Support returnProperties and includedProperties parameters of recommendation requests

Author: OndraFiedler

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

lib/recombee_api_client.rb

@@ -96,10 +96,25 @@ def check_errors(response, request)
     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)

lib/recombee_api_client/api/add_bookmark.rb

@@ -51,22 +51,16 @@ def body_parameters
       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 = {}
       params
     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

lib/recombee_api_client/api/add_cart_addition.rb

@@ -51,22 +51,16 @@ def body_parameters
       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 = {}
       params
     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

lib/recombee_api_client/api/add_detail_view.rb

@@ -54,22 +54,16 @@ def body_parameters
       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 = {}
       params
     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

lib/recombee_api_client/api/add_group.rb

@@ -34,22 +34,16 @@ def body_parameters
       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 = {}
       params
     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

lib/recombee_api_client/api/add_item.rb

@@ -37,22 +37,16 @@ def body_parameters
       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 = {}
       params
     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

lib/recombee_api_client/api/add_item_property.rb

@@ -39,7 +39,7 @@ def body_parameters
       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 @@ def query_parameters
     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

lib/recombee_api_client/api/add_purchase.rb

@@ -51,22 +51,16 @@ def body_parameters
       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 = {}
       params
     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

lib/recombee_api_client/api/add_rating.rb

@@ -54,22 +54,16 @@ def body_parameters
       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 = {}
       params
     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