attune 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a563fd197a9c289b606b60513d1ff6d59e923f59
-  data.tar.gz: db9e422ab1230d0df8b763d04d3b18f6ef263a78
+  metadata.gz: 0cdd1d33ca1623326bd2c704e63db89f4fcd2108
+  data.tar.gz: 3c0959d27267e602ed662f979601d96cf0afa9f0
 SHA512:
-  metadata.gz: 77f9eee386f7c94052fcae0e1c9badbe97294ad0fdb7cf5227876cd6a41127bf6563398c808904cddf9ba3a2968e95d3c28f3554b036a26158c841665f521eb1
-  data.tar.gz: dcdabaec2faf8cc7d3e39f170a90a8fa970fae7de0dc3cfb2804a95067196c5bd7fe994c41a199557b6fc9b1d2ec8783f4ae64282698b96a18b7723e83691cbb
+  metadata.gz: d925942d0c3305bbdeb954f4d434f865b83930980ccd133738d67333dc7ab90e1ce075362bd29a866c5b2c20fb474fbaf21c49da4dc7a2bcf15a7a4c68c21f31
+  data.tar.gz: 209966761a7586eedc8234452f3fff3dac1d02928a4170d11f1ce255097ffe3a699b1fb52854956e0c4f5077cd971b3e05e92176c9022fbb5fdbfef252da9b41

data/README.md

@@ -71,7 +71,7 @@ class ProductsController
       entities: products.map(&:id)
     )
     products.sort_by do |product|
-      ranking.index(product.id.to_s)
+      ranking[:entities].index(product.id.to_s)
     end
   end
 end

data/lib/attune/client.rb

@@ -112,18 +112,24 @@ module Attune
     # @option options [Array<String>] :entities entities to be ranked. These should be numeric strings or integers.
     # @option options [String] :ip ip address of remote user. Used for geolocation (optional)
     # @option options [String] :customer id of customer (optional)
-    # @return ranking [Array<String>] The entities in their ranked order
+    # @return [Hash{Symbol => Hash, Array<String>}]
+    #   * :headers the attune headers indicating ranking performed
+    #   * :entities 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)
+      rankings = {}
       if response = get("rankings/#{qs}", customer: options.fetch(:customer, 'none'))
-        JSON.parse(response.body)['ranking']
+        rankings[:headers] = response.headers.select { |k,v| k =~ /^attune/ }
+        rankings[:entities] = JSON.parse(response.body)['ranking']
       else
         # In mock mode: return the entities in the order passed in
-        options[:entities]
+        rankings[:headers] = {"attune-cell"=>"mock", "attune-ranking"=>"mock"}
+        rankings[:entities] = options[:entities]
       end
+      rankings
     end
 
     # Get multiple rankings in one call
@@ -144,29 +150,35 @@ module Attune
     #     }
     #   ])
     # @param [Array<Hash>] multi_options An array of options (see #get_rankings)
-    # @return [Array<Array<String>>] rankings
+    # @return [Hash{Symbol => Hash, Array<Array<String>>}]
+    #   * :headers the attune headers indicating ranking performed
+    #   * :entities entities in their ranked order
     # @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)
       end
+      rankings = {}
       if response = get("rankings", ids: requests)
         results = JSON.parse(response.body)['results']
+        rankings[:headers] = response.headers.select { |k,v| k =~ /^attune/ }
 
         # Order of encoded paramaters may change, so we must parse them
         results = Hash[results.map do |request, result|
           [CGI.parse(request), result]
         end]
-        requests.map do |request|
+        rankings[:entities] = requests.map do |request|
           results[CGI.parse(request)]['ranking']
         end
       else
         # In mock mode: return the entities in the order passed in
-        multi_options.map do |options|
+        rankings[:headers] = {"attune-cell"=>"mock", "attune-ranking"=>"mock"}
+        rankings[:entities] = multi_options.map do |options|
           options[:entities]
         end
       end
+      rankings
     end
 
     # Binds an anonymous user to a customer id

data/lib/attune/version.rb

@@ -1,3 +1,3 @@
 module Attune
-  VERSION = "0.0.7"
+  VERSION = "1.0.0"
 end

data/spec/attune/client_spec.rb

@@ -80,7 +80,11 @@ describe Attune::Client do
           collection: 'products',
           entities: %w[1001, 1002, 1003, 1004]
         )
-        expect(result).to eq %w[1001, 1002, 1003, 1004]
+        expected = {
+          headers: {"attune-cell"=>"mock", "attune-ranking"=>"mock"},
+          entities: %w[1001, 1002, 1003, 1004]
+        }
+        expect(result).to eq expected
       end
       it "mocks multi_get_rankings" do
         result = client.multi_get_rankings([
@@ -89,7 +93,11 @@ describe Attune::Client do
           collection: 'products',
           entities: %w[1001, 1002, 1003, 1004]
         ])
-        expect(result).to eq [%w[1001, 1002, 1003, 1004]]
+        expected = {
+          headers: {"attune-cell"=>"mock", "attune-ranking"=>"mock"},
+          entities: [%w[1001, 1002, 1003, 1004]]
+        }
+        expect(result).to eq expected
       end
     end
   end
@@ -125,66 +133,83 @@ describe Attune::Client do
     expect(id).to eq('abcd123')
   end
 
-  it "can get_rankings" do
-    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',
-      collection: 'products',
-      entities: %w[1001, 1002, 1003, 1004]
-    )
-    stubs.verify_stubbed_calls
+  describe "get_rankings" do
+    before(:each) do
+      stubs.get("rankings/anonymous=abcd123&entities=1001%2C%2C1002%2C%2C1003%2C%2C1004&entity_collection=products&ip=none&view=b%2Fmens-pants"){ [200, {"attune-ranking"=>"test", "attune-cell"=>"test"}, %[{"ranking":["1004","1003","1002","1001"]}]] }
+      @rankings = client.get_rankings(
+        id: 'abcd123',
+        view: 'b/mens-pants',
+        collection: 'products',
+        entities: %w[1001, 1002, 1003, 1004]
+      )
+      stubs.verify_stubbed_calls
+    end
+
+    it "can get ranked entities" do
+      expect(@rankings[:entities]).to eq(%W[1004 1003 1002 1001])
+    end
 
-    expect(rankings).to eq(%W[1004 1003 1002 1001])
+    it "can get ranking headers" do
+      expect(@rankings[:headers]).to eq({"attune-ranking"=>"test", "attune-cell"=>"test"})
+    end
   end
 
-  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%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": {},
-    "results": {
-        "anonymous=0cddbc0-6114-11e3-949a-0800200c9a66&entities=1001%2C%2C1002%2C%2C1003%2C%2C1004&entity_collection=products&ip=none&view=b%2Fmens-pants": {
-            "ranking": [
-                "1004",
-                "1003",
-                "1002",
-                "1001"
-            ]
+  describe "multi_get_rankings" 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' }
+
+    before(:each) 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, {"attune-ranking"=>"test", "attune-cell"=>"test"}, <<-JSON]
+  {
+      "errors": {},
+      "results": {
+          "anonymous=0cddbc0-6114-11e3-949a-0800200c9a66&entities=1001%2C%2C1002%2C%2C1003%2C%2C1004&entity_collection=products&ip=none&view=b%2Fmens-pants": {
+              "ranking": [
+                  "1004",
+                  "1003",
+                  "1002",
+                  "1001"
+              ]
+          },
+          "anonymous=0cddbc0-6114-11e3-949a-0800200c9a66&entities=2001%2C%2C2002%2C%2C2003%2C%2C2004&entity_collection=products&ip=none&view=b%2Fmens-pants": {
+              "ranking": [
+                  "2004",
+                  "2003",
+                  "2002",
+                  "2001"
+              ]
+          }
+      }
+  }
+        JSON
+      end
+      @rankings = client.multi_get_rankings([
+        {
+          id: '0cddbc0-6114-11e3-949a-0800200c9a66',
+          view: 'b/mens-pants',
+          collection: 'products',
+          entities: %w[1001, 1002, 1003, 1004]
         },
-        "anonymous=0cddbc0-6114-11e3-949a-0800200c9a66&entities=2001%2C%2C2002%2C%2C2003%2C%2C2004&entity_collection=products&ip=none&view=b%2Fmens-pants": {
-            "ranking": [
-                "2004",
-                "2003",
-                "2002",
-                "2001"
-            ]
+        {
+          id: '0cddbc0-6114-11e3-949a-0800200c9a66',
+          view: 'b/mens-pants',
+          collection: 'products',
+          entities: %w[2001, 2002, 2003, 2004]
         }
-    }
-}
-      JSON
+      ])
+      stubs.verify_stubbed_calls
     end
-    rankings = client.multi_get_rankings([
-      {
-        id: '0cddbc0-6114-11e3-949a-0800200c9a66',
-        view: 'b/mens-pants',
-        collection: 'products',
-        entities: %w[1001, 1002, 1003, 1004]
-      },
-      {
-        id: '0cddbc0-6114-11e3-949a-0800200c9a66',
-        view: 'b/mens-pants',
-        collection: 'products',
-        entities: %w[2001, 2002, 2003, 2004]
-      }
-    ])
-    stubs.verify_stubbed_calls
 
-    expect(rankings).to eq [
-      %W[1004 1003 1002 1001],
-      %W[2004 2003 2002 2001]
-    ]
+    it "can get ranked entities" do
+      expect(@rankings[:entities]).to eq [
+        %W[1004 1003 1002 1001],
+        %W[2004 2003 2002 2001]
+      ]
+    end
+
+    it "can get ranking headers" do
+      expect(@rankings[:headers]).to eq({"attune-ranking"=>"test", "attune-cell"=>"test"})
+    end
   end
 end

data/spec/remote_spec.rb

@@ -35,24 +35,35 @@ describe "remote requests" do
     client.bind(id, '654321')
   end
 
+  let(:entities){ [202875,202876,202874,202900,202902,202898,202905,200182,200181,185940,188447,185932,190589,1238689589] }
   describe "get_rankings" do
-    let(:entities){ [202875,202876,202874,202900,202902,202898,202905,200182,200181,185940,188447,185932,190589,1238689589] }
-    it "can get rankings" do
+    before(:each) do
       id = client.create_anonymous(id: '123456', user_agent: 'Mozilla/5.0')
       client.bind(id, '654321')
-      result = client.get_rankings(id: '123456', view: 'b/mens-pants', collection: 'products', entities: entities)
-      result.should be_an Array
-      result.sort.should == entities.map(&:to_s).sort
+      @result = client.get_rankings(id: '123456', view: 'b/mens-pants', collection: 'products', entities: entities)
+    end
+    it "can get ranked entities" do
+      @result[:entities].should be_an Array
+      @result[:entities].sort.should == entities.map(&:to_s).sort
     end
+    specify { expect(@result[:headers]).to be_a Hash }
+    specify { expect(@result[:headers]).to have_key "attune-ranking" }
+    specify { expect(@result[:headers]).to have_key "attune-cell" }
+  end
 
-    it "can batch get rankings" do
+  describe "multi_get_rankings" do
+    before(:each) do
       id = client.create_anonymous(id: '123456', user_agent: 'Mozilla/5.0')
       client.bind(id, '654321')
-      results = client.multi_get_rankings([id: '123456', view: 'b/mens-pants', collection: 'products', entities: entities])
-      results.should be_an Array
-
-      result, = *results
+      @results = client.multi_get_rankings([id: '123456', view: 'b/mens-pants', collection: 'products', entities: entities])
+    end
+    it "can batch get rankings" do
+      @results[:entities].should be_an Array
+      result, = *@results[:entities]
       result.sort.should == entities.map(&:to_s).sort
     end
+    specify { expect(@results[:headers]).to be_a Hash }
+    specify { expect(@results[:headers]).to have_key "attune-ranking" }
+    specify { expect(@results[:headers]).to have_key "attune-cell" }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attune
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday