omniauth-paypal-oauth2 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e858f9b31dcbdb2a17016d12f17b4bf8acac5105
+  data.tar.gz: fb46dfdb22debb4a9e814be9706ae801c74cb4ba
+SHA512:
+  metadata.gz: a26124a6a3f214042b767df8cd650465f416d60769a59207c6cd0671f92d852c03d3349285ef5e7698735bdeece9c5ea9976f9f50b216b151cb98b731346e06e
+  data.tar.gz: 1f3dad26a5adc22edbc35e4a84650c4780a7674d3330cb0dd708f8e16852e57bc06e68164227078f3900fee8b00eb71fb3a42b9573174cd264f419bd5987b353

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'omniauth-oauth2', "~> 1.4.0"
+gem 'json'

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    omniauth-paypal-oauth2 (1.3)
+      omniauth-oauth2 (~> 1.4.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    faraday (0.10.1)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.4.6)
+    json (2.0.3)
+    jwt (1.5.6)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.3.0)
+      faraday (>= 0.8, < 0.11)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.3.1)
+      hashie (>= 1.2, < 4)
+      rack (>= 1.0, < 3)
+    omniauth-oauth2 (1.4.0)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    rack (2.0.1)
+    rake (12.0.0)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  json
+  omniauth-oauth2 (~> 1.4.0)
+  omniauth-paypal-oauth2!
+  rake
+  rspec (~> 2.14)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,130 @@
+# OmniAuth PayPal
+
+**Note:** This gem is designed to work with OmniAuth 1.0 library.
+
+This gem contains the Log In With PayPal strategy for OmniAuth.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem "omniauth-paypal"
+```
+
+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'], sandbox: true, scope: "openid profile email"
+end
+```
+
+## Attributes and Scopes
+
+Log In With PayPal information can be found on https://developer.paypal.com/webapps/developer/docs/integration/direct/log-in-with-paypal/
+
+The possible attributes to be returned at the moment are:
+
+```ruby
+info['name']
+info['email']
+info['first_name'] # also available as given_name
+info['last_name'] # also available as family_name
+info['location']
+info['name']
+info['phone']
+
+extra['account_creation_date']
+extra['account_type']
+extra['address']['country']
+extra['address']['locality']
+extra['address']['postal_code']
+extra['address']['region']
+extra['address']['street_address']
+extra['language']
+extra['locale']
+extra['verified_account']
+extra['zoneinfo']
+extra['age_range']
+extra['birthday']
+```
+
+The actual set of attributes returned depends on the scopes set. The currently available scopes are:
+
+```
+openid
+profile
+email
+address
+phone
+https://uri.paypal.com/services/paypalattributes
+https://uri.paypal.com/services/expresscheckout
+```
+
+(those last 2 are scope names, not links)
+
+For more details see the PayPal [list of attributes](https://developer.paypal.com/webapps/developer/docs/integration/direct/log-in-with-paypal/detailed/#attributes).
+
+## Registering for an API key
+
+To register your application for Log In With PayPal head over to the [PayPal Developer portal](https://developer.paypal.com/), log in and register for an application. Make sure to match your scope when registering your app to the scope provided when initializing Omniauth.
+
+[A full tutorial is available](http://cristianobetta.com/blog/2013/09/27/integrating-login-with-paypal-into-rails/) on how to use Omniauth, Login With PayPal, and the PayPal Developer portal.
+
+## Example of result auth hash
+With all scopes requested.
+
+```yaml
+provider: paypal
+uid: bathjJwvdhKjgfgh8Jd745J7dh5Qkgflbnczd65dfnw
+info:
+  name: John Smith
+  email: example@example.com
+  first_name: John
+  last_name: Smith
+  given_name: John
+  family_name: Smith
+  location: Moscow
+  name: John Smith
+  phone: "71234567890"
+credentials:
+  token: <token>
+  refresh_token: <refresh token>
+  expires_at: 1355082790
+  expires: true
+extra:
+  account_creation_date: "2008-04-21"
+  account_type: PERSONAL
+  user_id: https://www.paypal.com/webapps/auth/identity/user/bathjJwvdhKjgfgh8Jd745J7dh5Qkgflbnczd65dfnw
+  address:
+    country: US
+    locality: San Jose
+    postal_code: "95131"
+    region: CA
+    street_address: 1 Main St
+  language: en_US
+  locale: en_US
+  verified_account: true
+  zoneinfo: America/Los_Angeles
+  age_range: 31-35
+  birthday: "1982-01-01"
+```
+
+## Contributing
+
+Log In With PayPal has been in flux since I started this project and anything that helps keep this gem up to date and tested is greatly apprecitated. Thanks for your help!
+
+## 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.rb

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

data/lib/omniauth/paypal.rb

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

data/lib/omniauth/paypal/version.rb

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

data/lib/omniauth/strategies/paypal.rb

@@ -0,0 +1,90 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class PayPal < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "openid profile"
+      DEFAULT_RESPONSE_TYPE = "code"
+      SANDBOX_SITE = "https://api.sandbox.paypal.com"
+      SANDBOX_AUTHORIZE_URL = 'https://www.sandbox.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize'
+
+      option :client_options, {
+        :site          => 'https://api.paypal.com',
+        :authorize_url => 'https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize',
+        :token_url     => '/v1/identity/openidconnect/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'],
+                   'given_name' => raw_info['given_name'],
+                   'family_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'] == 'true'),
+                   'language' => raw_info['language'],
+                   'zoneinfo' => raw_info['zoneinfo'],
+                   'locale' => raw_info['locale'],
+                   'account_creation_date' => raw_info['account_creation_date'],
+                   'age_range' => raw_info['age_range'],
+                   'birthday' => raw_info['birthday']
+               })
+      end
+
+      def setup_phase
+        if options.sandbox
+          options.client_options[:site] = SANDBOX_SITE
+          options.client_options[:authorize_url] = SANDBOX_AUTHORIZE_URL
+        end
+        super
+      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('/v1/identity/openidconnect/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/omniauth-paypal-oauth2.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-oauth2'
+  s.version  = '1.4.0'
+  s.authors  = ['Jonas Hübotter']
+  s.email    = ['jonas.huebotter@gmail.com']
+  s.summary  = 'PayPal Identity strategy for OmniAuth2'
+  s.homepage = 'https://github.com/jonhue/omniauth-paypal-oauth2'
+  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.4.0'
+
+  s.add_development_dependency 'rspec', '~> 2.14'
+  s.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/paypal_spec.rb

@@ -0,0 +1,50 @@
+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
+      expect(subject.client.site).to eq('https://api.paypal.com')
+    end
+
+    it 'has correct PayPal sandbox site' do
+      @options = { :sandbox => true }
+      subject.setup_phase
+      expect(subject.client.site).to eq('https://api.sandbox.paypal.com')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.client.options[:authorize_url]).to eq('https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize')
+    end
+
+    it 'has correct sandbox authorize url' do
+      @options = { :sandbox => true }
+      subject.setup_phase
+      expect(subject.client.options[:authorize_url]).to eq('https://www.sandbox.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize')
+    end
+
+    it 'has correct token url' do
+      expect(subject.client.options[:token_url]).to eq('/v1/identity/openidconnect/tokenservice')
+    end
+
+    it 'runs the setup block if passed one' do
+      counter = ''
+      @options = { :setup => Proc.new { |env| counter = 'ok' } }
+      subject.setup_phase
+      expect(counter).to eq("ok")
+    end
+  end
+
+  describe '#callback_path' do
+    it "has the correct callback path" do
+      expect(subject.callback_path).to 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' } }
+      expect(subject.client.options[:authorize_url]).to eq('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' } }
+      expect(subject.authorize_params['foo']).to eq('bar')
+      expect(subject.authorize_params['baz']).to 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' }
+      expect(subject.authorize_params['scope']).to eq('bar')
+      expect(subject.authorize_params['foo']).to 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' } }
+      expect(subject.token_params['foo']).to eq('bar')
+      expect(subject.token_params['baz']).to 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' }
+      expect(subject.token_params['scope']).to eq('bar')
+      expect(subject.token_params['foo']).to eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-paypal-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-14 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.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !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: rake
+  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: 
+email:
+- jonas.huebotter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- 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-oauth2.gemspec
+- spec/omniauth/strategies/paypal_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/jonhue/omniauth-paypal-oauth2
+licenses:
+- MIT
+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.6.8
+signing_key: 
+specification_version: 4
+summary: PayPal Identity strategy for OmniAuth2
+test_files: []