algolia 2.3.4 → 3.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d62b0de820a85fc4e78522751cb8ebea6aae9ed3ec3093be279b1bc8e3c8b562
-  data.tar.gz: 25f6506b67a2331391bcb3cb5d59cefd65265c9c07d89b0d01cf208c743c9859
+  metadata.gz: 69039252ebbc3b88f6ad76a5283d0eeaa9c8c7fd6722dd3602dc45e93fa0c90d
+  data.tar.gz: 109a6b0f329218b6a82da539cf03259eba52292035ff832f099ce1ef1d722f00
 SHA512:
-  metadata.gz: 548d4e0344b4b7157d652ee0fa095735ee40d473c726c4e68149bdc0451088ea64cc1e857d369ca2e94a9ea2036ccb072e95774fc3e5fde71fc4d0d9cb07de36
-  data.tar.gz: 70297bf2011eeddbb2320cb44ede56fd55876268c9dc4e9edff2babb11c0b1ef5be44c18b175a59b3d4e7c1da1802c808858aa5ef715e0cd3f79a805809cf3ca
+  metadata.gz: 1ae2f7ed837224d0a459be1568bdce840ab52df0e51edfdb08499ae8ecff4b9af7505be0a1d586b158f0d2ee2263ba3bd70edba91fb5b3cf154ce2b0e4568dbc
+  data.tar.gz: d6d7fc15a74dd6dc548429e2934ba540799a11174a05d6786a8804e5ff1a9f872e53a80231e43c0317eda828ed184d075d0aa2657f7eec094e885917f939451e

data/CHANGELOG.md

@@ -1,94 +1,22 @@
-# ChangeLog
+## [3.0.0.alpha.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.alpha.1...3.0.0.alpha.2)
+
+- [ae6adfbf7](https://github.com/algolia/api-clients-automation/commit/ae6adfbf7) fix(specs): port recommend changes ([#2476](https://github.com/algolia/api-clients-automation/pull/2476)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.0.0.alpha.1](https://github.com/algolia/algoliasearch-client-ruby/tree/3.0.0.alpha.1)
+
+- [9f4f17585](https://github.com/algolia/api-clients-automation/commit/9f4f17585) fix(ruby): support ruby alpha format ([#2447](https://github.com/algolia/api-clients-automation/pull/2447)) by [@millotp](https://github.com/millotp/)
+- [443c8909a](https://github.com/algolia/api-clients-automation/commit/443c8909a) chore(ruby): setup release ([#2446](https://github.com/algolia/api-clients-automation/pull/2446)) by [@millotp](https://github.com/millotp/)
+- [1281c2d10](https://github.com/algolia/api-clients-automation/commit/1281c2d10) feat(ruby): client tests ([#2445](https://github.com/algolia/api-clients-automation/pull/2445)) by [@millotp](https://github.com/millotp/)
+- [e0527a573](https://github.com/algolia/api-clients-automation/commit/e0527a573) feat(ruby): e2e CTS ([#2439](https://github.com/algolia/api-clients-automation/pull/2439)) by [@millotp](https://github.com/millotp/)
+- [48c33a77e](https://github.com/algolia/api-clients-automation/commit/48c33a77e) feat(ruby): add CTS ([#2401](https://github.com/algolia/api-clients-automation/pull/2401)) by [@millotp](https://github.com/millotp/)
+- [916789e10](https://github.com/algolia/api-clients-automation/commit/916789e10) fix(ruby): support additionalProperties: true ([#2418](https://github.com/algolia/api-clients-automation/pull/2418)) by [@millotp](https://github.com/millotp/)
+- [c0279405d](https://github.com/algolia/api-clients-automation/commit/c0279405d) fix(ruby): customize linter ([#2409](https://github.com/algolia/api-clients-automation/pull/2409)) by [@millotp](https://github.com/millotp/)
+- [77b7a8ca8](https://github.com/algolia/api-clients-automation/commit/77b7a8ca8) feat(ruby): make hit generic ([#2400](https://github.com/algolia/api-clients-automation/pull/2400)) by [@millotp](https://github.com/millotp/)
+- [1e7c50d2f](https://github.com/algolia/api-clients-automation/commit/1e7c50d2f) feat(ruby): retry strategy ([#2383](https://github.com/algolia/api-clients-automation/pull/2383)) by [@millotp](https://github.com/millotp/)
+- [614d56ae8](https://github.com/algolia/api-clients-automation/commit/614d56ae8) fix(ruby): make the playground work ([#2379](https://github.com/algolia/api-clients-automation/pull/2379)) by [@millotp](https://github.com/millotp/)
+- [8d71c2b69](https://github.com/algolia/api-clients-automation/commit/8d71c2b69) fix(specs): provide non clashing names for custom methods ([#2369](https://github.com/algolia/api-clients-automation/pull/2369)) by [@shortcuts](https://github.com/shortcuts/)
+- [205519c6f](https://github.com/algolia/api-clients-automation/commit/205519c6f) fix(specs): highlight result map definition ([#2312](https://github.com/algolia/api-clients-automation/pull/2312)) by [@shortcuts](https://github.com/shortcuts/)
+- [a8f2565a0](https://github.com/algolia/api-clients-automation/commit/a8f2565a0) fix(ruby): add libraries in the Dockerfile ([#2333](https://github.com/algolia/api-clients-automation/pull/2333)) by [@millotp](https://github.com/millotp/)
+- [b97259611](https://github.com/algolia/api-clients-automation/commit/b97259611) chore(ruby): fix renovate config ([#2314](https://github.com/algolia/api-clients-automation/pull/2314)) by [@shortcuts](https://github.com/shortcuts/)
+- [833b489d1](https://github.com/algolia/api-clients-automation/commit/833b489d1) feat(ruby): setup client ([#2311](https://github.com/algolia/api-clients-automation/pull/2311)) by [@millotp](https://github.com/millotp/)
 
-## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.3.2..master)
-
-## [2.3.4](https://github.com/algolia/algoliasearch-client-ruby/compare/2.3.3...2.3.4) (2023-11-27)
-### Fixed
-- Fixes issue with index name encoding for certain characters.
-
-## [2.3.3](https://github.com/algolia/algoliasearch-client-ruby/compare/2.3.2...2.3.3) (2023-11-14)
-### Fixed
-- Fixed issue with connection caching for faulty hosts that accept similar requests ([`#496`](https://github.com/algolia/algoliasearch-client-ruby/pull/496))
-
-## [2.3.2](https://github.com/algolia/algoliasearch-client-ruby/compare/2.3.1...2.3.2) (2023-06-07)
-### Fixed
-- Fixed issue with Request not taking timeouts into account ([`#493`](https://github.com/algolia/algoliasearch-client-ruby/pull/493))
-
-## [2.3.1](https://github.com/algolia/algoliasearch-client-ruby/compare/2.3.0...2.3.1) (2022-09-26)
-### Fixed
-- Fixed issue when project uses Faraday <1 ([`#485`](https://github.com/algolia/algoliasearch-client-ruby/pull/485))
-
-## [2.3.0](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.5...2.3.0) (2022-09-26)
-### Changed
-- Dropped support for Ruby < 2.4 ([`#483`](https://github.com/algolia/algoliasearch-client-ruby/pull/483))
-- Updated Faraday dependency range ([`#471`](https://github.com/algolia/algoliasearch-client-ruby/pull/471))
-- Fixed bug with `createIfNotExists` ([`#458`](https://github.com/algolia/algoliasearch-client-ruby/pull/458))
-- Use user-configured logger to temp client ([`#480`](https://github.com/algolia/algoliasearch-client-ruby/pull/480))
-
-## [2.2.5](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.4...2.2.5) (2022-05-24)
-### Fixed
-- multiple_queries: allow params to be `nil` ([`#478`](https://github.com/algolia/algoliasearch-client-ruby/pull/478))
-
-## [2.2.4](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.3...2.2.4) (2022-05-24)
-### Fixed
-- API endpoint URL mishandling in get_settings method ([`#473`](https://github.com/algolia/algoliasearch-client-ruby/pull/473))
-- Confusing empty debug.log generation in gem users root ([`#474`](https://github.com/algolia/algoliasearch-client-ruby/pull/474))
-
-## [2.2.3](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.2...2.2.3) (2022-04-21)
-### Fixed
-- API polling flood issue due to msec sleep time mishandling ([`#472`](https://github.com/algolia/algoliasearch-client-ruby/pull/472))
-- mailto link in SECURITY.md ([`#463`](https://github.com/algolia/algoliasearch-client-ruby/pull/463))
-
-### Added
-- allow hash in multiple queries ([`#468`](https://github.com/algolia/algoliasearch-client-ruby/pull/468))
-
-## [2.2.2](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.1...2.2.2) (2021-12-08)
-### Fixed
-- Added a `status` field to the `MockRequester` ([`#467`](https://github.com/algolia/algoliasearch-client-ruby/pull/467))
-
-## [2.2.1](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.0...2.2.1) (2021-11-12)
-### Chore
-- Deprecated `RecommendationClient` in favor of `PersonalizationClient` ([`#461`](https://github.com/algolia/algoliasearch-client-ruby/pull/461))
-
-## [2.2.0](https://github.com/algolia/algoliasearch-client-ruby/compare/2.1.1...2.2.0) (2021-11-08)
-### Added
-- Added RecommendClient ([`#466`](https://github.com/algolia/algoliasearch-client-ruby/pull/466))
-- Added `search` alias for `multiple_queries` ([`#457`](https://github.com/algolia/algoliasearch-client-ruby/pull/457))
-
-## [2.1.1](https://github.com/algolia/algoliasearch-client-ruby/compare/2.1.0...2.1.1) (2021-05-27)
-
-### Fix
-- Bug with read/write nodes caching ([`#455`](https://github.com/algolia/algoliasearch-client-ruby/pull/455))
-
-## [2.1.0](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.4...2.1.0) (2021-03-30)
-
-### Feat
-- Custom dictionaries methods
-
-### Fix
-- The parameter `forwardToReplicas` should be handled independently in the `set_settings` method
-
-## [2.0.4](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.3...2.0.4) (2021-01-05)
-
-### Fix
-- `app_api_key`: send opts with waitable method
-
-## [2.0.3](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.2...2.0.3) (2020-11-24)
-
-### Chore
-- Containerize the repo
-
-## [2.0.2](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.1...2.0.2) (2020-11-09)
-
-### Fix
-- Don't mutate index name on stripping
-
-## [2.0.1](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.0...2.0.1) (2020-11-02)
-
-### Fix
-- Simplify merge of headers in `Transport` class
-- `deserialize_settings` function to take into account `symbolize_keys` parameter
-
-## [2.0.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/2.0.0) (2020-10-27)
-
-* Initial release of v2

data/Gemfile

@@ -1,18 +1,5 @@
-# typed: strong
+# frozen_string_literal: true
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in algolia.gemspec
 gemspec
-
-gem 'minitest-ci'
-
-group :development do
-  gem 'git-precommit'
-  gem 'steep' if RUBY_VERSION >= '2.5'
-  gem 'yard'
-end
-
-group :test do
-  gem 'simplecov'
-end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    algolia (3.0.0.alpha.2)
+      faraday (>= 1.0.1, < 3.0)
+      faraday-net_http_persistent (>= 0.15, < 3)
+      net-http-persistent
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.2.0)
+    connection_pool (2.4.1)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    faraday-net_http_persistent (2.1.0)
+      faraday (~> 2.5)
+      net-http-persistent (~> 4.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    net-http-persistent (4.0.2)
+      connection_pool (~> 2.2)
+    parallel (1.24.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  aarch64-linux
+  x86_64-linux
+
+DEPENDENCIES
+  algolia!
+  bundler
+  rake
+  rubocop
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -24,8 +24,7 @@
 
 ## ✨ Features
 
-- Thin & minimal low-level HTTP client to interact with Algolia's API
-- Supports Ruby `^2.4`.
+Thin & minimal low-level HTTP client to interact with Algolia's API
 
 ## 💡 Getting Started
 
@@ -38,15 +37,14 @@ Then, create objects on your index:
 
 
 ```ruby
-client = Algolia::Search::Client.create('YourApplicationID', 'YourAPIKey')
-index = client.init_index('your_index_name')
+client = Algolia::SearchClient.create('YourApplicationID', 'YourAPIKey')
 
-index.save_objects([{objectID: 1, name: 'Foo'}])
+client.save_object('your_index_name', {objectID: 1, name: 'Foo'})
 ```
 
 Finally, you may begin searching a object using the `search` method:
 ```ruby
-objects = index.search('Foo')
+objects = client.search_single_index('your_index_name', 'Foo')
 ```
 
 For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.

data/Rakefile

@@ -1,45 +1,6 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
 require 'rubocop/rake_task'
-require 'git_precommit'
 
 task(:default) { system 'rake --tasks' }
-task test: 'test:unit'
 
 RuboCop::RakeTask.new
-GitPrecommit::PrecommitTasks.new
-
-task :precommit do
-  Rake::Task['rubocop'].invoke
-end
-
-namespace :test do
-  Rake::TestTask.new(:unit) do |t|
-    t.libs << 'test'
-    t.libs << 'lib'
-    t.test_files = FileList['test/algolia/unit/**/*_test.rb']
-    t.verbose    = true
-    t.warning    = false
-  end
-
-  Rake::TestTask.new(:integration) do |t|
-    t.libs << 'test'
-    t.libs << 'lib'
-    t.test_files = FileList['test/algolia/integration/**/*_test.rb']
-    t.verbose    = true
-    t.warning    = false
-  end
-
-  desc 'Run unit and integration tests'
-  task :all do
-    Rake::Task['test:unit'].invoke
-    Rake::Task['test:integration'].invoke
-  end
-end
-
-desc 'Run linting, unit and integration tests'
-task :all do
-  Rake::Task['rubocop'].invoke
-  Rake::Task['test:unit'].invoke
-  Rake::Task['test:integration'].invoke
-end

data/algolia.gemspec

@@ -1,50 +1,35 @@
-require 'date'
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'algolia/version'
+require 'date'
 
-Gem::Specification.new do |spec|
-  spec.name          = 'algolia'
-  spec.version       = Algolia::VERSION
-  spec.authors       = ['Algolia']
-  spec.email         = ['support@algolia.com']
-
-  spec.date        = Date.today
-  spec.licenses    = ['MIT']
-  spec.summary     = 'A simple Ruby client for the algolia.com REST API'
-  spec.description = 'A simple Ruby client for the algolia.com REST API'
-  spec.homepage    = 'https://github.com/algolia/algoliasearch-client-ruby'
-
-  spec.metadata = {
+Gem::Specification.new do |s|
+  s.name        = 'algolia'
+  s.version     = Algolia::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Algolia']
+  s.email       = ['support@algolia.com']
+  s.homepage    = 'https://github.com/algolia/algoliasearch-client-ruby'
+  s.summary     = 'A simple Ruby client for the algolia.com REST API'
+  s.description = 'A simple Ruby client for the algolia.com REST API'
+  s.licenses    = ['MIT']
+
+  s.metadata = {
     'bug_tracker_uri' => 'https://github.com/algolia/algoliasearch-client-ruby/issues',
-    'documentation_uri' => 'https://www.algolia.com/doc/api-client/getting-started/install/ruby',
-    'source_code_uri' => 'https://github.com/algolia/algoliasearch-client-ruby'
+    'source_code_uri' => 'https://github.com/algolia/algoliasearch-client-ruby',
+    'rubygems_mfa_required' => 'true'
   }
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem
-  # that have been added into git.
-  spec.files         = `git ls-files`.split($/)
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop', '<= 0.82.0'
+  s.files         = `find *`.split("\n").uniq.sort.reject(&:empty?)
+  s.executables   = []
+  s.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', ['>= 0.15', '< 3']
-  spec.add_dependency 'faraday-net_http_persistent', ['>= 0.15', '< 3']
+  s.add_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_dependency 'faraday-net_http_persistent', ['>= 0.15', '< 3']
 
-  spec.add_dependency 'multi_json', '~> 1.0'
-  spec.add_dependency 'net-http-persistent'
+  s.add_dependency 'net-http-persistent'
 
-  spec.add_development_dependency 'httpclient'
-  spec.add_development_dependency 'm'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'minitest-hooks'
-  spec.add_development_dependency 'minitest-proveit'
-  spec.add_development_dependency 'webmock'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubocop'
 end