recombee_api_client 5.1.0 → 6.0.0

data/lib/recombee_api_client/api/set_item_values.rb

@@ -1,45 +1,44 @@
 module RecombeeApiClient
   require_relative 'set_values'
   require_relative '../errors'
-  
+
   ##
-  #Set/update (some) property values of a given item. The properties (columns) must be previously created by [Add item property](https://docs.recombee.com/api#add-item-property).
+  # Set/update (some) property values of a given item. The properties (columns) must be previously created by [Add item property](https://docs.recombee.com/api#add-item-property).
   #
   class SetItemValues < SetValues
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item which will be modified.
-  #
-  #   - +values+ -> The values for the individual properties.
-  #
-  #Example of body:
-  #```
-  #  {
-  #    "product_description": "4K TV with 3D feature",
-  #    "categories":   ["Electronics", "Televisions"],
-  #    "price_usd": 342,
-  #    "in_stock_from": "2016-11-16T08:00Z",
-  #    "!cascadeCreate": true
-  #  }
-  #```
-  #
-  #Special parameter `!cascadeCreate` may be used. It indicates that the item of the given itemId should be created if it does not exist in the database, as if the corresponding PUT method was used. Note the exclamation mark (!) at the beginning of the parameter's name to distinguish it from item property names.
-  #
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> Sets whether the item should be created  if not present in the database.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item which will be modified.
+    #
+    #   - +values+ -> The values for the individual properties.
+    #
+    # Example of body:
+    # ```
+    #  {
+    #    "product_description": "4K TV with 3D feature",
+    #    "categories":   ["Electronics", "Televisions"],
+    #    "price_usd": 342,
+    #    "in_stock_from": "2016-11-16T08:00Z",
+    #    "!cascadeCreate": true
+    #  }
+    # ```
+    #
+    # Special parameter `!cascadeCreate` may be used. It indicates that the item of the given itemId should be created if it does not exist in the database, as if the corresponding PUT method was used. Note the exclamation mark (!) at the beginning of the parameter's name to distinguish it from item property names.
+    #
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +cascadeCreate+ -> Sets whether the item should be created  if not present in the database.
+    #
     def initialize(item_id, values, optional = {})
       super(values, optional)
       @item_id = item_id
       @timeout = 1000
       @ensure_https = false
     end
-  
+
     # Relative path to the endpoint
     def path
       "/{databaseId}/items/#{@item_id}"

data/lib/recombee_api_client/api/set_user_values.rb

@@ -1,32 +1,31 @@
 module RecombeeApiClient
   require_relative 'set_values'
   require_relative '../errors'
-  
+
   ##
-  #Set/update (some) property values of a given user. The properties (columns) must be previously created by [Add user property](https://docs.recombee.com/api#add-user-property).
+  # Set/update (some) property values of a given user. The properties (columns) must be previously created by [Add user property](https://docs.recombee.com/api#add-user-property).
   #
   class SetUserValues < SetValues
     attr_reader :user_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user which will be modified.
-  #
-  #   - +values+ -> The values for the individual properties.
-  #
-  #Example of body:
-  #```
-  #  {
-  #    "country": "US",
-  #    "sex": "F",
-  #  }
-  #```
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> Sets whether the item should be created  if not present in the database.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user which will be modified.
+    #
+    #   - +values+ -> The values for the individual properties.
+    #
+    # Example of body:
+    # ```
+    #  {
+    #    "country": "US",
+    #    "sex": "F",
+    #  }
+    # ```
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +cascadeCreate+ -> Sets whether the item should be created  if not present in the database.
+    #
     def initialize(user_id, values, optional = {})
       super(values, optional)
       @user_id = user_id

data/lib/recombee_api_client/api/set_values.rb

@@ -1,57 +1,57 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Set/update (some) property values of a given entity.
+  # Set/update (some) property values of a given entity.
   #
   class SetValues < ApiRequest
     attr_reader :cascade_create, :values
-  
-  ##
-  # * *Required arguments*
-  #   - +values+ -> The values for the individual properties.
-  #
-  #Example of body:
-  #```
-  #  {
-  #    "product_description": "4K TV with 3D feature",
-  #    "categories":   ["Electronics", "Televisions"],
-  #    "price_usd": 342,
-  #    "in_stock_from": "2016-11-16T08:00Z",
-  #  }
-  #```
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> Sets whether the item should be created  if not present in the database.
-  #
-    def initialize( values, optional = {})
+
+    ##
+    # * *Required arguments*
+    #   - +values+ -> The values for the individual properties.
+    #
+    # Example of body:
+    # ```
+    #  {
+    #    "product_description": "4K TV with 3D feature",
+    #    "categories":   ["Electronics", "Televisions"],
+    #    "price_usd": 342,
+    #    "in_stock_from": "2016-11-16T08:00Z",
+    #  }
+    # ```
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +cascadeCreate+ -> Sets whether the item should be created  if not present in the database.
+    #
+    def initialize(values, optional = {})
       @values = values
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @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
       :post
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      result = Hash.new
+      result = {}
       result = result.merge(@values)
       result['!cascadeCreate'] = true if @cascade_create
       result
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      Hash.new
+      {}
     end
   end
 end

data/lib/recombee_api_client/api/set_view_portion.rb

@@ -5,55 +5,60 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Sets viewed portion of an item (for example a video or article) by a user (at a session).
-  #If you send a new request with the same (`userId`, `itemId`, `sessionId`), the portion gets updated.
+  # Sets viewed portion of an item (for example a video or article) by a user (at a session).
+  # If you send a new request with the same (`userId`, `itemId`, `sessionId`), the portion gets updated.
   #
   class SetViewPortion < ApiRequest
-    attr_reader :user_id, :item_id, :portion, :session_id, :timestamp, :cascade_create, :recomm_id, :additional_data
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> User who viewed a portion of the item
-  #   - +item_id+ -> Viewed item
-  #   - +portion+ -> Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the actual viewed part of the item, no matter the seeking. For example, if the user seeked immediately to half of the item and then viewed 10% of the item, the `portion` should still be `0.1`.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +sessionId+ -> ID of the session in which the user viewed the item. Default is `null` (`None`, `nil`, `NULL` etc., depending on the language).
-  #   - +timestamp+ -> UTC timestamp of the view portion 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 view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-  #   - +additionalData+ -> A dictionary of additional data for the interaction.
-  #
+    attr_reader :user_id, :item_id, :portion, :session_id, :timestamp, :cascade_create, :recomm_id, :additional_data,
+                :auto_presented, :time_spent
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> User who viewed a portion of the item
+    #   - +item_id+ -> Viewed item
+    #   - +portion+ -> Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the actual viewed part of the item, no matter the seeking. For example, if the user seeked immediately to half of the item and then viewed 10% of the item, the `portion` should still be `0.1`.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +sessionId+ -> ID of the session in which the user viewed the item. Default is `null` (`None`, `nil`, `NULL` etc., depending on the language).
+    #   - +timestamp+ -> UTC timestamp of the view portion 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 view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+    #   - +additionalData+ -> A dictionary of additional data for the interaction.
+    #   - +autoPresented+ -> Indicates whether the item was automatically presented to the user (e.g., in a swiping feed) or explicitly requested by the user (e.g., by clicking on a link). Defaults to `false`.
+    #   - +timeSpent+ -> The duration (in seconds) that the user viewed the item. In update requests, this value may only increase and is required only if it has changed.
+    #
     def initialize(user_id, item_id, portion, optional = {})
       @user_id = user_id
       @item_id = item_id
       @portion = portion
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @session_id = optional['sessionId']
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @recomm_id = optional['recommId']
       @additional_data = optional['additionalData']
+      @auto_presented = optional['autoPresented']
+      @time_spent = optional['timeSpent']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["sessionId","timestamp","cascadeCreate","recommId","additionalData"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[sessionId timestamp cascadeCreate recommId
+                                                          additionalData autoPresented timeSpent].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['portion'] = @portion
@@ -62,19 +67,21 @@ 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['autoPresented'] = @optional['autoPresented'] if @optional.include? 'autoPresented'
+      p['timeSpent'] = @optional['timeSpent'] if @optional.include? 'timeSpent'
+
       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}/viewportions/"
+      '/{databaseId}/viewportions/'
     end
   end
 end

data/lib/recombee_api_client/api/update_auto_reql_segmentation.rb

@@ -5,62 +5,61 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Update an existing Segmentation.
+  # Update an existing Segmentation.
   #
   class UpdateAutoReqlSegmentation < ApiRequest
     attr_reader :segmentation_id, :expression, :title, :description
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +segmentation_id+ -> ID of the updated Segmentation
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +expression+ -> ReQL expression that returns for each item a set with IDs of segments to which the item belongs
-  #
-  #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
-  #
-  #   - +description+ -> Description that is shown in the Recombee Admin UI.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the updated Segmentation
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +expression+ -> ReQL expression that returns for each item a set with IDs of segments to which the item belongs
+    #
+    #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
+    #
+    #   - +description+ -> Description that is shown in the Recombee Admin UI.
+    #
+    #
     def initialize(segmentation_id, optional = {})
       @segmentation_id = segmentation_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @expression = optional['expression']
       @title = optional['title']
       @description = optional['description']
       @optional = optional
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["expression","title","description"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[expression title description].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['expression'] = @optional['expression'] if @optional.include? 'expression'
       p['title'] = @optional['title'] if @optional.include? 'title'
       p['description'] = @optional['description'] if @optional.include? 'description'
+
       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}/segmentations/auto-reql/#{@segmentation_id}"

data/lib/recombee_api_client/api/update_manual_reql_segment.rb

@@ -5,60 +5,59 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Update definition of the Segment.
+  # Update definition of the Segment.
   #
   class UpdateManualReqlSegment < ApiRequest
     attr_reader :segmentation_id, :segment_id, :filter, :title
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +segmentation_id+ -> ID of the Segmentation to which the updated Segment belongs
-  #   - +segment_id+ -> ID of the Segment that will be updated
-  #   - +filter+ -> ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
-  #
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +title+ -> Human-readable name of the Segment that is shown in the Recombee Admin UI.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the Segmentation to which the updated Segment belongs
+    #   - +segment_id+ -> ID of the Segment that will be updated
+    #   - +filter+ -> ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
+    #
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +title+ -> Human-readable name of the Segment that is shown in the Recombee Admin UI.
+    #
+    #
     def initialize(segmentation_id, segment_id, filter, optional = {})
       @segmentation_id = segmentation_id
       @segment_id = segment_id
       @filter = filter
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @title = optional['title']
       @optional = optional
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["title"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['title'].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['filter'] = @filter
       p['title'] = @optional['title'] if @optional.include? 'title'
+
       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}/segmentations/manual-reql/#{@segmentation_id}/segments/#{@segment_id}"

data/lib/recombee_api_client/api/update_manual_reql_segmentation.rb

@@ -5,58 +5,57 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Update an existing Segmentation.
+  # Update an existing Segmentation.
   #
   class UpdateManualReqlSegmentation < ApiRequest
     attr_reader :segmentation_id, :title, :description
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +segmentation_id+ -> ID of the updated Segmentation
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
-  #
-  #   - +description+ -> Description that is shown in the Recombee Admin UI.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the updated Segmentation
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
+    #
+    #   - +description+ -> Description that is shown in the Recombee Admin UI.
+    #
+    #
     def initialize(segmentation_id, optional = {})
       @segmentation_id = segmentation_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @title = optional['title']
       @description = optional['description']
       @optional = optional
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["title","description"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[title description].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['title'] = @optional['title'] if @optional.include? 'title'
       p['description'] = @optional['description'] if @optional.include? 'description'
+
       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}/segmentations/manual-reql/#{@segmentation_id}"