Added support for view portions

Author: OndraFiedler

lib/recombee_api_client.rb

@@ -18,7 +18,7 @@ class RecombeeClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/1.4.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/1.5.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee

lib/recombee_api_client/api/delete_view_portion.rb

@@ -0,0 +1,65 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  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
+    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.
+  #
+    def initialize(user_id, item_id, optional = {})
+      @user_id = user_id
+      @item_id = item_id
+      @session_id = optional['sessionId']
+      @optional = optional
+      @timeout = 1000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail 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
+      params = {}
+      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/"
+    end
+  end
+end

lib/recombee_api_client/api/list_item_view_portions.rb

@@ -0,0 +1,53 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  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
+    attr_reader :item_id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +item_id+ -> ID of the item of which the view portions are to be listed.
+  #
+  #
+    def initialize(item_id)
+      @item_id = item_id
+      @timeout = 100000
+      @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/"
+    end
+  end
+end

lib/recombee_api_client/api/list_user_view_portions.rb

@@ -0,0 +1,52 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #The view portions feature is currently experimental.
+  #
+  #List all the view portions ever submitted by a given user.
+  #
+  class ListUserViewPortions < ApiRequest
+    attr_reader :user_id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user whose view portions are to be listed.
+  #
+    def initialize(user_id)
+      @user_id = user_id
+      @timeout = 100000
+      @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}/viewportions/"
+    end
+  end
+end

lib/recombee_api_client/api/set_view_portion.rb

@@ -0,0 +1,75 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  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.
+  #
+  class SetViewPortion < ApiRequest
+    attr_reader :user_id, :item_id, :session_id, :timestamp, :portion, :cascade_create
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *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) ).
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +sessionId+ -> Id of session in which the user viewed the item
+  #   - +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, portion, optional = {})
+      @user_id = user_id
+      @item_id = item_id
+      @portion = portion
+      @session_id = optional['sessionId']
+      @timestamp = optional['timestamp']
+      @cascade_create = optional['cascadeCreate']
+      @optional = optional
+      @timeout = 1000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["sessionId","timestamp","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['userId'] = @user_id
+      p['itemId'] = @item_id
+      p['portion'] = @portion
+      p['sessionId'] = @optional['sessionId'] if @optional.include? 'sessionId'
+      p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
+      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}/viewportions/"
+    end
+  end
+end

lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

spec/api/delete_view_portion.rb

@@ -0,0 +1,21 @@
+#
+# This file is auto-generated, do not edit
+#
+
+require 'spec_helper'
+require_relative 'set_environment'
+shared_examples 'delete view portion' do
+include_context 'set environment'
+include_context 'set interactions'
+
+  it 'does not fail with existing entity id' do
+    req = described_class.new('user','item')
+    resp = @client.send(req)
+    req = described_class.new('user','item')
+    expect { @client.send(req) }.to raise_exception { |exception|
+       expect(exception).to be_a(RecombeeApiClient::ResponseError)
+       expect(exception.status_code).to eq 404
+     }
+  end
+
+end

spec/api/delete_view_portion_spec.rb

@@ -0,0 +1,10 @@
+#
+# This file is auto-generated, do not edit
+#
+
+require 'spec_helper'
+require_relative "delete_view_portion"
+
+describe RecombeeApiClient::DeleteViewPortion do
+  it_behaves_like "delete view portion"
+end

spec/api/list_item_view_portions_spec.rb

@@ -0,0 +1,10 @@
+#
+# This file is auto-generated, do not edit
+#
+
+require 'spec_helper'
+require_relative "list_item_interactions"
+
+describe RecombeeApiClient::ListItemViewPortions do
+  it_behaves_like "list item interactions"
+end

spec/api/list_user_view_portions_spec.rb

@@ -0,0 +1,10 @@
+#
+# This file is auto-generated, do not edit
+#
+
+require 'spec_helper'
+require_relative "list_user_interactions"
+
+describe RecombeeApiClient::ListUserViewPortions do
+  it_behaves_like "list user interactions"
+end