README.md in mandrill_event-0.0.1 vs README.md in mandrill_event-0.0.2
- old
+ new
@@ -1,5 +1,7 @@
+[![Gem Version](https://badge.fury.io/rb/mandrill_event.svg)](http://badge.fury.io/rb/mandrill_event)
+
# MandrillEvent
MandrillEvent is built on the ActiveSupport::Notifications API. Define subscribers to handle specific event types. Subscribers can be a block or an object that responds to #call.
@@ -7,11 +9,11 @@
### Add it to your Gemfile
```ruby
# Gemfile
-gem 'mandrill_event', github: 'netsign/mandrill_event'
+gem 'mandrill_event'
```
And then execute:
$ bundle
@@ -28,35 +30,41 @@
### Setup the initializer
```ruby
# config/initializers/mandrill_event.rb
MandrillEvent.configure do |events|
- events.subscribe 'reject', RejectHandler.new
+ events.subscribe 'reject', RejectHandler
end
```
-### Create subscriber objects that respond to #call
+### Subscriber responds to call
```ruby
# app/mandrill_handlers/reject_handler.rb
class RejectHandler
- def call(event)
+ def self.call(event)
# your code here
end
end
```
+### Configure Mandrill webhooks to use your endpoint
+
+At the Mandrill website, create a webhook that points to your server with the path `/mandrill/events`. A service like [Ngrok](https://ngrok.com/) or [Ultrahook](http://www.ultrahook.com/) can be really useful in creating a tunnel to your local server and inspecting the request payloads.
+
+
## Thanks
MandrillEvent ~~takes inspiration from~~ is a direct rip-off of the [stripe_event](https://github.com/integrallis/stripe_event) gem, which takes it's inspiration from [Webmachine](https://github.com/seancribbs/webmachine-ruby/blob/6edaecea1ceab7c2c54fc5e83446317524f6bb8b/lib/webmachine/events.rb), which is inspired by Erlang. It's turtles all the way down.
## TODO:
+* Get it on Travis
+* Write docs with RDoc/YARD
* More test coverage
* Incoming webhook requests are authenticated
* Get it on Coveralls
-* Get it on Travis
* Get it on Code Climate
## Contributing