stripe_webhooks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd1f08430b1ef364a86da41ffb13052b5f817413
+  data.tar.gz: a7d9e947785bcc9267cbade2ab1141a23f3a5e8b
+SHA512:
+  metadata.gz: 9affb286ac0b56570d85ba2b30c30eb45e2c24229b7de964cd1af12246aba77d81f5e3424d8b6a51a18da11cf9370464a7743de8f7058d8d77f9d450e44c2eec
+  data.tar.gz: 5d26da0418c121b1c124cdc507a8290886133adf48b59c2bc2eafdd3baffa8182bf159625684a33b290bba3bb390578015686c346e8229b26543c31aeb05d10a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Greg Woods
+
+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.md

@@ -0,0 +1,43 @@
+# StripeWebhooks
+
+**NOTICE**: This project is in early development. As such, I don't recommend using it for anything serious just yet. You have been warned! 
+
+StripeWebhooks is a Rails engine for dealing with data posted from [Stripe via Webhooks](https://stripe.com/docs/webhooks).
+
+## Goals
+
+1. Provide an endpoint for capturing POST data from Stripe
+2. Verify authenticity of data by checking against the Stripe API
+3. Run callbacks in response to desired events
+4. Enable an app to "catch up" with missed events in the case of a server outage
+5. Store as little Stripe data locally as possible
+
+## Requirements
+
+- [Stripe](https://rubygems.org/gems/stripe) 1.23 or higher
+- Rails 4.2
+- Ruby 2.2
+
+## Installation
+
+First, install and configure the [stripe](https://rubygems.org/gems/stripe) gem according to their instructions. Then:
+
+1. Add the gem to your Gemfile
+
+        gem 'stripe_webhooks'
+
+2. Run bundle install
+3. Copy the database migrations to your rails project
+
+        bundle exec rake railties:install:migrations
+        rake db:migrate
+
+4. Mount the engine in your routes.rb file
+
+        mount StripeWebhooks::Engine => "/stripe_webhooks"
+
+5. Restart your application
+
+## Usage
+
+TODO: This project is in the early development phase. This section will be updated as soon as the dust starts to settle.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'StripeWebhooks'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/stripe_webhooks/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/stripe_webhooks/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/stripe_webhooks/application_controller.rb

@@ -0,0 +1,4 @@
+module StripeWebhooks
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/stripe_webhooks/events_controller.rb

@@ -0,0 +1,26 @@
+require_dependency "stripe_webhooks/application_controller"
+
+module StripeWebhooks
+  class EventsController < ApplicationController
+    protect_from_forgery :except => :create
+
+    def create
+      begin
+        raw_data = JSON.parse(request.body.read)
+      rescue JSON::ParserError => e
+        render :text => e.message, :status => 400
+        return
+      end
+
+      @event = StripeWebhooks::Event.find_or_initialize_by(:stripe_event_id => raw_data['id'])
+
+      if @event.save()
+        StripeWebhooks::ProcessorJob.perform_later(@event)
+        render :nothing => true, :status => 200
+      else
+        render :text => @event.errors.full_messages.first, :status => 422
+      end
+    end
+
+  end
+end

data/app/helpers/stripe_webhooks/application_helper.rb

@@ -0,0 +1,4 @@
+module StripeWebhooks
+  module ApplicationHelper
+  end
+end

data/app/helpers/stripe_webhooks/events_helper.rb

@@ -0,0 +1,4 @@
+module StripeWebhooks
+  module EventsHelper
+  end
+end

data/app/jobs/stripe_webhooks/processor_job.rb

@@ -0,0 +1,14 @@
+module StripeWebhooks
+  class ProcessorJob < ActiveJob::Base
+    queue_as :default
+
+    def perform(event)
+      puts "running!"
+      event.validate!
+      if event.is_authentic?
+        event.run_callbacks!
+      end
+    end
+
+  end
+end

data/app/models/stripe_webhooks/callback.rb

@@ -0,0 +1,62 @@
+module StripeWebhooks
+  class Callback
+
+    module ClassMethods
+      attr_reader :event_types
+
+      # Run callbacks for a given event type
+      #
+      # === Example
+      #
+      #  StripeWebhooks::Callback.run_callbacks_for('customer.subscription.deleted', stripe_event)
+      #
+      def run_callbacks_for(event_type, event)
+        StripeWebhooks.callbacks.each do |label|
+          class_name = "#{label.classify}Callback"
+          callback = class_name.constantize.new
+          if callback.handles?(event_type)
+            callback.run_once(event)
+          end
+        end
+      end
+
+      # Declares which event types a callback will handle
+      #
+      # === Example
+      #
+      #   class MyCallback < StripeWebhooks::Callback
+      #     handles_events 'customer.subscription.deleted', 'customer.subscription.testing'
+      #     def run(event)
+      #       puts "Do useful stuff"
+      #     end
+      #   end
+      #
+      def handles_events(*event_types)
+        @event_types = event_types
+      end
+    end
+    extend ClassMethods
+
+    # Return the label for the callback. Label is based on the class name.
+    #
+    def label
+      return self.class.to_s.underscore.gsub('_callback', '')
+    end
+
+    # Run the callback only if we have not run it once before
+    #
+    def run_once(event)
+      if !StripeWebhooks::PerformedCallback.exists?(:stripe_event_id => event.id, :label => label)
+        run(event)
+        StripeWebhooks::PerformedCallback.create(:stripe_event_id => event.id, :label => label)
+      end
+    end
+
+    # Return true if the Callback handles this type of event
+    #
+    def handles?(event_type)
+      return self.class.event_types.include?(event_type)
+    end
+
+  end
+end

data/app/models/stripe_webhooks/event.rb

@@ -0,0 +1,37 @@
+module StripeWebhooks
+  class Event < ActiveRecord::Base
+    validates :stripe_event_id, :presence => true, :uniqueness => true
+    has_many :performed_callbacks, :primary_key => :stripe_event_id, :foreign_key => :stripe_event_id
+
+    def stripe_event
+      if created_at < 30.days.ago
+        Rails.logger.warn('The event you requested was created over 30 days ago, which means it may no longer be available via the Stripe Events API.')
+      end
+      @_stripe_event ||= Stripe::Event.retrieve(stripe_event_id)
+      return @_stripe_event
+    end
+
+    def validate!
+      return true if is_authentic
+      begin
+        event = stripe_event()
+        update_attributes({
+          :is_processed => true,
+          :is_authentic => true,
+          :stripe_event_type => event.type,
+          :stripe_created_at => Time.at(event.created).to_datetime
+        })
+        return true
+      rescue Stripe::InvalidRequestError
+        update_attributes(:is_processed => true, :is_authentic => false)
+        return false
+      end
+    end
+
+    def run_callbacks!
+      StripeWebhooks::Callback.run_callbacks_for(self.stripe_event_type, self.stripe_event)
+      return true
+    end
+
+  end
+end

data/app/models/stripe_webhooks/performed_callback.rb

@@ -0,0 +1,5 @@
+module StripeWebhooks
+  class PerformedCallback < ActiveRecord::Base
+    belongs_to :event, :primary_key => :stripe_event_id, :foreign_key => :stripe_event_id
+  end
+end

data/app/views/layouts/stripe_webhooks/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>StripeWebhooks</title>
+  <%= stylesheet_link_tag    "stripe_webhooks/application", media: "all" %>
+  <%= javascript_include_tag "stripe_webhooks/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+StripeWebhooks::Engine.routes.draw do
+  resources :events, :only => :create
+end

data/db/migrate/20150715152905_create_stripe_webhooks_events.rb

@@ -0,0 +1,13 @@
+class CreateStripeWebhooksEvents < ActiveRecord::Migration
+  def change
+    create_table :stripe_webhooks_events do |t|
+      t.string :stripe_event_id
+      t.index :stripe_event_id, :unique => true
+      t.string :stripe_event_type
+      t.datetime :stripe_created_at
+      t.boolean :is_processed, :default => false
+      t.boolean :is_authentic, :default => false
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150716195741_create_stripe_webhooks_performed_callbacks.rb

@@ -0,0 +1,10 @@
+class CreateStripeWebhooksPerformedCallbacks < ActiveRecord::Migration
+  def change
+    create_table :stripe_webhooks_performed_callbacks do |t|
+      t.string :stripe_event_id, :null => false
+      t.string :label, :null => false
+      t.index [:stripe_event_id, :label], :name => 'index_stripe_webhooks_performed_callbacks_event_id_label'
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/stripe_webhooks.rb

@@ -0,0 +1,7 @@
+module StripeWebhooks
+  module Generators
+    class Base < Rails::Generators::NamedBase
+
+    end
+  end
+end

data/lib/generators/stripe_webhooks/callback_generator.rb

@@ -0,0 +1,28 @@
+require 'generators/stripe_webhooks'
+
+module StripeWebhooks
+  module Generators
+    class CallbackGenerator < Base
+      desc "Creates a stripe webhook callback object"
+      argument :event_types, :type => :array, :default => [], :banner => 'event.type.a event.type.b ...'
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_callback
+        application_callback = 'app/callbacks/application_callback.rb'
+        if !File.exist?(application_callback)
+          template 'application_callback.rb.erb', application_callback
+        end
+
+        template 'callback.rb.erb', "app/callbacks/#{name.underscore}_callback.rb"
+        
+        initializer = 'config/initializers/stripe_webhook_callbacks.rb'
+        if !File.exist?(initializer)
+          create_file(initializer)
+        end
+        append_to_file initializer, "StripeWebhooks.register_callback('#{name.underscore}')\n"
+      end
+
+    end
+  end
+end

data/lib/generators/stripe_webhooks/templates/application_callback.rb.erb

@@ -0,0 +1,3 @@
+class ApplicationCallback < StripeWebhooks::Callback
+
+end

data/lib/generators/stripe_webhooks/templates/callback.rb.erb

@@ -0,0 +1,8 @@
+class <%= name %>Callback < ApplicationCallback
+  handles_events <%= event_types.collect{ |event_type| "'#{event_type}'" }.join(', ') %>
+
+  def run(event)
+
+  end
+
+end

data/lib/stripe_webhooks.rb

@@ -0,0 +1,6 @@
+require "stripe_webhooks/engine"
+require "stripe_webhooks/callbacks"
+
+module StripeWebhooks
+  include Callbacks
+end

data/lib/stripe_webhooks/callbacks.rb

@@ -0,0 +1,24 @@
+module StripeWebhooks
+  module Callbacks
+
+    def self.included(base)
+      base.instance_variable_set(:@callbacks, [])
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      attr_reader :callbacks
+
+      # Add a callback to be ran whenever a new event is recorded
+      #
+      # === Example
+      #
+      #  StripeWebhooks.register_callback('my_callback')
+      #  
+      def register_callback(label)
+        @callbacks << label
+      end
+    end
+
+  end
+end