RubyGems - thumbjive-koudoku - Versions diffs - 1.5.0 - Mend

thumbjive-koudoku 1.5.0

Files changed (92) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +198 -0
data/Rakefile +10 -0
data/app/assets/javascripts/koudoku/application.js +15 -0
data/app/assets/stylesheets/koudoku/application.css +13 -0
data/app/assets/stylesheets/koudoku/pricing-table.scss +78 -0
data/app/concerns/koudoku/coupon.rb +7 -0
data/app/concerns/koudoku/plan.rb +14 -0
data/app/concerns/koudoku/subscription.rb +255 -0
data/app/controllers/koudoku/application_controller.rb +7 -0
data/app/controllers/koudoku/subscriptions_controller.rb +181 -0
data/app/helpers/koudoku/application_helper.rb +20 -0
data/app/views/koudoku/subscriptions/_card.html.erb +99 -0
data/app/views/koudoku/subscriptions/_pricing_table.html.erb +40 -0
data/app/views/koudoku/subscriptions/_social_proof.html.erb +11 -0
data/app/views/koudoku/subscriptions/_stripe_js.html.erb +0 -0
data/app/views/koudoku/subscriptions/edit.html.erb +7 -0
data/app/views/koudoku/subscriptions/index.html.erb +2 -0
data/app/views/koudoku/subscriptions/new.html.erb +1 -0
data/app/views/koudoku/subscriptions/show.html.erb +15 -0
data/app/views/koudoku/subscriptions/unauthorized.html.erb +1 -0
data/app/views/layouts/koudoku/application.html.erb +14 -0
data/config/environment.rb +0 -0
data/config/initializers/stripe_event.rb +27 -0
data/config/locales/en.yml +58 -0
data/config/locales/pt-BR.yml +57 -0
data/config/routes.rb +14 -0
data/lib/generators/koudoku/install_generator.rb +74 -0
data/lib/generators/koudoku/templates/app/models/coupon.rb +5 -0
data/lib/generators/koudoku/templates/app/models/plan.rb +6 -0
data/lib/generators/koudoku/templates/app/models/subscription.rb +8 -0
data/lib/generators/koudoku/templates/config/initializers/koudoku.rb +18 -0
data/lib/generators/koudoku/views_generator.rb +31 -0
data/lib/koudoku-tj.rb +0 -0
data/lib/koudoku.rb +84 -0
data/lib/koudoku/engine.rb +20 -0
data/lib/koudoku/errors.rb +4 -0
data/lib/koudoku/version.rb +3 -0
data/lib/tasks/koudoku_tasks.rake +12 -0
data/spec/concerns/koudoku/plan_spec.rb +39 -0
data/spec/concerns/koudoku/subscription_spec.rb +0 -0
data/spec/controllers/koudoku/subscriptions_controller.rb +21 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/models/coupon.rb +3 -0
data/spec/dummy/app/models/customer.rb +6 -0
data/spec/dummy/app/models/plan.rb +8 -0
data/spec/dummy/app/models/subscription.rb +7 -0
data/spec/dummy/app/views/koudoku/subscriptions/_social_proof.html.erb +11 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +55 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +32 -0
data/spec/dummy/config/environments/production.rb +69 -0
data/spec/dummy/config/environments/test.rb +36 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/devise.rb +0 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/koudoku.rb +7 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/devise.en.yml +59 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +6 -0
data/spec/dummy/db/migrate/20130318201927_create_customers.rb +8 -0
data/spec/dummy/db/migrate/20130318204455_create_subscriptions.rb +16 -0
data/spec/dummy/db/migrate/20130318204458_create_plans.rb +14 -0
data/spec/dummy/db/migrate/20130318204502_create_coupons.rb +10 -0
data/spec/dummy/db/migrate/20130520163946_add_interval_to_plan.rb +5 -0
data/spec/dummy/db/schema.rb +53 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/test.log +80 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/dummy/test/fixtures/customers.yml +7 -0
data/spec/dummy/test/unit/customer_test.rb +7 -0
data/spec/helpers/koudoku/application_helper_spec.rb +29 -0
data/spec/spec_helper.rb +30 -0
metadata +332 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50fbdceb853ea51b754ebeb8ade4a9feccec2563
+  data.tar.gz: 783bd44103f5e4bd053bf62dda3a7b8302f81afe
+SHA512:
+  metadata.gz: 7f7b506a2e1828936b26d02c3029cd7b53444e6842557541c5f0495e9b6306f9f4e7617204872232e8360e6fb01933fe7047ba0ca394497e153ca174f7a36b57
+  data.tar.gz: da482feb71c1315e06a39e419bc56a12d8dbdc494d50fd2a033875040c3e6d2d16b0e1f91715ffc0c16dacc665da59b52a9b39da48ae689bdef5886947c8f42f

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+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 ADDED Viewed

@@ -0,0 +1,198 @@
+# Koudoku
+[![Gem Version](https://badge.fury.io/rb/koudoku.png)](https://rubygems.org/gems/koudoku) [![Code Climate](https://codeclimate.com/github/andrewculver/koudoku.png)](https://codeclimate.com/github/andrewculver/koudoku) [![Build Status](https://travis-ci.org/andrewculver/koudoku.png)](https://travis-ci.org/andrewculver/koudoku)
+Robust subscription support for Ruby on Rails apps using [Stripe](https://stripe.com), including out-of-the-box pricing pages, payment pages, and  subscription management for your customers. Also makes it easy to manage logic related to new subscriptions, upgrades, downgrades, cancellations, payment failures, and streamlines hooking up notifications, metrics logging, etc.
+To see an example of Koudoku in action, please visit [Koudoku.org](http://koudoku.org/).
+<small><a href="http://churnbuster.io"><img src="https://s3.amazonaws.com/andrew-culver-images/churn-buster/koudoku-readme.png" width="196" height="38" alt="Churn Buster" /></a><br>Koudoku is authored and maintained by [Andrew Culver](http://twitter.com/andrewculver) and [Christoph Engelhardt](https://twitter.com/itengelhardt). If you find it useful, consider checking out [Churn Buster](http://churnbuster.io). It's designed to help you handle the pain points you'll run into when doing payments at scale.</small>
+## Installation
+Include the following in your `Gemfile`:
+```ruby
+    gem 'koudoku'
+```
+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`. It may also be something like `company`, etc.)
+```ruby
+    rails g koudoku:install user
+    rake db:migrate
+```
+Add the following to `app/views/layouts/application.html.erb` before your `<head>` tag closes:
+```ruby
+    <%= yield :koudoku %>
+```
+(This allows us to inject a Stripe `<script>` tag in the correct place. If you don't, the payment form will not work.)
+After installing, you'll need to add some subscription plans. (You can see an explanation of each of the attributes in the table below.)
+**Note:** You need to create the plans in your [Stripe Dashboard](https://dashboard.stripe.com) separately.
+```ruby
+    Plan.create({
+      name: 'Personal',
+      price: 10.00,
+      interval: 'month',
+      stripe_id: '1',
+      features: ['1 Project', '1 Page', '1 User', '1 Organization'].join("\n\n"),
+      display_order: 1
+    })
+    Plan.create({
+      name: 'Team',
+      highlight: true, # This highlights the plan on the pricing page.
+      price: 30.00,
+      interval: 'month',
+      stripe_id: '2',
+      features: ['3 Projects', '3 Pages', '3 Users', '3 Organizations'].join("\n\n"),
+      display_order: 2
+    })
+    Plan.create({
+      name: 'Enterprise',
+      price: 100.00,
+      interval: 'month',
+      stripe_id: '3',
+      features: ['10 Projects', '10 Pages', '10 Users', '10 Organizations'].join("\n\n"),
+      display_order: 3
+    })
+```
+To help you understand the attributes:
+| Attribute       | Type    | Function |
+| --------------- | ------- | -------- |
+| `name`          | string  | Name for the plan to be presented to customers. |
+| `price`         | float   | Price per billing cycle. |
+| `interval`      | string  | *Optional.* What is the billing cycle? Valid options are `month`, `year`, `week`, `3-month`, `6-month`. Defaults to `month`. |
+| `stripe_id`     | string  | The Plan ID in Stripe. |
+| `features`      | string  | A list of features. Supports Markdown syntax. |
+| `display_order` | integer | Order in which to display plans. |
+| `highlight`     | boolean | *Optional.* Whether to highlight the plan on the pricing page. |
+The only view installed locally into your app by default is the `koudoku/subscriptions/_social_proof.html.erb` partial which is displayed alongside the pricing table. It's designed as a placeholder where you can provide quotes about your product from customers that could positively influence your visitors.
+### Configuring Stripe API Keys
+You can supply your publishable and secret API keys in `config/initializers/koudoku.rb`. However, by default it will use the `STRIPE_PUBLISHABLE_KEY` and `STRIPE_SECRET_KEY` shell environment variables. This encourages people to keep these API keys out of version control. You may want to rename these environment variables to be more application specific.
+In a bash shell, you can set them in `~/.bash_profile` like so:
+```bash
+    export STRIPE_PUBLISHABLE_KEY=pk_0CJwDH9sdh98f79FDHDOjdiOxQob0
+    export STRIPE_SECRET_KEY=sk_0CJwFDIUshdfh97JDJOjZ5OIDjOCH
+```
+(Reload your terminal for these settings to take effect.)
+On Heroku you accomplish this same effect with [Config Vars](https://devcenter.heroku.com/articles/config-vars):
+```bash
+    heroku config:add STRIPE_PUBLISHABLE_KEY=pk_0CJwDH9sdh98f79FDHDOjdiOxQob0
+    heroku config:add STRIPE_SECRET_KEY=sk_0CJwFDIUshdfh97JDJOjZ5OIDjOCH
+```
+## User-Facing Subscription Management
+By default a `pricing_path` route is defined which you can link to in order to show visitors a pricing table. If a user is signed in, this pricing table will take into account their current plan. For example, you can link to this page like so:
+```ruby
+    <%= link_to 'Pricing', main_app.pricing_path %>
+```
+(Note: Koudoku uses the application layout, so it's important that application paths referenced in that layout are prefixed with "`main_app.`" like you see above or Rails will try to look the paths up in the Koudoku engine instead of your application.)
+Existing users can view available plans, select a plan, enter credit card details, review their subscription, change plans, and cancel at the following route:
+```ruby
+    koudoku.owner_subscriptions_path(@user)
+```
+In these paths, `owner` refers to `User` by default, or whatever model has been configured to be the owner of the `Subscription` model.
+A number of views are provided by default. To customize the views, use the following generator:
+```ruby
+    rails g koudoku:views
+```
+### Pricing Table
+Koudoku ships with a stock pricing table. By default it depends on Twitter Bootstrap, but also has some additional styles required. In order to import these styles, add the following to your `app/assets/stylesheets/application.css`:
+```css
+    *= require 'koudoku/pricing-table'
+```
+Or, if you've replaced your `application.css` with an `application.scss` (like I always do):
+```css
+    @import "koudoku/pricing-table"
+```
+## Using Coupons
+While more robust coupon support is expected in the future, the simple way to use a coupon is to first create it:
+```ruby
+    coupon = Coupon.create(code: '30-days-free', free_trial_length: 30)
+```
+Then assign it to a _new_ subscription before saving:
+```ruby
+    subscription = Subscription.new(...)
+    subscription.coupon = coupon
+    subscription.save
+```
+It should be noted that these coupons are different from the coupons provided natively by Stripe.
+## Implementing Logging, Notifications, etc.
+The included module defines the following empty "template methods" which you're able to provide an implementation for in `Subscription`:
+ - `prepare_for_plan_change`
+ - `prepare_for_new_subscription`
+ - `prepare_for_upgrade`
+ - `prepare_for_downgrade`
+ - `prepare_for_cancelation`
+ - `prepare_for_card_update`
+ - `finalize_plan_change!`
+ - `finalize_new_subscription!`
+ - `finalize_upgrade!`
+ - `finalize_downgrade!`
+ - `finalize_cancelation!`
+ - `finalize_card_update!`
+ - `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.
+### Webhooks
+We use [stripe_event](https://github.com/integrallis/stripe_event) under the hood to support webhooks.
+The default webhooks URL is `/koudoku/webhooks`.
+You can add your own webhooks using the (reduced) stripe_event syntax in the `config/initializers/koudoku.rb` file:
+```
+# /config/initializers/koudoku.rb
+Koudoku.setup do |config|
+  config.subscriptions_owned_by = :user
+  config.stripe_publishable_key = ENV['STRIPE_PUBLISHABLE_KEY']
+  config.stripe_secret_key = ENV['STRIPE_SECRET_KEY']
+  # add webhooks
+  config.subscribe 'charge.failed', YourChargeFailed
+end
+```

data/Rakefile ADDED Viewed

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+task default: :spec

data/app/assets/javascripts/koudoku/application.js ADDED Viewed

@@ -0,0 +1,15 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/koudoku/application.css ADDED Viewed

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/koudoku/pricing-table.scss ADDED Viewed

@@ -0,0 +1,78 @@
+ul.koudoku-pricing-table {
+  position: relative;
+  margin: 20px 0;
+  margin-left: 25px;
+  li.plan {
+    text-align: center;
+    background-color: #f5f5f5;
+    margin-top: 17px;
+    margin-left: 0;
+    position: relative;
+    z-index: 99;
+    &.plan-primary {
+      background-color: #f9f9f9;
+      margin-top: 0px;
+      margin-left: -5px;
+      margin-right: -5px;
+      z-index: 100;
+      h3 {
+        font-size: 32.5px;
+        line-height: 51px;
+      }
+      h4 {
+        line-height: 22px;
+      }
+      a, input[type=submit] {
+        font-size: 21.5px;
+        line-height: 26px;
+      }
+      ul.features {
+        margin-bottom: 12px;
+        li {
+          font-size: 12pt;
+        }
+      }
+    }
+    .call-to-action {
+      margin: 10px 0;
+    }
+    .features {
+      margin: 0;
+      li {
+        list-style: none;
+        padding: 8px;
+        line-height: 18px;
+        vertical-align: top;
+        border-top: 1px solid #dddddd;
+      }
+      li:first-child {
+        border-top: none;
+      }
+    }
+  }
+  .social-proof {
+    padding: 17px 0;
+    blockquote {
+      h2, h3, h4 {
+        padding: 5px 0;
+      }
+    }
+  }
+}

data/app/concerns/koudoku/coupon.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module Koudoku::Coupon
+  extend ActiveSupport::Concern
+  included do
+    has_many :subscriptions
+  end
+end

data/app/concerns/koudoku/plan.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module Koudoku::Plan
+  extend ActiveSupport::Concern
+  # Todo: fix the unit tests so that the association can be defined here
+  #
+  # included do
+  #   has_many :subscriptions
+  # end
+  def is_upgrade_from?(plan)
+    (price || 0) >= (plan.price || 0)
+  end
+end

data/app/concerns/koudoku/subscription.rb ADDED Viewed

@@ -0,0 +1,255 @@
+module Koudoku::Subscription
+  extend ActiveSupport::Concern
+  included do
+    # We don't store these one-time use tokens, but this is what Stripe provides
+    # client-side after storing the credit card information.
+    attr_accessor :credit_card_token
+    belongs_to :plan, optional: true
+    belongs_to :coupon, optional: true
+    belongs_to Koudoku.subscriptions_owned_by
+    # update details.
+    before_save :processing!
+    def processing!
+      # if their package level has changed ..
+      if changing_plans?
+        prepare_for_plan_change
+        # and a customer exists in stripe ..
+        if stripe_id.present?
+          # fetch the customer.
+          customer = Stripe::Customer.retrieve(self.stripe_id)
+          # if a new plan has been selected
+          if self.plan.present?
+            # Record the new plan pricing.
+            self.current_price = self.plan.price
+            prepare_for_downgrade if downgrading?
+            prepare_for_upgrade if upgrading?
+            # update the package level with stripe.
+            customer.update_subscription(:plan => self.plan.stripe_id, :prorate => Koudoku.prorate)
+            finalize_downgrade! if downgrading?
+            finalize_upgrade! if upgrading?
+          # if no plan has been selected.
+          else
+            prepare_for_cancelation
+            # Remove the current pricing.
+            self.current_price = nil
+            # delete the subscription.
+            customer.cancel_subscription
+            finalize_cancelation!
+          end
+        # when customer DOES NOT exist in stripe ..
+        else
+          # if a new plan has been selected
+          if self.plan.present?
+            # Record the new plan pricing.
+            self.current_price = self.plan.price
+            prepare_for_new_subscription
+            prepare_for_upgrade
+            begin
+              # raise Koudoku::NilCardToken, "Possible javascript error" if credit_card_token.blank?
+              raise "Possible javascript error" if credit_card_token.blank?
+              customer_attributes = {
+                description: subscription_owner_description,
+                email: subscription_owner_email,
+                card: credit_card_token # obtained with Stripe.js
+              }
+              # If the class we're being included in supports coupons ..
+              if respond_to? :coupon
+                if coupon.present? and coupon.free_trial?
+                  customer_attributes[:trial_end] = coupon.free_trial_ends.to_i
+                end
+              end
+              customer_attributes[:coupon] = @coupon_code if @coupon_code
+              # create a customer at that package level.
+              customer = Stripe::Customer.create(customer_attributes)
+              finalize_new_customer!(customer.id, plan.price)
+              customer.update_subscription(:plan => self.plan.stripe_id, :prorate => Koudoku.prorate)
+            rescue Stripe::CardError => card_error
+              errors[:base] << card_error.message
+              card_was_declined
+              return false
+            end
+            # store the customer id.
+            self.stripe_id = customer.id
+            self.last_four = customer.cards.retrieve(customer.default_card).last4
+            finalize_new_subscription!
+            finalize_upgrade!
+          else
+            # This should never happen.
+            self.plan_id = nil
+            # Remove any plan pricing.
+            self.current_price = nil
+          end
+        end
+        finalize_plan_change!
+      # if they're updating their credit card details.
+      elsif self.credit_card_token.present?
+        prepare_for_card_update
+        # fetch the customer.
+        customer = Stripe::Customer.retrieve(self.stripe_id)
+        customer.card = self.credit_card_token
+        customer.save
+        # update the last four based on this new card.
+        self.last_four = customer.cards.retrieve(customer.default_card).last4
+        finalize_card_update!
+      end
+    end
+  end
+  def describe_difference(plan_to_describe)
+    if plan.nil?
+      if persisted?
+        I18n.t('koudoku.plan_difference.upgrade')
+      else
+        if Koudoku.free_trial?
+          I18n.t('koudoku.plan_difference.start_trial')
+        else
+          I18n.t('koudoku.plan_difference.upgrade')
+        end
+      end
+    else
+      if plan_to_describe.is_upgrade_from?(plan)
+        I18n.t('koudoku.plan_difference.upgrade')
+      else
+        I18n.t('koudoku.plan_difference.downgrade')
+      end
+    end
+  end
+  # Set a Stripe coupon code that will be used when a new Stripe customer (a.k.a. Koudoku subscription)
+  # is created
+  def coupon_code=(new_code)
+    @coupon_code = new_code
+  end
+  # Pretty sure this wouldn't conflict with anything someone would put in their model
+  def subscription_owner
+    # Return whatever we belong to.
+    # If this object doesn't respond to 'name', please update owner_description.
+    send Koudoku.subscriptions_owned_by
+  end
+  def subscription_owner=(owner)
+    # e.g. @subscription.user = @owner
+    send Koudoku.owner_assignment_sym, owner
+  end
+  def subscription_owner_description
+    # assuming owner responds to name.
+    # we should check for whether it responds to this or not.
+    "#{subscription_owner.try(:name) || subscription_owner.try(:id)}"
+  end
+  def subscription_owner_email
+    "#{subscription_owner.try(:email)}"
+  end
+  def changing_plans?
+    plan_id_changed?
+  end
+  def downgrading?
+    plan.present? and plan_id_was.present? and plan_id_was > self.plan_id
+  end
+  def upgrading?
+    (plan_id_was.present? and plan_id_was < plan_id) or plan_id_was.nil?
+  end
+  # Template methods.
+  def prepare_for_plan_change
+  end
+  def prepare_for_new_subscription
+  end
+  def prepare_for_upgrade
+  end
+  def prepare_for_downgrade
+  end
+  def prepare_for_cancelation
+  end
+  def prepare_for_card_update
+  end
+  def finalize_plan_change!
+  end
+  def finalize_new_subscription!
+  end
+  def finalize_new_customer!(customer_id, amount)
+  end
+  def finalize_upgrade!
+  end
+  def finalize_downgrade!
+  end
+  def finalize_cancelation!
+  end
+  def finalize_card_update!
+  end
+  def card_was_declined
+  end
+  # stripe web-hook callbacks.
+  def payment_succeeded(amount)
+  end
+  def charge_failed
+  end
+  def charge_disputed
+  end
+end