omniauth-g5 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11b40e7d7c3dc0c0dfd4d01586f52f0d29ac1b62
+  data.tar.gz: fd85bdb45987fe74f697f47a98257e248b28512f
+SHA512:
+  metadata.gz: e1101ff8051b3e386ae8bb30da99adc6691fc7558dd8f8c97f2874c6d827566f586faf42784ae422ed7240737af57dd2ad565dcefc4f6ebee23b1dcec59dfe55
+  data.tar.gz: 34b9d4c94b0e656ddf3e6aa4a99308e3ad609e33fec5eab63977b188ad1108d832c7cffccda04d1b290699dead53520b4d01ca98afbea380bbd363f5ef66c6a7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

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

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# 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)
+
+* Changed `rake g5:export_users` task to read default argument values
+  from environment variables:
+  * `G5_AUTH_CLIENT_ID` - the G5 OAuth application ID
+  * `G5_AUTH_CLIENT_SECRET` - the G5 OAuth application secret
+  * `G5_AUTH_REDIRECT_URI` - the redirect URI registered with the auth server
+  * `G5_AUTH_ENDPOINT` - the auth server endpoint URL
+  * `G5_AUTH_AUTHORIZATION_CODE` - the G5 OAuth authorization code for
+    obtaining an access token
+* Changed argument order for `rake g5:export_users` such that
+  `authorization_code` now comes first.
+* 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)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-g5.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 G5
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# G5 OmniAuth
+
+This is the [OmniAuth][omniauth] strategy for authenticating to G5 via
+[OAuth 2.0][oauth].
+
+ [omniauth]: https://github.com/intridea/omniauth
+ [oauth]: http://oauth.net/2/
+
+## Current version
+
+0.1.0
+
+## Requirements
+
+* G5 Auth client credentials
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-g5'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install omniauth-g5
+```
+
+## Usage
+
+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]:
+
+```ruby
+Devise.setup do |config|
+  config.omniauth :g5, ENV['G5_AUTH_CLIENT_ID'], ENV['G5_AUTH_CLIENT_SECRET']
+end
+```
+
+For more general information about setting up and using OmniAuth, see the
+[official OmniAuth documentation][omniauth-wiki].
+
+ [devise]: https://github.com/plataformatec/devise
+ [omniauth-wiki]: https://github.com/intridea/omniauth/wiki
+
+## Authors
+
+  * Maeve Revels / [@maeve](https://github.com/maeve)
+  * Rob Revels / [@sleverbor](https://github.com/sleverbor)
+
+## Contributing
+
+1. Fork it
+2. Get it running
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Write your code and **specs**
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+If you find bugs, have feature requests or questions, please
+[file an issue](https://github.com/G5/omniauth-g5/issues).
+
+### Specs
+
+Just execute:
+
+```console
+$ bundle exec rspec spec
+```
+
+## License
+
+Copyright (c) 2013 G5
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/omniauth-g5.rb

@@ -0,0 +1,2 @@
+require 'omniauth-g5/version'
+require 'omniauth/strategies/g5'

data/lib/omniauth-g5/version.rb

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

data/lib/omniauth/strategies/g5.rb

@@ -0,0 +1,25 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class G5 < OmniAuth::Strategies::OAuth2
+      option :name, :g5
+
+      option :client_options, {
+        :site => 'https://auth.g5search.com',
+        :authorize_url => '/oauth/authorize',
+        :token_url => '/oauth/token'
+      }
+
+      uid { raw_info['id'] }
+
+      info do
+        {:email => raw_info['email']}
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/v1/me.json').parsed
+      end
+    end
+  end
+end

data/omniauth-g5.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-g5/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-g5'
+  gem.version       = OmniAuth::G5::VERSION
+  gem.authors       = ['Maeve Revels', 'Rob Revels']
+  gem.email         = ['maeve.revels@getg5.com', 'rob.revels@getg5.com']
+  gem.description   = 'OmniAuth strategy for G5'
+  gem.summary       = 'OmniAuth strategy for G5'
+  gem.homepage      = 'https://github.com/G5/omniauth-g5'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('omniauth-oauth2', '~> 1.1')
+
+  gem.add_development_dependency('rspec', '~> 2.14')
+  gem.add_development_dependency('simplecov', '~> 0.7')
+  gem.add_development_dependency('codeclimate-test-reporter')
+  gem.add_development_dependency('pry')
+  gem.add_development_dependency('webmock')
+end

data/spec/omniauth/strategies/g5_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::G5 do
+  subject { strategy }
+  let(:strategy) { OmniAuth::Strategies::G5.new(rack_app, app_id, app_secret, options) }
+
+  let(:rack_app) { double(:rack_app) }
+  let(:app_id) { 'test_app' }
+  let(:app_secret) { '1234567890qwerty' }
+  let(:options) { Hash.new }
+
+  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) }
+
+  its(:name) { should == :g5 }
+
+  it 'should have the correct client id' do
+    expect(strategy.options[:client_id]).to eq(app_id)
+  end
+
+  it 'should have the correct client secret' do
+    expect(strategy.options[:client_secret]).to eq(app_secret)
+  end
+
+  describe 'client_options' 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' }
+    end
+
+    context 'with partially overridden options' do
+      let(:options) 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' }
+    end
+  end
+
+  describe '#raw_info' 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)
+      raw_info
+    end
+
+    it { should == parsed_response }
+  end
+
+  describe '#uid' do
+    subject(:uid) { strategy.uid }
+    let(:parsed_response) do
+      {'id' => 123}
+    end
+
+    it { should == 123 }
+  end
+
+  describe '#info' do
+    subject(:info) { strategy.info }
+    let(:parsed_response) do
+      {'email' => 'test@test.com'}
+    end
+
+    its([:email]) { should == 'test@test.com' }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'simplecov'
+SimpleCov.start 'test_frameworks'
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'pry'
+require 'omniauth-g5'
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before { OmniAuth.config.test_mode = true }
+  config.after { OmniAuth.config.test_mode = false }
+
+  config.after(:suite) { WebMock.disable! }
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-g5
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maeve Revels
+- Rob Revels
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: pry
+  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: webmock
+  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'
+description: OmniAuth strategy for G5
+email:
+- maeve.revels@getg5.com
+- rob.revels@getg5.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-g5.rb
+- lib/omniauth-g5/version.rb
+- lib/omniauth/strategies/g5.rb
+- omniauth-g5.gemspec
+- spec/omniauth/strategies/g5_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+homepage: https://github.com/G5/omniauth-g5
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for G5
+test_files:
+- spec/omniauth/strategies/g5_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+has_rdoc: