feat!: add v30 api breaking changes

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
         ruby-version: ['3.0', '3.2', '3.3', '3.4']
     services:
       typesense:
-        image: typesense/typesense:29.0
+        image: typesense/typesense:30.0.alpha1
         ports:
           - 8108:8108
         volumes:

lib/typesense.rb

@@ -16,14 +16,21 @@ module Typesense
 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 @@ module Typesense
 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'

lib/typesense/analytics.rb

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

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

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

lib/typesense/analytics_rule.rb

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

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

lib/typesense/analytics_rules.rb

@@ -5,26 +5,27 @@ class AnalyticsRules
     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)
+      AnalyticsRule.new(rule_name, @api_call)
     end
 
-    private
+    def respond_to_missing?(_method_name, _include_private = false)
+      true
+    end
 
-    def endpoint_path(operation = nil)
-      "#{AnalyticsRules::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
+    def method_missing(method_name, *_args, &_block)
+      self[method_name.to_s]
     end
   end
 end

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

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

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 @@ def initialize(options = {})
       @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

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

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

lib/typesense/curation_set_items.rb

@@ -0,0 +1,33 @@
+# 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
+
+    def respond_to_missing?(_method_name, _include_private = false)
+      true
+    end
+
+    def method_missing(method_name, *_args, &_block)
+      self[method_name.to_s]
+    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

lib/typesense/curation_sets.rb

@@ -0,0 +1,31 @@
+# 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
+
+    def respond_to_missing?(_method_name, _include_private = false)
+      true
+    end
+
+    def method_missing(method_name, *_args, &_block)
+      self[method_name.to_s]
+    end
+  end
+end

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