shutl_auth 0.8.5 → 0.9.0

data/.rspec

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

data/lib/shutl/auth/access_token_request.rb

@@ -1,79 +1,84 @@
 module Shutl
   module  Auth
-    class Shutl::Error        < ::StandardError; end
-    class InvalidUrl          < Shutl::Error; end
-    class InvalidCredentials  < Shutl::Error; end
-    class InternalServerError < Shutl::Error; end
+    class AccessTokenRequest
 
-    def access_token!
-      access_token_response!.access_token
-    end
+      def initialize(opts)
+        self.client_id = opts.fetch :client_id
+        self.client_secret = opts.fetch :client_secret
+        self.url = opts.fetch :url
+      end
 
-    def access_token_response!
-      c = client
+      def access_token
+        access_token_response.access_token
+      end
 
-      Shutl::NetworkRetry.retry "Authentication Service Error" do
-        handling_exceptions do
-          Shutl::Auth.logger.debug "executing Rack::OAuth2::Client request"
-          c.access_token!
-        end
-     end
-    end
+      def access_token_response
+        c = client
 
-    private
-
-    def handling_exceptions
-      yield
-    rescue Rack::OAuth2::Client::Error => e
-      Shutl::Auth.logger.error "Rack::OAuth2::Client::Error: #{e.message}"
-      case e.message
-      when /The client identifier provided is invalid, the client failed to authenticate, the client did not include its credentials, provided multiple client credentials, or used unsupported credentials type\./
-        raise_invalid_credentials
-      else
-        raise_internal_server_error e
+        Shutl::NetworkRetry.retry "Authentication Service Error" do
+          handling_exceptions do
+            Shutl::Auth.logger.debug "executing Rack::OAuth2::Client request"
+            c.access_token!
+          end
+       end
       end
-    end
 
-    def client
-      check uri
+      private
 
-      Rack::OAuth2::Client.new \
-        identifier:     Shutl::Auth.client_id,
-        secret:         Shutl::Auth.client_secret,
-        token_endpoint: '/token',
-        host:           uri.host,
-        port:           uri.port,
-        scheme:         uri.scheme
-    end
+      attr_accessor :client_id, :client_secret, :url
 
 
-    def uri
-      URI Shutl::Auth.url
-    rescue
-      raise_invalid_uri
-    end
+      def handling_exceptions
+        yield
+      rescue Rack::OAuth2::Client::Error => e
+        Shutl::Auth.logger.error "Rack::OAuth2::Client::Error: #{e.message}"
+        case e.message
+        when /The client identifier provided is invalid, the client failed to authenticate, the client did not include its credentials, provided multiple client credentials, or used unsupported credentials type\./
+          raise_invalid_credentials
+        else
+          raise_internal_server_error e
+        end
+      end
 
-    def check uri
-      return uri if uri and uri.host and uri.scheme
-      raise_invalid_uri
+      def client
+        check uri
 
-    rescue
-      raise_invalid_uri
-    end
+        Rack::OAuth2::Client.new \
+          identifier:     client_id,
+          secret:         client_secret,
+          token_endpoint: '/token',
+          host:           uri.host,
+          port:           uri.port,
+          scheme:         uri.scheme
+      end
 
-    def raise_invalid_uri
-      raise Shutl::Auth::InvalidUrl, "Please set value of Shutl::Auth.url"
-    end
 
-    def raise_invalid_credentials
-      raise Shutl::Auth::InvalidCredentials, "Invalid credentials set, please see https://github.com/shutl/shutl_auth/blob/master/README.md"
-    end
+      def uri
+        URI url
+      rescue
+        raise_invalid_uri
+      end
 
-    def raise_internal_server_error e
-      Shutl.notify e
-      raise Shutl::Auth::InternalServerError
-    end
+      def check uri
+        return uri if uri and uri.host and uri.scheme
+        raise_invalid_uri
+
+      rescue
+        raise_invalid_uri
+      end
 
-    extend self
+      def raise_invalid_uri
+        raise Shutl::Auth::InvalidUrl, "Please set value of Shutl::Auth.url"
+      end
+
+      def raise_invalid_credentials
+        raise Shutl::Auth::InvalidCredentials, "Invalid credentials set, please see https://github.com/shutl/shutl_auth/blob/master/README.md"
+      end
+
+      def raise_internal_server_error e
+        Shutl.notify e
+        raise Shutl::Auth::InternalServerError
+      end
+    end
   end
 end

data/lib/shutl/auth/authenticated_request.rb

@@ -2,6 +2,29 @@
 #authenticating requests
 module Shutl
   module Auth
+    module AuthenticatedRequest
+      def self.included base
+      end
+
+      def access_token
+        authenticator.access_token
+      end
+
+      def authenticated_request &blk
+        authenticator.authenticated_request &blk
+      end
+
+      def request_access_token
+        authenticator.request_access_token
+      end
+
+      protected
+
+      def authenticator
+        @authenticator ||= Authenticator.new client_id: Shutl::Auth.client_id, client_secret: Shutl::Auth.client_secret , url: Shutl::Auth.url
+      end
+    end
+
     class Cache
       def initialize
         @cache = {}
@@ -29,42 +52,5 @@ module Shutl
         Cache.new
       end
     end
-
-    module AuthenticatedRequest
-      def self.included base
-        
-      end
-
-      def request_access_token
-        return read_token if read_token
-        Shutl::Auth.logger.debug "request_access_token: cached? #{!!read_token}"
-
-        Shutl::Auth.access_token!
-      end
-
-      def access_token
-        return read_token if read_token
-        set_token request_access_token
-      end
-
-      def authenticated_request &blk
-        begin
-          yield
-        rescue Shutl::UnauthorizedAccess => e
-          Shutl::Auth.logger.debug "Shutl::UnauthorizedAccess - resetting access token"
-          set_token nil
-          access_token
-          yield
-        end
-      end
-
-      def read_token
-        Shutl::Auth.cache.read(:access_token)
-      end
-
-      def set_token(token)
-        Shutl::Auth.cache.write(:access_token, token)
-      end
-    end
   end
 end

data/lib/shutl/auth/authenticator.rb

@@ -0,0 +1,58 @@
+
+module Shutl
+  module Auth
+    class Authenticator
+
+      def initialize(options = {})
+        Shutl::Auth.logger.debug "building a new authenticator"
+        self.cache_key      = options.fetch(:cache_key) { :access_token }
+        self.client_id      = options.fetch(:client_id)
+        self.client_secret  = options.fetch(:client_secret)
+        self.url            = options.fetch(:url)
+      end
+
+      def access_token
+        return read_token if read_token
+        set_token request_access_token
+      end
+
+      def authenticated_request &blk
+        begin
+          yield
+        rescue Shutl::UnauthorizedAccess => e
+          Shutl::Auth.logger.debug "Shutl::UnauthorizedAccess - resetting access token"
+          set_token nil
+          access_token
+          yield
+        end
+      end
+
+      def request_access_token
+        return read_token if read_token
+        Shutl::Auth.logger.debug "request_access_token: cached? #{!!read_token}"
+
+        AccessTokenRequest.new(opts).access_token
+      end
+
+      private
+
+      attr_accessor :cache_key, :client_id, :client_secret, :url
+
+      def read_token
+        Shutl::Auth.cache.read(cache_key)
+      end
+
+      def set_token(token)
+        Shutl::Auth.cache.write(cache_key, token)
+      end
+
+      def opts
+        {
+          client_id:     client_id,
+          client_secret: client_secret,
+          url:           url
+        }
+      end
+    end
+  end
+end

data/lib/shutl/auth/version.rb

@@ -1,5 +1,5 @@
 module Shutl
   module Auth
-    VERSION = "0.8.5"
+    VERSION = "0.9.0"
   end
 end

data/lib/shutl_auth.rb

@@ -5,11 +5,19 @@ require "shutl/network_retry"
 require "shutl/auth/version"
 require "shutl/auth/access_token_request"
 require "shutl/auth/authenticated_request"
+require "shutl/auth/authenticator"
 
 require 'logger'
 
 module Shutl
+  class UnauthorizedAccess < ::StandardError ; end
+  class Error              < ::StandardError;  end
+
   module Auth
+    class InvalidUrl          < Shutl::Error; end
+    class InvalidCredentials  < Shutl::Error; end
+    class InternalServerError < Shutl::Error; end
+
     extend self
 
     attr_accessor :client_id, :client_secret, :url
@@ -24,4 +32,4 @@ module Shutl
       Logger.new('/dev/null')
     end
   end
-end
+end

data/spec/integration/integration_spec.rb

@@ -2,18 +2,16 @@ require 'spec_helper'
 
 
 describe "Integration" do
-  subject { Shutl::Auth }
-
-  def set_auth
-    Shutl::Auth.config do |c|
-      c.url           =  "http://localhost:3000"
-      c.client_id     =  "QUOTE_SERVICE_CLIENT_ID"
-      c.client_secret =  "QUOTE_SERVICE_CLIENT_SECRET"
-    end
-  end
-
-  before do
-    set_auth
+  subject { Shutl::Auth::AccessTokenRequest.new opts }
+  let(:client_id) { "QUOTE_SERVICE_CLIENT_ID" }
+  let(:url) { "http://localhost:3000" }
+
+  let(:opts) do
+    {
+      client_id: client_id,
+      client_secret: "QUOTE_SERVICE_CLIENT_SECRET",
+      url: url
+    }
   end
 
   context 'successful request to authentication service' do
@@ -21,29 +19,22 @@ describe "Integration" do
 
     specify do
       VCR.use_cassette 'get_token' do
-        Shutl::Auth.access_token!.should == token
+        subject.access_token.should == token
       end
     end
 
-    specify "with invalid auth service url" do
-      Shutl::Auth.url = ''
-
-      expect {Shutl::Auth.access_token!}.to raise_error Shutl::Auth::InvalidUrl
-
-      Shutl::Auth.url = 'http://'
-      expect {Shutl::Auth.access_token!}.to raise_error Shutl::Auth::InvalidUrl
-
-      Shutl::Auth.url = 'http://localhost:3000'
+    describe "with invalid auth service url" do
+      specify do
+        expect { Shutl::Auth::AccessTokenRequest.new(client_id: '', client_secret: '', url: '').access_token}.to raise_error Shutl::Auth::InvalidUrl
+      end
 
-      VCR.use_cassette 'get_token' do
-        Shutl::Auth.access_token!.should == token
+      specify do
+        expect {Shutl::Auth::AccessTokenRequest.new(client_id: '', client_secret: '', url: 'http://').access_token}.to raise_error Shutl::Auth::InvalidUrl
       end
     end
 
     specify "with 500 from auth server" do
-      set_auth
-
-      stub_request(:post, /.*#{Shutl::Auth.url}.*/).to_return(
+      stub_request(:post, /.*#{url}.*/).to_return(
         { body: '',
            status: 500,
            headers: {"CONTENT_TYPE" => 'application/json'}}
@@ -51,24 +42,21 @@ describe "Integration" do
 
       Airbrake.should_receive(:notify)
 
-      expect{ Shutl::Auth.access_token!}.to raise_error Shutl::Auth::InternalServerError
+      expect{ subject.access_token}.to raise_error Shutl::Auth::InternalServerError
     end
 
-    specify "with invalid credentials" do
-      set_auth
-      Shutl::Auth.client_id = 'egg'
+    describe "with invalid credentials" do
+      let(:client_id) { 'egg' }
 
-      VCR.use_cassette 'invalid_credentials' do
-        expect { Shutl::Auth.access_token!}.to raise_error Shutl::Auth::InvalidCredentials
-      end
-
-      set_auth
-      Shutl::Auth.client_id = 'egg'
+      specify do
+        VCR.use_cassette 'invalid_credentials' do
+          expect { subject.access_token}.to raise_error Shutl::Auth::InvalidCredentials
+        end
 
-      VCR.use_cassette 'invalid_credentials' do
-        expect { Shutl::Auth.access_token!}.to raise_error Shutl::Auth::InvalidCredentials
+        VCR.use_cassette 'invalid_credentials' do
+          expect { subject.access_token}.to raise_error Shutl::Auth::InvalidCredentials
+        end
       end
-
     end
   end
 end

data/spec/{access_token_request_spec.rb → unit/access_token_request_spec.rb}

@@ -1,18 +1,20 @@
 require 'spec_helper'
 
-describe Shutl::Auth do
-  subject { Shutl::Auth }
+describe Shutl::Auth::AccessTokenRequest do
+  subject { Shutl::Auth::AccessTokenRequest.new opts }
+
+  let(:opts) do
+    {
+      client_id: "QUOTE_SERVICE_CLIENT_ID",
+      client_secret: "QUOTE_SERVICE_CLIENT_SECRET",
+      url: "http://localhost:3000"
+    }
+  end
 
   let(:oauth_client) { mock 'oauth client' }
 
   before do
     Rack::OAuth2::Client.stub(:new).and_return oauth_client
-
-    Shutl::Auth.config do |c|
-      c.url           =  "http://localhost:3000"
-      c.client_id     =  "QUOTE_SERVICE_CLIENT_ID"
-      c.client_secret =  "QUOTE_SERVICE_CLIENT_SECRET"
-    end
   end
 
   context 'successful request to authentication service' do
@@ -21,7 +23,7 @@ describe Shutl::Auth do
     end
 
     specify do
-      subject.access_token_response!.should == 'token response'
+      subject.access_token_response.should == 'token response'
     end
   end
 
@@ -34,7 +36,7 @@ describe Shutl::Auth do
       let(:number_of_failures) { 2 }
 
       specify do
-        Shutl::Auth.access_token_response!.should == 'token'
+        subject.access_token_response.should == 'token'
       end
     end
 
@@ -42,7 +44,7 @@ describe Shutl::Auth do
       let(:number_of_failures) { 3 }
 
       specify do
-        Shutl::Auth.access_token_response!.should be_nil
+        subject.access_token_response.should be_nil
       end
     end
 

data/spec/unit/authenticated_request_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
+require 'ostruct'
 
-module Shutl
-  class UnauthorizedAccess < StandardError ; end
-end
 describe Shutl::Auth::AuthenticatedRequest do
 
   class ToTestAuthenticatedRequest
@@ -11,56 +9,48 @@ describe Shutl::Auth::AuthenticatedRequest do
 
   subject { ToTestAuthenticatedRequest.new }
 
-  let(:token)       { 'abcd' }
-  let(:spare_token) { '1234' }
+  let(:authenticator) { OpenStruct.new(access_token: '123', request_access_token: '456')}
 
   before do
-    Shutl::Auth.stub(:access_token!).and_return(token, spare_token)
+    Shutl::Auth::Authenticator.stub(:new).and_return(authenticator)
   end
 
   describe 'access_token' do
-    it 'requests the token' do
-      subject.access_token.should == token
-    end
-
-    it 'caches the token' do
-      subject.access_token
-
-      subject.access_token.should == token
+    it 'delegates the call to the authenticator' do
+      subject.access_token.should == '123'
     end
   end
 
   describe 'authenticated_request' do
-    it 'execute the block' do
-      block = -> { 'test' }
+    it 'delegates the call to the authenticator' do
+      block = -> { 'abcd' }
+      authenticator.stub(:authenticated_request).with(&block).and_return('abcd')
 
-      result = subject.authenticated_request &block
+      subject.authenticated_request { block }.should == 'abcd'
+    end
+  end
 
-      result.should == 'test'
+  describe 'request_access_token' do
+    it 'delegates the call to the authenticator' do
+      subject.request_access_token.should == '456'
     end
+  end
 
-    it 'retries if the block raise an UnauthorizedAccess' do
-      call = 0
-      block = -> do
-        t = subject.access_token
-        if call == 0
-          call += 1
-          raise Shutl::UnauthorizedAccess
-        end
-        t
+  describe 'default configuration' do
+    before do
+      Shutl::Auth.config do |s|
+        s.url           = 'http://localhost:3000'
+        s.client_id     = 'CLIENT_ID'
+        s.client_secret = 'CLIENT_SECRET'
       end
-
-      result = subject.authenticated_request &block
-
-      result.should == spare_token
     end
 
-    it 'caches the token' do
-      block = -> { subject.access_token }
-
-      2.times { subject.authenticated_request &block }
+    it 'uses the default Shutl::Auth value to authenticate' do
+      Shutl::Auth::Authenticator.should_receive(:new).
+        with(client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET', url: 'http://localhost:3000').
+        and_return(authenticator)
 
-      subject.cache.read(:access_token).should == token
+      subject.request_access_token
     end
   end
 end

data/spec/unit/authenticator_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Shutl::Auth::Authenticator do
+  subject { described_class.new opts }
+
+  let(:token)       { 'abcd' }
+  let(:spare_token) { '1234' }
+  let(:access_token_request) { stub :access_request }
+
+  let(:opts) do
+    {
+      client_id:     "QUOTE_SERVICE_CLIENT_ID",
+      client_secret: "QUOTE_SERVICE_CLIENT_SECRET",
+      url:            "http://localhost:3000"
+    }
+  end
+
+  before do
+    Shutl::Auth.cache.write(:access_token, nil)
+
+    Shutl::Auth::AccessTokenRequest.stub(:new).and_return(access_token_request)
+    access_token_request.stub(:access_token).and_return(token, spare_token)
+  end
+
+  describe 'access_token' do
+    it 'requests the token' do
+      subject.access_token.should == token
+    end
+
+    it 'caches the token' do
+      subject.access_token
+
+      subject.access_token.should == token
+    end
+  end
+
+  describe 'authenticated_request' do
+    it 'execute the block' do
+      block = -> { 'test' }
+
+      result = subject.authenticated_request &block
+
+      result.should == 'test'
+    end
+
+    it 'retries if the block raise an UnauthorizedAccess' do
+      call = 0
+      block = -> do
+        t = subject.access_token
+        if call == 0
+          call += 1
+          raise Shutl::UnauthorizedAccess
+        end
+        t
+      end
+
+      result = subject.authenticated_request &block
+
+      result.should == spare_token
+    end
+
+    it 'caches the token' do
+      block = -> { subject.access_token }
+
+      2.times { subject.authenticated_request &block }
+
+      Shutl::Auth.cache.read(:access_token).should == token
+    end
+  end
+
+  describe 'token cache' do
+    subject { described_class.new(opts.merge(cache_key: :an_other_cache)) }
+
+    it 'caches the token with the provided value' do
+      block = -> { subject.access_token }
+
+      2.times { subject.authenticated_request &block }
+
+      Shutl::Auth.cache.read(:an_other_cache).should == token
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shutl_auth
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retriable
@@ -147,6 +147,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .ruby-version
 - .rvmrc
 - .travis.yml
@@ -160,15 +161,17 @@ files:
 - doc/dependencies.html
 - lib/shutl/auth/access_token_request.rb
 - lib/shutl/auth/authenticated_request.rb
+- lib/shutl/auth/authenticator.rb
 - lib/shutl/auth/version.rb
 - lib/shutl/network_retry.rb
 - lib/shutl_auth.rb
 - shutl_auth.gemspec
-- spec/access_token_request_spec.rb
 - spec/config_spec.rb
 - spec/integration/integration_spec.rb
 - spec/spec_helper.rb
+- spec/unit/access_token_request_spec.rb
 - spec/unit/authenticated_request_spec.rb
+- spec/unit/authenticator_spec.rb
 - spec/vcr/get_token.yml
 - spec/vcr/invalid_credentials.yml
 homepage: ''
@@ -185,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1526403474588545504
+      hash: 3338059309435403024
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -194,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1526403474588545504
+      hash: 3338059309435403024
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -202,10 +205,11 @@ signing_key:
 specification_version: 3
 summary: Used by various gems/services for communicating with shutl oauth server
 test_files:
-- spec/access_token_request_spec.rb
 - spec/config_spec.rb
 - spec/integration/integration_spec.rb
 - spec/spec_helper.rb
+- spec/unit/access_token_request_spec.rb
 - spec/unit/authenticated_request_spec.rb
+- spec/unit/authenticator_spec.rb
 - spec/vcr/get_token.yml
 - spec/vcr/invalid_credentials.yml