acts_as_subscription 0.0.1

data/spec/models/subscription_spec.rb

@@ -0,0 +1,207 @@
+require 'spec/spec_helper'
+
+describe Subscription do
+
+  before(:each) do
+    @free_attr = free_attributes
+    @paid_attr = paid_attributes
+  end
+  
+  describe 'initialization' do
+    
+    it 'should initialize the backend' do
+      subscription = model_factory
+      ActsAsSubscription::Subscription::Backend.config.should_not == nil
+      ActsAsSubscription::Subscription::Backend.instance.class.should == ActsAsSubscription::Subscription::Backend::DummyClient
+    end
+      
+    it 'should create the customer code automatically' do
+      subscription = Subscription.new(@free_attr)
+      subscription.customer_code.should_not == nil
+    end
+    
+    it 'should create a CreditCard instance' do
+      subscription = Subscription.new(@free_attr)
+      subscription.credit_card.class.should == ActiveMerchant::Billing::CreditCard
+    end
+    
+  end
+  
+  describe 'validation' do
+  
+    describe 'for all plans' do
+  
+      it 'should require an email' do
+        subscription = Subscription.new(@free_attr.merge(:email => ''))
+        subscription.should_not be_valid
+      end
+
+      it 'should require a first_name' do
+        subscription = Subscription.new(@free_attr.merge(:first_name => ''))
+        subscription.should_not be_valid
+      end
+
+      it 'should require a last_name' do
+        subscription = Subscription.new(@free_attr.merge(:last_name => ''))
+        subscription.should_not be_valid
+      end
+
+      it 'should require a customer_code' do
+        subscription = Subscription.new(@free_attr.merge(:customer_code => ''))
+        subscription.should_not be_valid
+      end
+
+      it 'is_free_plan? should return false if the :plan_code is missing' do
+        subscription = Subscription.new(@free_attr.merge(:plan_code => nil))
+        subscription.is_free_plan?.should == false
+        subscription = Subscription.new(@free_attr.merge(:plan_code => ''))
+        subscription.is_free_plan?.should == false
+        subscription = Subscription.new(@free_attr.merge(:plan_code => ' '))
+        subscription.is_free_plan?.should == false
+      end
+
+      it 'is_free_plan? should return true if the :plan_code contains the string "free"' do
+        subscription = Subscription.new(@free_attr.merge(:plan_code => 'free_plan'))
+        subscription.is_free_plan?.should == true
+        subscription = Subscription.new(@free_attr.merge(:plan_code => 'plan_free_plan'))
+        subscription.is_free_plan?.should == true
+        subscription = Subscription.new(@free_attr.merge(:plan_code => 'free'))
+        subscription.is_free_plan?.should == true
+        subscription = Subscription.new(@free_attr.merge(:plan_code => 'FREE'))
+        subscription.is_free_plan?.should == true
+        subscription = Subscription.new(@free_attr.merge(:plan_code => 'MY_PLAN (frEe)'))
+        subscription.is_free_plan?.should == true
+      end
+    
+    end
+  
+    describe 'for free plans' do
+  
+      describe 'with valid parameters' do
+    
+        it 'should validate' do
+          subscription = Subscription.new(@free_attr)
+          subscription.should be_valid
+        end
+
+        it 'should create a new record on save' do
+          lambda do
+            Subscription.create(@free_attr)
+          end.should change(Subscription, :count).by(1)
+        end
+
+        it 'should identify as a free plan' do
+          subscription = Subscription.new(@free_attr)
+          subscription.is_free_plan?.should == true
+        end
+    
+      end
+  
+      describe 'with invalid parameters' do
+    
+        it 'should be invalid' do
+          subscription = Subscription.new(@free_attr.merge(:first_name => ''))
+          subscription.should_not be_valid
+        end
+
+        it 'should not create a new record on save' do
+          lambda do
+            Subscription.create(@free_attr.merge(:first_name => ''))
+          end.should_not change(Subscription, :count)
+        end
+      
+      end
+    
+    end
+  
+    describe 'for paid plans' do
+  
+      it 'should require a zip_code' do
+        subscription = Subscription.new(@paid_attr.merge(:zip_code => ''))
+        subscription.should_not be_valid
+      end
+  
+      it 'should require a cc_expiration_month' do
+        subscription = Subscription.new(@paid_attr.merge(:cc_expiration_month => ''))
+        subscription.should_not be_valid
+      end
+  
+      it 'should require a cc_expiration_year' do
+        subscription = Subscription.new(@paid_attr.merge(:cc_expiration_year => ''))
+        subscription.should_not be_valid
+      end
+  
+      it 'should require a cc_verification_value' do
+        subscription = Subscription.new(@paid_attr.merge(:cc_verification_value => ''))
+        subscription.should_not be_valid
+      end
+  
+      it 'should require a cc_number' do
+        subscription = Subscription.new(@paid_attr.merge(:cc_number => ''))
+        subscription.should_not be_valid
+      end
+  
+      describe 'with valid parameters' do
+    
+        it 'should validate' do
+          subscription = Subscription.new(@paid_attr)
+          subscription.should be_valid
+        end
+
+        it 'should create a new record on save' do
+          lambda do
+            Subscription.create(@paid_attr)
+          end.should change(Subscription, :count).by(1)
+        end
+
+        it 'should set cc_last_digits on validation' do
+          subscription = Subscription.new(@paid_attr)
+          subscription.valid?
+          subscription.cc_last_digits.should == @paid_attr[:cc_number].reverse[0, 4].reverse
+        end
+
+        it 'should identify as a paid plan' do
+          subscription = Subscription.new(@paid_attr)
+          subscription.is_free_plan?.should == false
+        end
+
+        it 'should update the internal CreditCard instance on validate' do
+          subscription = Subscription.new(@paid_attr)
+          subscription.credit_card.first_name.should          == nil
+          subscription.credit_card.first_name.should          == nil
+          subscription.credit_card.last_name.should           == nil
+          subscription.credit_card.month.should               == nil
+          subscription.credit_card.year.should                == nil
+          subscription.credit_card.verification_value.should  == nil
+          subscription.credit_card.number.should              == nil
+          subscription.valid?
+          subscription.credit_card.first_name.should          == @paid_attr[:first_name]
+          subscription.credit_card.last_name.should           == @paid_attr[:last_name]
+          subscription.credit_card.month.should               == @paid_attr[:cc_expiration_month]
+          subscription.credit_card.year.should                == @paid_attr[:cc_expiration_year]
+          subscription.credit_card.verification_value.should  == @paid_attr[:cc_verification_value]
+          subscription.credit_card.number.should              == @paid_attr[:cc_number]
+        end
+    
+      end
+  
+      describe 'with invalid parameters' do
+    
+        it 'should be invalid' do
+          subscription = Subscription.new(@paid_attr.merge(:first_name => ''))
+          subscription.should_not be_valid
+        end
+
+        it 'should not create a new record on save' do
+          lambda do
+            Subscription.create(@paid_attr.merge(:first_name => ''))
+          end.should_not change(Subscription, :count)
+        end
+    
+      end
+    
+    end
+  
+  end # validation
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,110 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+
+begin
+  require 'active_record'
+  require 'bundler'
+  require 'rubygems'
+
+  if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new('0.9.5')
+    raise RuntimeError, "Your bundler version is too old." +
+     "Run `gem install bundler` to upgrade."
+  end
+
+  # Set up load paths for all bundled gems
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end
+
+Bundler.require
+require File.expand_path('../../lib/acts_as_subscription', __FILE__)
+
+ENV['DB'] ||= 'sqlite3'
+
+database_yml = File.expand_path('../support/database.yml', __FILE__)
+if File.exists?(database_yml)
+  active_record_configuration = YAML.load_file(database_yml)[ENV['DB']]
+  
+  ActiveRecord::Base.establish_connection(active_record_configuration)
+  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+  
+  ActiveRecord::Base.silence do
+    ActiveRecord::Migration.verbose = false
+    
+    load(File.dirname(__FILE__) + '/support/schema.rb')
+    load(File.dirname(__FILE__) + '/support/models.rb')
+  end  
+  
+else
+  raise "Please create #{database_yml} first to configure your database. Take a look at: #{database_yml}.example"
+end
+
+def backend_config(backend_name)
+  backend_yml = File.expand_path('../support/backend.yml', __FILE__)
+  if File.exists?(backend_yml)
+    config = YAML.load_file(backend_yml)
+    
+    # Check that config is defined for this backend.
+    unless config[backend_name.to_s]
+      raise "Please create a section for '#{backend_name}' in #{backend_yml}"
+    end
+    
+    config[backend_name.to_s]
+  else
+    raise "Please create #{backend_yml} first to configure backend authentication. Take a look at: #{backend_yml}.example"
+  end
+end
+
+def free_attributes
+    {
+      :email                        => 'dummy@recursive-design.com',
+      :plan_code                    => 'FREE',
+      :customer_code                => UUIDTools::UUID.random_create.to_s,
+      :first_name                   => 'Testy',
+      :last_name                    => 'McTest',
+    }
+end
+
+def paid_attributes
+    {
+      :email                        => 'dummy@recursive-design.com',
+      :plan_code                    => 'PRO',
+      :customer_code                => UUIDTools::UUID.random_create.to_s,
+      :first_name                   => 'Testy',
+      :last_name                    => 'McTest',
+      :cc_expiration_month          => 1,
+      :cc_expiration_year           => 2012,
+      :cc_number                    => '4111111111111111',
+      :cc_verification_value        => '123',
+      :zip_code                     => '90210',
+    }
+  end
+
+def model_factory(params={})
+  defaults   = {:backend => :dummy, :user => 'user', :pass => 'pass'}
+  params     = defaults.merge(params)
+  param_str  =  params.collect { |name, value| 
+    if (value.class == Symbol) 
+      value = ":#{value}" 
+    else 
+      value = "'#{value}'" 
+    end 
+    ":#{name} => #{value}" }.join(', ')
+	klass = eval <<-RUBY_EVAL
+	class Subscription < ActiveRecord::Base
+    include ActsAsSubscription::Subscription
+    acts_as_subscription #{param_str}
+  end
+	RUBY_EVAL
+	klass
+end
+
+def clean_database!
+  models = [Subscription]
+  models.each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end
+
+clean_database!

data/spec/support/backend.yml.example

@@ -0,0 +1,14 @@
+cheddar_getter:
+  user:         'user@test.com'
+  pass:         'pass'
+  product_code: 'my_product'
+
+recurly:
+  user:         'user@test.com'
+  pass:         'pass'
+  product_code: 'my_product'
+
+chargify:
+  user:         'user@test.com'
+  pass:         'pass'
+  product_code: 'my_product'

data/spec/support/database.yml

@@ -0,0 +1,17 @@
+sqlite3:
+  adapter: sqlite3
+  database: acts_as_subscription.sqlite3
+
+mysql:
+  adapter: mysql
+  hostname: localhost
+  username: root
+  password:
+  database: acts_as_subscription
+
+postgresql:
+  adapter: postgresql
+  hostname: localhost
+  username: postgres
+  password:
+  database: acts_as_subscription

data/spec/support/models.rb

@@ -0,0 +1,21 @@
+
+class Subscription < ActiveRecord::Base
+  
+  # Doesn't work without this include for gem testing - not needed for real-world use.
+  include ActsAsSubscription::Subscription
+  
+  acts_as_subscription :backend      => :dummy,
+                       :user         => 'user',
+                       :password     => 'pass',
+                       :product_code => 'DUMMY_TEST'
+  
+end
+
+
+class SubscriptionPlan < ActiveRecord::Base
+  
+  include ActsAsSubscription::SubscriptionPlan
+  
+  acts_as_subscription_plan
+  
+end

data/spec/support/schema.rb

@@ -0,0 +1,30 @@
+
+ActiveRecord::Schema.define :version => 0 do
+
+  create_table :subscriptions, :force => true do |t|
+    t.string      :customer_code, :null => false
+    t.string      :email,         :null => false
+    t.string      :first_name,    :null => false
+    t.string      :last_name,     :null => false
+    t.string      :plan_code,     :null => false
+    t.string      :zip_code
+    t.integer     :cc_expiration_month
+    t.integer     :cc_expiration_year
+    t.string      :cc_last_digits
+    t.string      :cc_verification_value
+    t.datetime    :canceled_at
+    t.datetime    :suspended_at
+    t.timestamps
+  end
+  
+  create_table :subscription_plans, :force => true do |t|
+    t.string      :code,              :null => false
+    t.string      :name,              :null => false
+    t.text        :description
+    t.string      :billing_frequency, :null => false
+    t.float       :recurring_charge,  :null => false
+    t.boolean     :active,            :default => true
+    t.timestamps
+  end
+
+end

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_subscription
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dave Perrett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-01 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: activemerchant
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 1
+        - 9
+        - 3
+        version: 1.9.3
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: chargify_api_ares
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 3
+        - 7
+        version: 0.3.7
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: hpricot
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: mousetrap
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: rails
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: uuidtools
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 0
+        - 9
+        - 9
+        version: 0.9.9
+  requirement: *id009
+description: With ActsAsSubscription, you can hook your model into several subscription services, such as CheddarGetter.
+email: mail@recursive-design.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .autotest
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_subscription.gemspec
+- autotest/discover.rb
+- lib/acts_as_subscription.rb
+- lib/acts_as_subscription/backend.rb
+- lib/acts_as_subscription/backend/chargify_client.rb
+- lib/acts_as_subscription/backend/cheddar_getter_client.rb
+- lib/acts_as_subscription/backend/dummy_client.rb
+- lib/acts_as_subscription/backend/recurly_client.rb
+- lib/acts_as_subscription/error.rb
+- lib/acts_as_subscription/railtie.rb
+- lib/acts_as_subscription/subscription.rb
+- lib/acts_as_subscription/subscription_plan.rb
+- spec/backend/backend/chargify_client_spec.rb
+- spec/backend/backend/cheddar_getter_client_spec.rb
+- spec/backend/backend_spec.rb
+- spec/models/subscription_plan_spec.rb
+- spec/models/subscription_spec.rb
+- spec/spec_helper.rb
+- spec/support/backend.yml.example
+- spec/support/database.yml
+- spec/support/models.rb
+- spec/support/schema.rb
+has_rdoc: true
+homepage: http://recursive-design.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: nowarning
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActsAsSubscription is a plugin for rails that provides recurring subscription capabilities to a model.
+test_files: 
+- spec/backend/backend/chargify_client_spec.rb
+- spec/backend/backend/cheddar_getter_client_spec.rb
+- spec/backend/backend_spec.rb
+- spec/models/subscription_plan_spec.rb
+- spec/models/subscription_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb