Merge branch 'typesense:master' into response-malformed-json-error

Author: sunny

.github/workflows/tests.yml

@@ -10,18 +10,35 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['3.0', '3.2', '3.3']
+    services:
+      typesense:
+        image: typesense/typesense:28.0
+        ports:
+          - 8108:8108
+        volumes:
+          - /tmp/typesense-data:/data
+          - /tmp/typesense-analytics:/analytics
+        env:
+          TYPESENSE_API_KEY: xyz
+          TYPESENSE_DATA_DIR: /data
+          TYPESENSE_ENABLE_CORS: true
+          TYPESENSE_ANALYTICS_DIR: /analytics
+          TYPESENSE_ENABLE_SEARCH_ANALYTICS: true
 
     steps:
+      - name: Wait for Typesense
+        run: |
+          timeout 20 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8108/health)" != "200" ]]; do sleep 1; done' || false
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - run: bundle exec rubocop
       - run: bundle exec rspec --format documentation
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
-          name: coverage
+          name: coverage-ruby-${{ matrix.ruby-version }}
           path: coverage/
           retention-days: 1

.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

Gemfile

@@ -4,5 +4,22 @@ 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 'erb'
+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

README.md

@@ -33,7 +33,8 @@ 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    |
+| \>= v28.0        | \>= v3.0.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 +51,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
 

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

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
@@ -145,6 +145,16 @@
 #   "num_documents"         => 0
 # }
 
+###
+# Truncate a collection
+#   Truncation returns the number of documents deleted
+collection = @typesense.collections['companies'].documents.truncate
+ap collection
+
+# {
+#   "num_deleted": 125
+# }
+
 # Let's create the collection again for use in our remaining examples
 @typesense.collections.create(schema)
 

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

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 @@
 
 @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 }]
 )
 
 ##

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

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