faraday_middleware-oauth2_refresh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75da60b7dc91240b31f66f29485c5f5ff4bba802
+  data.tar.gz: 6ee13c0e2e6e021cea753fa34263a387d874b8f7
+SHA512:
+  metadata.gz: ed3a230f557a09efc3837c296e4cddcd87863a68e876d436528ef62d29288d6c4d8b4063133e3b52bfe5b39182d5ac2f5499f210b41e44d1c4ea7ee062c25a06
+  data.tar.gz: 7fbb42a498997098e567b619f43c875a3929070b5a95bccfbefad9868c2c8c5afbc30d957f5663123b40493435361a5f05625f49b382aea73a88b02c3c30c3fa

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+CHANGELOG
+---------
+- **2015-05-31**: 0.0.1
+  - Initial release

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 John Wang
+ 
+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,53 @@
+# FaradayMiddleware::OAuth2Refresh
+
+Faraday middleware to manage OAuth token authorization with token refresh.
+
+## Description
+
+This gem is a piece of Faraday middleware that adds OAuth token handling using the [oauth2 gem](https://github.com/intridea/oauth2).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday_middleware-oauth2_refresh'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install faraday_middleware-oauth2_refresh
+```
+
+## Usage
+
+```ruby
+require 'oauth2'
+require 'faraday_middleware/oauth2_refresh'
+
+client = OAuth2::Client.new('my_client_id', 'my_client_secret', :site => 'https://example.com' )
+token  = client.password.get_token('username', 'password', { :headers => { 'Authorization' => 'Basic my_api_key' } })
+
+conn = Faraday.new(:url => "http://example.com") do |builder|
+  builder.request  :oauth2_refresh, token
+  builder.adapter Faraday.default_adapter
+end
+
+conn.get "/foo" # sends token
+```
+
+## Change Log
+
+- **2015-05-30**: 0.0.1
+  - Initial public release
+
+## Problems, Comments, Suggestions?
+
+All of the above are most welcome on Github.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the library.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+desc 'Generate YARD documentation.'
+task :gendoc do
+  # puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
+  system "yardoc"
+  system "yard stats --list-undoc"
+end

data/VERSION.txt

@@ -0,0 +1 @@
+0.0.1

data/lib/faraday_middleware-oauth2_refresh.rb

@@ -0,0 +1 @@
+require 'faraday_middleware/oauth2_refresh'

data/lib/faraday_middleware/oauth2_refresh.rb

@@ -0,0 +1,38 @@
+require 'base64'
+require 'faraday'
+require 'forwardable'
+
+module FaradayMiddleware
+  class OAuth2Refresh < Faraday::Middleware
+    AUTH_HEADER = 'Authorization'.freeze
+
+    attr_reader :oauth2_token
+
+    extend Forwardable
+
+    def call(env)
+      if @oauth2_token.expired?
+      	@oauth2_token = @oauth2_token.refresh!({:headers => {'Authorization' => 'Basic ' + get_api_key()}})
+      end
+      
+      if @oauth2_token.token.to_s.length>0
+        env[:request_headers][AUTH_HEADER] = %(Bearer #{@oauth2_token.token.to_s})
+      end
+
+      @app.call env
+    end
+
+    def get_api_key()
+      api_key = Base64::encode64("#{@oauth2_token.client.id.to_s}:#{@oauth2_token.client.secret.to_s}").gsub(/[\s\t\r\n]/,'')
+      return api_key
+    end
+
+    def initialize(app=nil, token=nil, options={})
+      super(app)
+      @oauth2_token = token
+    end
+
+  end
+end
+
+Faraday::Request.register_middleware :oauth2_refresh => FaradayMiddleware::OAuth2Refresh

data/test/test_setup.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_middleware-oauth2_refresh'
+
+class OAuth2Test < Test::Unit::TestCase
+  def testSetup
+
+    conn = Faraday.new 'http://example.com/api' do |conn|
+      conn.request :oauth2_refresh
+    end
+
+    ref = FaradayMiddleware::OAuth2Refresh.new
+
+    assert_equal 'FaradayMiddleware::OAuth2Refresh', ref.class.name
+
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: faraday_middleware-oauth2_refresh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - '>='
+      - !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::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: forwardable
+  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: This Faraday middleware gem adds OAuth2 token handling with token refresh
+email: johncwang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION.txt
+- lib/faraday_middleware-oauth2_refresh.rb
+- lib/faraday_middleware/oauth2_refresh.rb
+- test/test_setup.rb
+homepage: https://github.com/grokify/
+licenses: []
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Faraday OAuth2 request middleware with token refresh
+test_files: []