algolia 3.0.0.beta.8 → 3.0.0.beta.9

data/lib/algolia/transport/echo_requester.rb

@@ -2,8 +2,17 @@ module Algolia
   module Transport
     class EchoRequester
       def send_request(host, method, path, body, query_params, headers, timeout, connect_timeout)
-        Http::Response.new(host: host, status: 200, body: body, query_params: query_params, headers: headers, method: method, path: path, timeout: timeout,
-                           connect_timeout: connect_timeout)
+        Http::Response.new(
+          host: host,
+          status: 200,
+          body: body,
+          query_params: query_params,
+          headers: headers,
+          method: method,
+          path: path,
+          timeout: timeout,
+          connect_timeout: connect_timeout
+        )
       end
     end
   end

data/lib/algolia/transport/http/http_requester.rb

@@ -8,8 +8,8 @@ module Algolia
       # @param logger [Object] logger used to log requests. Defaults to Algolia::LoggerHelper
       #
       def initialize(adapter, logger)
-        @adapter     = adapter
-        @logger      = logger
+        @adapter = adapter
+        @logger = logger
         @connections = {}
       end
 
@@ -25,27 +25,33 @@ module Algolia
       # @return [Http::Response]
       #
       def send_request(host, method, path, body, query_params, headers, timeout, connect_timeout)
-        connection                      = connection(host)
-        connection.options.timeout      = timeout / 1000
+        connection = connection(host)
+        connection.options.timeout = timeout / 1000
         connection.options.open_timeout = connect_timeout / 1000
         path += handle_query_params(query_params)
 
-        @logger.info("Sending #{method.to_s.upcase!} request to #{path} with body #{body}") if ENV['ALGOLIA_DEBUG']
+        @logger.info("Sending #{method.to_s.upcase!} request to #{path} with body #{body}") if ENV["ALGOLIA_DEBUG"]
 
         response = connection.run_request(method, path, body, headers)
 
         if response.success?
-          @logger.info("Request succeeded. Response status: #{response.status}, body: #{response.body}") if ENV['ALGOLIA_DEBUG']
+          if ENV["ALGOLIA_DEBUG"]
+            @logger.info("Request succeeded. Response status: #{response.status}, body: #{response.body}")
+          end
+
           return Http::Response.new(status: response.status, body: response.body, headers: response.headers)
         end
 
-        @logger.info("Request failed. Response status: #{response.status}, error: #{response.body}") if ENV['ALGOLIA_DEBUG']
+        if ENV["ALGOLIA_DEBUG"]
+          @logger.info("Request failed. Response status: #{response.status}, error: #{response.body}")
+        end
+
         Http::Response.new(status: response.status, error: response.body, headers: response.headers)
       rescue Faraday::TimeoutError => e
-        @logger.info("Request timed out. Error: #{e.message}") if ENV['ALGOLIA_DEBUG']
+        @logger.info("Request timed out. Error: #{e.message}") if ENV["ALGOLIA_DEBUG"]
         Http::Response.new(error: e.message, has_timed_out: true)
       rescue ::StandardError => e
-        @logger.info("Request failed. Error: #{e.message}") if ENV['ALGOLIA_DEBUG']
+        @logger.info("Request failed. Error: #{e.message}") if ENV["ALGOLIA_DEBUG"]
         Http::Response.new(error: e.message, network_failure: true)
       end
 
@@ -58,7 +64,7 @@ module Algolia
       def connection(host)
         url = build_url(host)
         @connections[url] ||= Faraday.new(url) do |f|
-          f.adapter @adapter.to_sym
+          f.adapter(@adapter.to_sym)
         end
       end
 
@@ -69,21 +75,23 @@ module Algolia
       # @return [String]
       #
       def build_url(host)
-        host.protocol + host.url + (host.port.nil? ? '' : ":#{host.port}")
+        host.protocol + host.url + (host.port.nil? ? "" : ":#{host.port}")
       end
 
       # Convert query_params to a full query string
       #
       def handle_query_params(query_params)
-        query_params.nil? || query_params.empty? ? '' : "?#{to_query_string(query_params)}"
+        query_params.nil? || query_params.empty? ? "" : "?#{to_query_string(query_params)}"
       end
 
       # Create a query string from query_params
       #
       def to_query_string(query_params)
-        query_params.map do |key, value|
-          "#{key}=#{value}"
-        end.join('&')
+        query_params
+          .map do |key, value|
+            "#{key}=#{value}"
+          end
+          .join("&")
       end
     end
   end

data/lib/algolia/transport/http/response.rb

@@ -14,16 +14,16 @@ module Algolia
       # @option has_timed_out    [String]  If the request has timed out
       #
       def initialize(opts = {})
-        @status          = opts[:status]
-        @body            = opts[:body]
-        @error           = opts[:error] || ''
-        @headers         = opts[:headers] || ''
-        @has_timed_out   = opts[:has_timed_out] || false
+        @status = opts[:status]
+        @body = opts[:body]
+        @error = opts[:error] || ""
+        @headers = opts[:headers] || ""
+        @has_timed_out = opts[:has_timed_out] || false
         @network_failure = opts[:network_failure] || false
 
-        @method = opts[:method] || ''
-        @path = opts[:path] || ''
-        @host = opts[:host] || ''
+        @method = opts[:method] || ""
+        @path = opts[:path] || ""
+        @host = opts[:host] || ""
         @timeout = opts[:timeout] || 0
         @connect_timeout = opts[:connect_timeout] || 0
         @query_params = opts[:query_params] || {}

data/lib/algolia/transport/request_options.rb

@@ -6,10 +6,10 @@ module Algolia
       # @param [Search::Config] config
       #
       def initialize(config)
-        @header_params    = {}
-        @query_params     = {}
-        @timeout          = nil
-        @connect_timeout  = nil
+        @header_params = {}
+        @query_params = {}
+        @timeout = nil
+        @connect_timeout = nil
         @compression_type = config.compression_type
       end
 
@@ -35,6 +35,7 @@ module Algolia
         opts[:header_params].each do |opt, value|
           @header_params[opt.to_s] = value
         end
+
         opts.delete(:header_params)
       end
 
@@ -48,6 +49,7 @@ module Algolia
         opts[:query_params].each do |opt, value|
           @query_params[opt.to_sym] = value
         end
+
         opts.delete(:query_params)
       end
 

data/lib/algolia/transport/retry_outcome_type.rb

@@ -1,5 +1,5 @@
 module RetryOutcomeType
-  SUCCESS = 'SUCCESS'.freeze
-  RETRY   = 'RETRY'.freeze
-  FAILURE = 'FAILURE'.freeze
+  SUCCESS = "SUCCESS".freeze
+  RETRY = "RETRY".freeze
+  FAILURE = "FAILURE".freeze
 end

data/lib/algolia/transport/retry_strategy.rb

@@ -7,7 +7,7 @@ module Algolia
       #
       def initialize(hosts)
         @hosts = hosts
-        @lock  = Mutex.new
+        @lock = Mutex.new
       end
 
       # Retrieves the tryable hosts
@@ -26,6 +26,7 @@ module Algolia
             @hosts.each do |host|
               reset(host) if flag?(host.accept, call_type)
             end
+
             @hosts
           end
         end
@@ -42,16 +43,16 @@ module Algolia
       def decide(tryable_host, http_response_code: nil, is_timed_out: false, network_failure: false)
         @lock.synchronize do
           if !is_timed_out && success?(http_response_code)
-            tryable_host.up       = true
+            tryable_host.up = true
             tryable_host.last_use = Time.now.utc
             SUCCESS
           elsif !is_timed_out && retryable?(http_response_code, network_failure)
-            tryable_host.up       = false
+            tryable_host.up = false
             tryable_host.last_use = Time.now.utc
             RETRY
           elsif is_timed_out
-            tryable_host.up           = true
-            tryable_host.last_use     = Time.now.utc
+            tryable_host.up = true
+            tryable_host.last_use = Time.now.utc
             tryable_host.retry_count += 1
             RETRY
           else
@@ -94,9 +95,9 @@ module Algolia
       # @param host [StatefulHost]
       #
       def reset(host)
-        host.up          = true
+        host.up = true
         host.retry_count = 0
-        host.last_use    = Time.now.utc
+        host.last_use = Time.now.utc
       end
 
       # Make a binary check to know whether the item contains the flag

data/lib/algolia/transport/stateful_host.rb

@@ -13,13 +13,13 @@ module Algolia
       # @option options [Boolean] :up host status
       #
       def initialize(url, opts = {})
-        @url         = url
-        @protocol    = opts[:protocol] || 'https://'
-        @port        = opts[:port]
-        @accept      = opts[:accept] || (READ | WRITE)
-        @last_use    = opts[:last_use] || Time.now.utc
+        @url = url
+        @protocol = opts[:protocol] || "https://"
+        @port = opts[:port]
+        @accept = opts[:accept] || (READ | WRITE)
+        @last_use = opts[:last_use] || Time.now.utc
         @retry_count = opts[:retry_count] || 0
-        @up          = opts.key?(:up) ? opts[:up] : true
+        @up = opts.key?(:up) ? opts[:up] : true
       end
     end
   end

data/lib/algolia/transport/transport.rb

@@ -1,17 +1,18 @@
-require 'faraday'
+require "faraday"
+
 # this is the default adapter and it needs to be required to be registered.
-require 'faraday/net_http_persistent' unless Faraday::VERSION < '1'
-require 'zlib'
+require "faraday/net_http_persistent" unless Faraday::VERSION < "1"
+require "zlib"
 
 module Algolia
   module Transport
     def self.encode_uri(uri)
-      CGI.escape(uri).gsub('+', '%20')
+      CGI.escape(uri).gsub("+", "%20")
     end
 
     def self.stringify_query_params(query_params)
       query_params.to_h do |key, value|
-        value = value.join(',') if value.is_a?(Array)
+        value = value.join(",") if value.is_a?(Array)
         [encode_uri(key.to_s).to_sym, encode_uri(value.to_s)]
       end
     end
@@ -39,7 +40,7 @@ module Algolia
       #
       def request(call_type, method, path, body, opts = {})
         @retry_strategy.get_tryable_hosts(call_type).each do |host|
-          opts[:timeout]         ||= get_timeout(call_type) * (host.retry_count + 1)
+          opts[:timeout] ||= get_timeout(call_type) * (host.retry_count + 1)
           opts[:connect_timeout] ||= @config.connect_timeout * (host.retry_count + 1)
 
           request_options = RequestOptions.new(@config)
@@ -47,7 +48,7 @@ module Algolia
           # TODO: what is this merge for ?
           # request_options.query_params.merge!(request_options.data) if method == :GET
 
-          request  = build_request(method, path, body, request_options)
+          request = build_request(method, path, body, request_options)
           response = @requester.send_request(
             host,
             request[:method],
@@ -59,15 +60,21 @@ module Algolia
             request[:connect_timeout]
           )
 
-          outcome = @retry_strategy.decide(host, http_response_code: response.status, is_timed_out: response.has_timed_out, network_failure: response.network_failure)
+          outcome = @retry_strategy.decide(
+            host,
+            http_response_code: response.status,
+            is_timed_out: response.has_timed_out,
+            network_failure: response.network_failure
+          )
           if outcome == FAILURE
             decoded_error = JSON.parse(response.error, :symbolize_names => true)
             raise Algolia::AlgoliaHttpError.new(decoded_error[:status], decoded_error[:message])
           end
+
           return response unless outcome == RETRY
         end
 
-        raise Algolia::AlgoliaUnreachableHostError, 'Unreachable hosts'
+        raise Algolia::AlgoliaUnreachableHostError, "Unreachable hosts"
       end
 
       private
@@ -82,13 +89,13 @@ module Algolia
       # @return [Hash]
       #
       def build_request(method, path, body, request_options)
-        request                   = {}
-        request[:method]          = method.downcase
-        request[:path]            = path
-        request[:body]            = build_body(body, request_options)
-        request[:query_params]    = Algolia::Transport.stringify_query_params(request_options.query_params)
-        request[:header_params]   = generate_header_params(body, request_options)
-        request[:timeout]         = request_options.timeout
+        request = {}
+        request[:method] = method.downcase
+        request[:path] = path
+        request[:body] = build_body(body, request_options)
+        request[:query_params] = Algolia::Transport.stringify_query_params(request_options.query_params)
+        request[:header_params] = generate_header_params(body, request_options)
+        request[:timeout] = request_options.timeout
         request[:connect_timeout] = request_options.connect_timeout
         request
       end
@@ -97,7 +104,7 @@ module Algolia
       def build_body(body, request_options)
         return nil if body.nil?
 
-        if request_options.compression_type == 'gzip'
+        if request_options.compression_type == "gzip"
           body = Zlib.gzip(body)
         end
 
@@ -113,9 +120,9 @@ module Algolia
       def generate_header_params(body, request_options)
         header_params = request_options.header_params.transform_keys(&:downcase)
         header_params = @config.header_params.merge(header_params)
-        header_params['accept-encoding'] = 'gzip' if request_options.compression_type == 'gzip'
-        if request_options.compression_type == 'gzip' && body.is_a?(String) && !body.to_s.strip.empty?
-          header_params['content-encoding'] = 'gzip'
+        header_params["accept-encoding"] = "gzip" if request_options.compression_type == "gzip"
+        if request_options.compression_type == "gzip" && body.is_a?(String) && !body.to_s.strip.empty?
+          header_params["content-encoding"] = "gzip"
         end
 
         header_params

data/lib/algolia/user_agent.rb

@@ -9,7 +9,7 @@ module Algolia
     # Adds a segment to the UserAgent
     #
     def add(segment, version)
-      @value += format('; %<segment>s (%<version>s)', segment: segment, version: version)
+      @value += format("; %<segment>s (%<version>s)", segment: segment, version: version)
     end
   end
 end

data/lib/algolia/version.rb

@@ -1,5 +1,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 module Algolia
-  VERSION = '3.0.0.beta.8'.freeze
+  VERSION = "3.0.0.beta.9".freeze
 end

data/lib/algolia.rb

@@ -3,22 +3,22 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 # Common files
-require 'algolia/api_client'
-require 'algolia/api_error'
-require 'algolia/error'
-require 'algolia/version'
-require 'algolia/configuration'
-require 'algolia/user_agent'
-require 'algolia/logger_helper'
-require 'algolia/transport/http/http_requester'
-require 'algolia/transport/http/response'
-require 'algolia/transport/echo_requester'
-require 'algolia/transport/call_type'
-require 'algolia/transport/retry_outcome_type'
-require 'algolia/transport/stateful_host'
-require 'algolia/transport/retry_strategy'
-require 'algolia/transport/request_options'
-require 'algolia/transport/transport'
+require "algolia/api_client"
+require "algolia/api_error"
+require "algolia/error"
+require "algolia/version"
+require "algolia/configuration"
+require "algolia/user_agent"
+require "algolia/logger_helper"
+require "algolia/transport/http/http_requester"
+require "algolia/transport/http/response"
+require "algolia/transport/echo_requester"
+require "algolia/transport/call_type"
+require "algolia/transport/retry_outcome_type"
+require "algolia/transport/stateful_host"
+require "algolia/transport/retry_strategy"
+require "algolia/transport/request_options"
+require "algolia/transport/transport"
 
 # Models
 Dir["#{File.dirname(__FILE__)}/algolia/models/**/*.rb"].sort.each { |file| require file }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.8
+  version: 3.0.0.beta.9
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-01 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -51,27 +51,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: net-http-persistent
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -79,7 +85,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -93,7 +99,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -114,7 +120,6 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/release.yml"
 - ".gitignore"
-- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -254,6 +259,7 @@ files:
 - lib/algolia/models/ingestion/destination_update_response.rb
 - lib/algolia/models/ingestion/docker_image_type.rb
 - lib/algolia/models/ingestion/docker_registry.rb
+- lib/algolia/models/ingestion/docker_streams_input.rb
 - lib/algolia/models/ingestion/error_base.rb
 - lib/algolia/models/ingestion/event.rb
 - lib/algolia/models/ingestion/event_sort_keys.rb
@@ -271,7 +277,6 @@ files:
 - lib/algolia/models/ingestion/mapping_kit_action.rb
 - lib/algolia/models/ingestion/mapping_type_csv.rb
 - lib/algolia/models/ingestion/method_type.rb
-- lib/algolia/models/ingestion/on_demand_date_utils_input.rb
 - lib/algolia/models/ingestion/on_demand_trigger.rb
 - lib/algolia/models/ingestion/on_demand_trigger_input.rb
 - lib/algolia/models/ingestion/on_demand_trigger_type.rb
@@ -290,7 +295,6 @@ files:
 - lib/algolia/models/ingestion/run_sort_keys.rb
 - lib/algolia/models/ingestion/run_status.rb
 - lib/algolia/models/ingestion/run_type.rb
-- lib/algolia/models/ingestion/schedule_date_utils_input.rb
 - lib/algolia/models/ingestion/schedule_trigger.rb
 - lib/algolia/models/ingestion/schedule_trigger_input.rb
 - lib/algolia/models/ingestion/schedule_trigger_type.rb
@@ -321,9 +325,9 @@ files:
 - lib/algolia/models/ingestion/source_update_response.rb
 - lib/algolia/models/ingestion/source_update_shopify.rb
 - lib/algolia/models/ingestion/source_watch_response.rb
+- lib/algolia/models/ingestion/streaming_input.rb
 - lib/algolia/models/ingestion/streaming_trigger.rb
 - lib/algolia/models/ingestion/streaming_trigger_type.rb
-- lib/algolia/models/ingestion/streaming_utils_input.rb
 - lib/algolia/models/ingestion/subscription_trigger.rb
 - lib/algolia/models/ingestion/subscription_trigger_type.rb
 - lib/algolia/models/ingestion/task.rb
@@ -489,6 +493,7 @@ files:
 - lib/algolia/models/recommend/remove_stop_words.rb
 - lib/algolia/models/recommend/remove_words_if_no_results.rb
 - lib/algolia/models/recommend/rendering_content.rb
+- lib/algolia/models/recommend/search_pagination.rb
 - lib/algolia/models/recommend/search_params.rb
 - lib/algolia/models/recommend/search_params_object.rb
 - lib/algolia/models/recommend/search_params_query.rb
@@ -539,6 +544,7 @@ files:
 - lib/algolia/models/search/batch_request.rb
 - lib/algolia/models/search/batch_response.rb
 - lib/algolia/models/search/batch_write_params.rb
+- lib/algolia/models/search/browse_pagination.rb
 - lib/algolia/models/search/browse_params.rb
 - lib/algolia/models/search/browse_params_object.rb
 - lib/algolia/models/search/browse_response.rb
@@ -638,6 +644,7 @@ files:
 - lib/algolia/models/search/search_for_hits_options.rb
 - lib/algolia/models/search/search_hits.rb
 - lib/algolia/models/search/search_method_params.rb
+- lib/algolia/models/search/search_pagination.rb
 - lib/algolia/models/search/search_params.rb
 - lib/algolia/models/search/search_params_object.rb
 - lib/algolia/models/search/search_params_query.rb

data/.rubocop.yml

@@ -1,99 +0,0 @@
-AllCops:
-  DisabledByDefault: false
-  NewCops: enable
-
-Style/HashSyntax:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-  EnforcedStyle: always
-
-Style/WordArray:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 180
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Gemspec/DevelopmentDependencies:
-  Exclude:
-    - 'algolia.gemspec'
-
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'algolia.gemspec'
-
-Lint/DuplicateMethods:
-  Enabled: false
-
-Lint/SymbolConversion:
-  Enabled: false
-
-Lint/UnderscorePrefixedVariableName:
-  Enabled: false
-
-Naming/PredicateName:
-  Enabled: false
-
-Style/AccessorGrouping:
-  Enabled: false
-
-Style/ClassVars:
-  Enabled: false
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Style/HashTransformValues:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/NumericPredicate:
-  Enabled: false
-
-Style/RescueStandardError:
-  Enabled: false
-
-Style/SoleNestedConditional:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: false
-
-Lint/SuppressedException:
-  Enabled: false
-
-Metrics/BlockNesting:
-  Max: 4
-
-Metrics/ParameterLists:
-  Max: 7
-
-Security/CompoundHash:
-  Enabled: false