typesense 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 717b58a0ddf1e2e262d8cf0e4c0a5e3e2f90a8e0cb259337a5d243a3fb0f901c
-  data.tar.gz: 89a094ce8f884ce68d068122b91a6a2df733cc7e77b128e49dd3396cb4c2f5ce
+  metadata.gz: 2a9a804d053011ec4aed72f8a7a401db1c4a171152d1d171e8de7d2861b9f04e
+  data.tar.gz: cfc7041f6221f8d5ee321b289e38ee82b4ee4d3decceeace13df3ae061cd621a
 SHA512:
-  metadata.gz: 69bbef4fea77ec0a97aa15d34a12168d5853c7eccb4a86866605fc536f8348fb80a31e807ff3b25ae342f95ff3569b421c54fd383164646a1585174bf66ad402
-  data.tar.gz: 8abf2ce30d9858d76150c8f81534d7f3e9bc6ad06a4fc33c2c01e0e6ffcfe49e7b0d02282e862bc95c5574a538966cc51c2f39e43e843abbb68333ef43f368da
+  metadata.gz: 2eb9a9633cb01ef642e6a03ac4e98f67128ce47065f37484c108e843f2984be4fe2903841f1c78005cb6f6cc22e145f156bc2b6705c01a562fdcd2f45778c17a
+  data.tar.gz: 20c0869a33ae76f0dcc6a11a3cb32db546d3cc40014403816887a1311e6c54f1fe7e98686550155fb56464385c6d5c28b8e7d387a464dbda931930af83f188af

data/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.18.0 | \>= v0.10.0 |
 | \>= v0.17.0 | \>= v0.9.0 |
 | \>= v0.16.0 | \>= v0.8.0 |
 | \>= v0.15.0 | \>= v0.7.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
 
@@ -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/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

@@ -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
 

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/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.9.0'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-17 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