recombee_api_client 5.1.0 → 6.0.0

data/lib/recombee_api_client.rb

@@ -10,6 +10,7 @@ require 'cgi'
 
 require 'recombee_api_client/errors'
 Gem.find_files('recombee_api_client/api/*.rb').each { |path| require path }
+Gem.find_files('recombee_api_client/inputs/*.rb').each { |path| require path }
 
 module RecombeeApiClient
   ##
@@ -17,8 +18,8 @@ module RecombeeApiClient
   class RecombeeClient
     include HTTParty
 
-    BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/5.1.0'}
+    BATCH_MAX_SIZE = 10_000
+    USER_AGENT = { 'User-Agent' => 'recombee-ruby-api-client/6.0.0' }
 
     ##
     #   - +account+ -> Name of your account at Recombee
@@ -33,8 +34,7 @@ module RecombeeApiClient
     ##
     #   - +request+ -> ApiRequest to be sent to Recombee recommender
     def send(request)
-
-      return send_multipart_batch(request) if request.kind_of? Batch and request.requests.size > BATCH_MAX_SIZE
+      return send_multipart_batch(request) if request.is_a? Batch and request.requests.size > BATCH_MAX_SIZE
 
       timeout = request.timeout / 1000
       uri = process_request_uri(request)
@@ -54,7 +54,7 @@ module RecombeeApiClient
           delete(request, uri, timeout)
         end
       rescue Timeout::Error
-        fail ApiTimeout.new(request)
+        raise ApiTimeout.new(request)
       end
     end
 
@@ -62,12 +62,15 @@ module RecombeeApiClient
 
     def get_regional_base_uri(region)
       uri = {
-            'ap-se' => 'rapi-ap-se.recombee.com',
-            'ca-east' => 'rapi-ca-east.recombee.com',
-            'eu-west' => 'rapi-eu-west.recombee.com',
-            'us-west' => 'rapi-us-west.recombee.com'
-          }[region.to_s.gsub('_', '-').downcase]
-      raise ArgumentError.new("Region \"#{region}\" is unknown. You may need to update the version of the SDK.") if uri == nil
+        'ap-se' => 'rapi-ap-se.recombee.com',
+        'ca-east' => 'rapi-ca-east.recombee.com',
+        'eu-west' => 'rapi-eu-west.recombee.com',
+        'us-west' => 'rapi-us-west.recombee.com'
+      }[region.to_s.gsub('_', '-').downcase]
+      if uri.nil?
+        raise ArgumentError.new("Region \"#{region}\" is unknown. You may need to update the version of the SDK.")
+      end
+
       uri
     end
 
@@ -77,16 +80,17 @@ module RecombeeApiClient
 
       if options.key? :region
         raise ArgumentError.new(':base_uri and :region cannot be specified at the same time') if base_uri
+
         base_uri = get_regional_base_uri(options[:region])
       end
-      base_uri||= 'rapi.recombee.com'
+      base_uri ||= 'rapi.recombee.com'
       base_uri
     end
 
     def put(request, uri, timeout)
-      response = self.class.put(uri, body: request.body_parameters.to_json, 
-                                headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
-                                timeout: timeout)
+      response = self.class.put(uri, body: request.body_parameters.to_json,
+                                     headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
+                                     timeout: timeout)
       check_errors(response, request)
       response.body
     end
@@ -98,44 +102,45 @@ module RecombeeApiClient
     end
 
     def post(request, uri, timeout)
-      response = self.class.post(uri, body: request.body_parameters.to_json, 
-                                 headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
-                                 timeout: timeout)
+      response = self.class.post(uri, body: request.body_parameters.to_json,
+                                      headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
+                                      timeout: timeout)
       check_errors(response, request)
       begin
-        return JSON.parse(response.body)
+        JSON.parse(response.body)
       rescue JSON::ParserError
-        return response.body
+        response.body
       end
     end
 
     def delete(request, uri, timeout)
       response = self.class.delete(uri, body: request.body_parameters.to_json,
-                                   headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
-                                   timeout: timeout)
+                                        headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
+                                        timeout: timeout)
       check_errors(response, request)
       begin
-        return JSON.parse(response.body)
+        JSON.parse(response.body)
       rescue JSON::ParserError
-        return response.body
+        response.body
       end
     end
 
     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)
+      return if [200, 201].include?(status_code)
+
+      raise ResponseError.new(request, status_code, response.body)
     end
 
     def send_multipart_batch(request)
       requests_parts = request.requests.each_slice(BATCH_MAX_SIZE)
-      responses = requests_parts.map {|rqs| Batch.new(rqs)}.map{|batch| send(batch)}
-      responses.inject([]){|result,resp| result + resp}
+      responses = requests_parts.map { |rqs| Batch.new(rqs) }.map { |batch| send(batch) }
+      responses.inject([]) { |result, resp| result + resp }
     end
 
     def process_request_uri(request)
       uri = request.path
-      uri.slice! ('/{databaseId}/')
+      uri.slice!('/{databaseId}/')
       uri += query_parameters_to_url(request)
       uri
     end
@@ -143,15 +148,16 @@ module RecombeeApiClient
     def query_parameters_to_url(req)
       ps = ''
       req.query_parameters.each do |name, val|
-        ps += (ps.include? '?') ? '&' : '?'
+        ps += ps.include?('?') ? '&' : '?'
         ps += "#{name}=#{format_query_parameter_value(val)}"
       end
       ps
     end
 
     def format_query_parameter_value(value)
-      return CGI::escape("#{value}") unless value.kind_of?(Array)
-      value.map{|v| CGI::escape("#{v}")}.join(',')
+      return CGI.escape("#{value}") unless value.is_a?(Array)
+
+      value.map { |v| CGI.escape("#{v}") }.join(',')
     end
 
     # Sign request with HMAC, request URI must be exacly the same
@@ -160,12 +166,11 @@ module RecombeeApiClient
       uri = "/#{@account}/#{req_part}"
       time = hmac_time(uri)
       sign = hmac_sign(uri, time)
-      res = uri + time + "&hmac_sign=#{sign}"
-      res
+      uri + time + "&hmac_sign=#{sign}"
     end
 
     def hmac_time(uri)
-      res = (uri.include? '?') ? '&' : '?'
+      res = uri.include?('?') ? '&' : '?'
       res << "hmac_timestamp=#{Time.now.utc.to_i}"
     end
 

data/recombee_api_client.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'recombee_api_client/version'
 
@@ -19,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'multi_json', '~> 1.15'
   spec.add_dependency 'httparty', '~> 0.18'
+  spec.add_dependency 'multi_json', '~> 1.15'
 
   spec.add_development_dependency 'bundler', '~> 2.6.2'
   spec.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,42 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Ondřej Fiedler
 bindir: bin
 cert_chain: []
-date: 2025-07-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +105,7 @@ files:
 - lib/recombee_api_client/api/add_user.rb
 - lib/recombee_api_client/api/add_user_property.rb
 - lib/recombee_api_client/api/batch.rb
+- lib/recombee_api_client/api/composite_recommendation.rb
 - lib/recombee_api_client/api/create_auto_reql_segmentation.rb
 - lib/recombee_api_client/api/create_manual_reql_segmentation.rb
 - lib/recombee_api_client/api/create_property_based_segmentation.rb
@@ -129,7 +130,6 @@ files:
 - lib/recombee_api_client/api/get_segmentation.rb
 - lib/recombee_api_client/api/get_user_property_info.rb
 - lib/recombee_api_client/api/get_user_values.rb
-- lib/recombee_api_client/api/hash_normalizer.rb
 - lib/recombee_api_client/api/insert_to_series.rb
 - lib/recombee_api_client/api/list_item_bookmarks.rb
 - lib/recombee_api_client/api/list_item_cart_additions.rb
@@ -177,6 +177,10 @@ files:
 - lib/recombee_api_client/api/update_more_items.rb
 - lib/recombee_api_client/api/update_property_based_segmentation.rb
 - lib/recombee_api_client/errors.rb
+- lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb
+- lib/recombee_api_client/inputs/input.rb
+- lib/recombee_api_client/inputs/logic.rb
+- lib/recombee_api_client/utils/hash_normalizer.rb
 - lib/recombee_api_client/version.rb
 - recombee_api_client.gemspec
 homepage: https://recombee.com
@@ -197,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Client for Recombee recommendation API
 test_files: []

data/lib/recombee_api_client/api/hash_normalizer.rb

@@ -1,21 +0,0 @@
-module RecombeeApiClient
-  ##
-  # Module to convert Ruby conventions to Recombee's API namings
-  #
-  module HashNormalizer
-    def normalize_optional opts
-      opts_new = {}
-      opts.each do |k,v|
-        case k
-        when String then opts_new[camelize(k)] = opts.delete(k)
-        when Symbol then opts_new[camelize(k.to_s)] = opts.delete(k)
-        end
-      end
-      opts_new
-    end
-
-    def camelize str
-      str.gsub(/_(.)/) {|e| $1.upcase}
-    end
-  end
-end