recombee_api_client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 502d27b927763c5c54e373aca3db137df0198683
-  data.tar.gz: 0dea5323ad9a5b304bd72a8fe20f590ce8002103
+  metadata.gz: 11704e7192a3cf0b6f8122a3049608247b5c274f
+  data.tar.gz: 1841fd3587cde54649877aaf150f798649264072
 SHA512:
-  metadata.gz: 2787a7a249bf23cb1df46cb9047c6e36e13227677a936c79a87a680547c21829850de8ec2c3dda9083dd9351abd35c3fbdea0d0607da93dae85669138ff6c151
-  data.tar.gz: 117af7984b724ada34b5ffac9bbf03e3efbded675733daf76e7ceb79a25b494db5285c8408a33c089f68117940879030cdac28d6e1a53714b627a0324c65734a
+  metadata.gz: 5f61d16bcb1bd799376ba4e4c984ab806960bb14ccd3f7c2c22754bdcdcc4228107873a72a88c15a1f186be7f19e256a38041fe72392778be5a452e26589e97d
+  data.tar.gz: 21109e33ba9b98f43a62b512c825420c4f1e1544f067b109a1195386785d488365229f94bcf618d271a0b3992dafe15e188c885e5389cd42c7f6653e9cf2ba81

data/README.md

@@ -49,7 +49,7 @@ begin
   puts 'Send items'
   client.send(Batch.new(my_items.map { |itemId| AddItem.new(itemId) }))
   puts 'Send purchases'
-  client.send(Batch.new(my_purchases.map { |p| AddPurchase.new(p['userId'], p['itemId'], 0) }))
+  client.send(Batch.new(my_purchases.map { |p| AddPurchase.new(p['userId'], p['itemId']) }))
   
   # Get recommendations for user 'user-25'
   puts 'Recommend for a user'
@@ -62,8 +62,6 @@ end
 
 ### Using property values
 ```ruby
-#!/usr/bin/env ruby
-
 require 'recombee_api_client'
 include RecombeeApiClient
 
@@ -107,7 +105,7 @@ requests = []
   user_ids = (1..NUM).map{|i| "user-#{i}"}
   user_ids = user_ids.select { |_| rand(0.0..1.0) < PROBABILITY_PURCHASED }
   # Use cascadeCreate to create unexisting users
-  user_ids.each { |user_id| requests.push(AddPurchase.new(user_id, item_id, 0, 'cascadeCreate' => true)) }
+  user_ids.each { |user_id| requests.push(AddPurchase.new(user_id, item_id, 'cascadeCreate' => true)) }
 end
 
 # Send purchases to the recommender system

data/lib/recombee_api_client.rb

@@ -1,6 +1,6 @@
 require 'recombee_api_client/version'
 require 'securerandom'
-require 'digest/hmac'
+require 'openssl'
 require 'httparty'
 require 'json'
 require 'open-uri'
@@ -11,85 +11,103 @@ require 'recombee_api_client/errors'
 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
-      @base_uri = options[:base_uri] ||= 'https://rapi.recombee.com'
+      @protocol = protocol
+      @base_uri = ENV['RAPI_URI'] if ENV.key? 'RAPI_URI'
+      @base_uri||=  options[:base_uri]
+      @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)
@@ -99,7 +117,8 @@ module RecombeeApiClient
 
     def hmac_sign(uri, time)
       url = uri + time
-      Digest::HMAC.hexdigest(url, @token, Digest::SHA1)
+      digest = OpenSSL::Digest.new('sha1')
+      OpenSSL::HMAC.hexdigest(digest, @token, url)
     end
   end
 end

data/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 @@ module RecombeeApiClient
       @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

data/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 @@ module RecombeeApiClient
       @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

data/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 @@ module RecombeeApiClient
       @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

data/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 @@ module RecombeeApiClient
     def initialize(group_id)
       @group_id = group_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/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 @@ module RecombeeApiClient
     def initialize(item_id)
       @item_id = item_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/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 @@ module RecombeeApiClient
       @property_name = property_name
       @type = type
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/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 @@ module RecombeeApiClient
       @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

data/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 @@ module RecombeeApiClient
       @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

data/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 @@ module RecombeeApiClient
     def initialize(series_id)
       @series_id = series_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/add_user.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class AddUser < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -20,6 +21,7 @@ module RecombeeApiClient
     def initialize(user_id)
       @user_id = user_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/batch.rb

@@ -9,6 +9,7 @@ module RecombeeApiClient
   class Batch < ApiRequest
     attr_reader :requests
     attr_accessor :timeout
+    attr_accessor :ensure_https
     ##
     # * *Required arguments*
     #   - +requests+ -> Array of API requests.
@@ -17,6 +18,7 @@ module RecombeeApiClient
       @requests = requests
       @body_parameters = requests_to_batch_hash
       @timeout = requests.map{|r| r.timeout}.reduce(:+)
+      @ensure_https = true
     end
 
     # HTTP method

data/lib/recombee_api_client/api/delete_bookmark.rb

@@ -12,18 +12,26 @@ module RecombeeApiClient
   class DeleteBookmark < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who made the bookmark.
   #   - +item_id+ -> ID of the item of which was bookmarked.
-  #   - +timestamp+ -> Unix timestamp of the bookmark.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the bookmark. If the `timestamp` is omitted, then all the bookmarks with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
   
     # HTTP method
@@ -43,7 +51,7 @@ module RecombeeApiClient
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
   
@@ -54,7 +62,11 @@ module RecombeeApiClient
   
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/bookmarks/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/bookmarks/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end

data/lib/recombee_api_client/api/delete_cart_addition.rb

@@ -12,18 +12,26 @@ module RecombeeApiClient
   class DeleteCartAddition < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who made the cart addition.
   #   - +item_id+ -> ID of the item of which was added to cart.
-  #   - +timestamp+ -> Unix timestamp of the cart addition.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the cart addition. If the `timestamp` is omitted, then all the cart additions with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
   
     # HTTP method
@@ -43,7 +51,7 @@ module RecombeeApiClient
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
   
@@ -54,7 +62,11 @@ module RecombeeApiClient
   
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/cartadditions/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/cartadditions/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end