typesense 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dcd2c3b6cfbf9be0a2d466eb377a55d9a419ba9334861de46cb3eefe6542d56
-  data.tar.gz: c3c6bbc4d9eb200a827d01ccbf25f2a9f660dce2237e483886237325f1ebb8eb
+  metadata.gz: 8c74454a48a4f170bbb99bb5e382199c8842e84ec5d2fbd6198106df89b45977
+  data.tar.gz: ca4772c87e84fabe0cef3af42bfb6e1bb889e305b402d9a2e2f83b10bdbe6d1b
 SHA512:
-  metadata.gz: 3c76aff4123a3c2067319f6d4c168eeaf5b2f95cf50cd07fd1ab0e9c8aec9f628be408071aa52750e86e768d1751205b4da94dcfdd4246f7ccb667d2c0a1ff01
-  data.tar.gz: 9e246a32ad33a084768b8b8c0eae17c61b969296294b757936d6f157a93beeb7b2d91c046a7322676ea62a363f7a09dadb89ed01a99c6071516ef227ba515280
+  metadata.gz: d1ab99d6e52d15257c8e664d765b1debb063d151d364916b273cef1658537dadcd0241e76fffa5807be50b15c83891b76c2aaef7105c875be2c3bb70728b88e0
+  data.tar.gz: db20bce0c42a7713a3c5fa25ca1c7a17bb6724bd8949b5dc16202d11538b348d806d960f0def0712e118d856184da8650a3b12ba861037754e20e172856d38c0

data/.gitignore

@@ -11,5 +11,7 @@ Gemfile.lock
 .ruby-version
 .ruby-gemset
 
+typesense-server-peers
+
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -4,6 +4,7 @@ require: rubocop-rspec
 
 AllCops:
   TargetRubyVersion: "2.4"
+  NewCops: enable
 
 Metrics/BlockLength:
   Exclude:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-17 15:11:06 -0700 using RuboCop version 0.53.0.
+# on 2020-05-21 20:10:36 -0700 using RuboCop version 0.83.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,27 +11,44 @@ Lint/ShadowedException:
   Exclude:
     - 'lib/typesense/api_call.rb'
 
+# Offense count: 2
+# Configuration parameters: AllowComments.
+Lint/SuppressedException:
+  Exclude:
+    - 'examples/collections_and_documents.rb'
+    - 'examples/search.rb'
+
 # Offense count: 3
+# Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 37
+  Max: 43
 
 # Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 184
+
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 11
 
-# Offense count: 1
-# Configuration parameters: CountComments.
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 35
+  Max: 29
 
-# Offense count: 1
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 14
+  Max: 11
 
-# Offense count: 13
+# Offense count: 25
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Exclude:
+    - 'spec/typesense/alias_spec.rb'
+    - 'spec/typesense/aliases_spec.rb'
     - 'spec/typesense/api_call_spec.rb'
     - 'spec/typesense/collection_spec.rb'
     - 'spec/typesense/collections_spec.rb'
@@ -40,20 +57,19 @@ RSpec/ExampleLength:
     - 'spec/typesense/documents_spec.rb'
     - 'spec/typesense/override_spec.rb'
     - 'spec/typesense/overrides_spec.rb'
-    - 'spec/typesense/alias_spec.rb'
-    - 'spec/typesense/aliases_spec.rb'
 
-# Offense count: 2
-# Configuration parameters: AggregateFailuresByDefault.
+# Offense count: 10
 RSpec/MultipleExpectations:
-  Max: 2
+  Max: 5
 
-# Offense count: 9
+# Offense count: 13
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/typesense.rb'
+    - 'lib/typesense/alias.rb'
+    - 'lib/typesense/aliases.rb'
     - 'lib/typesense/api_call.rb'
     - 'lib/typesense/client.rb'
     - 'lib/typesense/collection.rb'
@@ -64,11 +80,10 @@ Style/Documentation:
     - 'lib/typesense/documents.rb'
     - 'lib/typesense/override.rb'
     - 'lib/typesense/overrides.rb'
-    - 'lib/typesense/alias.rb'
-    - 'lib/typesense/aliases.rb'
 
-# Offense count: 92
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 157
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
-  Max: 245
+Layout/LineLength:
+  Max: 312

data/README.md

@@ -29,6 +29,13 @@ Here are some examples that show you how the Ruby client works: [examples](examp
 
 Tests are also a good place to know how the the library works internally: [spec](spec)
 
+## Compatibility
+
+| Typesense Server | typesense-ruby |
+|------------------|----------------|
+| <= v0.11 | <= v0.3.0 |
+| \>= v0.12 | \>= v0.4.0 |
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/codecov.yml

@@ -0,0 +1,10 @@
+coverage:
+  status:
+    project:
+      default:
+        threshold: 10%
+        target: 90%
+    patch:
+      default:
+        threshold: 10%
+        target: 80%

data/examples/aliases.rb

@@ -3,34 +3,12 @@
 ##
 # 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 '../lib/typesense'
-require 'awesome_print'
-
-AwesomePrint.defaults = {
-  indent: -2
-}
-
-##
-# Setup
-#
-# Start the master
-#   $ docker run -p 8108:8108  -it -v/tmp/typesense-data-master/:/data -it typesense/typesense:0.8.0-rc1 --data-dir /data --api-key=abcd --listen-port 8108 --license-key=<>
-#
-
-##
-# Create a client
-typesense = Typesense::Client.new(
-  master_node: {
-    host: 'localhost',
-    port: 8108,
-    protocol: 'http',
-    api_key: 'abcd'
-  }
-)
+require_relative './client_initialization'
 
 # Create a collection
-create_response = typesense.collections.create(
+create_response = @typesense.collections.create(
   "name": 'books_january',
   "fields": [
     { "name": 'title', "type": 'string' },
@@ -48,8 +26,8 @@ create_response = typesense.collections.create(
 ap create_response
 
 # Create or update an existing alias
-create_alias_response = typesense.aliases.upsert('books',
-                                                 "collection_name": 'books_january')
+create_alias_response = @typesense.aliases.upsert('books',
+                                                  "collection_name": 'books_january')
 ap create_alias_response
 
 # Add a book using the alias name `books`
@@ -61,20 +39,20 @@ hunger_games_book = {
   'ratings_count': 4_780_653
 }
 
-typesense.collections['books'].documents.create(hunger_games_book)
+@typesense.collections['books'].documents.create(hunger_games_book)
 
 # Search using the alias
-ap typesense.collections['books'].documents.search(
+ap @typesense.collections['books'].documents.search(
   'q': 'hunger',
   'query_by': 'title',
   'sort_by': 'ratings_count:desc'
 )
 
 # List all aliases
-ap typesense.aliases.retrieve
+ap @typesense.aliases.retrieve
 
 # Retrieve the configuration of a specific alias
-ap typesense.aliases['books'].retrieve
+ap @typesense.aliases['books'].retrieve
 
 # Delete an alias
-ap typesense.aliases['books'].delete
+ap @typesense.aliases['books'].delete

data/examples/client_initialization.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative '../lib/typesense'
+require 'awesome_print'
+
+AwesomePrint.defaults = {
+  indent: -2
+}
+
+##
+## 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.rc9 --data-dir /data --api-key=xyz --search-only-api-key=abcd --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.12.rc9 --data-dir /data --api-key=xyz --search-only-api-key=abcd --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.rc9 --data-dir /data --api-key=xyz --search-only-api-key=abcd --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.rc9 --data-dir /data --api-key=xyz --search-only-api-key=abcd --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
+
+##
+# Create a client
+@typesense = Typesense::Client.new(
+  nodes: [
+    {
+      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'
+    }
+  ],
+  # 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'
+  },
+  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
+)

data/examples/collections_and_documents.rb

@@ -4,41 +4,7 @@
 # These examples walk you through all the operations you can do on a collection and a document
 # Search is specifically covered in another file in the examples folder
 
-require_relative '../lib/typesense'
-require 'awesome_print'
-
-AwesomePrint.defaults = {
-  indent: -2
-}
-
-##
-# Setup
-#
-# Start the master
-#   $ docker run -p 8108:8108  -it -v/tmp/typesense-data-master/:/data -it typesense/typesense:0.8.0-rc1 --data-dir /data --api-key=abcd --listen-port 8108
-#
-# Start the read replica
-#   $ docker run -p 8109:8109  -it -v/tmp/typesense-data-read-replica-1/:/data -it typesense/typesense:0.8.0-rc1 --data-dir /data --api-key=wxyz --listen-port 8109 --master http://localhost:8108
-
-##
-# Create a client
-typesense = Typesense::Client.new(
-  master_node: {
-    host: 'localhost',
-    port: 8108,
-    protocol: 'http',
-    api_key: 'abcd'
-  },
-  read_replica_nodes: [
-    {
-      host: 'localhost',
-      port: 8109,
-      protocol: 'http',
-      api_key: 'wxyz'
-    }
-  ],
-  timeout_seconds: 10
-)
+require_relative './client_initialization'
 
 ##
 # Create a collection
@@ -62,7 +28,13 @@ schema = {
   'default_sorting_field' => 'num_employees'
 }
 
-collection = typesense.collections.create(schema)
+# Delete the collection if it already exists
+begin
+  @typesense.collections['companies'].delete
+rescue Typesense::Error::ObjectNotFound
+end
+
+collection = @typesense.collections.create(schema)
 ap collection
 
 # {
@@ -87,7 +59,8 @@ ap collection
 
 ##
 # Retrieve a collection
-collection = typesense.collections['companies'].retrieve
+sleep 0.5 # Give Typesense cluster a few hundred ms to create the collection on all nodes, before reading it right after (eventually consistent)
+collection = @typesense.collections['companies'].retrieve
 ap collection
 
 # {
@@ -115,7 +88,7 @@ ap collection
 
 ##
 # Retrieve all collections
-collections = typesense.collections.retrieve
+collections = @typesense.collections.retrieve
 ap collections
 
 # [
@@ -146,7 +119,7 @@ ap collections
 ##
 # Delete a collection
 #   Deletion returns the schema of the collection after deletion
-collection = typesense.collections['companies'].delete
+collection = @typesense.collections['companies'].delete
 ap collection
 
 # {
@@ -173,7 +146,7 @@ ap collection
 # }
 
 # Let's create the collection again for use in our remaining examples
-typesense.collections.create(schema)
+@typesense.collections.create(schema)
 
 ##
 # Create (index) a document
@@ -184,7 +157,7 @@ document = {
   'country' => 'USA'
 }
 
-document = typesense.collections['companies'].documents.create(document)
+document = @typesense.collections['companies'].documents.create(document)
 ap document
 
 # {
@@ -196,7 +169,8 @@ ap document
 
 ##
 # Retrieve a document
-document = typesense.collections['companies'].documents['124'].retrieve
+sleep 0.5 # Give Typesense cluster a few hundred ms to create the document on all nodes, before reading it right after (eventually consistent)
+document = @typesense.collections['companies'].documents['124'].retrieve
 ap document
 
 # {
@@ -209,7 +183,7 @@ ap document
 ##
 # Delete a document
 #   Deleting a document, returns the document after deletion
-document = typesense.collections['companies'].documents['124'].delete
+document = @typesense.collections['companies'].documents['124'].delete
 ap document
 
 # {
@@ -219,25 +193,28 @@ ap document
 #   "num_employees" => 5215
 # }
 
-# Let's create two documents again for use in our remaining examples
-typesense.collections['companies'].documents.create(
-  'id' => '124',
-  'company_name' => 'Stark Industries',
-  'num_employees' => 5215,
-  'country' => 'USA'
-)
-
-typesense.collections['companies'].documents.create(
-  'id' => '125',
-  'company_name' => 'Acme Corp',
-  'num_employees' => 1002,
-  'country' => 'France'
-)
+# Let's bulk create two documents again for use in our remaining examples
+documents = [
+  {
+    'id' => '124',
+    'company_name' => 'Stark Industries',
+    'num_employees' => 5215,
+    'country' => 'USA'
+  },
+  {
+    'id' => '125',
+    'company_name' => 'Acme Corp',
+    'num_employees' => 1002,
+    'country' => 'France'
+  }
+]
+ap @typesense.collections['companies'].documents.create_many(documents)
 
 ##
 # 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 (elements in the array) as needed.
-array_of_json_strings = typesense.collections['companies'].documents.export
+sleep 0.5 # Give Typesense cluster a few hundred ms to create the document on all nodes, before reading it right after (eventually consistent)
+array_of_json_strings = @typesense.collections['companies'].documents.export
 ap array_of_json_strings
 
 # [
@@ -248,4 +225,4 @@ ap array_of_json_strings
 ##
 # Cleanup
 # Drop the collection
-typesense.collections['companies'].delete
+@typesense.collections['companies'].delete