omniauth_configure 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDljYTI3MmY5YWRjOTAzMTRkNWFjZmNlNDZiM2E0Zjk5Y2JhOWYyNQ==
+  data.tar.gz: !binary |-
+    NTM5ZTA5Yjk3ZTQ1MTNiYTQ1YWJkMjFkZTlhMzgwMDMzM2I4MGI1NQ==
+SHA512:
+  metadata.gz: !binary |-
+    NDA4OTllNTUwNjQwYWVkMmUzZWVkMGNmOWYwMDkyZGViNmI2NjY0Yzc3MjA1
+    NWUwZTlhZjk3OGMxMmQwYjJhZjE4YjQ1YjExZTg1NjQ2OWVlMWI4Mjc2Zjg0
+    YTM5MjVmMmViNTBiNmY3ZmM1MDRmOTZmZDJlODgxZWRkMjVhOWE=
+  data.tar.gz: !binary |-
+    YjJmNzMzODZmMTAzYzlkYzJlYTU5MzBiM2U1MGMyZTBiY2NjNjAxOTIyYzJm
+    ODNjYWZkOGQ4MTE1NDc3ZjY5YWQ4YzVkYmI1ZDA0NTMyYWM2ZTFmM2QyMTZl
+    NjNjZDMzYzA5MDZlNmRiYTM5NzA2MjkyMzkzZmE2YzdiYWMwOTY=

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.2.0
+
+* Use all configuration options when configuring a strategy instead of 
+  only client_id, client_secret, and specific client_options.
+
+## 0.1.0
+
+* Allow omniauth to be configured through a centralized file on the server.
+

data/README.md

@@ -1,4 +1,4 @@
-# OmnAuth Configure
+# OmniAuth Configure
 
 Centralize OmniAuth strategy configurations on the server. This has a couple 
 advantages over storing configuration details (e.g. client secret and urls) in 
@@ -11,27 +11,35 @@ source control or the environment for the user running the application server.
 
 1. Add the `omniauth_configure` gem to the Gemfile
 
-## Congiguration
+## Configuration
+
+A configuration contains details about applications and strategies which
+use omniauth. Applications are top level keys (e.g. nucats_assist, nitro) 
+with the exception of the 'defaults'. The 'defaults' top level key is used to 
+keep global options for strategies. When a strategy is configured on a per  
+application level, the default options for that strategy are inherited first
+and the application specific strategy options are applied on top of them.
 
 ```
 # /etc/nubic/omniauth/local.yml
 
 defaults:
   nucats_membership:
-    site: http://membership-staging.nubic.northwestern.edu
-    authorize_url: /auth
-    token_url: /token
+    client_options:
+      site: http://membership-staging.nubic.northwestern.edu
+      authorize_url: /auth
+      token_url: /token
 nucats_assist:
   nucats_membership:
     client_id: abc123
     client_secret: def456
-  facebok:
+  facebook:
     client_id: asdf213
     client_secret: jimbo
 nitro:
   nucats_membership:
     client_id: xyz987
-    client_secret:ufw654
+    client_secret: ufw654
 ```
 
 ## Rack
@@ -40,7 +48,7 @@ nitro:
 # server.ru
 
 OmniauthConfigure.configure {
-  app :example
+  app :nucats_assist
   strategies :nucats_membership
   central '/etc/nubic/omniauth/local.yml'
 }
@@ -54,8 +62,12 @@ OmniauthConfigure::Rack.use_in(self)
 # config/environments/development.rb
 
 OmniAuthConfigure.configure {
-  app :example
+  app :nucats_assist
   strategies :nucats_membership
   central '/etc/nubic/omniauth/local.yml'
 }
 ```
+
+For Devise configuration see the [Devise wiki page about omniauth](https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview)
+
+

data/lib/omniauth_configure/central_parameters.rb

@@ -1,5 +1,6 @@
 # -*- encoding : utf-8 -*-
 require 'yaml'
+require 'active_support'
 
 module OmniAuthConfigure
   class CentralParameters
@@ -23,9 +24,9 @@ module OmniAuthConfigure
       unless entries.key?(app)
         entries[app] = {}
         entries[app][provider] = 
-            {}.merge((raw_values[:default] || {})[provider] || {}).
-            merge((raw_values[:defaults] || {})[provider] || {}).
-            merge((raw_values[app] || {})[provider] || {})
+            {}.deep_merge((raw_values[:default] || {})[provider] || {}).
+            deep_merge((raw_values[:defaults] || {})[provider] || {}).
+            deep_merge((raw_values[app] || {})[provider] || {})
       end
       entries[app][provider]
     end

data/lib/omniauth_configure/rack.rb

@@ -23,19 +23,11 @@ module OmniAuthConfigure::Rack
 
       p = effective_configuration.parameters_for(app, klass)
 
-      middleware.args [:client_id, :client_secret]
+      arg_keys = p.keys.sort
 
-      cid = p[:client_id]
-      cs  = p[:client_secret]
-      s   = p[:site]
-      au  = p[:authorize_url]
-      tu  = p[:token_url]
+      middleware.args arg_keys
 
-      args = [cid, cs]
-      if s || au || tu
-        middleware.args [:client_id, :client_secret, :client_options]
-        args << {:site => s, :authorize_url => au, :token_url => tu }
-      end
+      args = p.values_at(*arg_keys)
       args << {} # Last argument to provider strategy is empty hash
 
       builder.use middleware, *args, &block

data/lib/omniauth_configure/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 
 module OmniAuthConfigure
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/omniauth_configure.gemspec

@@ -16,5 +16,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'omniauth', '~> 1.2'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rake'
+  s.add_runtime_dependency 'activesupport'
 end
 

data/spec/omniauth_configure/configuration_spec.rb

@@ -22,7 +22,7 @@ describe OmniAuthConfigure::Configuration do
     end
 
     it 'aquires the default parameters' do
-      expect(northwestern[:site]).to eq('http://northwestern.edu')
+      expect(northwestern[:client_options][:site]).to eq('http://northwestern.edu')
     end
 
     it 'aquires the parameters' do
@@ -31,7 +31,7 @@ describe OmniAuthConfigure::Configuration do
     end
 
     it 'aquires the overridden parameters' do
-      expect(northwestern[:token_url]).to eq('/override/token')
+      expect(northwestern[:client_options][:token_url]).to eq('/override/token')
     end
   end
 

data/spec/omniauth_configure/rack_spec.rb

@@ -23,7 +23,7 @@ describe OmniAuthConfigure::Rack do
 
       OmniAuthConfigure::Rack.use_in(builder)
       expect(builder.uses[0].first).to eq(OmniAuth::Strategies::Northwestern)
-      expect(builder.uses[0].first.args).to eq([:client_id, :client_secret, :client_options])
+      expect(builder.uses[0].first.args).to eq([:client_id, :client_options, :client_secret])
 
       expect(builder.uses[1].first).to eq(OmniAuth::Strategies::Facebook)
       expect(builder.uses[1].first.args).to eq([:client_id, :client_secret])

data/spec/omniauth_configure/test_configuration.yml

@@ -1,13 +1,15 @@
 defaults:
   northwestern:
-    site: http://northwestern.edu
-    authorize_url: /oauth/auth
-    token_url: /oauth/token
+    client_options:
+      site: http://northwestern.edu
+      authorize_url: /oauth/auth
+      token_url: /oauth/token
 patient_tracker:
   northwestern:
     client_id: c1980
     client_secret: kareem
-    token_url: /override/token
+    client_options:
+      token_url: /override/token
   facebook:
     client_id: c1995
     client_secret: seagal

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: omniauth_configure
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - John Dzak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,20 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -66,6 +73,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -82,32 +90,25 @@ files:
 - spec/spec_helper.rb
 homepage: 
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1431042663031854455
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1431042663031854455
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Allows centralized OmniAuth strategy configurations
 test_files: []