Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pat/chargify-loops

A Rails Engine for Chargify Webhooks
https://github.com/pat/chargify-loops

Last synced: 28 days ago
JSON representation

A Rails Engine for Chargify Webhooks

Host: GitHub
URL: https://github.com/pat/chargify-loops
Owner: pat
License: mit
Created: 2011-11-17T08:26:05.000Z (almost 13 years ago)
Default Branch: master
Last Pushed: 2014-04-02T11:34:58.000Z (over 10 years ago)
Last Synced: 2023-04-09T05:11:48.969Z (over 1 year ago)
Language: Ruby
Homepage:
Size: 146 KB
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.textile
- Changelog: HISTORY

Awesome Lists containing this project

README

h1. Chargify Loops

Chargify Loops is a Rails engine that handles Chargify's Web Hooks. All you need to do is pair hooks to loops for any particular events you care about, and this engine handles everything else.

This is for Rails 3 only - though developers using Rails 2 are welcome to pick things out of the source for their apps.

h2. Installation and Usage

Add the following to your Gemfile:

gem 'chargify-loops', '~> 0.3.0'

Then add an initializer for your loops, and provide your shared key:

# config/initializers/chargify_loops.rb

Chargify::Loops.shared_key = 'secret-key-from-chargify'

Chargify::Loops.loop! :signup_success do |payload|

  Emails.welcome(payload['subscription']['customer']['email']).deliver

end

Chargify::Loops.loop! :payment_failure do |payload|

  Banker.loan payload['payment']['amount_in_cents']

end

# Or catch all events:

Chargify::Loops.loop! :all do |event, payload|

  Events.store event, payload

end

If a web hook is invalid, it'll never hit your loops - so you're only dealing with valid hook requests. All hash keys will be strings (I normally prefer symbols, but hashes within hashes had string keys, so opting with that as a default).

Also: it's best to keep your loops short and sweet - don't put business logic in your initializer, but somewhere else where you've got some test coverage. As a rule of thumb, if you've got more than one line inside a loop block, then you should probably consider whether that code could be somewhere else.

Finally, make sure Chargify is set up to send its hooks your way. This library adds a route that accepts POST requests to @/chargify/hooks@ - so if your site is @www.example.com@, then you'll want to tell Chargify to send hooks to @http://www.example.com/chargify/hooks@.

h2. Contributing

Contributions are very much welcome - but keep in mind the following:

* Keep patches in a separate branch.
* Write tests for your patches.
* Don't mess with the version or history file. I'll take care of that when the patch is merged in.

h2. Credits