omniauth-multi-provider 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16ff3ef4f047ef105e33b3e2442420c39eb867ea
-  data.tar.gz: c5572a21ca416dc901a6c2d4e8ba3a3a09174ee3
+  metadata.gz: 8b5608e7d4138222375e7ea620ceca08cc3b0c5a
+  data.tar.gz: acf1a2eaef1eacf658e82f85eae08beb0b4ee076
 SHA512:
-  metadata.gz: 2c153418eb8f3c8f6a356a3905f159afd2715b362c3d07160a23d8bc97aa0c376566f7a78bdd7fffc65d5bb5ea2c421d17bde8b9788162d98f6088256e4ab497
-  data.tar.gz: 43de8c2fbfe2dfacf2aa67b95d9a674dc99cbfc8dea9e8c9315219b83f2ac78714dafb5e9e5434a4e35932a0b346ad37abb462e3d5c1126dbdbbdd519b06c15a
+  metadata.gz: 9aaa1e2239cd6ce60a4861abcd6d36b53f8c66fa5ea2d851c9fbe982203e79c436c75601ca2ee3951e52596620155cd1978a2777e5fcd52bcf22b81b9c1d66cc
+  data.tar.gz: 9d43e25787e436a884a637fdc23ead62b86c03268267cdcc15bee7938b5ede6436942c743ce687a3057f619d7d45aa4709a3722d2919dc8a26eb49f47b0044a5

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+omniauth-multi-provider

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.3

data/.travis.yml

@@ -1,7 +1,11 @@
 language: ruby
 rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.12.4
+  - 2.4.0
+  - 2.3.3
+before_install:
+  # Workaround for https://github.com/sickill/rainbow/issues/48
+  - gem update --system
+  - gem install bundler -v 1.13.7
 script:
   - bundle exec rubocop
   - bundle exec rspec

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # omniauth-multi-provider
 
+## v0.2.0
+- Support configuration of the callback suffix. Thanks [Martin Holman](https://github.com/martin308).
+
 ## v0.1.0
 - Initial version

data/README.md

@@ -1,11 +1,9 @@
-# OmniAuth::MultiProvider
+# OmniAuth MultiProvider
 
-Welcome to your new gem! In this directory, you'll find the files you need to be
-able to package up your Ruby library into a gem. Put your Ruby code in the file
-`lib/omniauth-multi-provider`. To experiment with that code, run 
-`bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a simple extension to [omniauth](https://github.com/omniauth/omniauth) for supporting 
+multiple identity provider instances of a given type e.g. multiple SAML or OAuth2
+identity providers. It is a generalization of the 
+[omniauth-multi-provider-saml](https://github.com/salsify/omniauth-multi-provider-saml).
 
 ## Installation
 
@@ -23,9 +21,71 @@ Or install it yourself as:
 
     $ gem install omniauth-multi-provider
 
-## Usage
+## Setup
+
+**Getting your setup to work with a single identity provider before attempting to use this gem is highly recommended.** 
+
+The setup process consists of the following steps:
+
+1. Create an OmniAuth callback controller for your identity provider like you normally would with OmniAuth.
+1. Configure your routes to handle routes for multiple identity provider instances.
+1. Configure omniauth-multi-provider to choose the appropriate identity provider instance.
 
-TODO: Write usage instructions here
+### Configure Routes
+
+Add something like the following to your routes assuming you're using Rails and a SAML identity provider 
+(your actual URL structure may vary):
+
+```ruby
+MyApplication::Application.routes.draw do
+  match '/auth/saml/:identity_provider_id/callback',
+        via: [:get, :post],
+        to: 'omniauth_callbacks#saml',
+        as: 'user_omniauth_callback'
+
+  match '/auth/saml/:identity_provider_id',
+        via: [:get, :post],
+        to: 'omniauth_callbacks#passthru',
+        as: 'user_omniauth_authorize'
+end
+```
+
+### Configure OmniAuth
+
+The basic configuration of OmniAuth looks something like this:
+
+```ruby
+# config/omniauth.rb
+Rails.application.config.middleware.use OmniAuth::Builder do
+  OmniAuth::MultiProvider.register(self,
+                                   provider_name: :saml,
+                                   identity_provider_id_regex: /\d+/,
+                                   path_prefix: '/auth/saml',
+                                   callback_suffix: 'callback',
+                                   # Specify any additional provider specific options
+                                   name_identifier_format: 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress',
+                                   issuer: 'salsify.com',
+                                   allowed_clock_drift: 5.seconds) do |identity_provider_id, rack_env|
+    identity_provider = SAML::IdentityProvider.find(identity_provider_id)
+    # Optionally store a reference to the identity provider in the Rack environment
+    # so you can reference it in your OmniAuth callbacks controller
+    rack_env['salsify.saml_identity_provider'] = identity_provider
+    # Any dynamic options returned by this block will be merged in with any statically
+    # configured options for the identity provider type e.g. issuer in this example.
+    identity_provider.options
+  end
+  
+  # This also works with multiple provider types
+  OmniAuth::MultiProvider.register(self,
+                                   provider_name: :oauth2,
+                                   identity_provider_id_regex: /\d+/,
+                                   path_prefix: '/auth/oauth2') do |identity_provider_id, rack_env|
+    identity_provider = OAuth2::IdentityProvider.find(identity_provider_id)
+    rack_env['salsify.oauth2_identity_provider'] = identity_provider
+    identity_provider.options
+  end
+end
+```
 
 ## Development
 

data/lib/omni_auth/multi_provider.rb

@@ -1,3 +1,5 @@
+require 'omniauth'
+
 require 'omni_auth/multi_provider/handler'
 require 'omni_auth/multi_provider/version'
 
@@ -6,11 +8,10 @@ module OmniAuth
     def self.register(builder,
                       provider_name:,
                       path_prefix: ::OmniAuth.config.path_prefix,
-                      identity_provider_id_regex:,
                       **options, &dynamic_options_generator)
 
       handler = OmniAuth::MultiProvider::Handler.new(path_prefix: path_prefix,
-                                                     identity_provider_id_regex: identity_provider_id_regex,
+                                                     **options,
                                                      &dynamic_options_generator)
 
       static_options = options.merge(path_prefix: path_prefix)

data/lib/omni_auth/multi_provider/handler.rb

@@ -2,23 +2,25 @@ module OmniAuth
   module MultiProvider
     class Handler
       attr_reader :path_prefix, :provider_instance_path_regex, :request_path_regex,
-                  :callback_path_regex, :provider_path_prefix,
+                  :callback_path_regex, :callback_suffix,
                   :identity_provider_options_generator
 
-      def initialize(path_prefix: OmniAuth.config.path_prefix,
-                     identity_provider_id_regex: /\w+/,
-                     &provider_generator)
+      def initialize(path_prefix:,
+                     identity_provider_id_regex:,
+                     callback_suffix: 'callback',
+                     **_options,
+                     &identity_provider_options_generator)
         raise 'Missing provider options generator block' unless block_given?
 
         @path_prefix = path_prefix
-        @identity_provider_options_generator = provider_generator
+        @identity_provider_options_generator = identity_provider_options_generator
         @identity_provider_id_regex = identity_provider_id_regex
+        @callback_suffix = callback_suffix
 
         # Eagerly compute these since lazy evaluation will not be threadsafe
-        @provider_path_prefix = @path_prefix
         @provider_instance_path_regex = /^#{@path_prefix}\/(?<identity_provider_id>#{@identity_provider_id_regex})/
         @request_path_regex = /#{@provider_instance_path_regex}\/?$/
-        @callback_path_regex = /#{@provider_instance_path_regex}\/callback\/?$/
+        @callback_path_regex = /#{@provider_instance_path_regex}\/#{@callback_suffix}\/?$/
       end
 
       def provider_options
@@ -29,6 +31,16 @@ module OmniAuth
         }
       end
 
+      def request_path?(env)
+        path = current_path(env)
+        !!request_path_regex.match(path)
+      end
+
+      def callback_path?(env)
+        path = current_path(env)
+        !!callback_path_regex.match(path)
+      end
+
       def setup(env)
         identity_provider_id = extract_identity_provider_id(env)
         if identity_provider_id
@@ -38,10 +50,12 @@ module OmniAuth
         end
       end
 
+      private
+
       def add_path_options(strategy, identity_provider_id)
         strategy.options.merge!(
-          request_path: "#{provider_path_prefix}/#{identity_provider_id}",
-          callback_path: "#{provider_path_prefix}/#{identity_provider_id}/callback"
+          request_path: "#{path_prefix}/#{identity_provider_id}",
+          callback_path: "#{path_prefix}/#{identity_provider_id}/#{callback_suffix}"
         )
       end
 
@@ -53,16 +67,6 @@ module OmniAuth
         throw :warden, result
       end
 
-      def request_path?(env)
-        path = current_path(env)
-        !!request_path_regex.match(path)
-      end
-
-      def callback_path?(env)
-        path = current_path(env)
-        !!callback_path_regex.match(path)
-      end
-
       def current_path(env)
         env['PATH_INFO']
       end

data/lib/omni_auth/multi_provider/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module MultiProvider
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/omniauth-multi-provider.gemspec

@@ -32,6 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.4'
-  spec.add_development_dependency 'salsify_rubocop', '~> 0.42.0'
+  spec.add_development_dependency 'salsify_rubocop', '~> 0.45.0'
   spec.add_development_dependency 'overcommit'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-multi-provider
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Salsify, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.45.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.45.0
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,8 @@ files:
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile