A gem to authenticate your service clients via headers client-id, pass-key before processing api requests.
gem 'client_authenticator'And then execute:
$ bundle
Or install it yourself as:
$ gem install client_authenticator
Next, you need to run the generator:
`$ rails generate client_authenticator:install`
It will add a migration to create api_clients model.
Then run rake db:migrate
Add following to to controller/base controller where you want clients to be authenticated for all api class
include ClientAuthenticator::ApiAuthenticable
for test to pass in above controllers you can use the test_helper methods stub_valid_client_credentials and stub_invalid_client_credentials(Add config.include InternalApiAuthenticator::TestHelpers to rails_helper file, so that the test_helper methods are available)
Gem provides a easy way to create the client credentials. You can run following rake task to generate client credentials.
$ bundle exec rake 'client_authenticator:generate_api_client_credentials[CLIENT_ID]'
- Fork it ( https://github.com/gojek-engineeering/client_authenticator-rb/fork )
- 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 a new Pull Request
- Create Issues if you find any or for enhancement requests