bunny_farm 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dce4a5a279e75daa093483da57a1606a4c1afc242bc95914d8536988a2d9d4b8
+  data.tar.gz: 81b2823ea910eb4aac39027b77c55ecf69ff2c37d0f905a57f3d8260df3bad67
+SHA512:
+  metadata.gz: b7aae736d022ed6713a041c02c8d0ca713bbedb16f746d8eeb80eb87f3ae9673e64120ae0692d1e468ae5547eaea3ad4138f1f2af0a58d6d1f16e520fbec03c2
+  data.tar.gz: 6ee8229cee9771ba0ceeb7786e6c505fce96f15c71c6533892b25ba3cffe4632f5f59b711a66038fabc38359b20477dd12630b3454181a3f8575ccc0a0ac3ede

data/.envrc

@@ -0,0 +1 @@
+export RR=`pwd`

data/.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs-material mkdocs-minify-plugin
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+site
+.aigcm_msg

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.1

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+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.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [Released]
+
+### [v0.1.2] - 2025-09-02
+
+#### Added
+- Comprehensive documentation website with MkDocs
+- 26 interactive SVG diagrams illustrating core concepts
+- GitHub Actions CI/CD pipeline for documentation deployment
+- Complete API reference documentation
+- Getting started guide with examples
+- Core features documentation (error handling, task scheduling, workflow support)
+- Configuration management documentation
+- Development and testing guides
+- Architecture overview diagrams
+
+#### Fixed
+- XML parsing issues in SVG diagrams (unescaped ampersands and angle brackets)
+- Documentation build warnings for missing files
+- Improved visual consistency across all diagrams
+
+#### Changed
+- Enhanced documentation structure and navigation
+- Updated configuration examples for better clarity
+- Improved code examples throughout documentation
+
+### [v0.1.1] - 2016-06-30
+
+#### Added
+- Initial BunnyFarm message processing framework
+- Message DSL for defining fields and actions
+- RabbitMQ integration with smart routing
+- JSON serialization support
+- Basic error handling and retry mechanisms
+- Configuration management system
+- Core message lifecycle management
+- Publishing and consuming capabilities
+
+#### Fixed
+- Basic message routing functionality
+- Connection handling improvements
+- Error propagation in message processing
+
+#### Security
+- Secure configuration handling for RabbitMQ credentials
+
+### [v0.1.0] - 2015-02-21
+
+#### Added
+- Initial project structure
+- Basic message framework foundation
+- Core library architecture
+- Initial RabbitMQ integration prototype

data/COMMITS.md

@@ -0,0 +1,196 @@
+---
+url: https://www.conventionalcommits.org/en/v1.0.0/
+title: Conventional Commits
+description: A specification for adding human and machine readable meaning to commit messages
+access_date: 2025-07-31T20:51:29.000Z
+current_date: 2025-07-31T20:51:29.601Z
+---
+
+# Conventional Commits
+
+A specification for adding human and machine readable meaning to commit messages
+
+ Quick Summary Full Specification Contribute
+
+# Conventional Commits 1.0.0
+
+## Summary
+
+The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
+
+The commit message should be structured as follows:
+
+---
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+
+```
+
+---
+
+The commit contains the following structural elements, to communicate intent to the consumers of your library:
+
+1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with `PATCH` in Semantic Versioning).
+2. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with `MINOR` in Semantic Versioning).
+3. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with `MAJOR` in Semantic Versioning). A BREAKING CHANGE can be part of commits of any _type_.
+4. _types_ other than `fix:` and `feat:` are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends `build:`, `chore:`,`ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others.
+5. _footers_ other than `BREAKING CHANGE: <description>` may be provided and follow a convention similar to git trailer format.
+
+Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., `feat(parser): add ability to parse arrays`.
+
+## Examples
+
+### Commit message with description and breaking change footer
+
+```
+feat: allow provided config object to extend other configs
+
+BREAKING CHANGE: `extends` key in config file is now used for extending other config files
+
+```
+
+### Commit message with `!` to draw attention to breaking change
+
+```
+feat!: send an email to the customer when a product is shipped
+
+```
+
+### Commit message with scope and `!` to draw attention to breaking change
+
+```
+feat(api)!: send an email to the customer when a product is shipped
+
+```
+
+### Commit message with both `!` and BREAKING CHANGE footer
+
+```
+chore!: drop support for Node 6
+
+BREAKING CHANGE: use JavaScript features not available in Node 6.
+
+```
+
+### Commit message with no body
+
+```
+docs: correct spelling of CHANGELOG
+
+```
+
+### Commit message with scope
+
+```
+feat(lang): add Polish language
+
+```
+
+### Commit message with multi-paragraph body and multiple footers
+
+```
+fix: prevent racing of requests
+
+Introduce a request id and a reference to latest request. Dismiss
+incoming responses other than from latest request.
+
+Remove timeouts which were used to mitigate the racing issue but are
+obsolete now.
+
+Reviewed-by: Z
+Refs: #123
+
+```
+
+## Specification
+
+The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
+
+1. Commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc., followed by the OPTIONAL scope, OPTIONAL `!`, and REQUIRED terminal colon and space.
+2. The type `feat` MUST be used when a commit adds a new feature to your application or library.
+3. The type `fix` MUST be used when a commit represents a bug fix for your application.
+4. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `fix(parser):`
+5. A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string_.
+6. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
+7. A commit body is free-form and MAY consist of any number of newline separated paragraphs.
+8. One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a `:<space>` or `<space>#` separator, followed by a string value (this is inspired by the git trailer convention).
+9. A footer’s token MUST use `-` in place of whitespace characters, e.g., `Acked-by` (this helps differentiate the footer section from a multi-paragraph body). An exception is made for `BREAKING CHANGE`, which MAY also be used as a token.
+10. A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.
+11. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.
+12. If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g.,_BREAKING CHANGE: environment variables now take precedence over config files_.
+13. If included in the type/scope prefix, breaking changes MUST be indicated by a`!` immediately before the `:`. If `!` is used, `BREAKING CHANGE:` MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.
+14. Types other than `feat` and `fix` MAY be used in your commit messages, e.g., _docs: update ref docs._
+15. The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
+16. BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.
+
+## Why Use Conventional Commits
+
+* Automatically generating CHANGELOGs.
+* Automatically determining a semantic version bump (based on the types of commits landed).
+* Communicating the nature of changes to teammates, the public, and other stakeholders.
+* Triggering build and publish processes.
+* Making it easier for people to contribute to your projects, by allowing them to explore a more structured commit history.
+
+## FAQ
+
+### How should I deal with commit messages in the initial development phase?
+
+We recommend that you proceed as if you’ve already released the product. Typically _somebody_, even if it’s your fellow software developers, is using your software. They’ll want to know what’s fixed, what breaks etc.
+
+### Are the types in the commit title uppercase or lowercase?
+
+Any casing may be used, but it’s best to be consistent.
+
+### What do I do if the commit conforms to more than one of the commit types?
+
+Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.
+
+### Doesn’t this discourage rapid development and fast iteration?
+
+It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors.
+
+### Might Conventional Commits lead developers to limit the type of commits they make because they’ll be thinking in the types provided?
+
+Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time.
+
+### How does this relate to SemVer?
+
+`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases.
+
+### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`?
+
+We recommend using SemVer to release your own extensions to this specification (and encourage you to make these extensions!)
+
+### What do I do if I accidentally use the wrong commit type?
+
+#### When you used a type that’s of the spec but not the correct type, e.g. `fix` instead of `feat`
+
+Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use.
+
+#### When you used a type _not_ of the spec, e.g. `feet` instead of `feat`
+
+In a worst case scenario, it’s not the end of the world if a commit lands that does not meet the Conventional Commits specification. It simply means that commit will be missed by tools that are based on the spec.
+
+### Do all my contributors need to use the Conventional Commits specification?
+
+No! If you use a squash based workflow on Git lead maintainers can clean up the commit messages as they’re merged—adding no workload to casual committers. A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
+
+### How does Conventional Commits handle revert commits?
+
+Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release instead be a patch?
+
+Conventional Commits does not make an explicit effort to define revert behavior. Instead we leave it to tooling authors to use the flexibility of _types_ and _footers_ to develop their logic for handling reverts.
+
+One recommendation is to use the `revert` type, and a footer that references the commit SHAs that are being reverted:
+
+```
+revert: let us never again speak of the noodle incident
+
+Refs: 676104e, a215868
+
+```

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bunny_farm.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Dewayne VanHoozer
+
+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,330 @@
+# BunnyFarm
+
+<div align="center">
+  <table>
+    <tr>
+      <td width="40%" align="center" valign="top">
+        <a href="https://github.com/MadBomber/bunny_farm" target="_blank">
+          <img src="images/bunny_farm_logo.png" alt="BunnyFarm - Lightweight AMQP Job Manager" width="800">
+        </a>
+        <br /><br />
+        <a href="https://badge.fury.io/rb/bunny_farm"><img src="https://badge.fury.io/rb/bunny_farm.svg" alt="Gem Version" /></a>
+        <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a>
+        <br/><br/>
+        <a href="https://madbomber.github.io/bunny_farm/">Comprehensive Documentation Website</a>
+      </td>
+      <td width="60%" align="left" valign="top">
+        Like a well-organized farm where messages hop efficiently from producers to consumers, BunnyFarm provides a lightweight Ruby gem for managing background jobs using RabbitMQ. Each message becomes a living entity with its own behavior, routing intelligently through the message broker to the right workers.
+        <br/><br/>
+        The bunny farm is an abstraction in which the messages are encapsulated as classes.  Instances of these BunnyFarm::Messages are hopping around the RabbitMQ as JSON strings with routing keys in the form of MessageClassName.action where action is a method on the MessageClassName instance.
+        <br/><br/>
+        <h3>Key Features</h3>
+        <ul>
+            <li><strong>🐰 <a href="#message-structure">Message-Centric Design</a></strong> - Classes encapsulate behavior and data</li>
+            <li><strong>🔀 <a href="#usage">Smart Routing</a></strong> - Automatic routing with ClassName.action keys</li>
+            <li><strong>📨 <a href="#usage">JSON Serialization</a></strong> - Simple, readable message format</li>
+            <li><strong>⚙️ <a href="#configuration">Flexible Configuration</a></strong> - Environment, YAML, or programmatic setup</li>
+            <li><strong>🔄 <a href="#examples">Workflow Support</a></strong> - Multi-step processes with message chaining</li>
+            <li><strong>⏰ <a href="#examples">Task Scheduling</a></strong> - Delayed execution with retry logic</li>
+            <li><strong>🛡️ <a href="#examples">Error Handling</a></strong> - Built-in success/failure tracking</li>
+            <li><strong>🎯 <a href="#why">Simplicity First</a></strong> - K.I.S.S. design philosophy</li>
+        </ul>
+      </td>
+    </tr>
+  </table>
+</div>
+
+## Table of Contents
+
+* [Why?](#why)
+* [How?](#how)
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Message Structure](#message-structure)
+* [Usage](#usage)
+* [Configuration](#configuration)
+    * [Environment Variables](#environment-variables)
+    * [Programmatic Configuration](#programmatic-configuration)
+    * [Configuration File](#configuration-file)
+* [Testing](#testing)
+* [Architecture Overview](#architecture-overview)
+* [License](#license)
+* [Examples](#examples)
+* [Contributing](#contributing)
+
+## Why?
+
+- Simplistic?  Because extensive is sometimes overkill.
+- JSON?        Because binary compression is sometimes overkill.
+- Bunny?       Who doesn't like bunnies?  They're like cats with long ears.
+- AMQP?        I like AMQP.  I like RabbitMQ as an AMQP broker.
+
+BTW, at the farm bunnies grow best if planted ears up.
+
+## How?
+
+Use system environment variables.  Such as:
+
+```bash
+export AMQP_HOST=amqp.example.com
+export AMQP_VHOST=sandbox
+export AMQP_EXCHANGE=sandbox
+export AMQP_QUEUE=tv_show_suggestions
+export AMQP_ROUTING_KEY="TvShowSuggestion.submit"
+export AMQP_PASS=guest
+export AMQP_USER=guest
+```
+
+If you don't know how AMQP works you had better go study.  The
+values above were selected to match the demo code below.
+
+## Requirements
+
+- Ruby 2.5 or higher
+- RabbitMQ server
+- Bundler
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bunny_farm'
+```
+
+And then execute:
+
+    bundle install
+
+Or install it yourself as:
+
+    gem install bunny_farm
+
+## Message Structure
+
+Understanding how BunnyFarm messages are structured is key to using the library effectively:
+
+![Message Structure](images/message_structure.svg)
+
+## Usage
+
+The shortest job manager / message processor looks like this:
+
+```ruby
+require 'bunny_farm'
+require 'my_message_class'
+
+BunnyFarm.config
+BunnyFarm.manage  # This will block and process messages
+```
+
+Here is how to publish messages:
+
+```ruby
+require 'bunny_farm'
+require 'my_message_class'
+
+BunnyFarm.config do
+  app_id 'my_job_name'
+end
+
+mm = MyMessageClass.new
+
+mm[:field1] = 'Hello'
+mm[:field2] = 'World'
+# ...
+mm[:fieldn] = 'whatever'
+
+mm.publish('action') # routing key becomes: MyMessageClass.action
+
+puts 'It worked' if mm.successful?
+
+if mm.failed?
+  puts 'This sucks.  Here are some errors:'
+  puts mm.errors.join("\n")
+end
+# rinse and repeat as necessary
+```
+
+
+All processing is done in YourMessageClass.  The
+AMQP routing keys look like: "YourMessageClass.action" and
+guess what the "action" is... a method in YourMessageClass.
+
+So assume that I have a public facing website which allows users
+to fill our forms for various purposes.  Say that one of those
+forms is to collect suggestions for episodes of a TV show.  I would have a
+form with fields that collect informaion about the user as well as a field
+where their suggestion is recorded.  As a hash it might looks something
+like this:
+
+```ruby
+form_contents = {
+	author: {
+		name: 'Jimmy Smith',
+		mailing_address: '123 Main St. USA',
+		email_address: 'little_jimmy@smith.us',
+		phone_number: '+19995551212'
+	},
+	tv_show_name: 'Lost In Space',
+	suggestion: 'Why does doctor Smith have to be such a meanie?',
+	lots_of_other_house_keeping_junk: {}
+}
+```
+
+The website turns that hash into a json package and publishes it
+via an AMQP broker.  I like RabbitMQ.  The published message has
+a routing key of 'TvShowSuggestion.submit'
+
+In the file tv_show_suggestion.rb you could have something like this:
+
+```ruby
+class TvShowSuggestion < BunnyFarm::Message
+
+  fields :tv_show_name, :suggestion,
+    { author: [ :name, :mailing_address, :email_address, :phone_number ]}
+
+	actions :submit
+
+	def submit
+		# TODO: anything you want.
+		save_suggestion
+		notify_writers  if success?
+		success? ? send_thank_you : send_sorry_please_try_again
+		success!
+		some_super_class_service
+		successful? # true will ACK the message; false will not
+	end
+
+private
+
+	def save_suggestion
+		puts @items[:suggestion]
+		success
+	end
+
+	def notify_writers
+		puts "Hey slackers! what about #{@items[:suggestion]}"
+		failure('Writers were sleeping')
+	end
+
+	def send_thank_you
+		puts "Thank you goes to #{@items[:author][:name]}"
+		success
+	end
+
+	def send_sorry_please_try_again
+		STDERR.puts "Sorry #{@items[:author][:name]}, please try again later."
+	end
+end # class TvShowSuggestion < BunnyFarm::Message
+```
+
+## Configuration
+
+BunnyFarm provides flexible configuration options to suit different environments and deployment scenarios:
+
+![Configuration Flow](images/configuration_flow.svg)
+
+BunnyFarm can be configured using environment variables or programmatically:
+
+### Environment Variables
+
+```bash
+export AMQP_HOST=localhost
+export AMQP_VHOST=/
+export AMQP_PORT=5672
+export AMQP_USER=guest
+export AMQP_PASS=guest
+export AMQP_EXCHANGE=my_exchange
+export AMQP_QUEUE=my_queue
+export AMQP_ROUTING_KEY='#.new'
+export AMQP_APP_NAME=my_app
+```
+
+### Programmatic Configuration
+
+```ruby
+BunnyFarm.config do
+  env 'production'
+  app_id 'my_worker'
+  bunny_file 'config/bunny.yml.erb'
+end
+```
+
+### Configuration File
+
+You can also use a YAML configuration file with ERB support (`config/bunny.yml.erb`):
+
+```yaml
+defaults: &defaults
+  host: <%= ENV['AMQP_HOST'] || 'localhost' %>
+  vhost: <%= ENV['AMQP_VHOST'] || '/' %>
+  port: <%= (ENV['AMQP_PORT'] || 5672).to_i %>
+  user: <%= ENV['AMQP_USER'] || 'guest' %>
+  pass: <%= ENV['AMQP_PASS'] || 'guest' %>
+  exchange_name: <%= ENV['AMQP_EXCHANGE'] || 'my_exchange' %>
+  queue_name: <%= ENV['AMQP_QUEUE'] || 'my_queue' %>
+  routing_key: <%= ENV['AMQP_ROUTING_KEY'] || '#' %>
+  app_name: <%= ENV['AMQP_APP_NAME'] || 'bunny_farm_job' %>
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+  host: amqp.production.com
+```
+
+## Testing
+
+```bash
+bundle exec rake test
+```
+
+## Architecture Overview
+
+BunnyFarm provides a clean, layered architecture that separates concerns and enables scalable message processing:
+
+
+<img src="images/architecture_overview.svg" alt="Architecture Overview" width="1200">
+
+The architecture consists of four main layers:
+
+1. **Ruby Application Layer** - Your web apps, API servers, schedulers, and worker processes
+2. **BunnyFarm Library Layer** - Core components including Message classes, Publisher, Consumer, Config, and Router
+3. **RabbitMQ Message Broker** - Handles message routing, queuing, and delivery with exchanges and queues
+4. **Persistence & External Services** - Databases, email services, file storage, APIs, and caching layers
+
+This separation allows for:
+- **Horizontal scaling** - Add more workers as needed
+- **Fault tolerance** - Messages persist in queues if workers are down
+- **Flexible routing** - Different message types can go to different workers
+- **Monitoring** - RabbitMQ provides comprehensive management tools
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Examples
+
+Check out the [examples directory](examples/) for comprehensive, runnable examples including:
+
+- **Simple Producer/Consumer**: Basic message publishing and processing
+- **Order Processing Workflow**: Complex multi-step workflows with error handling
+- **Task Scheduler**: Scheduled tasks with retry logic and failure recovery
+
+Each example includes detailed documentation and can be run independently to help you understand BunnyFarm's capabilities.
+
+## Contributing
+
+Remember the key design goal is K.I.S.S.  Edge cases and exotic stuff
+are not what life is like on the bunny farm.
+
+1. Fork it ( https://github.com/MadBomber/bunny_farm/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request