omniauth-exvo 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+coverage/*
+pkg/*

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2011-2012 Exvo.com Development BV
+
+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,31 @@
+# OmniAuth Exvo
+
+This gem contains the official Exvo strategy for OmniAuth 1.0.
+
+It depends on the [exvo_helpers](https://github.com/Exvo/exvo_helpers) gem for its configuration.
+
+There is also [exvo-auth](https://github.com/Exvo/exvo_auth) gem, which provides additional helper methods, which make both users and app authorizations at Exvo easier.
+
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-exvo'
+```
+
+Then `bundle install`.
+
+
+## Basic usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :exvo, ENV['AUTH_CLIENT_ID'], ENV['AUTH_CLIENT_SECRET']
+end
+```
+
+
+
+Copyright © 2011-2012 Exvo.com Development BV, released under the MIT license

data/Rakefile

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

data/lib/omniauth-exvo.rb

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

data/lib/omniauth-exvo/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Exvo
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/strategies/exvo.rb

@@ -0,0 +1,84 @@
+require 'omniauth-oauth2'
+require 'exvo_helpers'
+
+module OmniAuth
+  module Strategies
+    class Exvo < OmniAuth::Strategies::OAuth2
+
+      option :name, 'exvo'
+
+      option :client_options, {
+        :site => ::Exvo::Helpers.auth_uri,
+        :token_url => ::Exvo::Helpers.auth_uri + '/oauth/access_token'
+      }
+
+      def request_phase
+        options[:scope] = request["scope"] if request["scope"]
+        options[:state] = request["state"] if request["state"]
+        options[:x_sign_up] = request["x_sign_up"] if request["x_sign_up"]
+        super
+      end
+
+      def callback_phase
+        set_failure_handler
+        super
+      end
+
+      def callback_key
+        '_callback'
+      end
+
+      def callback_url
+        if interactive?
+          super
+        else
+          super + "?" + Rack::Utils.build_query(callback_key => request[callback_key])
+        end
+      end
+
+      def interactive?
+        !non_interactive?
+      end
+
+      def non_interactive?
+        !!request[callback_key]
+      end
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          'nickname' => raw_info['nickname'],
+          'email' => raw_info['email']
+        }
+      end
+
+      extra do
+        {
+          :raw_info => raw_info
+        }
+      end
+
+      def raw_info
+        access_token.options[:mode] = :query
+        access_token.options[:param_name] = :access_token
+        @raw_info ||= access_token.get('/user.json').parsed
+      end
+
+      def set_failure_handler
+        OmniAuth.config.on_failure =
+          if interactive?
+            Proc.new do |env|
+              message_key = env['omniauth.error.type']
+              new_path = "#{env['SCRIPT_NAME']}#{OmniAuth.config.path_prefix}/failure?message=#{message_key}"
+              [302, { 'Location' => new_path, 'Content-Type'=> 'text/html' }, []]
+            end
+          else
+            OmniAuth.config.on_failure = Proc.new do |env|
+              [401, { 'Content-Type' => 'application/javascript' }, [MultiJson.encode(:error => env['omniauth.error.type'])]]
+            end
+          end
+      end
+    end
+  end
+end

data/omniauth-exvo.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-exvo/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "omniauth-exvo"
+  gem.version     = Omniauth::Exvo::VERSION
+  gem.authors     = ["Paweł Gościcki"]
+  gem.email       = ["pawel.goscicki@gmail.com"]
+  gem.homepage    = "https://github.com/Exvo/omniauth-exvo/"
+  gem.summary     = "OmniAuth strategy for Exvo"
+  gem.description = "OmniAuth strategy for Exvo"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'omniauth', '~> 1.0'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.0'
+  gem.add_dependency 'exvo_helpers', '~> 0.2'
+
+  gem.add_development_dependency 'rspec', '>= 2.8'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'webmock'
+
+  gem.add_development_dependency 'guard', ['~> 1.0']
+  gem.add_development_dependency 'guard-rspec', ['>= 0.6.0']
+  gem.add_development_dependency "rb-fsevent"
+  gem.add_development_dependency "rb-inotify"
+
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov-rcov"
+end

data/spec/omniauth/strategies/exvo_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Exvo do
+
+  attr_accessor :app
+
+  def set_app!
+    self.app = Rack::Builder.app do
+      use Rack::Session::Cookie
+      use OmniAuth::Strategies::Exvo
+      run lambda { |env| [200, {'env' => env}, ['Hello!']] }
+    end
+  end
+
+  subject do
+    OmniAuth::Strategies::Exvo.new(nil, @options || {})
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'should have the correct Exvo Auth site' do
+      subject.client.site.should eq('https://auth.exvo.com')
+    end
+
+    it 'should have the correct authorization url' do
+      subject.client.options[:authorize_url].should eq('/oauth/authorize')
+    end
+
+    it 'should have the correct token url' do
+      subject.client.options[:token_url].should match(/\/oauth\/access_token$/)
+    end
+  end
+
+  describe '#callback_key' do
+    specify { subject.callback_key.should match(/callback/) }
+  end
+
+  describe '#callback_path' do
+    its(:callback_path) { should eq('/auth/exvo/callback') }
+  end
+
+  describe '#callback_url' do
+    before do
+      subject.request.should_receive(:url).and_return('https://auth.exvo.com')
+      subject.should_receive(:script_name).and_return('')
+    end
+
+    it 'should have the correct callback url' do
+      subject.should_receive(:interactive?).and_return(true)
+      subject.callback_url.should eq('https://auth.exvo.com/auth/exvo/callback')
+    end
+
+    it 'should include _callback param if it is passed in request' do
+      subject.should_receive(:interactive?).and_return(false)
+      subject.request.should_receive(:[]).with('_callback').and_return('123')
+      subject.callback_url.should eq('https://auth.exvo.com/auth/exvo/callback?_callback=123')
+    end
+  end
+
+  describe '#interactive? and #non_interactive? return false and true, respectively, if request has callback key' do
+    before do
+      subject.request.should_receive(:[]).with('_callback').and_return('123')
+    end
+
+    it { should_not be_interactive }
+    it { should be_non_interactive }
+  end
+
+  describe '#uid' do
+    it 'returns the uid from raw_info' do
+      subject.stub(:raw_info).and_return({ 'id' => '123' })
+      subject.uid.should eq('123')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      subject.stub(:raw_info).and_return({ 'id' => '123', 'nickname' => 'Pawel', 'email' => 'some@email.com' })
+    end
+
+    it 'returns the nickname' do
+      subject.info['nickname'].should eq('Pawel')
+    end
+
+    it 'returns the email' do
+      subject.info['email'].should eq('some@email.com')
+    end
+  end
+
+  describe '#extra' do
+    let(:extra) { { 'language' => 'en' } }
+
+    it 'returns a hash of extra information' do
+      subject.stub(:raw_info).and_return(extra)
+      subject.extra.should eq({ :raw_info => extra })
+    end
+  end
+
+  describe '#credentials' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      @access_token.stub(:token).and_return('123')
+      @access_token.stub(:expires?).and_return(false)
+      subject.stub(:access_token).and_return(@access_token)
+    end
+
+    specify { subject.credentials.should be_a(Hash) }
+
+    specify { subject.credentials['token'].should eq('123') }
+
+    specify { subject.credentials['expires'].should eq(false) }
+  end
+
+  describe '#request_phase' do
+    before do
+      set_app!
+    end
+
+    it 'redirects to auth app with a callback param' do
+      get '/auth/exvo'
+      last_response.should be_redirect
+
+      follow_redirect!
+      last_request.url.should match(/^https:\/\/auth\.exvo\.com\/.+callback$/)
+    end
+  end
+
+  describe '#set_failure_handler' do
+    let(:env) { { 'omniauth.error.type' => 'invalid_credentials', 'SCRIPT_NAME' => 'http://example.com' } }
+    let(:failure) { OmniAuth.config.on_failure.call(env) }
+
+    context "interactive" do
+      before do
+        subject.should_receive(:interactive?).and_return(true)
+        subject.set_failure_handler
+      end
+
+      it 'sets a redirect Rack response array' do
+        failure[0].should eq(302)
+        failure[1]['Location'].should match(/^http:\/\/example.com\/auth\/failure/)
+      end
+    end
+
+    context "non_interactive" do
+      before do
+        subject.should_receive(:interactive?).and_return(false)
+        subject.set_failure_handler
+      end
+
+      it 'sets an unauthorized Rack response array' do
+        failure[0].should eq(401)
+        failure[2][0].should match(/invalid_credentials/)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+require 'simplecov-rcov'
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.start
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'rack/test'
+require 'omniauth-exvo'
+
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.include Rack::Test::Methods
+  config.extend OmniAuth::Test::StrategyMacros, :type => :strategy
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,38 @@
+shared_examples 'an oauth2 strategy' do
+
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.authorize_params['foo'].should eq('bar')
+      subject.authorize_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('bar')
+      subject.authorize_params['foo'].should eq('baz')
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any token params passed in the :token_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :token_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+
+end

metadata

@@ -0,0 +1,253 @@
+--- !ruby/object:Gem::Specification 
+name: omniauth-exvo
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Pawe\xC5\x82 Go\xC5\x9Bcicki"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-26 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: omniauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: omniauth-oauth2
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: exvo_helpers
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 8
+        version: "2.8"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rb-fsevent
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: rb-inotify
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: simplecov-rcov
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id012
+description: OmniAuth strategy for Exvo
+email: 
+- pawel.goscicki@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-exvo.rb
+- lib/omniauth-exvo/version.rb
+- lib/omniauth/strategies/exvo.rb
+- omniauth-exvo.gemspec
+- spec/omniauth/strategies/exvo_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+has_rdoc: true
+homepage: https://github.com/Exvo/omniauth-exvo/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for Exvo
+test_files: []
+