typesense 0.7.0.pre1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3803dbc3cd03bcd1fe38c1d677f69154e8e96440c5854fa0ed55ed96a391f861
-  data.tar.gz: 18879ab944d054d7ae1bbdfedcf12a6df1aaf6afe1ff46c4cbee3689368ebdc4
+  metadata.gz: 2a9a804d053011ec4aed72f8a7a401db1c4a171152d1d171e8de7d2861b9f04e
+  data.tar.gz: cfc7041f6221f8d5ee321b289e38ee82b4ee4d3decceeace13df3ae061cd621a
 SHA512:
-  metadata.gz: bce2e1a2749cfbb67093ac42b41cd5c5c940fde602f9e7f30974396ba182fb61e3352d634be4364a02772e86a4d66b9e4c89d6a07923f0ec0b8d256b40918952
-  data.tar.gz: c0197e8c8f81c655b41dca0be24bfaaf05922774ca327865a46c4f9fdf4512d9e53b60bbff340e211b7c7d683e2434ff1e7a944c2219db8b8dcbeee3c96dbe0a
+  metadata.gz: 2eb9a9633cb01ef642e6a03ac4e98f67128ce47065f37484c108e843f2984be4fe2903841f1c78005cb6f6cc22e145f156bc2b6705c01a562fdcd2f45778c17a
+  data.tar.gz: 20c0869a33ae76f0dcc6a11a3cb32db546d3cc40014403816887a1311e6c54f1fe7e98686550155fb56464385c6d5c28b8e7d387a464dbda931930af83f188af

data/README.md

@@ -33,6 +33,9 @@ Tests are also a good place to know how the the library works internally: [spec]
 
 | Typesense Server | typesense-ruby |
 |------------------|----------------|
+| \>= v0.18.0 | \>= v0.10.0 |
+| \>= v0.17.0 | \>= v0.9.0 |
+| \>= v0.16.0 | \>= v0.8.0 |
 | \>= v0.15.0 | \>= v0.7.0 |
 | \>= v0.12.1 | \>= v0.5.0 |
 | \>= v0.12.0 | \>= v0.4.0 |

data/examples/aliases.rb

@@ -2,8 +2,6 @@
 
 ##
 # These examples walk you through operations specifically related to aliases
-# # This is a Typesense Premium feature (see: https://typesense.org/premium)
-# Be sure to add `--license-key=<>` as a parameter, when starting a Typesense Premium server
 
 require_relative './client_initialization'
 

data/examples/client_initialization.rb

@@ -12,7 +12,7 @@ AwesomePrint.defaults = {
 ## Setup
 #
 ### Option 1: Start a single-node cluster
-#     $ docker run -i -p 8108:8108 -v/tmp/typesense-server-data-1b/:/data -v`pwd`/typesense-server-peers:/typesense-server-peers typesense/typesense:0.12.1.rc1 --data-dir /data --api-key=xyz --listen-port 8108 --enable-cors
+#     $ docker run -i -p 8108:8108 -v/tmp/typesense-server-data-1b/:/data -v`pwd`/typesense-server-peers:/typesense-server-peers typesense/typesense:0.18.0 --data-dir /data --api-key=xyz --listen-port 8108 --enable-cors
 #
 ### Option 2: Start a 3-node cluster
 #
@@ -20,13 +20,13 @@ AwesomePrint.defaults = {
 #   $ echo '172.17.0.2:8107:8108,172.17.0.3:7107:7108,172.17.0.4:9107:9108' > `pwd`/typesense-server-peers
 #
 # Start node 1:
-#   $ docker run -i -p 8108:8108 -p 8107:8107 -v/tmp/typesense-server-data-1b/:/data -v`pwd`/typesense-server-peers:/typesense-server-peers typesense/typesense:0.12.1.rc1 --data-dir /data --api-key=xyz --listen-port 8108 --peering-port 8107 --enable-cors --nodes=/typesense-server-peers
+#   $ docker run -i -p 8108:8108 -p 8107:8107 -v/tmp/typesense-server-data-1b/:/data -v`pwd`/typesense-server-peers:/typesense-server-peers typesense/typesense:0.18.0 --data-dir /data --api-key=xyz --listen-port 8108 --peering-port 8107 --enable-cors --nodes=/typesense-server-peers
 #
 # Start node 2:
-#   $ docker run -i -p 7108:7108 -p 7107:7107 -v/tmp/.typesense-server-data-2b/:/data -v`pwd`/typesense-server-peers:/typesense-server-peers typesense/typesense:0.12.1.rc1 --data-dir /data --api-key=xyz --listen-port 7108 --peering-port 7107 --enable-cors --nodes=/typesense-server-peers
+#   $ docker run -i -p 7108:7108 -p 7107:7107 -v/tmp/.typesense-server-data-2b/:/data -v`pwd`/typesense-server-peers:/typesense-server-peers typesense/typesense:0.18.0 --data-dir /data --api-key=xyz --listen-port 7108 --peering-port 7107 --enable-cors --nodes=/typesense-server-peers
 #
 # Start node 3:
-#   $ docker run -i -p 9108:9108 -p 9107:9107 -v/tmp/.typesense-server-data-3b/:/data -v`pwd`/typesense-server-peers:/typesense-server-peers typesense/typesense:0.12.1.rc1 --data-dir /data --api-key=xyz --listen-port 9108 --peering-port 9107 --enable-cors --nodes=/typesense-server-peers
+#   $ docker run -i -p 9108:9108 -p 9107:9107 -v/tmp/.typesense-server-data-3b/:/data -v`pwd`/typesense-server-peers:/typesense-server-peers typesense/typesense:0.18.0 --data-dir /data --api-key=xyz --listen-port 9108 --peering-port 9107 --enable-cors --nodes=/typesense-server-peers
 #
 # Note: Be sure to add `--license-key=<>` at the end when starting a Typesense Premium server
 
@@ -38,31 +38,31 @@ AwesomePrint.defaults = {
       host: 'localhost',
       port: 8108,
       protocol: 'http'
-    },
-    # Uncomment if starting a 3-node cluster, using Option 2 under Setup instructions above
-    {
-      host: 'localhost',
-      port: 7108,
-      protocol: 'http'
-    },
-    {
-      host: 'localhost',
-      port: 9108,
-      protocol: 'http'
     }
+    # Uncomment if starting a 3-node cluster, using Option 2 under Setup instructions above
+    # {
+    #   host: 'localhost',
+    #   port: 7108,
+    #   protocol: 'http'
+    # },
+    # {
+    #   host: 'localhost',
+    #   port: 9108,
+    #   protocol: 'http'
+    # }
   ],
   # If this optional key is specified, requests are always sent to this node first if it is healthy
   #   before falling back on the nodes mentioned in the `nodes` key. This is useful when running a distributed set of search clusters.
-  'nearest_node': {
-    'host': 'localhost',
-    'port': '8108',
-    'protocol': 'http'
-  },
+  # 'nearest_node': {
+  #   'host': 'localhost',
+  #   'port': '8108',
+  #   'protocol': 'http'
+  # },
   api_key: 'xyz',
   num_retries: 10,
   healthcheck_interval_seconds: 1,
   retry_interval_seconds: 0.01,
   connection_timeout_seconds: 10,
   logger: Logger.new($stdout),
-  log_level: Logger::DEBUG
+  log_level: Logger::INFO
 )

data/examples/collections_and_documents.rb

@@ -167,6 +167,10 @@ ap document
 #   "num_employees" => 5215
 # }
 
+# You can also upsert a document, which will update the document if it already exists or create a new one if it doesn't exist
+document = @typesense.collections['companies'].documents.upsert(document)
+ap document
+
 ##
 # Retrieve a document
 sleep 0.5 # Give Typesense cluster a few hundred ms to create the document on all nodes, before reading it right after (eventually consistent)
@@ -180,6 +184,25 @@ ap document
 #   "num_employees" => 5215
 # }
 
+##
+# Update a document. Unlike upsert, update will error out if the doc doesn't already exist.
+document = @typesense.collections['companies'].documents['124'].update(
+  'id' => 1,
+  'num_employees' => 5500
+)
+ap document
+
+# {
+#   "id"            => "124",
+#   "num_employees" => 5500
+# }
+
+# This should error out, since document 145 doesn't exist
+# document = @typesense.collections['companies'].documents['145'].update(
+#   'num_employees' => 5500
+# )
+# ap document
+
 ##
 # Delete a document
 #   Deleting a document, returns the document after deletion
@@ -208,11 +231,36 @@ documents = [
     'country' => 'France'
   }
 ]
-ap @typesense.collections['companies'].documents.create_many(documents)
+ap @typesense.collections['companies'].documents.import(documents)
 
-## If you already have documents in JSONL format, you can also use #import instead, to avoid the JSON parsing overhead:
+## If you already have documents in JSONL format, you can also pass it directly to #import, to avoid the JSON parsing overhead:
 # @typesense.collections['companies'].documents.import(documents_in_jsonl_format)
 
+## You can bulk upsert documents, by adding an upsert action option to #import
+documents << {
+  'id' => '126',
+  'company_name' => 'Stark Industries 2',
+  'num_employees' => 200,
+  'country' => 'USA'
+}
+ap @typesense.collections['companies'].documents.import(documents, action: :upsert)
+
+## You can bulk update documents, by adding an update action option to #import
+# `action: update` will throw an error if the document doesn't already exist
+# This document will error out, since id: 1200 doesn't exist
+documents << {
+  'id' => '1200',
+  'country' => 'USA'
+}
+documents << {
+  'id' => '126',
+  'num_employees' => 300
+}
+ap @typesense.collections['companies'].documents.import(documents, action: :update)
+
+## You can also bulk delete documents, using filter_by fields:
+ap @typesense.collections['companies'].documents.delete(filter_by: 'num_employees:>100')
+
 ##
 # Export all documents in a collection in JSON Lines format
 #   We use JSON Lines format for performance reasons. You can choose to parse selected lines as needed, by splitting on \n.

data/examples/overrides.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 ##
-# These examples walk you through operations specifically related to overrides
-# This is a Typesense Premium feature (see: https://typesense.org/premium)
-# Be sure to add `--license-key=<>` as a parameter, when starting a Typesense Premium server
+# These examples walk you through operations specifically related to result overrides / curation
 
 require_relative './client_initialization'
 
+# Delete the collection if it already exists
+begin
+  @typesense.collections['companies'].delete
+rescue Typesense::Error::ObjectNotFound
+end
+
 ##
 # Create a collection
 schema = {
@@ -63,16 +67,16 @@ schema = {
 ##
 # Create overrides
 
-@typesense.collections['companies'].overrides.create(
-  "id": 'promote-doofenshmirtz',
+@typesense.collections['companies'].overrides.upsert(
+  'promote-doofenshmirtz',
   "rule": {
     "query": 'doofen',
     "match": 'exact'
   },
   "includes": [{ 'id' => '126', 'position' => 1 }]
 )
-@typesense.collections['companies'].overrides.create(
-  "id": 'promote-acme',
+@typesense.collections['companies'].overrides.upsert(
+  'promote-acme',
   "rule": {
     "query": 'stark',
     "match": 'exact'

data/examples/synonyms.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+##
+# These examples walk you through operations specifically related to synonyms
+
+require_relative './client_initialization'
+
+# Delete the collection if it already exists
+begin
+  @typesense.collections['companies'].delete
+rescue Typesense::Error::ObjectNotFound
+end
+
+##
+# Create a collection
+schema = {
+  'name' => 'companies',
+  'fields' => [
+    {
+      'name' => 'company_name',
+      'type' => 'string'
+    },
+    {
+      'name' => 'num_employees',
+      'type' => 'int32'
+    },
+    {
+      'name' => 'country',
+      'type' => 'string',
+      'facet' => true
+    }
+  ],
+  'default_sorting_field' => 'num_employees'
+}
+
+@typesense.collections.create(schema)
+
+# Let's create a couple documents for us to use in our search examples
+@typesense.collections['companies'].documents.create(
+  'id' => '124',
+  'company_name' => 'Stark Industries',
+  'num_employees' => 5215,
+  'country' => 'USA'
+)
+
+@typesense.collections['companies'].documents.create(
+  'id' => '127',
+  'company_name' => 'Stark Corp',
+  'num_employees' => 1031,
+  'country' => 'USA'
+)
+
+@typesense.collections['companies'].documents.create(
+  'id' => '125',
+  'company_name' => 'Acme Corp',
+  'num_employees' => 1002,
+  'country' => 'France'
+)
+
+@typesense.collections['companies'].documents.create(
+  'id' => '126',
+  'company_name' => 'Doofenshmirtz Inc',
+  'num_employees' => 2,
+  'country' => 'Tri-State Area'
+)
+
+##
+# Create synonyms
+
+ap @typesense.collections['companies'].synonyms.upsert(
+  'synonyms-doofenshmirtz',
+  {
+    'synonyms' => %w[Doofenshmirtz Heinz Evil]
+  }
+)
+
+##
+# Search for documents
+# Should return Doofenshmirtz Inc, since it's set as a synonym
+results = @typesense.collections['companies'].documents.search(
+  'q' => 'Heinz',
+  'query_by' => 'company_name'
+)
+ap results
+
+##
+# List all synonyms
+ap @typesense.collections['companies'].synonyms.retrieve
+
+##
+# Retrieve specific synonym
+ap @typesense.collections['companies'].synonyms['synonyms-doofenshmirtz'].retrieve
+
+##
+# Update synonym to a one-way synonym
+ap @typesense.collections['companies'].synonyms.upsert(
+  'synonyms-doofenshmirtz',
+  {
+    'root' => 'Evil',
+    'synonyms' => %w[Doofenshmirtz Heinz]
+  }
+)
+
+##
+# Search for documents
+# Should return Doofenshmirtz Inc, since it's set as a synonym
+results = @typesense.collections['companies'].documents.search(
+  'q' => 'Evil',
+  'query_by' => 'company_name'
+)
+ap results
+
+# Should not return any results, since this is a one-way synonym
+results = @typesense.collections['companies'].documents.search(
+  'q' => 'Heinz',
+  'query_by' => 'company_name'
+)
+ap results
+
+##
+# Delete synonym
+ap @typesense.collections['companies'].synonyms['synonyms-doofenshmirtz'].delete
+
+##
+# Cleanup
+# Drop the collection
+@typesense.collections['companies'].delete

data/lib/typesense.rb

@@ -13,6 +13,8 @@ require_relative 'typesense/documents'
 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'
@@ -20,4 +22,5 @@ require_relative 'typesense/key'
 require_relative 'typesense/debug'
 require_relative 'typesense/health'
 require_relative 'typesense/metrics'
+require_relative 'typesense/operations'
 require_relative 'typesense/error'

data/lib/typesense/api_call.rb

@@ -7,6 +7,8 @@ module Typesense
   class ApiCall
     API_KEY_HEADER_NAME = 'X-TYPESENSE-API-KEY'
 
+    attr_reader :logger
+
     def initialize(configuration)
       @configuration = configuration
 
@@ -24,43 +26,40 @@ module Typesense
       @current_node_index = -1
     end
 
-    def post(endpoint, parameters = {})
-      headers, body = extract_headers_and_body_from(parameters)
-
+    def post(endpoint, body_parameters = {}, query_parameters = {})
       perform_request :post,
                       endpoint,
-                      headers,
-                      body: body
+                      query_parameters: query_parameters,
+                      body_parameters: body_parameters
     end
 
-    def put(endpoint, parameters = {})
-      headers, body = extract_headers_and_body_from(parameters)
+    def patch(endpoint, body_parameters = {}, query_parameters = {})
+      perform_request :patch,
+                      endpoint,
+                      query_parameters: query_parameters,
+                      body_parameters: body_parameters
+    end
 
+    def put(endpoint, body_parameters = {}, query_parameters = {})
       perform_request :put,
                       endpoint,
-                      headers,
-                      body: body
+                      query_parameters: query_parameters,
+                      body_parameters: body_parameters
     end
 
-    def get(endpoint, parameters = {})
-      headers, query = extract_headers_and_query_from(parameters)
-
+    def get(endpoint, query_parameters = {})
       perform_request :get,
                       endpoint,
-                      headers,
-                      params: query
+                      query_parameters: query_parameters
     end
 
-    def delete(endpoint, parameters = {})
-      headers, query = extract_headers_and_query_from(parameters)
-
+    def delete(endpoint, query_parameters = {})
       perform_request :delete,
                       endpoint,
-                      headers,
-                      params: query
+                      query_parameters: query_parameters
     end
 
-    def perform_request(method, endpoint, headers = {}, options = {})
+    def perform_request(method, endpoint, query_parameters: nil, body_parameters: nil, additional_headers: {})
       @configuration.validate!
       last_exception = nil
       @logger.debug "Performing #{method.to_s.upcase} request: #{endpoint}"
@@ -70,15 +69,23 @@ module Typesense
         @logger.debug "Attempting #{method.to_s.upcase} request Try ##{num_tries} to Node #{node[:index]}"
 
         begin
-          response = Typhoeus::Request.new(uri_for(endpoint, node),
-                                           {
-                                             method: method,
-                                             headers: default_headers.merge(headers),
-                                             timeout: @connection_timeout_seconds
-                                           }.merge(options)).run
+          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)
+          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
 
-          @logger.debug "Request to Node #{node[:index]} was successfully made (at the network layer). Response Code was #{response.code}."
+          @logger.debug "Request #{method}:#{uri_for(endpoint, node)} to Node #{node[:index]} was successfully made (at the network layer). Response Code was #{response.code}."
 
           parsed_response = if response.headers && (response.headers['content-type'] || '').include?('application/json')
                               Oj.load(response.body)
@@ -99,7 +106,7 @@ module Typesense
           #   other languages that might not support the same construct.
           set_node_healthcheck(node, is_healthy: false)
           last_exception = e
-          @logger.warn "Request to Node #{node[:index]} failed due to \"#{e.class}: #{e.message}\""
+          @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
         end
@@ -110,41 +117,6 @@ module Typesense
 
     private
 
-    def extract_headers_and_body_from(parameters)
-      if json_request?(parameters)
-        headers = { 'Content-Type' => 'application/json' }
-        body = Oj.dump(sanitize_parameters(parameters))
-      else
-        headers = {}
-        body = parameters[:body]
-      end
-      [headers, body]
-    end
-
-    def extract_headers_and_query_from(parameters)
-      if json_request?(parameters)
-        headers = { 'Content-Type' => 'application/json' }
-        query = sanitize_parameters(parameters)
-      else
-        headers = {}
-        query = parameters[:query]
-      end
-      [headers, query]
-    end
-
-    def json_request?(parameters)
-      parameters[:as_json].nil? ? true : parameters[:as_json]
-    end
-
-    def sanitize_parameters(parameters)
-      sanitized_parameters = parameters.dup
-      sanitized_parameters.delete(:as_json)
-      sanitized_parameters.delete(:body)
-      sanitized_parameters.delete(:query)
-
-      sanitized_parameters
-    end
-
     def uri_for(endpoint, node)
       "#{node[:protocol]}://#{node[:host]}:#{node[:port]}#{endpoint}"
     end
@@ -227,6 +199,7 @@ module Typesense
 
     def default_headers
       {
+        'Content-Type' => 'application/json',
         API_KEY_HEADER_NAME.to_s => @api_key,
         'User-Agent' => 'Typesense Ruby Client'
       }

data/lib/typesense/client.rb

@@ -2,7 +2,7 @@
 
 module Typesense
   class Client
-    attr_reader :configuration, :collections, :aliases, :keys, :debug, :health, :metrics
+    attr_reader :configuration, :collections, :aliases, :keys, :debug, :health, :metrics, :operations
 
     def initialize(options = {})
       @configuration = Configuration.new(options)
@@ -13,6 +13,7 @@ module Typesense
       @debug = Debug.new(@api_call)
       @health = Health.new(@api_call)
       @metrics = Metrics.new(@api_call)
+      @operations = Operations.new(@api_call)
     end
   end
 end

data/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

data/lib/typesense/document.rb

@@ -16,6 +16,10 @@ module Typesense
       @api_call.delete(endpoint_path)
     end
 
+    def update(partial_document)
+      @api_call.patch(endpoint_path, partial_document)
+    end
+
     private
 
     def endpoint_path

data/lib/typesense/documents.rb

@@ -16,14 +16,40 @@ module Typesense
       @api_call.post(endpoint_path, document)
     end
 
-    def create_many(documents)
-      documents_in_jsonl_format = documents.map { |document| Oj.dump(document) }.join("\n")
-      results_in_jsonl_format = import(documents_in_jsonl_format)
-      results_in_jsonl_format.split("\n").map { |r| Oj.load(r) }
+    def upsert(document)
+      @api_call.post(endpoint_path, document, action: :upsert)
     end
 
-    def import(documents_in_jsonl_format)
-      @api_call.post(endpoint_path('import'), as_json: false, body: documents_in_jsonl_format)
+    def update(document)
+      @api_call.post(endpoint_path, document, action: :update)
+    end
+
+    def create_many(documents, options = {})
+      @api_call.logger.warn('#create_many is deprecated and will be removed in a future version. Use #import instead, which now takes both an array of documents or a JSONL string of documents')
+      import(documents, options)
+    end
+
+    # @param [Array,String] documents An array of document hashes or a JSONL string of documents.
+    def import(documents, options = {})
+      documents_in_jsonl_format = if documents.is_a?(Array)
+                                    documents.map { |document| Oj.dump(document) }.join("\n")
+                                  else
+                                    documents
+                                  end
+
+      results_in_jsonl_format = @api_call.perform_request(
+        'post',
+        endpoint_path('import'),
+        query_parameters: options,
+        body_parameters: documents_in_jsonl_format,
+        additional_headers: { 'Content-Type' => 'text/plain' }
+      )
+
+      if documents.is_a?(Array)
+        results_in_jsonl_format.split("\n").map { |r| Oj.load(r) }
+      else
+        results_in_jsonl_format
+      end
     end
 
     def export
@@ -38,6 +64,10 @@ module Typesense
       @documents[document_id] ||= Document.new(@collection_name, document_id, @api_call)
     end
 
+    def delete(query_parameters = {})
+      @api_call.delete(endpoint_path, query_parameters)
+    end
+
     private
 
     def endpoint_path(operation = nil)

data/lib/typesense/keys.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'base64'
+require 'json'
+require 'openssl'
 
 module Typesense
   class Keys

data/lib/typesense/operations.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Operations
+    RESOURCE_PATH = '/operations'
+
+    def initialize(api_call)
+      @api_call = api_call
+    end
+
+    def perform(operation_name, query_params = {})
+      @api_call.post("#{RESOURCE_PATH}/#{operation_name}", {}, query_params)
+    end
+  end
+end

data/lib/typesense/overrides.rb

@@ -10,8 +10,8 @@ module Typesense
       @overrides       = {}
     end
 
-    def create(params)
-      @api_call.put(endpoint_path, params)
+    def upsert(override_id, params)
+      @api_call.put(endpoint_path(override_id), params)
     end
 
     def retrieve

data/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

data/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

data/lib/typesense/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typesense
-  VERSION = '0.7.0.pre1'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 0.7.0.pre1
+  version: 0.10.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -274,6 +274,7 @@ files:
 - examples/keys.rb
 - examples/overrides.rb
 - examples/search.rb
+- examples/synonyms.rb
 - lib/typesense.rb
 - lib/typesense/alias.rb
 - lib/typesense/aliases.rb
@@ -290,8 +291,11 @@ files:
 - lib/typesense/key.rb
 - lib/typesense/keys.rb
 - lib/typesense/metrics.rb
+- lib/typesense/operations.rb
 - lib/typesense/override.rb
 - lib/typesense/overrides.rb
+- lib/typesense/synonym.rb
+- lib/typesense/synonyms.rb
 - lib/typesense/version.rb
 - typesense.gemspec
 homepage: https://typesense.org
@@ -309,9 +313,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.6
 signing_key: