recombee_api_client 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72b624fc1cdb24d3afbff79cece22899d3ec16ca
-  data.tar.gz: b5ba19f5808607a614909bc3836144df57f74247
+  metadata.gz: 67a55a5aad6cdef70d224b317e7487b91df21ebd
+  data.tar.gz: 1178066744ec92b39a3660e854ce709b4d431be6
 SHA512:
-  metadata.gz: 047f3f735420c34e159d4701149dcdb9df6b0b51d04761ec1c99c06b01a94383aa01576db73a9b37aa0f2618de9cae9051c9bcb7f17305adcc726cfa18895a90
-  data.tar.gz: c7bd8111794cc4f8c1fc21f58f74021a625fdad3998654b68b9bd8eea09b89497f2fd46c7c735b4b23efe17b60ef1c7f9f45a21ef9baef70ef76053fb95e92a4
+  metadata.gz: 5a06bfcbbb78f7b94231f542673be408222d25bd8eb1f22de6ccfedb9d1ce43cd7912621268d8799700221fe3bb3868db41f67157cfa0d79437a37800c46cc08
+  data.tar.gz: d4ccb9bd5fd18ad5279b09380fc447220e517b60783eace5e78c42df031c7b5a926820c1e9304fd4d2751f345b75b790393a0ecc5eb0f1b14a8095e5dc096656

data/README.md

@@ -75,16 +75,19 @@ client = RecombeeClient('--my-database-id--', '--my-secret-token--')
 client.send(ResetDatabase.new) # Clear everything from the database
 
 # We will use computers as items in this example
-# Computers have three properties 
+# Computers have five properties 
 #   - price (floating point number)
 #   - number of processor cores (integer number)
 #   - description (string)
+#   - date from which it is in stock (timestamp)
+#   - image (url of computer's photo)
 
 # Add properties of items
 client.send(AddItemProperty.new('price', 'double'))
 client.send(AddItemProperty.new('num-cores', 'int'))
 client.send(AddItemProperty.new('description', 'string'))
-client.send(AddItemProperty.new('time', 'timestamp'))
+client.send(AddItemProperty.new('in_stock_from', 'timestamp'))
+client.send(AddItemProperty.new('image', 'image'))
 
 # Prepare requests for setting a catalog of computers
 requests = (1..NUM).map do |i|
@@ -95,7 +98,8 @@ requests = (1..NUM).map do |i|
         'price' => rand(15000.0 .. 25000.0),
         'num-cores' => rand(1..8),
         'description' => 'Great computer',
-        'time' => DateTime.now
+        'in_stock_from' => DateTime.now,
+        'image' => "http://examplesite.com/products/computer-#{i}.jpg"
       },
       #optional parameters:
       {

data/lib/recombee_api_client/api/add_item_property.rb

@@ -18,7 +18,7 @@ module RecombeeApiClient
   # * *Required arguments*
   #   - +property_name+ -> Name of the item property to be created. Currently, the following names are reserved:`id`, `itemid`, case insensitively. Also, the length of the property name must not exceed 63 characters.
   #
-  #   - +type+ -> Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`
+  #   - +type+ -> Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
   #
   #
     def initialize(property_name, type)

data/lib/recombee_api_client/api/delete_view_portion.rb

@@ -7,8 +7,6 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #The view portions feature is currently experimental.
-  #
   #Deletes an existing view portion specified by (`userId`, `itemId`, `sessionId`) from the database.
   #
   class DeleteViewPortion < ApiRequest

data/lib/recombee_api_client/api/list_item_view_portions.rb

@@ -7,8 +7,6 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #The view portions feature is currently experimental.
-  #
   #List all the view portions of an item ever submitted by different users.
   #
   class ListItemViewPortions < ApiRequest

data/lib/recombee_api_client/api/list_user_view_portions.rb

@@ -7,8 +7,6 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #The view portions feature is currently experimental.
-  #
   #List all the view portions ever submitted by a given user.
   #
   class ListUserViewPortions < ApiRequest

data/lib/recombee_api_client/api/set_view_portion.rb

@@ -7,8 +7,6 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #The view portions feature is currently experimental.
-  #
   #Sets viewed portion of an item (for example a video or article) by a user (at a session).
   #If you send new request with the same (`userId`, `itemId`, `sessionId`), the portion gets updated.
   #
@@ -24,7 +22,7 @@ module RecombeeApiClient
   #   - +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. Default is `none`.
+  #   - +sessionId+ -> ID of session in which the user viewed the item. Default is `null` (`None`, `nil`, `NULL` etc. depending on language).
   #   - +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.
   #

data/lib/recombee_api_client/version.rb

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

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.1'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/2.1.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Ondřej Fiedler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json