Sha256: af4afd7f4250d6493bdcc8bc3152a5ee8d0b9d3cdec35072bf7f809436960c52
Contents?: true
Size: 1.87 KB
Versions: 5
Compression:
Stored size: 1.87 KB
Contents
# CottonTail
[](https://circleci.com/gh/jamesBrennan/cotton-tail)
[](https://depfu.com/github/jamesBrennan/cotton-tail?project_id=6465)
[](https://codeclimate.com/github/jamesBrennan/cotton-tail)
CottonTail provides a simple DSL for consuming messages from a RabbitMQ server.
This gem is in early development. The API will be unstable until the 1.0.0
release.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cotton-tail'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install cotton-tail
## Usage
### Quick Start
You can look at the file `examples/app.rb` to see an example of what a CottonTail
App definition looks like.
To run the example locally you need to have a rabbitmq instance running. The
included `docker-compose` file can be used to start up a local instance of
rabbitmq.
`docker-compose up`
Once the rabbitmq service has completed startup (takes a few seconds) you can
start the example app.
`bundle exec examples/app.rb`
You should see
`Waiting for messages ...`
We've included bash scripts to publish messages for the example app. Execute them
in another terminal window to see output in the app window.
`examples/messages/say.hello`, `examples/messages/say.goodbye`, etc...
## Development
After checking out the repo, install docker. Then, run `docker-compose` up to
spin up a local instance of rabbitmq. Run `rake spec:all` to run the tests.
You can also run `bin/console` for an interactive prompt that will allow you
to experiment.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jamesBrennan/cotton-tail.
Version data entries
5 entries across 5 versions & 1 rubygems
| Version | Path |
|---|---|
| cotton-tail-0.7.0 | README.md |
| cotton-tail-0.6.1 | README.md |
| cotton-tail-0.6.0 | README.md |
| cotton-tail-0.5.0 | README.md |
| cotton-tail-0.4.1 | README.md |