evalgate-sdk 3.17.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2228fc710e97f827a5fc0a84480fce289b691b4765e7ab0150ec4583eb61ca41
+  data.tar.gz: ea68b4cba43e3cc8d4f8b3d5617e44299bc8289dd79f5de8b41b0e7b9293398e
+SHA512:
+  metadata.gz: ab4a973ab92d0585499fb14332e334b0740539281029b13c026d4b42bab93edffadb12f3cf1c686810a7569f43ca186a8337ef2a2b878db721e283a53f4ba2fd
+  data.tar.gz: 99138479dc8883fea4c8ade0370cc498e7c8aaa445cfb0c06ca049e784e254c74adb51c2ffcf3bb42ad7e56bd6904db34f3901fc0df4bd05b570f454c6958630

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Paul Carpenter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# EvalGate Ruby SDK
+
+Official EvalGate REST client with generated operation methods, model validation,
+and RBS signatures from EvalGate's verified public OpenAPI contract.
+Product and package homepage: https://evalgate.com.
+
+Requires Ruby 3.2 or newer. Only Ruby standard/default libraries are used.
+
+Install from RubyGems:
+
+```sh
+gem install evalgate-sdk --version 3.17.0
+```
+
+```ruby
+require "evalgate"
+
+client = EvalGate::Client.new(
+  api_key: ENV.fetch("EVALGATE_API_KEY"),
+  organization_id: ENV.fetch("EVALGATE_ORGANIZATION_ID")
+)
+response = client.get_evaluations(query: { limit: 10 })
+puts response.headers["ratelimit"]
+
+body = EvalGate::Models::PostApiEvaluationsRequest.new(name: "Release checks")
+client.post_evaluations(body: body, idempotency_key: "release-checks-001")
+```
+
+The read requires an `eval:read` scoped API key; the example mutation requires
+`eval:write`. The service enforces scopes and organization authorization. Use
+human-approved credentials and a disposable local EvalGate instance for writes
+while testing. Configure `base_url:` for that instance.
+
+Every operation in `EvalGate::OPERATIONS` has a generated snake_case method.
+Pass `path:`, `query:`, and declared `headers:` maps; required and unknown
+parameters are checked before sending a request. JSON bodies may be generated
+models or hashes. Object models validate documented required fields and primitive
+types, and support `model.name`, `model[:name]`, and `model.to_h`. Unions without
+one concrete Ruby class retain ordinary JSON values. Access fields named after
+inherited Ruby methods, such as `method`, `methods`, or `hash`, with `model[:method]`.
+Their JSON fields remain available without replacing Ruby's built-in methods.
+Models preserve nullable collections: pass `nil` for JSON `null`, `[]` or `{}`
+for explicit empty collections, and leave out an optional keyword to omit it.
+Nonnullable array/map fields reject `nil`; their RBS types follow the same schema.
+The `sig/` directory contains RBS 3+ signatures; `generation.json` pins the
+contract digest and operation inventory.
+
+`response.data`, `response.status`, and `response.headers` preserve successful
+responses. `EvalGate::APIError` exposes `status`, `code`, `request_id`, `headers`,
+and `data`. On a 429, inspect `error.headers["retry-after"]` and the live
+`ratelimit` / `ratelimit-policy` values before rescheduling. The client does not
+retry requests automatically or follow redirects. A mutation's `idempotency_key:`
+should identify the same logical operation across retries.
+
+```ruby
+client.paginate("get_evaluations", query: { limit: 50 }, max_pages: 100).each do |page|
+  puts page.data
+end
+```
+
+The paginator follows the generated cursor/offset/page contract, rejects repeated
+cursors and no-progress pages, and raises when `max_pages` is exhausted rather
+than silently truncating. Each HTTP operation defaults to a 30 second timeout;
+set `timeout:` at client creation to change it.
+
+To verify an independent checkout of this Ruby package:
+
+```sh
+ruby -Ilib test/client_test.rb
+gem build evalgate.gemspec
+gem install --local --no-document evalgate-sdk-3.17.0.gem
+```
+
+From the platform source repository, check generated client freshness:
+
+```sh
+node scripts/generate-sdk-ecosystems.mjs --check
+```
+
+The gem uses an explicit file allowlist: runtime Ruby, RBS, README, MIT license,
+and the generated contract manifest. Private platform source, deployment files,
+and credentials are excluded.
+
+Documentation: https://www.evalgate.com/docs/sdk/ruby. Support: hello@evalgate.com.