omniauth-paypal-openid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc223104652396145b843652f6392b46b627de34
+  data.tar.gz: d2a19fa89f7bcc8279f2beb12dd24a7733b9bffd
+SHA512:
+  metadata.gz: 671bf6ad3053bce0b658005b8253dfad3657bfb4d1f00c7e52f2b12903bbd73cc41d93c80cdd9d092aed971c2f2ebac6b2d6160d720e8687c00de1ef8908f922
+  data.tar.gz: 201d4c111aff1f913dd2e56fb4357d47ae20317cbbcbd14a3b50f2477e7072a93a9225447dc8f383391bbb3dbf9d3d1b996e78432fbfc365a5a3c89581770cad

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kb1990@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'json'
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 kbravi
+
+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,130 @@
+# Omniauth PayPal OpenID
+
+This gem contains the Log In With PayPal OpenID strategy for OmniAuth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-paypal-openid'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install omniauth-paypal-openid
+```
+
+## 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_openid, 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']
+info['last_name']
+info['location']
+info['name']
+info['phone']
+
+extra['raw_info']['account_creation_date']
+extra['raw_info']['account_type']
+extra['raw_info']['address']['country']
+extra['raw_info']['address']['locality']
+extra['raw_info']['address']['postal_code']
+extra['raw_info']['address']['region']
+extra['raw_info']['address']['street_address']
+extra['raw_info']['language']
+extra['raw_info']['locale']
+extra['raw_info']['verified_account']
+extra['raw_info']['zoneinfo']
+extra['raw_info']['age_range']
+extra['raw_info']['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.
+
+## 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
+  location: Moscow
+  name: John Smith
+  phone: "71234567890"
+credentials:
+  token: <token>
+  refresh_token: <refresh token>
+  expires_at: 1355082790
+  expires: true
+extra:
+  raw_info:
+    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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-paypal-openid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/paypal/openid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth-paypal-openid.rb

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

data/lib/omniauth-paypal-openid/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module PayPalOpenID
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth/strategies/paypal-openid.rb

@@ -0,0 +1,112 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class PayPalOpenID < 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 :name, 'paypal_openid'
+      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',
+      }
+
+      option :authorize_options, [:scope, :response_type, :redirect_uri]
+      option :provider_ignores_state, true
+      option :sandbox, false
+
+      uid { @parsed_uid ||= (/\/([^\/]+)\z/.match raw_info['user_id'])[1] }
+
+      info do
+        prune!({
+          name: raw_info['name'],
+          email: raw_info['email'],
+          first_name: raw_info['given_name'],
+          last_name: raw_info['family_name'],
+          location: build_user_location,
+          phone: raw_info['phone_number'],
+          image: raw_info['picture']
+        })
+      end
+
+      extra do
+        prune!({'raw_info' => raw_info})
+      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 callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      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
+
+      def custom_build_access_token
+        access_token =
+        if request.xhr? && request.params['code']
+          verifier = request.params['code']
+          redirect_uri = request.params['redirect_uri'] || 'postmessage'
+          client.auth_code.get_token(verifier, get_token_options(redirect_uri), deep_symbolize(options.auth_token_params || {}))
+        elsif request.params['code'] && request.params['redirect_uri']
+          verifier = request.params['code']
+          redirect_uri = request.params['redirect_uri']
+          client.auth_code.get_token(verifier, get_token_options(redirect_uri), deep_symbolize(options.auth_token_params || {}))
+        else
+          verifier = request.params["code"]
+          client.auth_code.get_token(verifier, get_token_options(callback_url), deep_symbolize(options.auth_token_params))
+        end
+        access_token
+      end
+      alias_method :build_access_token, :custom_build_access_token
+
+      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 get_token_options(redirect_uri)
+        { :redirect_uri => redirect_uri }.merge(token_params.to_hash(:symbolize_keys => true))
+      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
+
+      def build_user_location
+        return unless raw_info['address']
+        location = [
+          raw_info['address']['locality'],
+          raw_info['address']['region']
+        ].compact.join(', ')
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'paypal_openid', 'PayPalOpenID'

data/omniauth-paypal-openid.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-paypal-openid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-paypal-openid"
+  spec.version       = OmniAuth::PayPalOpenID::VERSION
+  spec.authors       = ["Karthik Ravichandran"]
+  spec.email         = ["kb1990@gmail.com"]
+
+  spec.summary       = %q{PayPal Identity strategy for OmniAuth}
+  spec.homepage      = "https://github.com/kbravi/omniauth-paypal-openid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth', '>= 1.1.1'
+  spec.add_runtime_dependency 'omniauth-oauth2', '>= 1.3.1'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-paypal-openid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Karthik Ravichandran
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- kb1990@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-paypal-openid.rb
+- lib/omniauth-paypal-openid/version.rb
+- lib/omniauth/strategies/paypal-openid.rb
+- omniauth-paypal-openid.gemspec
+homepage: https://github.com/kbravi/omniauth-paypal-openid
+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.4.8
+signing_key: 
+specification_version: 4
+summary: PayPal Identity strategy for OmniAuth
+test_files: []