typesense 0.10.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a9a804d053011ec4aed72f8a7a401db1c4a171152d1d171e8de7d2861b9f04e
-  data.tar.gz: cfc7041f6221f8d5ee321b289e38ee82b4ee4d3decceeace13df3ae061cd621a
+  metadata.gz: e06b23f04adf0d96e94901c079d8be9f5f353fab0a6f0f7ef69c3f47022f3941
+  data.tar.gz: c0a6d81b8af2acaba1a071d4ac3dd555ec0b710df82ff25421db1e10670575ff
 SHA512:
-  metadata.gz: 2eb9a9633cb01ef642e6a03ac4e98f67128ce47065f37484c108e843f2984be4fe2903841f1c78005cb6f6cc22e145f156bc2b6705c01a562fdcd2f45778c17a
-  data.tar.gz: 20c0869a33ae76f0dcc6a11a3cb32db546d3cc40014403816887a1311e6c54f1fe7e98686550155fb56464385c6d5c28b8e7d387a464dbda931930af83f188af
+  metadata.gz: 124612023259c23c58b13331db5da50782b11cf344451d8697c3463ea2c592bdd4a24f39a6267e8da23811980ce94b9863d75f7b872678be8f7b9a675c13f943
+  data.tar.gz: 6e3f8e2930653f49ba48c9965bbfabf49982faf6447fe588143d29a9acf080be2900afb1188f17f5054f13e3107f56a265e413c5caae5e8b4e4d01511e87e8cf

data/.gitignore

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

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.21.0 | \>= v0.13.0 |
+| \>= 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 |

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.18.0 --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.18.0 --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.18.0 --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.18.0 --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
 

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/lib/typesense.rb

@@ -19,6 +19,7 @@ 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'

data/lib/typesense/api_call.rb

@@ -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, :operations
+    attr_reader :configuration, :collections, :aliases, :keys, :debug, :health, :metrics, :operations,
+                :multi_search
 
     def initialize(options = {})
       @configuration = Configuration.new(options)
@@ -10,6 +11,7 @@ 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)

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 = {})
@@ -52,8 +52,8 @@ module Typesense
       end
     end
 
-    def export
-      @api_call.get(endpoint_path('export'))
+    def export(options = {})
+      @api_call.get(endpoint_path('export'), options)
     end
 
     def search(search_parameters)

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typesense
-  VERSION = '0.10.0'
+  VERSION = '0.13.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.10.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-07-14 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
@@ -291,6 +291,7 @@ 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