Giter VIP home page Giter VIP logo

client-authenticator-rb's Introduction

Client Authenticator

Build Status

A gem to authenticate your service clients via headers client-id, pass-key before processing api requests.

Installation

gem 'client_authenticator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install client_authenticator

Usage

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]'

Contributing

  1. Fork it ( https://github.com/gojek-engineeering/client_authenticator-rb/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request
  6. Create Issues if you find any or for enhancement requests

client-authenticator-rb's People

Contributors

detj avatar dineshkumar-cse avatar manoharkshetty avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.