freemium-ajb 0.0.4

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,15 @@
+free:
+  id: 1
+  key: free
+  name: Free Access
+  rate_cents: 0
+basic:
+  id: 2
+  key: basic
+  name: Basic
+  rate_cents: 1295
+premium:
+  id: 3
+  key: premium
+  name: Premium
+  rate_cents: 2495

data/spec/fixtures/subscriptions.yml

@@ -0,0 +1,28 @@
+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
+  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/lib/tasks/run_billing_rake_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "freemium:run_billing" do
+  include_context "rake"
+
+  before do
+  end
+
+  # its(:prerequisites) { should include("environment") }
+
+  it "generates a registrations report" do
+    subject.invoke
+  end
+end

data/spec/models/coupon_redemption_spec.rb

@@ -0,0 +1,287 @@
+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
+
+  it "should automatically upgrade the plan, as long as discount percentage is 100%" do
+    hundred_coupon = Coupon.create(:description => "100% off", :discount_percentage => 100, :redemption_key => "100OFF")
+    hundred_coupon.subscription_plans << subscription_plans(:premium)
+
+    @subscription.coupon = hundred_coupon
+
+    @subscription.subscription_plan.should eql(subscription_plans(:premium))
+    @subscription.save.should be_true
+    @subscription.rate.cents.should eql(0)
+  end
+
+  it "should not automatically downgrade the plan, no matter what" do
+    @subscription.subscription_plan = subscription_plans(:premium)
+
+    hundred_coupon = Coupon.create(:description => "100% off", :discount_percentage => 100, :redemption_key => "100OFF")
+    hundred_coupon.subscription_plans << subscription_plans(:basic)
+
+    @subscription.coupon = hundred_coupon
+
+    @subscription.subscription_plan.should eql(subscription_plans(:premium))
+    @subscription.save.should be_false
+    @subscription.should have(1).errors_on(:coupon_redemptions)
+  end
+
+  it 'should remove the coupon when upgrading the subscription plan' do
+    @subscription.subscription_plan = subscription_plans(:free)
+
+    hundred_coupon = Coupon.create(:description => "100% off", :discount_percentage => 100, :redemption_key => "100OFF")
+    hundred_coupon.subscription_plans << subscription_plans(:basic)
+
+    @subscription.coupon = hundred_coupon
+
+    @subscription.subscription_plan.should eql(subscription_plans(:basic))
+    @subscription.save.should be_true
+    @subscription.rate.cents.should eql(0)
+
+    cc = CreditCard.sample
+    cc.save
+
+    @subscription.update_attributes(
+      subscription_plan_id: subscription_plans(:premium).id,
+      credit_card: cc
+    )
+
+    @subscription.reload
+
+    @subscription.credit_card.should eql(cc)
+    @subscription.rate.cents.should_not eql(0)
+    @subscription.paid_through.should_not eql(nil)
+    @subscription.coupon.should eql(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,124 @@
+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.create(CreditCard.sample_params.merge(:subscription => @subscription))
+    Freemium.configuration.gateway = Freemium::Gateways::Test.new
+    Freemium.configuration.gateway.username = 'demo'
+    Freemium.configuration.gateway.password = 'password'
+
+    Freemium.configuration.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.configuration.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
+
+  it "should automatically determine card type" do
+    c = CreditCard.create(number: '4111111111111111', month: '2', year: '2013')
+    c.valid?
+    c.card_type.should eql(:visa)
+  end
+
+  it 'should not choke when there is no expiration date provided' do
+    c = CreditCard.new(number: '4111111111111111')
+    c.valid?.should eql(false)
+  end
+end