attune 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YmI0ZDQ2MjAxYWIyYzNiNDE0Y2E5YWI1YWFmMTUxMDcyYTNjZTc3Mw==
-  data.tar.gz: !binary |-
-    YmRkYWIzMTRhOGNlOTVlYzBhZDFjY2FkMGFkNDY2MGVlNWIzMGY2ZA==
+SHA1:
+  metadata.gz: a768188791c5cf1b4dbb0d9bb7639c79be622f49
+  data.tar.gz: 0b55667d588255b97df0fc7fbc7d7571f2a3a420
 SHA512:
-  metadata.gz: !binary |-
-    M2UyY2E5ZTE5MzAyNGY2NGIzNjQyNDEwYWU0ZTRiN2FkYWEwNDA5MjY3Yjg2
-    ZTQ3N2Q3ZGU3MzE0OWUzZWNiNmM2ZjUyMTQxMjU4NGJhMTA2MGUzYTI4ODk2
-    ODhhYmQ1MWQ0ZjM0MDA3ZDU4OWEyNDJjMDExYjY4ODk2MWE1MDk=
-  data.tar.gz: !binary |-
-    NWI4YmYxMDMxNWZkMWQxYTZjZTIyODQ1MjdiYjkxMWIwZjYzM2E1MDM3MDk1
-    M2Y5ZTU5YWQ4ODcwNTk4ZDQ0NWE0ZjA1NzMzOTI1MTQyMGQ0NzQ5MDE3MzFi
-    YjJmYzVlNTQxNmQ5ZjUyMWQyNzZkZjU5NDMxNjQxZTIzMjA5YTc=
+  metadata.gz: a90ccfd4d4aa1893c315e161545a3bd04cdddcdaabdc98f7e4daf809a7a8acbefd3e15d03344fd933ae83e290b7ff3f4bdd2c15b0180565d4b00597c4c7d9e74
+  data.tar.gz: 1686b9cfa601e45f89590446c8c69a65f9c6f80b775f4031056fc6f9438c790514f836d7f00622ce31b0562d92e62c643aa19da5a53491c92d08cb2289be1ec8

data/README.md

@@ -1,6 +1,10 @@
 # Attune
 
-A client for the [Attune ranking API](http://attune.co/). Build using the excellent [faraday](https://github.com/lostisland/faraday) library.
+A client for the [Attune ranking API](http://attune.co/). Built using the excellent [faraday](https://github.com/lostisland/faraday) library.
+
+* [Github](https://github.com/DigitalStripe/attune-ruby)
+* [RubyGems](https://rubygems.org/gems/attune)
+* [Documentation](http://rdoc.info/github/DigitalStripe/attune-ruby)
 
 ## Installation
 
@@ -55,22 +59,24 @@ The client can then perform rankings
 ``` ruby
 class ProductsController
   def index
-    @products = Product.all
+    @products = sorted(Product.all)
+  end
 
+  private
+  def sorted products
     ranking = attune_client.get_ranking(
       id: session[:attune_id],
       view: request.fullpath,
       collection: 'products',
-      entities: @products.map(&:id)
+      entities: products.map(&:id)
     )
-    @products.sort_by do |product|
+    products.sort_by do |product|
       ranking.index(product.id.to_s)
     end
   end
 end
 ```
 
-
 ### Configuration
 
 Attune can be configured globally
@@ -88,9 +94,26 @@ Settings can also be overridden on a client object
 client = Attune::Client.new(timeout: 2)
 ```
 
+See the documentation for
+[Attune::Configurable](http://rdoc.info/github/DigitalStripe/attune-ruby/master/Attune/Configurable)
+and the
+[default configuration](http://rdoc.info/github/DigitalStripe/attune-ruby/master/Attune/Default)
+for more details.
+
+### Testing
+
+For testing and development, the ranking API can be simulated using.
+
+``` ruby
+Attune.test_mode!
+```
+
+In this mode no API calls will be made, and rankings will be returned in their original order.
+Calling `.test_mode!` is equivalent to setting `disabled` to true and `exception_handler` to `:mock`.
+
 ## Contributing
 
-1. Fork it ( http://github.com/freerunningtech/attune/fork )
+1. Fork it ( http://github.com/DigitalStripe/attune/fork )
 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`)

data/attune.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["john@freerunningtechnologies.com"]
   spec.summary       = %q{Client for the Attune product ranking API.}
   spec.description   = %q{Client for the Attune product ranking API.}
-  spec.homepage      = "https://github.com/freerunningtech/attune-ruby"
+  spec.homepage      = "https://github.com/DigitalStripe/attune-ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "simplecov"
 end

data/lib/attune.rb

@@ -9,4 +9,17 @@ module Attune
   def self.client
     Client.new
   end
+
+  # Simulate all API calls
+  # This is equivalent to setting disabled to true and exception_handler to
+  # :mock
+  def self.test_mode!
+    configure do |c|
+      c.exception_handler = :mock
+      c.disabled = true
+    end
+  end
+  def self.configure(&block)
+    Default.configure(&block)
+  end
 end

data/lib/attune/call_dropping.rb

@@ -0,0 +1,52 @@
+module Attune
+  class CallDropping < Faraday::Middleware
+    def initialize app, storage=default_storage
+      @app = app
+      @storage = storage
+    end
+
+    def call env
+      raise_timeout if should_skip?
+      begin
+        result = @app.call(env)
+        increment_skips(-SKIP_STEP)
+        result
+      rescue Faraday::Error::TimeoutError => e
+        increment_skips(SKIP_STEP)
+        raise e
+      end
+    end
+
+    private
+    # requests to skip before retry
+    SKIP_STEP = 0.25
+
+    # The most requests to skip before retrying
+    SKIP_MAX = 10.0
+
+    def raise_timeout
+      raise Faraday::Error::TimeoutError, "dropped request"
+    end
+
+    def should_skip?
+      rand > (1.0 / (1.0 + skip_rate))
+    end
+
+    def increment_skips amount
+      self.skip_rate = skip_rate + amount
+
+      if skip_rate <= 0.0
+        self.skip_rate = 0.0
+      elsif skip_rate >= SKIP_MAX
+        self.skip_rate = SKIP_MAX
+      end
+    end
+
+    def skip_rate; @storage[:skip_rate] || 0.0; end
+    def skip_rate= v; @storage[:skip_rate]= v; end
+
+    def default_storage
+      Thread.current
+    end
+  end
+end

data/lib/attune/client.rb

@@ -1,8 +1,12 @@
 require 'json'
 
 module Attune
+  class DisabledException < Faraday::Error::ClientError
+    def initialize(message="Attune library disabled though config")
+      super(message)
+    end
+  end
 
-  # Client for the attune
   class Client
     include Attune::Configurable
 
@@ -38,14 +42,19 @@ module Attune
     # @option options [String] :user_agent The user agent for the application used by the anonymous users
     # @return id [String]
     # @raise [ArgumentError] if user_agent is not provided
+    # @raise [Faraday::Error] if the request fails or exceeds the timeout
     def create_anonymous(options)
       raise ArgumentError, "user_agent required" unless options[:user_agent]
       if id = options[:id]
-        response = put("anonymous/#{id}", {user_agent: options[:user_agent]})
+        put("anonymous/#{id}", {user_agent: options[:user_agent]})
         id
       else
-        response = post("anonymous", {user_agent: options[:user_agent]})
-        response[:location][/\Aurn:id:([a-z0-9\-]+)\Z/, 1]
+        if response = post("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
+          SecureRandom.uuid
+        end
       end
     end
 
@@ -67,10 +76,15 @@ module Attune
     # @option options [String] :customer id of customer (optional)
     # @return ranking [Array<String>] The entities in their ranked order
     # @raise [ArgumentError] if required parameters are missing
+    # @raise [Faraday::Error] if the request fails or exceeds the timeout
     def get_rankings(options)
       qs = encoded_ranking_params(options)
-      response = get("rankings/#{qs}", customer: options.fetch(:customer, 'none'))
-      JSON.parse(response.body)['ranking']
+      if response = get("rankings/#{qs}", customer: options.fetch(:customer, 'none'))
+        JSON.parse(response.body)['ranking']
+      else
+        # In mock mode: return the entities in the order passed in
+        options[:entities]
+      end
     end
 
     # Get multiple rankings in one call
@@ -92,14 +106,21 @@ module Attune
     #   ])
     # @param [Array<Hash>] multi_options An array of options (see #get_rankings)
     # @return [Array<Array<String>>] rankings
+    # @raise [Faraday::Error] if the request fails or exceeds the timeout
     def multi_get_rankings(multi_options)
       requests = multi_options.map do |options|
         encoded_ranking_params(options)
       end
-      response = get("rankings", ids: requests)
-      results = JSON.parse(response.body)['results']
-      results.values.map do |result|
-        result['ranking']
+      if response = get("rankings", ids: requests)
+        results = JSON.parse(response.body)['results']
+        results.values.map do |result|
+          result['ranking']
+        end
+      else
+        # In mock mode: return the entities in the order passed in
+        multi_options.map do |options|
+          options[:entities]
+        end
       end
     end
 
@@ -112,6 +133,7 @@ module Attune
     #     '25892e17-80f6-415f-9c65-7395632f022',
     #     'cd171f7c-560d-4a62-8d65-16b87419a58'
     #   )
+    # @raise [Faraday::Error] if the request fails or exceeds the timeout
     def bind(id, customer_id)
       put("bindings/anonymous=#{id}&customer=#{customer_id}")
       true
@@ -131,27 +153,32 @@ module Attune
 
     def get(path, params={})
       adapter.get(path, params)
-    rescue Faraday::ClientError => e
+    rescue Faraday::Error::ClientError => e
       handle_exception(e)
     end
 
     def put(path, params={})
       adapter.put(path, ::JSON.dump(params))
-    rescue Faraday::ClientError => e
+    rescue Faraday::Error::ClientError => e
       handle_exception(e)
     end
 
     def post(path, params={})
       adapter.post(path, ::JSON.dump(params))
-    rescue Faraday::ClientError => e
+    rescue Faraday::Error::ClientError => e
       handle_exception(e)
     end
 
     def handle_exception e
-      raise e
+      if exception_handler == :mock
+        nil
+      else
+        raise e
+      end
     end
 
     def adapter
+      raise DisabledException if disabled?
       Faraday.new(url: endpoint, builder: middleware, request: {timeout: timeout})
     end
   end

data/lib/attune/configurable.rb

@@ -4,6 +4,7 @@ module Attune
       :endpoint,
       :middleware,
       :disabled,
+      :exception_handler,
       :timeout
     ]
 
@@ -15,10 +16,23 @@ module Attune
 
     # FIXME
     attr_accessor :disabled
+    alias_method :disabled?, :disabled
 
     # Time (in seconds) to wait for requests to finish
     attr_accessor :timeout
 
+    # How to deal with HTTP exceptions
+    # @param [:mock, :raise] handler Method used for handling exceptions.
+    # @raise [ArgumentError] if handler is not :mock or :raise
+    attr_reader :exception_handler
+    def exception_handler= handler
+      if [:mock, :raise].include?(handler)
+        @exception_handler = handler
+      else
+        raise ArgumentError, "exception_handler must be :mock or :raise"
+      end
+    end
+
     # @example configure
     #   Attune.configure do |c|
     #     c.endpoint = "http://example.com:8080/"

data/lib/attune/default.rb

@@ -1,4 +1,5 @@
 require 'attune/param_flattener'
+require "attune/call_dropping"
 require "attune/json_logger"
 
 module Attune
@@ -12,6 +13,9 @@ module Attune
       # Needed for encoding of BATCH GET requests
       builder.use Attune::ParamFlattener
 
+      # Log all requests
+      builder.use Attune::CallDropping
+
       # Allow one retry per request
       builder.request :retry, 1
 
@@ -27,6 +31,7 @@ module Attune
       c.endpoint = ENDPOINT
       c.middleware = MIDDLEWARE
       c.disabled = false
+      c.exception_handler = :raise
       c.timeout = 1
     end
   end

data/lib/attune/version.rb

@@ -1,3 +1,3 @@
 module Attune
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/attune/call_dropping_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Attune::CallDropping do
+  let(:stubs){ Faraday::Adapter::Test::Stubs.new }
+  let(:connection) do
+    Faraday.new(url: 'http://example.com/') do |builder|
+      builder.use described_class, storage
+      builder.adapter :test, stubs
+    end
+  end
+  let(:response){ connection.get("/") }
+  let(:timeout){ Faraday::Error::TimeoutError.new("simulated timeout") }
+
+  context "using default storage" do
+    let(:connection) do
+      Faraday.new(url: 'http://example.com/') do |builder|
+        builder.use described_class
+        builder.adapter :test, stubs
+      end
+    end
+    it "can be initialized" do
+      stubs.get("/"){ [200, {}, "foobar"] }
+      expect(response.body).to eq "foobar"
+      stubs.verify_stubbed_calls
+    end
+  end
+
+  context "without previous timeouts" do
+    let(:storage){ {} }
+    context "no timeout" do
+      it "runs request" do
+        stubs.get("/"){ [200, {}, "foobar"] }
+        expect(response.body).to eq "foobar"
+        expect(storage).to eq(skip_rate: 0.0)
+        stubs.verify_stubbed_calls
+      end
+    end
+
+    context "with a timeout" do
+      it "raises the timeout" do
+        stubs.get("/"){ raise timeout }
+        expect {
+          response
+        }.to raise_exception(Faraday::Error::TimeoutError)
+        expect(storage).to eq(skip_rate: 0.25)
+        stubs.verify_stubbed_calls
+      end
+    end
+  end
+
+  context "with an existing skip rate" do
+    let(:storage){ {skip_rate: 1.0} }
+    before{ described_class.any_instance.stub(rand: random) }
+    context "request skipped" do
+      let(:random){ 1 }
+      it "raises timeout" do
+        expect {
+          response
+        }.to raise_exception(Faraday::Error::TimeoutError)
+        expect(storage).to eq(skip_rate: 1.00)
+      end
+    end
+
+    context "request attempted" do
+      context "at max drop rate" do
+        let(:storage){ {skip_rate: 10.0} }
+        it "leaves drop rate unchanged" do
+          stubs.get("/"){ raise timeout }
+          expect { response }.to raise_exception(Faraday::Error::TimeoutError)
+          expect(storage).to eq(skip_rate: 10.0)
+          stubs.verify_stubbed_calls
+        end
+      end
+
+      let(:random){ 0 }
+      it "succeeds an reduces skip rate" do
+        stubs.get("/"){ [200, {}, "foobar"] }
+        expect(response.body).to eq "foobar"
+        expect(storage).to eq(skip_rate: 0.75)
+        stubs.verify_stubbed_calls
+      end
+    end
+  end
+end

data/spec/attune/client_spec.rb

@@ -24,6 +24,63 @@ describe Attune::Client do
     end
   end
 
+  describe "API errors" do
+    it "will raise timeout" do
+      stubs.post("anonymous", %[{"user_agent":"Mozilla/5.0"}]){ raise Faraday::Error::TimeoutError.new("test") }
+      expect {
+        client.create_anonymous(user_agent: 'Mozilla/5.0')
+      }.to raise_exception(Faraday::Error::TimeoutError)
+      stubs.verify_stubbed_calls
+    end
+    it "will raise ConnectionFailed" do
+      stubs.post("anonymous", %[{"user_agent":"Mozilla/5.0"}]){ raise Faraday::Error::ConnectionFailed.new("test") }
+      expect {
+        client.create_anonymous(user_agent: 'Mozilla/5.0')
+      }.to raise_exception(Faraday::Error::ConnectionFailed)
+      stubs.verify_stubbed_calls
+    end
+  end
+
+  describe "disabled" do
+    context "with raise" do
+      let(:options){ {disabled: true, exception_handler: :raise} }
+      it "will raise DisalbedException" do
+        expect {
+          client.create_anonymous(user_agent: 'Mozilla/5.0')
+        }.to raise_exception(Attune::DisabledException)
+      end
+    end
+    context "with mock" do
+      let(:options){ {disabled: true, exception_handler: :mock} }
+      it "mocks create_anonymous with an id" do
+        result = client.create_anonymous(id: '12345', user_agent: 'Mozilla/5.0')
+        expect(result).to eq('12345')
+      end
+      it "mocks create_anonymous with no id" do
+        result = client.create_anonymous(user_agent: 'Mozilla/5.0')
+        expect(result).to match(/^[a-z0-9\-]+$/)
+      end
+      it "mocks get_rankings" do
+        result = client.get_rankings(
+          id: 'abcd123',
+          view: 'b/mens-pants',
+          collection: 'products',
+          entities: %w[1001, 1002, 1003, 1004]
+        )
+        expect(result).to eq %w[1001, 1002, 1003, 1004]
+      end
+      it "mocks multi_get_rankings" do
+        result = client.multi_get_rankings([
+          id: 'abcd123',
+          view: 'b/mens-pants',
+          collection: 'products',
+          entities: %w[1001, 1002, 1003, 1004]
+        ])
+        expect(result).to eq [%w[1001, 1002, 1003, 1004]]
+      end
+    end
+  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')

data/spec/attune_spec.rb

@@ -9,4 +9,18 @@ describe Attune do
     specify { expect(subject.endpoint).to eq 'http://localhost/' }
     specify { expect(subject.disabled).to eq false }
   end
+  describe 'configure' do
+    it "yields with Attune::Default" do
+      Attune.configure do |c|
+        expect(c).to be Attune::Default
+      end
+    end
+  end
+  describe 'test_mode' do
+    it "sets correct test options" do
+      expect(Attune::Default).to receive(:exception_handler=).with(:mock)
+      expect(Attune::Default).to receive(:disabled=).with(true)
+      Attune.test_mode!
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/vendor'
+  add_filter '/spec'
+end
+
 require 'attune'
 
 # This file was generated by the `rspec --init` command. Conventionally, all

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: attune
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   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
@@ -42,56 +42,70 @@ dependencies:
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: yard
   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'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Client for the Attune product ranking API.
@@ -111,18 +125,20 @@ files:
 - Rakefile
 - attune.gemspec
 - lib/attune.rb
+- lib/attune/call_dropping.rb
 - lib/attune/client.rb
 - lib/attune/configurable.rb
 - lib/attune/default.rb
 - lib/attune/json_logger.rb
 - lib/attune/param_flattener.rb
 - lib/attune/version.rb
+- spec/attune/call_dropping_spec.rb
 - spec/attune/client_spec.rb
 - spec/attune/json_logger_spec.rb
 - spec/attune_spec.rb
 - spec/remote_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/freerunningtech/attune-ruby
+homepage: https://github.com/DigitalStripe/attune-ruby
 licenses:
 - MIT
 metadata: {}
@@ -132,21 +148,22 @@ 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.1.9
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Client for the Attune product ranking API.
 test_files:
+- spec/attune/call_dropping_spec.rb
 - spec/attune/client_spec.rb
 - spec/attune/json_logger_spec.rb
 - spec/attune_spec.rb