Merge pull request #25 from typesense/ts-server-0.19.0-support

Typesense Server 0.19.0 support

Author: jasonbosco

README.md

@@ -33,6 +33,7 @@ Tests are also a good place to know how the the library works internally: [spec]
 
 | Typesense Server | typesense-ruby |
 |------------------|----------------|
+| \>= v0.19.0 | \>= v0.11.0 |
 | \>= v0.18.0 | \>= v0.10.0 |
 | \>= v0.17.0 | \>= v0.9.0 |
 | \>= v0.16.0 | \>= v0.8.0 |

examples/client_initialization.rb

@@ -12,21 +12,21 @@
 ## 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
 #
 # Create file in present working directory called typesense-server-peers (update IP Addresses appropriately to your local network):
 #   $ 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
 

examples/search.rb

@@ -73,37 +73,6 @@
 )
 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 @@
 )
 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 @@
 )
 ap results
 
-# {
-#   "found"          => 0,
-#   "hits"           => [],
-#   "page"           => 1,
-#   "search_time_ms" => 0
-# }
-
 ##
 # Cleanup
 # Drop the collection

lib/typesense.rb

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

lib/typesense/client.rb

@@ -2,14 +2,16 @@
 
 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)
       @api_call = ApiCall.new(@configuration)
       @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)

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

lib/typesense/version.rb

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

spec/typesense/multi_search_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative 'shared_configuration_context'
+
+describe Typesense::MultiSearch do
+  include_context 'with Typesense configuration'
+
+  describe '#perform' do
+    it 'does a multi-search request' do
+      stub_request(:post, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/multi_search', typesense.configuration.nodes[0]))
+        .with(
+          headers: {
+            'Content-Type' => 'application/json',
+            'X-Typesense-Api-Key' => typesense.configuration.api_key
+          },
+          query: hash_including({ param: 'a' }),
+          body: JSON.dump({ searches: [] })
+        ).to_return(status: 200, body: '{}', headers: { 'Content-Type': 'application/json' })
+
+      result = typesense.multi_search.perform({ searches: [] }, { param: 'a' })
+
+      expect(result).to eq({})
+    end
+  end
+end

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