koudoku 0.0.2 → 0.0.3

data/README.md

@@ -1,80 +1,16 @@
 # Koudoku
 
-Robust subscription support for Ruby on Rails apps using [Stripe](https://stripe.com). Makes it easy to manage actions related to new subscriptions, upgrades, downgrades, cancelations, as well as hooking up notifications, metrics logging, coupons, etc.
+Robust subscription support for Ruby on Rails apps using [Stripe](https://stripe.com). Makes it easy to manage actions related to new subscriptions, upgrades, downgrades, cancelations, payment failures, as well as hooking up notifications, metrics logging, coupons, etc.
 
 ## Installation
 
 Include the following in your `Gemfile`:
 
     gem 'koudoku'
-
-## Usage
-
-There are no generators at the moment, so you'll need to generate plans, subscriptions, and (optionally) coupons on your own:
-
-### Subscriptions
-
-    rails g model subscription stripe_id:string plan_id:integer last_four:string coupon_id:integer current_price:float user_id:integer
     
-Only include `coupon_id` if you want to support coupons. The `user_id` property should actually be the foreign key for whatever model you want your subscriptions to relate to. (User is just the default.)
-
-Then, dress up your subscription model by including the `Koudoku::Subscription` module and defining some essential relationships:
-
-    class Subscription < ActiveRecord::Base
-      include Koudoku::Subscription
-
-      # Belongs to user. (This is the default.)
-      attr_accessible :user_id
-      belongs_to :user
-  
-      # Supports coupons.
-      attr_accessible :coupon_id
-      belongs_to :coupon
-
-    end
-
-### Plans
-
-    rails g model plan name:string stripe_id:string price:float
-    
-The `stripe_id` for each plan must match the ID from Stripe. The price here isn't affected by (nor does it affect) the price in Stripe.
-
-You'll need to create a few plans to start. (You don't need to create a plan to represent "free" accounts.)
-
-    Plan.create(name: 'Personal', price: '10.00')
-    Plan.create(name: 'Team', price: '30.00')
-    Plan.create(name: 'Enterprise', price: '100.00')
-
-### Coupons
-
-Again, this is only required if you want to support coupons:
-
-    rails g model coupon code:string free_trial_length:string
-
-
-## Subscriptions That Belong to Models Other than User
-
-Here's an example of a subscription that belongs to a company rather than a user:
-
-    class Subscription < ActiveRecord::Base
-      include Koudoku::Subscription
-
-      # Ownership.
-      attr_accessible :company_id
-      belongs_to :company
-
-      # Inform Koudoku::Subscription how to identify the owner of the subscription.
-      def subscription_owner
-        company
-      end
-  
-      # Inform Koudoku::Subscription how to represent the owner in emails, etc.
-      def subscription_owner_description
-        "#{company.name} (#{company.primary_contact_name})"
-      end
-
-    end
+After running `bundle install`, you can run a Rails generator to do the rest. Before installing, the model you'd like to have own subscriptions must already exist. (In many cases this will be "`user`".)
 
+    rails g koudoku:install user
 
 ## Using Coupons
 
@@ -88,7 +24,6 @@ Then assign it to a _new_ subscription before saving:
     subscription.coupon = coupon
     subscription.save
     
-    
 ## Implementing Logging, Notifications, etc.
 
 The included module defined the following empty "template methods" which you're able to provide an implementation for:
@@ -104,8 +39,17 @@ The included module defined the following empty "template methods" which you're
  - `finalize_downgrade!`
  - `finalize_cancelation!`
  - `card_was_declined`
-
+ 
 Be sure to include a call to `super` in each of your implementations, especially if you're using multiple concerns to break all this logic into smaller pieces.
 
 Between `prepare_for_*` and `finalize_*`, so far I've used `finalize_*` almost exclusively. The difference is that `prepare_for_*` runs before we settle things with Stripe, and `finalize_*` runs after everything is settled in Stripe. For that reason, please be sure not to implement anything in `finalize_*` implementations that might cause issues with ActiveRecord saving the updated state of the subscription.
 
+### Stripe Webhooks
+
+Support for Stripe Webhooks is still quite limited. To react to some of the webhooks that are currently handled, you can implement the following template methods of the `Subscription` class:
+
+  - `payment_succeeded(amount)`
+  - `charge_failed`
+  - `charge_disputed`
+  
+No additional information is currently handled from the webhook request body.

data/lib/generators/koudoku/install_generator.rb

@@ -0,0 +1,63 @@
+# this generator based on rails_admin's install generator.
+# https://www.github.com/sferik/rails_admin/master/lib/generators/rails_admin/install_generator.rb
+
+require 'rails/generators'
+
+# http://guides.rubyonrails.org/generators.html
+# http://rdoc.info/github/wycats/thor/master/Thor/Actions.html
+
+module Koudoku
+  class InstallGenerator < Rails::Generators::Base
+
+    # Not sure what this does.
+    source_root File.expand_path("../templates", __FILE__)
+
+    include Rails::Generators::Migration
+
+    argument :subscription_owner_model, :type => :string, :required => true, :desc => "Owner of the subscription"
+    desc "Koudoku installation generator"
+
+    def install
+      
+      unless defined?(Koudoku)
+        gem("koudoku")
+      end
+      
+      require "securerandom"
+      api_key = SecureRandom.uuid
+      create_file 'config/initializers/koudoku.rb' do
+      <<-RUBY
+Koudoku.setup do |config|
+  config.webhooks_api_key = "#{api_key}"
+end
+RUBY
+      end
+
+      # Generate subscription.
+      generate("model", "subscription stripe_id:string plan_id:integer last_four:string coupon_id:integer current_price:float #{subscription_owner_model}_id:integer")
+      gsub_file "app/models/subscription.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n  include Koudoku::Subscription\n\n  belongs_to :#{subscription_owner_model}\n  belongs_to :coupon\n"
+      
+      # Add the plans.
+      generate("model", "plan name:string stripe_id:string price:float")
+      gsub_file "app/models/plan.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n  belongs_to :#{subscription_owner_model}\n  belongs_to :coupon\n"
+
+      # Add coupons.
+      generate("model coupon code:string free_trial_length:string")
+      gsub_file "app/models/plan.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n  has_many :subscriptions\n"
+      
+      # Update the owner relationship.
+      gsub_file "app/models/#{subscription_owner_model}.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n\n  # Added by Koudoku.\n  has_one :subscription\n\n"
+
+      # Update the owner relationship.
+      gsub_file "app/models/#{subscription_owner_model}.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n\n  # Added by Koudoku.\n  has_one :subscription\n\n"
+
+      # Add webhooks to the route.
+      gsub_file "config/routes.rb", /Application.routes.draw do/, "Application.routes.draw do\n\n  # Added by Koudoku.\n  namespace :koudoku do\n    match 'webhooks' => 'webhooks#process'\n  end\n\n"
+      
+      # Show the user the API key we generated.
+      say "\nTo enable support for Stripe webhooks, point it to \"/koudoku/webhooks?api_key=#{api_key}\". This API key has been randomly generated, so it's unique to your application.\n\n"
+      
+    end
+
+  end
+end

data/lib/koudoku.rb

@@ -1,5 +1,18 @@
 require "koudoku/version"
 require "koudoku/subscription"
+require "koudoku/webhooks_controller"
+require "generators/koudoku/install_generator"
+
+# Load all rake tasks.
+Dir["tasks/**/*.rake"].each { |ext| load ext } if defined?(Rake)
 
 module Koudoku
+
+  mattr_accessor :webhooks_api_key
+  @@webhooks_api_key = nil
+  
+  def self.setup
+    yield self
+  end
+  
 end

data/lib/koudoku/subscription.rb

@@ -182,6 +182,16 @@ module Koudoku::Subscription
 
     def card_was_declined
     end
+    
+    # stripe web-hook callbacks.
+    def payment_succeeded(amount)
+    end
+    
+    def charge_failed
+    end
+    
+    def charge_disputed
+    end
 
   end
 

data/lib/koudoku/version.rb

@@ -1,3 +1,3 @@
 module Koudoku
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/koudoku/webhooks_controller.rb

@@ -0,0 +1,37 @@
+class Koudoku::WebhooksController < ActionController::Base
+
+  # I have no idea why this parameter is required to be here.
+  # If we don't do this, we get "wrong number of arguments (1 for 0)"
+  def process(parameter = nil)
+    
+    raise "API key not configured. For security reasons you must configure this in 'config/koudoku.rb'." unless Koudoku.webhooks_api_key.present?
+    raise "Invalid API key. Be sure the webhooks URL Stripe is configured with includes ?api_key= and the correct key." unless params[:api_key] == Koudoku.webhooks_api_key
+    
+    data_json = JSON.parse request.body.read
+    
+    if data_json['type'] == "invoice.payment_succeeded"
+      
+      stripe_id = data_json['data']['object']['customer']
+      amount = data_json['data']['object']['total'].to_f / 100.0
+      subscription = Subscription.find_by_stripe_id(stripe_id)
+      subscription.payment_succeeded(amount)
+    
+    elsif data_json['type'] == "charge.failed"
+    
+      stripe_id = data_json['data']['object']['customer']
+      subscription = Subscription.find_by_stripe_id(stripe_id)
+      subscription.charge_failed
+    
+    elsif data_json['type'] == "charge.dispute.created"
+    
+      stripe_id = data_json['data']['object']['customer']
+    
+      puts "Finding listing with Stripe ID #{stripe_id}"
+      subscription = Subscription.find_by_stripe_id(stripe_id)
+      listing = subscription.listing
+      subscription.charge_disputed
+      
+    end
+    
+  end
+end

data/lib/tasks/koudoku.rake

@@ -0,0 +1,8 @@
+namespace :koudoku do
+
+  desc "Install koudoku"
+  task :install do
+    system 'rails g koudoku:install'
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: koudoku
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-27 00:00:00.000000000 Z
+date: 2012-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70303128505700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70303128505700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: stripe
-  requirement: &70303128502880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70303128502880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Robust subscription support for Rails with Stripe. Provides package levels,
   coupons, logging, notifications, etc.
 email:
@@ -45,10 +55,15 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- docs/INSTALLATION.md
 - koudoku.gemspec
+- lib/generators/koudoku/install_generator.rb
+- lib/generators/koudoku/templates/insert_default_plans.rb
 - lib/koudoku.rb
 - lib/koudoku/subscription.rb
 - lib/koudoku/version.rb
+- lib/koudoku/webhooks_controller.rb
+- lib/tasks/koudoku.rake
 homepage: http://github.com/andrewculver/koudoku
 licenses: []
 post_install_message: 
@@ -69,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: koudoku
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Robust subscription support for Rails with Stripe.