omniauth-oauth2-generic 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c60894fadcf2f9014bc48732350f0294c8743a60
+  data.tar.gz: 11bba29d2e3fdea5edeb6eebb2679376dafa5838
+SHA512:
+  metadata.gz: cb6e8cee46248d982b1d228e1d0e836b6c52c895b65b7ddb6dd13861150aa63fe20c8c4f8d1c66f2df6eb4704e24300fe9d3b17386d5aabefcc50374b38e5471
+  data.tar.gz: c98f7e1af754afb486fc978b37e1f4916afd93a34108bdf9f3df8561ab01f887ee2518a64bfdeda82afc0ff21f93525b26dead3b0684c4193019d57b34cc8821

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-oauth2-generic.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (C) 2017 Joe Marty, Jeff Hahn and Internet Exposure.
+
+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,83 @@
+# omniauth-oauth2-generic
+
+By [Internet Exposure](https://www.iexposure.com/)
+
+[![build](http://gitlab.iexposure.com/satorix/omniauth-oauth2-generic/badges/master/build.svg)](http://gitlab.iexposure.com/satorix/omniauth-oauth2-generic/pipelines)
+[![coverage](http://gitlab.iexposure.com/satorix/omniauth-oauth2-generic/badges/master/coverage.svg)](http://gitlab.iexposure.com/satorix/omniauth-oauth2-generic/pipelines)
+
+This gem provides an OmniAuth strategy for authenticating with an OAuth2 service using the authorization grant flow.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-oauth2-generic'
+```
+
+## Usage
+
+Include this gem in your client app [as you would any OmniAuth strategy](https://github.com/omniauth/omniauth#getting-started), by adding it to the middleware stack:
+
+**Rails Example: (minimum configuration)**
+```ruby
+# config/initializers/omniauth.rb
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :oauth2_generic,
+      "Your_OAuth_App_ID", "Your_OAuth_App_Secret",
+      client_options: {
+        site: 'https://your_oauth_server', # including port if necessary
+        user_info_url: '/api/path/to/fetch/current_user/info'
+      },
+      name: 'Satorix' # optional - alternate name for the strategy (appears in URLs)
+  end
+```
+
+**Gitlab Config Example:**
+
+```ruby
+# /etc/gitlab/gitlab.rb
+gitlab_rails['omniauth_enabled'] = true
+gitlab_rails['omniauth_allow_single_sign_on'] = ['oauth2_generic']
+gitlab_rails['omniauth_block_auto_created_users'] = false
+gitlab_rails['omniauth_providers'] = [
+  {
+    'name' => 'oauth2_generic',
+    'app_id' => 'oauth_client_app_id',
+    'app_secret' => 'oauth_client_app_secret',
+    'args' => {
+      client_options: {
+        'site' => 'https://your_oauth_server', # including port if necessary
+        'user_info_url' => '/api/path/to/fetch/current_user/info'
+      },
+      # optionally, you can add the following two lines to "white label" the display name
+      # of this strategy (appears in urls and Gitlab login buttons)
+      # If you do this, you must also replace oauth2_generic, everywhere it appears above, with the new name. 
+      name: 'Satorix', # display name for this strategy
+      strategy_class: "OmniAuth::Strategies::OAuth2Generic" # Devise-specific config option Gitlab uses to find renamed strategy
+    }
+  }
+]
+````
+
+Now if you visit `http://yourserver/auth/oauth2_generic` (or `/auth/Satorix` for the custom name example), you should be directed to log in with your OAuth2 server.
+
+## Configuration Options
+
+Details about the available configuration options are provided as comments in [the OAuth2Generic class](lib/omniauth/strategies/oauth2_generic.rb).
+
+Configuration options for this gem are:
+
+* **client_options** - A Hash containing options for configuring the OAuth client to point to the right URLs
+* **user_response_structure** - A Hash containing paths to various attributes of the user in the response that your OAuth server returns from the `user_info_url` specified in the `client_options`.
+  * **root_path** - An Array containing each key in the path to the node that contains the user attributes (i.e. `['data', 'attributes']` for a JsonAPI-formatted response)
+  * **id_path** - A String containing the name, or Array containing the keys in the path to the node that contains the user's ID (i.e. `['data', 'id']` for a JsonAPI-formatted response). Default: `'id'` (string values are assumed to be relative to the `root_path`)
+  * **attributes** - A Hash containing [standard Omniauth user attributes](https://github.com/omniauth/omniauth/wiki/auth-hash-schema#schema-10-and-later) and the names/paths to them in the response, if not the standard names (this hash defaults to looking for the standard names under the specified `root_path`)
+  
+    **Note:** The entire raw response will also be returned in the `['extra']['raw_info']` field of the OmniAuth auth hash, regardless of the value of this option.
+* **redirect_url** - The URL the client will be directed to after authentication. Defaults to `http://yourserver/auth/oauth2_generic/callback`
+
+  **Note:** Your OAuth server may restrict redirects to a specific list of URLs.
+* **name** - A String.  If set, this changes the name of the strategy used in the URLs and sometimes other places (the login button in Gitlab, for instance)
+  
+The hash options have default values for all keys, and your provided configuration is merged into the default, so you do not have to re-specify nested default options (although you will need to provide at least `site` and `user_info_url` in `client_options`, unless you want to use the default/example gitlab.com configuration). 

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/satorix"
+
+# 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

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-oauth2-generic.rb

@@ -0,0 +1,2 @@
+require "omniauth-oauth2-generic/version"
+require "omniauth/strategies/oauth2_generic"

data/lib/omniauth-oauth2-generic/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module OAuth2Generic
+    VERSION = "0.2.2"
+  end
+end

data/lib/omniauth/strategies/oauth2_generic.rb

@@ -0,0 +1,73 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class OAuth2Generic < OmniAuth::Strategies::OAuth2
+      option :name, 'oauth2_generic'
+
+      option :client_options, { # Defaults are set for GitLab example implementation
+        site: 'https://gitlab.com', # The URL for your OAuth 2 server
+        user_info_url: '/api/v3/user', # The endpoint on your OAuth 2 server that provides user info for the current user
+        authorize_url: '/oauth/authorize', # The authorization endpoint for your OAuth server
+        token_url: '/oauth/token' # The token request endpoint for your OAuth server
+      }
+
+      option :user_response_structure, { # info about the structure of the response from the oauth server's user_info_url (specified above)
+        root_path: [], # The default path to the user attributes (i.e. ['data', 'attributes'])
+        id_path: 'id', # The name or path to the user ID (i.e. ['data', 'id]').  Scalars are considered relative to `root_path`, Arrays are absolute paths.
+        attributes: { # Alternate paths or names for any attributes that don't match the default
+          name: 'name', # Scalars are treated as relative (i.e. 'username' would point to response['data']['attributes']['username'], given a root_path of ['data', 'attributes'])
+          email: 'email', # Arrays are treated as absolute paths (i.e. ['included', 'contacts', 0, 'email'] would point to response['included']['contacts'][0]['email'], regardless of root_path)
+          nickname: 'nickname',
+          first_name: 'first_name',
+          last_name: 'last_name',
+          location: 'location',
+          description: 'description',
+          image: 'image',
+          phone: 'phone',
+          urls: 'urls'
+        }
+      }
+
+      option :redirect_url
+
+      uid do
+        fetch_user_info(user_paths[:id_path]).to_s
+      end
+
+      info do
+        user_paths[:attributes].inject({}) do |user_hash, (field, path)|
+          value = fetch_user_info(path)
+          user_hash[field] = value if value
+          user_hash
+        end
+      end
+
+      extra do
+        { raw_info: raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get(options.client_options[:user_info_url]).parsed
+      end
+
+      private
+
+      def user_paths
+        options.user_response_structure
+      end
+
+      def fetch_user_info(path)
+        return nil unless path
+        full_path = path.is_a?(Array) ? path : Array(user_paths[:root_path]) + [path]
+        full_path.inject(raw_info) { |info, key| info[key] rescue nil }
+      end
+
+      def callback_url
+        options.redirect_url || (full_host + script_name + callback_path)
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'oauth2_generic', 'OAuth2Generic'

data/omniauth-oauth2-generic.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-oauth2-generic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-oauth2-generic"
+  spec.version       = Omniauth::OAuth2Generic::VERSION
+  spec.authors       = ["Joe Marty"]
+  spec.email         = ["jmarty@iexposure.com"]
+
+  spec.summary       = %q{Generic, Configurable OmniAuth Strategy for OAuth2 providers}
+  spec.description   = spec.summary
+  spec.homepage      = "https://gitlab.com/satorix/omniauth-oauth2-generic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "omniauth-oauth2", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-oauth2-generic
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Joe Marty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-16 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generic, Configurable OmniAuth Strategy for OAuth2 providers
+email:
+- jmarty@iexposure.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-oauth2-generic.rb
+- lib/omniauth-oauth2-generic/version.rb
+- lib/omniauth/strategies/oauth2_generic.rb
+- omniauth-oauth2-generic.gemspec
+homepage: https://gitlab.com/satorix/omniauth-oauth2-generic
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Generic, Configurable OmniAuth Strategy for OAuth2 providers
+test_files: []