redline 0.1.4 → 0.2.0

data/.gitignore

@@ -19,4 +19,5 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
-spec/db/test.sqlite3
+spec/db/test.sqlite3
+tmp/

data/README.rdoc

@@ -2,7 +2,18 @@
 
 Braintree via Redline: riding the rails
 
-Redline helps you with Braintree on Rails, it automatically makes creation/deletion/update scripts for your model, translating and syncing them with a Braintree customer profile. In the future I plan to increase the capabilities with helpers for Braintree models and light-weight subscription support, perhaps using Braintree's reoccurring billing.
+Redline helps you with Braintree on Rails, it automatically makes customer creation/deletion/update scripts for your model, translating and syncing them with a Braintree customer profile.
+Redline also includes a lightweight manual subscription billing system, if you desire that functionality.
+
+=== Please note: this repository may be a prerelease version, please read the README of the version you have installed.
+
+== Heads up
+
+=== This software is delivered "as is" without warranty. As with any piece of code, please study it if you include it in your project, especially for such a critical component of your application.
+
+While I believe the tests cover the code well, there may be certain cases that I have not expirienced or predicted. This is a manual billing script, so dreadful things may occur; please help out and add to the tests if you see, or god forbid expirience, any problems.
+
+It is my intention to convert to gateway handled subscriptions, once Braintree adds this functionality to their gem.
 
 == Getting started
 
@@ -15,34 +26,46 @@ Run your install task:
 
   $ rake gems:install
 
-Configure Braintree normally in an initializer:
-
-  Braintree::Configuration.environment = CONFIG[:braintree][:environment].to_sym
-  Braintree::Configuration.merchant_id = CONFIG[:braintree][:merchant_id]
-  Braintree::Configuration.public_key  = CONFIG[:braintree][:public_key]
-  Braintree::Configuration.private_key = CONFIG[:braintree][:private_key]
+Configure Braintree normally in an initializer and add the following magic columns to a model of your choice (e.g, User):
 
-Add acts_as_braintree_customer and a column customer_id:integer to a model of your choice:
+  add_column :users, :customer_id,      :integer  # Required
+  
+  add_column :users, :subscription_key, :string   # Required if User has_a_subscription
+  add_column :users, :paid_until,       :date     # Required if User has_a_subscription
+  add_column :users, :trial_until,      :date     # Required if User has_a_subscription and trial length is greater than 0.days
 
-  add_column :users, :customer_id, :integer
+And the following definition calls:
 
-  Class User < ActiveRecord::Base
-    acts_as_braintree_customer
+  class User < ActiveRecord::Base
+  
+    has_a_braintree_customer
+  
+    has_a_subscription do
+      plans :mild => {:price => 0.00}, :medium => {:price => 5.00}, :spicy => {:price => 10.00}
+    end
+  
   end
 
-== Example and configuration
+And then run this daily:
 
-acts_as_braintree_customer takes an optional series of attributes that represent an attribute[] mapper
+  User.run_billing!
 
-  class User < ActiveRecord::Base
-    acts_as_braintree_customer :business_name => :company, :firstname => :first_name, :lastname => :last_name
-    attr_accessible :firstname, :lastname, :website, :email, :business_name, :password, :password_confirmation
-  end
+== More advanced configuration
 
-  james = User.find(1) #=> <User id: 1, firstname: "James", lastname: "Daniels", business_name: "MarginLeft, LLC", email: 'james@jamesdaniels.net', website: 'http://www.marginleft.com', crypted_password: "45fres8...", persistence_token: "4jsdf88...", ...>
-  james.customer #=> <Braintree::Customer id: "9999999", first_name: "James", last_name: "Daniels", company: "MarginLeft, LLC", email: "james@jamesdaniels.net", website: "http://www.marginleft.com", ..., addresses: [], credit_cards: []>
+If you don't like the default settings or your user needs a field mapping, you can override many assumptions RedLine makes:
 
-More to come.
+  class User < ActiveRecord::Base
+    has_a_braintree_customer do
+      attribute_map :firstname => :first_name, :lastname => :last_name
+    end
+
+    has_a_subscription do
+      plans :mild => {:price => 0.00}, :medium => {:price => 5.00}, :spicy => {:price => 10.00}
+      default_plan :medium
+      billing_frequency 30.days, :grace_period => 7.days
+      free_trial 30.days, :reminder => 7.days
+    end
+  end
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "redline"
-    gem.summary = %Q{Braintree via redline: riding the rails}
-    gem.description = %Q{Manual subscriptions via the Braintree gem}
+    gem.summary = %Q{Syncs your AR models with Braintree (Payment Gateway) and offers a lightweight reoccurring billing script}
+    gem.description = %Q{Syncs your AR models with Braintree (Payment Gateway) and offers a lightweight reoccurring billing script}
     gem.email = "james@marginleft.com"
     gem.homepage = "http://github.com/jamesdaniels/redline"
     gem.authors = ["James Daniels"]
@@ -21,6 +21,11 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
+begin
+	require 'metric_fu'
+rescue
+end
+
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/lib/redline.rb

@@ -2,12 +2,21 @@ require 'rubygems'
 require 'active_record'
 
 module RedLine
-  
-  autoload :Customer, 'redline/customer'
+
+	autoload :Customer,     'redline/customer/base'
+	autoload :Subscription, 'redline/subscription/base'
+	autoload :Billing,      'redline/billing/base'
+	
+	def has_a_braintree_customer
+		include RedLine::Customer
+		yield if block_given?
+		set_default_customer_options
+	end
 	
-	def acts_as_braintree_customer(attribute_rewriting = {})
-		send :include, RedLine::Customer
-		send 'braintree_customer=', attribute_rewriting
+	def has_a_subscription
+		include RedLine::Subscription
+		yield if block_given?
+		set_default_subscription_options
 	end
 
 end

data/lib/redline/billing/base.rb

@@ -0,0 +1,11 @@
+module RedLine
+	module Billing
+		def run_billing!
+			# should clean this up, put it in a named scope
+			self.all.select{|u| u.next_due == Date.today}.each do |record|
+				record.pay rescue nil
+				record.save
+			end
+		end
+	end
+end

data/lib/redline/customer/base.rb

@@ -0,0 +1,18 @@
+module RedLine
+	module Customer
+		autoload :Settings,        'redline/customer/settings'
+		autoload :InstanceMethods, 'redline/customer/instance'
+		def self.included(base)
+			base.class_eval do
+				extend ActiveSupport::Memoizable
+				extend RedLine::Customer::Settings
+				include InstanceMethods
+				memoize :customer
+				before_create  :create_customer
+				before_update  :update_customer
+				before_destroy :delete_customer
+				cattr_accessor :braintree_customer
+			end
+		end
+	end
+end

data/lib/redline/{customer.rb → customer/instance.rb}

@@ -1,16 +1,5 @@
 module RedLine
 	module Customer
-		def self.included(base)
-			base.class_eval do
-				send :extend, ActiveSupport::Memoizable
-				send :include, InstanceMethods
-				memoize :customer
-				before_create  :create_customer
-				before_update  :update_customer
-				before_destroy :delete_customer
-				cattr_accessor :braintree_customer
-			end
-		end
 		module InstanceMethods
 			def braintree_customer_attributes
 				wanted_attributes = Braintree::Customer._create_signature.reject{|a| a.is_a? Hash}.reject{|a| a == :id}

data/lib/redline/customer/settings.rb

@@ -0,0 +1,12 @@
+module RedLine
+	module Customer
+		module Settings
+			def set_default_customer_options
+				attribute_map {} unless (send :braintree_customer)
+			end
+			def attribute_map(attributes = {})
+				self.braintree_customer = attributes
+			end
+		end
+	end
+end

data/lib/redline/subscription/base.rb

@@ -0,0 +1,16 @@
+module RedLine
+	module Subscription
+		autoload :Settings,        'redline/subscription/settings'
+		autoload :InstanceMethods, 'redline/subscription/instance'
+		def self.included(base)
+			base.class_eval do
+				extend ActiveSupport::Memoizable
+				extend RedLine::Subscription::Settings
+				extend RedLine::Billing
+				include InstanceMethods
+				before_create :set_plan
+				cattr_accessor :subscription_plans, :trial_settings, :billing_settings, :default_subscription_plan
+			end
+		end
+	end
+end

data/lib/redline/subscription/instance.rb

@@ -0,0 +1,42 @@
+module RedLine
+	module Subscription
+		module InstanceMethods
+			def plan
+				self.class.subscription_plans[(subscription_key || self.class.default_subscription_plan).to_sym]
+			end
+			def plan=(plan)
+				if (plan.is_a?(String) || plan.is_a?(Symbol)) && self.class.subscription_plans.keys.include?(plan.to_sym)
+					self.subscription_key = plan
+				elsif plan.is_a?(Hash)
+					self.subscription_key = self.class.subscription_plans.index(plan)
+				end
+				self.paid_until = Date.today
+				self.trial_until ||= Date.today + self.class.trial_settings[:period] if trial?
+			end
+			def set_plan
+				self.subscription_key ||= self.class.default_subscription_plan
+			end
+			def pay
+				self.customer.sale!(:amount => ("%0.2f" % plan[:price]), :options => {:submit_for_settlement => true})
+				self.paid_until = Date.today + self.class.billing_settings[:period] - (past_due || 0)
+			end
+			def past_grace?
+				past_due && past_due >= self.class.billing_settings[:grace_period]
+			end
+			def paid_plan?
+				plan[:price] > 0
+			end
+			def trial?
+				self.class.trial_settings[:period] > 0.days
+			end
+			def next_due
+				paid_plan? && [trial? && trial_until || nil, paid_until, Date.today].compact.max
+			end
+			def past_due
+				due_date = [trial? && trial_until || nil, paid_until].compact.max
+				amount = (due_date && (Date.today - due_date) || 0).days
+				paid_plan? && amount > 0 && amount
+			end
+		end
+	end
+end

data/lib/redline/subscription/settings.rb

@@ -0,0 +1,24 @@
+module RedLine
+	module Subscription
+		module Settings
+			def set_default_subscription_options
+				billing_frequency 30.days unless billing_settings
+				free_trial        30.days unless trial_settings
+				default_plan ((send :subscription_plans).to_a.sort_by{|a| a[1][:price]}.first.first) unless default_subscription_plan
+			end
+			def plans(subscriptions = {})
+				include RedLine::Subscription
+				self.subscription_plans = subscriptions
+			end
+			def free_trial(period, options = {})
+				self.trial_settings = {:period => period, :reminder => 5.days}.merge(options)
+			end
+			def billing_frequency(period, options = {})
+				self.billing_settings = {:period => period, :grace_period => 5.days}.merge(options)
+			end
+			def default_plan(subscription_plan)
+				self.default_subscription_plan = subscription_plan
+			end
+		end
+	end
+end

data/redline.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{redline}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Daniels"]
-  s.date = %q{2010-02-03}
-  s.description = %q{Manual subscriptions via the Braintree gem}
+  s.date = %q{2010-02-10}
+  s.description = %q{Syncs your AR models with Braintree (Payment Gateway) and offers a lightweight reoccurring billing script}
   s.email = %q{james@marginleft.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -24,25 +24,37 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/redline.rb",
-     "lib/redline/customer.rb",
+     "lib/redline/billing/base.rb",
+     "lib/redline/customer/base.rb",
+     "lib/redline/customer/instance.rb",
+     "lib/redline/customer/settings.rb",
+     "lib/redline/subscription/base.rb",
+     "lib/redline/subscription/instance.rb",
+     "lib/redline/subscription/settings.rb",
      "redline.gemspec",
+     "spec/billing_spec.rb",
+     "spec/customer_spec.rb",
      "spec/db/database.yml",
      "spec/db/models.rb",
      "spec/db/schema.rb",
      "spec/redline_spec.rb",
      "spec/spec.opts",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/subscription_spec.rb"
   ]
   s.homepage = %q{http://github.com/jamesdaniels/redline}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Braintree via redline: riding the rails}
+  s.summary = %q{Syncs your AR models with Braintree (Payment Gateway) and offers a lightweight reoccurring billing script}
   s.test_files = [
-    "spec/db/models.rb",
+    "spec/billing_spec.rb",
+     "spec/customer_spec.rb",
+     "spec/db/models.rb",
      "spec/db/schema.rb",
      "spec/redline_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/subscription_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/billing_spec.rb

@@ -0,0 +1,121 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe User do
+	
+	def valid_user
+		Braintree::Customer.stub!('_create_signature').and_return([:first_name, :last_name, :email])
+		@user ||= User.new(
+			:first_name => 'James', 
+			:last_name => 'Daniels', 
+			:email => 'james@marginleft.com', 
+			:unused_attribute => 'unused'
+		)
+	end
+	
+	def mock_customer
+		@customer ||= mock(Braintree::Customer, :id => 1)
+	end
+	
+	it 'should run billing' do
+		Braintree::Customer.stub!('_create_signature').and_return([:first_name, :last_name, :email])
+		Braintree::Customer.should_receive('create!').with(valid_user.braintree_customer_attributes).exactly(3).and_return(mock_customer)
+		Braintree::Customer.should_receive('update!').twice.and_return(mock_customer)
+		users = User.subscription_plans.keys.map do |plan|
+			user = User.new(
+				:first_name => 'James', 
+				:last_name => 'Daniels', 
+				:email => 'james@marginleft.com', 
+				:unused_attribute => 'unused'
+			)
+			user.plan = plan
+			if plan == :mild
+				user.should_receive(:next_due).and_return(nil)
+				user.should_not_receive(:pay)
+			else
+				user.should_receive(:next_due).and_return(Date.today)
+				user.should_receive(:pay).and_return(true)
+			end
+			user.save
+			user
+		end
+		User.stub!(:all).and_return(users)
+		User.run_billing!
+	end
+	
+	it 'should run billing with failures' do
+		Braintree::Customer.stub!('_create_signature').and_return([:first_name, :last_name, :email])
+		Braintree::Customer.should_receive('create!').with(valid_user.braintree_customer_attributes).once.and_return(mock_customer)
+		Braintree::Customer.should_receive('update!').once.and_return(mock_customer)
+		user = User.new(
+			:first_name => 'James', 
+			:last_name => 'Daniels', 
+			:email => 'james@marginleft.com', 
+			:unused_attribute => 'unused'
+		)
+		user.plan = :medium
+		user.paid_until = Date.today - 1
+		user.trial_until = Date.today - 1
+		user.stub!('customer').and_return(mock_customer)
+		user.stub!(:pay).and_raise(ArgumentError)
+		user.save
+		User.stub!(:all).and_return([user])
+		User.run_billing!
+		user.next_due.should eql(Date.today)
+	end
+	
+	describe 'paid bill' do
+		(0).upto(5) do |x|
+			it "should push the due date 30 days when #{x} days past due" do
+				user = User.new
+				mock_customer = mock(Braintree::Customer, :id => 1)
+				user.stub!('customer').and_return(mock_customer)
+				mock_customer.should_receive('sale!').with({:amount=>"10.00", :options=>{:submit_for_settlement=>true}}).and_return(true)
+				user.plan = :spicy
+				user.paid_until = Date.today - x.days
+				user.trial_until = Date.today - 30.days
+				user.pay
+				user.next_due.should eql(Date.today + 30.days - x.days)
+			end
+		end
+	end
+	
+end
+
+describe ComplexUser do
+	
+	describe 'paid bill' do
+		(0).upto(5) do |x|
+			it "should push the due date 30 days when #{x} days past due" do
+				user = ComplexUser.new
+				mock_customer = mock(Braintree::Customer, :id => 1)
+				user.stub!('customer').and_return(mock_customer)
+				mock_customer.should_receive('sale!').with({:amount=>"5.00", :options=>{:submit_for_settlement=>true}}).and_return(true)
+				user.plan = :medium
+				user.paid_until = Date.today - x.days
+				user.trial_until = Date.today - 31.days
+				user.pay
+				user.next_due.should eql(Date.today + 31.days - x.days)
+			end
+		end
+	end
+
+end
+
+describe UserWithoutTrial do
+	
+	describe 'paid bill' do
+		(0).upto(5) do |x|
+			it "should push the due date 30 days when #{x} days past due" do
+				user = UserWithoutTrial.new
+				mock_customer = mock(Braintree::Customer, :id => 1)
+				user.stub!('customer').and_return(mock_customer)
+				mock_customer.should_receive('sale!').with({:amount=>"10.00", :options=>{:submit_for_settlement=>true}}).and_return(true)
+				user.plan = :spicy
+				user.paid_until = Date.today - x.days
+				user.pay
+				user.next_due.should eql(Date.today + 30.days - x.days)
+			end
+		end
+	end
+	
+end

data/spec/customer_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe User do
+	
+	def valid_user
+		Braintree::Customer.stub!('_create_signature').and_return([:first_name, :last_name, :email])
+		@user ||= User.new(
+			:first_name => 'James', 
+			:last_name => 'Daniels', 
+			:email => 'james@marginleft.com', 
+			:unused_attribute => 'unused'
+		)
+	end
+	
+	def mock_customer
+		@customer ||= mock(Braintree::Customer, :id => 1)
+	end
+	
+	it "should have a empty braintree_customer" do
+		User.braintree_customer.should eql({})
+	end
+	
+  it "should inherit the instance methods" do
+		expected_methods = %w(braintree_customer_attributes customer create_customer update_customer delete_customer)
+		(User.instance_methods & expected_methods).sort.should eql(expected_methods.sort)
+	end
+	it "should have proper braintree attributes" do
+		valid_user.braintree_customer_attributes.should eql({:first_name=>"James", :last_name=>"Daniels", :email=>"james@marginleft.com"})
+	end
+	it "should fire Braintree::Customer.create!" do
+		Braintree::Customer.should_receive('create!').with(valid_user.braintree_customer_attributes).and_return(mock_customer)
+		valid_user.save!
+		valid_user.reload
+		valid_user.customer_id.should eql(mock_customer.id)
+	end
+	it "should fire Braintree::Customer.update!" do
+		Braintree::Customer.stub!('create!').and_return(mock_customer)
+		Braintree::Customer.should_receive('update!').with(mock_customer.id, valid_user.braintree_customer_attributes.merge(:email =>  'james@jamesdaniels.net')).and_return(true)
+		valid_user.save!
+		valid_user.update_attributes(:email => 'james@jamesdaniels.net')
+		valid_user.reload
+		valid_user.customer_id.should eql(mock_customer.id)
+	end
+	it "should fire Braintree::Customer.delete" do
+		Braintree::Customer.stub!('create!').and_return(mock_customer)
+		Braintree::Customer.stub!('find').and_return(true)
+		Braintree::Customer.should_receive('delete').with(mock_customer.id).and_return(true)
+		valid_user.save!
+		valid_user.destroy
+	end
+	it "should fire Braintree::Customer.find" do
+		Braintree::Customer.stub!('create!').and_return(mock_customer)
+		Braintree::Customer.stub!('update!').and_return(true)
+		Braintree::Customer.should_receive('find').with(mock_customer.id).and_return(true)
+		valid_user.save!
+		valid_user.customer
+	end
+	
+end
+
+describe ComplexUser do
+	
+	it "should have a empty braintree_customer" do
+		ComplexUser.braintree_customer.should eql({:firstname=>:first_name, :lastname=>:last_name})
+	end
+	it "should have proper braintree attributes" do
+		Braintree::Customer.stub!('_create_signature').and_return([:first_name, :last_name, :email])
+		ComplexUser.new(
+			:firstname => 'James', 
+			:lastname => 'Daniels', 
+			:email => 'james@marginleft.com', 
+			:unused_attribute => 'unused'
+		).braintree_customer_attributes.should eql({:first_name=>"James", :last_name=>"Daniels", :email=>"james@marginleft.com"})
+	end
+
+end

data/spec/db/models.rb

@@ -1,6 +1,10 @@
 class User < ActiveRecord::Base
 	
-	acts_as_braintree_customer
+	has_a_braintree_customer
+	
+	has_a_subscription do
+		plans :mild => {:price => 0.00}, :medium => {:price => 5.00}, :spicy => {:price => 10.00}
+	end
 	
 	validates_presence_of :first_name, :last_name, :unused_attribute, :email
 
@@ -8,8 +12,36 @@ end
 
 class ComplexUser < ActiveRecord::Base
 	
-	acts_as_braintree_customer :firstname => :first_name, :lastname => :last_name
+	has_a_braintree_customer do
+		attribute_map :firstname => :first_name, :lastname => :last_name
+	end
+	
+	has_a_subscription do
+		plans :mild => {:price => 0.00}, :medium => {:price => 5.00}, :spicy => {:price => 10.00}
+		default_plan :medium
+		billing_frequency 31.days, :grace_period => 6.days
+		free_trial 31.days, :reminder => 6.days
+	end
 	
 	validates_presence_of :firstname, :lastname, :unused_attribute, :email
 	
+end
+
+class UserWithoutTrial < ActiveRecord::Base
+	
+	has_a_braintree_customer do
+		attribute_map :firstname => :first_name, :lastname => :last_name
+	end
+	
+	has_a_subscription do
+		plans :mild => {:price => 0.00}, :medium => {:price => 5.00}, :spicy => {:price => 10.00}
+		free_trial 0.days
+	end
+	
+end
+
+class UserWithoutSubscription < ActiveRecord::Base
+
+	has_a_braintree_customer
+
 end

data/spec/db/schema.rb

@@ -1,16 +1,37 @@
 ActiveRecord::Schema.define(:version => 1) do
-  create_table :users, :force => true do |t|
-    t.column :first_name, :string
-    t.column :last_name, :string
-    t.column :email, :string
-    t.column :unused_attribute, :string
-    t.column :customer_id, :integer
-  end
-  create_table :complex_users, :force => true do |t|
-    t.column :firstname, :string
-    t.column :lastname, :string
-    t.column :email, :string
-    t.column :unused_attribute, :string
-    t.column :customer_id, :integer
-  end
+	create_table :users, :force => true do |t|
+		t.column :first_name, :string
+		t.column :last_name, :string
+		t.column :email, :string
+		t.column :unused_attribute, :string
+		t.column :customer_id, :integer
+		t.column :subscription_key, :string
+		t.column :trial_until, :date
+		t.column :paid_until, :date
+	end
+	create_table :complex_users, :force => true do |t|
+		t.column :firstname, :string
+		t.column :lastname, :string
+		t.column :email, :string
+		t.column :unused_attribute, :string
+		t.column :customer_id, :integer
+		t.column :subscription_key, :string
+		t.column :trial_until, :date
+		t.column :paid_until, :date
+	end
+	create_table :user_without_trials, :force => true do |t|
+		t.column :firstname, :string
+		t.column :lastname, :string
+		t.column :email, :string
+		t.column :unused_attribute, :string
+		t.column :customer_id, :integer
+		t.column :subscription_key, :string
+		t.column :paid_until, :date
+	end
+	create_table :user_without_subscription, :force => true do |t|
+		t.column :firstname, :string
+		t.column :lastname, :string
+		t.column :email, :string
+		t.column :customer_id, :integer
+	end
 end

data/spec/redline_spec.rb

@@ -1,70 +1,42 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe User do
-	
-	def valid_user
-		Braintree::Customer.stub!('_create_signature').and_return([:first_name, :last_name, :email])
-		@user ||= User.new(
-			:first_name => 'James', 
-			:last_name => 'Daniels', 
-			:email => 'james@marginleft.com', 
-			:unused_attribute => 'unused'
-		)
-	end
-	
-	def mock_customer
-		@customer ||= mock(Braintree::Customer, :id => 1)
-	end
-	
-	it "should have a empty braintree_customer" do
-		User.braintree_customer.should eql({})
-	end
-  it "should inherit the instance methods" do
-		expected_methods = %w(braintree_customer_attributes customer create_customer update_customer delete_customer)
-		(User.instance_methods & expected_methods).sort.should eql(expected_methods.sort)
-	end
-	it "should have proper braintree attributes" do
-		valid_user.braintree_customer_attributes.should eql({:first_name=>"James", :last_name=>"Daniels", :email=>"james@marginleft.com"})
-	end
-	it "should fire Braintree::Customer.create!" do
-		Braintree::Customer.should_receive('create!').with(valid_user.braintree_customer_attributes).and_return(mock_customer)
-		valid_user.save!
-		valid_user.customer_id.should eql(mock_customer.id)
-	end
-	it "should fire Braintree::Customer.update!" do
-		Braintree::Customer.stub!('create!').and_return(mock_customer)
-		Braintree::Customer.should_receive('update!').with(mock_customer.id, valid_user.braintree_customer_attributes.merge(:email =>  'james@jamesdaniels.net')).and_return(true)
-		valid_user.save!
-		valid_user.update_attributes(:email => 'james@jamesdaniels.net')
-		valid_user.customer_id.should eql(mock_customer.id)
-	end
-	it "should fire Braintree::Customer.delete" do
-		Braintree::Customer.stub!('create!').and_return(mock_customer)
-		Braintree::Customer.stub!('find').and_return(true)
-		Braintree::Customer.should_receive('delete').with(mock_customer.id).and_return(true)
-		valid_user.save!
-		valid_user.destroy
-	end
-	it "should fire Braintree::Customer.find" do
-		Braintree::Customer.stub!('create!').and_return(mock_customer)
-		Braintree::Customer.stub!('update!').and_return(true)
-		Braintree::Customer.should_receive('find').with(mock_customer.id).and_return(true)
-		valid_user.save!
-		valid_user.customer
+describe ActiveRecord do
+	it 'should extend our module' do
+		ActiveRecord::Base.is_a?(RedLine).should be_true
 	end
 end
 
-describe ComplexUser do
-	it "should have a empty braintree_customer" do
-		ComplexUser.braintree_customer.should eql({:firstname=>:first_name, :lastname=>:last_name})
-	end
-	it "should have proper braintree attributes" do
-		Braintree::Customer.stub!('_create_signature').and_return([:first_name, :last_name, :email])
-		ComplexUser.new(
-			:firstname => 'James', 
-			:lastname => 'Daniels', 
-			:email => 'james@marginleft.com', 
-			:unused_attribute => 'unused'
-		).braintree_customer_attributes.should eql({:first_name=>"James", :last_name=>"Daniels", :email=>"james@marginleft.com"})
+[User, ComplexUser, UserWithoutTrial, UserWithoutSubscription].each do |klass|
+	describe klass do
+		it 'should extend our module' do
+			klass.is_a?(RedLine).should be_true
+		end
+		it 'should respond to a customer' do
+			klass.respond_to?(:has_a_braintree_customer).should be_true
+		end
+		it 'should respond to a subscription' do
+			klass.respond_to?(:has_a_subscription).should be_true
+		end
+		it 'should include RedLine::Customer' do
+			klass.include?(RedLine::Customer).should be_true
+		end
+		it 'should extend RedLine::Customer::Settings' do
+			klass.is_a?(RedLine::Customer::Settings).should be_true
+		end
+		it 'should include RedLine::Customer::InstanceMethods' do
+			klass.include?(RedLine::Customer::InstanceMethods).should be_true
+		end
+		it "should#{(klass == UserWithoutSubscription) && ' not' || ''} include RedLine::Subscription" do
+			klass.include?(RedLine::Subscription).should eql(klass != UserWithoutSubscription)
+		end
+		it "should#{(klass == UserWithoutSubscription) && ' not' || ''} extend RedLine::Subscription::Settings" do
+			klass.is_a?(RedLine::Subscription::Settings).should eql(klass != UserWithoutSubscription)
+		end
+		it "should#{(klass == UserWithoutSubscription) && ' not' || ''} include RedLine::Subscription::InstanceMethods" do
+			klass.include?(RedLine::Subscription::InstanceMethods).should eql(klass != UserWithoutSubscription)
+		end
+		it "should#{(klass == UserWithoutSubscription) && ' not' || ''} include RedLine::Billing" do
+			klass.is_a?(RedLine::Billing).should eql(klass != UserWithoutSubscription)
+		end
 	end
 end

data/spec/subscription_spec.rb

@@ -0,0 +1,237 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe User do
+	
+	def valid_user
+		Braintree::Customer.stub!('_create_signature').and_return([:first_name, :last_name, :email])
+		@user ||= User.new(
+			:first_name => 'James', 
+			:last_name => 'Daniels', 
+			:email => 'james@marginleft.com', 
+			:unused_attribute => 'unused'
+		)
+	end
+	
+	def mock_customer
+		@customer ||= mock(Braintree::Customer, :id => 1)
+	end
+	
+	it 'should have a default plan' do
+		Braintree::Customer.should_receive('create!').with(valid_user.braintree_customer_attributes).and_return(mock_customer)
+		user = valid_user
+		user.save
+		user.reload
+		user.subscription_key = :mild
+	end
+	
+	it 'should have possible subscription plans' do
+		User.subscription_plans.should == {:mild => {:price => 0.00}, :medium => {:price => 5.00}, :spicy => {:price => 10.00}}
+	end
+	it 'should have a default plan' do
+		User.default_subscription_plan.should eql(:mild)
+	end
+	it 'should have billing settings' do
+		User.billing_settings.should == {:period => 30.days, :grace_period => 5.days}
+	end
+	it 'should have trial settings' do
+		User.trial_settings.should == {:period => 30.days, :reminder=>5.days}
+	end
+	
+	describe 'should handle trial period' do
+		it 'sets trial' do
+			user = User.new
+			user.plan = :mild
+			user.trial_until.should eql(Date.today + 30.days)
+		end
+		it 'upgrades account within trial' do
+			user = User.new
+			user.plan = :medium
+			user.plan = :spicy
+			user.trial_until.should eql(Date.today + 30.days)
+		end
+		it 'upgrades account outside of trial' do
+			user = User.new
+			user.plan = :medium
+			user.trial_until = Date.today-1.days
+			user.plan = :spicy
+			user.trial_until.should eql(Date.today - 1.days)
+		end
+		it 'downgrades account within trial' do
+			user = User.new
+			user.plan = :spicy
+			user.plan = :medium
+			user.trial_until.should eql(Date.today + 30.days)
+		end
+		it 'downgrades account outside of trial' do
+			user = User.new
+			user.plan = :spicy
+			user.trial_until = Date.today-1.days
+			user.plan = :medium
+			user.trial_until.should eql(Date.today - 1.days)
+		end
+	end
+end
+
+describe ComplexUser do
+	
+	it 'should have possible subscription plans' do
+		ComplexUser.subscription_plans.should == {:mild => {:price => 0.00}, :medium => {:price => 5.00}, :spicy => {:price => 10.00}}
+	end
+	it 'should have a default plan' do
+		ComplexUser.default_subscription_plan.should eql(:medium)
+	end
+	it 'should have billing settings' do
+		ComplexUser.billing_settings.should == {:period => 31.days, :grace_period => 6.days}
+	end
+	it 'should have trial settings' do
+		ComplexUser.trial_settings.should == {:period => 31.days, :reminder=>6.days}
+	end
+
+	it 'should hand plan as a hash' do
+		user = ComplexUser.new
+		user.plan = ComplexUser.subscription_plans.values.first
+		user.subscription_key.should eql(ComplexUser.subscription_plans.keys.first)
+	end
+
+	describe 'should handle next due correctly' do
+		it 'on free' do
+			user = ComplexUser.new
+			user.plan = :mild
+			user.next_due.should be_false
+		end
+		it 'on past due' do
+			user = ComplexUser.new
+			user.plan = :spicy
+			user.paid_until = Date.today - 6.days
+			user.trial_until = Date.today - 37.days
+			user.next_due.should eql(Date.today)
+		end
+		it 'on paid' do
+			user = ComplexUser.new
+			user.plan = :spicy
+			user.paid_until = Date.today + 6.days
+			user.trial_until = Date.today - 31.days + 6.days
+			user.next_due.should eql(Date.today+6.days)
+		end
+		it 'on upgrade' do
+			user = ComplexUser.new
+			user.plan = :mild
+			user.trial_until = Date.today - 30.days
+			user.paid_until = Date.today - 1.days
+			user.plan = :spicy
+			user.next_due.should eql(Date.today)
+		end
+		it 'on downgrade' do
+			user = ComplexUser.new
+			user.plan = :spicy
+			user.trial_until = Date.today - 30.days
+			user.paid_until = Date.today - 1.days
+			user.plan = :medium
+			user.next_due.should eql(Date.today)
+		end
+	end
+	
+	describe 'should handle trial period' do
+		it 'sets trial' do
+			user = ComplexUser.new
+			user.plan = :mild
+			user.trial_until.should eql(Date.today + 31.days)
+		end
+	end
+	
+	describe 'should handle grace period' do
+		it 'on not past due' do
+			user = ComplexUser.new
+			user.should_receive(:past_due).and_return(false)
+			user.past_grace?.should be_false
+		end
+		0.upto(6) do |x|
+			it "on past due by #{x} days" do
+				user = ComplexUser.new
+				user.should_receive(:past_due).twice.and_return(x.days)
+				user.past_grace?.should eql(x > 5)
+			end
+		end
+	end
+
+	describe 'should handle due correctly' do
+	 	describe 'past due' do
+			it 'should work via past_due method' do
+				user = ComplexUser.new
+				user.plan = :spicy
+				user.paid_until = Date.today - 6.days
+				user.trial_until = Date.today - 37.days
+				user.past_due.should eql(6.days)
+			end
+			it 'should handle trials' do
+				user = ComplexUser.new
+				user.plan = :spicy
+				user.paid_until = nil
+				user.trial_until = Date.today - 1.days
+				user.past_due.should eql(1.days)
+			end
+		end
+		describe 'not overdue' do
+			it 'should work via past_due method' do
+				user = ComplexUser.new
+				user.plan = :spicy
+				user.paid_until = Date.today + 6.days
+				user.trial_until = Date.today - 31.days + 6.days
+				user.past_due.should be_false
+			end
+			it 'should handle end of trial' do
+				user = ComplexUser.new
+				user.plan = :spicy
+				user.paid_until = nil
+				user.trial_until = nil
+				user.past_due.should be_false
+			end
+			it 'should handle trials' do
+				user = ComplexUser.new
+				user.plan = :spicy
+				user.paid_until = nil
+				user.trial_until = Date.today + 1.days
+				user.past_due.should be_false
+			end
+		end
+		describe 'free account' do
+			it 'should work via past_due trial' do
+				user = ComplexUser.new
+				user.plan = :mild
+				user.paid_until = Date.today - 6.days
+				user.trial_until = Date.today - 37.days
+				user.past_due.should be_false
+			end
+			it 'should handle past_due trials' do
+				user = ComplexUser.new
+				user.plan = :mild
+				user.paid_until = nil
+				user.trial_until = Date.today - 1.days
+				user.past_due.should be_false
+			end
+			it 'should work via trial' do
+				user = ComplexUser.new
+				user.plan = :mild
+				user.paid_until = Date.today + 6.days
+				user.trial_until = Date.today - 31.days + 6.days
+				user.past_due.should be_false
+			end
+			it 'should handle trials' do
+				user = ComplexUser.new
+				user.plan = :mild
+				user.paid_until = nil
+				user.trial_until = Date.today + 1.days
+				user.past_due.should be_false
+			end
+		end
+	end
+
+end
+
+describe UserWithoutTrial do
+	
+	it 'has no trial' do
+		UserWithoutTrial.trial_settings.should == {:period=>0.days, :reminder=>5.days}
+	end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: redline
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - James Daniels
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-03 00:00:00 -05:00
+date: 2010-02-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: Manual subscriptions via the Braintree gem
+description: Syncs your AR models with Braintree (Payment Gateway) and offers a lightweight reoccurring billing script
 email: james@marginleft.com
 executables: []
 
@@ -69,14 +69,23 @@ files:
 - Rakefile
 - VERSION
 - lib/redline.rb
-- lib/redline/customer.rb
+- lib/redline/billing/base.rb
+- lib/redline/customer/base.rb
+- lib/redline/customer/instance.rb
+- lib/redline/customer/settings.rb
+- lib/redline/subscription/base.rb
+- lib/redline/subscription/instance.rb
+- lib/redline/subscription/settings.rb
 - redline.gemspec
+- spec/billing_spec.rb
+- spec/customer_spec.rb
 - spec/db/database.yml
 - spec/db/models.rb
 - spec/db/schema.rb
 - spec/redline_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/subscription_spec.rb
 has_rdoc: true
 homepage: http://github.com/jamesdaniels/redline
 licenses: []
@@ -104,9 +113,12 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: "Braintree via redline: riding the rails"
+summary: Syncs your AR models with Braintree (Payment Gateway) and offers a lightweight reoccurring billing script
 test_files: 
+- spec/billing_spec.rb
+- spec/customer_spec.rb
 - spec/db/models.rb
 - spec/db/schema.rb
 - spec/redline_spec.rb
 - spec/spec_helper.rb
+- spec/subscription_spec.rb