stripe_event 0.3.1 → 0.4.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. Incoming webhook requests are authenticated by retrieving the [event object](https://stripe.com/docs/api?lang=ruby#event_object) from Stripe. Define subscriber blocks to handle one, many, or all event types.
+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.
 
 ## Install
 
@@ -13,7 +13,7 @@ gem 'stripe_event'
 
 ```ruby
 # config/routes.rb
-mount StripeEvent::Engine => "/my-chosen-path" # provide a custom path
+mount StripeEvent::Engine => '/my-chosen-path' # provide a custom path
 ```
 
 ## Usage
@@ -37,6 +37,23 @@ StripeEvent.setup do
 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:
+
+```ruby
+StripeEvent.event_retriever = Proc.new do |params| 
+  secret_key = Account.find_by_stripe_user_id(params[:user_id]).secret_key
+  Stripe::Event.retrieve(params[:id], secret_key)
+end
+```
+
+During development it may be useful to skip retrieving the event from Stripe, and deal with the params hash directly. Just remember that the data has not been authenticated.
+
+```ruby
+StripeEvent.event_retriever = Proc.new { |params| params }
+```
+
 ## Register webhook url with Stripe
 
 ![Setup webhook url](https://raw.github.com/integrallis/stripe_event/master/screenshots/dashboard-webhook.png "webhook setup")

data/app/controllers/stripe_event/webhook_controller.rb

@@ -1,7 +1,7 @@
 module StripeEvent
   class WebhookController < ActionController::Base
     def event
-      event = Stripe::Event.retrieve(params[:id])
+      event = StripeEvent.event_retriever.call(params)
       StripeEvent.publish(event)
       head :ok
     rescue Stripe::StripeError

data/lib/stripe_event.rb

@@ -1,37 +1,23 @@
 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
   end
   
-  def self.registration(&block)
-    warn "[Deprecation Warning] StripeEvent.registration is deprecated. Use StripeEvent.setup."
-    instance_eval(&block)
-  end
-  
-  def self.publish(event_obj)
-    ActiveSupport::Notifications.instrument(event_obj.type, :event => event_obj)
+  def self.publish(event)
+    Publisher.new(event).instrument
   end
   
   def self.subscribe(*names, &block)
-    Subscriber.new(*names, &block).register
-  end
-  
-  def self.subscribers(name)
-    ActiveSupport::Notifications.notifier.listeners_for(name)
-  end
-  
-  def self.clear_subscribers!
-    TYPE_LIST.each do |type|
-      subscribers(type).each { |s| unsubscribe(s) }
-    end
-  end
-  
-  def self.unsubscribe(subscriber)
-    ActiveSupport::Notifications.notifier.unsubscribe(subscriber)
+    Subscriber.new(*names).register(&block)
   end
 end

data/lib/stripe_event/errors.rb

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

data/lib/stripe_event/publisher.rb

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

data/lib/stripe_event/subscriber.rb

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

data/lib/stripe_event/types.rb

@@ -1,7 +1,7 @@
 module StripeEvent
-  InvalidEventType = Class.new(StandardError)
-  
   TYPE_LIST = [
+    'account.updated',
+    'account.application.deauthorized',
     'charge.succeeded',
     'charge.failed',
     'charge.refunded',
@@ -30,6 +30,7 @@ module StripeEvent
     'coupon.updated',
     'coupon.deleted',
     'transfer.created',
+    'transfer.updated',
     'transfer.failed',
     'ping'
   ]

data/lib/stripe_event/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe_event
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-15 00:00:00.000000000 Z
+date: 2012-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70103674405340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70103674405340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: stripe
-  requirement: &70103674404620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70103674404620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70103674420300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *70103674420300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70103674419640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +69,12 @@ dependencies:
         version: '1.8'
   type: :development
   prerelease: false
-  version_requirements: *70103674419640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: Stripe webhook integration for Rails applications.
 email:
 - dwhalen@integrallis.com
@@ -65,6 +85,8 @@ 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
@@ -92,9 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Stripe webhook integration for Rails applications.
 test_files: []
-has_rdoc: