typesense 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b16a7f00600eadbcf0769d6eec67994e52d89784d4d5900dbbb2cd4ea23b364
-  data.tar.gz: 4a278a32c83aaff66f7fb23f8e9688f222604c5f90f25236a3eb55b1416247c5
+  metadata.gz: d9adfab903d2cd5d7063cde39ee3db9c0be4b736c714fd146d0527c18e27b683
+  data.tar.gz: e2117b54725a861fbf989097100b44ae72a78a781c1b610b7aa12d81ad086b8f
 SHA512:
-  metadata.gz: 179ee2a5b661699d0fc7eb311f92dcd1ec913ed9aae99a13124f96ad3ef314ac872a1db4cee70f0d8abd84011a8887cf7d188bdd048219151d7f843700763f3b
-  data.tar.gz: 4aedda18915d7c2f3f17626d3d9b90cc1ddd4fa81f828536235d9775fcc1e9de0c838bde2988f3de38b337ab1a7b6e5b489547e07cfa9101754cb5a0ce2a05aa
+  metadata.gz: 0c29843ebf31fad00242a59c2b01e9fe9389bc5444545715b32abe84955c00576e308f2d69f5615870b67cf3f83ae41d27aae8f15f51e7142b454815e7315f30
+  data.tar.gz: 951e630fb0ab2fe2aa1d18366857d5c1326eb9dbfaaae34e17cc17e5d5f61370893af6b26f7aadbb32fb9cd61b758527802d9e61733077893c62abcd85abb243

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/vendor/
 /.yardoc
 /_yardoc/
 /coverage/

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require: rubocop-rspec
+plugins: rubocop-rspec
 
 AllCops:
   NewCops: enable
@@ -48,4 +48,4 @@ RSpec/MultipleExpectations:
   Enabled: false
 
 Style/HashSyntax:
-  Enabled: false # We still want to support older versions of Ruby
+  Enabled: false # We still want to support older versions of Ruby

data/Gemfile

@@ -16,7 +16,7 @@ gem 'rspec', '~> 3.9'
 gem 'rspec_junit_formatter', '~> 0.4'
 gem 'rspec-legacy_formatters', '~> 1.0' # For codecov formatter
 gem 'rubocop', '~> 1.12'
-gem 'rubocop-rspec', '~> 2.4', require: false
+gem 'rubocop-rspec', '~> 3.6', require: false
 gem 'simplecov', '~> 0.18'
 gem 'timecop', '~> 0.9'
 gem 'webmock', '~> 3.8'

data/examples/collections_and_documents.rb

@@ -147,8 +147,8 @@ ap collection
 
 ###
 # Truncate a collection
-#   Deletion returns the number of documents deleted
-collection = @typesense.collections['companies'].truncate
+#   Truncation returns the number of documents deleted
+collection = @typesense.collections['companies'].documents.truncate
 ap collection
 
 # {

data/lib/typesense/analytics_rules.rb

@@ -24,7 +24,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{AnalyticsRules::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+      "#{AnalyticsRules::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
     end
   end
 end

data/lib/typesense/api_call.rb

@@ -85,7 +85,7 @@ module Typesense
               req.body = body
             end
           end
-          set_node_healthcheck(node, is_healthy: true) if response.status >= 1 && response.status <= 499
+          set_node_healthcheck(node, is_healthy: true) if response.status.between?(1, 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}."
 
@@ -96,7 +96,7 @@ module Typesense
                             end
 
           # If response is 2xx return the object, else raise the response as an exception
-          return parsed_response if response.status >= 200 && response.status <= 299
+          return parsed_response if response.status.between?(200, 299)
 
           exception_message = (parsed_response && parsed_response['message']) || 'Error'
           raise custom_exception_klass_for(response), exception_message
@@ -190,7 +190,7 @@ module Typesense
         Typesense::Error::ObjectAlreadyExists.new(response: response)
       elsif response.status == 422
         Typesense::Error::ObjectUnprocessable.new(response: response)
-      elsif response.status >= 500 && response.status <= 599
+      elsif response.status.between?(500, 599)
         Typesense::Error::ServerError.new(response: response)
       elsif response.respond_to?(:timed_out?) && response.timed_out?
         Typesense::Error::TimeoutError.new(response: response)

data/lib/typesense/client.rb

@@ -3,7 +3,7 @@
 module Typesense
   class Client
     attr_reader :configuration, :collections, :aliases, :keys, :debug, :health, :metrics, :stats, :operations,
-                :multi_search, :analytics, :presets, :stemming
+                :multi_search, :analytics, :presets, :stemming, :nl_search_models
 
     def initialize(options = {})
       @configuration = Configuration.new(options)
@@ -20,6 +20,7 @@ module Typesense
       @analytics = Analytics.new(@api_call)
       @stemming = Stemming.new(@api_call)
       @presets = Presets.new(@api_call)
+      @nl_search_models = NlSearchModels.new(@api_call)
     end
   end
 end

data/lib/typesense/documents.rb

@@ -50,7 +50,16 @@ module Typesense
       )
 
       if documents.is_a?(Array)
-        results_in_jsonl_format.split("\n").map { |r| Oj.load(r) }
+        results_in_jsonl_format.split("\n").map do |r|
+          Oj.load(r)
+        rescue Oj::ParseError => e
+          {
+            'success' => false,
+            'exception' => e.class.name,
+            'error' => e.message,
+            'json' => r
+          }
+        end
       else
         results_in_jsonl_format
       end
@@ -79,7 +88,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Documents::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
+      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Documents::RESOURCE_PATH}#{"/#{operation}" unless operation.nil?}"
     end
   end
 end

data/lib/typesense/nl_search_model.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Typesense
+  class NlSearchModel
+    def initialize(model_id, api_call)
+      @model_id = model_id
+      @api_call = api_call
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def update(update_schema)
+      @api_call.put(endpoint_path, update_schema)
+    end
+
+    def delete
+      @api_call.delete(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{NlSearchModels::RESOURCE_PATH}/#{URI.encode_www_form_component(@model_id)}"
+    end
+  end
+end

data/lib/typesense/nl_search_models.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Typesense
+  class NlSearchModels
+    RESOURCE_PATH = '/nl_search_models'
+
+    def initialize(api_call)
+      @api_call = api_call
+      @nl_search_models = {}
+    end
+
+    def create(schema)
+      @api_call.post(RESOURCE_PATH, schema)
+    end
+
+    def retrieve
+      @api_call.get(RESOURCE_PATH)
+    end
+
+    def [](model_id)
+      @nl_search_models[model_id] ||= NlSearchModel.new(model_id, @api_call)
+    end
+  end
+end

data/lib/typesense/overrides.rb

@@ -25,7 +25,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Overrides::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Overrides::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
     end
   end
 end

data/lib/typesense/presets.rb

@@ -24,7 +24,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Presets::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+      "#{Presets::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
     end
   end
 end

data/lib/typesense/stemming_dictionaries.rb

@@ -43,7 +43,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{StemmingDictionaries::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+      "#{StemmingDictionaries::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
     end
   end
 end

data/lib/typesense/synonyms.rb

@@ -25,7 +25,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Synonyms::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Synonyms::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
     end
   end
 end

data/lib/typesense/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typesense
-  VERSION = '3.0.1'
+  VERSION = '3.2.0'
 end

data/lib/typesense.rb

@@ -35,3 +35,5 @@ require_relative 'typesense/error'
 require_relative 'typesense/stemming'
 require_relative 'typesense/stemming_dictionaries'
 require_relative 'typesense/stemming_dictionary'
+require_relative 'typesense/nl_search_models'
+require_relative 'typesense/nl_search_model'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-24 00:00:00.000000000 Z
+date: 2025-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -99,6 +99,8 @@ files:
 - lib/typesense/keys.rb
 - lib/typesense/metrics.rb
 - lib/typesense/multi_search.rb
+- lib/typesense/nl_search_model.rb
+- lib/typesense/nl_search_models.rb
 - lib/typesense/operations.rb
 - lib/typesense/override.rb
 - lib/typesense/overrides.rb