recombee_api_client 5.1.0 → 6.0.0

data/lib/recombee_api_client/api/delete_series.rb

@@ -5,55 +5,54 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes the series of the given `seriesId` from the database.
+  # Deletes the series of the given `seriesId` from the database.
   #
-  #Deleting a series will only delete assignment of items to it, not the items themselves!
+  # Deleting a series will only delete assignment of items to it, not the items themselves!
   #
   class DeleteSeries < ApiRequest
     attr_reader :series_id, :cascade_delete
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +series_id+ -> ID of the series to be deleted.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +cascadeDelete+ -> If set to `true`, item with the same ID as seriesId will be also deleted. Default is `false`.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +series_id+ -> ID of the series to be deleted.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +cascadeDelete+ -> If set to `true`, item with the same ID as seriesId will be also deleted. Default is `false`.
+    #
     def initialize(series_id, optional = {})
       @series_id = series_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @cascade_delete = optional['cascadeDelete']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["cascadeDelete"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['cascadeDelete'].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :delete
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['cascadeDelete'] = @optional['cascadeDelete'] if @optional.include? 'cascadeDelete'
+
       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/delete_user.rb

@@ -5,45 +5,42 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes a user of the given *userId* from the database.
+  # Deletes a user of the given *userId* from the database.
   #
-  #If there are any purchases, ratings, bookmarks, cart additions or detail views made by the user present in the database, they will be deleted in cascade as well.
+  # If there are any purchases, ratings, bookmarks, cart additions or detail views made by the user present in the database, they will be deleted in cascade as well.
   #
   class DeleteUser < ApiRequest
     attr_reader :user_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user to be deleted.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user to be deleted.
+    #
     def initialize(user_id)
       @user_id = user_id
       @timeout = 3000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :delete
     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/delete_user_property.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deleting a user property is roughly equivalent to removing a column from the table of users.
+  # Deleting a user property is roughly equivalent to removing a column from the table of users.
   #
   class DeleteUserProperty < ApiRequest
     attr_reader :property_name
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +property_name+ -> Name of the property to be deleted.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +property_name+ -> Name of the property to be deleted.
+    #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 100000
+      @timeout = 100_000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :delete
     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/properties/#{@property_name}"

data/lib/recombee_api_client/api/delete_view_portion.rb

@@ -5,47 +5,45 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes an existing view portion specified by (`userId`, `itemId`, `sessionId`) from the database.
+  # Deletes an existing view portion specified by (`userId`, `itemId`, `sessionId`) from the database.
   #
   class DeleteViewPortion < ApiRequest
     attr_reader :user_id, :item_id, :session_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user who rated the item.
-  #   - +item_id+ -> ID of the item which was rated.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +sessionId+ -> Identifier of a session.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user who rated the item.
+    #   - +item_id+ -> ID of the item which was rated.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +sessionId+ -> Identifier of a session.
+    #
     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)
       @session_id = optional['sessionId']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["sessionId"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['sessionId'].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :delete
     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
@@ -53,12 +51,13 @@ module RecombeeApiClient
       params['userId'] = @user_id
       params['itemId'] = @item_id
       params['sessionId'] = @optional['sessionId'] if @optional['sessionId']
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/viewportions/"
+      '/{databaseId}/viewportions/'
     end
   end
 end

data/lib/recombee_api_client/api/get_item_property_info.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Gets information about specified item property.
+  # Gets information about specified item property.
   #
   class GetItemPropertyInfo < ApiRequest
     attr_reader :property_name
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +property_name+ -> Name of the property about which the information is to be retrieved.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +property_name+ -> Name of the property about which the information is to be retrieved.
+    #
     def initialize(property_name)
       @property_name = property_name
       @timeout = 3000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :get
     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}/items/properties/#{@property_name}"

data/lib/recombee_api_client/api/get_item_values.rb

@@ -5,44 +5,41 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Gets all the current property values of the given item.
+  # Gets all the current property values of the given item.
   #
   class GetItemValues < ApiRequest
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item whose properties are to be obtained.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item whose properties are to be obtained.
+    #
+    #
     def initialize(item_id)
       @item_id = item_id
       @timeout = 3000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :get
     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}/items/#{@item_id}"

data/lib/recombee_api_client/api/get_segmentation.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Get existing Segmentation.
+  # Get existing Segmentation.
   #
   class GetSegmentation < ApiRequest
     attr_reader :segmentation_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +segmentation_id+ -> ID of the Segmentation that should be returned
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the Segmentation that should be returned
+    #
     def initialize(segmentation_id)
       @segmentation_id = segmentation_id
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :get
     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}/segmentations/list/#{@segmentation_id}"

data/lib/recombee_api_client/api/get_user_property_info.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Gets information about specified user property.
+  # Gets information about specified user property.
   #
   class GetUserPropertyInfo < ApiRequest
     attr_reader :property_name
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +property_name+ -> Name of the property about which the information is to be retrieved.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +property_name+ -> Name of the property about which the information is to be retrieved.
+    #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 100000
+      @timeout = 100_000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :get
     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/properties/#{@property_name}"

data/lib/recombee_api_client/api/get_user_values.rb

@@ -5,44 +5,41 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Gets all the current property values of the given user.
+  # Gets all the current property values of the given user.
   #
   class GetUserValues < ApiRequest
     attr_reader :user_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user whose properties are to be obtained.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user whose properties are to be obtained.
+    #
+    #
     def initialize(user_id)
       @user_id = user_id
       @timeout = 3000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :get
     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/insert_to_series.rb

@@ -5,62 +5,61 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Inserts an existing item/series into a series of the given seriesId at a position determined by time.
+  # Inserts an existing item/series into a series of the given seriesId at a position determined by time.
   #
   class InsertToSeries < ApiRequest
     attr_reader :series_id, :item_type, :item_id, :time, :cascade_create
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +series_id+ -> ID of the series to be inserted into.
-  #   - +item_type+ -> `item` iff the regular item from the catalog is to be inserted, `series` iff series is inserted as the item.
-  #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.
-  #   - +time+ -> Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. In case of `item`, an item is created, in case of `series` a series + corresponding item with the same ID is created.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +series_id+ -> ID of the series to be inserted into.
+    #   - +item_type+ -> `item` iff the regular item from the catalog is to be inserted, `series` iff series is inserted as the item.
+    #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.
+    #   - +time+ -> Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. In case of `item`, an item is created, in case of `series` a series + corresponding item with the same ID is created.
+    #
     def initialize(series_id, item_type, item_id, time, optional = {})
       @series_id = series_id
       @item_type = item_type
       @item_id = item_id
       @time = time
-      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
       :post
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['itemType'] = @item_type
       p['itemId'] = @item_id
       p['time'] = @time
       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}/items/"