acts_as_subscription 0.0.1

data/spec/backend/backend/chargify_client_spec.rb

@@ -0,0 +1,204 @@
+require 'spec_helper'
+require 'acts_as_subscription/backend/chargify_client'
+
+describe ActsAsSubscription::Subscription::Backend::ChargifyClient do
+  
+  def active_subscriptions
+    Chargify::Subscription.find(:all, :params => {:state => 'active'})
+  end
+  
+  before(:each) do
+    @config    = backend_config(:chargify)
+    @free_attr = free_attributes
+    @paid_attr = paid_attributes
+    # Chargify uses '1' as the success card number for testing, and '2' for failure.
+    @paid_attr[:cc_number] = 1
+    @backend   = ActsAsSubscription::Subscription::Backend::ChargifyClient.new(@config['user'], @config['password'], @config['product_code'])
+    
+    # Cancel any active subscriptions before each test - no way to actually delete via the chargify API.
+    active_subscriptions.each do |sub|
+      sub.cancel
+    end
+  end
+  
+  describe 'for all accounts' do
+  
+    it 'should return a list of plans' do
+      plans = @backend.plans
+      plans.length.should == 3
+      plans.each do |plan|
+        plan[:code].should_not be_nil
+        plan[:billing_frequency].should_not be_nil
+        plan[:name].should_not be_nil
+        plan[:description].should_not be_nil
+        plan[:recurring_charge].should_not be_nil      
+      end
+    end
+    
+  end
+  
+  describe 'for paid accounts' do
+    
+    describe 'with valid parameters' do
+     
+      it 'should create new subscriptions' do
+        @backend.create_subscription(Subscription.new(@paid_attr)).should == true 
+        active_subscriptions.size.should == 1
+      end
+    
+      it 'should update existing subscriptions' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription).should == true
+        subscription.email = 'updated@recursive-design.com'
+        @backend.update_subscription(subscription).should == true
+        customer = Chargify::Customer.find_by_reference(subscription.customer_code)
+        customer.attributes[:email].should == 'updated@recursive-design.com'
+        active_subscriptions.size.should == 1
+      end
+    
+      it 'should allow downgrading to a free plan' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription).should == true
+        subscription.plan_code = @free_attr[:plan_code]
+        @backend.update_subscription(subscription).should == true
+        sub = Chargify::Subscription.find_by_customer_reference(subscription.customer_code)
+        sub.product.attributes[:handle].should == @free_attr[:plan_code].downcase
+        active_subscriptions.size.should == 1
+      end
+   
+      it 'should cancel existing subscriptions' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription).should == true
+        customer = Chargify::Customer.find_by_reference(subscription.customer_code)
+        @backend.cancel_subscription!(subscription.customer_code).should == true
+        sub = Chargify::Subscription.find_by_customer_reference(subscription.customer_code)
+        sub.attributes[:state].should == 'canceled'
+        active_subscriptions.size.should == 0
+      end
+      
+    end
+
+    describe 'with invalid parameters' do
+    
+      it 'should not create new subscriptions' do
+        @backend.create_subscription(Subscription.new(@paid_attr.merge(:first_name => nil))).should_not == true
+        active_subscriptions.size.should == 0
+      end
+    
+      it 'should not update existing subscriptions' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription).should == true
+        subscription.email = ''
+        @backend.update_subscription(subscription).should_not == true
+        customer = Chargify::Customer.find_by_reference(subscription.customer_code)
+        customer.attributes[:email].should == @paid_attr[:email]
+        active_subscriptions.size.should == 1
+      end
+    
+      it 'should not allow downgrading to a free plan' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription).should == true
+        subscription.plan_code = @free_attr[:plan_code]
+        subscription.email = ''
+        @backend.update_subscription(subscription).should_not == true
+        sub = Chargify::Subscription.find_by_customer_reference(subscription.customer_code)
+        sub.product.attributes[:handle].should == @paid_attr[:plan_code].downcase
+        active_subscriptions.size.should == 1
+      end
+    
+      it 'should fail to cancel invalid subscriptions' do
+        @backend.cancel_subscription!('invalid-customer-code').should == false
+      end
+      
+    end
+    
+  end
+    
+  describe 'for free accounts' do
+    
+    describe 'with valid parameters' do
+    
+      it 'should create new subscriptions' do
+        @backend.create_subscription(Subscription.new(@free_attr)).should == true 
+        active_subscriptions.size.should == 1
+      end
+      
+      it 'should update existing subscriptions' do
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription).should == true
+        subscription.email = 'updated@recursive-design.com'
+        @backend.update_subscription(subscription).should == true
+        customer = Chargify::Customer.find_by_reference(subscription.customer_code)
+        customer.attributes[:email].should == 'updated@recursive-design.com'
+        active_subscriptions.size.should == 1
+      end
+        
+      it 'should allow upgrading to a paid plan' do      
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription).should == true
+        subscription.plan_code             = @paid_attr[:plan_code]
+        subscription.cc_number             = @paid_attr[:cc_number]
+        subscription.cc_expiration_month   = @paid_attr[:cc_expiration_month]
+        subscription.cc_expiration_year    = @paid_attr[:cc_expiration_year]
+        subscription.cc_verification_value = @paid_attr[:cc_verification_value]
+        subscription.zip_code              = @paid_attr[:zip_code]
+        @backend.update_subscription(subscription).should == true
+        sub = Chargify::Subscription.find_by_customer_reference(subscription.customer_code)
+        sub.product.attributes[:handle].should == @paid_attr[:plan_code].downcase
+        active_subscriptions.size.should == 1
+      end
+    
+      it 'should cancel existing subscriptions' do
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription).should == true
+        customer = Chargify::Customer.find_by_reference(subscription.customer_code)
+        @backend.cancel_subscription!(subscription.customer_code).should == true
+        sub = Chargify::Subscription.find_by_customer_reference(subscription.customer_code)
+        sub.attributes[:state].should == 'canceled'
+        active_subscriptions.size.should == 0
+      end
+  
+    end
+    
+    describe 'with invalid parameters' do
+    
+      it 'should not create new subscriptions' do
+        @backend.create_subscription(Subscription.new(@free_attr.merge(:first_name => nil))).should_not == true
+        active_subscriptions.size.should == 0
+      end
+    
+      it 'should not update existing subscriptions' do
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription).should == true
+        subscription.email = ''
+        @backend.update_subscription(subscription).should_not == true
+        customer = Chargify::Customer.find_by_reference(subscription.customer_code)
+        customer.attributes[:email].should == @free_attr[:email]
+        active_subscriptions.size.should == 1
+      end
+    
+      it 'should not allow upgrading to a paid plan' do
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription).should == true
+        subscription.plan_code = @paid_attr[:plan_code]
+        @backend.update_subscription(subscription).should_not == true
+        sub = Chargify::Subscription.find_by_customer_reference(subscription.customer_code)
+        sub.product.attributes[:handle].should == @free_attr[:plan_code].downcase
+        active_subscriptions.size.should == 1
+      end
+     
+    end
+    
+  end
+  
+end
+
+
+module Chargify
+  
+  class Customer < Base
+    def self.delete!
+      post(:destroy)
+    end
+  end
+end

data/spec/backend/backend/cheddar_getter_client_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+require 'acts_as_subscription/backend/cheddar_getter_client'
+
+describe ActsAsSubscription::Subscription::Backend::CheddarGetterClient do
+
+  before(:each) do
+    config     = backend_config(:cheddar_getter)
+    @free_attr = free_attributes
+    @paid_attr = paid_attributes
+    @backend   = ActsAsSubscription::Subscription::Backend::CheddarGetterClient.new(config['user'], config['password'], config['product_code'])
+    
+    # Remove any existing customers before each test - quite slow unfortunately.
+    Mousetrap::Customer.all.each do |customer|
+      customer.delete if customer.email.match /@recursive-design.com$/
+    end
+  end
+  
+  describe 'for all accounts' do
+  
+    it 'should initialize the mousetrap gem' do
+      Mousetrap.product_code.should == 'ACTS_AS_SUBSCRIPTION_TEST'
+    end
+  
+    it 'should return a list of plans' do
+      plans = @backend.plans
+      plans.length.should == 3
+      plans.each do |plan|
+        plan[:code].should_not be_nil
+        plan[:name].should_not be_nil
+        plan[:description].should_not be_nil
+        plan[:billing_frequency].should == 'month'
+        plan[:recurring_charge].should_not be_nil      
+      end
+    end
+    
+  end
+  
+  describe 'for paid accounts' do
+    
+    describe 'with valid parameters' do
+      
+      it 'should create new subscriptions' do
+        @backend.create_subscription(Subscription.new(@paid_attr)).should == true 
+        Mousetrap::Customer.all.size.should == 1
+      end
+    
+      it 'should update existing subscriptions' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription)
+        subscription.email = 'updated@recursive-design.com'
+        @backend.update_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].email.should == 'updated@recursive-design.com'
+        Mousetrap::Customer.all.size.should == 1
+      end
+    
+      it 'should allow downgrading to a free plan' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription)
+        subscription.plan_code = @free_attr[:plan_code]
+        @backend.update_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].subscription.plan.code.should == @free_attr[:plan_code]
+        Mousetrap::Customer.all.size.should == 1
+      end
+    
+      it 'should cancel existing subscriptions' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].subscription.canceled_at.should == nil
+        @backend.cancel_subscription!(subscription.customer_code).should == true
+        Mousetrap::Customer[subscription.customer_code].subscription.canceled_at.should_not == nil
+        Mousetrap::Customer.all.size.should == 1
+      end
+
+    end
+    
+    describe 'with invalid parameters' do
+    
+      it 'should not create new subscriptions' do
+        @backend.create_subscription(Subscription.new(@paid_attr.merge(:first_name => nil))).should_not == true
+        Mousetrap::Customer.all.size.should == 0
+      end
+    
+      it 'should not update existing subscriptions' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription)
+        subscription.email = ''
+        @backend.update_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].email.should == 'dummy@recursive-design.com'
+        Mousetrap::Customer.all.size.should == 1
+      end
+    
+      it 'should not allow downgrading to a free plan' do
+        subscription = Subscription.new(@paid_attr)
+        @backend.create_subscription(subscription)
+        subscription.plan_code = @free_attr[:plan_code]
+        subscription.email = ''
+        @backend.update_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].subscription.plan.code.should ==  @paid_attr[:plan_code]
+        Mousetrap::Customer.all.size.should == 1
+      end
+    
+      it 'should fail to cancel invalid subscriptions' do
+        @backend.cancel_subscription!('invalid-customer-code').should == false
+      end
+  
+    end
+  
+  end
+    
+  describe 'for free accounts' do
+    
+    describe 'with valid parameters' do
+    
+      it 'should create new subscriptions' do
+        @backend.create_subscription(Subscription.new(@free_attr)).should == true 
+        Mousetrap::Customer.all.size.should == 1
+      end
+    
+      it 'should update existing subscriptions' do
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription)
+        subscription.email = 'updated@recursive-design.com'
+        @backend.update_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].email.should == 'updated@recursive-design.com'
+        Mousetrap::Customer.all.size.should == 1
+      end
+    
+      it 'should allow upgrading to a paid plan' do
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription)
+        subscription.plan_code             = @paid_attr[:plan_code]
+        subscription.cc_number             = @paid_attr[:cc_number]
+        subscription.cc_expiration_month   = @paid_attr[:cc_expiration_month]
+        subscription.cc_expiration_year    = @paid_attr[:cc_expiration_year]
+        subscription.cc_verification_value = @paid_attr[:cc_verification_value]
+        subscription.zip_code              = @paid_attr[:zip_code]
+        @backend.update_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].subscription.plan.code.should ==  @paid_attr[:plan_code]
+        Mousetrap::Customer.all.size.should == 1
+      end
+    
+      it 'should cancel existing subscriptions' do
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].subscription.canceled_at.should == nil
+        @backend.cancel_subscription!(subscription.customer_code).should == true
+        Mousetrap::Customer[subscription.customer_code].subscription.canceled_at.should_not == nil
+        Mousetrap::Customer.all.size.should == 1
+      end
+  
+    end
+    
+    describe 'with invalid parameters' do
+    
+      it 'should not create new subscriptions' do
+        @backend.create_subscription(Subscription.new(@free_attr.merge(:first_name => nil))).should_not == true
+        Mousetrap::Customer.all.size.should == 0
+      end
+    
+      it 'should not update existing subscriptions' do
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription)
+        subscription.email = ''
+        @backend.update_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].email.should == 'dummy@recursive-design.com'
+        Mousetrap::Customer.all.size.should == 1
+      end
+    
+      it 'should not allow upgrading to a paid plan without credit card info' do
+        subscription = Subscription.new(@free_attr)
+        @backend.create_subscription(subscription)
+        subscription.plan_code = @paid_attr[:plan_code]
+        @backend.update_subscription(subscription)
+        Mousetrap::Customer[subscription.customer_code].subscription.plan.code.should == @free_attr[:plan_code]
+        Mousetrap::Customer.all.size.should == 1
+      end
+      
+    end
+  
+  end
+  
+end
+
+
+module Mousetrap
+  class Customer
+    def delete
+      member_action 'delete' unless new_record?
+    end
+  end
+end

data/spec/backend/backend_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe ActsAsSubscription::Subscription::Backend do
+
+  before(:each) do
+    @attr = {
+      :backend      => :dummy,
+      :product_code => 'DUMMY_TEST',
+      :user         => 'user',
+      :password     => 'pass'
+    }
+    
+    @backend          = ActsAsSubscription::Subscription::Backend
+    @backend.instance = nil
+    @subscription     = Subscription.new(paid_attributes)
+  end
+  
+  describe 'validation' do
+    
+    it 'should require a :backend' do
+      lambda {
+        @backend.initialize(@attr.merge(:backend => nil))
+      }.should raise_error(ActsAsSubscription::Subscription::Error::ArgumentError)
+    end
+    
+    it 'should make sure :backend exists' do
+      lambda {
+        @backend.initialize(@attr.merge(:backend => :non_existent))
+      }.should raise_error(ActsAsSubscription::Subscription::Error::BackendError)
+    end
+    
+    it 'should accept a valid :backend' do
+      lambda {
+        @backend.initialize(@attr.merge(:backend => :dummy))
+      }.should_not raise_error(ActsAsSubscription::Subscription::Error::ArgumentError)
+    end
+    
+    it 'should require a :product_code' do
+      lambda {
+        @backend.initialize(@attr.merge(:product_code => nil))
+      }.should raise_error(ActsAsSubscription::Subscription::Error::ArgumentError)
+    end
+    
+    it 'should require a :user' do
+      lambda {
+        @backend.initialize(@attr.merge(:user => nil))
+      }.should raise_error(ActsAsSubscription::Subscription::Error::ArgumentError)
+    end
+    
+    it 'should require a :password' do
+      lambda {
+        @backend.initialize(@attr.merge(:password => nil))
+      }.should raise_error(ActsAsSubscription::Subscription::Error::ArgumentError)
+    end
+    
+    it 'should instantiate a backend given valid params' do
+      @backend.initialize(@attr)
+      @backend.instance.should_not == nil
+    end
+    
+  end
+  
+  describe 'operations' do
+    
+    it 'should respond to create_subscription' do
+      @backend.initialize(@attr)
+      @backend.create_subscription(@subscription).should == true
+    end
+    
+    it 'should respond to update_subscription' do
+      @backend.initialize(@attr)
+      @backend.update_subscription(@subscription).should == true
+    end
+    
+    it 'should respond to cancel_subscription!' do
+      @backend.initialize(@attr)
+      @backend.cancel_subscription!(@subscription).should == true
+    end
+    
+  end
+
+end

data/spec/models/subscription_plan_spec.rb

@@ -0,0 +1,118 @@
+require 'spec/spec_helper'
+
+describe SubscriptionPlan do
+
+  before(:each) do
+    ActsAsSubscription::Subscription::Backend.config = {
+      :backend      => :dummy,
+      :user         => 'my_user',
+      :password     => 'my_pass',
+      :product_code => 'my_product'
+    }
+      
+    @attr = {
+      :code              => 'FREE',
+      :name              => 'free test plan',
+      :description       => 'a bargain',
+      :billing_frequency => 'monthly',
+      :recurring_charge  => 0.0
+    }
+
+    SubscriptionPlan.find(:all).each do |plan|
+      plan.destroy
+    end
+  end
+  
+  describe 'validation' do
+  
+    it 'should accept valid attributes' do
+      plan = SubscriptionPlan.new(@attr)
+      plan.should be_valid
+      lambda do
+        plan.save
+      end.should change(SubscriptionPlan, :count).by(1)
+    end
+  
+    it 'should require a plan_code' do
+      plan = SubscriptionPlan.new(@attr.merge(:code => ''))
+      plan.should_not be_valid
+    end
+  
+    it 'should ensure that plan_code is unique' do
+      plan = SubscriptionPlan.new(@attr.merge(:code => 'unique'))
+      plan.should be_valid
+      plan.save
+      plan = SubscriptionPlan.new(@attr.merge(:code => 'unique'))
+      plan.should_not be_valid
+    end
+  
+    it 'should require a name' do
+      plan = SubscriptionPlan.new(@attr.merge(:name => ''))
+      plan.should_not be_valid
+    end
+  
+    it 'should require a billing_frequency' do
+      plan = SubscriptionPlan.new(@attr.merge(:billing_frequency => ''))
+      plan.should_not be_valid
+    end
+  
+    it 'should require a numeric recurring_charge' do
+      plan = SubscriptionPlan.new(@attr.merge(:recurring_charge => 'zero'))
+      plan.should_not be_valid
+    end
+  
+    it 'should require a positive recurring_charge' do
+      plan = SubscriptionPlan.new(@attr.merge(:recurring_charge => -1))
+      plan.should_not be_valid
+    end
+  
+    it 'should accept a recurring_charge of up to two decimal places' do
+      plan = SubscriptionPlan.new(@attr.merge(:name => 'test 1', :recurring_charge => 0))
+      plan.should be_valid
+      plan = SubscriptionPlan.new(@attr.merge(:name => 'test 2', :recurring_charge => 0.1))
+      plan.should be_valid
+      plan = SubscriptionPlan.new(@attr.merge(:name => 'test 3', :recurring_charge => 0.01))
+      plan.should be_valid
+      plan = SubscriptionPlan.new(@attr.merge(:name => 'test 4', :recurring_charge => 0.001))
+      plan.should_not be_valid
+    end
+
+  end  
+  
+  describe 'syncing' do
+  
+    it 'should populate the database with plan records' do
+      SubscriptionPlan.sync!
+      SubscriptionPlan.find(:all).length.should == 3
+    end
+  
+    it 'should update existing records if possible' do
+      plan = SubscriptionPlan.new(@attr)
+      plan.name.should == @attr[:name]
+      plan.save
+      SubscriptionPlan.sync!
+      SubscriptionPlan.find(:all).length.should == 3
+      SubscriptionPlan.find(plan.id).name.should_not == plan.name
+    end
+
+  end  
+  
+  describe 'form options' do
+  
+    it 'should populate the form_options array' do
+      SubscriptionPlan.sync!
+      plans   = SubscriptionPlan.find_all_by_active(true)
+      options = SubscriptionPlan.form_options
+      options.length.should == 3
+      plans.each do |plan|
+        if plan.recurring_charge > 0
+          options.include?(["#{plan.name} ($#{plan.recurring_charge})", plan.code]).should == true
+        else
+          options.include?([plan.name, plan.code]).should == true
+        end
+      end
+    end
+    
+  end
+  
+end