typesense 2.1.0 → 3.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 821dcb542970fb0e93bfeceed5e47b714ecfb9c0ff8920382b4959b6ddfc8c22
-  data.tar.gz: e17c06e9cfc5bba67a5cfe92d9a1fb35bd53b4957e9f523f5ca3ee0e819dc518
+  metadata.gz: 207a723a469821c92408584d89b0d74db1c705e472ab1f7f238cea1640816993
+  data.tar.gz: ce2df2d51c341f60c5f2626810b71d3250e03640ae01cfe5e74cfc0be262ee65
 SHA512:
-  metadata.gz: 794ef47d87171bc57c2d51e34883414224f1bb21c46e87a5257b2cb9744ed410da1e776737461d6001b8bf0b0d89b652f92b7d138edc1099789e71f2f7441ef1
-  data.tar.gz: 894cce3929f9f443d4c8f885717e3b087dc4d122d5943324a9244927eabc90b068d4c39db892aa0c893dfa2eea7b44d0361f826f0448356c13bc2eacfe485bea
+  metadata.gz: '08f5e7ba0388270bb7f510ea9d8150d159673d3cedee6fbaa9e867e5591716add353359af503754aa8da1d75f9732522df106def8a98ce77dae5d1f9ba80b037'
+  data.tar.gz: 58e734bcf1a05efb399e32ceed24827dac1818c9ea669d9b1d99c52707a60854af2305c3275ae863c5cca88fa0142b53f25e53e3c816ed44d4f0c0eb69e1d164

data/.github/workflows/tests.yml

@@ -11,8 +11,25 @@ jobs:
     strategy:
       matrix:
         ruby-version: ['2.7', '3.0', '3.2']
+    services:
+      typesense:
+        image: typesense/typesense:27.1
+        ports:
+          - 8108:8108
+        volumes:
+          - /tmp/typesense-data:/data
+          - /tmp/typesense-analytics:/analytics
+        env:
+          TYPESENSE_API_KEY: xyz
+          TYPESENSE_DATA_DIR: /data
+          TYPESENSE_ENABLE_CORS: true
+          TYPESENSE_ANALYTICS_DIR: /analytics
+          TYPESENSE_ENABLE_SEARCH_ANALYTICS: true
 
     steps:
+      - name: Wait for Typesense
+        run: |
+          timeout 20 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8108/health)" != "200" ]]; do sleep 1; done' || false
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:

data/Gemfile

@@ -8,6 +8,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gem 'awesome_print', '~> 1.8'
 gem 'bundler', '~> 2.0'
 gem 'codecov', '~> 0.1'
+gem 'erb'
 gem 'guard', '~> 2.16'
 gem 'guard-rubocop', '~> 1.3'
 gem 'rake', '~> 13.0'

data/lib/typesense/api_call.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'typhoeus'
+require 'faraday'
 require 'oj'
 
 module Typesense
@@ -69,23 +69,25 @@ module Typesense
         @logger.debug "Attempting #{method.to_s.upcase} request Try ##{num_tries} to Node #{node[:index]}"
 
         begin
-          request_options = {
-            method: method,
-            timeout: @connection_timeout_seconds,
-            headers: default_headers.merge(additional_headers)
-          }
-          request_options.merge!(params: query_parameters) unless query_parameters.nil?
-
-          unless body_parameters.nil?
-            body = body_parameters
-            body = Oj.dump(body_parameters, mode: :compat) if request_options[:headers]['Content-Type'] == 'application/json'
-            request_options.merge!(body: body)
+          conn = Faraday.new(uri_for(endpoint, node)) do |f|
+            f.options.timeout = @connection_timeout_seconds
+            f.options.open_timeout = @connection_timeout_seconds
           end
 
-          response = Typhoeus::Request.new(uri_for(endpoint, node), request_options).run
-          set_node_healthcheck(node, is_healthy: true) if response.code >= 1 && response.code <= 499
+          headers = default_headers.merge(additional_headers)
 
-          @logger.debug "Request #{method}:#{uri_for(endpoint, node)} to Node #{node[:index]} was successfully made (at the network layer). Response Code was #{response.code}."
+          response = conn.send(method) do |req|
+            req.headers = headers
+            req.params = query_parameters unless query_parameters.nil?
+            unless body_parameters.nil?
+              body = body_parameters
+              body = Oj.dump(body_parameters, mode: :compat) if headers['Content-Type'] == 'application/json'
+              req.body = body
+            end
+          end
+          set_node_healthcheck(node, is_healthy: true) if response.status >= 1 && response.status <= 499
+
+          @logger.debug "Request #{method}:#{uri_for(endpoint, node)} to Node #{node[:index]} was successfully made (at the network layer). response.status was #{response.status}."
 
           parsed_response = if response.headers && (response.headers['content-type'] || '').include?('application/json')
                               Oj.load(response.body, mode: :compat)
@@ -94,13 +96,15 @@ module Typesense
                             end
 
           # If response is 2xx return the object, else raise the response as an exception
-          return parsed_response if response.code >= 200 && response.code <= 299
+          return parsed_response if response.status >= 200 && response.status <= 299
 
           exception_message = (parsed_response && parsed_response['message']) || 'Error'
           raise custom_exception_klass_for(response), exception_message
-        rescue Errno::EINVAL, Errno::ENETDOWN, Errno::ENETUNREACH, Errno::ENETRESET, Errno::ECONNABORTED, Errno::ECONNRESET,
-               Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::EHOSTDOWN, Errno::EHOSTUNREACH,
-               Typesense::Error::TimeoutError, Typesense::Error::ServerError, Typesense::Error::HTTPStatus0Error => e
+        rescue Faraday::ConnectionFailed, Faraday::TimeoutError,
+               Errno::EINVAL, Errno::ENETDOWN, Errno::ENETUNREACH, Errno::ENETRESET,
+               Errno::ECONNABORTED, Errno::ECONNRESET, Errno::ETIMEDOUT,
+               Errno::ECONNREFUSED, Errno::EHOSTDOWN, Errno::EHOSTUNREACH,
+               Typesense::Error::ServerError, Typesense::Error::HTTPStatus0Error => e
           # Rescue network layer exceptions and HTTP 5xx errors, so the loop can continue.
           # Using loops for retries instead of rescue...retry to maintain consistency with client libraries in
           #   other languages that might not support the same construct.
@@ -176,23 +180,24 @@ module Typesense
     end
 
     def custom_exception_klass_for(response)
-      if response.code == 400
+      if response.status == 400
         Typesense::Error::RequestMalformed.new(response: response)
-      elsif response.code == 401
+      elsif response.status == 401
         Typesense::Error::RequestUnauthorized.new(response: response)
-      elsif response.code == 404
+      elsif response.status == 404
         Typesense::Error::ObjectNotFound.new(response: response)
-      elsif response.code == 409
+      elsif response.status == 409
         Typesense::Error::ObjectAlreadyExists.new(response: response)
-      elsif response.code == 422
+      elsif response.status == 422
         Typesense::Error::ObjectUnprocessable.new(response: response)
-      elsif response.code >= 500 && response.code <= 599
+      elsif response.status >= 500 && response.status <= 599
         Typesense::Error::ServerError.new(response: response)
-      elsif response.timed_out?
+      elsif response.respond_to?(:timed_out?) && response.timed_out?
         Typesense::Error::TimeoutError.new(response: response)
-      elsif response.code.zero?
+      elsif response.status.zero?
         Typesense::Error::HTTPStatus0Error.new(response: response)
       else
+        # This will handle both 300-level responses and any other unhandled status codes
         Typesense::Error::HTTPError.new(response: response)
       end
     end

data/lib/typesense/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typesense
-  VERSION = '2.1.0'
+  VERSION = '3.0.0.rc1'
 end

data/typesense.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'faraday', '~> 2.8'
   spec.add_dependency 'oj', '~> 3.16'
-  spec.add_dependency 'typhoeus', '~> 1.4'
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.16'
 description: Typesense is an open source search engine for building a delightful search
   experience.
 email:
@@ -111,9 +111,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key: