Skip to content

Latest commit

 

History

History
130 lines (100 loc) · 4.24 KB

README.md

File metadata and controls

130 lines (100 loc) · 4.24 KB
Raw

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:

gem "omniauth-paypal"

Then bundle install.

Usage

Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb.

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:

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.

Registering for an API key

To register your application for Log In With PayPal head over to the PayPal Developer portal, 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 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: [email protected]
  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.