servicemerchant 0.1.0

data/subscription_management/samples/freshbooks.yml

@@ -0,0 +1,78 @@
+# Tariff configuration for freshbooks
+# http://www.freshbooks.com/pricing.php
+#
+
+freshbooks:
+  features:
+    clients: &clients
+      name: Active Clients
+      description: "Number of clients available for management"
+    staff: &staff
+      name: Staff Members
+      description: "Number of staff members who can access an account"
+  payment_terms:
+    monthly: &monthly
+      name: Monthly payments
+      periodicity: 1m
+  services:
+    shuttle_bus: &shuttle_bus
+      name: Shuttle Bus
+      features:
+       - feature: *clients
+         quantity: 25
+       - feature: *staff
+         quantity: 1
+    limousine: &limousine
+      name: Limousine
+      features:
+       - feature: *clients
+         quantity: 100
+       - feature: *staff
+         quantity: 2
+    private_jet: &private_jet
+      name: Private Jet
+      features:
+       - feature: *clients
+         quantity: 500
+       - feature: *staff
+         quantity: 3
+    starship: &starship
+      name: Starship
+      features:
+       - feature: *clients
+         quantity: 2000
+       - feature: *staff
+         quantity: 10
+    time_machine: &time_machine
+      name: Time Machine
+      features:
+       - feature: *clients
+         quantity: 5000
+       - feature: *staff
+         quantity: 20
+  tariff_plans:
+    shuttle_bus_monthly:
+      service: *shuttle_bus
+      payment_term: *monthly
+      currency: USD
+      price: 1400
+    limousine_monthly:
+      service: *limousine
+      payment_term: *monthly
+      currency: USD
+      price: 2700
+    private_jet_monthly:
+      service: *private_jet
+      payment_term: *monthly
+      currency: USD
+      price: 3900
+    starship_monthly:
+      service: *starship
+      payment_term: *monthly
+      currency: USD
+      price: 8900
+    time_machine_monthly:
+      service: *time_machine
+      payment_term: *monthly
+      currency: USD
+      price: 14900

data/subscription_management/samples/highrise.yml

@@ -0,0 +1,100 @@
+# Tariff configuration for highrise
+# http://www.highrisehq.com/signup
+#
+
+highrise:
+  features:
+    user: &user
+      name: User Accounts
+      description: "User accounts available within application"
+    storage: &storage
+      name: "File Storage"
+      unit: Gigabyte
+      description: "File storage maximum disk quota"
+    case: &case
+      name: Cases
+      description: "Cases let you keep related people, companies, notes, files, and images together on a convenient single page."
+    contact: &contact
+      name: Contacts
+      descrption: "Contacts for an account"
+    ssl: &ssl
+      name: SSL Security
+      description: "Whether SSL encryption for online sessions is available or not"
+    free_campfire_premium: &free_campfire_premium
+      name: Free Campfore Premium
+      description: "Free Premium Campfire membership. Campfire is real-time group chat tool for businesses."
+  payment_terms:
+    monthly: &monthly
+      name: Monthly payments
+      periodicity: 1m
+      trial_days: 30
+  services:
+    solo: &solo
+      name: Solo
+      features:
+       - feature: *user
+         quantity: 1
+       - feature: *storage
+         quantity: 3
+       - feature: *contact
+         quantity: 20000
+       - feature: *case
+         quantity: 0
+       - feature: *ssl
+    basic: &basic
+      name: Basic
+      features:
+       - feature: *user
+         quantity: 6
+       - feature: *storage
+         quantity: 3
+       - feature: *contact
+         quantity: 5000
+       - feature: *case
+         quantity: 5
+    plus: &plus
+      name: Plus
+      features:
+       - feature: *user
+         quantity: 15
+       - feature: *storage
+         quantity: 10
+       - feature: *contact
+         quantity: 20000
+       - feature: *case
+         quantity: 0
+       - feature: *ssl
+    pro: &pro
+      name: Pro
+      features:
+       - feature: *user
+         quantity: 40
+       - feature: *storage
+         quantity: 20
+       - feature: *contact
+         quantity: 30000
+       - feature: *case
+         quantity: 0
+       - feature: *ssl
+       - feature: *free_campfire_premium
+  tariff_plans:
+    solo_monthly:
+      service: *solo
+      payment_term: *monthly
+      currency: USD
+      price: 2900
+    basic_monthly:
+      service: *basic
+      payment_term: *monthly
+      currency: USD
+      price: 2400
+    plus_monthly:
+      service: *plus
+      payment_term: *monthly
+      currency: USD
+      price: 4900
+    pro_monthly:
+      service: *pro
+      payment_term: *monthly
+      currency: USD
+      price: 9900

data/subscription_management/samples/presets.yml

@@ -0,0 +1,10 @@
+defaults:
+  payment_policies:
+    monthly: &default_monthly
+      name: Monthly payments
+      periodicity: 1m
+      description: Paid every month
+    yearly: &default_yearly
+      name: Annual payments
+      periodicity: 1y
+      description: Paid every year on the same day

data/subscription_management/samples/taxes.yml

@@ -0,0 +1,21 @@
+defaults:
+  gst: &gst
+    name: Goods and Services Tax
+  tax1: &tax1
+    name: Sample tax
+
+taxes:
+  ca:
+    name: non-resident, Canada
+    country: CA
+    state: *
+    taxes:
+      - tax: *gst
+        rate: 0.05
+  us_ca:
+    name: resident, CA
+    country: US
+    state: CA
+    taxes:
+      - tax: *tax1
+        rate: 0.2

data/subscription_management/subscription_management.rb

@@ -0,0 +1,7 @@
+#TODO: Use auto-loading from activesupport
+require 'rubygems'
+require 'activerecord'
+
+require File.dirname(__FILE__) + '/lib/models/subscription'
+require File.dirname(__FILE__) + '/lib/models/subscription_profile'
+require File.dirname(__FILE__) + '/lib/subscription_management'

data/subscription_management/tasks/schema.rb

@@ -0,0 +1,50 @@
+namespace :subscription do
+  desc 'Create Subscription management database tables'
+  task :create_tables => :connection do
+    ActiveRecord::Base.connection.create_table :subscriptions, :force => true do |t|
+      t.column :account_id,                 :string, :null => false
+      t.column :tariff_plan_id,             :string, :null => false
+      t.column :taxes_id,                   :string, :null => false
+      t.column :quantity,                   :integer, :null => false
+      t.column :currency,                   :string, :null => false
+      t.column :net_amount,                 :integer, :null => false
+      t.column :taxes_amount,               :integer, :null => false
+      t.column :periodicity,                :string, :null => false
+      t.column :starts_on,                  :date,   :null => false
+      t.column :ends_on,                    :date
+      t.column :status,                     :string, :null => false
+      t.column :created_at,                 :datetime, :null => false
+      t.column :updated_at,                 :datetime
+      t.column :deleted_at,                 :datetime
+    end
+    ActiveRecord::Base.connection.add_index :subscriptions, [ :account_id ], :name => 'ix_subscription_account'
+
+    ActiveRecord::Base.connection.create_table :subscription_profiles, :force => true do |t|
+      t.column :subscription_id, :integer,      :null => false
+      t.column :recurring_payment_profile_id, :integer, :null => false
+      t.column :created_at,                 :datetime, :null => false
+    end
+    ActiveRecord::Base.connection.add_index :subscription_profiles, [ :subscription_id ], :name => 'ix_subscription_profiles_subscription'
+  end
+
+  desc 'Drop Subscription management database tables'
+  task :drop_tables => :connection do
+    ActiveRecord::Base.connection.drop_table :subscription_profiles
+    ActiveRecord::Base.connection.drop_table :subscriptions
+  end
+
+  # Use Rails connection when appropriate or fallback to local test db
+  task :connection do
+    connected = false
+    begin
+      begin
+        connected = true if ActiveRecord::Base.connection
+      rescue ActiveRecord::ConenctionNotEstablished
+      end
+    rescue NameError # ActiveRecord not loaded
+    end
+    require File.dirname(__FILE__) + "/../test/connection" unless connected
+  end
+end
+
+

data/subscription_management/test/connection.rb

@@ -0,0 +1,10 @@
+# As we're not using Rails in tests, we have to establish DB conneciton ourselves
+require 'rubygems'
+gem 'activerecord'
+require 'activerecord'
+gem 'sqlite3-ruby'
+
+ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database  => (File.dirname(__FILE__) + "/../../tracker/db/test.db")
+)

data/subscription_management/test/remote/subscription_management_test.rb

@@ -0,0 +1,112 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+require 'money'
+
+class SubscriptionManagementRemoteTest < Test::Unit::TestCase
+
+  def setup
+    @sm = ::SubscriptionManagement.new(
+                  :tariff_plans_config => File.dirname(__FILE__) + '/../../samples/backpack.yml',
+                  :taxes_config => File.dirname(__FILE__) + '/../../samples/taxes.yml',
+                  :gateways_config => File.dirname(__FILE__) + '/../../../recurring_billing/test/fixtures.yml',
+                  :gateway => :paypal
+                  )
+  end
+
+  # Checks if there are no exceptions while manipulating class with legit data; based on demo.rb
+  def test_crud_is_working
+    options = {
+              :account_id => 'test_acc_id',
+              :account_country => 'US',
+              :account_state => 'CA',
+              :tariff_plan => 'solo_monthly',
+              :start_date => (Date.today + 1),
+              :quantity => 1,
+              :end_date => DateTime.new(2010, 12, 11)
+              }
+    credit_card = credit_card()
+    credit_card_2 = credit_card(4929838635250031, {:year => Time.now.year + 5})
+    credit_card_3 = credit_card(4929273971564532, {:year => Time.now.year + 3})
+
+    assert_raise StandardError do; @sm.get_active_profile(-1); end
+
+    subscription_id = @sm.subscribe(options)
+    assert_equal 'pending', Subscription.find_by_id(subscription_id).status
+    assert_raise StandardError do; @sm.get_active_profile(subscription_id); end
+    @sm.pay_for_subscription(subscription_id, credit_card, {})
+    subscription = Subscription.find_by_id(subscription_id)
+    assert_equal 'ok', subscription.status
+    assert_equal 700, subscription.net_amount
+    assert_equal 140, subscription.taxes_amount
+    assert_equal 840, subscription.billing_amount
+
+    assert_equal 1, subscription.recurring_payment_profiles.length
+    profile = subscription.recurring_payment_profiles[0]
+    assert_equal 700, profile.net_amount
+    assert_equal 140, profile.taxes_amount
+    assert_equal 840, profile.amount
+
+    # create payment and check invoice
+    time = DateTime.now
+    transaction = Transaction.new({
+        :recurring_payment_profile_id => profile.id,
+        :gateway_reference => 'ABC0123456789XYZ',
+        :currency => 'USD',
+        :amount => 840,
+        :created_at => time
+        })
+    transaction.save!
+
+    invoice_data = @sm.get_invoice_data(transaction.id)
+    invoice_data[:date] = invoice_data[:date].strftime('%Y-%m-%d')
+
+    assert_equal({:taxes_comment    =>"resident, CA",
+                 :net_amount        =>"7.00 USD",
+                 :billing_account   =>"test_acc_id",
+                 :transaction_gateway=>"PAYPAL",
+                 :taxes_amount      =>"1.40 USD",
+                 :transaction_id    =>"ABC0123456789XYZ",
+                 :number            => transaction.id,
+                 :date              => time.strftime('%Y-%m-%d'),
+                 :transaction_amount=>"8.40 USD",
+                 :total_amount      =>"8.40 USD",
+                 :service_name      =>"Solo (per month)"
+                 },
+                invoice_data
+                )
+
+    transaction = Transaction.new({
+        :recurring_payment_profile_id => profile.id,
+        :gateway_reference => 'CAB0123456789ZYX',
+        :currency => 'CAD',
+        :amount => 840,
+        :created_at => Date.today
+        })
+    transaction.save!
+    assert_raises NotImplementedError do; @sm.get_invoice_data(transaction.id); end
+
+    transaction = Transaction.new({
+        :recurring_payment_profile_id => profile.id,
+        :gateway_reference => 'CAB0123456789ZYX',
+        :currency => 'USD',
+        :amount => 839,
+        :created_at => Date.today
+        })
+    transaction.save!
+    assert_raises NotImplementedError do; @sm.get_invoice_data(transaction.id); end
+
+    features = @sm.get_features(subscription_id)
+
+    options = {:card=>credit_card_2}
+    assert @sm.update_possible?(subscription_id, options)
+    @sm.update_subscription(subscription_id, options)
+
+    options = {:card=>credit_card_3, :start_date => Date.today + 42}
+    assert !@sm.update_possible?(subscription_id, options)
+    @sm.update_subscription(subscription_id, options)
+
+    @sm.unsubscribe(subscription_id)
+    assert_equal 'canceled', Subscription.find_by_id(subscription_id).status
+  end
+
+end

data/subscription_management/test/test_helper.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'test/unit'
+require 'activesupport'
+
+silence_warnings do
+  require 'active_merchant'
+end
+
+require File.dirname(__FILE__) + "/connection"
+require File.dirname(__FILE__) + '/../subscription_management'
+
+# Turn off invalid certificate crashes
+require 'openssl'
+silence_warnings do
+  OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+end
+
+ActiveMerchant::Billing::Base.mode = :test
+
+module Test
+  module Unit
+    class TestCase
+
+
+      DEFAULT_CREDENTIALS = File.dirname(__FILE__) + '/fixtures.yml'
+
+      private
+      def credit_card(number = '4242424242424242', options = {})
+        defaults = {
+          :number => number,
+          :month => 9,
+          :year => Time.now.year + 1,
+          :first_name => 'John',
+          :last_name => 'Doe',
+          :verification_value => '123',
+          :type => 'visa'
+        }.update(options)
+
+        ActiveMerchant::Billing::CreditCard.new(defaults)
+      end
+
+      def address(options = {})
+        {
+          :name => 'John Doe',
+          :address1 => '1234 My Street',
+          :address2 => 'Apt 1',
+          :company => 'Widgets Inc',
+          :city => 'Ottawa',
+          :state => 'ON',
+          :zip => 'K1C2N6',
+          :country => 'CA',
+          :phone => '(555)555-5555'
+        }.update(options)
+      end
+
+      def all_fixtures
+        @@fixtures ||= load_fixtures
+      end
+
+      def fixtures(key)
+        data = all_fixtures[key] || raise(StandardError, "No fixture data was found for '#{key}'")
+
+        data.dup
+      end
+
+      def load_fixtures
+        file = DEFAULT_CREDENTIALS
+        yaml_data = YAML.load(File.read(file))
+        symbolize_keys(yaml_data)
+
+        yaml_data
+      end
+
+      def symbolize_keys(hash)
+        return unless hash.is_a?(Hash)
+
+        hash.symbolize_keys!
+        hash.each{|k,v| symbolize_keys(v)}
+      end
+    end
+  end
+end