typesense 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eabea293f2c90bcda7240c54cc821d661ed84de8cf8acdd010e0ab664b9f231a
-  data.tar.gz: 20d6adb7c931b511ccac43dab48a894868268e602aafc7659fd43742396052ff
+  metadata.gz: 4b23c932504c838fa3f2e1f81799177bf87ba5ca4707a51166a25ddfe4c4b122
+  data.tar.gz: dc707abbc7a0a9407e0dee23fc93aae5da56cd5c6e9829eae932a578b476d307
 SHA512:
-  metadata.gz: e1f78ab07a2a81ff13fa21b7d9b49c4bf241c694703798fa26091767f0229416a821c91147296dab5c834c0aeaa39e337b395128f0b1b4f6fc7cd3b94bebc664
-  data.tar.gz: cf150fb6a61a3b0586de8d44e94ae38e9968cf59525bbb1dbd003ee96a45230f42bedb6419627e58cedb75bfc0969db10405e859881bbf4b1d7bf5d7bfa0d113
+  metadata.gz: 34d84e8e3f542b1adf96200bef90e35754ffa940a43860e72e9e60fe4cf401cad013678a4a42f0253470af31fbbb9d39e2455ce79971348821b479c751d5073b
+  data.tar.gz: 6afb7470a13190ec849e9ba01c64a4f45866878291afcbb606998f94b97ba21f7fa58656dd8285d3448072476d96c04920f8fabe8f7fe9b7f8d6928d3d482293

data/.github/workflows/tests.yml

@@ -10,10 +10,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.2', '3.3']
+        ruby-version: ['3.0', '3.2', '3.3', '3.4']
     services:
       typesense:
-        image: typesense/typesense:28.0
+        image: typesense/typesense:30.0.alpha1
         ports:
           - 8108:8108
         volumes:

data/Gemfile

@@ -15,7 +15,7 @@ gem 'rake', '~> 13.0'
 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', '1.72.2'
 gem 'rubocop-rspec', '~> 3.6', require: false
 gem 'simplecov', '~> 0.18'
 gem 'timecop', '~> 0.9'

data/README.md

@@ -33,6 +33,7 @@ Tests are also a good place to know how the the library works internally: [spec]
 
 | Typesense Server | typesense-ruby |
 |------------------|----------------|
+| \>= v30.0        | \>= v5.0.0     |
 | \>= v28.0        | \>= v3.0.0     |
 | \>= v0.25.0      | \>= v1.0.0     |
 | \>= v0.23.0      | \>= v0.14.0    |

data/docker-compose.yml

@@ -0,0 +1,18 @@
+services:
+  typesense:
+    image: typesense/typesense:29.0
+    ports:
+      - "127.0.0.1:8108:8108"
+    volumes:
+      - data:/data
+      - analytics:/analytics
+    environment:
+      TYPESENSE_API_KEY: xyz
+      TYPESENSE_DATA_DIR: /data
+      TYPESENSE_ENABLE_CORS: true
+      TYPESENSE_ANALYTICS_DIR: /analytics
+      TYPESENSE_ENABLE_SEARCH_ANALYTICS: true
+
+volumes:
+  data:
+  analytics:

data/lib/typesense/analytics.rb

@@ -11,5 +11,9 @@ module Typesense
     def rules
       @rules ||= AnalyticsRules.new(@api_call)
     end
+
+    def events
+      @events ||= AnalyticsEvents.new(@api_call)
+    end
   end
 end

data/lib/typesense/analytics_events.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Typesense
+  class AnalyticsEvents
+    RESOURCE_PATH = '/analytics/events'
+
+    def initialize(api_call)
+      @api_call = api_call
+    end
+
+    def create(params)
+      @api_call.post(self.class::RESOURCE_PATH, params)
+    end
+
+    def retrieve(params = {})
+      @api_call.get(self.class::RESOURCE_PATH, params)
+    end
+  end
+end

data/lib/typesense/analytics_events_v1.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Typesense
+  class AnalyticsEventsV1
+    RESOURCE_PATH = '/analytics/events'
+
+    def initialize(api_call)
+      @api_call = api_call
+    end
+
+    def create(params)
+      @api_call.post(endpoint_path, params)
+    end
+
+    private
+
+    def endpoint_path(operation = nil)
+      "#{AnalyticsEventsV1::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
+    end
+  end
+end

data/lib/typesense/analytics_rule.rb

@@ -15,6 +15,10 @@ module Typesense
       @api_call.delete(endpoint_path)
     end
 
+    def update(params)
+      @api_call.put(endpoint_path, params)
+    end
+
     private
 
     def endpoint_path

data/lib/typesense/analytics_rule_v1.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Typesense
+  class AnalyticsRuleV1
+    def initialize(rule_name, api_call)
+      @rule_name = rule_name
+      @api_call = api_call
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def delete
+      @api_call.delete(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{AnalyticsRulesV1::RESOURCE_PATH}/#{URI.encode_www_form_component(@rule_name)}"
+    end
+  end
+end

data/lib/typesense/analytics_rules.rb

@@ -5,26 +5,19 @@ module Typesense
     RESOURCE_PATH = '/analytics/rules'
 
     def initialize(api_call)
-      @api_call        = api_call
-      @analytics_rules = {}
+      @api_call = api_call
     end
 
-    def upsert(rule_name, params)
-      @api_call.put(endpoint_path(rule_name), params)
+    def create(rules)
+      @api_call.post(self.class::RESOURCE_PATH, rules)
     end
 
     def retrieve
-      @api_call.get(endpoint_path)
+      @api_call.get(self.class::RESOURCE_PATH)
     end
 
     def [](rule_name)
-      @analytics_rules[rule_name] ||= AnalyticsRule.new(rule_name, @api_call)
-    end
-
-    private
-
-    def endpoint_path(operation = nil)
-      "#{AnalyticsRules::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
+      AnalyticsRule.new(rule_name, @api_call)
     end
   end
 end

data/lib/typesense/analytics_rules_v1.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Typesense
+  class AnalyticsRulesV1
+    RESOURCE_PATH = '/analytics/rules'
+
+    def initialize(api_call)
+      @api_call        = api_call
+      @analytics_rules = {}
+    end
+
+    def upsert(rule_name, params)
+      @api_call.put(endpoint_path(rule_name), params)
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def [](rule_name)
+      @analytics_rules[rule_name] ||= AnalyticsRuleV1.new(rule_name, @api_call)
+    end
+
+    private
+
+    def endpoint_path(operation = nil)
+      "#{AnalyticsRulesV1::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
+    end
+  end
+end

data/lib/typesense/analytics_v1.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Typesense
+  class AnalyticsV1
+    RESOURCE_PATH = '/analytics'
+
+    def initialize(api_call)
+      @api_call = api_call
+    end
+
+    def rules
+      @rules ||= AnalyticsRulesV1.new(@api_call)
+    end
+
+    def events
+      @events ||= AnalyticsEventsV1.new(@api_call)
+    end
+  end
+end

data/lib/typesense/api_call.rb

@@ -112,7 +112,7 @@ module Typesense
           last_exception = e
           @logger.warn "Request #{method}:#{uri_for(endpoint, node)} to Node #{node[:index]} failed due to \"#{e.class}: #{e.message}\""
           @logger.warn "Sleeping for #{@retry_interval_seconds}s and then retrying request..."
-          sleep @retry_interval_seconds
+          sleep @retry_interval_seconds if num_tries <= @num_retries_per_request
         end
       end
       @logger.debug "No retries left. Raising last error \"#{last_exception.class}: #{last_exception.message}\"..."

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, :nl_search_models
+                :multi_search, :analytics, :analytics_v1, :presets, :stemming, :nl_search_models, :synonym_sets, :curation_sets
 
     def initialize(options = {})
       @configuration = Configuration.new(options)
@@ -18,9 +18,12 @@ module Typesense
       @stats = Stats.new(@api_call)
       @operations = Operations.new(@api_call)
       @analytics = Analytics.new(@api_call)
+      @analytics_v1 = AnalyticsV1.new(@api_call)
       @stemming = Stemming.new(@api_call)
       @presets = Presets.new(@api_call)
       @nl_search_models = NlSearchModels.new(@api_call)
+      @synonym_sets = SynonymSets.new(@api_call)
+      @curation_sets = CurationSets.new(@api_call)
     end
   end
 end

data/lib/typesense/curation_set.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Typesense
+  class CurationSet
+    attr_reader :items
+
+    def initialize(curation_set_name, api_call)
+      @curation_set_name = curation_set_name
+      @api_call = api_call
+      @items = CurationSetItems.new(@curation_set_name, @api_call)
+    end
+
+    def upsert(curation_set_data)
+      @api_call.put(endpoint_path, curation_set_data)
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def delete
+      @api_call.delete(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{CurationSets::RESOURCE_PATH}/#{URI.encode_www_form_component(@curation_set_name)}"
+    end
+  end
+end

data/lib/typesense/curation_set_item.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Typesense
+  class CurationSetItem
+    def initialize(curation_set_name, item_id, api_call)
+      @curation_set_name = curation_set_name
+      @item_id = item_id
+      @api_call = api_call
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def upsert(params)
+      @api_call.put(endpoint_path, params)
+    end
+
+    def delete
+      @api_call.delete(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{CurationSets::RESOURCE_PATH}/#{URI.encode_www_form_component(@curation_set_name)}/items/#{URI.encode_www_form_component(@item_id)}"
+    end
+  end
+end

data/lib/typesense/curation_set_items.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Typesense
+  class CurationSetItems
+    def initialize(curation_set_name, api_call)
+      @curation_set_name = curation_set_name
+      @api_call = api_call
+      @items = {}
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def [](item_id)
+      @items[item_id] ||= CurationSetItem.new(@curation_set_name, item_id, @api_call)
+    end
+
+    private
+
+    def endpoint_path(operation = nil)
+      "#{CurationSets::RESOURCE_PATH}/#{URI.encode_www_form_component(@curation_set_name)}/items#{"/#{operation}" unless operation.nil?}"
+    end
+  end
+end

data/lib/typesense/curation_sets.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Typesense
+  class CurationSets
+    RESOURCE_PATH = '/curation_sets'
+
+    def initialize(api_call)
+      @api_call = api_call
+    end
+
+    def upsert(curation_set_name, curation_set_data)
+      @api_call.put("#{self.class::RESOURCE_PATH}/#{URI.encode_www_form_component(curation_set_name)}", curation_set_data)
+    end
+
+    def retrieve
+      @api_call.get(self.class::RESOURCE_PATH)
+    end
+
+    def [](curation_set_name)
+      CurationSet.new(curation_set_name, @api_call)
+    end
+  end
+end

data/lib/typesense/synonym_set.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Typesense
+  class SynonymSet
+    def initialize(synonym_set_name, api_call)
+      @synonym_set_name = synonym_set_name
+      @api_call = api_call
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def delete
+      @api_call.delete(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{SynonymSets::RESOURCE_PATH}/#{URI.encode_www_form_component(@synonym_set_name)}"
+    end
+  end
+end

data/lib/typesense/synonym_sets.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Typesense
+  class SynonymSets
+    RESOURCE_PATH = '/synonym_sets'
+
+    def initialize(api_call)
+      @api_call = api_call
+      @synonym_sets = {}
+    end
+
+    def upsert(synonym_set_name, params)
+      @api_call.put(endpoint_path(synonym_set_name), params)
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def [](synonym_set_name)
+      @synonym_sets[synonym_set_name] ||= SynonymSet.new(synonym_set_name, @api_call)
+    end
+
+    private
+
+    def endpoint_path(operation = nil)
+      "#{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 = '4.0.0'
+  VERSION = '5.0.0'
 end

data/lib/typesense.rb

@@ -16,14 +16,21 @@ require_relative 'typesense/overrides'
 require_relative 'typesense/override'
 require_relative 'typesense/synonyms'
 require_relative 'typesense/synonym'
+require_relative 'typesense/synonym_sets'
+require_relative 'typesense/synonym_set'
 require_relative 'typesense/aliases'
 require_relative 'typesense/alias'
 require_relative 'typesense/keys'
 require_relative 'typesense/key'
 require_relative 'typesense/multi_search'
 require_relative 'typesense/analytics'
+require_relative 'typesense/analytics_events'
 require_relative 'typesense/analytics_rules'
 require_relative 'typesense/analytics_rule'
+require_relative 'typesense/analytics_v1'
+require_relative 'typesense/analytics_events_v1'
+require_relative 'typesense/analytics_rules_v1'
+require_relative 'typesense/analytics_rule_v1'
 require_relative 'typesense/presets'
 require_relative 'typesense/preset'
 require_relative 'typesense/debug'
@@ -37,3 +44,7 @@ require_relative 'typesense/stemming_dictionaries'
 require_relative 'typesense/stemming_dictionary'
 require_relative 'typesense/nl_search_models'
 require_relative 'typesense/nl_search_model'
+require_relative 'typesense/curation_sets'
+require_relative 'typesense/curation_set'
+require_relative 'typesense/curation_set_items'
+require_relative 'typesense/curation_set_item'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-11 00:00:00.000000000 Z
+date: 2026-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -72,6 +72,7 @@ files:
 - bin/console
 - bin/setup
 - codecov.yml
+- docker-compose.yml
 - examples/aliases.rb
 - examples/client_initialization.rb
 - examples/collections_and_documents.rb
@@ -83,13 +84,22 @@ files:
 - lib/typesense/alias.rb
 - lib/typesense/aliases.rb
 - lib/typesense/analytics.rb
+- lib/typesense/analytics_events.rb
+- lib/typesense/analytics_events_v1.rb
 - lib/typesense/analytics_rule.rb
+- lib/typesense/analytics_rule_v1.rb
 - lib/typesense/analytics_rules.rb
+- lib/typesense/analytics_rules_v1.rb
+- lib/typesense/analytics_v1.rb
 - lib/typesense/api_call.rb
 - lib/typesense/client.rb
 - lib/typesense/collection.rb
 - lib/typesense/collections.rb
 - lib/typesense/configuration.rb
+- lib/typesense/curation_set.rb
+- lib/typesense/curation_set_item.rb
+- lib/typesense/curation_set_items.rb
+- lib/typesense/curation_sets.rb
 - lib/typesense/debug.rb
 - lib/typesense/document.rb
 - lib/typesense/documents.rb
@@ -111,6 +121,8 @@ files:
 - lib/typesense/stemming_dictionaries.rb
 - lib/typesense/stemming_dictionary.rb
 - lib/typesense/synonym.rb
+- lib/typesense/synonym_set.rb
+- lib/typesense/synonym_sets.rb
 - lib/typesense/synonyms.rb
 - lib/typesense/version.rb
 - typesense.gemspec