Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tgrk/yatael
Yet Another Twitter API Erlang Library
https://github.com/tgrk/yatael
erlang erlang-library oauth twitter-api
Last synced: 17 days ago
JSON representation
Yet Another Twitter API Erlang Library
- Host: GitHub
- URL: https://github.com/tgrk/yatael
- Owner: tgrk
- License: mit
- Created: 2013-08-03T12:14:51.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-01-26T12:16:05.000Z (almost 5 years ago)
- Last Synced: 2023-03-11T19:37:42.777Z (over 1 year ago)
- Topics: erlang, erlang-library, oauth, twitter-api
- Language: Erlang
- Size: 74.2 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/tgrk/yatael/tree/master)
[](https://codecov.io/github/tgrk/yatael?branch=master)
yatael
======
Yet Another [Twitter REST API][1] (v1.1) Erlang Library
Implemented REST API Calls
===
* `request_token/2`
* `get_authorize_url/1`
* `get_access_token/3`
* `authorize/2`
* `unauthorize/1`
* `verify_credentials/2`
* `get_timeline/1`
* `get_timeline/2`
* `get_mentions_timeline/2`
* `lookup_status/2`
* `search/2`
Besides REST API and Search API there is of coure support for OAuth and few related helper functions for easy signup integration.
## Dependencies
* Erlang (>= R17)
* [jiffy][2]
Fetch and compile all dependencies:
```
$ rebar3 update compile
```
or
```bash
$ rebar get-deps compile
```
OAuth
===
https://dev.twitter.com/oauth
API Rate Limits
===
https://dev.twitter.com/rest/public/rate-limits
https://dev.twitter.com/rest/public/rate-limiting
Register your application
===
1. Sign in at https://apps.twitter.com
2. Click on Create New App
3. Enter your Application Name, Description and Website
4. For Callback URL: `http://127.0.0.1:3000`
5. Go to Settings tab
6. Under Application Type select Read and Write access
7. Check the box Allow this application to be used to Sign in with Twitter
8. Click Update this Twitter's applications settings
9. Obtain Consumer Key (API Key or ClientId) and Consumer Secret (API Secret)
Raw library usage
===
```erlang
1> ConsumerKey = <<"foo">>,
2> ConsumerSecret = <<"bar">>,
3> CallbackUri = <<"http://127.0.0.1/">>.
4> {ok, _Apps} = application:ensure_all_started(yatael).
5> {ok, Pid} = yatael:start_link(ConsumerKey, ConsumerSecret).
6> ok = yatael:request_token(Pid, CallbackUri).
7> {ok, Url} = yatael:get_authorize_url(Pid).
```
Open `Url` value in brower and accept Twitter oAuth and extract following arguments
after sucessfull redirect to your `CallbackUri`:
```erlang
8> AccessToken = <<"foo2">>.
9> Verifier = <<"bar2">>.
10> ok = yatael:get_access_token(Pid, AccessToken, Verifier),
```
Now athentification is done and you can use supproted API calls:
```erlang
11> yatael:verify_credentials(Pid, [{skip_status, true}]).
{ok,#{<<"contributors_enabled">> => false,
<<"created_at">> => <<"Fri Jun 26 09:22:24 +0000 2009">>,
<<"default_profile">> => false,
<<"default_profile_image">> => false,
....
12> yatael:get_timeline(Pid).
....
13> yatael_auth:unauthorize(Pid).
ok
```
Auth helper usage
===
```erlang
1> ConsumerKey = <<"foo">>,
2> ConsumerSecret = <<"bar">>,
3> CallbackUri = <<"http://127.0.0.1/">>.
4> {ok, _Apps} = application:ensure_all_started(yatael).
5> {ok, Pid} = yatael:start_link(ConsumerKey, ConsumerSecret).
6> ok = yatael:request_token(Pid, CallbackUri).
7> {ok, Url} = yatael:get_authorize_url(Pid).
...
8> Map = #{<<"oauth_token">> => <<"foo3">>, <<"oauth_verifier">> => <<"bar3">>, <<"callback_uri">> => CallbackUri}.
9> yatael_auth:authorize(Pid, Map).
{ok,#{<<"contributors_enabled">> => false,
<<"created_at">> => <<"Fri Jun 26 09:22:24 +0000 2009">>,
<<"default_profile">> => false,
<<"default_profile_image">> => false,
....
10> yatael_auth:unauthorize(Pid).
ok
```
[1]: https://dev.twitter.com/rest/public
[2]: https://github.com/davisp/jiffy