stripe_event 0.4.0 → 0.5.0

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/integrallis/stripe_event.png?branch=master)](http://travis-ci.org/integrallis/stripe_event)
 
-stripe_event is built on the ActiveSupport::Notifications API[[0]](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html). Incoming webhook requests are authenticated by retrieving the [event object](https://stripe.com/docs/api?lang=ruby#event_object) from Stripe[[1]](https://answers.stripe.com/questions/what-is-the-recommended-way-to-authenticate-a-webhook-callback). Define subscriber blocks to handle one, many, or all event types.
+stripe_event is built on the [ActiveSupport::Notifications API](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html). Incoming webhook requests are authenticated by retrieving the [event object](https://stripe.com/docs/api?lang=ruby#event_object) from Stripe[[1]](https://answers.stripe.com/questions/what-is-the-recommended-way-to-authenticate-a-webhook-callback). Define subscriber blocks to handle one, many, or all event types.
 
 ## Install
 
@@ -24,7 +24,10 @@ Stripe.api_key = ENV['STRIPE_API_KEY'] # Set your api key
 
 StripeEvent.setup do
   subscribe 'charge.failed' do |event|
-    MyClass.handle_failed_charge(event) # Define subscriber behavior
+    # Define subscriber behavior based on the event object
+    event.class #=> Stripe::Event
+    event.type  #=> "charge.failed"
+    event.data  #=> { ... }
   end
 
   subscribe 'customer.created', 'customer.updated' do |event|
@@ -39,7 +42,7 @@ end
 
 ## Configuration
 
-If you have built an application that has multiple Stripe accounts--say, each of your customers has their own--you may want to define your own way of retrieving events from Stripe (e.g. perhaps you want to use the `user_id` parameter[[2]](https://stripe.com/docs/apps/getting-started#webhooks) from the top level to detect the customer for the event, then grab their specific API key). You can do this:
+If you have built an application that has multiple Stripe accounts--say, each of your customers has their own--you may want to define your own way of retrieving events from Stripe (e.g. perhaps you want to use the [user_id parameter](https://stripe.com/docs/apps/getting-started#webhooks) from the top level to detect the customer for the event, then grab their specific API key). You can do this:
 
 ```ruby
 StripeEvent.event_retriever = Proc.new do |params| 
@@ -54,6 +57,14 @@ During development it may be useful to skip retrieving the event from Stripe, an
 StripeEvent.event_retriever = Proc.new { |params| params }
 ```
 
-## Register webhook url with Stripe
+### Register webhook url with Stripe
 
 ![Setup webhook url](https://raw.github.com/integrallis/stripe_event/master/screenshots/dashboard-webhook.png "webhook setup")
+
+### Examples
+
+The [RailsApps](https://github.com/RailsApps) project by Daniel Kehoe has released an [example Rails 3.2 app](https://github.com/RailsApps/rails-stripe-membership-saas) with recurring billing using Stripe. The application uses stripe_event to handle `customer.subscription.deleted` events.
+
+### Note: 'Test Webhooks' Button on Stripe Dashboard
+
+This button sends an example event to your webhook urls, including an `id` of `evt_00000000000000`. To confirm that Stripe sent the webhook, stripe_event attempts to retrieve the event details from Stripe using the given `id`. In this case the event does not exist and stripe_event responds with `401 Unauthorized`. Instead of using the 'Test Webhooks' button, trigger webhooks by using the Stripe Dashboard to create test payments, customers, etc.

data/Rakefile

@@ -1,27 +1,4 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-# begin
-#   require 'rdoc/task'
-# rescue LoadError
-#   require 'rdoc/rdoc'
-#   require 'rake/rdoctask'
-#   RDoc::Task = Rake::RDocTask
-# end
-# 
-# RDoc::Task.new(:rdoc) do |rdoc|
-#   rdoc.rdoc_dir = 'rdoc'
-#   rdoc.title    = 'StripeEvent'
-#   rdoc.options << '--line-numbers'
-#   rdoc.rdoc_files.include('lib/**/*.rb')
-# end
-
-Bundler::GemHelper.install_tasks
-
-require 'rake'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) 
-task :default  => :spec
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/stripe_event.rb

@@ -1,23 +1,62 @@
+require "set"
 require "stripe"
 require "stripe_event/engine"
 require "stripe_event/subscriber"
 require "stripe_event/publisher"
-require "stripe_event/types"
-require "stripe_event/errors"
 
 module StripeEvent
   mattr_accessor :event_retriever
   self.event_retriever = Proc.new { |params| Stripe::Event.retrieve(params[:id]) }
 
-  class << self
-    alias_method :setup, :instance_eval
+  def self.setup(&block)
+    instance_eval(&block)
   end
-  
+
   def self.publish(event)
     Publisher.new(event).instrument
   end
-  
+
   def self.subscribe(*names, &block)
     Subscriber.new(*names).register(&block)
   end
+
+  class StripeEventError < StandardError; end
+  class InvalidEventTypeError < StripeEventError; end
+
+  TYPE_LIST = Set[
+    'account.updated',
+    'account.application.deauthorized',
+    'charge.succeeded',
+    'charge.failed',
+    'charge.refunded',
+    'charge.dispute.created',
+    'charge.dispute.updated',
+    'charge.dispute.closed',
+    'customer.created',
+    'customer.updated',
+    'customer.deleted',
+    'customer.subscription.created',
+    'customer.subscription.updated',
+    'customer.subscription.deleted',
+    'customer.subscription.trial_will_end',
+    'customer.discount.created',
+    'customer.discount.updated',
+    'customer.discount.deleted',
+    'invoice.created',
+    'invoice.updated',
+    'invoice.payment_succeeded',
+    'invoice.payment_failed',
+    'invoiceitem.created',
+    'invoiceitem.updated',
+    'invoiceitem.deleted',
+    'plan.created',
+    'plan.updated',
+    'plan.deleted',
+    'coupon.created',
+    'coupon.deleted',
+    'transfer.created',
+    'transfer.updated',
+    'transfer.failed',
+    'ping'
+  ].freeze
 end

data/lib/stripe_event/publisher.rb

@@ -1,13 +1,12 @@
 module StripeEvent
   class Publisher < Struct.new(:event)
     def instrument
-      ActiveSupport::Notifications.instrument(type, :event => event)
+      ActiveSupport::Notifications.instrument(type, event)
     end
-    
+
     def type
-      event[:type].tap { |type|
-        raise InvalidEventTypeError.new("Event type was not present for: #{event}") if !type.present?
-      }
+      return event[:type] if event[:type].present?
+      raise InvalidEventTypeError.new("Event type was not present for: #{event}")
     end
   end
 end

data/lib/stripe_event/subscriber.rb

@@ -2,22 +2,23 @@ module StripeEvent
   class Subscriber
     def initialize(*names)
       @names = names
-      ensure_valid_types!
+      assert_valid_types!
     end
-    
+
     def register(&block)
-      ActiveSupport::Notifications.subscribe(pattern) do |*_, payload|
-        block.call(payload[:event])
+      ActiveSupport::Notifications.subscribe(pattern) do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        block.call(event.payload)
       end
     end
-    
+
     def pattern
-      Regexp.union(@names.empty? ? TYPE_LIST : @names)
+      Regexp.union(@names.empty? ? TYPE_LIST.to_a : @names)
     end
-    
+
     private
-    
-    def ensure_valid_types!
+
+    def assert_valid_types!
       invalid_names = @names.select { |name| !TYPE_LIST.include?(name) }
       raise InvalidEventTypeError.new(invalid_names) if invalid_names.any?
     end

data/lib/stripe_event/version.rb

@@ -1,3 +1,3 @@
 module StripeEvent
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe_event
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-25 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
 description: Stripe webhook integration for Rails applications.
 email:
 - dwhalen@integrallis.com
@@ -85,17 +85,16 @@ files:
 - app/controllers/stripe_event/webhook_controller.rb
 - config/routes.rb
 - lib/stripe_event/engine.rb
-- lib/stripe_event/errors.rb
 - lib/stripe_event/publisher.rb
 - lib/stripe_event/subscriber.rb
-- lib/stripe_event/types.rb
 - lib/stripe_event/version.rb
 - lib/stripe_event.rb
-- MIT-LICENSE
+- LICENSE.md
 - Rakefile
 - README.md
 homepage: https://github.com/integrallis/stripe_event
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -114,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Stripe webhook integration for Rails applications.

data/lib/stripe_event/errors.rb

@@ -1,4 +0,0 @@
-module StripeEvent
-  class StripeEventError < StandardError; end
-  class InvalidEventTypeError < StripeEventError; end
-end

data/lib/stripe_event/types.rb

@@ -1,37 +0,0 @@
-module StripeEvent
-  TYPE_LIST = [
-    'account.updated',
-    'account.application.deauthorized',
-    'charge.succeeded',
-    'charge.failed',
-    'charge.refunded',
-    'charge.disputed',
-    'customer.created',
-    'customer.updated',
-    'customer.deleted',
-    'customer.subscription.created',
-    'customer.subscription.updated',
-    'customer.subscription.deleted',
-    'customer.subscription.trial_will_end',
-    'customer.discount.created',
-    'customer.discount.updated',
-    'customer.discount.deleted',
-    'invoice.created',
-    'invoice.updated',
-    'invoice.payment_succeeded',
-    'invoice.payment_failed',
-    'invoiceitem.created',
-    'invoiceitem.updated',
-    'invoiceitem.deleted',
-    'plan.created',
-    'plan.updated',
-    'plan.deleted',
-    'coupon.created',
-    'coupon.updated',
-    'coupon.deleted',
-    'transfer.created',
-    'transfer.updated',
-    'transfer.failed',
-    'ping'
-  ]
-end