recombee_api_client 5.1.0 → 6.0.0

data/lib/recombee_api_client/api/list_item_bookmarks.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Lists all the ever-made bookmarks of the given item.
+  # Lists all the ever-made bookmarks of the given item.#
   class ListItemBookmarks < ApiRequest
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item whose bookmarks are to be listed.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item whose bookmarks are to be listed.
+    #
+    #
     def initialize(item_id)
       @item_id = item_id
-      @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}/items/#{@item_id}/bookmarks/"

data/lib/recombee_api_client/api/list_item_cart_additions.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Lists all the ever-made cart additions of the given item.
+  # Lists all the ever-made cart additions of the given item.#
   class ListItemCartAdditions < ApiRequest
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item whose cart additions are to be listed.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item whose cart additions are to be listed.
+    #
+    #
     def initialize(item_id)
       @item_id = item_id
-      @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}/items/#{@item_id}/cartadditions/"

data/lib/recombee_api_client/api/list_item_detail_views.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Lists all the detail views of the given item ever made by different users.
+  # Lists all the detail views of the given item ever made by different users.#
   class ListItemDetailViews < ApiRequest
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item whose detail views are to be listed.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item whose detail views are to be listed.
+    #
+    #
     def initialize(item_id)
       @item_id = item_id
-      @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}/items/#{@item_id}/detailviews/"

data/lib/recombee_api_client/api/list_item_properties.rb

@@ -5,43 +5,39 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Gets the list of all the item properties in your database.
+  # Gets the list of all the item properties in your database.
   #
   class ListItemProperties < ApiRequest
-  
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  #
-    def initialize()
-      @timeout = 100000
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    #
+    def initialize
+      @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}/items/properties/list/"
+      '/{databaseId}/items/properties/list/'
     end
   end
 end

data/lib/recombee_api_client/api/list_item_purchases.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Lists all the ever-made purchases of the given item.
+  # Lists all the ever-made purchases of the given item.#
   class ListItemPurchases < ApiRequest
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item whose purchases are to be listed.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item whose purchases are to be listed.
+    #
+    #
     def initialize(item_id)
       @item_id = item_id
-      @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}/items/#{@item_id}/purchases/"

data/lib/recombee_api_client/api/list_item_ratings.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Lists all the ratings of an item ever submitted by different users.
+  # Lists all the ratings of an item ever submitted by different users.#
   class ListItemRatings < ApiRequest
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item whose ratings are to be listed.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item whose ratings are to be listed.
+    #
+    #
     def initialize(item_id)
       @item_id = item_id
-      @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}/items/#{@item_id}/ratings/"

data/lib/recombee_api_client/api/list_item_view_portions.rb

@@ -5,44 +5,41 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Lists all the view portions of an item ever submitted by different users.
+  # Lists all the view portions of an item ever submitted by different users.
   #
   class ListItemViewPortions < ApiRequest
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item whose view portions are to be listed.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item whose view portions are to be listed.
+    #
+    #
     def initialize(item_id)
       @item_id = item_id
-      @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}/items/#{@item_id}/viewportions/"

data/lib/recombee_api_client/api/list_items.rb

@@ -5,87 +5,86 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Gets a list of IDs of items currently present in the catalog.
+  # Gets a list of IDs of items currently present in the catalog.#
   class ListItems < ApiRequest
     attr_reader :filter, :count, :offset, :return_properties, :included_properties
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter items to be listed. Only the items for which the expression is *true* will be returned.
-  #   - +count+ -> The number of items to be listed.
-  #   - +offset+ -> Specifies the number of items to skip (ordered by `itemId`).
-  #   - +returnProperties+ -> With `returnProperties=true`, property values of the listed items are returned along with their IDs in a JSON dictionary. 
-  #
-  #Example response:
-  #```json
-  #  [
-  #    {
-  #      "itemId": "tv-178",
-  #      "description": "4K TV with 3D feature",
-  #      "categories":   ["Electronics", "Televisions"],
-  #      "price": 342,
-  #      "url": "myshop.com/tv-178"
-  #    },
-  #    {
-  #      "itemId": "mixer-42",
-  #      "description": "Stainless Steel Mixer",
-  #      "categories":   ["Home & Kitchen"],
-  #      "price": 39,
-  #      "url": "myshop.com/mixer-42"
-  #    }
-  #  ]
-  #```
-  #
-  #   - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
-  #
-  #Example response for `includedProperties=description,price`:
-  #```json
-  #  [
-  #    {
-  #      "itemId": "tv-178",
-  #      "description": "4K TV with 3D feature",
-  #      "price": 342
-  #    },
-  #    {
-  #      "itemId": "mixer-42",
-  #      "description": "Stainless Steel Mixer",
-  #      "price": 39
-  #    }
-  #  ]
-  #```
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter items to be listed. Only the items for which the expression is *true* will be returned.
+    #   - +count+ -> The number of items to be listed.
+    #   - +offset+ -> Specifies the number of items to skip (ordered by `itemId`).
+    #   - +returnProperties+ -> With `returnProperties=true`, property values of the listed items are returned along with their IDs in a JSON dictionary.
+    #
+    # Example response:
+    # ```json
+    #  [
+    #    {
+    #      "itemId": "tv-178",
+    #      "description": "4K TV with 3D feature",
+    #      "categories":   ["Electronics", "Televisions"],
+    #      "price": 342,
+    #      "url": "myshop.com/tv-178"
+    #    },
+    #    {
+    #      "itemId": "mixer-42",
+    #      "description": "Stainless Steel Mixer",
+    #      "categories":   ["Home & Kitchen"],
+    #      "price": 39,
+    #      "url": "myshop.com/mixer-42"
+    #    }
+    #  ]
+    # ```
+    #
+    #   - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
+    #
+    # Example response for `includedProperties=description,price`:
+    # ```json
+    #  [
+    #    {
+    #      "itemId": "tv-178",
+    #      "description": "4K TV with 3D feature",
+    #      "price": 342
+    #    },
+    #    {
+    #      "itemId": "mixer-42",
+    #      "description": "Stainless Steel Mixer",
+    #      "price": 39
+    #    }
+    #  ]
+    # ```
+    #
+    #
     def initialize(optional = {})
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @filter = optional['filter']
       @count = optional['count']
       @offset = optional['offset']
       @return_properties = optional['returnProperties']
       @included_properties = optional['includedProperties']
       @optional = optional
-      @timeout = 100000
+      @timeout = 100_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["filter","count","offset","returnProperties","includedProperties"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[filter count offset returnProperties
+                                                          includedProperties].include? par
       end
     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
@@ -95,12 +94,13 @@ module RecombeeApiClient
       params['offset'] = @optional['offset'] if @optional['offset']
       params['returnProperties'] = @optional['returnProperties'] if @optional['returnProperties']
       params['includedProperties'] = @optional['includedProperties'] if @optional['includedProperties']
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/items/list/"
+      '/{databaseId}/items/list/'
     end
   end
 end

data/lib/recombee_api_client/api/list_scenarios.rb

@@ -5,43 +5,39 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Get all [Scenarios](https://docs.recombee.com/scenarios) of the given database.
+  # Get all [Scenarios](https://docs.recombee.com/scenarios) of the given database.
   #
   class ListScenarios < ApiRequest
-  
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  #
-    def initialize()
-      @timeout = 10000
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    #
+    def initialize
+      @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}/scenarios/"
+      '/{databaseId}/scenarios/'
     end
   end
 end