faraday_oauth2_ccg_middleware 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1c2d4794e1431dc7b6e046f408992b1837b700ed56315f68ab49c57132311e5
+  data.tar.gz: 3d57ddcbe4c7be0489f6bbf13973dc7594505472d753794d62b8656c6d2172fa
+SHA512:
+  metadata.gz: af9fca69564e1292c20d94693b7968e90c6cb429d54467ca1fd6e9030fab6456d82060cd2b721276d64be5be7d37b3641080878dacecfb8d130dd9104a5a5ce9
+  data.tar.gz: 59a0480dd52dbd3e2e922283fa207c4e502ae0c14b06e2862982a1063477f30d1b75f365137dd8f6bae4fde37350aa7e26996fb2de4b97ce3a386bbf4cb25bb0

data/.gitignore

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

data/.rspec

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

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.3

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 sorin.guga@unifiedpost.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday_oauth2_ccg_middleware.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    faraday_oauth2_ccg_middleware (0.1.0)
+      faraday (>= 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  faraday_oauth2_ccg_middleware!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sorin Guga
+
+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,52 @@
+# Faraday OAUTH2 Client Credentials Grant Middleware
+
+Authorizes the request with the [OAUTH2 Client Credentials Grant](https://tools.ietf.org/html/rfc6749#section-4.4) and injects the received token into the Authorization header.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday_oauth2_ccg_middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday_oauth2_ccg_middleware
+
+## Usage
+
+```ruby
+Faraday.new do |conn|
+    conn.request :oauth2_ccg,
+             oauth_host:    'https://server.example.com',
+             token_url:     '/token',
+             client_id:     's6BhdRkqt3',
+             client_secret: '7Fjfp0ZBr1KtDRbnfVdmIw',
+             cache_store:   ::ActiveSupport::Cache.lookup_store(:redis_store, 'redis://127.0.0.1:6379')
+    
+    conn.adapter(:net_http) # NB: Last middleware must be the adapter
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fulf/faraday_oauth2_ccg_middleware. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FaradayUpOauth2Middleware project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/faraday_oauth2_ccg_middleware/blob/master/CODE_OF_CONDUCT.md).

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 "faraday_oauth2_ccg_middleware"
+
+# 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/faraday_oauth2_ccg_middleware.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_oauth2_ccg_middleware/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'faraday_oauth2_ccg_middleware'
+  spec.version       = FaradayOauth2CcgMiddleware::VERSION
+  spec.authors       = ['Sorin Guga']
+  spec.email         = ['sorin.guga@unifiedpost.com']
+
+  spec.summary       = 'Faraday OAUTH2 Client Credentials Grant Middleware'
+  spec.description   = 'Authorizes the request with the OAUTH2 Client Credentials
+\Grant and injects the received token into the Authorization header'
+  spec.homepage      = 'https://github.com'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) 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_dependency 'faraday', '>= 0.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/faraday_oauth2_ccg_middleware.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'faraday_oauth2_ccg_middleware/version'
+require 'faraday'
+require 'json'
+
+module FaradayOauth2CcgMiddleware
+
+  class Error < StandardError; end
+
+  # Authorizes the request with the OAUTH2 Client Credentials Grant and injects the received token
+  # into the Authorization header
+  #
+  # @example Configure OAUTH Client Credentials Grant middleware
+  # Faraday.new do |conn|
+  #   conn.request :oauth2_ccg,
+  #                oauth_host:    'https://server.example.com',
+  #                token_url:     '/token',
+  #                client_id:     's6BhdRkqt3',
+  #                client_secret: '7Fjfp0ZBr1KtDRbnfVdmIw',
+  #                cache_store:   ::ActiveSupport::Cache.lookup_store(:redis_store, 'redis://127.0.0.1:6379')
+  #
+  #   conn.adapter(:net_http) # NB: Last middleware must be the adapter
+  # end
+  class ClientCredentialsGrant < Faraday::Middleware
+    class Options < Faraday::Options.new(:oauth_host, :token_url,
+                                         :client_id, :client_secret,
+                                         :cache_store)
+
+      def self.from(value)
+        super(value)
+      end
+
+      def oauth_host
+        self[:oauth_host] ||= ''
+      end
+
+      def token_url
+        self[:token_url] ||= ''
+      end
+
+      def client_id
+        self[:client_id] ||= ''
+      end
+
+      def client_secret
+        self[:client_secret] ||= ''
+      end
+
+      def cache_store
+        self[:cache_store] ||= nil
+      end
+    end
+
+    AUTHORIZATION_HEADER = 'Authorization'
+    BEARER_AUTHORIZATION = 'Bearer'
+    CLIENT_CREDENTIALS_GRANT = 'client_credentials'
+
+    # @param app [#call]
+    # @param options [Hash]
+    # @option options [String] :oauth_host ('') OAUTH2 server host
+    # @option options [String] :token_url ('') Token endpoint to request authorization
+    # @option options [String] :client_id ('') Client authentication id
+    # @option options [String] :client_secret ('') Client authentication password
+    # @option options [Class] :cache_store (nil) An ActiveSupport::Cache::Store instance for token caching
+    def initialize(app, options = nil)
+      super(app)
+      @options = Options.from(options)
+    end
+
+    # @param env [Faraday::Env]
+    def call(env)
+      env[:request_headers][AUTHORIZATION_HEADER] = "#{BEARER_AUTHORIZATION} #{token}"
+
+      @app.call env
+    end
+
+    private
+
+    def token
+      if @options.cache_store
+        return @options.cache_store.fetch(cache_key, expires_in: token_object['expires_in']) do
+          token_object['access_token']
+        end
+      end
+
+      token_object['access_token']
+    end
+
+    def token_object
+      @token_object ||= JSON.parse(oauth_response.body)
+    end
+
+    def oauth_response
+      @oauth_response ||= auth_conn.post(
+        @options.token_url,
+        grant_type:    CLIENT_CREDENTIALS_GRANT,
+        client_id:     @options.client_id,
+        client_secret: @options.client_secret
+      )
+    end
+
+    def auth_conn
+      Faraday.new(url: @options.oauth_host)
+    end
+
+    def cache_key
+      Digest::MD5.hexdigest("#{@options.oauth_host}#{@options.client_id}#{@options.client_secret}")
+    end
+  end
+
+  Faraday::Request.register_middleware oauth2_ccg: FaradayOauth2CcgMiddleware::ClientCredentialsGrant
+end

data/lib/faraday_oauth2_ccg_middleware/version.rb

@@ -0,0 +1,3 @@
+module FaradayOauth2CcgMiddleware
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: faraday_oauth2_ccg_middleware
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sorin Guga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: |-
+  Authorizes the request with the OAUTH2 Client Credentials
+  \Grant and injects the received token into the Authorization header
+email:
+- sorin.guga@unifiedpost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faraday_oauth2_ccg_middleware.gemspec
+- lib/faraday_oauth2_ccg_middleware.rb
+- lib/faraday_oauth2_ccg_middleware/version.rb
+homepage: https://github.com
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Faraday OAUTH2 Client Credentials Grant Middleware
+test_files: []