Omniauth::InfinumId

Strategy to authenticate with InfinumID via OAuth2 in OmniAuth.

This gem is being used inside infinum_id-engine.

Installation

Add this line to your application's Gemfile:

gem 'omniauth-infinum_id'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-infinum_id

Usage

Name of the strategy is infinum_id.

Initialize omniauth inside devise:

# config/initializers/devise.rb

config.omniauth(
  :infinum_id,
  'InfinumID_client_id',
  'InfinumID_client_secret',
  client_options: { site: 'InfinumID_url' }
)

When user is authenticated via omniauth, strategy will parse users info into following:

{
  "provider" => "infinum_id",
  "uid" => 17, # ID_OF_USER_ON_INFINUM_ID_SERVER
  "info" => 
  {
    "email" => 'mirko.mirkec@infinum.hr',
    "first_name" => 'Mirko',
    "last_name" => 'Mirkec',
    "slack_username" => 'mmirkec',
    "time_zone" => 'Zagreb', # Name of time zone
    "deactivated_at" => nil, # DateTime when user was deactivated or nil if it's not
    "avatar_url" => nil # Remote url to user profile picture
  }
}

Lastly, callback method should be created with same name as strategy, in this case infinum_id, inside OmniauthCallbackController. In this method user should be authenticated and signed in.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-infinum_id. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Omniauth::InfinumId project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.