koudoku 0.0.3 → 0.0.4

data/MIT-LICENSE

@@ -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

@@ -8,10 +8,55 @@ Include the following in your `Gemfile`:
 
     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`".)
+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.)
 
     rails g koudoku:install user
+    
+After installing, you'll need to add some subscription plans.
+
+    Plan.create(name: 'Personal', price: 10.00, stripe_id: '1')
+    Plan.create(name: 'Team', price: 30.00, stripe_id: '2')
+    Plan.create(name: 'Enterprise', price: 100.00, stripe_id: '3')
+    
+### 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:
+
+    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):
+
+    heroku config:add STRIPE_PUBLISHABLE_KEY=pk_0CJwDH9sdh98f79FDHDOjdiOxQob0
+    heroku config:add STRIPE_SECRET_KEY=sk_0CJwFDIUshdfh97JDJOjZ5OIDjOCH
+    
+## User-Facing Subscription Management
+
+Users can view available plans, select a plan, enter credit card details, review their subscription, change plans, and cancel at the following route:
 
+    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:
+
+    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`:
+
+    *= require 'koudoku/pricing-table'
+    
+Or, if you've replaced your `application.css` with an `application.scss` (like I always do):
+
+    @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:
@@ -26,7 +71,7 @@ Then assign it to a _new_ subscription before saving:
     
 ## Implementing Logging, Notifications, etc.
 
-The included module defined the following empty "template methods" which you're able to provide an implementation for:
+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`
@@ -46,10 +91,12 @@ Between `prepare_for_*` and `finalize_*`, so far I've used `finalize_*` almost e
 
 ### 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:
+During the installation process, a path and API key will be printed out that you can configure in the Stripe account panel that will allow your application to receive information about recurring transactions as they happen. (These are useful for reacting to expired credit cards on file and revenue tracking.)
+
+Support for Stripe Webhooks is still quite limited. You can implement the following template methods of the `Subscription`:
 
   - `payment_succeeded(amount)`
   - `charge_failed`
   - `charge_disputed`
   
-No additional information is currently handled from the webhook request body.
+As mentioned before, be sure to call `super` in your implementations. No additional information from Stripe is currently handled from the webhook request body.

data/Rakefile

@@ -1 +1,40 @@
-require "bundler/gem_tasks"
+#!/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    = 'Koudoku'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.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/koudoku/application.js

@@ -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

@@ -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

@@ -0,0 +1,77 @@
+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;
+      
+      h2 {
+        margin-top: 5px;
+        padding-bottom: 7px;
+        font-size: 2.5em;
+      }
+      a, input[type=submit] {
+        font-size: 2em;
+        font-size: 14pt;
+      }
+      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/plan.rb

@@ -0,0 +1,20 @@
+module Koudoku::Plan
+  extend ActiveSupport::Concern
+
+  included do
+
+  end
+
+  module ClassMethods
+
+  end
+
+  module InstanceMethods
+    
+    def is_upgrade_from?(plan)
+      self.price >= plan.price
+    end
+
+  end
+
+end

data/{lib → app/concerns}/koudoku/subscription.rb

@@ -3,12 +3,12 @@ module Koudoku::Subscription
 
   included do
 
-    attr_accessible :plan_id, :stripe_id, :current_price
+    attr_accessible :plan_id, :stripe_id, :current_price, :credit_card_token, :card_type, :last_four
 
-    # We don't store these one-time use tokens, but this is what Strie provides
+    # 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
 
     # update details.
@@ -84,7 +84,7 @@ module Koudoku::Subscription
 
               # create a customer at that package level.
               customer = Stripe::Customer.create(customer_attributes)
-
+              
             rescue Stripe::CardError => card_error
               errors[:base] << card_error.message
               card_was_declined
@@ -123,18 +123,38 @@ module Koudoku::Subscription
   end
 
   module InstanceMethods
+    
+    def describe_difference(plan_to_describe)
+      if plan.nil?
+        if persisted?
+          "Upgrade"
+        else
+          if Koudoku.free_trial?
+            "Start Trial"
+          else 
+            "Upgrade"
+          end
+        end
+      else
+        if plan_to_describe.is_upgrade_from?(plan)
+          "Upgrade"
+        else
+          "Downgrade"
+        end
+      end
+    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.
-      user
+      send Koudoku.subscriptions_owned_by
     end
 
     def subscription_owner_description
       # assuming owner responds to name.
       # we should check for whether it responds to this or not.
-      "#{subscription_owner.name} (#{subscription_owner.id})"
+      "#{subscription_owner.id}"
     end
 
     def changing_plans?

data/app/controllers/koudoku/application_controller.rb

@@ -0,0 +1,5 @@
+module Koudoku
+  class ApplicationController < ActionController::Base
+    layout 'application'
+  end
+end

data/app/controllers/koudoku/subscriptions_controller.rb

@@ -0,0 +1,63 @@
+module Koudoku
+  class SubscriptionsController < ApplicationController
+    before_filter :load_owner
+    before_filter :show_existing_subscription, only: [:index, :new, :create]
+    before_filter :load_subscription, only: [:show, :cancel, :edit, :update]
+    before_filter :load_plans, only: [:index, :edit]
+    def load_plans
+      @plans = ::Plan.order(:price)
+    end
+    def load_owner
+      # e.g. User.find(params[:user_id])
+      @owner = Koudoku.owner_class.find(params[:owner_id])
+    end
+    def load_subscription
+      @subscription = ::Subscription.find(params[:id])
+    end
+    def index
+      # we should also set the owner of the subscription here.
+      @subscription = ::Subscription.new({Koudoku.owner_id_sym => @owner.id})
+      # e.g. @subscription.user = @owner
+      @subscription.send Koudoku.owner_assignment_sym, @owner
+    end
+    def new
+      @subscription = ::Subscription.new
+      @subscription.plan = ::Plan.find(params[:plan])
+    end
+    def show_existing_subscription
+      if @owner.subscription.present?
+        redirect_to owner_subscription_path(@owner, @owner.subscription)
+      end
+    end
+    def create
+      @subscription = ::Subscription.new(params[:subscription])
+      @subscription.user = @owner
+      if @subscription.save
+        flash[:success] = "You've been successfully upgraded."
+        redirect_to owner_subscription_path(@owner, @subscription)
+      else
+        flash[:error] = 'There was a problem processing this transaction.'
+        render :new
+      end
+    end
+    def show
+    end
+    def cancel
+      flash[:success] = "You've successfully cancelled your subscription."
+      @subscription.plan_id = nil
+      @subscription.save
+      redirect_to owner_subscription_path(@owner, @subscription)
+    end
+    def edit
+    end
+    def update
+      if @subscription.update_attributes(params[:subscription])
+        flash[:success] = "You've been successfully upgraded."
+        redirect_to owner_subscription_path(@owner, @subscription)
+      else
+        flash[:error] = 'There was a problem processing this transaction.'
+        render :edit
+      end
+    end
+  end
+end

data/app/controllers/koudoku/webhooks_controller.rb

@@ -0,0 +1,38 @@
+module Koudoku
+  class WebhooksController < ApplicationController
+
+    def create
+    
+      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']
+    
+        subscription = ::Subscription.find_by_stripe_id(stripe_id)
+        listing = subscription.listing
+        subscription.charge_disputed
+      
+      end
+    
+    end
+    
+  end
+end