omniauth-oauth2 1.0.0.beta1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format=progress

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gem 'omniauth', '1.0.0.pr2', :git => 'git://github.com/intridea/omniauth.git'
+# Specify your gem's dependencies in omniauth-oauth2.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'growl'
+  gem 'rb-fsevent'
+end

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/README.md

@@ -0,0 +1,78 @@
+# OmniAuth OAuth2
+
+**Note:** This gem is designed to work with the unreleased OmniAuth 1.0
+library. It will not be officially released on RubyGems.org until
+OmniAuth 1.0 is released.
+
+This gem contains a generic OAuth2 strategy for OmniAuth. It is meant to
+serve as a building block strategy for other strategies and not to be
+used independently (since it has no inherent way to gather uid and user
+info).
+
+## Creating an OAuth2 Strategy
+
+To create an OmniAuth OAuth2 strategy using this gem, you can simply
+subclass it and add a few extra methods like so:
+
+    require 'omniauth-oauth'
+
+    module OmniAuth
+      module Strategies
+        class SomeSite < OmniAuth::Strategies::OAuth2
+          # Give your strategy a name.
+          option :name, "some_site"
+
+          # This is where you pass the options you would pass when
+          # initializing your consumer from the OAuth gem.
+          option :client_options, {:site => "https://api.somesite.com"}
+
+          # These are called after authentication has succeeded. If
+          # possible, you should try to set the UID without making
+          # additional calls (if the user id is returned with the token
+          # or as a URI parameter). This may not be possible with all
+          # providers.
+          uid{ raw_info['id'] }
+
+          info do
+            {
+              :name => raw_info['name'],
+              :email => raw_info['email']
+            }
+          end
+
+          extra do
+            {
+              'raw_info' => raw_info
+            }
+          end
+
+          def raw_info
+            @raw_info ||= access_token.get('/me').parsed
+          end
+        end
+      end
+    end
+
+That's pretty much it!
+
+## License
+
+Copyright (C) 2011 by Michael Bleigh and Intridea, Inc.
+
+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,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/lib/omniauth-oauth2.rb

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

data/lib/omniauth-oauth2/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module OAuth2
+    VERSION = "1.0.0.beta1"
+  end
+end

data/lib/omniauth/strategies/oauth2.rb

@@ -0,0 +1,94 @@
+require 'cgi'
+require 'uri'
+require 'oauth2'
+require 'omniauth'
+
+module OmniAuth
+  module Strategies
+    # Authentication strategy for connecting with APIs constructed using
+    # the [OAuth 2.0 Specification](http://tools.ietf.org/html/draft-ietf-oauth-v2-10).
+    # You must generally register your application with the provider and
+    # utilize an application id and secret in order to authenticate using
+    # OAuth 2.0.
+    class OAuth2
+      include OmniAuth::Strategy
+
+      args [:client_id, :client_secret]
+
+      option :client_id, nil
+      option :client_secret, nil
+      option :client_options, {}
+      option :authorize_params, {}
+      option :authorize_options, [:scope]
+      option :token_params, {}
+      option :token_options, []
+
+      attr_accessor :access_token
+
+      def client
+        ::OAuth2::Client.new(options.client_id, options.client_secret, options.client_options.inject({}){|h,(k,v)| h[k.to_sym] = v; h})
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      credentials do
+        hash = {'token' => access_token.token}
+        hash.merge!('refresh_token' => access_token.refresh_token) if access_token.expires?
+        hash
+      end
+
+      def request_phase
+        redirect client.auth_code.authorize_url({:redirect_uri => callback_url}.merge(authorize_params))
+      end
+
+      def authorize_params
+        options.authorize_params.merge(options.authorize_options.inject({}){|h,k| h[k.to_sym] = options[k] if options[k]; h})
+      end
+
+      def token_params
+        options.token_params.merge(options.token_options.inject({}){|h,k| h[k.to_sym] = options[k] if options[k]; h})
+      end
+
+      def callback_phase
+        if request.params['error'] || request.params['error_reason']
+          raise CallbackError.new(request.params['error'], request.params['error_description'] || request.params['error_reason'], request.params['error_uri'])
+        end
+
+        self.access_token = build_access_token
+        self.access_token = client.auth_code.refresh_token(access_token.refresh_token) if access_token.expired?
+
+        super
+      rescue ::OAuth2::Error, CallbackError => e
+        fail!(:invalid_credentials, e)
+      rescue ::MultiJson::DecodeError => e
+        fail!(:invalid_response, e)
+      rescue ::Timeout::Error, ::Errno::ETIMEDOUT => e
+        fail!(:timeout, e)
+      end
+
+      protected
+
+      def build_access_token
+        verifier = request.params['code']
+        client.auth_code.get_token(verifier, {:redirect_uri => callback_url}.merge(options.token_params.to_hash(:symbolize_keys => true)))
+      rescue ::OAuth2::Error => e
+        raise e.response.inspect
+      end
+
+      # An error that is indicated in the OAuth 2.0 callback.
+      # This could be a `redirect_uri_mismatch` or other
+      class CallbackError < StandardError
+        attr_accessor :error, :error_reason, :error_uri
+
+        def initialize(error, error_reason=nil, error_uri=nil)
+          self.error = error
+          self.error_reason = error_reason
+          self.error_uri = error_uri
+        end
+      end
+    end
+  end
+end
+OmniAuth.config.add_camelization 'oauth2', 'OAuth2'

data/omniauth-oauth2.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-oauth2/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'hashie', '~> 1.2'
+  gem.add_dependency 'omniauth', '~> 1.0.0.beta1'
+  gem.add_dependency 'oauth2', '~> 0.5.0'
+
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'simplecov'
+
+  gem.authors       = ["Michael Bleigh"]
+  gem.email         = ["michael@intridea.com"]
+  gem.description   = %q{An abstract OAuth2 strategy for OmniAuth.}
+  gem.summary       = %q{An abstract OAuth2 strategy for OmniAuth.}
+  gem.homepage      = "https://github.com/intridea/omniauth-oauth2"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "omniauth-oauth2"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::OAuth2::VERSION
+end

data/spec/omniauth/strategies/oauth2_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::OAuth2 do
+  def app; lambda{|env| [200, {}, ["Hello."]]} end
+  let(:fresh_strategy){ Class.new(OmniAuth::Strategies::OAuth2) }
+
+  describe '#client' do
+    subject{ fresh_strategy }
+
+    it 'should be initialized with symbolized client_options' do
+      instance = subject.new(app, :client_options => {'authorize_url' => 'https://example.com'})
+      instance.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#authorize_params' do
+    subject { fresh_strategy }
+
+    it 'should include any authorize params passed in the :authorize_params option' do
+      instance = subject.new('abc', 'def', :authorize_params => {:foo => 'bar', :baz => 'zip'})
+      instance.authorize_params.should == {'foo' => 'bar', 'baz' => 'zip'}
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      instance = subject.new('abc', 'def', :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz')
+      instance.authorize_params.should == {'scope' => 'bar', 'foo' => 'baz'}
+    end
+  end
+
+  describe '#token_params' do
+    subject { fresh_strategy }
+
+    it 'should include any authorize params passed in the :authorize_params option' do
+      instance = subject.new('abc', 'def', :token_params => {:foo => 'bar', :baz => 'zip'})
+      instance.token_params.should == {'foo' => 'bar', 'baz' => 'zip'}
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      instance = subject.new('abc', 'def', :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz')
+      instance.token_params.should == {'scope' => 'bar', 'foo' => 'baz'}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-oauth2'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end
+

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+  prerelease: 6
+platform: ruby
+authors:
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70318691424740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70318691424740
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: &70318691424240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70318691424240
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: &70318691423780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70318691423780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70318691423320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70318691423320
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70318691422940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70318691422940
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70318691422480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70318691422480
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70318691422060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70318691422060
+description: An abstract OAuth2 strategy for OmniAuth.
+email:
+- michael@intridea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/omniauth-oauth2.rb
+- lib/omniauth-oauth2/version.rb
+- lib/omniauth/strategies/oauth2.rb
+- omniauth-oauth2.gemspec
+- spec/omniauth/strategies/oauth2_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/intridea/omniauth-oauth2
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: An abstract OAuth2 strategy for OmniAuth.
+test_files:
+- spec/omniauth/strategies/oauth2_spec.rb
+- spec/spec_helper.rb