Release: v6.0.0

- Added support for the new Composite Recommendation endpoint
- Added new parameter `autoPresented` for Detail View and View Portion interactions
- Added new parameter `timeSpent` for View Portion interactions
- Added support for `reqlExpressions` on recommended items
- Added support for input classes
- Format code using `rubocop`

Author: OndraFiedler

lib/recombee_api_client.rb

@@ -10,15 +10,16 @@
 
 require 'recombee_api_client/errors'
 Gem.find_files('recombee_api_client/api/*.rb').each { |path| require path }
+Gem.find_files('recombee_api_client/inputs/*.rb').each { |path| require path }
 
 module RecombeeApiClient
   ##
   # Client for sending requests to Recombee recommender system
   class RecombeeClient
     include HTTParty
 
-    BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/5.1.0'}
+    BATCH_MAX_SIZE = 10_000
+    USER_AGENT = { 'User-Agent' => 'recombee-ruby-api-client/6.0.0' }
 
     ##
     #   - +account+ -> Name of your account at Recombee
@@ -33,8 +34,7 @@ def initialize(account, token, options = {})
     ##
     #   - +request+ -> ApiRequest to be sent to Recombee recommender
     def send(request)
-
-      return send_multipart_batch(request) if request.kind_of? Batch and request.requests.size > BATCH_MAX_SIZE
+      return send_multipart_batch(request) if request.is_a? Batch and request.requests.size > BATCH_MAX_SIZE
 
       timeout = request.timeout / 1000
       uri = process_request_uri(request)
@@ -54,20 +54,23 @@ def send(request)
           delete(request, uri, timeout)
         end
       rescue Timeout::Error
-        fail ApiTimeout.new(request)
+        raise ApiTimeout.new(request)
       end
     end
 
     private
 
     def get_regional_base_uri(region)
       uri = {
-            'ap-se' => 'rapi-ap-se.recombee.com',
-            'ca-east' => 'rapi-ca-east.recombee.com',
-            'eu-west' => 'rapi-eu-west.recombee.com',
-            'us-west' => 'rapi-us-west.recombee.com'
-          }[region.to_s.gsub('_', '-').downcase]
-      raise ArgumentError.new("Region \"#{region}\" is unknown. You may need to update the version of the SDK.") if uri == nil
+        'ap-se' => 'rapi-ap-se.recombee.com',
+        'ca-east' => 'rapi-ca-east.recombee.com',
+        'eu-west' => 'rapi-eu-west.recombee.com',
+        'us-west' => 'rapi-us-west.recombee.com'
+      }[region.to_s.gsub('_', '-').downcase]
+      if uri.nil?
+        raise ArgumentError.new("Region \"#{region}\" is unknown. You may need to update the version of the SDK.")
+      end
+
       uri
     end
 
@@ -77,16 +80,17 @@ def get_base_uri(options)
 
       if options.key? :region
         raise ArgumentError.new(':base_uri and :region cannot be specified at the same time') if base_uri
+
         base_uri = get_regional_base_uri(options[:region])
       end
-      base_uri||= 'rapi.recombee.com'
+      base_uri ||= 'rapi.recombee.com'
       base_uri
     end
 
     def put(request, uri, timeout)
-      response = self.class.put(uri, body: request.body_parameters.to_json, 
-                                headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
-                                timeout: timeout)
+      response = self.class.put(uri, body: request.body_parameters.to_json,
+                                     headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
+                                     timeout: timeout)
       check_errors(response, request)
       response.body
     end
@@ -98,60 +102,62 @@ def get(request, uri, timeout)
     end
 
     def post(request, uri, timeout)
-      response = self.class.post(uri, body: request.body_parameters.to_json, 
-                                 headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
-                                 timeout: timeout)
+      response = self.class.post(uri, body: request.body_parameters.to_json,
+                                      headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
+                                      timeout: timeout)
       check_errors(response, request)
       begin
-        return JSON.parse(response.body)
+        JSON.parse(response.body)
       rescue JSON::ParserError
-        return response.body
+        response.body
       end
     end
 
     def delete(request, uri, timeout)
       response = self.class.delete(uri, body: request.body_parameters.to_json,
-                                   headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
-                                   timeout: timeout)
+                                        headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
+                                        timeout: timeout)
       check_errors(response, request)
       begin
-        return JSON.parse(response.body)
+        JSON.parse(response.body)
       rescue JSON::ParserError
-        return response.body
+        response.body
       end
     end
 
     def check_errors(response, request)
       status_code = response.code
-      return if status_code == 200 || status_code == 201
-      fail ResponseError.new(request, status_code, response.body)
+      return if [200, 201].include?(status_code)
+
+      raise ResponseError.new(request, status_code, response.body)
     end
 
     def send_multipart_batch(request)
       requests_parts = request.requests.each_slice(BATCH_MAX_SIZE)
-      responses = requests_parts.map {|rqs| Batch.new(rqs)}.map{|batch| send(batch)}
-      responses.inject([]){|result,resp| result + resp}
+      responses = requests_parts.map { |rqs| Batch.new(rqs) }.map { |batch| send(batch) }
+      responses.inject([]) { |result, resp| result + resp }
     end
 
     def process_request_uri(request)
       uri = request.path
-      uri.slice! ('/{databaseId}/')
+      uri.slice!('/{databaseId}/')
       uri += query_parameters_to_url(request)
       uri
     end
 
     def query_parameters_to_url(req)
       ps = ''
       req.query_parameters.each do |name, val|
-        ps += (ps.include? '?') ? '&' : '?'
+        ps += ps.include?('?') ? '&' : '?'
         ps += "#{name}=#{format_query_parameter_value(val)}"
       end
       ps
     end
 
     def format_query_parameter_value(value)
-      return CGI::escape("#{value}") unless value.kind_of?(Array)
-      value.map{|v| CGI::escape("#{v}")}.join(',')
+      return CGI.escape("#{value}") unless value.is_a?(Array)
+
+      value.map { |v| CGI.escape("#{v}") }.join(',')
     end
 
     # Sign request with HMAC, request URI must be exacly the same
@@ -160,12 +166,11 @@ def sign_url(req_part)
       uri = "/#{@account}/#{req_part}"
       time = hmac_time(uri)
       sign = hmac_sign(uri, time)
-      res = uri + time + "&hmac_sign=#{sign}"
-      res
+      uri + time + "&hmac_sign=#{sign}"
     end
 
     def hmac_time(uri)
-      res = (uri.include? '?') ? '&' : '?'
+      res = uri.include?('?') ? '&' : '?'
       res << "hmac_timestamp=#{Time.now.utc.to_i}"
     end
 

lib/recombee_api_client/api/add_bookmark.rb

@@ -5,30 +5,29 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a bookmark of the given item made by the given user.
+  # Adds a bookmark of the given item made by the given user.
   #
   class AddBookmark < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :cascade_create, :recomm_id, :additional_data
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> User who bookmarked the item
-  #   - +item_id+ -> Bookmarked item
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
-  #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
-  #   - +recommId+ -> If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-  #   - +additionalData+ -> A dictionary of additional data for the interaction.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> User who bookmarked the item
+    #   - +item_id+ -> Bookmarked item
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +timestamp+ -> UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
+    #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+    #   - +recommId+ -> If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+    #   - +additionalData+ -> A dictionary of additional data for the interaction.
+    #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @recomm_id = optional['recommId']
@@ -37,37 +36,38 @@ def initialize(user_id, item_id, optional = {})
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","recommId","additionalData"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[timestamp cascadeCreate recommId
+                                                          additionalData].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :post
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['userId'] = @user_id
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
       p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
       p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
+
       p
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/bookmarks/"
+      '/{databaseId}/bookmarks/'
     end
   end
 end

lib/recombee_api_client/api/add_cart_addition.rb

@@ -5,32 +5,31 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a cart addition of the given item made by the given user.
+  # Adds a cart addition of the given item made by the given user.
   #
   class AddCartAddition < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :cascade_create, :amount, :price, :recomm_id, :additional_data
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> User who added the item to the cart
-  #   - +item_id+ -> Item added to the cart
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
-  #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
-  #   - +amount+ -> Amount (number) added to cart. The default is 1. For example, if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal 2.
-  #   - +price+ -> Price of the added item. If `amount` is greater than 1, the sum of prices of all the items should be given.
-  #   - +recommId+ -> If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-  #   - +additionalData+ -> A dictionary of additional data for the interaction.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> User who added the item to the cart
+    #   - +item_id+ -> Item added to the cart
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +timestamp+ -> UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
+    #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+    #   - +amount+ -> Amount (number) added to cart. The default is 1. For example, if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal 2.
+    #   - +price+ -> Price of the added item. If `amount` is greater than 1, the sum of prices of all the items should be given.
+    #   - +recommId+ -> If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+    #   - +additionalData+ -> A dictionary of additional data for the interaction.
+    #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @amount = optional['amount']
@@ -41,18 +40,19 @@ def initialize(user_id, item_id, optional = {})
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","recommId","additionalData"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[timestamp cascadeCreate amount price recommId
+                                                          additionalData].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :post
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['userId'] = @user_id
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
@@ -61,19 +61,19 @@ def body_parameters
       p['price'] = @optional['price'] if @optional.include? 'price'
       p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
       p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
+
       p
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/cartadditions/"
+      '/{databaseId}/cartadditions/'
     end
   end
 end