access_token_wrapper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa3e4dc49fcef736188a2ac6c92c62f9be9aa49c
-  data.tar.gz: b2d6e2a5ca52da58f59c31f2d0d76ba72c54f2f3
+  metadata.gz: 97e4602f04e6cfbc043882a7aa5a0859c59b8ee6
+  data.tar.gz: 748826f2514ec5124d06e6888f659ac6d118e210
 SHA512:
-  metadata.gz: a24c1e9508895fed609af3208451bbb14436968205bfc47fa26072eb950fd7e5e142914364b7b4e189ea9cb8a8ab20ffcbbf0948651a9ef0858d6c3f77ea6166
-  data.tar.gz: 4888d4057b10b4981e5860ee1042bf396c58f2fb6f4ad122b81387e2431a89e0833ca13778d64d8c88987055fc5cf88bd9bdd9593bfa3d6e085058f37c69f1a4
+  metadata.gz: '0874f0e738ed1ed9cf360805caf45b97eea88e17aa5795ae4b07658a5caecfbc7bacf6dc0985281d2214982d2dfac96c1ad3c5e2c71f26c7b4319071846daab8'
+  data.tar.gz: 3c6472be726db31508ae06ee6e7a84d6568f9364dc54cb9103d0eae8bbe41d8b1c053705f61632bfd23981d6a846e8bffb9f530a1ad08a0bf623c7fc05016355

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.2.0 (2018-01-16)
+- [FEATURE] The library now checks the expires_at date of the token before attempting an API call.
+- [BREAKING] The refresh callback now only optionally contains an exception, when an exception is raised, if the refresh is due to the expires_at field (which should be the majority of the time) it will be `nil`
+
+## 0.1.0 (2017-09-20)
+- [BREAKING] `AccessTokenWrapper::Base#token` was renamed to `#raw_token`.

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    access_token_wrapper (0.2.0)
+      oauth2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    jwt (1.5.6)
+    multi_json (1.12.2)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (2.0.3)
+    rake (12.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  access_token_wrapper!
+  bundler (~> 1.3)
+  rake
+
+BUNDLED WITH
+   1.16.1

data/Rakefile

@@ -1 +1,18 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task default: [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+end
+
+desc "Open an irb session"
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'access_token_wrapper'
+  ARGV.clear
+  IRB.start
+end

data/access_token_wrapper.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "oauth2"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/lib/access_token_wrapper.rb

@@ -1,29 +1 @@
-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
+require "access_token_wrapper/base"

data/lib/access_token_wrapper/base.rb

@@ -0,0 +1,37 @@
+module AccessTokenWrapper
+  class Base
+    NON_ERROR_CODES = [402, 404, 422, 414, 429, 500, 503]
+    EXPIRY_GRACE_SEC = 30
+    attr_reader :raw_token
+
+    def initialize(raw_token, &callback)
+      @raw_token = raw_token
+      @callback  = callback
+    end
+
+    def method_missing(method_name, *args, &block)
+      refresh_token! if token_expiring?
+      @raw_token.send(method_name, *args, &block)
+    rescue OAuth2::Error => exception
+      if NON_ERROR_CODES.include?(exception.response.status)
+        raise exception
+      else
+        refresh_token!(exception)
+        @raw_token.send(method_name, *args, &block)
+      end
+    end
+
+    def refresh_token!(exception = nil)
+      @raw_token = @raw_token.refresh!
+      @callback.call(@raw_token, exception)
+    end
+
+    def token_expiring?
+      @raw_token.expires_at < (Time.now.to_i + EXPIRY_GRACE_SEC)
+    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

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

data/test/base_test.rb

@@ -0,0 +1,91 @@
+require 'test_helper'
+
+class AccessTokenWrapperTest < Minitest::Test
+  class FakeToken
+    attr_reader :refreshed
+
+    def initialize(options = {})
+      @has_run = nil
+      @options = options
+    end
+
+    def get(*)
+      ""
+    end
+
+    def expires_at
+      @options[:expires_at] || Time.now.to_i + 3600
+    end
+
+    def get_and_raise(code)
+      if @has_run
+        ""
+      else
+        @has_run = true
+        raise OAuth2::Error, OpenStruct.new(status: code, parsed: { 'error' => code }, body: '')
+      end
+    end
+
+    def refresh!
+      @refreshed = true
+      self
+    end
+  end
+
+  def described_class
+    AccessTokenWrapper::Base
+  end
+
+  def test_doesnt_run_block_if_no_exception
+    @run = false
+
+    token = described_class.new(FakeToken.new) do |new_token, exception|
+      @run = true
+    end
+
+    token.get('/')
+    assert !@run
+    assert !token.refreshed
+  end
+
+  def test_runs_refresh_block_if_exception
+    @run = false
+
+    token = described_class.new(FakeToken.new) do |new_token, exception|
+      @run = true
+    end
+
+    token.get_and_raise(401)
+    assert @run
+    assert token.refreshed
+  end
+
+
+  def test_runs_refresh_block_if_expiring
+    @run = false
+
+    token = described_class.new(FakeToken.new(expires_at: Time.now.to_i - 1)) do |new_token, exception|
+      @run = true
+    end
+
+    token.get('/')
+    assert @run
+    assert token.refreshed
+  end
+
+  def test_doesnt_run_block_if_non_auth_exception
+    @run = false
+
+    token = described_class.new(FakeToken.new) do |new_token, exception|
+      @run = true
+    end
+
+    begin
+      token.get_and_raise(429)
+    rescue OAuth2::Error
+    end
+
+    assert !@run
+    assert !token.refreshed
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'access_token_wrapper'
+require 'oauth2'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: access_token_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bradley Priest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
+- !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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -46,13 +60,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - access_token_wrapper.gemspec
 - lib/access_token_wrapper.rb
+- lib/access_token_wrapper/base.rb
 - lib/access_token_wrapper/version.rb
+- test/base_test.rb
+- test/test_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -73,9 +93,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Wrapper for OAuth2::Token to automatically refresh the expiry token when
   expired.
-test_files: []
+test_files:
+- test/base_test.rb
+- test/test_helper.rb