View Source Tw (Tw v0.1.1)

Twitter API Client for elixir.

depends only on jason (optional) and hackney (optional).
- JSON library and HTTP client are replacable.
no implicit state (at least for now)

Installation

The package can be installed by adding tw to your list of dependencies in mix.exs:

def deps do
  [
    {:jason, "~> 1.2"},   # only if you choose jason
    {:hackney, "~> 1.0"}, # only if you choose hackney
    {:tw, "~> 0.1.0"}
  ]
end

Examples

Twitter API v1.1

alias Tw.OAuth.
alias Tw.V1_1.Client
alias Tw.V1_1.Tweet

credentials = OAuth.V1_0a.Credentials.new(
  consumer_key: "xxx",
  consumer_secret: "xxx",
  access_token: "xxx",
  access_token_secret: "xxx",
)
client = Client.new(
  credentials: credentials,
)
{:ok, [%Tweet{} | _]} = Tweet.home_timeline(client, %{count: 10})

There are functions which wrap API endpoints. They provide functionality below.

parameter encoding from Struct, List etc.
response decoding into Struct.
documentation.
typespec.

If the corresponding function is not implemented for your desired endpoint, or if the above is unnecessary/problematic, the Client can be used as is.

alias Tw.V1_1.Client
{:ok, result_map} = Client.request(client, :get, "/foo/bar.json", %{param_1: 2})

HTTP Client is replacable

You can use whichever HTTP client you want as long as it implements Tw.HTTP.Client (inspired by the greate Goth redesign article).

JSON encoder/decoder is replacable