recombee_api_client 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92cb1287e8bab392d6c943302d9e1654fd865f7a
-  data.tar.gz: 878a578c3f0aea10860700755e2f2c1967ffca76
+  metadata.gz: 72b624fc1cdb24d3afbff79cece22899d3ec16ca
+  data.tar.gz: b5ba19f5808607a614909bc3836144df57f74247
 SHA512:
-  metadata.gz: f596060df4f929c7a9e70e0ef7d31558c4b1e64dbf90b326db71997617b639b1e7c2e71d04bffdc3982c6dd73266648d8fd65f9acf6ba733c90f1749c4f8bfee
-  data.tar.gz: 11d44916af1ee6c773e5d79faafff8b4b848750906b4dbe28f68292c1adb72169f3342390acdc1103fb2285d76559796f83acc419b7bc77286bbcfad4b073992
+  metadata.gz: 047f3f735420c34e159d4701149dcdb9df6b0b51d04761ec1c99c06b01a94383aa01576db73a9b37aa0f2618de9cae9051c9bcb7f17305adcc726cfa18895a90
+  data.tar.gz: c7bd8111794cc4f8c1fc21f58f74021a625fdad3998654b68b9bd8eea09b89497f2fd46c7c735b4b23efe17b60ef1c7f9f45a21ef9baef70ef76053fb95e92a4

data/lib/recombee_api_client.rb

@@ -18,7 +18,7 @@ module RecombeeApiClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/2.0.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/2.0.1'}
 
     ##
     #   - +account+ -> Name of your account at Recombee

data/lib/recombee_api_client/api/add_bookmark.rb

@@ -26,6 +26,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @optional = optional

data/lib/recombee_api_client/api/add_cart_addition.rb

@@ -28,6 +28,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @amount = optional['amount']

data/lib/recombee_api_client/api/add_detail_view.rb

@@ -27,6 +27,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @duration = optional['duration']
       @cascade_create = optional['cascadeCreate']

data/lib/recombee_api_client/api/add_purchase.rb

@@ -29,6 +29,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @amount = optional['amount']

data/lib/recombee_api_client/api/add_rating.rb

@@ -28,6 +28,7 @@ module RecombeeApiClient
       @user_id = user_id
       @item_id = item_id
       @rating = rating
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @optional = optional

data/lib/recombee_api_client/api/batch.rb

@@ -16,6 +16,7 @@ module RecombeeApiClient
     #
     def initialize(requests, optional = {})
       @requests = requests
+      optional = normalize_optional(optional)
       @optional = optional
       @body_parameters = requests_to_batch_hash
       @timeout = requests.map{|r| r.timeout}.reduce(:+)

data/lib/recombee_api_client/api/delete_bookmark.rb

@@ -25,6 +25,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
       @timeout = 1000

data/lib/recombee_api_client/api/delete_cart_addition.rb

@@ -25,6 +25,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
       @timeout = 1000

data/lib/recombee_api_client/api/delete_detail_view.rb

@@ -25,6 +25,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
       @timeout = 1000

data/lib/recombee_api_client/api/delete_purchase.rb

@@ -25,6 +25,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
       @timeout = 1000

data/lib/recombee_api_client/api/delete_rating.rb

@@ -25,6 +25,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
       @timeout = 1000

data/lib/recombee_api_client/api/delete_view_portion.rb

@@ -27,6 +27,7 @@ module RecombeeApiClient
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
+      optional = normalize_optional(optional)
       @session_id = optional['sessionId']
       @optional = optional
       @timeout = 1000

data/lib/recombee_api_client/api/hash_normalizer.rb

@@ -0,0 +1,21 @@
+module RecombeeApiClient
+  ##
+  # Module to convert Ruby conventions to Recombee's API namings
+  #
+  module HashNormalizer
+    def normalize_optional opts
+      opts_new = {}
+      opts.each do |k,v|
+        case k
+        when String then opts_new[camelize(k)] = opts.delete(k)
+        when Symbol then opts_new[camelize(k.to_s)] = opts.delete(k)
+        end
+      end
+      opts_new
+    end
+
+    def camelize str
+      str.gsub(/_(.)/) {|e| $1.upcase}
+    end
+  end
+end

data/lib/recombee_api_client/api/insert_to_group.rb

@@ -27,6 +27,7 @@ module RecombeeApiClient
       @group_id = group_id
       @item_type = item_type
       @item_id = item_id
+      optional = normalize_optional(optional)
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000

data/lib/recombee_api_client/api/insert_to_series.rb

@@ -29,6 +29,7 @@ module RecombeeApiClient
       @item_type = item_type
       @item_id = item_id
       @time = time
+      optional = normalize_optional(optional)
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000

data/lib/recombee_api_client/api/item_based_recommendation.rb

@@ -85,9 +85,9 @@ module RecombeeApiClient
   #
   #   - +minRelevance+ -> **Expert option** If the *targetUserId* is provided:  Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested qualit, and may return less than *count* items when there is not enough data to fulfill it.
   #
-  #   - +rotationRate+ -> **Expert option** If the *targetUserId* is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items.
+  #   - +rotationRate+ -> **Expert option** If the *targetUserId* is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0.01`.
   #
-  #   - +rotationTime+ -> **Expert option** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
+  #   - +rotationTime+ -> **Expert option** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
   #
   #   - +expertSettings+ -> Dictionary of custom options.
   #
@@ -95,6 +95,7 @@ module RecombeeApiClient
     def initialize(item_id, count, optional = {})
       @item_id = item_id
       @count = count
+      optional = normalize_optional(optional)
       @target_user_id = optional['targetUserId']
       @user_impact = optional['userImpact']
       @filter = optional['filter']

data/lib/recombee_api_client/api/list_items.rb

@@ -61,6 +61,7 @@ module RecombeeApiClient
   #
   #
     def initialize(optional = {})
+      optional = normalize_optional(optional)
       @filter = optional['filter']
       @count = optional['count']
       @offset = optional['offset']

data/lib/recombee_api_client/api/list_users.rb

@@ -55,6 +55,7 @@ module RecombeeApiClient
   #
   #
     def initialize(optional = {})
+      optional = normalize_optional(optional)
       @filter = optional['filter']
       @count = optional['count']
       @offset = optional['offset']

data/lib/recombee_api_client/api/merge_users.rb

@@ -19,8 +19,8 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +target_user_id+ -> ID of the source user.
-  #   - +source_user_id+ -> ID of the target user.
+  #   - +target_user_id+ -> ID of the targer user.
+  #   - +source_user_id+ -> ID of the source user.
   #
   # * *Optional arguments (given as hash optional)*
   #   - +cascadeCreate+ -> Sets whether the user *targetUserId* should be created if not present in the database.
@@ -28,6 +28,7 @@ module RecombeeApiClient
     def initialize(target_user_id, source_user_id, optional = {})
       @target_user_id = target_user_id
       @source_user_id = source_user_id
+      optional = normalize_optional(optional)
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 10000

data/lib/recombee_api_client/api/recommend_items_to_item.rb

@@ -117,6 +117,7 @@ module RecombeeApiClient
       @item_id = item_id
       @target_user_id = target_user_id
       @count = count
+      optional = normalize_optional(optional)
       @user_impact = optional['userImpact']
       @filter = optional['filter']
       @booster = optional['booster']

data/lib/recombee_api_client/api/recommend_items_to_user.rb

@@ -86,9 +86,9 @@ module RecombeeApiClient
   #
   #   - +minRelevance+ -> **Expert option** Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested relevancy, and may return less than *count* items when there is not enough data to fulfill it.
   #
-  #   - +rotationRate+ -> **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items.
+  #   - +rotationRate+ -> **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0.1`.
   #
-  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
+  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
   #
   #   - +expertSettings+ -> Dictionary of custom options.
   #
@@ -96,6 +96,7 @@ module RecombeeApiClient
     def initialize(user_id, count, optional = {})
       @user_id = user_id
       @count = count
+      optional = normalize_optional(optional)
       @filter = optional['filter']
       @booster = optional['booster']
       @cascade_create = optional['cascadeCreate']

data/lib/recombee_api_client/api/recommend_users_to_item.rb

@@ -84,6 +84,7 @@ module RecombeeApiClient
     def initialize(item_id, count, optional = {})
       @item_id = item_id
       @count = count
+      optional = normalize_optional(optional)
       @filter = optional['filter']
       @booster = optional['booster']
       @cascade_create = optional['cascadeCreate']

data/lib/recombee_api_client/api/recommend_users_to_user.rb

@@ -90,6 +90,7 @@ module RecombeeApiClient
     def initialize(user_id, count, optional = {})
       @user_id = user_id
       @count = count
+      optional = normalize_optional(optional)
       @filter = optional['filter']
       @booster = optional['booster']
       @cascade_create = optional['cascadeCreate']

data/lib/recombee_api_client/api/request.rb

@@ -3,5 +3,7 @@ module RecombeeApiClient
   # Parent class for API requests
   #
   class ApiRequest
+    require_relative 'hash_normalizer'
+    include RecombeeApiClient::HashNormalizer
   end
 end

data/lib/recombee_api_client/api/set_values.rb

@@ -27,6 +27,7 @@ module RecombeeApiClient
   #
     def initialize( values, optional = {})
       @values = values
+      optional = normalize_optional(optional)
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @optional.each do |par, _|

data/lib/recombee_api_client/api/set_view_portion.rb

@@ -21,10 +21,10 @@ module RecombeeApiClient
   # * *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) ).
+  #   - +portion+ -> Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the really viewed part of the item, no matter seeking, so 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 session in which the user viewed the item
+  #   - +sessionId+ -> ID of session in which the user viewed the item. Default is `none`.
   #   - +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.
   #
@@ -32,6 +32,7 @@ module RecombeeApiClient
       @user_id = user_id
       @item_id = item_id
       @portion = portion
+      optional = normalize_optional(optional)
       @session_id = optional['sessionId']
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']

data/lib/recombee_api_client/api/user_based_recommendation.rb

@@ -73,9 +73,9 @@ module RecombeeApiClient
   #
   #   - +minRelevance+ -> **Expert option** Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested qualit, and may return less than *count* items when there is not enough data to fulfill it.
   #
-  #   - +rotationRate+ -> **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items.
+  #   - +rotationRate+ -> **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0.1`.
   #
-  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
+  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
   #
   #   - +expertSettings+ -> Dictionary of custom options.
   #
@@ -83,6 +83,7 @@ module RecombeeApiClient
     def initialize(user_id, count, optional = {})
       @user_id = user_id
       @count = count
+      optional = normalize_optional(optional)
       @filter = optional['filter']
       @booster = optional['booster']
       @allow_nonexistent = optional['allowNonexistent']

data/lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Ondřej Fiedler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -120,6 +120,7 @@ files:
 - lib/recombee_api_client/api/get_item_values.rb
 - lib/recombee_api_client/api/get_user_property_info.rb
 - lib/recombee_api_client/api/get_user_values.rb
+- lib/recombee_api_client/api/hash_normalizer.rb
 - lib/recombee_api_client/api/insert_to_group.rb
 - lib/recombee_api_client/api/insert_to_series.rb
 - lib/recombee_api_client/api/item_based_recommendation.rb