Added support for view portions

Author: OndraFiedler

recombee_api_client/api_client.py

@@ -63,7 +63,7 @@ def send(self, request):
 
     @staticmethod
     def __get_http_headers(additional_headers=None):
-        headers = {'User-Agent': 'recombee-python-api-client/1.4.0'}
+        headers = {'User-Agent': 'recombee-python-api-client/1.5.0'}
         if additional_headers:
             headers.update(additional_headers)
         return headers

recombee_api_client/api_requests/__init__.py

@@ -49,6 +49,10 @@
 from recombee_api_client.api_requests.delete_bookmark import DeleteBookmark
 from recombee_api_client.api_requests.list_item_bookmarks import ListItemBookmarks
 from recombee_api_client.api_requests.list_user_bookmarks import ListUserBookmarks
+from recombee_api_client.api_requests.set_view_portion import SetViewPortion
+from recombee_api_client.api_requests.delete_view_portion import DeleteViewPortion
+from recombee_api_client.api_requests.list_item_view_portions import ListItemViewPortions
+from recombee_api_client.api_requests.list_user_view_portions import ListUserViewPortions
 from recombee_api_client.api_requests.user_based_recommendation import UserBasedRecommendation
 from recombee_api_client.api_requests.item_based_recommendation import ItemBasedRecommendation
 from recombee_api_client.api_requests.reset_database import ResetDatabase

recombee_api_client/api_requests/delete_view_portion.py

@@ -0,0 +1,50 @@
+from recombee_api_client.api_requests.request import Request
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+class DeleteViewPortion(Request):
+    """
+    The view portions feature is currently experimental.
+    
+    Deletes an existing view portion specified by (`userId`, `itemId`, `sessionId`) from the database.
+
+    """
+
+    def __init__(self, user_id, item_id, session_id=DEFAULT):
+        """
+        Required parameters:
+        @param user_id: ID of the user who rated the item.
+        
+        @param item_id: ID of the item which was rated.
+        
+        
+        Optional parameters:
+        @param session_id: Identifier of a session.
+        
+        """
+        self.user_id = user_id
+        self.item_id = item_id
+        self.session_id = session_id
+        self.timeout = 1000
+        self.ensure_https = False
+        self.method = 'delete'
+        self.path = "/viewportions/" % ()
+
+    def get_body_parameters(self):
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        return p
+
+    def get_query_parameters(self):
+        """
+        Values of query parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        params = dict()
+        params['userId'] = self.user_id
+        params['itemId'] = self.item_id
+        if self.session_id is not DEFAULT:
+            params['sessionId'] = self.session_id
+        return params

recombee_api_client/api_requests/list_item_view_portions.py

@@ -0,0 +1,39 @@
+from recombee_api_client.api_requests.request import Request
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+class ListItemViewPortions(Request):
+    """
+    The view portions feature is currently experimental.
+    
+    List all the view portions of an item ever submitted by different users.
+
+    """
+
+    def __init__(self, item_id):
+        """
+        Required parameters:
+        @param item_id: ID of the item of which the view portions are to be listed.
+        
+        
+        """
+        self.item_id = item_id
+        self.timeout = 100000
+        self.ensure_https = False
+        self.method = 'get'
+        self.path = "/items/%s/viewportions/" % (self.item_id)
+
+    def get_body_parameters(self):
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        return p
+
+    def get_query_parameters(self):
+        """
+        Values of query parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        params = dict()
+        return params

recombee_api_client/api_requests/list_user_view_portions.py

@@ -0,0 +1,38 @@
+from recombee_api_client.api_requests.request import Request
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+class ListUserViewPortions(Request):
+    """
+    The view portions feature is currently experimental.
+    
+    List all the view portions ever submitted by a given user.
+
+    """
+
+    def __init__(self, user_id):
+        """
+        Required parameters:
+        @param user_id: ID of the user whose view portions are to be listed.
+        
+        """
+        self.user_id = user_id
+        self.timeout = 100000
+        self.ensure_https = False
+        self.method = 'get'
+        self.path = "/users/%s/viewportions/" % (self.user_id)
+
+    def get_body_parameters(self):
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        return p
+
+    def get_query_parameters(self):
+        """
+        Values of query parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        params = dict()
+        return params

recombee_api_client/api_requests/set_view_portion.py

@@ -0,0 +1,65 @@
+from recombee_api_client.api_requests.request import Request
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+class SetViewPortion(Request):
+    """
+    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.
+
+    """
+
+    def __init__(self, user_id, item_id, portion, session_id=DEFAULT, timestamp=DEFAULT, cascade_create=DEFAULT):
+        """
+        Required parameters:
+        @param user_id: User who viewed a portion of the item
+        
+        @param item_id: Viewed item
+        
+        @param portion: Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ).
+        
+        
+        Optional parameters:
+        @param session_id: Id of session in which the user viewed the item
+        
+        @param timestamp: UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
+        
+        @param cascade_create: Sets whether the given user/item should be created if not present in the database.
+        
+        """
+        self.user_id = user_id
+        self.item_id = item_id
+        self.portion = portion
+        self.session_id = session_id
+        self.timestamp = timestamp
+        self.cascade_create = cascade_create
+        self.timeout = 1000
+        self.ensure_https = False
+        self.method = 'post'
+        self.path = "/viewportions/" % ()
+
+    def get_body_parameters(self):
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        p['userId'] = self.user_id
+        p['itemId'] = self.item_id
+        p['portion'] = self.portion
+        if self.session_id is not DEFAULT:
+            p['sessionId'] = self.session_id
+        if self.timestamp is not DEFAULT:
+            p['timestamp'] = self.timestamp
+        if self.cascade_create is not DEFAULT:
+            p['cascadeCreate'] = self.cascade_create
+        return p
+
+    def get_query_parameters(self):
+        """
+        Values of query parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        params = dict()
+        return params

setup.py

@@ -11,7 +11,7 @@
 setup(
     name='recombee-api-client',
 
-    version='1.4.0',
+    version='1.5.0',
 
     description='Client for Recombee recommendation API',
     long_description=long_description,

tests/test.py

@@ -116,6 +116,14 @@
     suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(ListItemBookmarksTestCase))
     from tests.test_cases.test_list_user_bookmarks import ListUserBookmarksTestCase
     suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(ListUserBookmarksTestCase))
+    from tests.test_cases.test_set_view_portion import SetViewPortionTestCase
+    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(SetViewPortionTestCase))
+    from tests.test_cases.test_delete_view_portion import DeleteViewPortionTestCase
+    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(DeleteViewPortionTestCase))
+    from tests.test_cases.test_list_item_view_portions import ListItemViewPortionsTestCase
+    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(ListItemViewPortionsTestCase))
+    from tests.test_cases.test_list_user_view_portions import ListUserViewPortionsTestCase
+    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(ListUserViewPortionsTestCase))
     from tests.test_cases.test_user_based_recommendation import UserBasedRecommendationTestCase
     suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(UserBasedRecommendationTestCase))
     from tests.test_cases.test_item_based_recommendation import ItemBasedRecommendationTestCase

tests/test_cases/delete_view_portion.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# This file is auto-generated, do not edit
+#
+
+from tests.test_cases.recombee_test import RecombeeTest, InteractionsTest
+from recombee_api_client.exceptions import ResponseException
+from recombee_api_client.api_requests import *
+
+class DeleteViewPortionTest (InteractionsTest ):
+
+    def create_request(self,user_id,item_id,session_id=None):
+        pass
+
+    def test_delete_view_portion(self):
+
+        # it 'does not fail with existing entity id'
+        req = self.create_request('user','item')
+        resp = self.client.send(req)
+        req = self.create_request('user','item')
+        try:
+            self.client.send(req)
+            self.assertFail()
+        except ResponseException as ex:
+            self.assertEqual(ex.status_code, 404)
+

tests/test_cases/recombee_test.py

@@ -48,7 +48,8 @@ def setUp(self):
       AddPurchase('user', 'item', timestamp=0),
       AddRating('user', 'item', 1, timestamp=0),
       AddCartAddition('user', 'item', timestamp=0),
-      AddBookmark('user', 'item', timestamp=0)
+      AddBookmark('user', 'item', timestamp=0),
+      SetViewPortion('user', 'item', 1, timestamp=0),
     ])
 
     self.client.send(batch)