Choosing of HTTP/HTTPS protocol for requests

Author: OndraFiedler

lib/recombee_api_client.rb

@@ -11,87 +11,103 @@
 Gem.find_files('recombee_api_client/api/*.rb').each { |path| require path }
 
 module RecombeeApiClient
+  ##
+  # Client for sending requests to Recombee recommender system
   class RecombeeClient
     include HTTParty
 
-    def initialize(account, token, options = {})
+    ##
+    #   - +account+ -> Name of your account at Recombee
+    #   - +token+ -> Secret token obtained from Recombee for signing requests
+    #   - +protocol+ -> Default protocol for sending requests. Possible values: 'http', 'https'.
+    def initialize(account, token, protocol = 'http', options = {})
       @account = account
       @token = token
+      @protocol = protocol
       @base_uri = ENV['RAPI_URI'] if ENV.key? 'RAPI_URI'
       @base_uri||=  options[:base_uri]
-      @base_uri||= 'https://rapi.recombee.com'
+      @base_uri||= 'rapi.recombee.com'
     end
 
+    ##
+    #   - +request+ -> ApiRequest to be sent to Recombee recommender
     def send(request)
-      @request = request
-      uri = request.path
-      uri.slice! ('/{databaseId}/')
-      uri = URI.escape uri
       timeout = request.timeout / 1000
+      uri = process_request_uri(request)
+      uri = sign_url(uri)
+      protocol = request.ensure_https ? 'https' : @protocol
+      uri = protocol + '://' + @base_uri + uri
       # puts uri
       begin
         case request.method
         when :put
-          hmac_put(uri, timeout)
+          put(request, uri, timeout)
         when :get
-          hmac_get(uri, timeout)
+          get(request, uri, timeout)
         when :post
-          hmac_post(uri, timeout, request.body_parameters.to_json)
+          post(request, uri, timeout)
         when :delete
-          hmac_delete(uri, timeout)
+          delete(request, uri, timeout)
         end
       rescue Timeout::Error
-        fail ApiTimeout.new(@request)
+        fail ApiTimeout.new(request)
       end
     end
 
     private
 
-    def hmac_put(uri, timeout, options = {})
-      r = self.class.put(sign_url(uri), query: options, timeout: timeout)
-      check_errors r
-      r.body
+    def put(request, uri, timeout)
+      response = self.class.put(uri, timeout: timeout)
+      check_errors(response, request)
+      response.body
     end
 
-    def hmac_get(uri, timeout, options = {})
-      r = self.class.get(sign_url(uri), query: options, timeout: timeout)
-      check_errors r
-      JSON.parse(r.body)
+    def get(request, uri, timeout)
+      response = self.class.get(uri, timeout: timeout)
+      check_errors(response, request)
+      JSON.parse(response.body)
     end
 
-    def hmac_post(uri, timeout, options = {})
-      url = sign_url(uri)
+    def post(request, uri, timeout)
       # pass arguments in body
-      r = self.class.post(url, body: options, 
+      response = self.class.post(uri, body: request.body_parameters.to_json, 
                         headers: { 'Content-Type' => 'application/json' },
                         timeout: timeout)
-      check_errors r
+      check_errors(response, request)
       begin
-        return JSON.parse(r.body)
+        return JSON.parse(response.body)
       rescue JSON::ParserError
-        return r.body
+        return response.body
       end
     end
 
-    def hmac_delete(uri, timeout, options = {})
-      r = self.class.delete(sign_url(uri), query: options, timeout: timeout)
-      check_errors r
-      r.body
+    def delete(request, uri, timeout)
+      response = self.class.delete(uri, timeout: timeout)
+      check_errors(response, request)
+      response.body
     end
 
-    def check_errors(response)
+    def check_errors(response, request)
       status_code = response.code
       return if status_code == 200 || status_code == 201
-      fail ResponseError.new(@request, status_code, response.body)
+      fail ResponseError.new(request, status_code, response.body)
+    end
+
+    def process_request_uri(request)
+      uri = request.path
+      uri.slice! ('/{databaseId}/')
+      uri = URI.escape uri
+      uri
     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)
-      uri = "/#{@account}/#{req}"
+    def sign_url(req_part)
+      uri = "/#{@account}/#{req_part}"
       time = hmac_time(uri)
       sign = hmac_sign(uri, time)
-      @base_uri + uri + time + "&hmac_sign=#{sign}"
+      res = uri + time + "&hmac_sign=#{sign}"
+      res
     end
 
     def hmac_time(uri)

lib/recombee_api_client/api/add_bookmark.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class AddBookmark < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :cascade_create
     attr_accessor :timeout
+    attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
@@ -29,6 +30,7 @@ def initialize(user_id, item_id, optional = {})
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
+      @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
       end

lib/recombee_api_client/api/add_cart_addition.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class AddCartAddition < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :cascade_create
     attr_accessor :timeout
+    attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
@@ -29,6 +30,7 @@ def initialize(user_id, item_id, optional = {})
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
+      @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
       end

lib/recombee_api_client/api/add_detail_view.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class AddDetailView < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :duration, :cascade_create
     attr_accessor :timeout
+    attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
@@ -31,6 +32,7 @@ def initialize(user_id, item_id, optional = {})
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
+      @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","duration","cascadeCreate"].include? par
       end

lib/recombee_api_client/api/add_group.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class AddGroup < ApiRequest
     attr_reader :group_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
@@ -19,6 +20,7 @@ class AddGroup < ApiRequest
     def initialize(group_id)
       @group_id = group_id
       @timeout = 1000
+      @ensure_https = false
     end
 
     # HTTP method

lib/recombee_api_client/api/add_item.rb

@@ -14,6 +14,7 @@ module RecombeeApiClient
   class AddItem < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
@@ -22,6 +23,7 @@ class AddItem < ApiRequest
     def initialize(item_id)
       @item_id = item_id
       @timeout = 1000
+      @ensure_https = false
     end
 
     # HTTP method

lib/recombee_api_client/api/add_item_property.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class AddItemProperty < ApiRequest
     attr_reader :property_name, :type
     attr_accessor :timeout
+    attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
@@ -24,6 +25,7 @@ def initialize(property_name, type)
       @property_name = property_name
       @type = type
       @timeout = 1000
+      @ensure_https = false
     end
 
     # HTTP method

lib/recombee_api_client/api/add_purchase.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class AddPurchase < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :cascade_create
     attr_accessor :timeout
+    attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
@@ -29,6 +30,7 @@ def initialize(user_id, item_id, optional = {})
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
+      @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
       end

lib/recombee_api_client/api/add_rating.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class AddRating < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :rating, :cascade_create
     attr_accessor :timeout
+    attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
@@ -31,6 +32,7 @@ def initialize(user_id, item_id, rating, optional = {})
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
+      @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
       end

lib/recombee_api_client/api/add_series.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class AddSeries < ApiRequest
     attr_reader :series_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
@@ -19,6 +20,7 @@ class AddSeries < ApiRequest
     def initialize(series_id)
       @series_id = series_id
       @timeout = 1000
+      @ensure_https = false
     end
 
     # HTTP method