identity-gateway 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a472a877c9f41b3452ce62134871ead4bafba3b
+  data.tar.gz: 1ebe4c7eb1c3b8745dfd734d76837c48486dab1e
+SHA512:
+  metadata.gz: d5ae5c137a7dbe728b5482f7c4ed7a40396b1663cfe302bce1212d403972d5081ceb41f1cc8a2c0b0c492e46081737cc0046a7d73f7d6000cde8e4c3015760a1
+  data.tar.gz: 5cd96de33a0d261670061e200a0a4ae738bdb525713334e895f40fa1ae401dd520f25f0ed243acba2ff01c74fe25c8e1e90a3dce6282a9535223a7a015d66b03

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/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Loic Kartono
+
+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,142 @@
+# Identity::Gateway
+
+[![Gem Version](https://img.shields.io/gem/v/identity-gateway.svg)](https://rubygems.org/gems/identity-gateway)
+[![CircleCI](https://circleci.com/gh/wamland-team/identity-gateway.svg?style=shield&circle-token=b03fdcc75674d173f58a296cb1a3b2162b6828dc)](https://circleci.com/gh/wamland-team/identity-gateway)
+
+Identity's gateway provider for Ruby and Rails applications. Act as a man in the middle between backend services and Identity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'identity-gateway'
+```
+
+Use Bundler to install the dependency:
+
+    $ bundle
+
+## Usage
+
+Once you've configured it, you can use the `Identity::Gateway::Provider` class in order to act as your authentication mechanism.
+
+```ruby
+# app/controllers/api_controller.rb
+module Api
+  class ApiController < ApplicationController
+    def authorize_access!
+      @provider = Identity::Gateway::Provider.new(request)
+      @provider.authorize!
+    end
+  end
+end
+
+# app/controllers/api/v1/posts_controller.rb
+module Api
+  module V1
+    class PostsController < Api::ApiController
+      before_action :authorize_access!, only: [:index]
+
+      def index
+        # Only authenticated users can access it.
+      end
+    end
+  end
+end
+```
+
+### Current subject
+
+A subject is the instance associated to the model you specify using the `model` option when you configure the gem. Any instance of `Identity::Gateway::Provider` expose a public method name `current_resource` that allows you to retrieve the resource associated to a given access token.
+
+```ruby
+# app/controllers/api_controller.rb
+module Api
+  class ApiController < ApplicationController
+    def authorize_access!
+      @provider = Identity::Gateway::Provider.new(request)
+      @provider.authorize!
+    end
+
+    def current_user
+      @current_user ||= @provider.current_resource
+    end
+  end
+end
+```
+
+### Rescuing a denied Authorization in Rails
+
+Identity::Gateway raises a `Identity::Gateway::Unauthorized` error you can
+[rescue_from](http://guides.rubyonrails.org/action_controller_overview.html#rescue-from)
+in your `ApplicationController`. You can customize the `unauthorized_response`
+method in every controller.
+
+```ruby
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :null_session
+
+  rescue_from Identity::Gateway::Unauthorized, with: :unauthorized_response
+
+  private
+
+  def unauthorized_response
+    render json: { message: 'You need to sign in before continuing.' }, status: :unauthorized
+  end
+end
+```
+
+Alternatively, you can globally handle Identity::Gateway::Unauthorized's by having rails handle them as a 401 error and serving a 401 error page. Add the following to application.rb:
+
+```ruby
+config.action_dispatch.rescue_responses['Identity::Gateway::Unauthorized'] = :unauthorized
+```
+
+## Configuration
+
+You can configure Identity::Gateway by creating an initializer `config/initializers/identity_gateway.rb` and passing it a `configure` block:
+
+```ruby
+Identity::Gateway.configure do |config|
+  # Define options here
+end
+```
+
+## Options
+
+### model
+
+This option allows you to define the name of the model you wish to associate. For example, if you handle cache for users with a User model, then it could looks like:
+
+```ruby
+config.model = 'User'
+```
+
+### provider_url
+
+This option allows you to define the url to your Identity server:
+
+```ruby
+config.provider_url = 'https://identity.domain.com'
+```
+
+### identity_path
+
+This option allows you to define the path on Identity that return the information about the current user. Generally, this path will be `/me`:
+
+```ruby
+config.identity_path = '/me'
+```
+
+### version_header
+
+This option allows you to define the `Accept` header use to determinate which version of Identity's API you which to use:
+
+```ruby
+config.version_header = 'application/vnd.wamland+json; version=1'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wamland-team/identity-gateway.

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 'identity/gateway'
+
+# 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/circle.yml

@@ -0,0 +1,11 @@
+machine:
+  ruby:
+    version: 2.2.4
+
+## Customize dependencies
+dependencies:
+  pre:
+    - sudo apt-get update
+  override:
+    - bundle install: # note ':' here
+        timeout: 180 # fail if command has no output for 3 minutes

data/identity-gateway.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'identity/gateway/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'identity-gateway'
+  spec.version       = Identity::Gateway::VERSION
+  spec.authors       = ['Loic Kartono']
+  spec.email         = ['kartono.loic@gmail.com']
+
+  spec.summary       = 'Identity\'s gateway provider'
+  spec.description   = 'Identity\'s gateway provider for Ruby and Rails applications'
+  spec.homepage      = 'https://github.com/wamland-team/identity-gateway'
+  spec.license       = 'MIT'
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  spec.add_dependency 'httparty', '~> 0.13'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.47.1'
+end

data/lib/identity/gateway.rb

@@ -0,0 +1,36 @@
+require 'identity/gateway/version'
+require 'identity/gateway/configuration'
+
+module Identity
+  module Gateway
+    class << self
+      attr_writer :configuration
+    end
+
+    # Access module configuration.
+    #
+    # ==== Returns
+    # * <tt>Identity::Gateway::Configuration</tt> - instance
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Reset configuration to defaults.
+    #
+    # ==== Returns
+    # * <tt>Identity::Gateway::Configuration</tt> - instance
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    # Configure block.
+    #
+    # ==== Returns
+    # * <tt>void</tt>
+    def self.configure
+      yield(configuration)
+    end
+  end
+end
+
+require 'identity/gateway/provider'

data/lib/identity/gateway/configuration.rb

@@ -0,0 +1,16 @@
+module Identity
+  module Gateway
+    class Configuration
+      attr_accessor :model, :provider_url, :identity_path, :version_header
+
+      # Initialize a configuration.
+      #
+      # ==== Returns
+      # * <tt>Identity::Gateway::Configuration</tt> - New instance.
+      def initialize
+        @model = 'User'
+        @identity_path = '/me'
+      end
+    end
+  end
+end

data/lib/identity/gateway/provider.rb

@@ -0,0 +1,93 @@
+require 'httparty'
+
+module Identity
+  module Gateway
+    class Unauthorized < StandardError; end
+    class Provider
+      include HTTParty
+
+      # Class initializer.
+      #
+      # ==== Parameters
+      # * <tt>request</tt> - Current request.
+      #
+      # ==== Returns
+      # Assigns arguments to instance variables.
+      def initialize(request)
+        @settings = Identity::Gateway.configuration
+        @request  = request
+        @response = {}
+        @subject  = nil
+        @model    = Object.const_get(@settings.model)
+      end
+
+      # Get token resource owner.
+      #
+      # ==== Returns
+      # * <tt>Object</tt> - HTTParty response or identity error.
+      def authorize!
+        token = request_token
+        @subject = @model.find_by(token: token)
+        return unless (@subject && @subject.token_has_expired?) || @subject.nil?
+        authorize_from_provider
+      end
+
+      # The current instance object associated to
+      # the model define in the configuration.
+      #
+      # ==== Returns
+      # * <tt>Object</tt> - instance or nil.
+      def current_resource
+        @subject
+      end
+
+      # Revoke access token.
+      #
+      # ==== Returns
+      # * <tt>HTTParty::Response</tt>.
+      def revoke_access!
+        self.class.post(
+          "#{@settings.provider_url}/oauth/revoke",
+          body: { token: request_token }.to_json,
+          headers: api_headers
+        )
+      end
+
+      protected
+
+      # Try to authorize token against provider.
+      #
+      # ==== Returns
+      # * <tt>ActiveRecord|Error</tt> - User object, error otherwise.
+      def authorize_from_provider
+        @response = self.class.get(
+          @settings.provider_url + @settings.identity_path,
+          headers: api_headers
+        )
+
+        raise Unauthorized if @response.code == 401 || @response.parsed_response.nil?
+        @subject = @model.from_oauth_provider(@response.parsed_response)
+      end
+
+      # Get oauth token from headers.
+      #
+      # ==== Returns
+      # * <tt>String</tt> - token.
+      def request_token
+        (@request.headers['Authorization'] || '').gsub('Bearer ', '')
+      end
+
+      # Required headers.
+      #
+      # ==== Returns
+      # * <tt>Hash</tt> - Hash of headers.
+      def api_headers
+        {
+          'Content-Type'  => 'application/json',
+          'Accept'        => @settings.version_header || '',
+          'Authorization' => @request.headers['Authorization'] || ''
+        }
+      end
+    end
+  end
+end

data/lib/identity/gateway/version.rb

@@ -0,0 +1,5 @@
+module Identity
+  module Gateway
+    VERSION = '1.1.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: identity-gateway
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Loic Kartono
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+description: Identity's gateway provider for Ruby and Rails applications
+email:
+- kartono.loic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- identity-gateway.gemspec
+- lib/identity/gateway.rb
+- lib/identity/gateway/configuration.rb
+- lib/identity/gateway/provider.rb
+- lib/identity/gateway/version.rb
+homepage: https://github.com/wamland-team/identity-gateway
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Identity's gateway provider
+test_files: []