Skip to content
This repository has been archived by the owner on Jan 25, 2024. It is now read-only.

parallel-markets/omniauth-parallelmarkets

Repository files navigation

Caution

This gem is no longer maintained. Please use the omniauth-oauth2 gem directly.

Gem Version Tests

OmniAuth ParallelMarkets

This gem contains the Parallel Markets strategy for OmniAuth.

ParallelMarkets uses the OAuth2 flow, you can read about at developer.parallelmarkets.com/api.

Installation

Add this line to your application's Gemfile:

gem 'omniauth-parallelmarkets'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-parallelmarkets

Usage

You'll need to register your application with Parallel Markets Support and get client_id & client_secret.

Here's an example for adding the middleware to a Rails app in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :parallelmarkets, ENV["CLIENT_ID"], ENV["CLIENT_SECRET"]
end

See the documentation for OmniAuth for more information on usage.

Sample Auth Hash

{
  "provider"=>"parallelmarkets",
  "uid"=>"VXNlcjox",
  "info"=> {
    "name"=>"Snake Plissken",
    "email"=>"[email protected]",
    "first_name"=>"Snake"
    "last_name"=>"Plissken"
  },
  "credentials"=> {
    "token"=>"parallel_access_token",
    "refresh_token"=>"parallel_refresh_token",
    "expires_at"=>1451681914,
    "expires"=>true
  },
  "extra"=> {
    "type"=>"individual",
    "user_id"=>"VXNlcjox",
    "accreditations"=>[
      {
        "id"=>321,
        "status"=>"current",
        "expires_at"=>1565317542,
        "assertion_type"=>"income",
        "created_at"=>1565307542
      }
    ]
  }
}

License

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