Summary
The repository’s current HEAD no longer ships the Ruby client implementation under lib/, but the README and all example scripts still instruct users to require "hlquery" and instantiate Hlquery::Client. As a result, the client is effectively unusable in its current state. This should be treated as a high-priority issue because the package currently presents a working SDK surface while publishing only documentation and examples.
Context
Recent history shows a sharp regression in repository functionality:
This is especially important for a high-performance search engine wrapper because client correctness is the entry point for every integration, benchmark, and production workload. Right now, users cannot even establish a baseline connection or exercise search, document, or collection APIs from Ruby.
Proposed Implementation
- Restore a supported runtime under
lib/, either by reintroducing the modular client from 208418a or replacing it with a smaller maintained implementation that preserves the documented API.
- Align the public contract across
README.md, example.rb, and examples/*.rb so every documented call maps to code that actually exists.
- Add a minimal smoke test or CI check that only verifies:
require "hlquery" succeedsHlquery::Client.new(...) is loadable- the documented top-level entry points (
health, collections, documents, search) are defined
- Fail CI on any future commit where docs/examples reference methods or files that are no longer shipped.
Impact
Fixing this restores the repository from a documentation-only shell to a usable SDK. It prevents users from hitting immediate runtime failures, re-establishes trust in the Ruby client, and creates a basic guardrail against future regressions where public examples drift away from the actual shipped client surface.
Summary
The repository’s current
HEADno longer ships the Ruby client implementation underlib/, but the README and all example scripts still instruct users torequire "hlquery"and instantiateHlquery::Client. As a result, the client is effectively unusable in its current state. This should be treated as a high-priority issue because the package currently presents a working SDK surface while publishing only documentation and examples.Context
Recent history shows a sharp regression in repository functionality:
208418aintroduced a modular Ruby client with endpoint APIs underlib/hlquery/*.rb.fb8f481removed that implementation entirely.HEADstill contains README.md, example.rb, and the scripts in /home/cferry/p/hlquery/ruby-api/examples, all of which assumelib/hlqueryexists.This is especially important for a high-performance search engine wrapper because client correctness is the entry point for every integration, benchmark, and production workload. Right now, users cannot even establish a baseline connection or exercise search, document, or collection APIs from Ruby.
Proposed Implementation
lib/, either by reintroducing the modular client from208418aor replacing it with a smaller maintained implementation that preserves the documented API.README.md,example.rb, andexamples/*.rbso every documented call maps to code that actually exists.require "hlquery"succeedsHlquery::Client.new(...)is loadablehealth,collections,documents,search) are definedImpact
Fixing this restores the repository from a documentation-only shell to a usable SDK. It prevents users from hitting immediate runtime failures, re-establishes trust in the Ruby client, and creates a basic guardrail against future regressions where public examples drift away from the actual shipped client surface.