omniauth-g5 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11b40e7d7c3dc0c0dfd4d01586f52f0d29ac1b62
-  data.tar.gz: fd85bdb45987fe74f697f47a98257e248b28512f
+  metadata.gz: 3c725fd3953602794351ab2800883220afc39466
+  data.tar.gz: 8fc1bede6057617700b3f76643257af2cb676e38
 SHA512:
-  metadata.gz: e1101ff8051b3e386ae8bb30da99adc6691fc7558dd8f8c97f2874c6d827566f586faf42784ae422ed7240737af57dd2ad565dcefc4f6ebee23b1dcec59dfe55
-  data.tar.gz: 34b9d4c94b0e656ddf3e6aa4a99308e3ad609e33fec5eab63977b188ad1108d832c7cffccda04d1b290699dead53520b4d01ca98afbea380bbd363f5ef66c6a7
+  metadata.gz: e6c228bccc9af1fb6a4073d1370e51d0379f481efc6293994f0b8909a20523998d129cac00bbe777667dab694548f859735c742d903cb44b34928d5129b8ea67
+  data.tar.gz: e44cbdc3809ba2f2f513ecae13d4ebe6e78ae5a5a95155b1a9b90e7935ec0e4deacd64c7d31ada5a8af2403b330aaf63d300ac7efea88420cfacf536d6d337e3

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.2.0

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - 2.1.5
+  - 2.2.0
+  - 2.2.2
+script:
+  - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,10 +1,16 @@
-# v0.1.0 (2014-03-12)
+## v0.2.0 (2015-05-20)
+
+* Added new fields to auth hash for user name, phone, title, and organization.
+* Added user roles to the auth hash
+  ([#8](https://github.com/G5/omniauth-g5/pull/8))
+
+## v0.1.0 (2014-03-12)
 
 * Moved `rake g5:export_users` task to
   [devise_g5_authenticatable](https://github.com/G5/devise_g5_authenticatable)
 * First open source release to [RubyGems](https://rubygems.org)
 
-# v0.0.2 (2013-11-06)
+## v0.0.2 (2013-11-06)
 
 * Changed `rake g5:export_users` task to read default argument values
   from environment variables:
@@ -19,6 +25,6 @@
 * Renamed any references to the client callback URL to redirect URI, to
   maintain terminology consistent with the OAuth 2.0 specification.
 
-# v0.0.1 (2013-07-25)
+## v0.0.1 (2013-07-25)
 
 * Initial release

data/README.md

@@ -8,7 +8,7 @@ This is the [OmniAuth][omniauth] strategy for authenticating to G5 via
 
 ## Current version
 
-0.1.0
+0.2.0
 
 ## Requirements
 
@@ -36,6 +36,8 @@ $ gem install omniauth-g5
 
 ## Usage
 
+### Configuration
+
 The strategy must be initialized with a valid client application ID and secret
 provided by the G5 auth service. For example, to use the G5 strategy with
 [devise][devise]:
@@ -52,6 +54,70 @@ For more general information about setting up and using OmniAuth, see the
  [devise]: https://github.com/plataformatec/devise
  [omniauth-wiki]: https://github.com/intridea/omniauth/wiki
 
+### Auth Hash
+
+After authenticating, OmniAuth returns a hash of information in the Rack
+environment under the key `omniauth.auth`. The G5 OmniAuth strategy
+specifically uses the following subset of the full
+[auth hash schema](https://github.com/intridea/omniauth/wiki/Auth-Hash-Schema):
+
+* `provider` - this will always be set to the symbol `:g5`
+* `uid` - the unique identifier for the authenticated user
+* `info` - a hash containing information about the user
+  * `email` - the email address of the authenticated user
+  * `name` - the display name for the user (concatenated first and last names,
+    or an empty string if no name fields have been populated)
+  * `first_name` - the user's first name (may be nil)
+  * `last_name` - the user's last name (may be nil)
+  * `phone` - the user's phone number (may be nil; no specific formatting is
+    enforced)
+* `credentials` - information about the user's access token
+  * `token` - the access token string
+  * `expires` - boolean indicating whether the access token has an expiry date
+    (always set to true for G5)
+  * `expires_at` - timestamp of the expiry time
+* `extra` - extra information returned from the auth server, including the raw
+  user data and custom fields specific to G5
+  * `title` - the user's job title (may be nil)
+  * `organization_name` - the user's organization name (may be nil). This does
+    not necessarily match the G5 client name. For example, it could be the name
+    of a department or business unit within the client's organization.
+  * `roles` - the array of roles assigned to the user (may be empty)
+    * `uid` - the unique identifier of the role on the auth server
+    * `name` - the name of the role in snakecase
+  * `raw_info` - a hash representation of the full JSON response from the G5
+    auth server
+
+For example:
+
+```ruby
+{"provider"=>:g5,
+ "uid"=>42,
+ "info"=>
+  {"email"=>"test.user@test.host",
+   "name"=>"Test User",
+   "first_name"=>"Test",
+   "last_name"=>"User",
+   "phone"=>"(555) 555-5555"},
+ "credentials"=>
+  {"token"=>"abc123",
+   "expires_at"=>1430170866,
+   "expires"=>true},
+ "extra"=>
+  {"raw_info"=>
+    {"id"=>42,
+     "email"=>"test.user@test.host",
+     "first_name"=>"Test",
+     "last_name"=>"User",
+     "phone_number"=>"(555) 555-5555",
+     "organization_name"=>"Test Org",
+     "title"=>"Tester",
+     "roles"=>[{"id"=>4,"name"=>"viewer"}]},
+   "title"=>"Tester",
+   "organization_name"=>"Test Org",
+   "roles" => [{"uid"=>4,"name"=>"viewer"}]}}
+```
+
 ## Authors
 
   * Maeve Revels / [@maeve](https://github.com/maeve)

data/lib/omniauth-g5/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module G5
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/omniauth/strategies/g5.rb

@@ -14,12 +14,33 @@ module OmniAuth
       uid { raw_info['id'] }
 
       info do
-        {:email => raw_info['email']}
+        {:email => raw_info['email'],
+         :name => display_name,
+         :first_name => raw_info['first_name'],
+         :last_name => raw_info['last_name'],
+         :phone => raw_info['phone_number']}
+      end
+
+      extra do
+        {:raw_info => raw_info,
+         :title => raw_info['title'],
+         :organization_name => raw_info['organization_name'],
+         :roles => roles}
       end
 
       def raw_info
         @raw_info ||= access_token.get('/v1/me.json').parsed
       end
+
+      def display_name
+        "#{raw_info['first_name']} #{raw_info['last_name']}".strip
+      end
+
+      def roles
+        [raw_info['roles']].flatten.collect do |role|
+          {:name => role['name']}
+        end
+      end
     end
   end
 end

data/omniauth-g5.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('omniauth-oauth2', '~> 1.1')
 
-  gem.add_development_dependency('rspec', '~> 2.14')
+  gem.add_development_dependency('rspec', '~> 3.2')
+  gem.add_development_dependency('rspec-its')
   gem.add_development_dependency('simplecov', '~> 0.7')
   gem.add_development_dependency('codeclimate-test-reporter')
   gem.add_development_dependency('pry')

data/spec/omniauth/strategies/g5_spec.rb

@@ -12,9 +12,9 @@ describe OmniAuth::Strategies::G5 do
   let(:access_token) { double(:access_token, :get => response) }
   let(:response) { double(:response, :parsed => parsed_response) }
   let(:parsed_response) { double(:parsed_response) }
-  before { strategy.stub(:access_token => access_token) }
+  before { allow(strategy).to receive(:access_token).and_return(access_token) }
 
-  its(:name) { should == :g5 }
+  its(:name) { is_expected.to eq(:g5) }
 
   it 'should have the correct client id' do
     expect(strategy.options[:client_id]).to eq(app_id)
@@ -28,9 +28,9 @@ describe OmniAuth::Strategies::G5 do
     subject(:client_options) { strategy.options.client_options }
 
     context 'with default options' do
-      its(:site) { should == 'https://auth.g5search.com' }
-      its(:authorize_url) { should == '/oauth/authorize' }
-      its(:token_url) { should == '/oauth/token' }
+      its(:site) { is_expected.to eq('https://auth.g5search.com') }
+      its(:authorize_url) { is_expected.to eq('/oauth/authorize') }
+      its(:token_url) { is_expected.to eq('/oauth/token') }
     end
 
     context 'with partially overridden options' do
@@ -38,9 +38,9 @@ describe OmniAuth::Strategies::G5 do
         {:client_options => {:site => 'https://custom.app.com'}}
       end
 
-      its(:site) { should == 'https://custom.app.com' }
-      its(:authorize_url) { should == '/oauth/authorize' }
-      its(:token_url) { should == '/oauth/token' }
+      its(:site) { is_expected.to eq('https://custom.app.com') }
+      its(:authorize_url) { is_expected.to eq('/oauth/authorize') }
+      its(:token_url) { is_expected.to eq('/oauth/token') }
     end
   end
 
@@ -48,11 +48,11 @@ describe OmniAuth::Strategies::G5 do
     subject(:raw_info) { strategy.raw_info }
 
     it 'should retrieve the user info from the server' do
-      access_token.should_receive(:get).with('/v1/me.json').and_return(response)
+      expect(access_token).to receive(:get).with('/v1/me.json').and_return(response)
       raw_info
     end
 
-    it { should == parsed_response }
+    it { is_expected.to eq(parsed_response) }
   end
 
   describe '#uid' do
@@ -61,15 +61,113 @@ describe OmniAuth::Strategies::G5 do
       {'id' => 123}
     end
 
-    it { should == 123 }
+    it { is_expected.to eq(123) }
   end
 
   describe '#info' do
     subject(:info) { strategy.info }
     let(:parsed_response) do
-      {'email' => 'test@test.com'}
+      {'email' => email,
+       'first_name' => first_name,
+       'last_name' => last_name,
+       'phone_number' => phone_number}
     end
 
-    its([:email]) { should == 'test@test.com' }
+    let(:email) { 'test@test.com' }
+    let(:first_name) { 'Test' }
+    let(:last_name) { 'User' }
+    let(:phone_number) { '(555) 555-5555' }
+
+    its([:email]) { is_expected.to eq(email) }
+    its([:name]) { is_expected.to eq("#{first_name} #{last_name}") }
+    its([:first_name]) { is_expected.to eq(first_name)}
+    its([:last_name]) { is_expected.to eq(last_name) }
+    its([:phone]) { is_expected.to eq(phone_number) }
+  end
+
+  describe '#extra' do
+    subject(:extra) { strategy.extra }
+    let(:parsed_response) do
+      {'title' => title,
+       'organization_name' => org_name,
+       'roles' => roles}
+    end
+
+    let(:title) { 'Grand Poobah' }
+    let(:org_name) { 'Test Org' }
+    let(:roles) { [{'name' => 'viewer'}] }
+
+    its([:raw_info]) { is_expected.to eq(parsed_response) }
+    its([:title]) { is_expected.to eq(title) }
+    its([:organization_name]) { is_expected.to eq(org_name) }
+    its([:roles]) { is_expected.to eq(strategy.roles) }
+  end
+
+  describe '#display_name' do
+    subject(:display_name) { strategy.display_name }
+    let(:parsed_response) do
+      {'first_name' => first_name,
+       'last_name' => last_name}
+    end
+
+    let(:first_name) {}
+    let(:last_name) {}
+
+    context 'with first and last name' do
+      let(:first_name) { 'Test' }
+      let(:last_name) { 'User' }
+
+      it { is_expected.to eq("#{first_name} #{last_name}")}
+    end
+
+    context 'with first name only' do
+      let(:first_name) { 'Test'}
+
+      it { is_expected.to eq(first_name) }
+    end
+
+    context 'with last name only' do
+      let(:last_name) { 'User' }
+
+      it { is_expected.to eq(last_name) }
+    end
+
+    context 'without name fields' do
+      it { is_expected.to eq('') }
+    end
+  end
+
+  describe '#roles' do
+    subject(:roles) { strategy.roles }
+    let(:parsed_response) do
+      {'roles' => role_data}
+    end
+
+    context 'when roles are empty' do
+      let(:role_data) { [] }
+
+      it { is_expected.to be_empty }
+    end
+
+    context 'when there is one role' do
+      let(:role_data) { [{'name' => 'viewer'}] }
+
+      its(:count) { is_expected.to eq(1) }
+
+      it 'should return the role name' do
+        expect(roles.first[:name]).to eq(role_data.first['name'])
+      end
+    end
+
+    context 'when there are two roles' do
+      let(:role_data) do
+        [{'name' => 'super_admin'},
+         {'name' => 'editor'}]
+      end
+
+      its(:count) { is_expected.to eq(2) }
+      it { is_expected.to include({name: 'super_admin'}) }
+      it { is_expected.to include({name: 'editor'}) }
+    end
   end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ SimpleCov.start 'test_frameworks'
 require 'codeclimate-test-reporter'
 CodeClimate::TestReporter.start
 
+require 'rspec/its'
 require 'pry'
 require 'omniauth-g5'
 
@@ -13,7 +14,6 @@ require 'webmock/rspec'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-g5
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Maeve Revels
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -31,14 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -105,8 +119,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -138,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: OmniAuth strategy for G5
@@ -146,4 +160,3 @@ test_files:
 - spec/omniauth/strategies/g5_spec.rb
 - spec/spec_helper.rb
 - spec/support/.gitkeep
-has_rdoc: 

data/.ruby-gemset

@@ -1 +0,0 @@
-g5_omniauth