Aptible::Auth

Ruby client for auth.aptible.com. Aptible's authorization server is built on top of OAuth 2.0 and HAL+JSON, and so this client is just a thin layer on top of the oauth2 and HyperResource gems.

Installation

Add the following line to your application's Gemfile.

gem 'aptible-auth'

And then run bundle install.

The gem depends on forked releases of the oauth2 and hyperresource gems.

The forked version of the OAuth2 gem is necessary until intridea/oauth2#165 and intridea/oauth2#166 are merged.

The forked version of the HyperResource gem is necessary until gamache/hyperresource#22 and gamache/hyperresource#23 are merged.

Usage

First, get a token:

token = Aptible::Auth::Token.create(email: 'user0@example.com', password: 'password')

From here, you can interact with the Authorization API however you wish:

auth = Aptible::Auth.new(token: token)
auth.clients.first.name
# => "Client 0"
client = Aptible::Auth::Client.create(token: token, name: 'Dogeclient')
client.href
# => "http://localhost:4000/clients/60765b69-ffd8-4762-b9d2-96354ddb16f9"

Configuration

Parameter	Description	Default
`root_url`	Root URL of the authorization server	`ENV['APTIBLE_AUTH_ROOT_URL']` or https://auth.aptible.com

To point the client at a different authorization server (e.g., during development), add the following to your application's initializers (or set the APTIBLE_AUTH_ROOT_URL environment variable):

Aptible::Auth.configure do |config|
  config.root_url = 'http://some.other.url'
end

Contributing

Fork the project.
Commit your changes, with specs.
Ensure that your code passes specs (rake spec) and meets Aptible's Ruby style guide (rake rubocop).
Create a new pull request on GitHub.

Copyright and License

MIT License, see LICENSE for details.