attune 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f989d86ece4bbcff8762dbfc11c3879e7b057913
-  data.tar.gz: ef029ed4b38d4d0ed4a8dc072646bcf37e474a1e
+  metadata.gz: 55fd8fc4869a5683e96320760ec40769e6ad8eae
+  data.tar.gz: 3670d480e007e4c3359f60aca54ccc358bfc5ebc
 SHA512:
-  metadata.gz: 6f00289644fedfcb042e5cc19a2001d60707f22c2ea0548e4a38a00133ca0f756a865b2b1105c18078618398bbca32ca48f374d1a83a34c391d9f829e41e5672
-  data.tar.gz: fbda6bd0e3aa269e23bdbcda5419f6c9292f96d418da688bec8155d8e0d9013f0586097443402bbb37896b9dfb294ea65d65eefcb3ac81f93aae2e9f1adfdaae
+  metadata.gz: 9f3791fa61216413b48d19ff413976fe20ae0d3268d139c36ea753922e990d7912dab40aaab568996a0d0f6e9ec224ca04d69212b4b09f84945e34f292a15dd8
+  data.tar.gz: 76be0940a93b17b72dd30267214c63116c94d6b8a8173b79a7663a08987fe2f8842210f598b14e8613c6f3846dfb9b9647b4f850d3398ed7e6135c83b99c1655

data/lib/attune/default.rb

@@ -1,6 +1,7 @@
 require 'attune/param_flattener'
 require "attune/call_dropping"
 require "attune/json_logger"
+require "attune/gzip_request"
 require "attune/net_http_persistent"
 
 module Attune
@@ -28,6 +29,9 @@ module Attune
       # Log all requests
       builder.use Attune::JsonLogger
 
+      # Gzip requests, Faraday handles responses automatically
+      builder.use Attune::GzipRequest
+
       # Raise exceptions for HTTP 4xx/5xx
       builder.response :raise_error
 

data/lib/attune/gzip_request.rb

@@ -0,0 +1,27 @@
+module Attune
+  class GzipRequest < Faraday::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+    CONTENT_ENCODING = 'Content-Encoding'.freeze
+    MIME_TYPE    = 'application/json'.freeze
+    ENCODING_TYPE = 'gzip'.freeze
+
+    def call(env)
+      if has_body?(env) && is_json?(env)
+        wio = StringIO.new("w")
+        w_gz = Zlib::GzipWriter.new(wio)
+        w_gz.write env[:body]
+        w_gz.close
+        env[:body] = wio.string
+        env[:request_headers][CONTENT_ENCODING] = ENCODING_TYPE
+      end
+      @app.call env
+    end
+    def is_json?(env)
+      env[:request_headers][CONTENT_TYPE] == MIME_TYPE
+    end
+    def has_body?(env)
+      body = env[:body] and !(body.respond_to?(:to_str) and body.empty?)
+    end
+  end
+end
+

data/lib/attune/models/anonymous_result.rb

@@ -2,7 +2,7 @@ module Attune
   module Model
     # Result of creating an anonymous user.
     #
-    # @attr [String] id
+    # @attr [String] id Id of the anonymous user.
     class AnonymousResult
       attr_accessor :id
       

data/lib/attune/models/batch_ranking_request.rb

@@ -1,8 +1,8 @@
 module Attune
   module Model
-    # Wrapper for requesting multiple rankings in a single call.
+    # Array of the parameters specified for a ranking request
     #
-    # @attr [Array<Attune::Model::RankingParams>] requests
+    # @attr [Array<Attune::Model::RankingParams>] requests 
     class BatchRankingRequest
       attr_accessor :requests
       

data/lib/attune/models/batch_ranking_result.rb

@@ -1,8 +1,8 @@
 module Attune
   module Model
-    # Wrapper of multiple ranking results.
+    # Array of ranking results.
     #
-    # @attr [Array<Attune::Model::RankedEntities>] results
+    # @attr [Array<Attune::Model::RankedEntities>] results Array of rankings in order of the parameters provided as input.
     class BatchRankingResult
       attr_accessor :results
       

data/lib/attune/models/blacklist.rb

@@ -2,15 +2,15 @@ module Attune
   module Model
     # 
     #
-    # @attr [String] id
-    # @attr [Array<String>] ids
-    # @attr [Boolean] disabled
-    # @attr [Array<String>] scope
-    # @attr [String] consumer
-    # @attr [String] entity_type
-    # @attr [String] start_date
-    # @attr [String] end_date
-    # @attr [String] created_at
+    # @attr [String] id 
+    # @attr [Array<String>] ids 
+    # @attr [String] consumer 
+    # @attr [String] entity_type 
+    # @attr [String] start_date 
+    # @attr [String] end_date 
+    # @attr [String] created_at 
+    # @attr [Boolean] disabled 
+    # @attr [Array<String>] scope 
     class Blacklist
       attr_accessor :id
       
@@ -18,12 +18,6 @@ module Attune
       attr_accessor :ids
       
 
-      attr_accessor :disabled
-      
-
-      attr_accessor :scope
-      
-
       attr_accessor :consumer
       
 
@@ -39,6 +33,12 @@ module Attune
       attr_accessor :created_at
       
 
+      attr_accessor :disabled
+      
+
+      attr_accessor :scope
+      
+
       def initialize(attributes = {})
         return if attributes.empty?
         # Workaround since JSON.parse has accessors as strings rather than symbols
@@ -47,13 +47,6 @@ module Attune
         if value.is_a?(Array)
           @ids = value
 
-        end
-        # Workaround since JSON.parse has accessors as strings rather than symbols
-        @disabled = attributes["disabled"] || attributes[:"disabled"]
-        value = attributes["scope"] || attributes[:"scope"]
-        if value.is_a?(Array)
-          @scope = value
-
         end
         # Workaround since JSON.parse has accessors as strings rather than symbols
         @consumer = attributes["consumer"] || attributes[:"consumer"]
@@ -65,6 +58,13 @@ module Attune
         @end_date = attributes["endDate"] || attributes[:"end_date"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
         @created_at = attributes["createdAt"] || attributes[:"created_at"]
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @disabled = attributes["disabled"] || attributes[:"disabled"]
+        value = attributes["scope"] || attributes[:"scope"]
+        if value.is_a?(Array)
+          @scope = value
+
+        end
         
 
       end
@@ -85,13 +85,13 @@ module Attune
       ATTRIBUTE_MAP = {
           :id => :id,
           :ids => :ids,
-          :disabled => :disabled,
-          :scope => :scope,
           :consumer => :consumer,
           :entity_type => :entityType,
           :start_date => :startDate,
           :end_date => :endDate,
-          :created_at => :createdAt
+          :created_at => :createdAt,
+          :disabled => :disabled,
+          :scope => :scope
 
         }
     end

data/lib/attune/models/blacklist_get_response.rb

@@ -2,7 +2,7 @@ module Attune
   module Model
     # 
     #
-    # @attr [Array<Attune::Model::Blacklist>] blacklists
+    # @attr [Array<Attune::Model::Blacklist>] blacklists 
     class BlacklistGetResponse
       attr_accessor :blacklists
       

data/lib/attune/models/blacklist_params.rb

@@ -2,42 +2,33 @@ module Attune
   module Model
     # 
     #
-    # @attr [Array<String>] scope
-    # @attr [String] active_from
-    # @attr [String] active_to
-    # @attr [String] entity_type
-    # @attr [Array<String>] ids
-    # @attr [Boolean] disabled
+    # @attr [String] entity_type 
+    # @attr [Array<String>] ids 
+    # @attr [Boolean] disabled 
+    # @attr [Array<String>] scope 
+    # @attr [String] active_from 
+    # @attr [String] active_to 
     class BlacklistParams
-      attr_accessor :scope
+      attr_accessor :entity_type
       
 
-      attr_accessor :active_from
+      attr_accessor :ids
       
 
-      attr_accessor :active_to
+      attr_accessor :disabled
       
 
-      attr_accessor :entity_type
+      attr_accessor :scope
       
 
-      attr_accessor :ids
+      attr_accessor :active_from
       
 
-      attr_accessor :disabled
+      attr_accessor :active_to
       
 
       def initialize(attributes = {})
         return if attributes.empty?
-        value = attributes["scope"] || attributes[:"scope"]
-        if value.is_a?(Array)
-          @scope = value
-
-        end
-        # Workaround since JSON.parse has accessors as strings rather than symbols
-        @active_from = attributes["activeFrom"] || attributes[:"active_from"]
-        # Workaround since JSON.parse has accessors as strings rather than symbols
-        @active_to = attributes["activeTo"] || attributes[:"active_to"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
         @entity_type = attributes["entityType"] || attributes[:"entity_type"]
         value = attributes["ids"] || attributes[:"ids"]
@@ -47,6 +38,15 @@ module Attune
         end
         # Workaround since JSON.parse has accessors as strings rather than symbols
         @disabled = attributes["disabled"] || attributes[:"disabled"]
+        value = attributes["scope"] || attributes[:"scope"]
+        if value.is_a?(Array)
+          @scope = value
+
+        end
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @active_from = attributes["activeFrom"] || attributes[:"active_from"]
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @active_to = attributes["activeTo"] || attributes[:"active_to"]
         
 
       end
@@ -65,12 +65,12 @@ module Attune
       private
       # :internal => :external
       ATTRIBUTE_MAP = {
-          :scope => :scope,
-          :active_from => :activeFrom,
-          :active_to => :activeTo,
           :entity_type => :entityType,
           :ids => :ids,
-          :disabled => :disabled
+          :disabled => :disabled,
+          :scope => :scope,
+          :active_from => :activeFrom,
+          :active_to => :activeTo
 
         }
     end

data/lib/attune/models/blacklist_save_response.rb

@@ -2,7 +2,7 @@ module Attune
   module Model
     # 
     #
-    # @attr [String] result
+    # @attr [String] result 
     class BlacklistSaveResponse
       attr_accessor :result
       

data/lib/attune/models/customer.rb

@@ -2,7 +2,7 @@ module Attune
   module Model
     # Customer associated with an anonymous user
     #
-    # @attr [String] customer
+    # @attr [String] customer 
     class Customer
       attr_accessor :customer
       

data/lib/attune/models/ranked_entities.rb

@@ -2,30 +2,30 @@ module Attune
   module Model
     # List of ids in ranked order. If an error occurs, returns message and status code.
     #
-    # @attr [String] message
-    # @attr [Integer] status
-    # @attr [Array<String>] ranking
+    # @attr [String] message Error message if ranking failed
+    # @attr [Array<String>] ranking List of ids in ranked order
+    # @attr [Integer] status HTTP status code if ranking failed
     class RankedEntities
       attr_accessor :message
       
 
-      attr_accessor :status
+      attr_accessor :ranking
       
 
-      attr_accessor :ranking
+      attr_accessor :status
       
 
       def initialize(attributes = {})
         return if attributes.empty?
         # Workaround since JSON.parse has accessors as strings rather than symbols
         @message = attributes["message"] || attributes[:"message"]
-        # Workaround since JSON.parse has accessors as strings rather than symbols
-        @status = attributes["status"] || attributes[:"status"]
         value = attributes["ranking"] || attributes[:"ranking"]
         if value.is_a?(Array)
           @ranking = value
 
         end
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @status = attributes["status"] || attributes[:"status"]
         
 
       end
@@ -45,8 +45,8 @@ module Attune
       # :internal => :external
       ATTRIBUTE_MAP = {
           :message => :message,
-          :status => :status,
-          :ranking => :ranking
+          :ranking => :ranking,
+          :status => :status
 
         }
     end

data/lib/attune/models/ranking_params.rb

@@ -2,34 +2,34 @@ module Attune
   module Model
     # Inputs for ranking a set of ids for a particular user.
     #
-    # @attr [Array<Attune::Model::ScopeEntry>] scope
-    # @attr [String] anonymous
-    # @attr [String] customer
-    # @attr [String] user_agent
-    # @attr [String] entity_type
-    # @attr [Array<String>] ids
-    # @attr [String] ip
-    # @attr [String] view
+    # @attr [String] entity_type 
+    # @attr [Array<String>] ids 
+    # @attr [Array<Attune::Model::ScopeEntry>] scope 
+    # @attr [String] user_agent 
+    # @attr [String] anonymous 
+    # @attr [String] ip 
+    # @attr [String] customer 
+    # @attr [String] view 
     class RankingParams
-      attr_accessor :scope
+      attr_accessor :entity_type
       
 
-      attr_accessor :anonymous
+      attr_accessor :ids
       
 
-      attr_accessor :customer
+      attr_accessor :scope
       
 
       attr_accessor :user_agent
       
 
-      attr_accessor :entity_type
+      attr_accessor :anonymous
       
 
-      attr_accessor :ids
+      attr_accessor :ip
       
 
-      attr_accessor :ip
+      attr_accessor :customer
       
 
       attr_accessor :view
@@ -37,27 +37,27 @@ module Attune
 
       def initialize(attributes = {})
         return if attributes.empty?
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @entity_type = attributes["entityType"] || attributes[:"entity_type"]
+        value = attributes["ids"] || attributes[:"ids"]
+        if value.is_a?(Array)
+          @ids = value
+
+        end
         value = attributes["scope"] || attributes[:"scope"]
         if value.is_a?(Array)
           @scope = value.map{ |v| ScopeEntry.new(v) }
 
         end
         # Workaround since JSON.parse has accessors as strings rather than symbols
-        @anonymous = attributes["anonymous"] || attributes[:"anonymous"]
-        # Workaround since JSON.parse has accessors as strings rather than symbols
-        @customer = attributes["customer"] || attributes[:"customer"]
-        # Workaround since JSON.parse has accessors as strings rather than symbols
         @user_agent = attributes["userAgent"] || attributes[:"user_agent"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
-        @entity_type = attributes["entityType"] || attributes[:"entity_type"]
-        value = attributes["ids"] || attributes[:"ids"]
-        if value.is_a?(Array)
-          @ids = value
-
-        end
+        @anonymous = attributes["anonymous"] || attributes[:"anonymous"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
         @ip = attributes["ip"] || attributes[:"ip"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
+        @customer = attributes["customer"] || attributes[:"customer"]
+        # Workaround since JSON.parse has accessors as strings rather than symbols
         @view = attributes["view"] || attributes[:"view"]
         
 
@@ -77,13 +77,13 @@ module Attune
       private
       # :internal => :external
       ATTRIBUTE_MAP = {
-          :scope => :scope,
-          :anonymous => :anonymous,
-          :customer => :customer,
-          :user_agent => :userAgent,
           :entity_type => :entityType,
           :ids => :ids,
+          :scope => :scope,
+          :user_agent => :userAgent,
+          :anonymous => :anonymous,
           :ip => :ip,
+          :customer => :customer,
           :view => :view
 
         }

data/lib/attune/models/scope_entry.rb

@@ -1,9 +1,9 @@
 module Attune
   module Model
-    # Name value pairs indicating the context where a ranking will be displayed.
+    # Name/value pairs that provide additional context to the request
     #
-    # @attr [String] name
-    # @attr [String] value
+    # @attr [String] name 
+    # @attr [String] value 
     class ScopeEntry
       attr_accessor :name
       

data/lib/attune/version.rb

@@ -1,4 +1,4 @@
 module Attune
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end
 

data/spec/remote_spec.rb

@@ -11,7 +11,7 @@ describe "remote requests" 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, timeout: 2) }
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attune
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - John Hawthorn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -147,6 +147,7 @@ files:
 - lib/attune/client.rb
 - lib/attune/configurable.rb
 - lib/attune/default.rb
+- lib/attune/gzip_request.rb
 - lib/attune/json_logger.rb
 - lib/attune/mocks.rb
 - lib/attune/models/anonymous_result.rb