typesense 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54f0c8b4934c74669d91b10ed2a2fb6d9b3b54db1c72271eaef97062eec5475e
-  data.tar.gz: 86aac1db6163de619c2aefc95c430dee2917f0db0c4f7d57921ae1ff2d78ab03
+  metadata.gz: 01637fffe88f9d21ae627407e69a06a8beb22e0989f1638b11cc38f0bb19f449
+  data.tar.gz: 9edee26c48191b1f49befe6b2d865b20a3efbb6e70bc78a31c15da83b93f8d3b
 SHA512:
-  metadata.gz: 6ecef532b4f623d2acbf1c591e0843ee2cff2bf95c70014d2c00f4b723b9cc5201eabd73d3119c2bcd71167a76fec1a98a9d32bef0fa4d42af91be39cfafdde2
-  data.tar.gz: 6d351095aa8ce2dca828f3f784d76f1f5bba65557e3afcedad3532a496200b59cb68481b3f7e903af26c82e95923bdbb04fe0367de7876e82287f057a933b305
+  metadata.gz: d42ae36979f4c7fcf72c53010e46a6fab5a97ab7dab81c11bbb40289175633db821c7f552578441c265078cac72f11735ee2a61d5f7c565c6e26e8a1c1ce8cf6
+  data.tar.gz: e80e0d6e7f921650729334097e19963279146a16bb16a9365c1020c6c94560e97e7693322fc318651769e846fdbf5daf447cedbf9120a5060b79d3582cde6eaa

data/.rubocop.yml

@@ -1,34 +1,39 @@
-inherit_from: .rubocop_todo.yml
-
-require: rubocop-rspec
-
 AllCops:
-  TargetRubyVersion: "2.4"
   NewCops: enable
 
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-    - 'Gemfile'
-    - 'typesense.gemspec'
-
 Style/Documentation:
   Enabled: false
 
-RSpec/ExampleLength:
+Metrics/AbcSize:
   Enabled: false
 
-Metrics/MethodLength:
+Metrics/CyclomaticComplexity:
   Enabled: false
 
-Metrics/AbcSize:
+Metrics/PerceivedComplexity:
   Enabled: false
 
 Metrics/ClassLength:
   Enabled: false
 
-Metrics/CyclomaticComplexity:
+Metrics/ParameterLists:
   Enabled: false
 
-Metrics/PerceivedComplexity:
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
   Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true
+
+Layout/LineLength:
+  Max: 300
+
+Lint/SuppressedException:
+  Exclude:
+    - examples/**

data/Guardfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :rubocop, cli: '-a' do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/examples/client_initialization.rb

@@ -2,6 +2,7 @@
 
 require_relative '../lib/typesense'
 require 'awesome_print'
+require 'logger'
 
 AwesomePrint.defaults = {
   indent: -2
@@ -62,6 +63,6 @@ AwesomePrint.defaults = {
   healthcheck_interval_seconds: 1,
   retry_interval_seconds: 0.01,
   connection_timeout_seconds: 10,
-  logger: Logger.new(STDOUT),
+  logger: Logger.new($stdout),
   log_level: Logger::DEBUG
 )

data/lib/typesense/api_call.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require 'httparty'
+require 'typhoeus'
+require 'oj'
 
 module Typesense
   class ApiCall
-    include HTTParty
-
     API_KEY_HEADER_NAME = 'X-TYPESENSE-API-KEY'
 
     def initialize(configuration)
@@ -30,8 +29,8 @@ module Typesense
 
       perform_request :post,
                       endpoint,
-                      body: body,
-                      headers: default_headers.merge(headers)
+                      headers,
+                      body: body
     end
 
     def put(endpoint, parameters = {})
@@ -39,8 +38,8 @@ module Typesense
 
       perform_request :put,
                       endpoint,
-                      body: body,
-                      headers: default_headers.merge(headers)
+                      headers,
+                      body: body
     end
 
     def get(endpoint, parameters = {})
@@ -48,8 +47,8 @@ module Typesense
 
       perform_request :get,
                       endpoint,
-                      query: query,
-                      headers: default_headers.merge(headers)
+                      headers,
+                      params: query
     end
 
     def delete(endpoint, parameters = {})
@@ -57,11 +56,11 @@ module Typesense
 
       perform_request :delete,
                       endpoint,
-                      query: query,
-                      headers: default_headers.merge(headers)
+                      headers,
+                      params: query
     end
 
-    def perform_request(method, endpoint, options = {})
+    def perform_request(method, endpoint, headers = {}, options = {})
       @configuration.validate!
       last_exception = nil
       @logger.debug "Performing #{method.to_s.upcase} request: #{endpoint}"
@@ -71,24 +70,31 @@ module Typesense
         @logger.debug "Attempting #{method.to_s.upcase} request Try ##{num_tries} to Node #{node[:index]}"
 
         begin
-          response_object = self.class.send(method,
-                                            uri_for(endpoint, node),
-                                            default_options.merge(options))
-          response_code = response_object.response.code.to_i
-          set_node_healthcheck(node, is_healthy: true) if response_code >= 1 && response_code <= 499
-
-          @logger.debug "Request to Node #{node[:index]} was successfully made (at the network layer). Response Code was #{response_code}."
+          response = Typhoeus::Request.new(uri_for(endpoint, node),
+                                           {
+                                             method: method,
+                                             headers: default_headers.merge(headers),
+                                             timeout: @connection_timeout_seconds
+                                           }.merge(options)).run
+          set_node_healthcheck(node, is_healthy: true) if response.code >= 1 && response.code <= 499
+
+          @logger.debug "Request to Node #{node[:index]} was successfully made (at the network layer). Response Code was #{response.code}."
+
+          parsed_response = if response.headers && (response.headers['content-type'] || '').include?('application/json')
+                              Oj.load(response.body)
+                            else
+                              response.body
+                            end
 
           # If response is 2xx return the object, else raise the response as an exception
-          return response_object.parsed_response if response_object.response.code_type <= Net::HTTPSuccess # 2xx
+          return parsed_response if response.code >= 200 && response.code <= 299
 
-          exception_message = (response_object.parsed_response && response_object.parsed_response['message']) || 'Error'
-          raise custom_exception_klass_for(response_object.response), exception_message
-        rescue SocketError, Net::ReadTimeout, Net::OpenTimeout,
-               EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
+          exception_message = (parsed_response && parsed_response['message']) || 'Error'
+          raise custom_exception_klass_for(response), exception_message
+        rescue SocketError, EOFError,
                Errno::EINVAL, Errno::ENETDOWN, Errno::ENETUNREACH, Errno::ENETRESET, Errno::ECONNABORTED, Errno::ECONNRESET,
                Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::EHOSTDOWN, Errno::EHOSTUNREACH,
-               Timeout::Error, HTTParty::ResponseError, Typesense::Error::ServerError, Typesense::Error::HTTPStatus0Error => e
+               Typesense::Error::TimeoutError, Typesense::Error::ServerError, Typesense::Error::HTTPStatus0Error => e
           # Rescue network layer exceptions and HTTP 5xx errors, so the loop can continue.
           # Using loops for retries instead of rescue...retry to maintain consistency with client libraries in
           #   other languages that might not support the same construct.
@@ -108,7 +114,7 @@ module Typesense
     def extract_headers_and_body_from(parameters)
       if json_request?(parameters)
         headers = { 'Content-Type' => 'application/json' }
-        body = sanitize_parameters(parameters).to_json
+        body = Oj.dump(sanitize_parameters(parameters))
       else
         headers = {}
         body = parameters[:body]
@@ -199,35 +205,31 @@ module Typesense
     end
 
     def custom_exception_klass_for(response)
-      response_code_type = response.code_type
-      if response_code_type <= Net::HTTPBadRequest # 400
+      if response.code == 400
         Typesense::Error::RequestMalformed
-      elsif response_code_type <= Net::HTTPUnauthorized # 401
+      elsif response.code == 401
         Typesense::Error::RequestUnauthorized
-      elsif response_code_type <= Net::HTTPNotFound # 404
+      elsif response.code == 404
         Typesense::Error::ObjectNotFound
-      elsif response_code_type <= Net::HTTPConflict # 409
+      elsif response.code == 409
         Typesense::Error::ObjectAlreadyExists
-      elsif response_code_type <= Net::HTTPUnprocessableEntity # 422
+      elsif response.code == 422
         Typesense::Error::ObjectUnprocessable
-      elsif response_code_type <= Net::HTTPServerError # 5xx
+      elsif response.code >= 500 && response.code <= 599
         Typesense::Error::ServerError
-      elsif response.code.to_i.zero?
+      elsif response.timed_out?
+        Typesense::Error::TimeoutError
+      elsif response.code.zero?
         Typesense::Error::HTTPStatus0Error
       else
         Typesense::Error::HTTPError
       end
     end
 
-    def default_options
-      {
-        timeout: @connection_timeout_seconds
-      }
-    end
-
     def default_headers
       {
-        API_KEY_HEADER_NAME.to_s => @api_key
+        API_KEY_HEADER_NAME.to_s => @api_key,
+        'User-Agent' => 'Typesense Ruby Client'
       }
     end
   end

data/lib/typesense/client.rb

@@ -2,13 +2,7 @@
 
 module Typesense
   class Client
-    attr_reader :configuration
-    attr_reader :collections
-    attr_reader :aliases
-    attr_reader :keys
-    attr_reader :debug
-    attr_reader :health
-    attr_reader :metrics
+    attr_reader :configuration, :collections, :aliases, :keys, :debug, :health, :metrics
 
     def initialize(options = {})
       @configuration = Configuration.new(options)

data/lib/typesense/collection.rb

@@ -2,8 +2,7 @@
 
 module Typesense
   class Collection
-    attr_reader :documents
-    attr_reader :overrides
+    attr_reader :documents, :overrides
 
     def initialize(name, api_call)
       @name      = name

data/lib/typesense/configuration.rb

@@ -1,16 +1,10 @@
 # frozen_string_literal: true
 
+require 'logger'
+
 module Typesense
   class Configuration
-    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
+    attr_accessor :nodes, :nearest_node, :connection_timeout_seconds, :healthcheck_interval_seconds, :num_retries, :retry_interval_seconds, :api_key, :logger, :log_level
 
     def initialize(options = {})
       @nodes = options[:nodes] || []
@@ -21,7 +15,7 @@ module Typesense
       @retry_interval_seconds = options[:retry_interval_seconds] || 0.1
       @api_key = options[:api_key]
 
-      @logger = options[:logger] || Logger.new(STDOUT)
+      @logger = options[:logger] || Logger.new($stdout)
       @log_level = options[:log_level] || Logger::WARN
       @logger.level = @log_level
 

data/lib/typesense/documents.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'oj'
+
 module Typesense
   class Documents
     RESOURCE_PATH = '/documents'
@@ -15,7 +17,7 @@ module Typesense
     end
 
     def create_many(documents)
-      documents_in_jsonl_format = documents.map { |document| JSON.dump(document) }.join("\n")
+      documents_in_jsonl_format = documents.map { |document| Oj.dump(document) }.join("\n")
       import(documents_in_jsonl_format)
     end
 
@@ -38,7 +40,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Documents::RESOURCE_PATH}#{operation.nil? ? '' : '/' + operation}"
+      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Documents::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
     end
   end
 end

data/lib/typesense/error.rb

@@ -26,6 +26,9 @@ module Typesense
     class HTTPStatus0Error < Error
     end
 
+    class TimeoutError < Error
+    end
+
     class NoMethodError < ::NoMethodError
     end
 

data/lib/typesense/overrides.rb

@@ -25,7 +25,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Overrides::RESOURCE_PATH}#{operation.nil? ? '' : '/' + operation}"
+      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Overrides::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.5.5'
+  VERSION = '0.6.0'
 end

data/typesense.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://typesense.org'
   spec.license       = 'Apache-2.0'
 
+  spec.required_ruby_version = '>= 2.4'
+
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -25,16 +27,19 @@ 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 'guard', '~> 2.16'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.3'
   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.83'
+  spec.add_development_dependency 'rspec-legacy_formatters', '~> 1.0' # For codecov formatter
+  spec.add_development_dependency 'rubocop', '~> 0.88'
   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.18'
+  spec.add_dependency 'oj', '~> 3.10'
+  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.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -95,47 +123,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: rspec-legacy_formatters
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec-legacy_formatters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '0.88'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '0.88'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -193,19 +221,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: Typesense is an open source search engine for building a delightful search
   experience.
 email:
@@ -218,8 +260,8 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -264,7 +306,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.rubocop_todo.yml

@@ -1,50 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# 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
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-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'
-    - 'examples/keys.rb'
-
-# Offense count: 10
-RSpec/MultipleExpectations:
-  Max: 5
-
-# 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'
-    - 'lib/typesense/collections.rb'
-    - 'lib/typesense/configuration.rb'
-    - 'lib/typesense/debug.rb'
-    - 'lib/typesense/document.rb'
-    - 'lib/typesense/documents.rb'
-    - 'lib/typesense/override.rb'
-    - 'lib/typesense/overrides.rb'
-
-# Offense count: 157
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 312