oauth2_api_client

Oauth2ApiClient is a small, but powerful client around oauth2 and http-rb to interact with APIs which use oauth2 for authentication.

client = Oauth2ApiClient.new(base_url: "https://api.example.com", token "oauth2 token")

client.post("/orders", json: { address: "..." }).status.success?
client.headers("User-Agent" => "API Client").timeout(read: 5, write: 5).get("/orders").parse(:json)
# ...

In case an API is unprotected and you still want to use Oauth2ApiClient, you can simply not pass any token:

client = Oauth2ApiClient.new(base_url: "...")

Oauth2ApiClient is capable of generating oauth2 tokens, when a client id, client secret and oauth token url is given with automatic token caching and renewal on expiry, including retry of the current request.

client = Oauth2ApiClient.new(
  base_url: "https://api.example.com",
  token: Oauth2ApiClient::TokenProvider.new(
    client_id: "client id",
    client_secret: "client secret",
    token_url: "https.//auth.example.com/oauth2/token",
    cache: Rails.cache, # optional,
    max_token_ttl: 1800 # optional
  )
)

Please note, get, post, put, etc. will raise Oauth2ApiClient::ResponseError unless the response code is 2xx. More specifically, it will e.g. raise Oauth2ApiClient::ResponseError::NotFound for a 404 status code, Oauth2ApiClient::ResponseError::InternalServerError for a 500 status code, etc.

Default query params

In addition to the DSL of http-rb Oauth2ApiClient allows to set default query params, which can be useful for some APIs:

client = Oauth2ApiClient.new(base_url: "https://api.example.com").params(key1: "value1")
client.get("/path", params: { key2: "value" })
#=> GET https://api.example.com/path?key1=value1&key2=value2

Install

Add this line to your application's Gemfile:

gem 'oauth2_api_client'

and then execute

$ bundle

or install it via

$ gem install oauth2_api_client

Reference Docs

The reference docs can be found at http://www.rubydoc.info/github/mrkamel/oauth2_api_client

Semantic Versioning

Oauth2ApiClient is using Semantic Versioning: SemVer

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request