recombee_api_client 5.1.0 → 6.0.0

data/lib/recombee_api_client/api/add_purchase.rb

@@ -5,33 +5,32 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a purchase of the given item made by the given user.
+  # Adds a purchase of the given item made by the given user.
   #
   class AddPurchase < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :cascade_create, :amount, :price, :profit, :recomm_id, :additional_data
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> User who purchased the item
-  #   - +item_id+ -> Purchased item
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> UTC timestamp of the purchase 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) of purchased items. The default is 1. For example, if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal 2.
-  #   - +price+ -> Price paid by the user for the item. If `amount` is greater than 1, the sum of prices of all the items should be given.
-  #   - +profit+ -> Your profit from the purchased item. The profit is natural in the e-commerce domain (for example, if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30) but is also applicable in other domains (for example, at a news company it may be income from a displayed advertisement on article page). If `amount` is greater than 1, the sum of profit of all the items should be given.
-  #   - +recommId+ -> If this purchase 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 purchased the item
+    #   - +item_id+ -> Purchased item
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +timestamp+ -> UTC timestamp of the purchase 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) of purchased items. The default is 1. For example, if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal 2.
+    #   - +price+ -> Price paid by the user for the item. If `amount` is greater than 1, the sum of prices of all the items should be given.
+    #   - +profit+ -> Your profit from the purchased item. The profit is natural in the e-commerce domain (for example, if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30) but is also applicable in other domains (for example, at a news company it may be income from a displayed advertisement on article page). If `amount` is greater than 1, the sum of profit of all the items should be given.
+    #   - +recommId+ -> If this purchase 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']
@@ -43,18 +42,19 @@ module RecombeeApiClient
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","profit","recommId","additionalData"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[timestamp cascadeCreate amount price profit 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'
@@ -64,19 +64,19 @@ module RecombeeApiClient
       p['profit'] = @optional['profit'] if @optional.include? 'profit'
       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}/purchases/"
+      '/{databaseId}/purchases/'
     end
   end
 end

data/lib/recombee_api_client/api/add_rating.rb

@@ -5,32 +5,31 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a rating of the given item made by the given user.
+  # Adds a rating of the given item made by the given user.
   #
   class AddRating < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :rating, :cascade_create, :recomm_id, :additional_data
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> User who submitted the rating
-  #   - +item_id+ -> Rated item
-  #   - +rating+ -> Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating. For example, in the case of 5-star evaluations, rating = (numStars-3)/2 formula may be used for the conversion.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> UTC timestamp of the rating 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 rating 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 submitted the rating
+    #   - +item_id+ -> Rated item
+    #   - +rating+ -> Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating. For example, in the case of 5-star evaluations, rating = (numStars-3)/2 formula may be used for the conversion.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +timestamp+ -> UTC timestamp of the rating 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 rating 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, rating, optional = {})
       @user_id = user_id
       @item_id = item_id
       @rating = rating
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @recomm_id = optional['recommId']
@@ -39,18 +38,19 @@ module RecombeeApiClient
       @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['rating'] = @rating
@@ -58,19 +58,19 @@ module RecombeeApiClient
       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}/ratings/"
+      '/{databaseId}/ratings/'
     end
   end
 end

data/lib/recombee_api_client/api/add_search_synonym.rb

@@ -5,68 +5,67 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a new synonym for the [Search items](https://docs.recombee.com/api#search-items).
+  # Adds a new synonym for the [Search items](https://docs.recombee.com/api#search-items).
   #
-  #When the `term` is used in the search query, the `synonym` is also used for the full-text search.
-  #Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
+  # When the `term` is used in the search query, the `synonym` is also used for the full-text search.
+  # Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
   #
-  #An example of a synonym can be `science fiction` for the term `sci-fi`.
+  # An example of a synonym can be `science fiction` for the term `sci-fi`.
   #
   class AddSearchSynonym < ApiRequest
     attr_reader :term, :synonym, :one_way
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +term+ -> A word to which the `synonym` is specified.
-  #   - +synonym+ -> A word that should be considered equal to the `term` by the full-text search engine.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +oneWay+ -> If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
-  #
-  #Default: `false`.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +term+ -> A word to which the `synonym` is specified.
+    #   - +synonym+ -> A word that should be considered equal to the `term` by the full-text search engine.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +oneWay+ -> If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
+    #
+    # Default: `false`.
+    #
+    #
     def initialize(term, synonym, optional = {})
       @term = term
       @synonym = synonym
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @one_way = optional['oneWay']
       @optional = optional
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["oneWay"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['oneWay'].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['term'] = @term
       p['synonym'] = @synonym
       p['oneWay'] = @optional['oneWay'] if @optional.include? 'oneWay'
+
       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}/synonyms/items/"
+      '/{databaseId}/synonyms/items/'
     end
   end
 end

data/lib/recombee_api_client/api/add_series.rb

@@ -5,52 +5,51 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Creates a new series in the database.
+  # Creates a new series in the database.#
   class AddSeries < ApiRequest
     attr_reader :series_id, :cascade_create
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +series_id+ -> ID of the series to be created.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> If set to `true`, the item will be created with the same ID as the series. Default is `true`.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +series_id+ -> ID of the series to be created.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +cascadeCreate+ -> If set to `true`, the item will be created with the same ID as the series. Default is `true`.
+    #
     def initialize(series_id, optional = {})
       @series_id = series_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['cascadeCreate'].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :put
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+
       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}/series/#{@series_id}"

data/lib/recombee_api_client/api/add_user.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a new user to the database.
+  # Adds a new user to the database.
   #
   class AddUser < ApiRequest
     attr_reader :user_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user to be added.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user to be added.
+    #
     def initialize(user_id)
       @user_id = user_id
       @timeout = 3000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :put
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
-      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}/users/#{@user_id}"

data/lib/recombee_api_client/api/add_user_property.rb

@@ -5,60 +5,59 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adding a user property is somewhat equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
+  # Adding a user property is somewhat equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
   #
   class AddUserProperty < ApiRequest
     attr_reader :property_name, :type
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +property_name+ -> Name of the user property to be created. Currently, the following names are reserved: `id`, `userid`, case-insensitively. Also, the length of the property name must not exceed 63 characters.
-  #
-  #   - +type+ -> Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`.
-  #
-  #* `int` - Signed integer number.
-  #
-  #* `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
-  #
-  #* `string` - UTF-8 string.
-  #
-  #* `boolean` - *true* / *false*
-  #
-  #* `timestamp` - Value representing date and time.
-  #
-  #* `set` - Set of strings.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +property_name+ -> Name of the user property to be created. Currently, the following names are reserved: `id`, `userid`, case-insensitively. Also, the length of the property name must not exceed 63 characters.
+    #
+    #   - +type+ -> Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`.
+    #
+    # * `int` - Signed integer number.
+    #
+    # * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
+    #
+    # * `string` - UTF-8 string.
+    #
+    # * `boolean` - *true* / *false*
+    #
+    # * `timestamp` - Value representing date and time.
+    #
+    # * `set` - Set of strings.
+    #
+    #
     def initialize(property_name, type)
       @property_name = property_name
       @type = type
-      @timeout = 100000
+      @timeout = 100_000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :put
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
-      p
+      {}
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
       params['type'] = @type
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
       "/{databaseId}/users/properties/#{@property_name}"

data/lib/recombee_api_client/api/batch.rb

@@ -8,22 +8,22 @@ module RecombeeApiClient
   #
   class Batch < ApiRequest
     attr_reader :requests
-    attr_accessor :timeout
-    attr_accessor :ensure_https
+    attr_accessor :timeout, :ensure_https
+
     ##
     # * *Required arguments*
     #   - +requests+ -> Array of API requests.
     #
     def initialize(requests, optional = {})
       @requests = requests
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @optional = optional
       @body_parameters = requests_to_batch_hash
-      @timeout = requests.map{|r| r.timeout}.reduce(:+)
+      @timeout = requests.map { |r| r.timeout }.reduce(:+)
       @ensure_https = true
 
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["distinctRecomms"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['distinctRecomms'].include? par
       end
     end
 
@@ -38,39 +38,35 @@ module RecombeeApiClient
     # Values of query path parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
 
     # Relative path to the endpoint
     def path
-      p = '/{databaseId}/batch/'
-      p
+      '/{databaseId}/batch/'
     end
 
     private
 
     def requests_to_batch_hash
       reqs = []
-      @requests.each { |r| reqs.push(request_to_batch_hash r) }
-      result = {'requests' => reqs}
+      @requests.each { |r| reqs.push(request_to_batch_hash(r)) }
+      result = { 'requests' => reqs }
       result['distinctRecomms'] = @optional['distinctRecomms'] if @optional.key? 'distinctRecomms'
       result
     end
 
     def request_to_batch_hash(req)
       path = req.path
-      path.slice! ('/{databaseId}')
+      path.slice!('/{databaseId}')
       bh = {
         'method' => req.method.to_s.upcase,
         'path' => path
       }
       params = req.query_parameters
 
-      if req.body_parameters
-        params = params.merge(req.body_parameters)
-      end
-      
+      params = params.merge(req.body_parameters) if req.body_parameters
+
       bh['params'] = params if params.size > 0
       bh
     end