freemium 0.0.1

data/spec/dummy/config/routes.rb

@@ -0,0 +1,58 @@
+Dummy::Application.routes.draw do
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => "welcome#index"
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id(.:format)))'
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/db/schema.rb

@@ -0,0 +1,92 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+    t.column :email, :string
+  end
+
+  create_table :subscription_plans, :force => true do |t|
+    t.column :name, :string, :null => false
+    t.column :redemption_key, :string, :null => false
+    t.column :rate_cents, :integer, :null => false
+    t.column :feature_set_id, :string, :null => false
+  end
+
+  create_table :subscriptions, :force => true do |t|
+    t.column :subscribable_id, :integer, :null => false
+    t.column :subscribable_type, :string, :null => false
+    t.column :billing_key, :string, :null => true
+    t.column :credit_card_id, :integer, :null => true
+    t.column :subscription_plan_id, :integer, :null => false
+    t.column :paid_through, :date, :null => true
+    t.column :expire_on, :date, :null => true
+    t.column :billing_key, :string, :null => true
+    t.column :started_on, :date, :null => true
+    t.column :last_transaction_at, :datetime, :null => true
+    t.column :last_transaction_success, :boolean, :null => true
+    t.column :in_trial, :boolean, :null => false, :default => false
+  end
+
+  create_table :manual_subscriptions, :force => true do |t|
+    t.column :subscribable_id, :integer, :null => false
+    t.column :subscribable_type, :string, :null => false
+    t.column :billing_key, :string, :null => true
+    t.column :credit_card_id, :integer, :null => true
+    t.column :subscription_plan_id, :integer, :null => false
+    t.column :paid_through, :date, :null => true
+    t.column :expire_on, :date, :null => true
+    t.column :billing_key, :string, :null => true
+    t.column :started_on, :date, :null => true
+    t.column :last_transaction_at, :datetime, :null => true
+    t.column :last_transaction_success, :boolean, :null => true
+    t.column :in_trial, :boolean, :null => false, :default => false
+  end
+
+  create_table :credit_cards, :force => true do |t|
+    t.column :display_number, :string, :null => false
+    t.column :card_type, :string, :null => false
+    t.column :expiration_date, :timestamp, :null => false
+    t.column :zip_code, :string, :null => true
+  end
+
+  create_table :coupons, :force => true do |t|
+    t.column :description, :string, :null => false
+    t.column :discount_percentage, :integer, :null => false
+    t.column :redemption_key, :string, :null => true
+    t.column :redemption_limit, :integer, :null => true
+    t.column :redemption_expiration, :date, :null => true
+    t.column :duration_in_months, :integer, :null => true
+  end
+
+  create_table :coupons_subscription_plans, :id => false, :force => true do |t|
+    t.column :coupon_id, :integer, :null => false
+    t.column :subscription_plan_id, :integer, :null => false
+  end
+
+  create_table :coupon_redemptions, :force => true do |t|
+    t.column :subscription_id, :integer, :null => false
+    t.column :coupon_id, :integer, :null => false
+    t.column :redeemed_on, :date, :null => false
+    t.column :expired_on, :date, :null => true
+  end
+
+  create_table :account_transactions, :force => true do |t|
+    t.column :subscription_id, :integer, :null => false
+    t.column :success, :boolean, :null => false
+    t.column :billing_key, :string, :null => false
+    t.column :amount_cents, :integer, :null => false
+    t.column :message, :string, :null => true
+    t.column :created_at, :timestamp, :null => false
+  end
+
+  create_table :subscription_changes, :force => true do |t|
+    t.column :subscribable_id, :integer, :null => false
+    t.column :subscribable_type, :string, :null => false
+    t.column :original_subscription_plan_id, :integer, :null => true
+    t.column :new_subscription_plan_id, :integer, :null => true
+    t.column :original_rate_cents, :integer, :null => true
+    t.column :new_rate_cents, :integer, :null => true
+    t.column :reason, :string, :null => false
+    t.column :created_at, :timestamp, :null => false
+  end
+
+end

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/fixtures/credit_cards.yml

@@ -0,0 +1,11 @@
+bobs_credit_card:
+  id: 1
+  expiration_date: <%= (Time.now + 3.years).to_s :db %>
+  display_number: xxxx-xxxx-xxxx-2222
+  card_type: master
+steves_credit_card:
+  id: 2
+  expiration_date: <%= (Time.now + 3.years).to_s :db %>
+  display_number: xxxx-xxxx-xxxx-1111
+  card_type: visa
+

data/spec/fixtures/subscription_plans.yml

@@ -0,0 +1,18 @@
+free:
+  id: 1
+  redemption_key: free
+  feature_set_id: free
+  name: Free Access
+  rate_cents: 0
+basic:
+  id: 2
+  redemption_key: basic
+  feature_set_id: basic
+  name: Basic
+  rate_cents: 1295
+premium:
+  id: 3
+  redemption_key: premium
+  feature_set_id: premium
+  name: Premium
+  rate_cents: 2495

data/spec/fixtures/subscriptions.yml

@@ -0,0 +1,29 @@
+bobs_subscription:
+  id: 1
+  subscribable_id: 1
+  subscribable_type: User
+  subscription_plan_id: 2
+  credit_card_id: 1
+  paid_through: <%= (Date.today + 20).to_s :db %>
+  billing_key: tc00001
+  started_on: <%= (Date.today - 60).to_s :db %>
+  last_transaction_at: 2007-09-15 12:34:56
+sues_subscription:
+  id: 2
+  subscribable_id: 2
+  subscribable_type: User
+  subscription_plan_id: 1
+  billing_key: 
+  paid_through: 
+  last_transaction_at:
+  started_on: <%= (Date.today - 60).to_s :db %>
+steves_subscription:
+  id: 3
+  subscribable_id: 4
+  subscribable_type: User
+  subscription_plan_id: 3
+  credit_card_id: 1
+  paid_through: <%= (Date.today + 20).to_s :db %>
+  billing_key: tc00002
+  started_on: <%= (Date.today - 60).to_s :db %>
+  last_transaction_at: 2007-09-15 12:34:56    

data/spec/fixtures/users.yml

@@ -0,0 +1,16 @@
+bob:
+  id: 1
+  name: Bob
+  email: bob@example.com
+sue:
+  id: 2
+  name: Sue
+  email: sue@example.com
+sally:
+  id: 3
+  name: Sally
+  email: sally@example.com
+steve:
+  id: 4
+  name: Steve
+  email: steve@example.com

data/spec/freemium_feature_sets.yml

@@ -0,0 +1,9 @@
+- id: free
+  ads: true
+  unlimited: false
+- id: plus
+  ads: false
+  unlimited: false
+- id: premium
+  ads: false
+  unlimited: true

data/spec/freemium_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe "Freemium" do
+end

data/spec/models/coupon_redemption_spec.rb

@@ -0,0 +1,235 @@
+require 'spec_helper'
+
+describe CouponRedemption do
+  fixtures :users, :subscriptions, :subscription_plans, :credit_cards
+
+  before(:each) do
+    @subscription = subscriptions(:bobs_subscription)
+    @original_price = @subscription.rate
+    @coupon = Coupon.create(:description => "30% off", :discount_percentage => 30, :redemption_key => "30OFF")
+  end
+
+  it "should be applied" do
+    @subscription.paid_through = Date.today + 30
+    @original_remaining_value = @subscription.remaining_value
+    @original_daily_rate = @subscription.daily_rate
+    @subscription.coupon_key = nil
+
+    @subscription.coupon_redemptions.create(:coupon => @coupon).should be_true
+    @subscription.rate.cents.should eql(@coupon.discount(@original_price).cents)
+    @subscription.daily_rate.cents.should eql(@coupon.discount(@original_daily_rate).cents)
+    @subscription.remaining_value.cents.should eql((@coupon.discount(@original_daily_rate) * @subscription.remaining_days).cents)
+  end
+
+  it "should be applied using coupon accessor" do
+    @subscription = build_subscription(:coupon => @coupon, :credit_card => CreditCard.sample)
+    @subscription.save!
+
+    @subscription.coupon.should_not be_nil
+    @subscription.coupon_redemptions.first.coupon.should_not be_nil
+    @subscription.coupon_redemptions.first.subscription.should_not be_nil
+    @subscription.coupon_redemptions.empty?.should be_false
+    @subscription.rate.cents.should eql(@coupon.discount(@subscription.subscription_plan.rate).cents)
+  end
+
+  it "should be applied using coupon key accessor" do
+    @subscription = build_subscription(:coupon_key => @coupon.redemption_key, :credit_card => CreditCard.sample)
+    @subscription.save!
+
+    @subscription.coupon.should_not be_nil
+    @subscription.coupon_redemptions.first.coupon.should_not be_nil
+    @subscription.coupon_redemptions.first.subscription.should_not be_nil
+    @subscription.coupon_redemptions.empty?.should be_false
+    @subscription.rate.cents.should eql(@coupon.discount(@subscription.subscription_plan.rate).cents)
+  end
+
+  it "should be applied multiple" do
+    @coupon_1 = Coupon.new(:description => "10% off", :discount_percentage => 10)
+    @subscription.coupon_redemptions.create(:coupon => @coupon_1).should be_true
+
+    @coupon_2 = Coupon.new(:description => "30% off", :discount_percentage => 30)
+    @subscription.coupon_redemptions.create(:coupon => @coupon_2).should be_true
+
+    @coupon_3 = Coupon.new(:description => "20% off", :discount_percentage => 20)
+    @subscription.coupon_redemptions.create(:coupon => @coupon_3).should be_true
+
+    # Should use the highest discounted coupon
+    @subscription.rate.cents.should eql(@coupon_2.discount(@original_price).cents)
+  end
+
+  it "should be destroyed" do
+    @subscription.coupon_redemptions.create(:coupon => @coupon).should be_true
+    @subscription.rate.cents.should eql(@coupon.discount(@original_price).cents)
+
+    @coupon.destroy
+    @subscription.reload
+
+    @subscription.coupon_redemptions.empty?.should be_true
+    @subscription.rate.cents.should eql(@original_price.cents)
+  end
+
+  it "should test coupon duration" do
+    @subscription.coupon_redemptions.create(:coupon => @coupon).should be_true
+    @subscription.rate.cents.should eql(@coupon.discount(@original_price).cents)
+
+    @coupon.duration_in_months = 3
+    @coupon.save!
+
+    @subscription.rate({:date => (Date.today + 3.months - 1)}).cents.should eql(@coupon.discount(@original_price).cents)
+    @subscription.rate({:date => (Date.today + 3.months + 1)}).cents.should eql(@original_price.cents)
+
+    safe_date = Date.today + 3.months - 1
+    Date.stub!(:today => safe_date)
+    @subscription.rate.cents.should eql(@coupon.discount(@original_price).cents)
+
+    safe_date = Date.today + 1
+    Date.stub!(:today => safe_date)
+    @subscription.rate.cents.should eql(@coupon.discount(@original_price).cents)
+
+    safe_date = Date.today + 1
+    Date.stub!(:today => safe_date)
+    @subscription.rate.cents.should eql(@original_price.cents)
+  end
+
+  it "should be applied complimentary" do
+    @coupon.discount_percentage = 100
+
+    @subscription = build_subscription(:coupon => @coupon, :credit_card => CreditCard.sample, :subscription_plan => subscription_plans(:premium))
+
+    @subscription.save.should be_true
+    @subscription.coupon.should_not be_nil
+    @subscription.rate.cents.should eql(0)
+    @subscription.paid?.should be_false
+  end
+
+  ##
+  ## Plan-specific coupons
+  ##
+
+  it "should be applied only on new premium plan" do
+    set_coupon_to_premium_only
+
+    @subscription = build_subscription(:coupon => @coupon, :credit_card => CreditCard.sample,
+                                       :subscription_plan => subscription_plans(:premium))
+
+    @subscription.save.should be_true
+    @subscription.coupon.should_not be_nil
+
+    @subscription = build_subscription(:coupon => @coupon, :credit_card => CreditCard.sample,
+                                       :subscription_plan => subscription_plans(:basic))
+
+    @subscription.save.should be_false
+    @subscription.should have(1).errors_on(:coupon_redemptions)
+  end
+
+  it "should be applied only on existent premium plan" do
+    set_coupon_to_premium_only
+
+    @subscription.coupon = @coupon
+
+    @subscription.subscription_plan.should eql(subscription_plans(:basic))
+    @subscription.save.should be_false
+    @subscription.should have(1).errors_on(:coupon_redemptions)
+
+    @subscription.subscription_plan = subscription_plans(:premium)
+
+    @subscription.subscription_plan.should eql(subscription_plans(:premium))
+    @subscription.save.should be_true
+    @subscription.coupon.should_not be_nil
+  end
+
+  ##
+  ## applying coupons
+  ##
+
+  it "should be applied to subscription" do
+    @subscription.coupon = @coupon
+    @subscription.should be_valid
+    @subscription.coupon.should_not be_nil
+  end
+
+  it "should validate coupon key" do
+    @subscription.coupon_key = @coupon.redemption_key + "xxxxx"
+
+    @subscription.should_not be_valid
+    @subscription.coupon.should be_nil
+    @subscription.should have(1).errors_on(:coupon)
+  end
+
+  it "should validate coupon by coupon plan" do
+    set_coupon_to_premium_only
+
+    @subscription.subscription_plan.should_not eql(subscription_plans(:premium))
+
+    @subscription.coupon = @coupon
+    @subscription.should_not be_valid
+    @subscription.should have(1).errors_on(:coupon_redemptions)
+  end
+
+  protected
+
+  def set_coupon_to_premium_only
+    @coupon.subscription_plans << subscription_plans(:premium)
+    @coupon.save!
+  end
+
+
+  public
+
+  ##
+  ## Validation Tests
+  ##
+
+  it "should validate coupon" do
+    s = CouponRedemption.new(:subscription => subscriptions(:bobs_subscription))
+    s.save.should be_false
+    s.should have(1).errors_on(:coupon)
+  end
+
+  it "should not be applied to unpaid subscription" do
+    subscriptions(:sues_subscription).paid?.should be_false
+    s = CouponRedemption.new(:subscription => subscriptions(:sues_subscription), :coupon => @coupon)
+    s.save.should be_false
+    s.should have(1).errors_on(:subscription)
+  end
+
+  it "should not be applied twice" do
+    s = CouponRedemption.new(:subscription => subscriptions(:bobs_subscription), :coupon => @coupon)
+    s.save.should be_true
+
+    s = CouponRedemption.new(:subscription => subscriptions(:bobs_subscription), :coupon => @coupon)
+    s.save.should be_false
+    s.should have(1).errors_on(:coupon_id)
+  end
+
+  it "should not be applied with redemption expired coupon" do
+    @coupon.redemption_expiration = Date.today-1
+    @coupon.save!
+
+    s = CouponRedemption.new(:subscription => subscriptions(:bobs_subscription), :coupon => @coupon)
+    s.save.should be_false
+    s.should have(1).errors_on(:coupon)
+  end
+
+  it "should not be applied with too many redemptions" do
+    @coupon.redemption_limit = 1
+    @coupon.save!
+
+    s = CouponRedemption.new(:subscription => subscriptions(:bobs_subscription), :coupon => @coupon)
+    s.save!
+
+    s = CouponRedemption.new(:subscription => subscriptions(:steves_subscription), :coupon => @coupon)
+    s.save.should be_false
+    s.should have(1).errors_on(:coupon)
+  end
+
+  protected
+
+  def build_subscription(options = {})
+    Subscription.new({
+      :subscription_plan => subscription_plans(:basic),
+      :subscribable => users(:sue)
+    }.merge(options))
+  end
+
+end

data/spec/models/credit_card_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe CreditCard do
+  fixtures :users, :subscriptions, :subscription_plans, :credit_cards
+
+  before(:each) do
+    @subscription = Subscription.new(:subscription_plan => subscription_plans(:premium), :subscribable => users(:sally))
+    @credit_card = CreditCard.new(CreditCard.sample_params.merge(:subscription => @subscription))
+    Freemium.gateway = Freemium::Gateways::BrainTree.new
+    Freemium.gateway.username = 'demo'
+    Freemium.gateway.password = 'password'
+
+    Freemium.gateway.stub!(:validate => Freemium::Response.new(true))
+  end
+
+  it "should create" do
+    @subscription.credit_card = @credit_card
+
+    @subscription.save.should be_true
+    @subscription = Subscription.find(@subscription.id)
+    @subscription.billing_key.should_not be_nil
+    @subscription.credit_card.display_number.should_not be_nil
+    @subscription.credit_card.card_type.should_not be_nil
+    @subscription.credit_card.expiration_date.should_not be_nil
+  end
+
+  it "should be created with billing validation failure" do
+    response = Freemium::Response.new(false, 'responsetext' => 'FAILED')
+    response.message = 'FAILED'
+    Freemium.gateway.stub!(:validate => response)
+
+    @subscription.credit_card = @credit_card
+
+    @subscription.save.should be_false
+    @subscription.should have(1).errors_on(:base)
+  end
+
+  it "should be updated" do
+    @subscription.credit_card = @credit_card
+
+    @subscription.save.should be_true
+    @subscription = Subscription.find(@subscription.id)
+    @subscription.billing_key.should_not be_nil
+
+    original_key = @subscription.billing_key
+    original_expiration = @subscription.credit_card.expiration_date
+
+    @subscription.credit_card = CreditCard.new(CreditCard.sample_params.merge(:zip_code => 95060, :number => "5431111111111111", :card_type => "master", :year => 2020))
+    @subscription.save.should be_true
+    @subscription = Subscription.find(@subscription.id)
+    @subscription.billing_key.should eql(original_key)
+    original_expiration.should < @subscription.credit_card.expiration_date
+    @subscription.credit_card.reload.zip_code.should eql("95060")
+  end
+
+  ##
+  ## Test Validations
+  ##
+
+  it "should validate card number" do
+    @credit_card.number = "foo"
+    @credit_card.should_not be_valid
+    @credit_card.save.should be_false
+  end
+
+  it "should validate expiration date of card" do
+    @credit_card.year = 2001
+    @credit_card.should_not be_valid
+    @credit_card.save.should be_false
+  end
+
+  it "should be changed" do
+    # We're overriding AR#changed? to include instance vars that aren't persisted to see if a new card is being set
+    @credit_card.changed?.should be_true #New card is changed
+  end
+
+  it "should be changed after reload" do
+    @credit_card.save!
+    @credit_card = CreditCard.find(@credit_card.id)
+    @credit_card.reload.changed?.should be_false #Saved card is NOT changed
+  end
+
+  it "should not be chanegd for existent card" do
+    credit_cards(:bobs_credit_card).changed?.should be_false
+  end
+
+  it "should be chnaged after update" do
+    credit_cards(:bobs_credit_card).number = "foo"
+    credit_cards(:bobs_credit_card).changed?.should be_true
+  end
+
+  it "should be valid" do
+    @credit_card.should be_valid #New card is valid
+  end
+
+  it "should be valid and unchanged for existent cards" do
+    # existing cards on file are valid ...
+    credit_cards(:bobs_credit_card).changed?.should be_false #Existing card has not changed
+    credit_cards(:bobs_credit_card).should be_valid #Existing card is valid
+  end
+
+  it "should validate number of existent card" do
+    # ... unless theres an attempt to update them
+    credit_cards(:bobs_credit_card).number = "foo"
+    credit_cards(:bobs_credit_card).should_not be_valid #Partially changed existing card is not valid
+  end
+
+  it "should validate card type of existent card" do
+    # ... unless theres an attempt to update them
+    credit_cards(:bobs_credit_card).card_type = "visa"
+    credit_cards(:bobs_credit_card).should_not be_valid  #Partially changed existing card is not valid
+  end
+
+end