access_token_agent 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc26e506a5e724e2f3fb483ffb8a8b7b74447e35
-  data.tar.gz: 31cce846d3c53a66737d2f5cb603dcf269ea3119
+  metadata.gz: b05e9bb8df48a419db6aa15bf18bca718638a4e8
+  data.tar.gz: 405ed7dfca477e3763e8acd6fc12b394813e0ffb
 SHA512:
-  metadata.gz: 560a1ce6c00cf31738b7d3c2d6ae7ee2ef0b9b9857e01aa620d299197f8cdba74daaf031a2cb5b7eee60d4f6c77e5f581ed86ed9e1a1279fb5ac83132d9a91a1
-  data.tar.gz: e5afd37637915dbe189fe7630b3b092e8cb588262f8c64167685711f9e2e0dc644bbbd08fc2f5d02a9333c35566dc5da2f36e29e17e607bdb20acd808cc17af5
+  metadata.gz: 19b6c44ddedcfdd3a7dc8a7c67dc0ab73d81c7cf11129c6bb2ccc2bf897d0cd15dee6400bf82fae597cbb49cb6b602a39ed5f56064a929ff1970e253231f7fcf
+  data.tar.gz: 90dab0e2595761e707ca502ec1b0b3489cbf8e7d96fdf21a6ca8952715856db351acfd29235b281567aa298d786eefc105fe751555042d77990bca76f5e3899b

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## master
+
+*no unreleased changes*
+
+## 3.2.0
+
+- Add `http_auth_header` method to the connector, since this is the most
+  common use case
+- Deprecate the `authenticate` method in favor of the new `token` method
+- Allow to configure from which path to get the access token
+- Put all errors into the AccessTokenAgent namespace
+- Actually return a token when faking auth
+- Rename error raised for unsupported token types
+- Ensure that access token response carries an access token
+
 ## 3.1.1
 
 - Fix broken gem release (missing files)

data/README.md

@@ -19,21 +19,24 @@ And then execute:
 
     $ bundle
 
-## Configuration
+## Basic Configuration
 
 Create an instance of AccessTokenAgent::Connector with the desired
 configuration and use that instance to authenticate.
 
-Needs the following parameters:
+Needs the following parameters to instantiate:
 
 * `host` - the server address where the auth provider is running.
 * `client_id` - the client_id of the application using this gem.
 * `client_secret` - the client_secret of the application using this gem.
+* `access_token_path` - Allows to customize the HTTP path where the
+  access token needs to be requested.
+  **Default:** `/oauth/token`
 
 Optional parameters:
 
 * `fake_auth` - if true, do not connect to the auth service and return
-   an empty access token (`nil`).
+   a faked access token.
 
 ### Example
 

data/access_token_agent.gemspec

@@ -1,8 +1,12 @@
 # coding: utf-8
 
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'access_token_agent/version'
+
 Gem::Specification.new do |s|
   s.name        = 'access_token_agent'
-  s.version     = '3.1.1'
+  s.version     = AccessTokenAgent::VERSION
   s.date        = '2016-04-08'
   s.summary     = 'Handles authentication against an OAuth2 provider'
   s.homepage    = 'https://github.com/kaeuferportal/access_token_agent'

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'access_token_agent'
+
+# 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

data/lib/access_token_agent.rb

@@ -3,3 +3,4 @@ require 'access_token_agent/unauthorized_error'
 require 'access_token_agent/connection_error'
 require 'access_token_agent/token'
 require 'access_token_agent/connector'
+require 'access_token_agent/version'

data/lib/access_token_agent/connector.rb

@@ -2,28 +2,44 @@ require 'net/http'
 
 module AccessTokenAgent
   class Connector
+    FAKE_TOKEN = 'FakeAuthToken'.freeze
+
     def initialize(host:,
                    client_id:,
                    client_secret:,
-                   fake_auth: false)
+                   fake_auth: false,
+                   access_token_path: '/oauth/token')
       @host = host
       @client_id = client_id
       @client_secret = client_secret
       @fake_auth = fake_auth
+      @access_token_path = access_token_path
     end
 
-    def authenticate
-      return if @fake_auth
-      fetch_token unless @known_token && @known_token.valid?
+    def http_auth_header
+      { Authorization: "Bearer #{token}" }
+    end
+
+    def token
+      return FAKE_TOKEN if @fake_auth
+      @known_token = fetch_token unless @known_token && @known_token.valid?
+
       @known_token.value
     end
 
+    def authenticate
+      warn '[DEPRECATION] `authenticate` is deprecated.  Use `token` instead.'
+      token
+    end
+
+    private
+
     def fetch_token
-      @known_token = Token.new(from_auth)
+      Token.new(fetch_token_hash)
     end
 
-    def from_auth
-      response = request
+    def fetch_token_hash
+      response = perform_request
       case response.code
       when '200' then JSON.parse(response.body)
       when '401' then raise UnauthorizedError
@@ -34,7 +50,7 @@ module AccessTokenAgent
       raise ConnectionError
     end
 
-    def request
+    def perform_request
       request = Net::HTTP::Post.new(auth_uri)
       request.basic_auth @client_id, @client_secret
       request.form_data = { 'grant_type' => 'client_credentials' }
@@ -47,7 +63,7 @@ module AccessTokenAgent
     end
 
     def auth_uri
-      @auth_uri ||= URI("#{@host}/oauth/token")
+      @auth_uri ||= URI("#{@host}#{@access_token_path}")
     end
   end
 end

data/lib/access_token_agent/error.rb

@@ -1,2 +1,4 @@
-class Error < StandardError
+module AccessTokenAgent
+  class Error < StandardError
+  end
 end

data/lib/access_token_agent/missing_access_token.rb

@@ -0,0 +1,7 @@
+module AccessTokenAgent
+  class MissingAccessToken < Error
+    def initialize
+      super('The access token response did not contain an access token.')
+    end
+  end
+end

data/lib/access_token_agent/token.rb

@@ -1,4 +1,5 @@
-require 'access_token_agent/invalid_token_type_error'
+require 'access_token_agent/missing_access_token'
+require 'access_token_agent/unsupported_token_type_error'
 
 module AccessTokenAgent
   class Token
@@ -7,9 +8,8 @@ module AccessTokenAgent
     EXPIRY_MARGIN = 60 # seconds
 
     def initialize(auth_response)
-      unless auth_response['token_type'] == 'bearer'
-        raise InvalidTokenTypeError, auth_response['token_type']
-      end
+      validate_response(auth_response)
+
       @value = auth_response['access_token']
       @expires_at = Time.now + auth_response['expires_in']
     end
@@ -17,5 +17,16 @@ module AccessTokenAgent
     def valid?
       @expires_at - EXPIRY_MARGIN > Time.now
     end
+
+    private
+
+    def validate_response(auth_response)
+      unless auth_response['token_type'] == 'bearer'
+        raise UnsupportedTokenTypeError, auth_response['token_type']
+      end
+
+      token = auth_response['access_token']
+      raise MissingAccessToken if token.nil? || token.empty?
+    end
   end
 end

data/lib/access_token_agent/unsupported_token_type_error.rb

@@ -0,0 +1,7 @@
+module AccessTokenAgent
+  class UnsupportedTokenTypeError < Error
+    def initialize(token_type)
+      super("Expected token_type to be 'bearer', but was '#{token_type}'.")
+    end
+  end
+end

data/lib/access_token_agent/version.rb

@@ -0,0 +1,3 @@
+module AccessTokenAgent
+  VERSION = '3.2.0'.freeze
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: access_token_agent
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Beko Käuferportal GmbH
@@ -115,6 +115,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
@@ -123,13 +124,16 @@ files:
 - LICENSE.md
 - README.md
 - access_token_agent.gemspec
+- bin/console
 - lib/access_token_agent.rb
 - lib/access_token_agent/connection_error.rb
 - lib/access_token_agent/connector.rb
 - lib/access_token_agent/error.rb
-- lib/access_token_agent/invalid_token_type_error.rb
+- lib/access_token_agent/missing_access_token.rb
 - lib/access_token_agent/token.rb
 - lib/access_token_agent/unauthorized_error.rb
+- lib/access_token_agent/unsupported_token_type_error.rb
+- lib/access_token_agent/version.rb
 homepage: https://github.com/kaeuferportal/access_token_agent
 licenses:
 - MIT

data/lib/access_token_agent/invalid_token_type_error.rb

@@ -1,5 +0,0 @@
-class InvalidTokenTypeError < Error
-  def initialize(token_type)
-    super("Expected token_type to be 'bearer', but was '#{token_type}'.")
-  end
-end