koudoku 0.0.8 → 0.0.9

data/README.md

@@ -15,13 +15,15 @@ After running `bundle install`, you can run a Rails generator to do the rest. Be
     rails g koudoku:install user
     rake db:migrate
     
-After installing, you'll need to add some subscription plans. (Note that we highlight the 'Team' plan.)
+After installing, you'll need to add some subscription plans. (You can see an explanation of each of the attributes in the table below.)
 
     Plan.create({
       name: 'Personal',
       price: 10.00,
-      stripe_id: '1', # This maps to the plan ID in Stripe.
-      features: ['1 Project', '1 Page', '1 User', '1 Organization'].join("\n\n"), # Features support Markdown syntax.
+      interval: 'month',
+      stripe_id: '1',
+      features: ['1 Project', '1 Page', '1 User', '1 Organization'].join("\n\n"),
+      interval: 'month',
       display_order: 1
     })
 
@@ -29,6 +31,7 @@ After installing, you'll need to add some subscription plans. (Note that we high
       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
@@ -37,11 +40,24 @@ After installing, you'll need to add some subscription plans. (Note that we high
     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

data/Rakefile

@@ -20,21 +20,14 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/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
-
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
 
-task :default => :test
+task :default => :spec

data/app/concerns/koudoku/plan.rb

@@ -9,12 +9,8 @@ module Koudoku::Plan
 
   end
 
-  module InstanceMethods
-    
-    def is_upgrade_from?(plan)
-      self.price >= plan.price
-    end
-
+  def is_upgrade_from?(plan)
+    (price || 0) >= (plan.price || 0)
   end
 
 end

data/app/concerns/koudoku/subscription.rb

@@ -12,7 +12,8 @@ module Koudoku::Subscription
     belongs_to :plan
 
     # update details.
-    before_save do
+    before_save :processing!
+    def processing!
 
       # if their package level has changed ..
       if changing_plans? 
@@ -137,103 +138,99 @@ module Koudoku::Subscription
   module ClassMethods
   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
+  def describe_difference(plan_to_describe)
+    if plan.nil?
+      if persisted?
+        "Upgrade"
       else
-        if plan_to_describe.is_upgrade_from?(plan)
+        if Koudoku.free_trial?
+          "Start Trial"
+        else 
           "Upgrade"
-        else
-          "Downgrade"
         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.
-      send Koudoku.subscriptions_owned_by
-    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_description
-      # assuming owner responds to name.
-      # we should check for whether it responds to this or not.
-      "#{subscription_owner.id}"
-    end
+  def subscription_owner_description
+    # assuming owner responds to name.
+    # we should check for whether it responds to this or not.
+    "#{subscription_owner.id}"
+  end
 
-    def changing_plans?
-      plan_id_changed?
-    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 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
+  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
+  # Template methods.
+  def prepare_for_plan_change
+  end
 
-    def prepare_for_new_subscription
-    end
+  def prepare_for_new_subscription
+  end
 
-    def prepare_for_upgrade
-    end
+  def prepare_for_upgrade
+  end
 
-    def prepare_for_downgrade
-    end
+  def prepare_for_downgrade
+  end
 
-    def prepare_for_cancelation
-    end
-    
-    def prepare_for_card_update
-    end
+  def prepare_for_cancelation
+  end
+  
+  def prepare_for_card_update
+  end
 
-    def finalize_plan_change!
-    end
+  def finalize_plan_change!
+  end
 
-    def finalize_new_subscription!
-    end
+  def finalize_new_subscription!
+  end
 
-    def finalize_upgrade!
-    end
+  def finalize_upgrade!
+  end
 
-    def finalize_downgrade!
-    end
+  def finalize_downgrade!
+  end
 
-    def finalize_cancelation!
-    end
+  def finalize_cancelation!
+  end
 
-    def finalize_card_update!
-    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
-    
+  def card_was_declined
+  end
+  
+  # stripe web-hook callbacks.
+  def payment_succeeded(amount)
+  end
+  
+  def charge_failed
+  end
+  
+  def charge_disputed
   end
 
 end

data/app/controllers/koudoku/webhooks_controller.rb

@@ -2,14 +2,14 @@ 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)
@@ -27,7 +27,6 @@ module Koudoku
         stripe_id = data_json['data']['object']['customer']
     
         subscription = ::Subscription.find_by_stripe_id(stripe_id)
-        listing = subscription.listing
         subscription.charge_disputed
       
       end

data/app/helpers/koudoku/application_helper.rb

@@ -1,4 +1,26 @@
 module Koudoku
   module ApplicationHelper
+
+    def plan_price(plan)
+      "#{number_to_currency(plan.price)}/#{plan_interval(plan)}"
+    end
+
+    def plan_interval(plan)
+      case plan.interval
+      when "month"
+        "month"
+      when "year"
+        "year"
+      when "week"
+        "week"
+      when "6-month"
+        "half-year"
+      when "3-month"
+        "quarter"
+      else 
+        "month"
+      end
+    end
+    
   end
 end

data/app/views/koudoku/subscriptions/_pricing_table.html.erb

@@ -4,7 +4,7 @@
       <div class="thumbnail">
         <div class="caption">
           <h3><%= plan.name %></h3>
-          <h4><%= number_to_currency(plan.price) %>/month</h4>
+          <h4><%= plan_price(plan) %></h4>
           <div class="call-to-action">
             <% if @subscription.nil? %>
               <%= link_to Koudoku.free_trial? ? 'Start Trial' : 'Sign Up', koudoku.new_subscription_path(plan: plan.id), class: "btn btn-success btn-large" %>

data/lib/generators/koudoku/install_generator.rb

@@ -42,7 +42,7 @@ RUBY
       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 features:text highlight:boolean display_order:integer")
+      generate("model", "plan name:string stripe_id:string price:float interval:string features:text highlight:boolean display_order:integer")
       gsub_file "app/models/plan.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n  include Koudoku::Plan\n  belongs_to :#{subscription_owner_model}\n  belongs_to :coupon\n  has_many :subscriptions\n"
 
       # Add coupons.

data/lib/koudoku.rb

@@ -22,8 +22,8 @@ module Koudoku
   def self.setup
     yield self
     
-    # Configure the Stripe 
-    Stripe.api_key = ENV['STRIPE_SECRET_KEY']
+    # Configure the Stripe gem.
+    Stripe.api_key = stripe_secret_key
   end
   
   # e.g. :users

data/lib/koudoku/engine.rb

@@ -3,5 +3,11 @@ require 'bluecloth'
 module Koudoku
   class Engine < ::Rails::Engine
     isolate_namespace Koudoku
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
   end
 end

data/lib/koudoku/version.rb

@@ -1,3 +1,3 @@
 module Koudoku
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/concerns/koudoku/plan_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Koudoku::Plan do
+  describe '#is_upgrade_from?' do
+    before do
+      class Plan
+        attr_accessor :price
+        include Koudoku::Plan
+      end 
+    end
+    it 'returns true if the price is higher' do
+      plan = Plan.new
+      plan.price = 123.23
+      cheaper_plan = Plan.new
+      cheaper_plan.price = 61.61
+      plan.is_upgrade_from?(cheaper_plan).should be_true
+    end
+    it 'returns true if the price is the same' do
+      plan = Plan.new
+      plan.price = 123.23
+      plan.is_upgrade_from?(plan).should be_true
+    end
+    it 'returns false if the price is the same or higher' do
+      plan = Plan.new
+      plan.price = 61.61
+      more_expensive_plan = Plan.new
+      more_expensive_plan.price = 123.23
+      plan.is_upgrade_from?(more_expensive_plan).should be_false
+    end
+    it 'handles a nil value gracefully' do
+      plan = Plan.new
+      plan.price = 123.23
+      cheaper_plan = Plan.new
+      lambda {
+        plan.is_upgrade_from?(cheaper_plan).should be_true
+      }.should_not raise_error
+    end
+  end
+end

data/spec/controllers/koudoku/subscriptions_controller.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Koudoku::SubscriptionsController do
+  describe 'when customer is signed in' do
+    before do
+      @customer = Customer.create(email: 'andrew.culver@gmail.com')
+      ApplicationController.any_instance.stub(:current_customer).and_return(@customer)
+    end
+    it 'works' do
+      get :index, use_route: 'koudoku'
+    end
+  end
+  describe 'when customer is not signed in' do
+    before do
+      ApplicationController.any_instance.stub(:current_customer).and_return(nil)
+    end
+    it 'works' do
+      get :index, use_route: 'koudoku'
+    end
+  end
+end