Support for synonyms

Author: jasonbosco

lib/typesense.rb

@@ -13,6 +13,8 @@ module Typesense
 require_relative 'typesense/document'
 require_relative 'typesense/overrides'
 require_relative 'typesense/override'
+require_relative 'typesense/synonyms'
+require_relative 'typesense/synonym'
 require_relative 'typesense/aliases'
 require_relative 'typesense/alias'
 require_relative 'typesense/keys'

lib/typesense/collection.rb

@@ -2,13 +2,14 @@
 
 module Typesense
   class Collection
-    attr_reader :documents, :overrides
+    attr_reader :documents, :overrides, :synonyms
 
     def initialize(name, api_call)
       @name      = name
       @api_call  = api_call
       @documents = Documents.new(@name, @api_call)
       @overrides = Overrides.new(@name, @api_call)
+      @synonyms = Synonyms.new(@name, @api_call)
     end
 
     def retrieve

lib/typesense/synonym.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Synonym
+    def initialize(collection_name, synonym_id, api_call)
+      @collection_name = collection_name
+      @synonym_id = synonym_id
+      @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
+      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Synonyms::RESOURCE_PATH}/#{@synonym_id}"
+    end
+  end
+end

lib/typesense/synonyms.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Synonyms
+    RESOURCE_PATH = '/synonyms'
+
+    def initialize(collection_name, api_call)
+      @collection_name = collection_name
+      @api_call        = api_call
+      @synonyms = {}
+    end
+
+    def upsert(synonym_id, params)
+      @api_call.put(endpoint_path(synonym_id), params)
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def [](synonym_id)
+      @synonyms[synonym_id] ||= Synonym.new(@collection_name, synonym_id, @api_call)
+    end
+
+    private
+
+    def endpoint_path(operation = nil)
+      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Synonyms::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
+    end
+  end
+end