Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kivra/oauth2_client
Erlang OAuth2 Client
https://github.com/kivra/oauth2_client
Last synced: 3 months ago
JSON representation
Erlang OAuth2 Client
- Host: GitHub
- URL: https://github.com/kivra/oauth2_client
- Owner: kivra
- License: mit
- Created: 2012-08-15T14:03:17.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2023-11-13T08:00:45.000Z (12 months ago)
- Last Synced: 2024-07-27T11:22:54.022Z (3 months ago)
- Language: Erlang
- Size: 183 KB
- Stars: 73
- Watchers: 17
- Forks: 39
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-erlang - oauth2c - An Erlang oAuth 2 client (uses restc) (Third Party APIs)
README
# Oauth2 Client
This library is designed to simplify consuming Oauth2 enabled REST Services. It wraps a restclient and takes care of reauthenticating expired access_tokens when needed.
## Flows
Implemented flows are:
- Client Credentials Grant
- Resource Owner Password Credentials Grant
## Example
Retrieve a client with access_token using Password Credentials Grant
```erlang
1> oauth2c:retrieve_access_token(<<"password">>, <<"Url">>, <<"Uid">>, <<"Pwd">>).
{ok, Headers, Client}
```
Retrieve a client with access_token using Client Credentials Grant
```erlang
2> oauth2c:retrieve_access_token(<<"client_credentials">>, <<"Url">>, <<"Client">>, <<"Secret">>).
{ok, Headers, Client}
```
**Microsoft Azure AD**: Since parameters are different please use `<<"azure_client_credentials">>` as `Type` when retrieving an access token for that service. Be sure to set a `Scope` if you want to access any of the connected APIs.
```erlang
2> oauth2c:retrieve_access_token(
<<"azure_client_credentials">>,
<<"some_tenant_specific_oauth_token_endpoint">>,
<<"some_registered_app_id">>,
<<"some_created_key">>,
<<"https://graph.microsoft.com">>).
{ok, Headers, Client}
```
The Opaque `Client` object is to be used on subsequent requests like:
```erlang
3> oauth2c:request(get, json, <<"Url">>, [200], Client).
{{ok, Status, Headers, Body} Client2}
```
See [restclient](https://github.com/kivra/restclient) for more info on how requests work.
## Twitter Example
```erlang
-module(oauth2c_twitter_example).
-export([ run/0
]).
-define(CONSUMER_SECRET, <<"my_consumer_secret">>).
-define(CONSUMER_KEY, <<"my_consumer_key">>).
-define(OAUTH2_TOKEN_URL, <<"https://api.twitter.com/oauth2/token">>).
-define(USER_TIMELINE_URL(User, StrCount),
<<"https://api.twitter.com/1.1/statuses/user_timeline.json?screen_name="
, User, "&count=", StrCount>>).
-define(APP_LIMITS_URL(Resources),
<< "https://api.twitter.com/1.1/application/rate_limit_status.json?resources="
, Resources>>).
run() ->
application:ensure_all_started(oauth2c),
application:ensure_all_started(ssl),
{ok, _Headers, Client} =
oauth2c:retrieve_access_token(
<<"client_credentials">>, ?OAUTH2_TOKEN_URL, ?CONSUMER_KEY,
?CONSUMER_SECRET),
{{ok, _Status1, _Headers1, Tweets}, Client2} =
oauth2c:request(
get, json, ?USER_TIMELINE_URL("twitterapi", "4"), [200], Client),
io:format("Tweets: ~p~n", [Tweets]),
{{ok, _Status2, _Headers2, Limits}, _Client3} =
oauth2c:request(
get, json, ?APP_LIMITS_URL("help,users,search,statuses"),
[200], Client2),
io:format("Limits: ~p~n", [Limits]),
ok.
```
## License
The KIVRA oauth2 library uses an [MIT license](http://en.wikipedia.org/wiki/MIT_License). So go ahead and do what
you want!