faraday-oauth2_cached_token 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a19677b5fa6ded3f7beeec7c91f42de93769722
+  data.tar.gz: 63d73cc211658cf22a110a6b56a0f7ac9951e96b
+SHA512:
+  metadata.gz: b7bb316d73590a5fd8aa3fa7761d4ff64d5bafbd6f3b948bfa29b74351d45e81a85ed9af146b69ebb0cc0963e035666b6a8f182d29997a409779fb7a23ceabef
+  data.tar.gz: e7f7d352e11e837dba45102a57f66520176268384cc8545d67077f53e012aee7bbe235c08bae95218fbd03e4f6b909c1e9c88ddb21057257aea5dd2c5ae08b1a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Globo.com
+
+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,43 @@
+# OAuth2CachedToken middleware
+
+Faraday middleware that caches and refreshes OAuth2 tokens as needed
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-oauth2_cached_token'
+```
+
+## Usage
+
+```ruby
+conn = Faraday.new(:url => 'http://sushi.com') do |faraday|
+  # You can pass the provider options
+  faraday.request :oauth2_cached_token, provider_options: {
+    id: 'client_id',
+    secret: 'secret',
+    options: {
+      site: 'http://sushi.com',
+      token_url: '/token'
+    }
+  }
+
+  # Or you can construct a provider yourself
+  faraday.request :oauth2_cached_token, provider: Faraday::OAuth2CachedToken::Provider.new({
+    id: 'client_id',
+    secret: 'secret',
+    options: {
+      site: 'http://sushi.com',
+      token_url: '/token'
+    }
+  })
+  
+  faraday.adapter Faraday.default_adapter
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Faraday::OAuth2CachedToken'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/faraday-oauth2_cached_token.rb

@@ -0,0 +1 @@
+require 'faraday/oauth2_cached_token'

data/lib/faraday/oauth2_cached_token.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+
+require 'faraday/oauth2_cached_token/provider'
+
+module Faraday
+  class OAuth2CachedToken < Middleware
+    INVALID_TOKEN_STATUS = 401
+
+    attr_reader :provider
+
+    def initialize(app, options = {})
+      super(app)
+      @provider = options[:provider] || Provider.new(options[:provider_options] || {})
+      @logger = options[:logger]
+    end
+
+    def call(request_env)
+      inject_header(request_env, @provider.get_token.headers)
+
+      @app.call(request_env).on_complete do |response_env|
+        on_complete(request_env, response_env)
+      end
+    end
+
+    private
+
+    def on_complete(request_env, response_env)
+      if response_env.status == INVALID_TOKEN_STATUS
+        @logger.try(:warn, 'Invalid Token. refreshing and retrying request...')
+        inject_header(request_env, @provider.get_fresh_token.headers)
+        @app.call(request_env)
+      end
+    end
+
+    def inject_header(request_env, header)
+      request_env[:request_headers].merge!(header)
+    end
+  end
+end
+
+Faraday::Request.register_middleware oauth2_cached_token: Faraday::OAuth2CachedToken

data/lib/faraday/oauth2_cached_token/provider.rb

@@ -0,0 +1,38 @@
+require 'faraday'
+require 'oauth2/client'
+require 'active_support'
+
+require 'faraday/oauth2_cached_token/token'
+
+module Faraday
+  class OAuth2CachedToken < Middleware
+    class Provider
+      def initialize(options)
+        @options = options
+        @cache = options[:store] || ActiveSupport::Cache::MemoryStore.new
+      end
+
+      def get_fresh_token
+        token = Token.from_access_token(oauth2_client.client_credentials.get_token)
+        @cache.write(cache_key, token, expires_in: token.expires_in)
+        token
+      end
+
+      def get_token
+        @cache.read(cache_key) || get_fresh_token
+      end
+
+      private
+
+      def cache_key
+        "oauth2_cached_token_#{@options[:id]}"
+      end
+
+      private
+
+      def oauth2_client
+        OAuth2::Client.new(@options[:id], @options[:secret], @options[:options])
+      end
+    end
+  end
+end

data/lib/faraday/oauth2_cached_token/token.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+
+module Faraday
+  class OAuth2CachedToken < Middleware
+    class Token
+      attr_reader :expires_in
+
+      def initialize(token, expires_in)
+        @token = token
+        @expires_in = expires_in
+      end
+
+      def headers
+        {'Authorization' => "Bearer #{@token}"}
+      end
+
+      def self.from_access_token(access_token)
+        new(access_token.token, access_token.expires_in)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: faraday-oauth2_cached_token
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Willrich
+- Jean Carlo Emer
+- Pablo Machado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Faraday middleware that caches and refreshes OAuth2 tokens as needed
+email:
+- rodrigo.willrich@corp.globo.com
+- jean.emer@corp.globo.com
+- pablo.machado@corp.globo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/faraday-oauth2_cached_token.rb
+- lib/faraday/oauth2_cached_token.rb
+- lib/faraday/oauth2_cached_token/provider.rb
+- lib/faraday/oauth2_cached_token/token.rb
+homepage: http://github.com/globocom/faraday-oauth2_cached_token
+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: Middleware to handle OAuth2 token caching
+test_files: []