algolia 3.34.2 → 3.34.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af622ae45477eb36e65251261be2d268e643f486eef9fa58ade403d9b0add27c
-  data.tar.gz: c65bb79725ceaea7da5c0d8a949029304b8235dffccc297cd6276494a80f1309
+  metadata.gz: 03d6bce34fbba23cd559298792898bbc4d1e3a3b68a57a842192dc6fc0334e2c
+  data.tar.gz: 9d30d5f50c4ece4c836738ef426988ebf7362dde85a4e544aba968ea96cd6a8b
 SHA512:
-  metadata.gz: ec3d2039e54ac77523aa16ac05bb912778f49eebdee8de760deb8a367df251f4ed151c019a9f48a443fccc4b61a7072a8775bddfe2423b3eb92ea2763baca62a
-  data.tar.gz: a763ee24d7b92f909f3c4b19fbd3dc203d031a1b0c6418807d9bc83e9f7cda2301a2fa80d4aaf34778f4c4e4a5c9e9c66dfd69d8741259657e6842bc877b066e
+  metadata.gz: b02665f3d715e8e109304d231009c8b1d4c53704b6f5ca74f359182ba5c0ac99b6a07305080f50f396e8ea6e39a29b6f9f27b8acf62713674ee1a866c15583b5
+  data.tar.gz: df7b681f76666269eeebb9e8092e17bea31add145e059d79b8ffcbbcd87787e4259d6f8eb4340c1f55d9c16aa8fe4290487f139bd26fb4add962df28a9474121

data/.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.4.8
+          ruby-version: 4.0.1
           bundler-cache: true
 
       - uses: rubygems/release-gem@1c162a739e8b4cb21a676e97b087e8268d8fc40b

data/AGENTS.md

@@ -0,0 +1,182 @@
+# RUBY CLIENT - AI AGENT INSTRUCTIONS
+
+## ⚠️ CRITICAL: CHECK YOUR REPOSITORY FIRST
+
+Before making ANY changes, verify you're in the correct repository:
+
+```bash
+git remote -v
+```
+
+- ✅ **CORRECT**: `origin .../algolia/api-clients-automation.git` → You may proceed
+- ❌ **WRONG**: `origin .../algolia/algoliasearch-client-ruby.git` → STOP! This is the PUBLIC repository
+
+**If you're in `algoliasearch-client-ruby`**: Do NOT make changes here. All changes must go through `api-clients-automation`. PRs and commits made directly to the public repo will be discarded on next release.
+
+## ⚠️ BEFORE ANY EDIT: Check If File Is Generated
+
+Before editing ANY file, verify it's hand-written by checking `config/generation.config.mjs`:
+
+```javascript
+// In generation.config.mjs - patterns WITHOUT '!' are GENERATED (do not edit)
+'clients/algoliasearch-client-ruby/lib/algolia/**',           // Generated
+'!clients/algoliasearch-client-ruby/lib/algolia/transport/**', // Hand-written ✓
+'!clients/algoliasearch-client-ruby/lib/algolia/error.rb',     // Hand-written ✓
+```
+
+**Hand-written (safe to edit):**
+
+- `lib/algolia/transport/**` - Transport, retry strategy, HTTP handling
+- `lib/algolia/api_client.rb` - Core API client
+- `lib/algolia/api_error.rb` - API error class
+- `lib/algolia/configuration.rb` - Configuration
+- `lib/algolia/error.rb` - Error base class
+- `lib/algolia/logger_helper.rb` - Logging utilities
+- `lib/algolia/user_agent.rb` - User agent handling
+
+**Generated (DO NOT EDIT):**
+
+- `lib/algolia/api/**` - API client classes
+- `lib/algolia/models/**` - API models
+- `Gemfile.lock`, `version.rb`
+
+## Language Conventions
+
+### Naming
+
+- **Files**: `snake_case.rb`
+- **Classes/Modules**: `PascalCase`
+- **Methods/Variables**: `snake_case`
+- **Constants**: `UPPER_SNAKE_CASE`
+- **Predicates**: `method_name?` (returns boolean)
+- **Dangerous methods**: `method_name!` (mutates or raises)
+
+### Formatting
+
+- RubyFmt for formatting
+- Run: `yarn cli format ruby clients/algoliasearch-client-ruby`
+
+### Ruby Idioms
+
+- Use `attr_reader`, `attr_accessor` for accessors
+- Prefer `||=` for memoization
+- Use `&.` safe navigation operator
+- Blocks over lambdas for callbacks
+
+### Dependencies
+
+- **HTTP**: Faraday (with Net::HTTP adapter)
+- **Build**: Bundler + gemspec
+- **Versions**: Ruby 3.4+
+
+## Client Patterns
+
+### Transport Architecture
+
+```ruby
+# lib/algolia/transport/
+class Transport
+  def initialize(config)
+    @http_requester = HttpRequester.new(config.app_id, config.api_key)
+    @retry_strategy = RetryStrategy.new(config.hosts)
+  end
+
+  def request(method, path, body, opts)
+    # Retry with host failover
+  end
+end
+```
+
+### Retry Strategy
+
+```ruby
+# lib/algolia/transport/retry_strategy.rb
+class RetryStrategy
+  # Host states: :up, :down, :timed_out
+  # Retries on network errors
+  # 4xx errors not retried
+end
+```
+
+### Configuration
+
+```ruby
+# Configuration object pattern
+config = Algolia::Configuration.new(
+  app_id: 'APP_ID',
+  api_key: 'API_KEY',
+  hosts: [...],
+  read_timeout: 5,
+  write_timeout: 30
+)
+```
+
+## Common Gotchas
+
+### Symbol vs String Keys
+
+```ruby
+# API returns string keys, use with_indifferent_access or symbols
+response[:hits]      # May not work
+response['hits']     # Works
+response.hits        # Works if using model objects
+```
+
+### Block Syntax
+
+```ruby
+# Use do..end for multi-line, braces for single-line
+client.search { |r| r.query = 'test' }
+
+client.search do |params|
+  params.query = 'test'
+  params.hits_per_page = 10
+end
+```
+
+### Error Handling
+
+```ruby
+begin
+  response = client.search(params)
+rescue Algolia::AlgoliaError => e
+  # Base error class
+rescue Algolia::ApiError => e
+  # API returned error
+  puts e.status_code
+  puts e.message
+end
+```
+
+### Nil Safety
+
+```ruby
+# Use safe navigation
+result&.hits&.first&.object_id
+
+# Or explicit checks
+if result && result.hits && result.hits.any?
+  result.hits.first.object_id
+end
+```
+
+### Deprecated Operations
+
+Some operations in `ingestion_client.rb` and `search_client.rb` are deprecated. Check method documentation before use.
+
+## Build & Test Commands
+
+```bash
+# From repo root (api-clients-automation)
+yarn cli build clients ruby                    # Build Ruby client
+yarn cli cts generate ruby                     # Generate CTS tests
+yarn cli cts run ruby                          # Run CTS tests
+yarn cli playground ruby search                # Interactive playground
+yarn cli format ruby clients/algoliasearch-client-ruby
+
+# From client directory
+cd clients/algoliasearch-client-ruby
+bundle install                                 # Install dependencies
+bundle exec rake test                          # Run tests
+bundle exec rubocop                            # Run linter
+```

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [3.34.4](https://github.com/algolia/algoliasearch-client-ruby/compare/3.34.3...3.34.4)
+
+- [f02ab6fa0](https://github.com/algolia/api-clients-automation/commit/f02ab6fa0) chore: agentic config prep ([#5825](https://github.com/algolia/api-clients-automation/pull/5825)) by [@Fluf22](https://github.com/Fluf22/)
+
+## [3.34.3](https://github.com/algolia/algoliasearch-client-ruby/compare/3.34.2...3.34.3)
+
+- [cd7a174b4](https://github.com/algolia/api-clients-automation/commit/cd7a174b4) fix(specs): BREAKING CHANGE — remove fields requirement from run response in CompAPI client ([#5809](https://github.com/algolia/api-clients-automation/pull/5809)) by [@ClaraMuller](https://github.com/ClaraMuller/)\
+Some fields from the Composition Run search response were marked as required while they were optional on the API side. This has been fixed, but might impact the client types.
+- [b08917039](https://github.com/algolia/api-clients-automation/commit/b08917039) chore(deps): dependencies 2025-12-29 ([#5792](https://github.com/algolia/api-clients-automation/pull/5792)) by [@algolia-bot](https://github.com/algolia-bot/)
+
 ## [3.34.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.34.1...3.34.2)
 
 - [005aa6524](https://github.com/algolia/api-clients-automation/commit/005aa6524) chore(deps): dependencies 2025-12-22 ([#5775](https://github.com/algolia/api-clients-automation/pull/5775)) by [@algolia-bot](https://github.com/algolia-bot/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.34.2)
+    algolia (3.34.4)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)

data/lib/algolia/models/composition/search_results_item.rb

@@ -341,44 +341,30 @@ module Algolia
           if (value = attributes[:hits]).is_a?(Array)
             self.hits = value
           end
-        else
-          self.hits = nil
         end
 
         if attributes.key?(:hits_per_page)
           self.hits_per_page = attributes[:hits_per_page]
-        else
-          self.hits_per_page = nil
         end
 
         if attributes.key?(:nb_hits)
           self.nb_hits = attributes[:nb_hits]
-        else
-          self.nb_hits = nil
         end
 
         if attributes.key?(:nb_pages)
           self.nb_pages = attributes[:nb_pages]
-        else
-          self.nb_pages = nil
         end
 
         if attributes.key?(:page)
           self.page = attributes[:page]
-        else
-          self.page = nil
         end
 
         if attributes.key?(:params)
           self.params = attributes[:params]
-        else
-          self.params = nil
         end
 
         if attributes.key?(:query)
           self.query = attributes[:query]
-        else
-          self.query = nil
         end
 
         if attributes.key?(:compositions)

data/lib/algolia/version.rb

@@ -3,5 +3,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 module Algolia
-  VERSION = "3.34.2"
+  VERSION = "3.34.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.34.2
+  version: 3.34.4
 platform: ruby
 authors:
 - https://alg.li/support
@@ -121,6 +121,7 @@ files:
 - ".github/workflows/issue.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
+- AGENTS.md
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -861,7 +862,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API
 test_files: []