recombee_api_client 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11704e7192a3cf0b6f8122a3049608247b5c274f
-  data.tar.gz: 1841fd3587cde54649877aaf150f798649264072
+  metadata.gz: 83b584f1d11c806d77846c5619ca291e2bbaa498
+  data.tar.gz: 317bde2ed001ea6a00b10d045123098e27b268c4
 SHA512:
-  metadata.gz: 5f61d16bcb1bd799376ba4e4c984ab806960bb14ccd3f7c2c22754bdcdcc4228107873a72a88c15a1f186be7f19e256a38041fe72392778be5a452e26589e97d
-  data.tar.gz: 21109e33ba9b98f43a62b512c825420c4f1e1544f067b109a1195386785d488365229f94bcf618d271a0b3992dafe15e188c885e5389cd42c7f6653e9cf2ba81
+  metadata.gz: eb191d7f12f872936719dc11a7c6e37e8e4c925c424f53aef19975dd7931ee5a43d3a2265f3e2c62d78e523363d91ce1c44e7c5a8cbecea878e122c67cbb27e1
+  data.tar.gz: c1d90063fe718a27a0cf665c0bcaebaa9d1fa1066ef3b917fb1492329a2c63fb386d5f01b1e7c957f9ba6754a94b3fc0abea9c804278a20c144af2fd7ed8c6bd

data/README.md

@@ -2,6 +2,8 @@
 
 A Ruby client for easy use of the [Recombee](https://www.recombee.com/) recommendation API.
 
+If you don't have an account at Recombee yet, you can create a free account [here](https://www.recombee.com/).
+
 Documentation of the API can be found at [docs.recombee.com](https://docs.recombee.com/).
 
 ## Installation

data/lib/recombee_api_client.rb

@@ -96,10 +96,25 @@ module RecombeeApiClient
     def process_request_uri(request)
       uri = request.path
       uri.slice! ('/{databaseId}/')
+      uri += query_parameters_to_url(request)
       uri = URI.escape uri
       uri
     end
 
+    def query_parameters_to_url(req)
+      ps = ''
+      req.query_parameters.each do |name, val|
+        ps += (ps.include? '?') ? '&' : '?'
+        ps += "#{name}=#{format_query_parameter_value(val)}"
+      end
+      ps
+    end
+
+    def format_query_parameter_value(value)
+      return value unless value.kind_of?(Array)
+      value.join(',')
+    end
+
     # Sign request with HMAC, request URI must be exacly the same
     # We have 30s to complete request with this token
     def sign_url(req_part)

data/lib/recombee_api_client/api/add_bookmark.rb

@@ -51,7 +51,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -59,14 +59,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/bookmarks/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/bookmarks/"
-      p
+      "/{databaseId}/bookmarks/"
     end
   end
 end

data/lib/recombee_api_client/api/add_cart_addition.rb

@@ -51,7 +51,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -59,14 +59,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/cartadditions/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/cartadditions/"
-      p
+      "/{databaseId}/cartadditions/"
     end
   end
 end

data/lib/recombee_api_client/api/add_detail_view.rb

@@ -54,7 +54,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -62,14 +62,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/detailviews/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/detailviews/"
-      p
+      "/{databaseId}/detailviews/"
     end
   end
 end

data/lib/recombee_api_client/api/add_group.rb

@@ -34,7 +34,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -42,14 +42,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/groups/#{@group_id}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/groups/#{@group_id}"
-      p
+      "/{databaseId}/groups/#{@group_id}"
     end
   end
 end

data/lib/recombee_api_client/api/add_item.rb

@@ -37,7 +37,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -45,14 +45,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/items/#{@item_id}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/items/#{@item_id}"
-      p
+      "/{databaseId}/items/#{@item_id}"
     end
   end
 end

data/lib/recombee_api_client/api/add_item_property.rb

@@ -39,7 +39,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -48,14 +48,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/items/properties/#{@property_name}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/items/properties/#{@property_name}?type=#{@type}"
-      p
+      "/{databaseId}/items/properties/#{@property_name}"
     end
   end
 end

data/lib/recombee_api_client/api/add_purchase.rb

@@ -51,7 +51,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -59,14 +59,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/purchases/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/purchases/"
-      p
+      "/{databaseId}/purchases/"
     end
   end
 end

data/lib/recombee_api_client/api/add_rating.rb

@@ -54,7 +54,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -62,14 +62,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/ratings/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/ratings/"
-      p
+      "/{databaseId}/ratings/"
     end
   end
 end

data/lib/recombee_api_client/api/add_series.rb

@@ -34,7 +34,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -42,14 +42,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/series/#{@series_id}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/series/#{@series_id}"
-      p
+      "/{databaseId}/series/#{@series_id}"
     end
   end
 end

data/lib/recombee_api_client/api/add_user.rb

@@ -35,7 +35,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -43,14 +43,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/users/#{@user_id}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/users/#{@user_id}"
-      p
+      "/{databaseId}/users/#{@user_id}"
     end
   end
 end

data/lib/recombee_api_client/api/batch.rb

@@ -29,9 +29,11 @@ module RecombeeApiClient
     # Values of body parameters as a Hash
     attr_reader :body_parameters
 
-    # Get values of parameters in form a Hash.
+    # Values of query path parameters as a Hash.
     # name of parameter => value of the parameter
-    def params_hash
+    def query_parameters
+      params = {}
+      params
     end
 
     # Relative path to the endpoint
@@ -49,7 +51,7 @@ module RecombeeApiClient
     end
 
     def request_to_batch_hash(req)
-      path = req.basic_path
+      path = req.path
       path.slice! ('/{databaseId}')
       bh = {
         'method' => req.method.to_s.upcase,

data/lib/recombee_api_client/api/delete_bookmark.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes a bookmark uniquely specified by `userId`, `itemId`, and `timestamp`.
+  #Deletes a bookmark uniquely specified by `userId`, `itemId`, and `timestamp` or all the bookmarks with given `userId` and `itemId` if `timestamp` is omitted.
   #
   class DeleteBookmark < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
@@ -45,7 +45,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -56,18 +56,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/bookmarks/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/bookmarks/?userId=#{@user_id}&itemId=#{@item_id}"
-      if @optional.include? 'timestamp'
-        p += (p.include? '?') ? '&' : '?'
-        p += "timestamp=#{@optional['timestamp']}"
-      end
-      p
+      "/{databaseId}/bookmarks/"
     end
   end
 end

data/lib/recombee_api_client/api/delete_cart_addition.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp`.
+  #Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp` or all the cart additions with given `userId` and `itemId` if `timestamp` is omitted.
   #
   class DeleteCartAddition < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
@@ -45,7 +45,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -56,18 +56,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/cartadditions/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/cartadditions/?userId=#{@user_id}&itemId=#{@item_id}"
-      if @optional.include? 'timestamp'
-        p += (p.include? '?') ? '&' : '?'
-        p += "timestamp=#{@optional['timestamp']}"
-      end
-      p
+      "/{databaseId}/cartadditions/"
     end
   end
 end

data/lib/recombee_api_client/api/delete_detail_view.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`).
+  #Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`) or all the detail views with given `userId` and `itemId` if `timestamp` is omitted.
   #
   class DeleteDetailView < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
@@ -45,7 +45,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -56,18 +56,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/detailviews/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/detailviews/?userId=#{@user_id}&itemId=#{@item_id}"
-      if @optional.include? 'timestamp'
-        p += (p.include? '?') ? '&' : '?'
-        p += "timestamp=#{@optional['timestamp']}"
-      end
-      p
+      "/{databaseId}/detailviews/"
     end
   end
 end

data/lib/recombee_api_client/api/delete_group.rb

@@ -37,7 +37,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -45,14 +45,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/groups/#{@group_id}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/groups/#{@group_id}"
-      p
+      "/{databaseId}/groups/#{@group_id}"
     end
   end
 end