rubyrana 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a23b823b6f21c5d8093c355b4c0a4fdcb8e5268b075163708d4e3d0042e556b0
+  data.tar.gz: f3b7ecd4ff79260a1d24fde0c8028dd496a89973212c356949fee339b9e612f4
+SHA512:
+  metadata.gz: a540d2da6e926c6b9abd75761a978000785fb4b0951a95f6df641b222e34df7e62fb202013eb331f975422c7d55bea5ce7266ac667662119c3f5ce2deb1aa85d
+  data.tar.gz: 986c64f68ea2fab6cee3851649b28aa8c8fb14356bad86aa84962e2e01748e656671773c17f5b1664b22a6827009f4828c160737f14983343ef5b5448befc691

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.0
+- Initial MVP scaffolding
+- Agent loop with tool calling
+- Anthropic provider integration
+- MCP client (experimental)
+- Streaming fallback
+- Built-in tools: code interpreter and web search (SerpAPI)

data/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Rubyrana Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,4 @@
+Rubyrana
+Copyright 2026 Rubyrana Contributors
+
+This product is licensed under the Apache License, Version 2.0.

data/README.md

@@ -0,0 +1,179 @@
+<div align="center">
+  <div>
+    <img src="https://placehold.co/80x80" alt="Rubyrana" width="80" height="80">
+  </div>
+
+  <h1>Rubyrana</h1>
+  <h2>Build production-ready AI agents in Ruby with just a few lines of code.</h2>
+
+  <div align="center">
+    <img alt="Gem version" src="https://img.shields.io/gem/v/rubyrana" />
+    <img alt="Ruby" src="https://img.shields.io/badge/ruby-%3E%3D%203.1-brightgreen" />
+    <img alt="License" src="https://img.shields.io/badge/license-Apache%202.0-blue" />
+  </div>
+
+  <p>
+    <a href="#quick-start">Quick Start</a>
+    ◆ <a href="#features">Features</a>
+    ◆ <a href="#tools">Tools</a>
+    ◆ <a href="#model-providers">Model Providers</a>
+    ◆ <a href="#mcp">MCP</a>
+  </p>
+</div>
+
+Rubyrana is a lightweight, model-driven Ruby SDK for building AI agents. Start with a simple conversational assistant, then scale to multi-tool workflows and production deployments.
+
+## Quick Start
+
+```bash
+# Install Rubyrana
+bundle add rubyrana
+```
+
+```ruby
+require "rubyrana"
+
+Rubyrana.configure do |config|
+  config.default_provider = Rubyrana::Providers::Anthropic.new(
+    api_key: ENV.fetch("ANTHROPIC_API_KEY"),
+    model: ENV.fetch("ANTHROPIC_MODEL", "claude-3-haiku-20240307")
+  )
+end
+
+agent = Rubyrana::Agent.new
+puts agent.call("What is the square root of 1764?")
+```
+
+> **Note:** Configure your Anthropic credentials before running.
+
+## Features
+
+- **Simple agent loop** with a clean Ruby API
+- **Anthropic-first** provider integration with tool calling and streaming
+- **Tooling-first design** for structured, safe function calls
+- **Streaming-ready** architecture (planned)
+- **MCP support** to connect thousands of tools (planned)
+
+## Tools
+
+Create tools with a Ruby DSL:
+
+```ruby
+require "rubyrana"
+
+word_count = Rubyrana::Tool.new("word_count") do |text:|
+  text.split.size
+end
+
+agent = Rubyrana::Agent.new(tools: [word_count])
+puts agent.call("How many words are in this sentence?")
+```
+
+### Built-in Tools
+
+Rubyrana ships with optional built-in tools:
+
+```ruby
+require "rubyrana"
+
+tools = [
+  Rubyrana::Tools.code_interpreter,
+  Rubyrana::Tools.web_search
+]
+
+agent = Rubyrana::Agent.new(tools: tools)
+puts agent.call("Search Ruby 3.3 release highlights and summarize.")
+```
+
+> **Note:** `web_search` requires users to bring their own `WEB_SEARCH_API_KEY` (Serper). `code_interpreter` runs code in a local process.
+
+### Tool Decorators + Loader
+
+Define tools with a simple Ruby decorator and load them from a directory:
+
+```ruby
+require "rubyrana"
+
+Rubyrana.tool("hello", description: "Greet a user", schema: {
+  type: "object",
+  properties: { name: { type: "string" } },
+  required: ["name"]
+}) do |name:|
+  "Hello, #{name}!"
+end
+
+agent = Rubyrana::Agent.new(load_tools_from: "./tools")
+puts agent.call("Use the hello tool to greet Ajay")
+```
+
+### Web Search via MCP (Preferred)
+
+If you want a Strands-style approach, delegate web search to an MCP server:
+
+```ruby
+require "rubyrana"
+
+web_search = Rubyrana::Tools.web_search_mcp(
+  command: "uvx",
+  args: ["awslabs.aws-documentation-mcp-server@latest"],
+  tool_name: "search_documentation"
+)
+
+agent = Rubyrana::Agent.new(tools: [web_search])
+puts agent.call("Search Bedrock docs and summarize the key points.")
+```
+
+Hot-reload tools from a folder:
+
+```ruby
+agent = Rubyrana::Agent.new(load_tools_from: "./tools")
+agent.call("Use any tools you find in the tools directory")
+```
+
+## MCP (Experimental)
+
+Connect Model Context Protocol servers:
+
+```ruby
+require "rubyrana"
+
+mcp = Rubyrana::MCP::Client.new(command: "uvx", args: ["awslabs.aws-documentation-mcp-server@latest"])
+
+mcp.with_session do |tools|
+  agent = Rubyrana::Agent.new(tools: tools)
+  puts agent.call("Tell me about Amazon Bedrock and how to use it with Ruby")
+end
+```
+
+## Model Provider
+
+Rubyrana is Anthropic-native today.
+
+Example:
+
+```ruby
+require "rubyrana"
+
+model = Rubyrana::Providers::Anthropic.new(
+  api_key: ENV.fetch("ANTHROPIC_API_KEY"),
+  model: ENV.fetch("ANTHROPIC_MODEL", "claude-3-haiku-20240307")
+)
+
+agent = Rubyrana::Agent.new(model: model)
+puts agent.call("Explain agentic workflows in simple terms")
+```
+
+## Documentation
+
+- Getting Started
+- Core Concepts
+- Tools & MCP
+- Production Deployment
+
+## Contributing
+
+Contributions are welcome. Please open issues and PRs with clear reproduction steps and context.
+
+## License
+
+Apache 2.0

data/REPORT.md

@@ -0,0 +1,156 @@
+# Rubyrana Feasibility & Implementation Report
+
+This report evaluates whether the README goal is buildable and outlines what is required to deliver it as a Ruby gem. The README is treated as the target product spec.
+
+## Executive Summary
+
+Yes, this is buildable. Rubyrana can be implemented as a Ruby gem with a small, composable core plus optional provider and MCP integrations. The main complexity is in provider adapters and streaming/MCP support. A staged build plan can deliver a usable v0.1 quickly, then layer advanced features.
+
+## Target Capabilities (from README)
+
+1. **Simple agent loop** with clean Ruby API
+2. **Anthropic-only** model support
+3. **Tools system** with a Ruby DSL and directory hot-reload
+4. **Streaming** support
+5. **MCP support** via external servers
+
+## What We Need to Build
+
+### 1) Core Gem Structure
+**Deliverables**
+- Gem skeleton (gemspec, lib/ directory, versioning)
+- `Rubyrana::Agent` API
+- `Rubyrana::Tool` and tool registry
+- Logging + configuration
+
+**Suggested File Structure**
+```
+lib/
+  rubyrana.rb
+  rubyrana/version.rb
+  rubyrana/agent.rb
+  rubyrana/tool.rb
+  rubyrana/tool_registry.rb
+  rubyrana/config.rb
+  rubyrana/errors.rb
+  rubyrana/serialization.rb
+  rubyrana/streaming/
+  rubyrana/providers/
+  rubyrana/mcp/
+```
+
+### 2) Agent Loop
+**Core responsibilities**
+- Accept a prompt and optional conversation history
+- Call selected model provider
+- Parse tool calls, invoke tools, and return a final response
+- Provide a streaming mode
+
+**What to implement**
+- `Rubyrana::Agent#call(prompt, **opts)`
+- `Rubyrana::Agent#stream(prompt, **opts)`
+- Minimal memory: request + response history
+
+### 3) Tooling System
+**Requirements**
+- A Ruby DSL to define tools
+- Type/shape for tool inputs
+- Tool invocation engine
+
+**Implementation notes**
+- Use `Rubyrana::Tool.new(name, description: ..., schema: ...) { |**args| ... }`
+- For schema validation: use JSON Schema or a simple Ruby contract system
+- Tool registry in `Rubyrana::ToolRegistry`
+
+**Hot Reloading**
+- Watch a `./tools` directory and load tools
+- Use `listen` gem for filesystem events
+
+### 4) Model Provider
+**Implementation**
+- Provider base class: `Rubyrana::Provider::Base`
+- `#complete(prompt, tools:, stream:)` interface
+
+**Required adapter**
+- Anthropic (HTTP API)
+
+**Dependencies**
+- `faraday` or `httpx` for HTTP
+
+### 5) MCP Integration
+**Goal**
+- Connect to MCP servers via stdio or HTTP
+
+**Implementation**
+- Add `Rubyrana::MCP::Client` that manages MCP lifecycle
+- Use `mcp` protocol JSON-RPC style
+- Provide `list_tools` and convert MCP tool defs into `Rubyrana::Tool`
+
+**Dependencies**
+- If using stdio: spawn a process and read/write JSON
+- Ruby JSON-RPC support (custom or existing gem)
+
+### 6) Streaming
+**Goal**
+- Return tokens incrementally
+
+**Implementation**
+- Provider adapters must support streaming
+- Agent exposes `#stream` returning an enumerator or block callback
+
+### 7) Error Handling & Telemetry
+**Deliverables**
+- Standard error types
+- Retriable failures
+- Optional logging and tracing hooks
+
+### 8) Tests & CI
+**Required**
+- Unit tests for agent, tools, providers
+- Integration tests with mock HTTP
+- CI workflow (GitHub Actions)
+
+## Feasibility Notes
+
+- **Core agent + tools**: straightforward; Ruby is well-suited for this.
+- **Provider adapter**: ensure request/response formats and tool use are correct.
+- **MCP**: feasible but requires careful process IO handling and tool conversion.
+- **Streaming**: depends on provider support; implement per-provider streaming.
+
+## Proposed Delivery Plan
+
+### Phase 0 — Foundations (1–2 weeks)
+- Gem skeleton
+- Agent loop (non-streaming)
+- Tool system
+- Anthropic adapter
+- Minimal README
+
+### Phase 1 — Streaming & Hardening (2–3 weeks)
+- Streaming interface
+- Robust errors
+
+### Phase 2 — MCP Integration (2–3 weeks)
+- MCP client via stdio
+- Tool conversion + lifecycle
+- Examples
+
+### Phase 3 — Production Readiness (ongoing)
+- CI, tests, docs site
+- Performance and retries
+
+## Gaps to Resolve Before Implementation
+
+1. **Exact API design** for tools and agent history
+2. **Anthropic model selection**
+3. **Streaming interface**: enumerator vs callback
+4. **MCP client spec**: confirm protocol requirements
+5. **Gem naming** and branding assets
+
+## Recommendation
+
+Proceed with an Anthropic-native SDK that mirrors the README and emphasizes tool use, streaming, and MCP.
+
+---
+
+If you want, I can now scaffold the gem, implement the Phase 0 core, and evolve the README to match the actual API as we build.

data/docs/CHECKLIST.md

@@ -0,0 +1,32 @@
+# Rubyrana Product Checklist
+
+## Core Capabilities
+- [x] Anthropic provider integration
+- [x] Tool calling loop
+- [x] Streaming support
+- [x] Conversation memory
+- [x] Safety filters
+- [x] Persistence (file + Redis)
+- [x] Multi-agent routing
+
+## Tooling Framework
+- [x] Tool registry
+- [x] Tool decorator (`Rubyrana.tool`)
+- [x] Tool loader (directory)
+- [x] MCP client integration
+- [x] MCP-based web search tool
+
+## Built-in Tools
+- [x] Code interpreter
+- [x] Web search (Serper)
+
+## Developer Experience
+- [x] Examples
+- [x] Usage docs
+- [x] Release checklist
+- [x] Tests + CI
+
+## Packaging
+- [x] Gem metadata
+- [x] License + NOTICE
+- [x] Changelog

data/docs/RELEASE.md

@@ -0,0 +1,16 @@
+# Release Checklist
+
+## Pre-release
+- Ensure tests pass on Ruby 3.1, 3.2, 3.3
+- Update CHANGELOG.md with release notes
+- Verify README and docs reflect the current API
+- Confirm gemspec metadata (homepage, authors, email)
+
+## Release
+- Tag release in git (e.g., v0.1.0)
+- Build gem: `gem build rubyrana.gemspec`
+- Push gem: `gem push rubyrana-0.1.0.gem`
+
+## Post-release
+- Update any version references
+- Announce the release

data/docs/USAGE.md

@@ -0,0 +1,54 @@
+# Rubyrana Usage
+
+## Quick Start
+
+1) Install the gem:
+
+- Add to your Gemfile:
+  - gem "rubyrana"
+
+2) Configure a provider:
+
+- Set an environment variable (e.g., ANTHROPIC_API_KEY)
+- Configure Rubyrana:
+  - Rubyrana.configure { |c| c.default_provider = Rubyrana::Providers::Anthropic.new(...) }
+
+3) Create an agent and call it:
+
+- agent = Rubyrana::Agent.new
+- agent.call("Hello")
+
+## Tools
+
+Define tools with a Ruby block and pass them to the agent:
+
+- word_count = Rubyrana::Tool.new("word_count") { |text:| text.split.size }
+- agent = Rubyrana::Agent.new(tools: [word_count])
+
+### Built-in Tools
+
+- code_interpreter: execute Ruby code in a temporary process
+- web_search: Serper-backed web search (users must supply WEB_SEARCH_API_KEY)
+- web_search_mcp: MCP-backed web search (users supply MCP server command/args)
+
+Example:
+
+- tools = [Rubyrana::Tools.code_interpreter, Rubyrana::Tools.web_search]
+- agent = Rubyrana::Agent.new(tools: tools)
+
+## Tool Decorators + Loader
+
+Define tools anywhere using `Rubyrana.tool`:
+
+- Rubyrana.tool("hello") { |name:| "Hello, #{name}!" }
+
+Load tools from a directory:
+
+- agent = Rubyrana::Agent.new(load_tools_from: "./tools")
+
+## MCP (Experimental)
+
+Use the MCP client to load tools:
+
+- mcp = Rubyrana::MCP::Client.new(command: "uvx", args: ["awslabs.aws-documentation-mcp-server@latest"])
+- mcp.with_session { |tools| Rubyrana::Agent.new(tools: tools).call("...") }

data/examples/mcp.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "dotenv/load"
+require "rubyrana"
+
+mcp = Rubyrana::MCP::Client.new(
+  command: "uvx",
+  args: ["awslabs.aws-documentation-mcp-server@latest"]
+)
+
+mcp.with_session do |tools|
+  Rubyrana.configure do |config|
+    config.debug = true
+    config.default_provider = Rubyrana::Providers::Anthropic.new(
+      api_key: ENV.fetch("ANTHROPIC_API_KEY"),
+      model: ENV.fetch("ANTHROPIC_MODEL", "claude-3-haiku-20240307")
+    )
+  end
+
+  agent = Rubyrana::Agent.new(tools: tools)
+  puts agent.call("What is Amazon Bedrock?")
+end