Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ninech/cony
Cony sends AMQP notifications when your model changes.
https://github.com/ninech/cony
Last synced: about 1 month ago
JSON representation
Cony sends AMQP notifications when your model changes.
- Host: GitHub
- URL: https://github.com/ninech/cony
- Owner: ninech
- License: mit
- Created: 2014-04-16T10:37:23.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-07-27T14:31:30.000Z (over 4 years ago)
- Last Synced: 2023-04-07T07:11:40.122Z (over 1 year ago)
- Language: Ruby
- Size: 68.4 KB
- Stars: 2
- Watchers: 23
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# :rabbit: Cony [](https://travis-ci.org/ninech/cony) [](https://codeclimate.com/github/ninech/cony)
Cony sends notifications about the lifecycle of your models via AMQP.
## Setup
### Rails
In Rubo on Rails add this to your Gemfile and run `bundle install`.
```ruby
gem 'cony'
```
To configure the AMQP-Settings, use an initializer (e.g.
`config/initializers/cony.rb`) with the following content.
```ruby
Cony.configure do |config|
config.amqp = {
host: 'localhost',
exchange: 'organization.application',
ssl: true,
user: 'username',
pass: 'secret',
}
config.test_mode = Rails.env.test?
# config.durable = false
end
```
## Getting Started
To enable the notifications for a model, you just need to include the
corresponding class. For `ActiveRecord` use the following snippet.
```ruby
class ExampleModel < ActiveRecord::Base
include Cony::ActiveRecord
end
```
## Message Format
The routing key for the messages have a format of
`model_name_with_underscore.mutation.event_type`.
It will append the id of the model and the detected changes to the payload of the message.
### Create
A create for a `Example::Model` model will have a routing key of
`example/model.mutation.created`.
The sent JSON structure will look like this:
```json
{
"id": 1337,
"changes": [
{ "name": { "old": null, "new": "value" } },
{ "description": { "old": null, "new": "value" } }
],
"event": "created",
"model": "Example::Model",
}
```
### Update
An update for a `Example::Model` model will have a routing key of
`example/model.mutation.updated`.
The sent JSON structure will look like this:
```json
{
"id": 1337,
"changes": [
{ "name": { "old": "old-value", "new": "new-value" } }
],
"event": "updated",
"model": "Example::Model",
}
```
### Destroy
A destroy event for a `Example::Model` model will have a routing key of
`example/model.mutation.destroyed`.
The sent JSON structure will look like this:
```json
{
"id": 1337,
"changes": [
{ "name": { "old": "value", "new": null } }
],
"event": "destroyed",
"model": "Example::Model",
}
```
## About
This gem is currently maintained and funded by [nine](https://nine.ch).