chargify-loops 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'combustion',
+  :git => 'git://github.com/freelancing-god/combustion.git',
+  :ref => 'cd3ccae'
+
+gemspec

data/HISTORY

@@ -0,0 +1,2 @@
+0.1.0 - November 17th 2011
+* First release

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Pat Allan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,42 @@
+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:
+
+<pre><code>gem 'chargify-loops', '~> 0.1.0'</code></pre>
+
+Then add an initializer for your loops, and provide your shared key:
+
+<pre><code># 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</code></pre>
+
+If a web hook is invalid, it'll never hit your loops - so you're only dealing with valid hook requests.
+
+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
+
+Copyright (c) 2011, Chargify Loops is developed and maintained by Pat Allan, and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/app/controllers/chargify/hooks_controller.rb

@@ -0,0 +1,24 @@
+class Chargify::HooksController < ActionController::Base
+  before_filter :verify_signature
+
+  def create
+    Chargify::Loops.delegate_hook params[:event].to_sym,
+      params[:payload].symbolize_keys
+
+    head :ok
+  end
+
+  private
+
+  def generated_signature
+    Digest::MD5.hexdigest(Chargify::Loops.shared_key + request.raw_post)
+  end
+
+  def provided_signature
+    request.headers['X-Chargify-Webhook-Signature']
+  end
+
+  def verify_signature
+    head :forbidden unless generated_signature == provided_signature
+  end
+end

data/chargify-loops.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'chargify/loops/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'chargify-loops'
+  s.version     = Chargify::Loops::VERSION
+  s.authors     = ['Pat Allan']
+  s.email       = ['pat@freelancing-gods.com']
+  s.homepage    = 'https://github.com/freelancing-god/chargify-loops'
+  s.summary     = %q{A Rails Engine for Chargify Webhooks}
+  s.description = %q{A Rails Engine that handles Chargify Webhooks requests and validates and forwards them off to registered loops.}
+
+  s.rubyforge_project = 'chargify-loops'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f|
+    File.basename(f)
+  }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency     'rails',       '~> 3.0'
+  s.add_development_dependency 'rspec-rails', '2.7.0'
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :action_controller
+run Combustion::Application

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  namespace :chargify do
+    resources :hooks, :only => :create
+  end
+end

data/lib/chargify-loops.rb

@@ -0,0 +1 @@
+require 'chargify/loops'

data/lib/chargify/loops.rb

@@ -0,0 +1,31 @@
+module Chargify
+  module Loops
+    def self.delegate_hook(event, payload)
+      loops[event] && loops[event].each do |block|
+        block.call payload
+      end
+    end
+
+    def self.loops
+      @loops ||= {}
+    end
+
+    def self.loop!(event, &block)
+      loops[event] ||= []
+      loops[event]  << block
+    end
+
+    def self.shared_key
+      @shared_key || ''
+    end
+
+    def self.shared_key=(key)
+      @shared_key = key
+    end
+  end
+end
+
+require 'digest/md5'
+
+require 'chargify/loops/version'
+require 'chargify/loops/engine'

data/lib/chargify/loops/engine.rb

@@ -0,0 +1,4 @@
+class Chargify::Loops::Engine < Rails::Engine
+  paths['app/controllers'] << 'app/controllers'
+  paths['config']          << 'config'
+end

data/lib/chargify/loops/version.rb

@@ -0,0 +1,5 @@
+module Chargify
+  module Loops
+    VERSION = '0.1.0'
+  end
+end

data/spec/chargify/loops_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Chargify::Loops do
+  before :each do
+    Chargify::Loops.loops.clear
+  end
+
+  describe '.delegate_hook' do
+    let(:alpha_hook) { double('hook') }
+    let(:beta_hook)  { double('hook') }
+
+    it "calls every registered loop for the given event with the payload" do
+      Chargify::Loops.loops[:alpha] = [alpha_hook]
+      Chargify::Loops.loops[:beta]  = [beta_hook]
+
+      alpha_hook.should_receive(:call).with(:foo)
+      beta_hook.should_not_receive(:call)
+
+      Chargify::Loops.delegate_hook :alpha, :foo
+    end
+
+    it "does not complain if there's no loops for a given hook" do
+      Chargify::Loops.delegate_hook :alpha, :foo
+    end
+  end
+
+  describe '.loop!' do
+    it "appends a loop for the given event" do
+      Chargify::Loops.loop! :test do |payload|
+        #
+      end
+
+      Chargify::Loops.loops[:test].length.should == 1
+    end
+  end
+end

data/spec/controllers/chargify/hooks_controller_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Chargify::HooksController do
+  before :each do
+    Chargify::Loops.stub :shared_key => Digest::MD5.hexdigest(Time.now.to_s)
+  end
+
+  def post_with_signature(action, params = {})
+    body      = params.to_query
+    signature = Digest::MD5.hexdigest(Chargify::Loops.shared_key + body)
+
+    request.env['X-Chargify-Webhook-Signature'] = signature
+
+    post action, params
+  end
+
+  describe '#create' do
+    context 'invalid signature' do
+      it "responds with a 403 Forbidden code" do
+        post :create
+
+        response.code.to_i.should == 403
+      end
+    end
+
+    context 'valid signatures' do
+      before :each do
+        Chargify::Loops.stub :delegate_hook => true
+      end
+
+      it "responds with a 200 OK code" do
+        post_with_signature :create, :payload => {:chargify => 'testing'},
+          :event => 'test'
+
+        response.code.to_i.should == 200
+      end
+
+      it "delegates the hook to the appropriate loops" do
+        Chargify::Loops.should_receive(:delegate_hook).
+          with(:test, {:chargify => 'testing'})
+
+        post_with_signature :create, :payload => {:chargify => 'testing'},
+          :event => 'test'
+      end
+    end
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :action_controller
+
+require 'rspec/rails'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: chargify-loops
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-17 00:00:00 +07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
+        version: 2.7.0
+  type: :development
+  version_requirements: *id002
+description: A Rails Engine that handles Chargify Webhooks requests and validates and forwards them off to registered loops.
+email: 
+- pat@freelancing-gods.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- HISTORY
+- LICENCE
+- README.textile
+- Rakefile
+- app/controllers/chargify/hooks_controller.rb
+- chargify-loops.gemspec
+- config.ru
+- config/routes.rb
+- lib/chargify-loops.rb
+- lib/chargify/loops.rb
+- lib/chargify/loops/engine.rb
+- lib/chargify/loops/version.rb
+- spec/chargify/loops_spec.rb
+- spec/controllers/chargify/hooks_controller_spec.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/freelancing-god/chargify-loops
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: chargify-loops
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A Rails Engine for Chargify Webhooks
+test_files: 
+- spec/chargify/loops_spec.rb
+- spec/controllers/chargify/hooks_controller_spec.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb