bnorton / notify_on

Send simple webhook style change notifications when models are updated

NotifyOn

Installation

Add this line to your application's Gemfile:

gem 'notify_on'

And then execute:

$ bundle

Or install it yourself as:

$ gem install notify_on

Usage

require 'notify_on'

Then setup the fields upon which to notify changes of Include the id, created_at and updated_at fields in all notifications

class Post < ActiveRecord::Base
  notify_on :title, :body, :comments_count, :always => [:created_at, :updated_at]
end

post = Post.first

post.notifications
#=> [#<Notification id: 12, url: "http://callbacks.their-site.com/posts">]

post.update_attributes!(:title => updated_title)
#=> true # and sends the notification

post.comments.create(params[:comment])
#=> #<Comment id: 2 ...> # no notification sent

post.comments.create(params[:comment])
#=> #<Comment id: 3 ...> # notification is sent

Your API consumers can Subscribe to models via the subscriptions api

##Subscriptions API

TODO

Contributing

1. Fork it
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 new Pull Request