typesense 0.2.0 → 0.4.0

data/lib/typesense/client.rb

@@ -9,9 +9,10 @@ module Typesense
 
     def initialize(options = {})
       @configuration = Configuration.new(options)
-      @collections = Collections.new(@configuration)
-      @aliases = Aliases.new(@configuration)
-      @debug = Debug.new(@configuration)
+      @api_call = ApiCall.new(@configuration)
+      @collections = Collections.new(@api_call)
+      @aliases = Aliases.new(@api_call)
+      @debug = Debug.new(@api_call)
     end
   end
 end

data/lib/typesense/collection.rb

@@ -5,19 +5,19 @@ module Typesense
     attr_reader :documents
     attr_reader :overrides
 
-    def initialize(configuration, name)
-      @configuration = configuration
-      @name          = name
-      @documents     = Documents.new(@configuration, @name)
-      @overrides     = Overrides.new(@configuration, @name)
+    def initialize(name, api_call)
+      @name      = name
+      @api_call  = api_call
+      @documents = Documents.new(@name, @api_call)
+      @overrides = Overrides.new(@name, @api_call)
     end
 
     def retrieve
-      ApiCall.new(@configuration).get(endpoint_path)
+      @api_call.get(endpoint_path)
     end
 
     def delete
-      ApiCall.new(@configuration).delete(endpoint_path)
+      @api_call.delete(endpoint_path)
     end
 
     private

data/lib/typesense/collections.rb

@@ -4,21 +4,21 @@ module Typesense
   class Collections
     RESOURCE_PATH = '/collections'
 
-    def initialize(configuration)
-      @configuration = configuration
-      @collections   = {}
+    def initialize(api_call)
+      @api_call    = api_call
+      @collections = {}
     end
 
     def create(schema)
-      ApiCall.new(@configuration).post(RESOURCE_PATH, schema)
+      @api_call.post(RESOURCE_PATH, schema)
     end
 
     def retrieve
-      ApiCall.new(@configuration).get(RESOURCE_PATH)
+      @api_call.get(RESOURCE_PATH)
     end
 
     def [](collection_name)
-      @collections[collection_name] ||= Collection.new(@configuration, collection_name)
+      @collections[collection_name] ||= Collection.new(collection_name, @api_call)
     end
   end
 end

data/lib/typesense/configuration.rb

@@ -2,37 +2,53 @@
 
 module Typesense
   class Configuration
-    attr_accessor :master_node
-    attr_accessor :read_replica_nodes
-    attr_accessor :timeout_seconds
+    attr_accessor :nodes
+    attr_accessor :nearest_node
+    attr_accessor :connection_timeout_seconds
+    attr_accessor :healthcheck_interval_seconds
+    attr_accessor :num_retries
+    attr_accessor :retry_interval_seconds
+    attr_accessor :api_key
+    attr_accessor :logger
+    attr_accessor :log_level
 
     def initialize(options = {})
-      @master_node = options[:master_node] || {
-        host: 'localhost',
-        port: '8108',
-        protocol: 'http'
-      }
-
-      @read_replica_nodes = options[:read_replica_nodes] || []
-      @timeout_seconds    = options[:timeout_seconds] || 10
+      @nodes = options[:nodes] || []
+      @nearest_node = options[:nearest_node]
+      @connection_timeout_seconds = options[:connection_timeout_seconds] || options[:timeout_seconds] || 10
+      @healthcheck_interval_seconds = options[:healthcheck_interval_seconds] || 15
+      @num_retries = options[:num_retries] || @nodes.length + (@nearest_node.nil? ? 0 : 1) || 3
+      @retry_interval_seconds = options[:retry_interval_seconds] || 0.1
+      @api_key = options[:api_key]
+
+      @logger = options[:logger] || Logger.new(STDOUT)
+      @log_level = options[:log_level] || Logger::WARN
+      @logger.level = @log_level
+
+      show_deprecation_warnings(options)
+      validate!
     end
 
     def validate!
-      if @master_node.nil? ||
-         node_missing_parameters?(@master_node)
-        raise Error::MissingConfiguration, 'Missing required configuration. Ensure that master_node[:protocol], master_node[:host], master_node[:port] and master_node[:api_key] are set.'
+      if @nodes.nil? ||
+         @nodes.empty? ||
+         @nodes.any? { |node| node_missing_parameters?(node) }
+        raise Error::MissingConfiguration, 'Missing required configuration. Ensure that nodes[][:protocol], nodes[][:host] and nodes[][:port] are set.'
       end
 
-      if !@read_replica_nodes.nil? &&
-         @read_replica_nodes.any? { |node| node_missing_parameters?(node) }
-        raise Error::MissingConfiguration, 'Missing required configuration for read_replica_nodes. Ensure that read_replica_nodes[][:protocol], read_replica_nodes[][:host], read_replica_nodes[][:port] and read_replica_nodes[][:api_key] are set.'
-      end
+      raise Error::MissingConfiguration, 'Missing required configuration. Ensure that api_key is set.' if @api_key.nil?
     end
 
     private
 
     def node_missing_parameters?(node)
-      %i[protocol host port api_key].any? { |attr| node.send(:[], attr).nil? }
+      %i[protocol host port].any? { |attr| node.send(:[], attr).nil? }
+    end
+
+    def show_deprecation_warnings(options)
+      @logger.warn 'Deprecation warning: timeout_seconds is now renamed to connection_timeout_seconds' unless options[:timeout_seconds].nil?
+      @logger.warn 'Deprecation warning: master_node is now consolidated to nodes, starting with Typesense Server v0.12' unless options[:master_node].nil?
+      @logger.warn 'Deprecation warning: read_replica_nodes is now consolidated to nodes, starting with Typesense Server v0.12' unless options[:read_replica_nodes].nil?
     end
   end
 end

data/lib/typesense/debug.rb

@@ -4,12 +4,12 @@ module Typesense
   class Debug
     RESOURCE_PATH = '/debug'
 
-    def initialize(configuration)
-      @configuration = configuration
+    def initialize(api_call)
+      @api_call = api_call
     end
 
     def retrieve
-      ApiCall.new(@configuration).get(RESOURCE_PATH)
+      @api_call.get(RESOURCE_PATH)
     end
   end
 end

data/lib/typesense/document.rb

@@ -2,18 +2,18 @@
 
 module Typesense
   class Document
-    def initialize(configuration, collection_name, document_id)
-      @configuration   = configuration
+    def initialize(collection_name, document_id, api_call)
       @collection_name = collection_name
       @document_id     = document_id
+      @api_call        = api_call
     end
 
     def retrieve
-      ApiCall.new(@configuration).get(endpoint_path)
+      @api_call.get(endpoint_path)
     end
 
     def delete
-      ApiCall.new(@configuration).delete(endpoint_path)
+      @api_call.delete(endpoint_path)
     end
 
     private

data/lib/typesense/documents.rb

@@ -4,26 +4,31 @@ module Typesense
   class Documents
     RESOURCE_PATH = '/documents'
 
-    def initialize(configuration, collection_name)
-      @configuration   = configuration
+    def initialize(collection_name, api_call)
       @collection_name = collection_name
+      @api_call        = api_call
       @documents       = {}
     end
 
     def create(document)
-      ApiCall.new(@configuration).post(endpoint_path, document)
+      @api_call.post(endpoint_path, document)
+    end
+
+    def create_many(documents)
+      documents_in_jsonl_format = documents.map { |document| JSON.dump(document) }.join("\n")
+      @api_call.post(endpoint_path('import'), as_json: false, body: documents_in_jsonl_format)
     end
 
     def export
-      ApiCall.new(@configuration).get_unparsed_response(endpoint_path('export')).split("\n")
+      (@api_call.get(endpoint_path('export')) || '').split("\n")
     end
 
     def search(search_parameters)
-      ApiCall.new(@configuration).get(endpoint_path('search'), search_parameters)
+      @api_call.get(endpoint_path('search'), search_parameters)
     end
 
     def [](document_id)
-      @documents[document_id] ||= Document.new(@configuration, @collection_name, document_id)
+      @documents[document_id] ||= Document.new(@collection_name, document_id, @api_call)
     end
 
     private

data/lib/typesense/error.rb

@@ -23,7 +23,13 @@ module Typesense
     class ServerError < Error
     end
 
+    class HTTPStatus0Error < Error
+    end
+
     class NoMethodError < ::NoMethodError
     end
+
+    class HTTPError < Error
+    end
   end
 end

data/lib/typesense/override.rb

@@ -2,18 +2,18 @@
 
 module Typesense
   class Override
-    def initialize(configuration, collection_name, override_id)
-      @configuration   = configuration
+    def initialize(collection_name, override_id, api_call)
       @collection_name = collection_name
       @override_id     = override_id
+      @api_call        = api_call
     end
 
     def retrieve
-      ApiCall.new(@configuration).get(endpoint_path)
+      @api_call.get(endpoint_path)
     end
 
     def delete
-      ApiCall.new(@configuration).delete(endpoint_path)
+      @api_call.delete(endpoint_path)
     end
 
     private

data/lib/typesense/overrides.rb

@@ -4,22 +4,22 @@ module Typesense
   class Overrides
     RESOURCE_PATH = '/overrides'
 
-    def initialize(configuration, collection_name)
-      @configuration   = configuration
+    def initialize(collection_name, api_call)
       @collection_name = collection_name
+      @api_call        = api_call
       @overrides       = {}
     end
 
     def create(params)
-      ApiCall.new(@configuration).put(endpoint_path, params)
+      @api_call.put(endpoint_path, params)
     end
 
     def retrieve
-      ApiCall.new(@configuration).get(endpoint_path)
+      @api_call.get(endpoint_path)
     end
 
     def [](override_id)
-      @overrides[override_id] ||= Override.new(@configuration, @collection_name, override_id)
+      @overrides[override_id] ||= Override.new(@collection_name, override_id, @api_call)
     end
 
     private

data/lib/typesense/version.rb

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

data/typesense.gemspec

@@ -25,15 +25,16 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'awesome_print', '~> 1.8'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'codecov', '~> 0.1'
-  spec.add_development_dependency 'pry-byebug', '~> 3.7'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rspec-legacy_formatters', '~> 1.0' # For codecov formatter
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
-  spec.add_development_dependency 'rubocop', '~> 0.76'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.36'
-  spec.add_development_dependency 'simplecov', '~> 0.17'
-  spec.add_development_dependency 'webmock', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.83'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.39'
+  spec.add_development_dependency 'simplecov', '~> 0.18'
+  spec.add_development_dependency 'timecop', '~> 0.9'
+  spec.add_development_dependency 'webmock', '~> 3.8'
 
-  spec.add_dependency 'httparty', '~> 0.17'
+  spec.add_dependency 'httparty', '~> 0.18'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2020-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,70 +128,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.83'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.83'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.39'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
 description: Typesense is an open source search engine for building a delightful search
   experience.
 email:
@@ -211,7 +225,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- codecov.yml
 - examples/aliases.rb
+- examples/client_initialization.rb
 - examples/collections_and_documents.rb
 - examples/overrides.rb
 - examples/search.rb