omniauth-paypal 1.1 → 1.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWFiOTYxMmIxMmFlMDU5ZDllNDc3YWU3OWEzZjYwNmFjZTlkNDVkMQ==
+  data.tar.gz: !binary |-
+    M2Y3ZmFmZDU5MThlYWUzOWVlMWEwNmRhNzg0Y2JkZTEwNzU2MGQ2NA==
+SHA512:
+  metadata.gz: !binary |-
+    ZGYzY2UyYWJhZDM1MDkxOGI2ZTgxYzIwZGZkNWZjODM2MzRlZTg3NThjODQ4
+    MzNmMjE0ODVkMGMxYmM0ZmY5N2IzNjFjMjljM2Y4ODhiZDZiOTg3OWEzNzRm
+    ZTY5OTJjMzU2ZjQyMTY2ZTA0NGIyYjkwNjMwZTgzOTRiM2M4ODE=
+  data.tar.gz: !binary |-
+    YTA3OGZiNDA1YTU3ODg2ZjRhNTNkY2QwNmUxY2VkMzJlMDE0YjM3MzhlNGRh
+    NDllZDJkZjIzNzQwNGRlM2JhYTU4ODQxZWViMmVmMDc4ZDMwYTY3NTc1MGQ4
+    ODQwMGJkMWFiNjQ5ZjI1MmQwNTliMTI5NGI5ZTRmMTNmMTViZGE=

data/.gitignore

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

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: git://github.com/intridea/omniauth-oauth2.git
-  revision: d6409bb14337675e22c50f3c76b5d7f672a631a3
+  revision: 8a7a97ecbdb71c04b96bfa47dbc465d5d931f694
   specs:
     omniauth-oauth2 (1.1.1)
       oauth2 (~> 0.9.0)
@@ -9,43 +9,43 @@ GIT
 PATH
   remote: .
   specs:
-    omniauth-paypal (1.0)
+    omniauth-paypal (1.2)
       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)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    hashie (2.0.5)
     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)
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.8.0)
+    multi_xml (0.5.5)
     multipart-post (1.2.0)
-    oauth2 (0.9.1)
+    oauth2 (0.9.2)
       faraday (~> 0.8)
-      httpauth (~> 0.1)
+      httpauth (~> 0.2)
       jwt (~> 0.1.4)
       multi_json (~> 1.0)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    omniauth (1.1.3)
-      hashie (~> 1.2)
+    omniauth (1.1.4)
+      hashie (>= 1.2, < 3)
       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)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
 
 PLATFORMS
   ruby
@@ -55,4 +55,4 @@ DEPENDENCIES
   omniauth-oauth2 (~> 1.1.1)!
   omniauth-paypal!
   rake
-  rspec (~> 2.7.0)
+  rspec (~> 2.14)

data/README.md

@@ -2,14 +2,14 @@
 
 **Note:** This gem is designed to work with OmniAuth 1.0 library.
 
-This gem contains the PayPal Access using OpenID strategy for OmniAuth.
+This gem contains the Log In With PayPal strategy for OmniAuth.
 
 ## Installing
 
 Add to your `Gemfile`:
 
 ```ruby
-gem 'omniauth-paypal', :git => "git://github.com/datariot/omniauth-paypal.git"
+gem "omniauth-paypal"
 ```
 
 Then `bundle install`.
@@ -20,82 +20,104 @@ Here's a quick example, adding the middleware to a Rails app in `config/initiali
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :paypal, ENV['APP_ID'], ENV['APP_TOKEN']
+  provider :paypal, ENV['APP_ID'], ENV['APP_TOKEN'], sandbox: true, scope: "openid profile email"
 end
 ```
 
-## info
+## Attributes and Scopes
 
-PayPal Access information https://www.x.com/developers/x.commerce/products/paypal-access
+Log In With PayPal information can be found on https://developer.paypal.com/webapps/developer/docs/integration/direct/log-in-with-paypal/
 
-The maximum info returned currently is:
+The possible attributes to be returned at the moment are:
 
-    info['name']
-    info['email']
-    info['first_name']
-    info['last_name]
-    info['location']
-    info['phone']
+```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']
+```
 
-    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']
+The actual set of attributes returned depends on the scopes set. The currently available scopes are:
 
-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.
+```
+openid
+profile
+email
+address
+phone
+https://uri.paypal.com/services/paypalattributes
+https://uri.paypal.com/services/expresscheckout
+```
 
-Actual set of attributes depends on these possible scopes:
+(those last 2 are scope names, not links)
 
-    openid
-    profile
-    email
-    address
-    phone
-    https://uri.paypal.com/services/paypalattributes
-(the last is scope name, not a link)
+For more details see the PayPal [list of attributes](https://developer.paypal.com/webapps/developer/docs/integration/direct/log-in-with-paypal/detailed/#attributes).
 
-For details see [this section](https://www.x.com/developers/paypal/documentation-tools/quick-start-guides/oauth-openid-connect-integration-paypal##attributes).
+## Registering for an API key
 
-To register your application for PayPal Access follow these instructions: https://www.x.com/developers/paypal/how-to-guides/how-register-application-paypal-access
+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.
 
-    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"
+```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
 

data/lib/omniauth/paypal/version.rb

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

data/lib/omniauth/strategies/paypal.rb

@@ -3,14 +3,15 @@ require 'omniauth-oauth2'
 module OmniAuth
   module Strategies
     class PayPal < OmniAuth::Strategies::OAuth2
-      DEFAULT_SCOPE = "profile"
+      DEFAULT_SCOPE = "openid profile"
       DEFAULT_RESPONSE_TYPE = "code"
-      SANDBOX_SITE = "https://www.sandbox.paypal.com"
+      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://www.paypal.com',
-        :authorize_url => '/webapps/auth/protocol/openidconnect/v1/authorize',
-        :token_url     => '/webapps/auth/protocol/openidconnect/v1/tokenservice',
+        :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
       }
 
@@ -26,6 +27,8 @@ module OmniAuth
                    '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']
                })
@@ -36,16 +39,21 @@ module OmniAuth
                    'account_type' => raw_info['account_type'],
                    'user_id' => raw_info['user_id'],
                    'address' => raw_info['address'],
-                   'verified_account' => raw_info['verified_account'],
+                   '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']
+                   'account_creation_date' => raw_info['account_creation_date'],
+                   'age_range' => raw_info['age_range'],
+                   'birthday' => raw_info['birthday']
                })
       end
 
       def setup_phase
-        options.client_options[:site] = SANDBOX_SITE if options.sandbox
+        if options.sandbox
+          options.client_options[:site] = SANDBOX_SITE
+          options.client_options[:authorize_url] = SANDBOX_AUTHORIZE_URL
+        end
       end
 
       def raw_info
@@ -64,7 +72,7 @@ module OmniAuth
           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 || {}
+          access_token.get('/v1/identity/openidconnect/userinfo', { :params => { :schema => 'openid'}}).parsed || {}
         end
 
         def prune!(hash)

data/omniauth-paypal.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'omniauth-oauth2', '~> 1.1.0'
 
-  s.add_development_dependency 'rspec', '~> 2.7.0'
+  s.add_development_dependency 'rspec', '~> 2.14'
   s.add_development_dependency 'rake'
 end

data/spec/omniauth/strategies/paypal_spec.rb

@@ -10,21 +10,27 @@ describe OmniAuth::Strategies::PayPal do
 
   describe '#client' do
     it 'has correct PayPal site' do
-      subject.client.site.should eq('https://www.paypal.com')
+      subject.client.site.should eq('https://api.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')
+      subject.client.site.should eq('https://api.sandbox.paypal.com')
     end
 
     it 'has correct authorize url' do
-      subject.client.options[:authorize_url].should eq('/webapps/auth/protocol/openidconnect/v1/authorize')
+      subject.client.options[:authorize_url].should 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
+      subject.client.options[:authorize_url].should eq('https://www.sandbox.paypal.com/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')
+      subject.client.options[:token_url].should eq('/v1/identity/openidconnect/tokenservice')
     end
   end
 

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-paypal
 version: !ruby/object:Gem::Version
-  version: '1.1'
-  prerelease: 
+  version: '1.2'
 platform: ruby
 authors:
 - David W. Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-17 00:00:00.000000000 Z
+date: 2013-10-02 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
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,23 +27,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -66,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -81,27 +75,26 @@ files:
 homepage: https://github.com/datariot/omniauth-paypal
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.1.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: PayPal Identity strategy for OmniAuth
 test_files:
 - spec/omniauth/strategies/paypal_spec.rb