attune 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71b45b8b01601ab2b240d6c5243a39c0991a23d9
-  data.tar.gz: fd29c20cac7f27e6cb3aa00f9a6c8ec4c54070a9
+  metadata.gz: aa77fa0fcbd44e02a0b3a26e722a76f3e7fabbff
+  data.tar.gz: bc15acc01376c94db3192f81a90d114aa6040e91
 SHA512:
-  metadata.gz: 830ae6660ed070894351cb69c13da91827fbb9abaa43a79377e527d1f8d339be1c6c20391280f4b9a315363c8cb7d24f344e6e9ccc0ba166d327651cbe9549f5
-  data.tar.gz: b7dd011b6e0003d0fa5d7e7a69cb53666dd3773e1cd50de389e870bb928ba75d9a1e4506d73b4af124d37a8eeac464a1b14cf66bf7473241fe7bbc618201844b
+  metadata.gz: 04272c55ef9a1f7095a2e77beaf008451aa73bf115fc5f99cf791f34e76e1dad2ffda8c3f1fde06b40203530fd6643822c563bd389772430b1f3ec9dbcb04b34
+  data.tar.gz: b95899dd52c6d526944569c775bfae2e942bfda23766b346792bfb68f28a0c6bc1103055ae9f5e86f1199842b788719348ef24f49d6fb888b2ba4585ce0600e6

data/README.md

@@ -77,12 +77,20 @@ class ProductsController
 end
 ```
 
+The client provides a way to request a new auth_token through the API
+
+``` ruby
+client = Attune::Client.new
+auth_token = client.get_auth_token('my-client-id', 'my-client-secret')
+```
+
 ### Configuration
 
 Attune can be configured globally
 
 ``` ruby
 Attune.configure do |c|
+  c.auth_token = "my-secure-auth-token"
   c.endpoint = "http://example.com/"
   c.timeout  = 5
 end
@@ -91,7 +99,7 @@ end
 Settings can also be overridden on a client object
 
 ``` ruby
-client = Attune::Client.new(timeout: 2)
+client = Attune::Client.new(auth_token: "my-secure-auth-token", timeout: 2)
 ```
 
 See the documentation for

data/attune.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "yard"
-  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "redcarpet", ">= 3.1.1"
   spec.add_development_dependency "simplecov"
 end

data/lib/attune/client.rb

@@ -7,6 +7,12 @@ module Attune
     end
   end
 
+  class AuthenticationException < Faraday::Error::ClientError
+    def initialize(message="Authentication credentials not accepted")
+      super(message)
+    end
+  end
+
   class Client
     include Attune::Configurable
 
@@ -19,13 +25,44 @@ module Attune
     #   )
     #
     # @param [Hash] options Options for connection (see Attune::Configurable)
-    # @returns A new client object
+    # @return A new client object
     def initialize(options={})
       Attune::Configurable::KEYS.each do |key|
         send("#{key}=", options[key] || Attune::Default.send(key))
       end
     end
 
+    # Request an auth token
+    #
+    # @example Generate a new auth token
+    #   token = client.get_auth_token("client id", "secret")
+    # @param [String] client_id The client identifier.
+    # @param [String] client_secret The secret key for the client.
+    # @return An auth token if credentials accepted
+    # @raise [ArgumentError] if client_id or client_secret is not provided
+    # @raise [AuthenticationException] if client_id or client_secret are not accepted
+    # @raise [Faraday::Error::ClientError] if the request fails or exceeds the timeout
+    def get_auth_token(client_id, client_secret)
+      raise ArgumentError, "client_id required" unless client_id
+      raise ArgumentError, "client_secret required" unless client_secret
+
+      response = post_form("oauth/token",
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: :client_credentials
+      )
+      if response
+        body = JSON.parse(response.body)
+        if body['error']
+          raise AuthenticationException, body['error_description']
+        end
+        body['access_token']
+      else
+        # Return a new UUID if there was an exception and we're in mock mode
+        SecureRandom.uuid
+      end
+    end
+
     # Create an anonymous tracked user
     #
     # @example Generate a new id (preferred)
@@ -43,13 +80,14 @@ module Attune
     # @return id [String]
     # @raise [ArgumentError] if user_agent is not provided
     # @raise [Faraday::Error::ClientError] if the request fails or exceeds the timeout
+    # @raise [AuthenticationException] if authorization header not accepted
     def create_anonymous(options)
       raise ArgumentError, "user_agent required" unless options[:user_agent]
       if id = options[:id]
         put("anonymous/#{id}", {user_agent: options[:user_agent]})
         id
       else
-        if response = post("anonymous", {user_agent: options[:user_agent]})
+        if response = post_json("anonymous", {user_agent: options[:user_agent]})
           response[:location][/\Aurn:id:([a-z0-9\-]+)\Z/, 1]
         else
           # Return a new UUID if there was an exception and we're in mock mode
@@ -77,6 +115,7 @@ module Attune
     # @return ranking [Array<String>] The entities in their ranked order
     # @raise [ArgumentError] if required parameters are missing
     # @raise [Faraday::Error::ClientError] if the request fails or exceeds the timeout
+    # @raise [AuthenticationException] if authorization header not accepted
     def get_rankings(options)
       qs = encoded_ranking_params(options)
       if response = get("rankings/#{qs}", customer: options.fetch(:customer, 'none'))
@@ -107,6 +146,7 @@ module Attune
     # @param [Array<Hash>] multi_options An array of options (see #get_rankings)
     # @return [Array<Array<String>>] rankings
     # @raise [Faraday::Error::ClientError] if the request fails or exceeds the timeout
+    # @raise [AuthenticationException] if authorization header not accepted
     def multi_get_rankings(multi_options)
       requests = multi_options.map do |options|
         encoded_ranking_params(options)
@@ -139,6 +179,7 @@ module Attune
     #     'cd171f7c-560d-4a62-8d65-16b87419a58'
     #   )
     # @raise [Faraday::Error::ClientError] if the request fails or exceeds the timeout
+    # @raise [AuthenticationException] if authorization header not accepted
     def bind(id, customer_id)
       put("bindings/anonymous=#{id}&customer=#{customer_id}")
       true
@@ -168,8 +209,18 @@ module Attune
       handle_exception(e)
     end
 
-    def post(path, params={})
-      adapter.post(path, ::JSON.dump(params))
+    def post_form(path, params={})
+      adapter.post(path, params)
+    rescue Faraday::Error::ClientError => e
+      handle_exception(e)
+    end
+
+    def post_json(path, params={})
+      adapter.post do |req|
+        req.url path
+        req.headers['Content-Type'] = 'application/json'
+        req.body = ::JSON.dump(params)
+      end
     rescue Faraday::Error::ClientError => e
       handle_exception(e)
     end
@@ -178,13 +229,19 @@ module Attune
       if exception_handler == :mock
         nil
       else
-        raise e
+        if e.response && e.response[:status] == 401
+          raise AuthenticationException, e
+        else
+          raise e
+        end
       end
     end
 
     def adapter
       raise DisabledException if disabled?
-      Faraday.new(url: endpoint, builder: middleware, request: {timeout: timeout})
+      conn = Faraday.new(url: endpoint, builder: middleware, request: {timeout: timeout})
+      conn.authorization :Bearer, auth_token unless !auth_token
+      conn
     end
   end
 end

data/lib/attune/configurable.rb

@@ -1,6 +1,7 @@
 module Attune
   module Configurable
     KEYS = [
+      :auth_token,
       :endpoint,
       :middleware,
       :disabled,
@@ -8,6 +9,9 @@ module Attune
       :timeout
     ]
 
+    # The Authorization token
+    attr_accessor :auth_token
+
     # The HTTP endpoint to connect to
     attr_accessor :endpoint
 

data/lib/attune/default.rb

@@ -16,6 +16,8 @@ module Attune
       # Log all requests
       builder.use Attune::CallDropping
 
+      builder.request  :url_encoded
+
       # Allow one retry per request
       builder.request :retry, 1
 

data/lib/attune/version.rb

@@ -1,3 +1,3 @@
 module Attune
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/attune/client_spec.rb

@@ -39,6 +39,15 @@ describe Attune::Client do
       }.to raise_exception(Faraday::Error::ConnectionFailed)
       stubs.verify_stubbed_calls
     end
+    it "will raise AuthenticationException" do
+      stubs.post("oauth/token",
+        {:client_id=>"id", :client_secret=>"secret", grant_type: :client_credentials}
+      ){ [200, {}, %[{"error":"invalid_client","error_description":"Bad client credentials"}]] }
+      expect {
+        client.get_auth_token("id", "secret")
+      }.to raise_exception(Attune::AuthenticationException)
+      stubs.verify_stubbed_calls
+    end
   end
 
   describe "disabled" do
@@ -52,6 +61,11 @@ describe Attune::Client do
     end
     context "with mock" do
       let(:options){ {disabled: true, exception_handler: :mock} }
+
+      it "mocks get_auth_token" do
+        result = client.get_auth_token("id", "secret")
+        expect(result).to match(/^[a-z0-9\-]+$/)
+      end
       it "mocks create_anonymous with an id" do
         result = client.create_anonymous(id: '12345', user_agent: 'Mozilla/5.0')
         expect(result).to eq('12345')
@@ -81,6 +95,15 @@ describe Attune::Client do
     end
   end
 
+  it "can get_auth_token requesting a token" do
+    stubs.post("oauth/token",
+      {:client_id=>"id", :client_secret=>"secret", grant_type: :client_credentials}
+    ){ [200, {}, %[{"access_token":"secret-token","token_type":"bearer"}]] }
+    token = client.get_auth_token('id', 'secret')
+
+    expect(token).to eq('secret-token')
+  end
+
   it "can create_anonymous generating an id" do
     stubs.post("anonymous", %[{"user_agent":"Mozilla/5.0"}]){ [200, {location: 'urn:id:abcd123'}, nil] }
     id = client.create_anonymous(user_agent: 'Mozilla/5.0')
@@ -104,7 +127,7 @@ describe Attune::Client do
   end
 
   it "can get_rankings" do
-    stubs.get("rankings/anonymous=abcd123&view=b%2Fmens-pants&entity_collection=products&entities=1001%2C%2C1002%2C%2C1003%2C%2C1004&ip=none"){ [200, {}, %[{"ranking":["1004","1003","1002","1001"]}]] }
+    stubs.get("rankings/anonymous=abcd123&entities=1001%2C%2C1002%2C%2C1003%2C%2C1004&entity_collection=products&ip=none&view=b%2Fmens-pants"){ [200, {}, %[{"ranking":["1004","1003","1002","1001"]}]] }
     rankings = client.get_rankings(
       id: 'abcd123',
       view: 'b/mens-pants',
@@ -119,7 +142,7 @@ describe Attune::Client do
   let(:req1){ CGI::escape 'anonymous=0cddbc0-6114-11e3-949a-0800200c9a66&view=b%2Fmens-pants&entity_collection=products&entities=1001%2C%2C1002%2C%2C1003%2C%2C1004&ip=none' }
   let(:req2){ CGI::escape 'anonymous=0cddbc0-6114-11e3-949a-0800200c9a66&view=b%2Fmens-pants&entity_collection=products&entities=2001%2C%2C2002%2C%2C2003%2C%2C2004&ip=none' }
   it "can multi_get_rankings" do
-    stubs.get("/rankings?ids=anonymous%3D0cddbc0-6114-11e3-949a-0800200c9a66%26view%3Db%252Fmens-pants%26entity_collection%3Dproducts%26entities%3D1001%252C%252C1002%252C%252C1003%252C%252C1004%26ip%3Dnone&ids=anonymous%3D0cddbc0-6114-11e3-949a-0800200c9a66%26view%3Db%252Fmens-pants%26entity_collection%3Dproducts%26entities%3D2001%252C%252C2002%252C%252C2003%252C%252C2004%26ip%3Dnone") do
+    stubs.get("/rankings?ids=anonymous%3D0cddbc0-6114-11e3-949a-0800200c9a66%26entities%3D1001%252C%252C1002%252C%252C1003%252C%252C1004%26entity_collection%3Dproducts%26ip%3Dnone%26view%3Db%252Fmens-pants&ids=anonymous%3D0cddbc0-6114-11e3-949a-0800200c9a66%26entities%3D2001%252C%252C2002%252C%252C2003%252C%252C2004%26entity_collection%3Dproducts%26ip%3Dnone%26view%3Db%252Fmens-pants") do
       [200, {}, <<-JSON]
 {
     "errors": {},

data/spec/attune/json_logger_spec.rb

@@ -24,6 +24,6 @@ describe Attune::JsonLogger do
     response.status.should == 200
     response.body.should == "foobar"
 
-    expect(logged).to eq %[{"ref":null,"v":1,"protocol":"http","host":"example.com","path":"/test","t":12345000,"r_id":"eaa45af2-efc3-45ef-90da-9bcb56758e77","status":200,"ua":"Faraday v0.8.8","method":"get","perf":{"total":120.0}}]
+    expect(logged).to match(/{"ref":null,"v":1,"protocol":"http","host":"example.com","path":"\/test","t":12345000,"r_id":"eaa45af2-efc3-45ef-90da-9bcb56758e77","status":200,"ua":"Faraday v\d+.\d+.\d+","method":"get","perf":{"total":120.0}}/)
   end
 end

data/spec/remote_spec.rb

@@ -2,8 +2,23 @@ require 'spec_helper'
 
 describe "remote requests" do
   let(:endpoint){ ENV['REMOTE_ENDPOINT'] }
-  before { pending "REMOTE_ENDPOINT required for remote spec" unless endpoint }
-  let!(:client){ Attune::Client.new(endpoint: endpoint) }
+  let(:auth_token){ ENV['AUTH_TOKEN'] }
+
+  let(:client_id) { ENV['CLIENT_ID'] }
+  let(:client_secret) { ENV['CLIENT_SECRET'] }
+
+  before do
+    pending "REMOTE_ENDPOINT required for remote spec" unless endpoint
+    pending "AUTH_TOKEN required for remote spec" unless auth_token
+  end
+  let!(:client){ Attune::Client.new(endpoint: endpoint, auth_token: auth_token) }
+
+  it "can request an auth_token given a client id and secret" do
+    pending "CLIENT_ID required for get_auth_token spec" unless client_id
+    pending "CLIENT_SECRET required for get_auth_token spec" unless client_secret
+    token = client.get_auth_token(client_id, client_secret)
+    token.should =~ /[a-z0-9\-]+/
+  end
 
   it "can create an anonymous user" do
     id = client.create_anonymous(user_agent: 'Mozilla/5.0')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attune
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Client for the Attune product ranking API.