omniauth-paypal 1.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'omniauth-oauth2', "~>1.1.1", :git => 'git://github.com/intridea/omniauth-oauth2.git'
+gem 'json'

data/Gemfile.lock

@@ -0,0 +1,58 @@
+GIT
+  remote: git://github.com/intridea/omniauth-oauth2.git
+  revision: d6409bb14337675e22c50f3c76b5d7f672a631a3
+  specs:
+    omniauth-oauth2 (1.1.1)
+      oauth2 (~> 0.9.0)
+      omniauth (~> 1.0)
+
+PATH
+  remote: .
+  specs:
+    omniauth-paypal (1.0)
+      omniauth-oauth2 (~> 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    faraday (0.8.6)
+      multipart-post (~> 1.1)
+    hashie (1.2.0)
+    httpauth (0.2.0)
+    json (1.6.6)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
+    multipart-post (1.2.0)
+    oauth2 (0.9.1)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    omniauth (1.1.3)
+      hashie (~> 1.2)
+      rack
+    rack (1.5.2)
+    rake (0.9.2.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json
+  omniauth-oauth2 (~> 1.1.1)!
+  omniauth-paypal!
+  rake
+  rspec (~> 2.7.0)

data/README.md

@@ -0,0 +1,108 @@
+# OmniAuth PayPal
+
+**Note:** This gem is designed to work with OmniAuth 1.0 library.
+
+This gem contains the PayPal Access using OpenID strategy for OmniAuth.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-paypal', :git => "git://github.com/datariot/omniauth-paypal.git"
+```
+
+Then `bundle install`.
+
+## Usage
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`.
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :paypal, ENV['APP_ID'], ENV['APP_TOKEN']
+end
+```
+
+## info
+
+PayPal Access information https://www.x.com/developers/x.commerce/products/paypal-access
+
+The maximum info returned currently is:
+
+    info['name']
+    info['email']
+    info['first_name']
+    info['last_name]
+    info['location']
+    info['phone']
+
+    extra['account_type']
+    extra['user_id']
+    extra['address']['postal_code']
+    extra['address']['locality']
+    extra['address']['country']
+    extra['address']['street_address']
+    extra['verified_account']
+    extra['language']
+    extra['zoneinfo']
+    extra['locale']
+    extra['account_creation_date']
+
+PayPal docs claim that day of birth also may be returned, but I was not able to find this param name, so it's not currently included.
+
+Actual set of attributes depends on these possible scopes:
+
+    openid
+    profile
+    email
+    address
+    phone
+    https://uri.paypal.com/services/paypalattributes
+(the last is scope name, not a link)
+
+For details see [this section](https://www.x.com/developers/paypal/documentation-tools/quick-start-guides/oauth-openid-connect-integration-paypal##attributes).
+
+To register your application for PayPal Access follow these instructions: https://www.x.com/developers/paypal/how-to-guides/how-register-application-paypal-access
+
+
+## Example of result auth hash
+With all scopes requested.
+
+    provider: paypal
+    uid: bathjJwvdhKjgfgh8Jd745J7dh5Qkgflbnczd65dfnw
+    info:
+      name: John Smith
+      email: example@example.com
+      first_name: John
+      last_name: Smith
+      location: Moscow
+      phone: "71234567890"
+    credentials:
+      token: <token>
+      refresh_token: <refresh token>
+      expires_at: 1355082790
+      expires: true
+    extra:
+      account_type: PERSONAL
+      user_id: https://www.paypal.com/webapps/auth/identity/user/bathjJwvdhKjgfgh8Jd745J7dh5Qkgflbnczd65dfnw
+      address:
+        postal_code: "123456"
+        locality: Moscow
+        country: RU
+        street_address: Red square, 1
+      verified_account: "true"
+      language: en_US
+      zoneinfo: America/Los_Angeles
+      locale: en_US
+      account_creation_date: "2008-04-21"
+
+## License
+
+Copyright (c) 2011 by veloGraf Systems
+
+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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/omniauth/paypal/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module PayPal
+    VERSION = "1.1"
+  end
+end

data/lib/omniauth/paypal.rb

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

data/lib/omniauth/strategies/paypal.rb

@@ -0,0 +1,81 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class PayPal < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "profile"
+      DEFAULT_RESPONSE_TYPE = "code"
+      SANDBOX_SITE = "https://www.sandbox.paypal.com"
+
+      option :client_options, {
+        :site          => 'https://www.paypal.com',
+        :authorize_url => '/webapps/auth/protocol/openidconnect/v1/authorize',
+        :token_url     => '/webapps/auth/protocol/openidconnect/v1/tokenservice',
+        :setup         => true
+      }
+
+      option :authorize_options, [:scope, :response_type]
+      option :provider_ignores_state, true
+      option :sandbox, false
+
+      uid { @parsed_uid ||= (/\/([^\/]+)\z/.match raw_info['user_id'])[1] } #https://www.paypal.com/webapps/auth/identity/user/baCNqjGvIxzlbvDCSsfhN3IrQDtQtsVr79AwAjMxekw => baCNqjGvIxzlbvDCSsfhN3IrQDtQtsVr79AwAjMxekw
+
+      info do
+        prune!({
+                   'name' => raw_info['name'],
+                   'email' => raw_info['email'],
+                   'first_name' => raw_info['given_name'],
+                   'last_name' => raw_info['family_name'],
+                   'location' => (raw_info['address'] || {})['locality'],
+                   'phone' => raw_info['phone_number']
+               })
+      end
+
+      extra do
+        prune!({
+                   'account_type' => raw_info['account_type'],
+                   'user_id' => raw_info['user_id'],
+                   'address' => raw_info['address'],
+                   'verified_account' => raw_info['verified_account'],
+                   'language' => raw_info['language'],
+                   'zoneinfo' => raw_info['zoneinfo'],
+                   'locale' => raw_info['locale'],
+                   'account_creation_date' => raw_info['account_creation_date']
+               })
+      end
+
+      def setup_phase
+        options.client_options[:site] = SANDBOX_SITE if options.sandbox
+      end
+
+      def raw_info
+        @raw_info ||= load_identity()
+      end
+
+      def authorize_params
+        super.tap do |params|
+          params[:scope] ||= DEFAULT_SCOPE
+          params[:response_type] ||= DEFAULT_RESPONSE_TYPE
+        end
+      end
+
+      private
+        def load_identity
+          access_token.options[:mode] = :query
+          access_token.options[:param_name] = :access_token
+          access_token.options[:grant_type] = :authorization_code
+          access_token.get('/webapps/auth/protocol/openidconnect/v1/userinfo', { :params => { :schema => 'openid'}}).parsed || {}
+        end
+
+        def prune!(hash)
+          hash.delete_if do |_, value|
+            prune!(value) if value.is_a?(Hash)
+            value.nil? || (value.respond_to?(:empty?) && value.empty?)
+          end
+        end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'paypal', 'PayPal'

data/lib/omniauth-paypal.rb

@@ -0,0 +1 @@
+require 'omniauth/paypal'

data/omniauth-paypal.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/paypal/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-paypal'
+  s.version  = OmniAuth::PayPal::VERSION
+  s.authors  = ['David W. Allen']
+  s.email    = ['david@datariot.io']
+  s.summary  = 'PayPal Identity strategy for OmniAuth'
+  s.homepage = 'https://github.com/datariot/omniauth-paypal'
+  s.license  = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.1.0'
+
+  s.add_development_dependency 'rspec', '~> 2.7.0'
+  s.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/paypal_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'omniauth-paypal'
+
+describe OmniAuth::Strategies::PayPal do
+  subject do
+    OmniAuth::Strategies::PayPal.new(nil, @options || {})
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct PayPal site' do
+      subject.client.site.should eq('https://www.paypal.com')
+    end
+
+    it 'has correct PayPal sandbox site' do
+      @options = { :sandbox => true }
+      subject.setup_phase
+      subject.client.site.should eq('https://www.sandbox.paypal.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/webapps/auth/protocol/openidconnect/v1/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/webapps/auth/protocol/openidconnect/v1/tokenservice')
+    end
+  end
+
+  describe '#callback_path' do
+    it "has the correct callback path" do
+      subject.callback_path.should eq('/auth/paypal/callback')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'rspec'
+require 'omniauth'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  OmniAuth.config.test_mode = true
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,37 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+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,109 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-paypal
+version: !ruby/object:Gem::Version
+  version: '1.1'
+  prerelease: 
+platform: ruby
+authors:
+- David W. Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- david@datariot.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/omniauth-paypal.rb
+- lib/omniauth/paypal.rb
+- lib/omniauth/paypal/version.rb
+- lib/omniauth/strategies/paypal.rb
+- omniauth-paypal.gemspec
+- spec/omniauth/strategies/paypal_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/datariot/omniauth-paypal
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: PayPal Identity strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/paypal_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb