Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Twerl is an Erlang client for the Twitter Streaming API
Erlang
branch: espec

This branch is 7 commits ahead, 33 commits behind lucaspiller:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
src
test
.gitignore
Makefile
README.md
rebar
rebar.config

README.md

Twerl

An Erlang client for the Twitter Streaming API.

Goals

  • A lightweight client which can consume the Twitter Streaming API (DONE).
  • A client manager which allows you to change the search queries without losing any data (WIP).

Usage

You probably want to include it as a depedency in Rebar:

{deps,
  [
    {twerl, ".*", {git, "https://github.com/lucaspiller/twerl.git", "master"}},
  ]
}.

Manager

WIP

Client

Generate auth headers:

Headers = stream_client_util:generate_auth_headers(TwitterUsername, TwitterPassword).

Generate params:

{ok, Params} = stream_client_util:keywords_to_track(["erlang"]).

Build a callback function:

Callback = fun(Data) ->
  Tweet = proplists:get_value(<<"text">>, Data),
  io:format("Erlang <3: ~s~n", [Tweet])
end.

Start streaming:

stream_client:connect(stream_client_util:filter_url(), Headers, Params, Callback).

Development

Start an Erlang shell with reloader support:

make dev

Compile new code:

make compile

Run eunit tests:

make eunit

Contributing

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests. Pull requests without tests will be ignored.
  • Send me a pull request. Bonus points for topic branches.

License

Creative Commons License
Twerl by Luca Spiller is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Based on a work at github.com.
Permissions beyond the scope of this license may be available at https://github.com/lucaspiller/twerl.

Something went wrong with that request. Please try again.