access_token_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa3e4dc49fcef736188a2ac6c92c62f9be9aa49c
+  data.tar.gz: b2d6e2a5ca52da58f59c31f2d0d76ba72c54f2f3
+SHA512:
+  metadata.gz: a24c1e9508895fed609af3208451bbb14436968205bfc47fa26072eb950fd7e5e142914364b7b4e189ea9cb8a8ab20ffcbbf0948651a9ef0858d6c3f77ea6166
+  data.tar.gz: 4888d4057b10b4981e5860ee1042bf396c58f2fb6f4ad122b81387e2431a89e0833ca13778d64d8c88987055fc5cf88bd9bdd9593bfa3d6e085058f37c69f1a4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TradeGecko Pte Ltd
+
+MIT License
+
+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,55 @@
+# AccessTokenWrapper
+
+Provides a wrapper for an OAuth2::Token to automatically refresh the expiry token when required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'access_token_wrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install access_token_wrapper
+
+## Usage
+
+```ruby
+def access_token
+  @access_token ||= begin
+    token = OAuth2::AccessToken.new(oauth_client, @user.access_token,
+            refresh_token: @user.refresh_token,
+            expires_at:    @user.expires_at
+    )
+    AccessTokenWrapper::Base.new(token) do |new_token, exception|
+      update_user_from_access_token(new_token)
+    end
+  end
+end
+
+def oauth_client 
+  @oauth_client ||= OAuth2::Client.new(ENV["OAUTH_ID"], ENV["OAUTH_SECRET"], site: "https://api.tradegecko.com")
+end
+
+def update_user_from_access_token(new_token)
+  @user.access_token  = new_token.token
+  @user.refresh_token = new_token.refresh_token
+  @user.expires_at    = new_token.expires_at
+  @user.save
+end
+```
+
+## Note
+The `AccessTokenWrapper#token` is replaced with `AccessTokenWrapper#raw_token`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/access_token_wrapper.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'access_token_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "access_token_wrapper"
+  spec.version       = AccessTokenWrapper::VERSION
+  spec.authors       = ["Bradley Priest"]
+  spec.email         = ["bradley@tradegecko.com"]
+  spec.description   = %q{Wrapper for OAuth2::Token to automatically refresh the expiry token when expired.}
+  spec.summary       = %q{Wrapper for OAuth2::Token to automatically refresh the expiry token when expired.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/access_token_wrapper.rb

@@ -0,0 +1,29 @@
+require "access_token_wrapper/version"
+
+module AccessTokenWrapper
+  class Base
+    NON_ERROR_CODES = [402, 404, 422, 414, 429, 500, 503]
+    attr_reader :raw_token
+
+    def initialize(raw_token, &callback)
+      @raw_token = raw_token
+      @callback  = callback
+    end
+
+    def method_missing(method, *args, &block)
+      @raw_token.send(method, *args, &block)
+    rescue OAuth2::Error => exception
+      if NON_ERROR_CODES.include?(exception.response.status)
+        raise exception
+      else
+        @raw_token = @raw_token.refresh!
+        @callback.call(@raw_token, exception)
+        @raw_token.send(method, *args, &block)
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @raw_token.respond_to?(method_name, include_private) || super
+    end
+  end
+end

data/lib/access_token_wrapper/version.rb

@@ -0,0 +1,3 @@
+module AccessTokenWrapper
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: access_token_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bradley Priest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Wrapper for OAuth2::Token to automatically refresh the expiry token when
+  expired.
+email:
+- bradley@tradegecko.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- access_token_wrapper.gemspec
+- lib/access_token_wrapper.rb
+- lib/access_token_wrapper/version.rb
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for OAuth2::Token to automatically refresh the expiry token when
+  expired.
+test_files: []