riffer 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6879b09034df7490183743a1f62d7d43805e61ddfcd804f74e6552e85f48a3a3
-  data.tar.gz: 73d817a987399225ea10157707e51be0e3fed8495081b16c023cac69a8d0b284
+  metadata.gz: 2a36bd54b70a03d93c4b955823477288bb7a52fc7f2be090dad466b8aa1ef5dd
+  data.tar.gz: 2d305b20b5f85dc3dfdb632624849cc83e9abc049739c703f03da1661fe342e8
 SHA512:
-  metadata.gz: cc39f949b65485f6a7ae08470d6491dc81680c718d0ff3ecb25acf2231f6d5926d0fc27980f3df52589cd0ec36d1998a50fc7eee6b975eb792bc03eefb3408e7
-  data.tar.gz: b7762e97f27aa78a23ef1f56d0b292d4c84c42efca631c4154474448d10d610231f3e98ed8bc676f54dab3a31d6ea82f11f4e284b9df72269bf0bbe1c6994153
+  metadata.gz: 3d82cd6aff279eb94ff710c7c7d3462a81f17a97d93f19c6df9d93cc83749e0d30ac5e8956b4e802ac2e2097c5c816f315a8027be47ce98ed16e7382d1937437
+  data.tar.gz: e4d964bc0c1ad34c29639c8ba4a9b5b28a62376608d8b9b4e383127bf55d0948795a820f00f80ee3b71e2bbda61e78b5b6e6f4fc91534058f7069ad1fca3f025

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.4.0"
+  ".": "0.4.1"
 }

data/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.1](https://github.com/bottrall/riffer/compare/riffer/v0.4.0...riffer/v0.4.1) (2025-12-29)
+
+
+### Bug Fixes
+
+* add conditional check for docs job execution based on release creation ([#58](https://github.com/bottrall/riffer/issues/58)) ([97bc6f7](https://github.com/bottrall/riffer/commit/97bc6f79b20902f94edac35b7d9d25c2e033d8bd))
+* add permissions for contents in docs job ([#57](https://github.com/bottrall/riffer/issues/57)) ([1dd5f7a](https://github.com/bottrall/riffer/commit/1dd5f7a817d4f73c1a0cad1a93fee0148ef10705))
+* suppress output during documentation generation ([#53](https://github.com/bottrall/riffer/issues/53)) ([6b7f2d9](https://github.com/bottrall/riffer/commit/6b7f2d9aa7adb5450855097840c971dcf201d8c0))
+* update rdoc command to target the lib directory ([#56](https://github.com/bottrall/riffer/issues/56)) ([c319efe](https://github.com/bottrall/riffer/commit/c319efe039ddb118411ad9e270dc0994d3b8cf5c))
+
 ## [0.4.0](https://github.com/bottrall/riffer/compare/riffer/v0.3.2...riffer/v0.4.0) (2025-12-29)
 
 

data/README.md

@@ -1,43 +1,142 @@
 # Riffer
 
-TODO: Delete this and the text below, and describe your gem
+The all-in-one Ruby framework for building AI-powered applications and agents.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/riffer`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/riffer.svg)](https://badge.fury.io/rb/riffer) ⚠️ Work in progress
 
-## Installation
+## Overview
+
+Riffer is a comprehensive Ruby framework designed to simplify the development of AI-powered applications and agents. It provides a complete toolkit for integrating artificial intelligence capabilities into your Ruby projects.
+
+Key concepts:
+
+- **Agents** – orchestrate messages, LLM calls, and tool execution (`Riffer::Agent`).
+- **Providers** – adapters that implement text generation and streaming (`Riffer::Providers::*`).
+- **Messages** – typed message objects for system, user, assistant, and tool messages (`Riffer::Messages::*`).
+
+## Features
+
+- Minimal, well-documented core for building AI agents
+- Provider abstraction (OpenAI + test provider) for easy testing
+- Streaming support and structured stream events
+- Message converters and helpers for robust message handling
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Requirements
 
-Install the gem and add to the application's Gemfile by executing:
+- Ruby 3.2 or later
+
+## Installation
+
+Install the released gem:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install riffer
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or add to your application's Gemfile:
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+gem 'riffer'
 ```
 
-## Usage
+Install the development branch directly from GitHub:
+
+```ruby
+gem 'riffer', git: 'https://github.com/bottrall/riffer.git'
+```
 
-TODO: Write usage instructions here
+## Quick Start
+
+Basic usage with the built-in test provider:
+
+```ruby
+require 'riffer'
+
+class EchoAgent < Riffer::Agent
+  identifier 'echo'
+  model 'test/default' # provider/model
+  instructions 'You are an assistant that repeats what the user says.'
+end
+
+agent = EchoAgent.new
+puts agent.generate('Hello world')
+# => "Test response" (the test provider returns a canned response by default)
+```
+
+Using the test provider directly (useful for unit tests):
+
+```ruby
+provider = Riffer::Providers::Test.new
+provider.stub_response('Hello from test provider!')
+assistant = provider.generate_text(prompt: 'Say hi')
+puts assistant.content # => "Hello from test provider!"
+```
+
+Streaming example (provider-dependent):
+
+```ruby
+provider = Riffer::Providers::Test.new
+enum = provider.stream_text(prompt: 'Stream something')
+enum.each do |chunk|
+  puts chunk[:content]
+end
+```
+
+Configuration example (OpenAI API key):
+
+```ruby
+Riffer.configure do |config|
+  config.openai.api_key = ENV['OPENAI_API_KEY']
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run:
+
+```bash
+bin/setup
+```
+
+Run the test suite:
+
+```bash
+bundle exec rake test
+```
+
+Check and fix code style:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+bundle exec rake standard
+bundle exec rake standard:fix
+```
+
+Run the interactive console:
+
+```bash
+bin/console
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/riffer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/riffer/blob/main/CODE_OF_CONDUCT.md).
+1. Fork the repository and create your branch: `git checkout -b feature/foo`
+2. Run tests and linters locally: `bundle exec rake`
+3. Submit a pull request with a clear description of the change
+
+Please follow the [Code of Conduct](https://github.com/bottrall/riffer/blob/main/CODE_OF_CONDUCT.md).
+
+## Changelog
+
+All notable changes to this project are documented in `CHANGELOG.md`.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Licensed under the MIT License. See `LICENSE.txt` for details.
+
+## Maintainers
+
+- Jake Bottrall — https://github.com/bottrall
 
-## Code of Conduct
+---
 
-Everyone interacting in the Riffer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/riffer/blob/main/CODE_OF_CONDUCT.md).
+If you'd like, I can add short usage examples to the documentation site or update the gemspec metadata (authors, homepage, summary).

data/Rakefile

@@ -6,5 +6,21 @@ require "minitest/test_task"
 Minitest::TestTask.create
 
 require "standard/rake"
+require "rdoc/task"
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "doc"
+  rdoc.title = "Riffer Documentation"
+  rdoc.main = "README.md"
+
+  # Explicitly include top-level docs and the library
+  rdoc.rdoc_files.include("README.md", "CHANGELOG.md", "LICENSE.txt")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+
+  # Use Markdown where available and ensure UTF-8
+  rdoc.options << "--charset" << "utf-8" << "--markup" << "markdown"
+end
+
+task docs: :rdoc
 
 task default: %i[test standard]

data/lib/riffer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Riffer
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riffer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jake Bottrall
@@ -120,7 +120,10 @@ email:
 - jakebottrall@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 files:
 - ".release-please-config.json"
 - ".release-please-manifest.json"
@@ -162,7 +165,13 @@ metadata:
   homepage_uri: https://riffer.ai
   source_code_uri: https://github.com/bottrall/riffer
   changelog_uri: https://github.com/bottrall/riffer/blob/main/CHANGELOG.md
-rdoc_options: []
+rdoc_options:
+- "--main"
+- README.md
+- "--title"
+- Riffer Documentation
+- "--markup"
+- markdown
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement