typesense 0.15.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b0902a6b96d21122114a769a6d55c55cba28880ace9b116a1e3c67251148bc9
-  data.tar.gz: 5b8bec6c747b00d61ed1028569272519d724b3262b3753753a2fea0c4b5db972
+  metadata.gz: 173e451d6ea840eb9dd625340b7f0350ae3e7343dacfff09584b3749116e7090
+  data.tar.gz: c0fbeb2881f825e49ec507cea288482ed52d398d8bf81bbc45da699f1a5305cf
 SHA512:
-  metadata.gz: 298131cd62bb16c8fc26797eb06ffb09689ec98553ef77ba3bd4811aff5f46de777bd6a9a62ac13665d95800189456557e741b89fbbec3911adc0ddd1cd008d3
-  data.tar.gz: db2215ce53918e3e37800ba596a0a7eb7a4b75127d266cf7081e94c6bfac87834ce881d6082c850041fff755ab9436f72de0f1e5f50d25b99f047f84819ed1fc
+  metadata.gz: 56d66cb6510b179d25e33ea7534bd4a75f299d9dd5e51392654d9e88d62850004b1a2c099e73aa8261deddb01f2a8cc8e77f9775fea532fce0acd922bd98716e
+  data.tar.gz: b6f6ea0103b926619e56e5f9a4d44d06ee33fde3822c2c6e20029a2506d2d699d5f8c2c53ea0c620389f20f2dff6a27429aa003d1cd55d62b096a99e9ee1f965

data/.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0', '3.2']
 
     steps:
       - uses: actions/checkout@v3

data/.rubocop.yml

@@ -1,5 +1,8 @@
+require: rubocop-rspec
+
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.7
 
 Style/Documentation:
   Enabled: false
@@ -37,3 +40,12 @@ Layout/LineLength:
 Lint/SuppressedException:
   Exclude:
     - examples/**
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false # We still want to support older versions of Ruby

data/Gemfile

@@ -4,5 +4,21 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
+# Dev dependencies
+gem 'awesome_print', '~> 1.8'
+gem 'bundler', '~> 2.0'
+gem 'codecov', '~> 0.1'
+gem 'guard', '~> 2.16'
+gem 'guard-rubocop', '~> 1.3'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.9'
+gem 'rspec_junit_formatter', '~> 0.4'
+gem 'rspec-legacy_formatters', '~> 1.0' # For codecov formatter
+gem 'rubocop', '~> 1.12'
+gem 'rubocop-rspec', '~> 2.4', require: false
+gem 'simplecov', '~> 0.18'
+gem 'timecop', '~> 0.9'
+gem 'webmock', '~> 3.8'
+
 # Specify your gem's dependencies in typesense.gemspec
 gemspec

data/README.md

@@ -33,7 +33,7 @@ Tests are also a good place to know how the the library works internally: [spec]
 
 | Typesense Server | typesense-ruby |
 |------------------|----------------|
-| \>= v0.25.0      | \>= v0.15.0    |
+| \>= v0.25.0      | \>= v1.0.0     |
 | \>= v0.23.0      | \>= v0.14.0    |
 | \>= v0.21.0      | \>= v0.13.0    |
 | \>= v0.20.0      | \>= v0.12.0    |
@@ -50,7 +50,11 @@ Tests are also a good place to know how the the library works internally: [spec]
 
 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+### Releasing
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/examples/aliases.rb

@@ -3,47 +3,47 @@
 ##
 # These examples walk you through operations specifically related to aliases
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 # Create a collection
 create_response = @typesense.collections.create(
-  "name": 'books_january',
-  "fields": [
-    { "name": 'title', "type": 'string' },
-    { "name": 'authors', "type": 'string[]' },
-    { "name": 'authors_facet', "type": 'string[]', "facet": true },
-    { "name": 'publication_year', "type": 'int32' },
-    { "name": 'publication_year_facet', "type": 'string', "facet": true },
-    { "name": 'ratings_count', "type": 'int32' },
-    { "name": 'average_rating', "type": 'float' },
-    { "name": 'image_url', "type": 'string' }
+  name: 'books_january',
+  fields: [
+    { name: 'title', type: 'string' },
+    { name: 'authors', type: 'string[]' },
+    { name: 'authors_facet', type: 'string[]', facet: true },
+    { name: 'publication_year', type: 'int32' },
+    { name: 'publication_year_facet', type: 'string', facet: true },
+    { name: 'ratings_count', type: 'int32' },
+    { name: 'average_rating', type: 'float' },
+    { name: 'image_url', type: 'string' }
   ],
-  "default_sorting_field": 'ratings_count'
+  default_sorting_field: 'ratings_count'
 )
 
 ap create_response
 
 # Create or update an existing alias
 create_alias_response = @typesense.aliases.upsert('books',
-                                                  "collection_name": 'books_january')
+                                                  collection_name: 'books_january')
 ap create_alias_response
 
 # Add a book using the alias name `books`
 hunger_games_book = {
-  'id': '1', 'original_publication_year': 2008, 'authors': ['Suzanne Collins'], 'average_rating': 4.34,
-  'publication_year': 2008, 'publication_year_facet': '2008', 'authors_facet': ['Suzanne Collins'],
-  'title': 'The Hunger Games',
-  'image_url': 'https://images.gr-assets.com/books/1447303603m/2767052.jpg',
-  'ratings_count': 4_780_653
+  id: '1', original_publication_year: 2008, authors: ['Suzanne Collins'], average_rating: 4.34,
+  publication_year: 2008, publication_year_facet: '2008', authors_facet: ['Suzanne Collins'],
+  title: 'The Hunger Games',
+  image_url: 'https://images.gr-assets.com/books/1447303603m/2767052.jpg',
+  ratings_count: 4_780_653
 }
 
 @typesense.collections['books'].documents.create(hunger_games_book)
 
 # Search using the alias
 ap @typesense.collections['books'].documents.search(
-  'q': 'hunger',
-  'query_by': 'title',
-  'sort_by': 'ratings_count:desc'
+  q: 'hunger',
+  query_by: 'title',
+  sort_by: 'ratings_count:desc'
 )
 
 # List all aliases

data/examples/collections_and_documents.rb

@@ -4,7 +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 './client_initialization'
+require_relative 'client_initialization'
 
 ##
 # Create a collection

data/examples/keys.rb

@@ -3,7 +3,7 @@
 ##
 # These examples walk you through operations to manage API Keys
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 # Let's setup some test data for this example
 schema = {
@@ -95,18 +95,18 @@ ap unscoped_search_only_api_key_response
 #  This is useful when you store multi-tenant data in a single Typesense server, but you only want
 #  a particular tenant to access their own data. You'd generate one scoped search key per tenant.
 #  IMPORTANT: scoped search keys should only be generated *server-side*, so as to not leak the unscoped main search key to clients
-scoped_search_only_api_key = @typesense.keys.generate_scoped_search_key(unscoped_search_only_api_key, { 'filter_by': 'company_id:124' })
+scoped_search_only_api_key = @typesense.keys.generate_scoped_search_key(unscoped_search_only_api_key, { filter_by: 'company_id:124' })
 ap "scoped_search_only_api_key: #{scoped_search_only_api_key}"
 
 # Now let's search the data using the scoped API Key for company_id:124
 # You can do searches with this scoped_search_only_api_key from the server-side or client-side
 scoped_typesense_client = Typesense::Client.new({
-                                                  'nodes': [{
-                                                    'host': 'localhost',
-                                                    'port': '8108',
-                                                    'protocol': 'http'
+                                                  nodes: [{
+                                                    host: 'localhost',
+                                                    port: '8108',
+                                                    protocol: 'http'
                                                   }],
-                                                  'api_key': scoped_search_only_api_key
+                                                  api_key: scoped_search_only_api_key
                                                 })
 
 search_results = scoped_typesense_client.collections['users'].documents.search({
@@ -117,8 +117,8 @@ ap search_results
 
 # Search for a user that exists, but is outside the current key's scope
 search_results = scoped_typesense_client.collections['users'].documents.search({
-                                                                                 'q': 'Maxwell',
-                                                                                 'query_by': 'user_name'
+                                                                                 q: 'Maxwell',
+                                                                                 query_by: 'user_name'
                                                                                })
 ap search_results # Will return empty result set
 

data/examples/overrides.rb

@@ -3,7 +3,7 @@
 ##
 # These examples walk you through operations specifically related to result overrides / curation
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 # Delete the collection if it already exists
 begin
@@ -69,19 +69,19 @@ schema = {
 
 @typesense.collections['companies'].overrides.upsert(
   'promote-doofenshmirtz',
-  "rule": {
-    "query": 'doofen',
-    "match": 'exact'
+  rule: {
+    query: 'doofen',
+    match: 'exact'
   },
-  "includes": [{ 'id' => '126', 'position' => 1 }]
+  includes: [{ 'id' => '126', 'position' => 1 }]
 )
 @typesense.collections['companies'].overrides.upsert(
   'promote-acme',
-  "rule": {
-    "query": 'stark',
-    "match": 'exact'
+  rule: {
+    query: 'stark',
+    match: 'exact'
   },
-  "includes": [{ 'id' => '125', 'position' => 1 }]
+  includes: [{ 'id' => '125', 'position' => 1 }]
 )
 
 ##

data/examples/search.rb

@@ -3,7 +3,7 @@
 ##
 # These examples walk you through operations specifically related to search
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 ##
 # Create a collection
@@ -110,7 +110,9 @@ ap results
 # Search for more documents
 results = @typesense.collections['companies'].documents.search(
   'q' => 'Non-existent',
-  'query_by' => 'company_name'
+  'query_by' => 'company_name',
+  # Optionally add a user id if you use Analytics & Query Suggestions
+  'x-typesense-user-id' => 42
 )
 ap results
 

data/examples/synonyms.rb

@@ -3,7 +3,7 @@
 ##
 # These examples walk you through operations specifically related to synonyms
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 # Delete the collection if it already exists
 begin

data/lib/typesense/api_call.rb

@@ -88,7 +88,7 @@ module Typesense
           @logger.debug "Request #{method}:#{uri_for(endpoint, node)} 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)
+                              Oj.load(response.body, mode: :compat)
                             else
                               response.body
                             end

data/lib/typesense/collections.rb

@@ -13,8 +13,8 @@ module Typesense
       @api_call.post(RESOURCE_PATH, schema)
     end
 
-    def retrieve
-      @api_call.get(RESOURCE_PATH)
+    def retrieve(options = {})
+      @api_call.get(RESOURCE_PATH, options)
     end
 
     def [](collection_name)

data/lib/typesense/configuration.rb

@@ -11,7 +11,7 @@ module Typesense
       @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
+      @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]
 

data/lib/typesense/documents.rb

@@ -21,7 +21,11 @@ module Typesense
     end
 
     def update(document, options = {})
-      @api_call.post(endpoint_path, document, options.merge(action: :update))
+      if options['filter_by'] || options[:filter_by]
+        @api_call.patch(endpoint_path, document, options)
+      else
+        @api_call.post(endpoint_path, document, options.merge(action: :update))
+      end
     end
 
     def create_many(documents, options = {})

data/lib/typesense/version.rb

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

data/typesense.gemspec

@@ -15,7 +15,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://typesense.org'
   spec.license       = 'Apache-2.0'
 
-  spec.required_ruby_version = '>= 2.4'
+  # rubocop:disable Gemspec/RequiredRubyVersion, Lint/RedundantCopDisableDirective
+  spec.required_ruby_version = '>= 2.7'
+  # rubocop:enable Gemspec/RequiredRubyVersion, Lint/RedundantCopDisableDirective
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -24,22 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  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_junit_formatter', '~> 0.4'
-  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 'oj', '~> 3.11'
+  spec.add_dependency 'oj', '~> 3.16'
   spec.add_dependency 'typhoeus', '~> 1.4'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,239 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-07 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: rspec-legacy_formatters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.88'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.88'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.39'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.39'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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.9'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.16'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -307,7 +97,8 @@ files:
 homepage: https://typesense.org
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -316,14 +107,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Ruby Library for Typesense