typesense 0.8.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5acfb1b3cbcfd880a7d8fa39a759ad2cb82396e159cdac02d64e72a4047ca264
-  data.tar.gz: 1e6d7ca55d559a86842e79e4ffb4db18327206e78c45ff039ff2a8fa59822a7b
+  metadata.gz: 8f2e50916953345869d9eb5e057391d24804ae2ecb95691b288f5b785cb95a32
+  data.tar.gz: a6bb310461509606774d6e6f28bdffabd1a1d201ac76900cac7287222393f227
 SHA512:
-  metadata.gz: 9fa4e3d1155043c18f873ee936eb5bf223d7faac05f99d311afaab9dd49faf2ba9088cf274c6c7402742422d951900f52626480f139949b6ad25e2245ba2f287
-  data.tar.gz: fe7fe260705cab7bf02dd0ebf28395860ce27a047e7ff8687c4fed5cbc4baf8aa4f79be4fb2ba08897b0f50eaa6861a9d9b9f4a7647ad959a8387c563b1c1c69
+  metadata.gz: 16f9981c8589b1c8a5d49dafa47af5888946ec3f39d53841e9c8aae41e89b2222fcf0880e8191a63c73f8f11bb248559615409ebb0355d0e39d88dab9d7928d0
+  data.tar.gz: 2314065984eb1f5419d80e4f65dc1e23c4ac2250211aa57579f872c275311e4caa73adbb3576d4f5b20a73bbe2de7258e7ff60bcc1ce8ce9d963c5f7c49f67f0

data/.gitignore

@@ -15,3 +15,4 @@ typesense-server-peers
 
 # rspec failure tracking
 .rspec_status
+typesense-data

data/README.md

@@ -33,6 +33,10 @@ Tests are also a good place to know how the the library works internally: [spec]
 
 | Typesense Server | typesense-ruby |
 |------------------|----------------|
+| \>= v0.20.0 | \>= v0.12.0 |
+| \>= v0.19.0 | \>= v0.11.0 |
+| \>= 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 |

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.19.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.19.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.19.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.19.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
 
@@ -64,5 +64,5 @@ AwesomePrint.defaults = {
   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

@@ -258,6 +258,9 @@ documents << {
 }
 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/search.rb

@@ -73,37 +73,6 @@ results = @typesense.collections['companies'].documents.search(
 )
 ap results
 
-# {
-#   "facet_counts"   => [],
-#   "found"          => 2,
-#   "hits"           => [
-#     [0] {
-#       "document"  => {
-#         "company_name"  => "Stark Industries",
-#         "country"       => "USA",
-#         "id"            => "124",
-#         "num_employees" => 5215
-#       },
-#       "highlight" => {
-#         "company_name" => "<mark>Stark</mark> Industries"
-#       }
-#     },
-#     [1] {
-#       "document"  => {
-#         "company_name"  => "Stark Corp",
-#         "country"       => "USA",
-#         "id"            => "127",
-#         "num_employees" => 1031
-#       },
-#       "highlight" => {
-#         "company_name" => "<mark>Stark</mark> Corp"
-#       }
-#     }
-#   ],
-#   "page"           => 1,
-#   "search_time_ms" => 0
-# }
-
 ##
 # Search for more documents
 results = @typesense.collections['companies'].documents.search(
@@ -114,25 +83,28 @@ results = @typesense.collections['companies'].documents.search(
 )
 ap results
 
-# {
-#   "facet_counts"   => [],
-#   "found"          => 1,
-#   "hits"           => [
-#     [0] {
-#       "document"  => {
-#         "company_name"  => "Doofenshmirtz Inc",
-#         "country"       => "Tri-State Area",
-#         "id"            => "126",
-#         "num_employees" => 2
-#       },
-#       "highlight" => {
-#         "company_name" => "Doofenshmirtz <mark>Inc</mark>"
-#       }
-#     }
-#   ],
-#   "page"           => 1,
-#   "search_time_ms" => 0
-# }
+##
+# Search for more multiple documents
+results = @typesense.multi_search.perform(
+  {
+    searches: [
+      {
+        'q' => 'Inc',
+        'filter_by' => 'num_employees:<100',
+        'sort_by' => 'num_employees:desc'
+      },
+      {
+        'q' => 'Stark'
+      }
+    ]
+  },
+  {
+    # Parameters that are common to all searches, can be mentioned here
+    'collection' => 'companies',
+    'query_by' => 'company_name'
+  }
+)
+ap results
 
 ##
 # Search for more documents
@@ -142,13 +114,6 @@ results = @typesense.collections['companies'].documents.search(
 )
 ap results
 
-# {
-#   "found"          => 0,
-#   "hits"           => [],
-#   "page"           => 1,
-#   "search_time_ms" => 0
-# }
-
 ##
 # Cleanup
 # Drop the collection

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,11 +13,15 @@ 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'
 require_relative 'typesense/key'
+require_relative 'typesense/multi_search'
 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

@@ -78,7 +78,7 @@ module Typesense
 
           unless body_parameters.nil?
             body = body_parameters
-            body = Oj.dump(body_parameters) if request_options[:headers]['Content-Type'] == 'application/json'
+            body = Oj.dump(body_parameters, mode: :compat) if request_options[:headers]['Content-Type'] == 'application/json'
             request_options.merge!(body: body)
           end
 
@@ -177,23 +177,23 @@ module Typesense
 
     def custom_exception_klass_for(response)
       if response.code == 400
-        Typesense::Error::RequestMalformed
+        Typesense::Error::RequestMalformed.new(response: response)
       elsif response.code == 401
-        Typesense::Error::RequestUnauthorized
+        Typesense::Error::RequestUnauthorized.new(response: response)
       elsif response.code == 404
-        Typesense::Error::ObjectNotFound
+        Typesense::Error::ObjectNotFound.new(response: response)
       elsif response.code == 409
-        Typesense::Error::ObjectAlreadyExists
+        Typesense::Error::ObjectAlreadyExists.new(response: response)
       elsif response.code == 422
-        Typesense::Error::ObjectUnprocessable
+        Typesense::Error::ObjectUnprocessable.new(response: response)
       elsif response.code >= 500 && response.code <= 599
-        Typesense::Error::ServerError
+        Typesense::Error::ServerError.new(response: response)
       elsif response.timed_out?
-        Typesense::Error::TimeoutError
+        Typesense::Error::TimeoutError.new(response: response)
       elsif response.code.zero?
-        Typesense::Error::HTTPStatus0Error
+        Typesense::Error::HTTPStatus0Error.new(response: response)
       else
-        Typesense::Error::HTTPError
+        Typesense::Error::HTTPError.new(response: response)
       end
     end
 

data/lib/typesense/client.rb

@@ -2,7 +2,8 @@
 
 module Typesense
   class Client
-    attr_reader :configuration, :collections, :aliases, :keys, :debug, :health, :metrics
+    attr_reader :configuration, :collections, :aliases, :keys, :debug, :health, :metrics, :operations,
+                :multi_search
 
     def initialize(options = {})
       @configuration = Configuration.new(options)
@@ -10,9 +11,11 @@ module Typesense
       @collections = Collections.new(@api_call)
       @aliases = Aliases.new(@api_call)
       @keys = Keys.new(@api_call)
+      @multi_search = MultiSearch.new(@api_call)
       @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,8 +16,8 @@ module Typesense
       @api_call.delete(endpoint_path)
     end
 
-    def update(partial_document)
-      @api_call.patch(endpoint_path, partial_document)
+    def update(partial_document, options = {})
+      @api_call.patch(endpoint_path, partial_document, options)
     end
 
     private

data/lib/typesense/documents.rb

@@ -12,16 +12,16 @@ module Typesense
       @documents       = {}
     end
 
-    def create(document)
-      @api_call.post(endpoint_path, document)
+    def create(document, options = {})
+      @api_call.post(endpoint_path, document, options)
     end
 
-    def upsert(document)
-      @api_call.post(endpoint_path, document, action: :upsert)
+    def upsert(document, options = {})
+      @api_call.post(endpoint_path, document, options.merge(action: :upsert))
     end
 
-    def update(document)
-      @api_call.post(endpoint_path, document, action: :update)
+    def update(document, options = {})
+      @api_call.post(endpoint_path, document, options.merge(action: :update))
     end
 
     def create_many(documents, options = {})
@@ -64,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/error.rb

@@ -2,6 +2,14 @@
 
 module Typesense
   class Error < StandardError
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+
+      super
+    end
+
     class MissingConfiguration < Error
     end
 

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/multi_search.rb

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

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.8.0'
+  VERSION = '0.12.0'
 end

data/typesense.gemspec

@@ -40,6 +40,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'timecop', '~> 0.9'
   spec.add_development_dependency 'webmock', '~> 3.8'
 
-  spec.add_dependency 'oj', '~> 3.10'
+  spec.add_dependency 'oj', '~> 3.11'
   spec.add_dependency 'typhoeus', '~> 1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -226,14 +226,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -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,12 @@ files:
 - lib/typesense/key.rb
 - lib/typesense/keys.rb
 - lib/typesense/metrics.rb
+- lib/typesense/multi_search.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