Make the timestamp parameter optional for interaction additions - default is the current time

Author: OndraFiedler

lib/recombee_api_client/api/add_bookmark.rb

@@ -17,20 +17,20 @@ class AddBookmark < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> User who bookmarked the item
   #   - +item_id+ -> Bookmarked item
-  #   - +timestamp+ -> Unix timestamp of the bookmark. If you don't have the timestamp value available, you may use some artificial value, such as 0. It is preferable, however, to provide the timestamp whenever possible as the user's preferences may evolve over time.
   #
   # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> UTC timestamp of the bookmark 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.
   #
-    def initialize(user_id, item_id, timestamp, optional = {})
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
       end
     end
 
@@ -44,7 +44,7 @@ def body_parameters
       p = Hash.new
       p['userId'] = @user_id
       p['itemId'] = @item_id
-      p['timestamp'] = @timestamp
+      p['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
       p
     end

lib/recombee_api_client/api/add_cart_addition.rb

@@ -17,20 +17,20 @@ class AddCartAddition < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> User who added the item to the cart
   #   - +item_id+ -> Item added to the cart
-  #   - +timestamp+ -> Unix timestamp of the cart addition. If you don't have the timestamp value available, you may use some artificial value, such as 0. It is preferable, however, to provide the timestamp whenever possible as the user's preferences may evolve over time.
   #
   # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> UTC timestamp of the cart addition 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.
   #
-    def initialize(user_id, item_id, timestamp, optional = {})
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
       end
     end
 
@@ -44,7 +44,7 @@ def body_parameters
       p = Hash.new
       p['userId'] = @user_id
       p['itemId'] = @item_id
-      p['timestamp'] = @timestamp
+      p['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
       p
     end

lib/recombee_api_client/api/add_detail_view.rb

@@ -17,22 +17,22 @@ class AddDetailView < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> User who viewed the item
   #   - +item_id+ -> Viewed item
-  #   - +timestamp+ -> Unix timestamp of the view. If you don't have the timestamp value available, you may use some artificial value, such as 0. It is preferable, however, to provide the timestamp whenever possible as the user's preferences may evolve over time.
   #
   # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
   #   - +duration+ -> Duration of the view
   #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
   #
-    def initialize(user_id, item_id, timestamp, optional = {})
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
       @duration = optional['duration']
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["duration","cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","duration","cascadeCreate"].include? par
       end
     end
 
@@ -46,7 +46,7 @@ def body_parameters
       p = Hash.new
       p['userId'] = @user_id
       p['itemId'] = @item_id
-      p['timestamp'] = @timestamp
+      p['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       p['duration'] = @optional['duration'] if @optional['duration']
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
       p

lib/recombee_api_client/api/add_purchase.rb

@@ -17,20 +17,20 @@ class AddPurchase < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> User who purchased the item
   #   - +item_id+ -> Purchased item
-  #   - +timestamp+ -> Unix timestamp of the purchase. If you don't have the timestamp value available, you may use some artificial value, such as 0. It is preferable, however, to provide the timestamp whenever possible as the user's preferences may evolve over time.
   #
   # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> UTC timestamp of the purchase 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.
   #
-    def initialize(user_id, item_id, timestamp, optional = {})
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
       end
     end
 
@@ -44,7 +44,7 @@ def body_parameters
       p = Hash.new
       p['userId'] = @user_id
       p['itemId'] = @item_id
-      p['timestamp'] = @timestamp
+      p['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
       p
     end

lib/recombee_api_client/api/add_rating.rb

@@ -17,22 +17,22 @@ class AddRating < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> User who submitted the rating
   #   - +item_id+ -> Rated item
-  #   - +timestamp+ -> Unix timestamp of the rating. If you don't have the timestamp value available, you may use some artificial value, such as 0. It is preferable, however, to provide the timestamp whenever possible as the user's preferences may evolve over time.
   #   - +rating+ -> Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating. For example, in the case of 5-star evaluations, rating = (numStars-3)/2 formula may be used for the conversion.
   #
   # * *Optional arguments (given as hash optional)*
+  #   - +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.
   #
-    def initialize(user_id, item_id, timestamp, rating, optional = {})
+    def initialize(user_id, item_id, rating, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
       @rating = rating
+      @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
       end
     end
 
@@ -46,8 +46,8 @@ def body_parameters
       p = Hash.new
       p['userId'] = @user_id
       p['itemId'] = @item_id
-      p['timestamp'] = @timestamp
       p['rating'] = @rating
+      p['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
       p
     end

lib/recombee_api_client/api/batch.rb

@@ -54,9 +54,11 @@ def request_to_batch_hash(req)
         'path' => path
       }
       params = req.query_parameters
+
       if req.body_parameters
         params = params.merge(req.body_parameters)
       end
+      
       bh['params'] = params if params.size > 0
       bh
     end

lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '0.1.0'
+  VERSION = '1.1.0'
 end

spec/api/add_interaction.rb

@@ -5,41 +5,46 @@
   include_context 'set environment'
 
   it 'does not fail with cascadeCreate' do
-    req = described_class.new('u_id', 'i_id', 0, 'cascadeCreate' => true)
+    req = described_class.new('u_id', 'i_id', 'cascadeCreate' => true)
     expect { @client.send(req) }.not_to raise_exception
   end
 
   it 'does not fail with existing item and user' do
-    req = described_class.new('entity_id', 'entity_id', 0)
+    req = described_class.new('entity_id', 'entity_id')
+    expect { @client.send(req) }.not_to raise_exception
+  end
+
+  it 'does not fail with valid timestamp' do
+    req = described_class.new('entity_id', 'entity_id', 'timestamp' => '2013-10-29T09:38:41.341Z')
     expect { @client.send(req) }.not_to raise_exception
   end
 
   it 'fails with nonexisting item id' do
-    req = described_class.new('entity_id', 'i_id', 0)
+    req = described_class.new('entity_id', 'i_id')
     expect { @client.send(req) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)
       expect(exception.status_code).to eq 404
     }
   end
 
   it 'fails with nonexisting user id' do
-    req = described_class.new('u_id', 'entity_id', 0)
+    req = described_class.new('u_id', 'entity_id')
     expect { @client.send(req) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)
       expect(exception.status_code).to eq 404
     }
   end
 
   it 'fails with invalid time' do
-    req = described_class.new('entity_id', 'entity_id', -15)
+    req = described_class.new('entity_id', 'entity_id', 'timestamp' => -15)
     expect { @client.send(req) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)
       expect(exception.status_code).to eq 400
     }
   end
 
   it 'really stores interaction to the system' do
-    req = described_class.new('u_id', 'i_id', 0, 'cascadeCreate' => true)
+    req = described_class.new('u_id', 'i_id', {'cascadeCreate' => true, 'timestamp' => 5})
     expect { @client.send(req) }.not_to raise_exception
     expect { @client.send(req) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)

spec/api/add_rating_spec.rb

@@ -5,49 +5,49 @@
   include_context 'set environment'
 
   it 'does not fail with cascadeCreate' do
-    dv = described_class.new('u_id', 'i_id', 0, 1, 'cascadeCreate' => true)
+    dv = described_class.new('u_id', 'i_id', 1, 'cascadeCreate' => true)
     expect { @client.send(dv) }.not_to raise_exception
   end
 
   it 'does not fail with existing item and user' do
-    dv = described_class.new('entity_id', 'entity_id', 0, 0)
+    dv = described_class.new('entity_id', 'entity_id', 0)
     expect { @client.send(dv) }.not_to raise_exception
   end
 
   it 'fails with nonexisting item id' do
-    dv = described_class.new('entity_id', 'i_id', 0, -1)
+    dv = described_class.new('entity_id', 'i_id', -1)
     expect { @client.send(dv) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)
       expect(exception.status_code).to eq 404
     }
   end
 
   it 'fails with nonexisting user id' do
-    dv = described_class.new('u_id', 'entity_id', 0, 0.5)
+    dv = described_class.new('u_id', 'entity_id', 0.5)
     expect { @client.send(dv) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)
       expect(exception.status_code).to eq 404
     }
   end
 
   it 'fails with invalid time' do
-    dv = described_class.new('entity_id', 'entity_id', -15, 0)
+    dv = described_class.new('entity_id', 'entity_id', 0, 'timestamp' => -15)
     expect { @client.send(dv) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)
       expect(exception.status_code).to eq 400
     }
   end
 
   it 'fails with invalid rating' do
-    dv = described_class.new('entity_id', 'entity_id', 15, -2)
+    dv = described_class.new('entity_id', 'entity_id', -2)
     expect { @client.send(dv) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)
       expect(exception.status_code).to eq 400
     }
   end
 
   it 'really stores interaction to the system' do
-    dv = described_class.new('u_id', 'i_id', 0, 0.3, 'cascadeCreate' => true)
+    dv = described_class.new('u_id', 'i_id', 0.3, {'cascadeCreate' => true, 'timestamp' => 5})
     expect { @client.send(dv) }.not_to raise_exception
     expect { @client.send(dv) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)

spec/api/batch_spec.rb

@@ -22,8 +22,8 @@
       ListItems.new('filter' => "'num' < 99"),
       DeleteItem.new('item1'),
       ListItems.new('filter' => "'num' >= 99"),
-      AddCartAddition.new('user', 'item2', 0),
-      AddCartAddition.new('user', 'item2', 0, 'cascadeCreate' => true)
+      AddCartAddition.new('user', 'item2'),
+      AddCartAddition.new('user', 'item2', 'cascadeCreate' => true)
     ]
     repl = @client.send(Batch.new(reqs))