omniauth-paypal-oauth2 1.4.13 → 1.4.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e4a7a29dbe49818dd003fba0c84883a3b25dc67
-  data.tar.gz: 7d47686bf5f3fd6d1a445ff149c2467eae949644
+SHA256:
+  metadata.gz: 12c2999b4af5ff0ac88422ec09126eccf6c8815f7524cb891f10ea9915d11c9e
+  data.tar.gz: 2da82c21ffa65e20c8b18edb9decf7c69728f1ff9c83c8aeed416bf97bb74f8b
 SHA512:
-  metadata.gz: f2d916910b12788dfe14e24018cbb786bc36d7891dbe79abc1cef4b6718e6f7f329198a51ec611dd3fc8d0e7f2c04a1f94c82030682d7c526d6bce901d5ed061
-  data.tar.gz: 1b6e4ec2e840037f609f7171e5d4908546f4e95eead7c8f50635639c1440626327069d6117f46c039429c1b6a70632cca0e702cf322efb9b36853ea9ccfdb302
+  metadata.gz: 99700535c14d5efda09a5d1843464b145115d5392d10ec2d4df65ca473cf0006cb6421eda57e1eee2db3e8fd735176be396360eb73ae4f4dceda3bee48fd58ef
+  data.tar.gz: 9438dc31f7abbb189a9586fd5251813dd399b1ff703ec8959da34a60fc9b6eea7f390f32d212fd6132820d463abc889b9a0086ba438a2286102d082b9e1da411

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.4.14 - 2018-01-06
+
+* enhancements
+    * cleaning up gem files

data/README.md

@@ -1,5 +1,7 @@
 # OmniAuth PayPal OAuth2 Strategy
 
+[![Gem Version](https://badge.fury.io/rb/omniauth-paypal-oauth2.svg)](https://badge.fury.io/rb/omniauth-paypal-oauth2) <img src="https://travis-ci.org/jonhue/omniauth-paypal-oauth2.svg?branch=master" />
+
 Strategy to authenticate with PayPal via OmniAuth.
 
 Get your API key at: https://developer.paypal.com/developer/applications/ in the section **RESTApps**. Note the Client ID and the Client Secret.
@@ -9,6 +11,24 @@ Use the [config Gem](https://rubygems.org/gems/config) to organize your keys and
 
 For more details, read the PayPal docs: https://developer.paypal.com/docs/integration/direct/identity/
 
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [PayPal API Setup](#paypal-api-setup)
+    * [Rails middleware](#rails-middleware)
+    * [Devise](#Devise)
+    * [Configuration](#configuration)
+    * [Auth hash](#auth-hash)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
 
 ## Installation
 
@@ -26,8 +46,11 @@ Or install it yourself as:
 
     $ gem install omniauth-paypal-oauth2
 
+---
 
-## PayPal API Setup
+## Usage
+
+### PayPal API Setup
 
 * Go to 'https://developer.paypal.com/developer/applications/'
 * Select your project.
@@ -37,8 +60,7 @@ Or install it yourself as:
 * Go to Credentials, then select the "OAuth consent screen" tab on top, and provide an 'EMAIL ADDRESS' and a 'PRODUCT NAME'
 * Wait 10 minutes for changes to take effect.
 
-
-## Usage
+### Rails middleware
 
 Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
 
@@ -52,8 +74,76 @@ You can now access the OmniAuth PayPal OAuth2 URL: `/auth/paypal_oauth2`
 
 **Note**: While developing your application, if you change the scope in the initializer you will need to restart your app server. Remember that either the 'email' or 'profile' scope is required!
 
+### Devise
+
+First define your application id and secret in `config/initializers/devise.rb`. Do not use the snippet mentioned in the [Usage](https://github.com/jonhue/omniauth-paypal-oauth2#usage) section.
+
+```ruby
+require "omniauth-paypal-oauth2"
+config.omniauth :paypal_oauth2, "PAYPAL_CLIENT_ID", "PAYPAL_CLIENT_SECRET"
+```
+
+Then add the following to 'config/routes.rb' so the callback routes are defined.
+
+```ruby
+devise_for :users, :controllers => { :omniauth_callbacks => "users/omniauth_callbacks" }
+```
+
+Make sure your model is omniauthable. Generally this is "/app/models/user.rb"
+
+```ruby
+devise :omniauthable, :omniauth_providers => [:paypal_oauth2]
+```
+
+Then make sure your callbacks controller is setup.
+
+```ruby
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  def paypal_oauth2
+      # You need to implement the method below in your model (e.g. app/models/user.rb)
+      @user = User.from_omniauth(request.env["omniauth.auth"])
+
+      if @user.persisted?
+        flash[:notice] = I18n.t "devise.omniauth_callbacks.success", :kind => "PayPal"
+        sign_in_and_redirect @user, :event => :authentication
+      else
+        session["devise.paypal_data"] = request.env["omniauth.auth"]
+        redirect_to new_user_registration_url
+      end
+  end
+end
+```
+
+and bind to or create the user
+
+```ruby
+def self.from_omniauth(access_token)
+    data = access_token.info
+    user = User.where(:email => data["email"]).first
+
+    # Uncomment the section below if you want users to be created if they don't exist
+    # unless user
+    #     user = User.create(name: data["name"],
+    #        email: data["email"],
+    #        password: Devise.friendly_token[0,20]
+    #     )
+    # end
+    user
+end
+```
 
-## Configuration
+For your views you can login using:
+
+```erb
+<%= link_to "Sign in with PayPal", user_paypal_oauth2_omniauth_authorize_path %>
+
+<%# Devise prior 4.1.0: %>
+<%= link_to "Sign in with PayPal", user_omniauth_authorize_path(:paypal_oauth2) %>
+```
+
+An overview is available at https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview
+
+### Configuration
 
 If you click from your [Applications Dashboard](https://developer.paypal.com/developer/applications/) in your Application on "Advanced Options" in the "APP SETTINGS" section and "Log In with PayPal" subsection, you can configure several options:
 
@@ -81,8 +171,7 @@ If you click from your [Applications Dashboard](https://developer.paypal.com/dev
     * `Locale`: Permits a locale string which indicates where the PayPal customer is.
     * `Language`: Permits the language the customer uses on PayPal.
 
-
-## Auth Hash
+### Auth Hash
 
 Here's an example of an authentication hash available in the callback by accessing `request.env["omniauth.auth"]`:
 
@@ -129,76 +218,31 @@ Here's an example of an authentication hash available in the callback by accessi
 
 For more details see the PayPal [List Of Attributes](https://developer.paypal.com/webapps/developer/docs/integration/direct/log-in-with-paypal/detailed/#attributes).
 
+---
 
-### Devise
+## To Do
 
-First define your application id and secret in `config/initializers/devise.rb`. Do not use the snippet mentioned in the [Usage](https://github.com/jonhue/omniauth-paypal-oauth2#usage) section.
+[Here](https://github.com/jonhue/omniauth-paypal-oauth2/projects/1) is the full list of current projects.
 
-```ruby
-require "omniauth-paypal-oauth2"
-config.omniauth :paypal_oauth2, "PAYPAL_CLIENT_ID", "PAYPAL_CLIENT_SECRET"
-```
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/omniauth-paypal-oauth2/issues/new).
 
-Then add the following to 'config/routes.rb' so the callback routes are defined.
+---
 
-```ruby
-devise_for :users, :controllers => { :omniauth_callbacks => "users/omniauth_callbacks" }
-```
+## Contributing
 
-Make sure your model is omniauthable. Generally this is "/app/models/user.rb"
+We hope that you will consider contributing to omniauth-paypal-oauth2. Please read this short overview for some information about how to get started:
 
-```ruby
-devise :omniauthable, :omniauth_providers => [:paypal_oauth2]
-```
+[Learn more about contributing to this repository](https://github.com/jonhue/omniauth-paypal-oauth2/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/jonhue/omniauth-paypal-oauth2/blob/master/CODE_OF_CONDUCT.md)
 
-Then make sure your callbacks controller is setup.
+### Contributors
 
-```ruby
-class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
-  def paypal_oauth2
-      # You need to implement the method below in your model (e.g. app/models/user.rb)
-      @user = User.from_omniauth(request.env["omniauth.auth"])
+Give the people some :heart: who are working on this project. See them all at:
 
-      if @user.persisted?
-        flash[:notice] = I18n.t "devise.omniauth_callbacks.success", :kind => "PayPal"
-        sign_in_and_redirect @user, :event => :authentication
-      else
-        session["devise.paypal_data"] = request.env["omniauth.auth"]
-        redirect_to new_user_registration_url
-      end
-  end
-end
-```
+https://github.com/jonhue/omniauth-paypal-oauth2/graphs/contributors
 
-and bind to or create the user
-
-```ruby
-def self.from_omniauth(access_token)
-    data = access_token.info
-    user = User.where(:email => data["email"]).first
-
-    # Uncomment the section below if you want users to be created if they don't exist
-    # unless user
-    #     user = User.create(name: data["name"],
-    #        email: data["email"],
-    #        password: Devise.friendly_token[0,20]
-    #     )
-    # end
-    user
-end
-```
-
-For your views you can login using:
-
-```erb
-<%= link_to "Sign in with PayPal", user_paypal_oauth2_omniauth_authorize_path %>
-
-<%# Devise prior 4.1.0: %>
-<%= link_to "Sign in with PayPal", user_omniauth_authorize_path(:paypal_oauth2) %>
-```
-
-An overview is available at https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview
+### Semantic Versioning
 
+omniauth-paypal-oauth2 follows Semantic Versioning 2.0 as defined at http://semver.org.
 
 ## License
 

data/lib/omniauth/paypal_oauth2/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
     module PaypalOauth2
-        VERSION = '1.4.13'
+        VERSION = '1.4.14'
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-paypal-oauth2
 version: !ruby/object:Gem::Version
-  version: 1.4.13
+  version: 1.4.14
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -38,55 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.52'
 description: A PayPal OAuth2 strategy for OmniAuth
 email:
-- jonas@slooob.com
+- jonas.huebotter@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
+- CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
-- _config.yml
-- examples/shared_examples.rb
 - lib/omniauth-paypal-oauth2.rb
 - lib/omniauth/paypal_oauth2.rb
 - lib/omniauth/paypal_oauth2/version.rb
 - lib/omniauth/strategies/paypal_oauth2.rb
-- omniauth-paypal-oauth2.gemspec
-- spec/omniauth/strategies/paypal_oauth2_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/jonhue/omniauth-paypal-oauth2
 licenses:
 - MIT
@@ -107,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A PayPal OAuth2 strategy for OmniAuth

data/.gitignore

@@ -1,20 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.idea/
-.ruby-version
-.ruby-gemset

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-# Development
-group :development do
-    gem 'rubocop', '~> 0.47.1', require: false
-end

data/Rakefile

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

data/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-minimal

data/examples/shared_examples.rb

@@ -1,36 +0,0 @@
-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

data/omniauth-paypal-oauth2.gemspec

@@ -1,24 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path(File.join('..', 'lib', 'omniauth', 'paypal_oauth2', 'version'), __FILE__)
-
-Gem::Specification.new do |gem|
-    gem.name          = 'omniauth-paypal-oauth2'
-    gem.version       = OmniAuth::PaypalOauth2::VERSION
-    gem.license       = 'MIT'
-    gem.summary       = 'A PayPal OAuth2 strategy for OmniAuth'
-    gem.description   = 'A PayPal OAuth2 strategy for OmniAuth'
-    gem.authors       = ['Jonas Hübotter']
-    gem.email         = ['jonas@slooob.com']
-    gem.homepage      = 'https://github.com/jonhue/omniauth-paypal-oauth2'
-
-    gem.files         = `git ls-files`.split("\n")
-    gem.require_paths = ['lib']
-
-    gem.required_ruby_version = '>= 2.0'
-
-    gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.4'
-    gem.add_runtime_dependency 'json', '~> 1.7'
-
-    gem.add_development_dependency 'rspec', '~> 3'
-    gem.add_development_dependency 'rake'
-end

data/spec/omniauth/strategies/paypal_oauth2_spec.rb

@@ -1,49 +0,0 @@
-require 'spec_helper'
-require 'omniauth-paypal-oauth2'
-
-describe OmniAuth::Strategies::PaypalOauth2 do
-    subject do
-        OmniAuth::Strategies::PaypalOauth2.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 { 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_oauth2/callback')
-        end
-    end
-end

data/spec/spec_helper.rb

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