omniauth-pacreception 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d82ca600c81b66497dc30d84e6f1ddf5dc86c48955a634507a9ea8a14c6910b8
+  data.tar.gz: ce437941985722bf4d0e6962dcef3aa27a0610b10f2a99c67d55a0945a5d409a
+SHA512:
+  metadata.gz: 5ba0c56f32403d89bf5bd000b30ce998fb39267e771d94220d1f08a3927ff507de3ea7e50946058fc2823d0e78ce460c3e0273b68690360827d71b2aad871a27
+  data.tar.gz: c2f12b2be899b4d35b521034d77acf168f8887f71153e0cd8ffa3be5e0873f72c54aafda630d17c7c226a3cb3bec23ae92366a440618cb1d4b2de1a31d5b571e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

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 TODO: Write your email address. 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"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in omniauth-pacreception.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    omniauth-pacreception (0.2.3)
+      omniauth-oauth2 (~> 1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.6.0)
+    jwt (2.1.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.9.0)
+      hashie (>= 3.4.6, < 3.7.0)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.6.0)
+      oauth2 (~> 1.1)
+      omniauth (~> 1.9)
+    rack (2.0.6)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  omniauth-pacreception!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,115 @@
+# Omniauth PacReception
+
+## PacReception OAuth2 Strategy for OmniAuth
+
+This is official OmniAuth strategy for authenticating to pacreception.com. To use it, you'll need to register your consumer application on pacreception.com to get pair of OAuth2 Application ID and Secret. It supports the OAuth 2.0 server-side and client-side flows for 3rd party OAuth consumer applications 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-pacreception'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-pacreception
+
+## Usage
+
+OmniAuth::Strategies::Pacreception is simply a Rack middleware.
+
+ First, register your application at 'www.pacreception.com/oauth/applications' with valid callback url to get app_id and secret (pacreception.com uses callback url to redirect to your app). Create environement variables 'PACRECEPTION_KEY', 'PACRECEPTION_SECRET' to store your app_id, secret respectively. 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 :pacreception, ENV['PACRECEPTION_KEY'], ENV['PACRECEPTION_SECRET']
+end
+```
+
+## Configuration
+
+You can configure several options, which you can pass in to the `provider` method via a `Hash`. also refer 'Examples' section accordingly.
+
+Option name | Default | Explanation
+--- | --- | ---
+`scope` | `public` | lets you set scope to provide granular access to different types of data. If not provided, scope defaults to 'public' for users. you can use any one of "write", "public" and "admin" values for scope.
+`auth_type` | nil | Optionally specifies the requested authentication feature. Valid value is 'reauthenticate' (asks the user to re-authenticate unconditionally). If not specified, default value is nil. (reuses the existing session of last authenticated user if any).
+`callback_path` | '/auth/:provider/callback' | Specify a custom callback URL used during the server-side flow. Note this must be same as specified at the time of your applicaiton registration at www.pacreception.com/oauth/applications. Execution flow returns back to this point at consumer application after authencitcation flow finishes at server-side. If not specified, default is '/auth/:provider/callback'. Make an entry for this end point in config/routes.rb of your consumer application. Strategy automatically replaces ':provider' by provider name as specified in config/initializers/omniauth.rb.
+
+### Examples 
+
+#### scope
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :pacreception, ENV['PACRECEPTION_KEY'], ENV['PACRECEPTION_SECRET'], { scope: 'admin' }
+end
+```
+If not specified, default scope is 'public'
+
+#### auth_type
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :pacreception, ENV['PACRECEPTION_KEY'], ENV['PACRECEPTION_SECRET'], 
+  		{ scope: 'admin', authorize_params: { auth_type: 'reauthenticate' }}
+end
+```
+If not specified, default is nil.
+
+#### callback_path
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :pacreception, ENV['PACRECEPTION_KEY'], ENV['PACRECEPTION_SECRET'], 
+      { scope: 'admin', authorize_params: { auth_type: 'reauthenticate' }, 
+        callback_path: '/your/custom/callback/path'}
+end
+```
+If not specified, default callback_path is '/auth/:provider/callback'.Here, finally it would be '/auth/pacreception/callback' as per explained in configuration table.
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  provider: 'pacreception',
+  uid: 1212123,
+  info: {
+    email: 'dark.knight@gotham.com',
+    name: 'Bruce Wayne'
+  },
+  credentials: {
+    token: 'ABCDEF...', # OAuth 2.0 access_token, which you may wish to store
+    expires_at: 1321747205, # when the access token expires (it always will)
+    expires: true # this will always be true
+  },
+  extra: {
+    raw_info: {
+      user: {
+        id: 1212123,
+        email: 'dark.knight@gotham.com',
+        first_name: 'Bruce',
+        last_name: 'Wayne'
+      }
+    }
+  }
+}
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/omniauth-pacreception/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'omniauth/pacreception'
+
+# 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/pacreception/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Pacreception
+    VERSION = "0.2.3"
+  end
+end

data/lib/omniauth/pacreception.rb

@@ -0,0 +1,9 @@
+require "omniauth/pacreception/version"
+require "omniauth/strategies/pacreception"
+
+module Omniauth
+  module Pacreception
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/omniauth/strategies/pacreception.rb

@@ -0,0 +1,60 @@
+require 'omniauth/strategies/oauth2'
+require 'uri'
+
+module OmniAuth
+  module Strategies
+    class Pacreception < OmniAuth::Strategies::OAuth2
+        # class NoAuthorizationCodeError < StandardError; en                
+        DEFAULT_SCOPE = 'public'
+
+        option :name, :pacreception
+
+        option :client_options, {
+          site: "https://www.pacreception.com"
+        }
+
+        option :authorize_options, [:scope, :auth_type]
+
+        uid {  raw_info['user']['id']  }
+    
+        info do
+          prune!({
+            'email' => raw_info['user']['email'],
+            'name' => "#{raw_info['user']['first_name']} #{raw_info['user']['last_name']}"
+          })
+        end
+
+        extra do 
+          hash = {}
+          hash['raw_info'] = raw_info unless skip_info?
+          prune! hash
+        end 
+
+        def raw_info
+          @raw_info ||= access_token.get('/api/v1/me').parsed
+        end
+
+        def authorize_params
+          super.tap do |params|
+            %w[scope auth_type].each do |v|
+                    if request.params[v]
+                        params[v.to_sym] = request.params[v]
+                    end
+            end
+            params[:scope] ||= DEFAULT_SCOPE
+          end
+        end 
+
+        def callback_url
+          options[:callback_url] || super
+        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

data/lib/omniauth-pacreception.rb

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

data/omniauth-pacreception.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omniauth/pacreception/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-pacreception"
+  spec.version       = Omniauth::Pacreception::VERSION
+  spec.authors       = ["Akash Srivastava"]
+  spec.email         = ["akash.srivastava@elitmus.com"]
+
+  spec.summary       = %q{PAC Reception OAuth2 Strategy for OmniAuth}
+  spec.description   = %q{PAC Reception OAuth2 Strategy for OmniAuth}
+  spec.homepage      = "https://github.com/akkee/omniauth-pacreception"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "https://github.com/akkee/omniauth-pacreception"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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-oauth2', '~> 1.5'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-pacreception
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Akash Srivastava
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-28 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.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: PAC Reception OAuth2 Strategy for OmniAuth
+email:
+- akash.srivastava@elitmus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-pacreception.rb
+- lib/omniauth/pacreception.rb
+- lib/omniauth/pacreception/version.rb
+- lib/omniauth/strategies/pacreception.rb
+- omniauth-pacreception.gemspec
+homepage: https://github.com/akkee/omniauth-pacreception
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/akkee/omniauth-pacreception
+  source_code_uri: https://github.com/akkee/omniauth-pacreception
+  changelog_uri: https://github.com/akkee/omniauth-pacreception
+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: []
+rubygems_version: 3.0.0
+signing_key: 
+specification_version: 4
+summary: PAC Reception OAuth2 Strategy for OmniAuth
+test_files: []