saas 0.1 → 0.1.1

data/generators/saas_features/USAGE

@@ -0,0 +1,41 @@
+Description:
+    This generator add Cucumber features to your application
+
+Example:
+    ./script/generate saas_features
+
+This will create:
+
+
+You will also have to manually do:
+    add to features/support/env.rb
+        # global subscription plans fixtures
+        # see http://wiki.github.com/aslakhellesoy/cucumber/fixtures
+        # and http://wiki.github.com/aslakhellesoy/cucumber/hooks
+        raw = File.read( RAILS_ROOT + '/db/subscription_plans.yml' )
+        data = YAML.load(raw)[RAILS_ENV].symbolize_keys
+        data[:plans].each {|params| SubscriptionPlan.create( params ) }
+        at_exit do
+          SubscriptionPlan.destroy_all
+        end
+        
+        
+    add to features/support/path.rb
+        when /my profile/
+          user_path(:current)
+        when /my subscription/
+          subscription_path(:current)
+        when /my credit card/
+          credit_card_subscription_path(:current)
+        
+    also, check the user_steps.rb file, it may define steps and methods you already have, it contains
+        Given /^a user "(.*)"$/
+        Given /^a user is logged in as "(.*)"$/
+        When /^I log in as "(.*)"$/
+        def create_user( options = {} )
+        def log_in_as( username )
+        
+    finally, the scenarios expect the homepage has a link to "Sign up" page
+        
+        
+        

data/generators/saas_features/saas_features_generator.rb

@@ -0,0 +1,18 @@
+class SaasFeaturesGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.directory   'features'
+      m.file        'subscription.feature',       'features/subscription.feature'
+      
+      m.directory   'features/step_definitions'
+      m.file        'subscription_steps.rb',      'features/step_definitions/subscription_steps.rb'
+      
+      m.directory   'features/support'
+      m.file        'subscription_helpers.rb',    'features/support/subscription_helpers.rb'
+      m.file        'subscriber_helpers.rb',      'features/support/subscriber_helpers.rb'
+
+# cancel
+    end
+  end
+end

data/generators/saas_features/templates/subscriber_helpers.rb

@@ -0,0 +1,32 @@
+module SubscriberHelpers
+  
+  # change these as needed by your app
+  # e.g. i'm assuming here that User acts_as_subscriber
+  
+  def create_subscriber( options = {} )
+    args = {
+      :username => 'subscriber',
+      :password => 'secret',
+      :password_confirmation => 'secret',
+    }.merge( options )
+    args[:email] ||= "#{args[:username]}@example.com"
+    
+    subscriber = User.create!(args)
+    # :create syntax for restful_authentication w/ aasm. Tweak as needed.
+    # user.activate! 
+    subscriber
+  end
+
+  def log_in_subscriber
+    visit "/login" 
+    fill_in("user_session_username", :with => 'subscriber') 
+    fill_in("password", :with => 'secret') 
+    click_button("Log in")  
+  end  
+  
+  def find_subscriber
+    User.find_by_username('subscriber')
+  end  
+end
+
+World(SubscriberHelpers)

data/generators/saas_features/templates/subscription.feature

@@ -0,0 +1,89 @@
+Feature: Subscription
+  In order to use subscription based services
+	As a subscriber
+  I want to maintain my subscription
+
+  Scenario: As a new user, my subscription page says I have a free account
+    Given a "free" subscriber is logged in
+		When I go to my subscription page
+		Then I should see "Free"
+		And I should see "(no credit card on file)"
+    #And show me the page
+  
+	Scenario: I have a free account and sign up for a paid plan
+		Given a "free" subscriber is logged in
+		When I go to my plan page
+		#And show me the page
+		And I select "basic" from "Plan"
+		And I press "Change Plan"
+		#And show me the page		
+		Then I should be on my subscription page
+		And I should see "Basic ($10.00 per month)"
+		And I should see "Trial"
+		And the subscription should have next renewal in 30 days
+		
+  Scenario: I add credit card info
+		Given a "basic" subscriber who is in trial, with next renewal in 3 days, and profile has no info
+		When the subscriber logs in
+		And I go to my subscription page
+		Then I should see "(no credit card on file)"
+		When I press "Update Credit Card"
+		And I fill out the credit card form correctly
+		And I press "Submit"
+		#And show me the page
+		Then I should be on my subscription page
+		And I should see "Credit card info successfully updated. No charges have been made at this time."
+		And I should see "Bogus XXXX-XXXX-XXXX-1 Expires: 2012-10-31"
+		And the profile should be "authorized"
+	
+	Scenario: Subscription is past due, I update credit card info
+		Given a "basic" subscriber who is past due, with next renewal 3 days ago, and profile has an error
+		When the subscriber logs in
+		And I go to my subscription page
+		#And show me the page
+		Then I should see "There was an error processing your credit card"
+		When I press "Update Credit Card"
+		And I fill out the credit card form correctly
+		And I press "Submit"
+		#And show me the page
+		Then I should be on my subscription page
+		And I should see "Thank you for your payment. Your credit card has been charged $10.00"
+		And I should see "Bogus XXXX-XXXX-XXXX-1 Expires: 2012-10-31"
+		And the profile should be "authorized"
+		And a "charge" transaction should be created
+		And the next renewal should be set to "original renewal plus 1 month"
+	
+	Scenario: I can see my transaction history
+		Given a "basic" subscriber who is in trial, with next renewal is today, and profile has no info
+		When the subscriber logs in
+		And I go to my credit card page
+		And I fill out the credit card form correctly
+		And I press "Submit"
+		Then I should be on my subscription page
+		When I follow "History"
+		#And show me the page
+		Then I should see "Charge $10.00"
+		And I should see "Store"
+	
+	Scenario: I upgrade to a higher cost plan
+	  Given a "basic" subscriber who is active, with next renewal in 15 days, and profile is authorized
+		When the subscriber logs in
+		And I go to my plan page
+		And I select "pro" from "Plan"
+		And I press "Change Plan"
+		#And show me the page		
+		Then I should be on my subscription page
+		And I should see "Your credit card has been charged $295.00"
+		And I should see "Pro"
+		And I should see "Active"
+		And the subscription should have next renewal in 1 year
+		
+	Scenario: I cancel my account
+	  Given a "basic" subscriber who is active, with next renewal in 15 days, and profile is authorized
+		When the subscriber logs in
+		And I go to my plan page
+		And I follow "I want to cancel my subscription"
+	  #And show me the page
+		Then I should see "Your subscription has been canceled"
+		And I should see "Free"
+		And I should see "$-5.00"

data/generators/saas_features/templates/subscription_helpers.rb

@@ -0,0 +1,65 @@
+module SubscriptionHelpers
+
+  def set_subscription_state( subscriber, text )
+    unless ['pending', 'free', 'trial', 'active', 'past due'].include? text
+      puts "bad case in set_current_subscription_text"
+      return
+    end
+    subscriber.subscription.state = text.gsub(' ','_')
+    # past due will have a balance due, so set it to the plan rate
+    subscriber.subscription.balance = subscriber.subscription.plan.rate if subscriber.subscription.past_due?
+    # assume active and past due were created more than 30 days ago
+    subscriber.subscription.created_at = Time.zone.now - 60.days
+    subscriber.subscription.save
+  end
+
+  def set_renewal( subscriber, text )
+    subscriber.subscription.next_renewal_on = text_to_date(text)
+    subscriber.subscription.save
+  end
+
+  def set_profile_state( subscriber, text )
+    profile = subscriber.subscription.profile || subscriber.subscription.build_profile
+    case text
+    when /no info/
+      profile.state = 'no_info'
+    when /authorized/, /error/
+      params = SubscriptionProfile.example_credit_card_params
+      profile.credit_card = params
+  	  #profile.request_ip = request.remote_ip
+  	  ok = profile.save
+  	  ok.should be_true
+      if text =~ /error/
+        profile.state = 'error'
+        profile.save
+      end
+    else
+      puts 'bad case in set_current_profile_state'
+    end
+    profile.save
+  end
+
+  def text_to_date(text)
+    today = Time.zone.today
+    case text
+    when /original renewal plus 1 month/
+      @original_renewal + 1.month
+    when /today/
+      today
+    when /in (\d+) days/
+      today + ($1).to_i.days
+    when /(\d+) days ago/
+      today - ($1).to_i.days
+    when /in 1 month/
+      today + 1.month
+    when /in 1 year/
+      today + 1.year
+    when "blank"
+      nil
+    else
+      puts 'bad case in text_to_date'
+    end
+  end
+end
+
+World(SubscriptionHelpers)

data/generators/saas_features/templates/subscription_steps.rb

@@ -0,0 +1,74 @@
+Given /^a "(.*)" subscriber$/ do |plan|
+  create_subscriber( :username => 'subscriber', :subscription_plan => plan )
+end
+
+Given /^a "(.*)" subscriber is logged in$/ do |plan|
+  create_subscriber( :username => 'subscriber', :subscription_plan => plan )
+  log_in_subscriber
+end
+
+Given /^a "(.*)" subscriber who is (in trial|active|past due|expired), with next renewal (.*), and profile (has no info|is authorized|has an error)$/ do |plan, subs_state, date_text, profile_state |
+	#Example: Given a "basic" subscriber who is in trial, next renewal is in 3 days, and profile has no info
+  subscriber = create_subscriber( :username => 'subscriber', :subscription_plan => plan )
+  set_subscription_state( subscriber, subs_state )
+  set_renewal( subscriber, date_text )
+  set_profile_state( subscriber, profile_state )
+  # beware this is not safe in all scenarios
+  @original_renewal = subscriber.subscription.next_renewal_on
+end
+
+When /^the subscriber logs in$/ do
+  log_in_subscriber
+end
+
+When /^I fill out the credit card form (correctly|with errors|with invalid card)$/ do |what|
+  case what
+  when 'correctly'
+    params = SubscriptionProfile.example_credit_card_params
+  when 'with errors'
+    params = SubscriptionProfile.example_credit_card_params( :first_name => '')
+  when 'with invalid card'
+    params = SubscriptionProfile.example_credit_card_params( :number => '2')
+  else
+    puts 'step error: unknown "what"'
+  end
+  params.each do |field, value|
+    name = "profile_credit_card_#{field}" #assuming view as form_for :profile ... form.feldsfor :credit_card
+    begin
+      select value, :from => name
+    rescue
+      fill_in name, :with => value
+    end
+  end
+end
+
+Then /^the subscription should be a "(.*)" plan$/ do |plan|
+  subscriber = find_subscriber
+  subscriber.subscription_plan.name.should == plan
+end
+
+Then /^the subscription should be in a "(.*)" state$/ do |state|
+  subscriber = find_subscriber
+  subscriber.subscription.state.should == state
+end
+  
+Then /^the subscription should have next renewal (.*)$/ do |value|
+  subscriber = find_subscriber
+  subscriber.subscription.next_renewal_on.should == text_to_date(value)
+end
+
+Then /^the profile should be "(no info|authorized|error)"$/ do |state|
+  subscriber = find_subscriber
+  subscriber.subscription.profile.state.to_s.should == state.downcase
+end
+
+Then /^a "(validate|store|update|unstore|charge|credit|refund)" transaction should be created$/ do |action|
+  subscriber = find_subscriber
+  subscriber.subscription.latest_transaction.action.should == action
+end
+
+Then /^the next renewal should be set to "(.*)"$/ do |text|
+  subscriber = find_subscriber
+  subscriber.subscription.next_renewal_on.should == text_to_date(text)
+end
+

data/generators/saas_features/templates/user_steps.rb

@@ -0,0 +1,33 @@
+Given /^a user "(.*)"$/ do |username|
+  @current_user = create_user( :username => username )
+end
+
+When /^I log in as "(.*)"$/ do |username|
+  log_in_as username
+end
+
+Given /^a user is logged in as "(.*)"$/ do |username|
+  @current_user = create_user( :username => username )
+  log_in_as username
+end
+
+
+def create_user( options = {} )
+  args = {
+    :username => 'subscriber',
+    :password => 'secret',
+    :password_confirmation => 'secret',
+  }.merge( options )
+  args[:email] ||= "#{args[:username]}@example.com"
+  user = User.create!(args)
+  # :create syntax for restful_authentication w/ aasm. Tweak as needed.
+  # user.activate! 
+  user
+end
+
+def log_in_as( username )
+  visit "/login" 
+  fill_in("user_session_username", :with => username) 
+  fill_in("password", :with => 'secret') 
+  click_button("Log in")  
+end  

data/generators/saas_migration/USAGE

@@ -0,0 +1 @@
+./script/generate saas_migration

data/generators/saas_migration/saas_migration_generator.rb

@@ -0,0 +1,12 @@
+class SaasMigrationGenerator < Rails::Generator::NamedBase
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args.insert(0, 'migrations')
+    super
+  end
+
+  def manifest
+    record do |m|
+      m.migration_template "migration.rb", "db/migrate", :migration_file_name => "create_subscription_etc"
+    end
+  end
+end

data/generators/saas_migration/templates/migration.rb

@@ -0,0 +1,67 @@
+class CreateSubscriptionEtc < ActiveRecord::Migration
+  def self.up
+    create_table :subscription_plans, :force => true do |t|
+      t.string  :name,                    :null => false
+      t.integer :rate_cents,              :default => 0
+      t.integer :interval,                :default => 1
+      t.timestamps
+      
+      # add app-specific resource limitations, e.g.
+      # t.integer :max_users
+      # t.integer :max_memory
+      # t.integer :telephone_support
+      # NOTE: Should also add to subcriptions table if you want to change settings per account 
+      
+    end
+    
+    create_table :subscriptions, :force => true do |t|
+      t.integer :subscriber_id,           :null => false
+      t.string  :subscriber_type,         :null => false      
+      t.integer :plan_id
+      t.string  :state
+      t.date    :next_renewal_on
+      t.integer :warning_level
+      t.integer :balance_cents,           :default => 0
+      t.timestamps
+    end
+    
+    create_table :subscription_profiles, :force => true do |t|
+      t.integer :subscription_id
+      t.string  :state
+      t.string  :profile_key,             :null => true
+      t.string  :card_first_name
+      t.string  :card_last_name
+      t.string  :card_type
+      t.string  :card_display_number
+      t.date    :card_expires_on
+      # could also add address columns if required by your gateway
+      t.timestamps
+    end
+    
+    create_table :subscription_transactions, :force => true do |t|
+      t.integer :subscription_id,         :null => false
+      t.integer :amount_cents
+      t.boolean :success
+      t.string  :reference
+      t.string  :message
+      t.string  :action
+      t.text    :params
+      t.boolean :test
+      t.timestamps
+    end
+    
+    # indexes
+    add_index :subscriptions, :subscriber_id
+    add_index :subscriptions, :subscriber_type
+    add_index :subscriptions, :state
+    add_index :subscriptions, :next_renewal_on
+    
+  end
+
+  def self.down
+    drop_table :subscription_profiles
+    drop_table :subscription_transactions
+    drop_table :subscriptions
+    drop_table :subscription_plans
+  end
+end

data/generators/saasramp/USAGE

@@ -0,0 +1,12 @@
+Description:
+    This generator bootstraps a Rails project for use with SaasRamp
+
+Example:
+    ./script/generate saasramp
+
+This will create:
+    config/subscription.yml										editable configuration file
+	  config/initializers/subscription.rb				initializer
+	  db/subscription_plans.yml
+	  config/initializers/active_merchant/
+	      

data/generators/saasramp/lib/insert_commands.rb

@@ -0,0 +1,54 @@
+# adapted from Ryan Bates nifty generators
+
+Rails::Generator::Commands::Create.class_eval do
+  def route_resource_x(resource, options)
+    resource_list = [resource.to_sym.inspect, options.inspect].join(', ')
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resource #{resource_list}\n"
+      end
+    end
+  end
+  
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+    unless options[:pretend]
+      gsub_file file, /^(class|module) .+$/ do |match|
+        "#{match}\n  #{line}"
+      end
+    end
+  end
+  
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def route_resource_x(resource, options)
+    resource_list = [resource.to_sym.inspect, options.inspect].join(', ')
+    look_for = "\n  map.resource #{resource_list}\n"
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+
+  def insert_into(file, line)
+    logger.remove "#{line} from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n  #{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def route_resource_x(resource, options)
+    resource_list = [resource.to_sym.inspect, options.inspect].join(', ')
+    logger.route "map.resource #{resource_list}"
+  end
+
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+  end
+end

data/generators/saasramp/saasramp_generator.rb

@@ -0,0 +1,23 @@
+# this generator bootstraps a Rails project for use with SaasRamp
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+class SaasrampGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory 'config'
+      m.file      'subscription.yml',                     'config/subscription.yml'
+
+      m.directory 'db'
+      m.file      'subscription_plans.yml',               'db/subscription_plans.yml'
+      
+      m.directory 'config/initializers'
+      m.file      'subscription.rb',                      'config/initializers/subscription.rb'
+
+      m.directory 'config/initializers/active_merchant'
+      m.file      'active_merchant/bogus.rb',             'config/initializers/active_merchant/bogus.rb'
+      m.file      'active_merchant/braintree.rb',         'config/initializers/active_merchant/braintree.rb'
+      m.file      'active_merchant/authorizenetcim.rb',   'config/initializers/active_merchant/authorizenetcim.rb'
+      
+      m.insert_into 'app/controllers/application_controller.rb', 'filter_parameter_logging :credit_card'       
+    end
+  end
+end

data/generators/saasramp/templates/active_merchant/authorizenetcim.rb

@@ -0,0 +1,272 @@
+# this file represents major hacking on the gateway, culled from various sources
+# hopefully we'll integrate it into the Authorize.net gateway itself and eliminate this gorilla monkey patching
+# references:
+#   http://gist.github.com/147194
+#  https://jadedpixel.lighthouseapp.com/projects/11599/tickets/111-void-refund-and-auth_capture-for-authorizenets-cim-gateway#ticket-111-1
+
+include ActiveMerchant::Billing
+require 'digest/sha1'
+
+class AuthorizeNetCimResponse < ActiveMerchant::Billing::Response
+  def token
+    @authorization || 
+    (@params['direct_response']['transaction_id'] if @params && @params['direct_response'])
+  end
+end
+
+ActiveMerchant::Billing::AuthorizeNetCimGateway::Response = AuthorizeNetCimResponse
+
+class ActiveMerchant::Billing::AuthorizeNetCimGateway
+# module ActiveMerchant #:nodoc:
+#   module Billing #:nodoc:
+#     class AuthorizeNetCimGateway < Gateway
+
+  # redefine constant (bleh)
+  silence_warnings do
+    CIM_TRANSACTION_TYPES = {
+      :auth_capture => 'profileTransAuthCapture',
+      :auth_only => 'profileTransAuthOnly',
+      :capture_only => 'profileTransCaptureOnly',
+      # adding this
+      :void => 'profileTransVoid',
+      :refund => 'profileTransRefund'
+    }
+  end
+
+  # NOTE TO SELF: this gateway has a validate_customer_payment_profile action 
+  # It requires the profile id (and billing id) exists, so its for validating an existing profile
+  # Thus, cannot be used to validate a card -before- storing it (as saasramp expects in SubscriptionTransaction#validate_card)
+
+  # Create a payment profile
+  def store(creditcard, options = {})
+    profile = {
+      :payment_profiles => {
+        :payment => { :credit_card => creditcard }
+      }
+    }
+    profile[:payment_profiles][:bill_to] = options[:billing_address] if options[:billing_address]
+    profile[:ship_to_list] = options[:shipping_address] if options[:shipping_address]
+
+    # CIM actually does require a unique ID to be passed in, 
+    # either merchant_customer_id or email, so generate it, if necessary
+    if options[:billing_id]
+      profile[:merchant_customer_id] = options[:billing_id]
+    elsif options[:email]
+      profile[:email] = options[:email]
+    else
+      profile[:merchant_customer_id] = Digest::SHA1.hexdigest("#{creditcard.number}#{Time.now.to_i}").first(20)
+    end
+
+    #create_customer_profile(:profile => profile)
+    create_customer_profile( {
+      :ref_id => rand(1_000_000),
+      :profile => profile
+    })
+  end
+
+  # Update an existing payment profile
+  def update(billing_id, creditcard, options = {})
+    if (response = get_customer_profile(:customer_profile_id => billing_id)).success?
+      update_customer_payment_profile(
+        :customer_profile_id => billing_id,
+        :payment_profile => {
+          :customer_payment_profile_id => response.params['profile']['payment_profiles']['customer_payment_profile_id'],
+          :payment => {
+            :credit_card => creditcard
+          }
+        }.merge(options[:billing_address] ? {:bill_to => options[:billing_address]} : {})
+      )
+    else
+      response
+    end
+  end
+
+  # Run an auth and capture transaction against the stored CC
+  def purchase(money, billing_id, options = {})
+    if (response = get_customer_profile(:customer_profile_id => billing_id)).success?
+      create_customer_profile_transaction( options.merge(
+        :transaction => { 
+          :customer_profile_id => billing_id, 
+          :customer_payment_profile_id => response.params['profile']['payment_profiles']['customer_payment_profile_id'], 
+          :type => :auth_capture, :amount => amount(money) 
+        }
+      ))
+    else
+      response
+    end
+  end
+
+  # authorize
+  def authorize(money, billing_id, options = {})
+    if (response = get_customer_profile(:customer_profile_id => billing_id)).success?
+      create_customer_profile_transaction( options.merge(
+        :transaction => { 
+          :customer_profile_id => billing_id, 
+          :customer_payment_profile_id => response.params['profile']['payment_profiles']['customer_payment_profile_id'], 
+          :type => :auth_only, :amount => amount(money) 
+        }
+      ))
+    else
+      response
+    end
+  end
+
+  # void
+  def void(money, trans_id, options = {})
+      create_customer_profile_transaction(
+        :transaction => { 
+          :type => :void,
+          :trans_id => trans_id
+        }
+      )
+  end
+
+  # refund (against a previous transaction) (options  { :amount => money })
+  def refund(trans_id, options)
+    money = options.delete(:amount)
+    billing_id = options.delete(:billing_id)
+    if (response = get_customer_profile(:customer_profile_id => billing_id)).success?
+      create_customer_profile_transaction(
+        :transaction => { 
+          :customer_profile_id => billing_id, 
+          :customer_payment_profile_id => response.params['profile']['payment_profiles']['customer_payment_profile_id'], 
+        
+          :type => :refund, 
+          :trans_id => trans_id,
+          :amount => amount(money) 
+        }
+      )
+    else
+      response
+    end
+  end
+
+  # credit (is a refund without the trans_id) 
+  # Requires Special Permission, Is not recommended by Authorize.net
+  # def credit(money, billing_id)
+  #   if (response = get_customer_profile(:customer_profile_id => billing_id)).success?
+  #     create_customer_profile_transaction(
+  #       :transaction => { 
+  #         :customer_profile_id => billing_id, 
+  #         :customer_payment_profile_id => response.params['profile']['payment_profiles']['customer_payment_profile_id'], 
+  #         :type => :refund, :amount => amount(money) 
+  #       }
+  #     )
+  #   else
+  #     response
+  #   end
+  # end
+
+  # Destroy a customer profile
+  def unstore(billing_id, options = {})
+    delete_customer_profile(:customer_profile_id => billing_id)
+  end
+
+  def create_customer_profile_transaction(options)
+    requires!(options, :transaction)
+    requires!(options[:transaction], :type)
+    case options[:transaction][:type]
+      when :void
+        requires!(options[:transaction], :trans_id)
+      when :refund
+        requires!(options[:transaction], :trans_id) &&
+          (
+            (options[:transaction][:customer_profile_id] && options[:transaction][:customer_payment_profile_id]) ||
+            options[:transaction][:credit_card_number_masked] ||
+            (options[:transaction][:bank_routing_number_masked] && options[:transaction][:bank_account_number_masked]) 
+          )
+      when :prior_auth_capture
+        requires!(options[:transaction], :amount, :trans_id)
+      else
+        requires!(options[:transaction], :amount, :customer_profile_id, :customer_payment_profile_id)
+    end
+    request = build_request(:create_customer_profile_transaction, options)
+    commit(:create_customer_profile_transaction, request)
+  end
+  
+  def create_customer_profile_transaction_for_refund(options)
+    requires!(options, :transaction)
+    options[:transaction][:type] = :refund
+    requires!(options[:transaction], :trans_id)
+    requires!(options[:transaction], :amount)
+
+    request = build_request(:create_customer_profile_transaction, options)
+    commit(:create_customer_profile_transaction, request)
+  end
+  
+  
+  def tag_unless_blank(xml, tag_name, data)
+    xml.tag!(tag_name, data) unless data.blank? || data.nil?
+  end
+
+  def add_transaction(xml, transaction)
+    unless CIM_TRANSACTION_TYPES.include?(transaction[:type])
+      raise StandardError, "Invalid Customer Information Manager Transaction Type: #{transaction[:type]}"
+    end
+    
+    xml.tag!('transaction') do
+      xml.tag!(CIM_TRANSACTION_TYPES[transaction[:type]]) do
+        # The amount to be billed to the customer
+        case transaction[:type]
+          when :void
+            tag_unless_blank(xml,'customerProfileId', transaction[:customer_profile_id])
+            tag_unless_blank(xml,'customerPaymentProfileId', transaction[:customer_payment_profile_id]) 
+            tag_unless_blank(xml,'customerShippingAddressId', transaction[:customer_shipping_address_id]) 
+            xml.tag!('transId', transaction[:trans_id])
+          when :refund
+            #TODO - add support for all the other options fields
+            xml.tag!('amount', transaction[:amount])
+            tag_unless_blank(xml, 'customerProfileId', transaction[:customer_profile_id])
+            tag_unless_blank(xml, 'customerPaymentProfileId', transaction[:customer_payment_profile_id]) 
+            tag_unless_blank(xml, 'customerShippingAddressId', transaction[:customer_shipping_address_id]) 
+            tag_unless_blank(xml, 'creditCardNumberMasked', transaction[:credit_card_number_masked])
+            tag_unless_blank(xml, 'bankRoutingNumberMasked', transaction[:bank_routing_number_masked])
+            tag_unless_blank(xml, 'bankAccountNumberMasked', transaction[:bank_account_number_masked])
+            xml.tag!('transId', transaction[:trans_id])
+          when :prior_auth_capture
+            xml.tag!('amount', transaction[:amount])
+            xml.tag!('transId', transaction[:trans_id])
+          else
+            xml.tag!('amount', transaction[:amount])
+            xml.tag!('customerProfileId', transaction[:customer_profile_id])
+            xml.tag!('customerPaymentProfileId', transaction[:customer_payment_profile_id])
+            xml.tag!('approvalCode', transaction[:approval_code]) if transaction[:type] == :capture_only
+        end
+        add_order(xml, transaction[:order]) if transaction[:order]
+      end
+    end
+  end
+  
+  def parse_direct_response(response)
+    direct_response = {'raw' => response.params['direct_response']}
+    direct_response_fields = response.params['direct_response'].split(',')
+
+    #keep this backwards compatible but add new direct response fields using
+    #field names from the AIM guide spec http://www.authorize.net/support/AIM_guide (around page 29)
+    dr_hash = {
+        'message' => direct_response_fields[3],
+        'approval_code' => direct_response_fields[4],
+        'invoice_number' => direct_response_fields[7],
+        'order_description' => direct_response_fields[8],
+        'amount' => direct_response_fields[9],
+        'transaction_type' => direct_response_fields[11],
+        'purchase_order_number' => direct_response_fields[36]
+      }
+       
+      dr_arr = %w(response_code response_subcode response_reason_code response_reason_text
+        authorization_code avs_response transaction_id invoice_number description amount
+        method transaction_type customer_id first_name last_name company address
+        city state zip_code country phone fax email-address ship_to_first_name
+        ship_to_last_name ship_to_company ship_to_address ship_to_city ship_to_state 
+        ship_to_zip_code ship_to_country tax duty freight tax_exempt purchase_order_number
+        md5_hash card_code_response cardholder_authentication_verification_response
+        )
+      dr_arr.each do |f|
+        dr_hash[f] = direct_response_fields[dr_arr.index(f)] 
+      end
+      direct_response.merge(dr_hash)
+  end
+  
+end
+
+

data/generators/saasramp/templates/active_merchant/bogus.rb

@@ -0,0 +1,48 @@
+# monkeypatch the gateway
+include ActiveMerchant::Billing
+
+class ActiveMerchant::Billing::Response
+#class BogusResponse < ActiveMerchant::Billing::Response
+  def token
+    @params.stringify_keys['billingid']
+  end
+end
+
+class ActiveMerchant::Billing::BogusGateway
+# module ActiveMerchant #:nodoc:
+#   module Billing #:nodoc:
+#     class Bogus < Gateway
+  
+  # handle billingid in addition to credit card
+  def purchase(money, ident, options = {})
+    number = ident.is_a?(ActiveMerchant::Billing::CreditCard) ? ident.number : ident
+    case number
+    when '1'
+      ActiveMerchant::Billing::Response.new(true, SUCCESS_MESSAGE, 
+        {:authorized_amount => money.to_s}, :test => true, :authorization => AUTHORIZATION )
+    when '2'
+      ActiveMerchant::Billing::Response.new(false, FAILURE_MESSAGE, 
+        {:authorized_amount => money.to_s, :error => FAILURE_MESSAGE }, :test => true)
+    else
+      raise Error, ERROR_MESSAGE
+    end      
+  end
+  
+  # fix apparent blantant bug in bogus.rb
+  def credit(money, ident, options = {})
+    case ident
+    when '1'
+      Response.new(true, SUCCESS_MESSAGE, 
+        {:paid_amount => money.to_s}, :test => true)
+    when '2'
+      Response.new(false, FAILURE_MESSAGE, 
+        {:paid_amount => money.to_s, :error => FAILURE_MESSAGE }, :test => true)
+    else
+      raise Error, ERROR_MESSAGE
+    end
+  end  
+  
+# end
+# end
+end
+

data/generators/saasramp/templates/active_merchant/braintree.rb

@@ -0,0 +1,16 @@
+# monkeypatch the gateway
+include ActiveMerchant::Billing
+
+class BraintreeResponse < ActiveMerchant::Billing::Response
+  def token
+    @params["customer_vault_id"]
+  end
+end
+
+begin
+  # HEAD
+  ActiveMerchant::Billing::SmartPs::Response = BraintreeResponse
+rescue NameError
+  # 1.4.2
+  ActiveMerchant::Billing::BraintreeGateway::Response = BraintreeResponse
+end

data/generators/saasramp/templates/subscription.rb

@@ -0,0 +1,10 @@
+ActiveMerchant::Billing::Base.mode = :test if SubscriptionConfig.test
+
+gateway_args = {
+  :login    => SubscriptionConfig.login, 
+  :password => SubscriptionConfig.password
+}.merge( (SubscriptionConfig.gateway_options rescue {}) )
+
+SubscriptionConfig.gateway = ActiveMerchant::Billing::Base.gateway(SubscriptionConfig.gateway_name).new( gateway_args )
+
+SubscriptionConfig.validate_via_transaction = false if SubscriptionConfig.bogus?

data/generators/saasramp/templates/subscription.yml

@@ -0,0 +1,53 @@
+defaults: &defaults
+  # default plan (name) when user has no subscription. Defaults to the first plan with rate==0. Must be a plan with rate==0 since no billing occurs. 
+  default_plan: free
+  
+  # what plan (name) to assign to subscriptions that have expired (may be nil) (defaults to default_plan). Must be a plan with rate==0 since no billing occurs. 
+  expired_plan: free
+
+  # trial period length (days) before first billing (can be 0 for no trial) (default = 30)
+  trial_period: 30
+  
+  # grace period length (days) after subscription is past due before it is expired (closed down)
+  grace_period: 7
+  
+  # define the mailer class name to use (default SubscriptionMailer provided with plugin)
+  mailer_class: SubscriptionMailer
+      
+  # where to send admin reports (nil for no emails)
+  admin_report_recipients: jonathan@parkerhill.com
+  
+  # shortcut configuration of the ActiveMerchant gateway
+  #  test sets the Billing mode
+  test: true
+  
+  #  gateway is the name of the gateway, passed to ActiveMerchant::Billing::Base.gateway(name)
+  gateway_name: braintree
+  
+  # login credentials to the gateway
+  login: testapi
+  password: password1
+  
+  # other options passed to #new when initializing the gateway
+  # gateway_options: 
+  #   foo: bar
+  #   baz: bam
+  
+  # when true then card is validated by authorizing for $1 (and then void) [always false for bogus gateway]
+  validate_via_transaction: true
+  
+development:
+  <<: *defaults
+  gateway_name: bogus
+
+test:
+  <<: *defaults
+  gateway_name: bogus
+  
+cucumber:
+  <<: *defaults
+  gateway_name: bogus
+    
+production:
+  <<: *defaults  
+  test: false

data/generators/saasramp/templates/subscription_plans.yml

@@ -0,0 +1,33 @@
+defaults: &defaults
+  # Note, this is seed data, changes here are not used at runtime, 
+  # must run "rake subscription:plans" to load them into the database. 
+  # But you can change this and re-run the rake task to update the database.
+  # If you've added any app-specific limits to plans you can add them here
+  #   name: name of the plan (required)
+  #   rate_cents: cost of the plan in cents (0 or nil is free)
+  #   interval: rate is for number of months (default 1). For example, an annual fee @ $25/month would have rate_cents: 30000 and interval: 12
+  #   other attributes: are app-specific, be sure you've added them to the SubscriptionPlan migration 
+  plans:
+    - name: free
+      rate_cents: 0
+    
+    - name: basic
+      rate_cents: 1000
+      #foo: bar
+    
+    - name: pro
+      rate_cents: 30000
+      interval: 12
+      #foo: baz
+    
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+cucumber:
+  <<: *defaults
+  
+production:
+  <<: *defaults

data/lib/engine.rb

@@ -0,0 +1,27 @@
+require 'saas'
+require 'rails'
+
+module Saas
+  class Engine < Rails::Engine
+
+    # Config defaults
+    config.mount_at = '/'
+
+    # Load rake tasks
+    #rake_tasks do
+    #  load File.join(File.dirname(__FILE__), 'rails/railties/tasks.rake')
+    #end
+
+    # Check the gem config
+    initializer "check config" do |app|
+
+      # make sure mount_at ends with trailing slash
+      config.mount_at += '/'  unless config.mount_at.last == '/'
+    end
+
+    #initializer "static assets" do |app|
+    #  app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    #end
+
+  end
+end

data/lib/saas.rb

@@ -0,0 +1,88 @@
+# acts_as_subscriber
+module Saas           #:nodoc:
+  require 'engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+
+  module Acts                 #:nodoc:
+    module Subscriber         #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        def acts_as_subscriber(options = {})
+          # when subscriber is using acts_as_paranoid, we'll destroy subscription (and its children) only when really really destroyed
+          if self.respond_to?(:paranoid?) && self.paranoid?
+            has_one :subscription, :as => :subscriber
+          else
+            has_one :subscription, :as => :subscriber, :dependent => :destroy
+          end
+          validates_associated :subscription
+
+          after_save :control_subscription
+
+          include Saas::Acts::Subscriber::InstanceMethods
+          extend Saas::Acts::Subscriber::SingletonMethods
+        end
+      end
+      
+      module SingletonMethods
+      end
+      
+      module InstanceMethods
+        # delegate for easier user forms
+        # for example, to sign up params[:user] => { :username => 'foo', :subscription_plan => '2', etc. }
+        attr_accessor :subscription_plan
+        
+  		  def subscription_plan=(plan)
+ 		      # arg can be object or id or name
+ 		      @newplan = case
+ 		        when plan.is_a?(SubscriptionPlan) then  plan
+ 		        when plan.to_i > 0 then              SubscriptionPlan.find_by_id(plan)
+ 		        else                                SubscriptionPlan.find_by_name(plan)
+ 		      end
+ 		      # not just change the attribute, really switch plans
+ 		      subscription.change_plan @newplan unless subscription.nil?
+  			end
+  			
+  			def subscription_plan
+  			  subscription.plan if subscription
+  		  end
+  		  
+  		  # overwrite this method
+  		  # compare subscriber to the plan's limits
+  		  # return a blank value if ok (nil, false, [], {}), anything else means subscriber has exceeded limits
+  		  # maybe should make this a callback option to acts_as_subscriber
+  		  def subscription_plan_check(plan)
+  		    # example:
+          # exceeded = {}
+          # exceeded[:memory_used] = plan.max_memory if subscriber.memory_used > plan.max_memory
+          # exceeded[:file_count]  = plan.max_files  if subscriber.file_count > plan.max_files
+          # exceeded
+		    end
+
+		    # when acts_as_paranoid, only destroy dependents when i'm really getting destroyed
+		    # (this way we don't have to also make the dependents acts_as_paranoid)
+		    def destroy!
+		      self.subscription.destroy if self.class.respond_to?(:paranoid?) && self.class.paranoid? && self.subscription
+		      super
+	      end
+  		  
+        protected
+        
+        def control_subscription
+          # this is the best time to create the subscription
+          # because cannot build_subscription while self.id is still nil
+          if subscription.nil?
+            self.create_subscription
+            self.subscription.change_plan @newplan if @newplan
+          end
+        end
+      end
+      
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include Saas::Acts::Subscriber
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saas
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-24 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &83443350 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *83443350
+date: 2012-02-25 00:00:00.000000000Z
+dependencies: []
 description: SaaS gem
 email:
 - info@luisperichon.com.ar
@@ -48,6 +37,27 @@ files:
 - app/models/subscription_config.rb
 - app/models/subscription_profile.rb
 - app/models/subscription_observer.rb
+- lib/engine.rb
+- lib/saas.rb
+- generators/saas_migration/saas_migration_generator.rb
+- generators/saas_migration/USAGE
+- generators/saas_migration/templates/migration.rb
+- generators/saasramp/saasramp_generator.rb
+- generators/saasramp/USAGE
+- generators/saasramp/templates/subscription.yml
+- generators/saasramp/templates/subscription.rb
+- generators/saasramp/templates/subscription_plans.yml
+- generators/saasramp/templates/active_merchant/bogus.rb
+- generators/saasramp/templates/active_merchant/braintree.rb
+- generators/saasramp/templates/active_merchant/authorizenetcim.rb
+- generators/saasramp/lib/insert_commands.rb
+- generators/saas_features/USAGE
+- generators/saas_features/templates/subscriber_helpers.rb
+- generators/saas_features/templates/subscription_steps.rb
+- generators/saas_features/templates/subscription_helpers.rb
+- generators/saas_features/templates/user_steps.rb
+- generators/saas_features/templates/subscription.feature
+- generators/saas_features/saas_features_generator.rb
 - README.rdoc
 homepage: http://luisperichon.com.ar
 licenses: []