Ajay Krishnan
e3e7b69c7f
Headline API:
reply = client.stream(session_id, "Explain monads") do |part|
print part["content"] if part["type"] == "text"
end
reply.full_text # final accumulated text
Sources ported from ajaynomics/ajent-rails lib/opencode/client/ after
the Phase-1+2 tier carve + Phase-2.5 boundary cleanup (see ajent-rails
PRs #840 and #843). Rails-runtime coupling stripped:
- Defaults read from ENV[OPENCODE_BASE_URL/SERVER_PASSWORD/TIMEOUT]
instead of Rails.application.config.x.opencode_blackline.*
- EventTraceable.timed_event(...) calls swapped for
Opencode::Instrumentation.instrument(...) — pluggable adapter
(default no-op) that callers wire to ActiveSupport::Notifications,
OpenTelemetry, stdout, etc.
Runtime dependency: activesupport (>= 6.1, < 9.0) for the small
core_ext surface (blank?/present?/presence/truncate/duplicable?/
megabytes). ActiveSupport is NOT Rails — it's a standalone helpers
gem that most Ruby apps already have transitively.
What's in the gem:
Opencode::Client HTTP + SSE client; #stream block-form API
Opencode::Reply SSE-event accumulator with observer protocol
Opencode::Reply::Result typed Struct value object
Opencode::ReplyObserver observer protocol module (no-op defaults)
Opencode::Prompts per-Reply pending question/permission registry
Opencode::Tracer callable that prefixes event names
Opencode::Instrumentation pluggable adapter
Opencode::ResponseParser wire-format extractors
Opencode::ToolPart canonical tool-part hash shape
Opencode::PartSource wire-vs-stream-only discriminator
Opencode::Todo todo status canonicalization
Opencode::Error (+ 7 subclasses)
What's out (per design D18 — wait for demand signal):
- acts_as_opencode_session concern
- ActiveRecord-backed session lifecycle
- rails generators
- opencode-rails as a separate gem
Instead, examples/conversation_recipe.rb ships as a ~140-line
plain-ActiveRecord blueprint demonstrating session lifecycle,
with_lock, update_columns mid-stream pattern, and CAS-safe finalize.
Tests: 12 runs, 25 assertions, 0 failures (smoke test against
WebMock-stubbed OpenCode endpoints — covers the postcard, error
model, Instrumentation, and Reply::Result shape).
Authored against ajent-rails commit 02954eeb (opencode-gem/phase-3-prep).
45 lines
2.0 KiB
Ruby
45 lines
2.0 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require_relative "lib/opencode/version"
|
|
|
|
Gem::Specification.new do |spec|
|
|
spec.name = "opencode-ruby"
|
|
spec.version = Opencode::VERSION
|
|
spec.authors = ["Ajay Krishnan"]
|
|
spec.email = ["ajay@krishnan.ca"]
|
|
|
|
spec.summary = "Idiomatic Ruby client for OpenCode (HTTP + SSE)."
|
|
spec.description = <<~DESC
|
|
Hand-rolled, opinionated Ruby SDK for OpenCode's REST + SSE API.
|
|
Block-form streaming, value-object responses, automatic SSE
|
|
reconnection. Complement to opencode_client (auto-generated from
|
|
OpenAPI) — pick this one if you want a small Ruby-idiomatic surface;
|
|
pick opencode_client if you want every endpoint with generated types.
|
|
DESC
|
|
spec.homepage = "https://gitea.krishnan.ca/ajaynomics/opencode-ruby"
|
|
spec.license = "MIT"
|
|
spec.required_ruby_version = ">= 3.2.0"
|
|
|
|
spec.metadata["source_code_uri"] = spec.homepage
|
|
spec.metadata["changelog_uri"] = "#{spec.homepage}/src/branch/main/CHANGELOG.md"
|
|
spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
|
|
|
|
spec.files = Dir.glob("lib/**/*.rb") +
|
|
Dir.glob("examples/**/*.rb") +
|
|
%w[README.md LICENSE CHANGELOG.md opencode-ruby.gemspec]
|
|
spec.require_paths = ["lib"]
|
|
|
|
# The only runtime dependency is ActiveSupport (NOT Rails). ActiveSupport
|
|
# is a standalone gem providing the `present?`/`blank?`/`presence`/
|
|
# `truncate`/`duplicable?` helpers used in this gem's code. It does NOT
|
|
# pull in ActiveRecord, ActionView, ActionController, Turbo, or any other
|
|
# Rails-only piece. Most Ruby apps in the wild already have ActiveSupport
|
|
# transitively via another gem; in the rare case yours doesn't, ~250 LOC
|
|
# of core_ext is added when this gem installs.
|
|
spec.add_runtime_dependency "activesupport", ">= 6.1", "< 9.0"
|
|
|
|
spec.add_development_dependency "minitest", "~> 5.20"
|
|
spec.add_development_dependency "rake", "~> 13.0"
|
|
spec.add_development_dependency "webmock", "~> 3.20"
|
|
end
|