servicemerchant 0.1.0

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Tobias Luetke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.txt

@@ -0,0 +1,231 @@
+ServiceMerchant
+===============
+
+*Ruby toolkit for recurring billing and subscription management*
+
+ServiceMerchant is an open source library for Software-as-a-Service
+applications, based on subscription payments and various service
+plans.  The library consists of number of well-isolated and
+well-defined components, so that you may re-use portions of the
+library, should you find the full functionality not required for
+you. If you choose to use the library as whole, it should cover most
+of your payments requirements, thus being billing module for your
+application.
+
+ServiceMerchant's main purpose is providing gateway-independent
+support for recurring billing operations and powerful high-level tools
+for building subscription-based billing atop of it.  It is built on
+top of well-known [Active Merchant](http://www.activemerchant.org/)
+library.
+
+ServiceMerchant can be used both as a Rails plug-in or standalone Ruby
+library.  It is also possible to integrate ServiceMerchant with
+non-Ruby web applications via REST interface or common GUI.
+
+== Supported Gateways
+
+Currently [Authorize.Net](http://www.authorize.net/) and
+[Paypal Website Payments Pro (US)](https://www.paypal.com/cgi-bin/webscr?cmd=_wp-pro-overview-outside)
+are supported.
+
+Generally, if Active Merchant supports some gateway with recurring
+billing features then it is easy to add ServiceMerhant support as
+well.  In this case you'll only need to add a few lines of proxy code
+between Active Merchant and commont recurring billing API.
+
+== Components
+
+ServiceMerchant consists of three relatively independent components:
+
+=== Recurring Billing API
+
+Recurring Billing API is aimed at providing uniform interface for
+recurring billing features of payment gateways and making switching
+from one to another as painless as possible.
+
+=== Transaction Tracker
+
+Transactions Tracker stores local and readily available snapshots of
+so-called "recurring billing profiles".  With Tracker you can check
+account status much faster than vie gateway query (which not every
+gateway API includes).  Transaction Tracker hooks automatically to
+Recurring Billing API and updates your local copy of data according to
+all ongoing operations.
+
+=== Subscription Manager
+
+Subscription Manager provides high-level logic for managing
+subscription services, tariff plans, payment poliies and so on.  You
+can even use it to automatically adjust final price with the tax of
+appropriate region!
+
+== Download
+
+Currently this library is available from https://github.com/itteco/service_merchant
+
+    git clone git://github.com/itteco/service_merchant.git
+
+== Installation
+
+0. Install Ruby, Rails and dependencies:
+
+   In *nix software installation may require root privileges. Use "su"
+   or "sudo" in case of lack rights.
+
+   1) Install Ruby and Rails:
+
+      please, refer to section #1 and #2 at
+      http://wiki.rubyonrails.com/rails/pages/GettingStartedWithRails
+
+   2) Install prerequisites:
+
+      gem install activemerchant -v '1.3.2' --include-dependencies
+
+      Test suite prerequisites:
+
+      gem install mocha --include-dependencies
+      gem install rake
+
+      You may also need to update rubygems package manager if your
+      version is too old
+
+      gem install rubygems-update
+
+   3) Install SQLite3 library:
+
+      1. Install SQLite3:
+
+         In *nix try your package manager.  You'll also need header
+         files.  On Ubuntu packages names are sqlite3 and sqlite3-dev
+         for library and header files respectively.
+
+         Under Windows install it manually:
+
+         a) download sqlitedll-*.zip from http://sqlite.org (for
+         example, http://sqlite.org/sqlitedll-3_6_3.zip)
+
+         b) extract sqlite3.dll somewhere within PATH
+         (e.g. c:\ruby\bin, c:\windows\system32)
+
+      2. Install Ruby wrapper:
+
+         gem install sqlite3-ruby --include-dependencies
+         (under Windows select <mswin32> option)
+
+         In case of problems under Windows try to use older version:
+
+         gem install --version 1.2.3 sqlite3-ruby
+
+   4) [optional] Install HTMLDOC library:
+
+      To use invoice generation feature in sample Rails application
+
+      1. Install HTMLDOC:
+
+         In *nix try your package manager. Package name is *htmldoc*.
+
+         Under Windows download it from
+         http://www.easysw.com/htmldoc/software.php and install it
+         manually.
+
+      2. Intall Ruby wrapper:
+
+         gem install htmldoc
+
+
+1.1. GEM installation:
+
+  #TODO#
+
+1.2. Manual installation:
+
+  1) Download and unpack source
+
+  2) [optional] Create ServiceMerchant database (will delete current
+  database):
+
+     cd {unpack_dir}/trunk
+     rake create_all_tables
+
+2. Configuration:
+
+  The distribution contains sample config for test usage.  See
+  tracker/test/fixtures.yml for details.  To run remote tests create
+
+  !!! WARNING !!!
+
+  Always use TEST accounts and TEST mode for your payment gateway
+  until you've verified everything works correctly.
+
+
+3. Test suite
+
+Run unit tests:
+    rake test:unit
+
+Run remote tests (requires test accounts on gateways, see tracker/test/fixtures.yml):
+    rake test:remote
+
+Other test-related tasks:
+    rake -T test
+
+== Sample Usage
+
+ 1) Simple command-line sample app:
+
+    cd {unpack_dir}/trunk
+    ./demo.rb
+
+    Please, refer to its source code for details.
+
+ 2) Simple web site (Ruby on Rails application):
+
+    cd {unpack_dir}/trunk/sample_app
+    ./script/server
+
+  and open http://127.0.0.1:3000/ and http://127.0.0.1:3000/admin in
+  your browser. If both URLs does not work, try running
+
+    ./script/server webrick
+    (instead of ./script/server)
+
+  Please, refer to its source code (for example, config/environment.rb
+  and app/controllers/*) for details.
+
+Both of these demo applications use sample configs to work.
+
+== Known issues
+
+1. No expection handling is provided for sample applications.
+
+2. Not tested in LIVE payment gateway mode.
+
+3. Database is stored inside module, single ServiceMerchant database
+for all projects.
+
+4. sqlite3-ruby 1.0.0 generates "Table not found" error on some Linux
+machines.
+
+== Roadmap
+
+Add "sync payments status" feature - find out what accounts has
+difficulties with payments - using
+
+  1. Online sync - ask for account status directly from payment
+  gateway
+
+  2. Offline sync - import payment gateway report manualy
+
+Pack source code as GEM and publish on rubyforge
+
+== Developers
+
+ - Alexander Lebedev <me@alexlebedev.com>
+ - Artyom Scorecky <tonn81@gmail.com>
+ - Anatoly Ivanov <mail@anatoly-ivanov.com>
+
+Sponsored by [Itteco Software](http://itteco.com)
+
+== Contributing
+
+  #TODO#

data/Rakefile

@@ -0,0 +1,122 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+#require 'rake/contrib/rubyforgepublisher'
+
+PKG_VERSION = "0.1.0"
+PKG_NAME = "servicemerchant"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+PKG_FILES = FileList[
+    "recurring_billing/**/*", "subscription_management/**/*",
+    "tracker/**/*", "vendor/**/*", "[a-zA-Z]*"
+].exclude(/\.svn$/)
+
+task :default => 'dobuild'
+
+task :install => [:package] do
+  `gem install pkg/#{PKG_FILE_NAME}.gem`
+end
+
+#TODO: use defaults in task
+task :test => ["test:default"] do
+  puts 'All tests run is complete.'
+end
+
+task :dobuild => [:test, :gem] do
+  puts 'Build complete'
+end
+
+# Genereate the RDoc documentation
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "ServiceMerchant library"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main=README' << '--include=tracker/lib/'
+  rdoc.rdoc_files.include('README.txt')
+  rdoc.rdoc_files.include('recurring_billing/lib/**/*.rb')
+  rdoc.rdoc_files.include('subscription_management/lib/**/*.rb')
+  rdoc.rdoc_files.include('tracker/lib/**/*.rb')
+end
+
+desc "Delete tar.gz / zip / rdoc"
+task :cleanup => [ :clobber_package ]
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "Provides UI and tools to add billing feature to web application"
+  s.has_rdoc = true
+
+  s.files = PKG_FILES
+
+  s.add_dependency('activemerchant', '= 1.3.2')
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+#######################################################################
+
+require File.dirname(__FILE__)+'/tracker/tasks/schema'
+require File.dirname(__FILE__)+'/subscription_management/tasks/schema'
+
+desc "Create all tables"
+task :create_all_tables => ["tracker:create_tables", "subscription:create_tables"]
+
+desc "Drop all tables"
+task :drop_all_tables => ["subscription:drop_tables", "tracker:drop_tables"]
+
+# Run the tests
+namespace :test do
+  Rake::TestTask.new(:unit_recurring) do |t|
+    t.pattern = 'recurring_billing/test/unit/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:unit_tracker) do |t|
+    t.pattern = 'tracker/test/unit/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:unit_subscription) do |t|
+    t.pattern = 'subscription_management/test/unit/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:remote_recurring) do |t|
+    t.pattern = 'recurring_billing/test/remote/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:remote_tracker) do |t|
+    t.pattern = 'tracker/test/remote/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:remote_subscription) do |t|
+    t.pattern = 'subscription_management/test/remote/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.verbose = true
+  end
+
+  desc "Run all unit tests"
+  task :unit => [:unit_recurring, :unit_tracker, :unit_subscription]
+
+  desc "Run all remote tests"
+  task :remote => [:remote_recurring, :remote_tracker, :remote_subscription]
+
+  desc "Run both unit and remote tests"
+  task :all => [:unit, :remote]
+
+  task :default => 'unit'
+end

data/demo.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/ruby
+#
+# Demo of subscription management
+require File.dirname(__FILE__) + '/subscription_management/subscription_management'
+
+require 'rubygems'
+require 'active_merchant'
+
+options = {
+          :account_id => 'Test',
+          :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 = ActiveMerchant::Billing::CreditCard.new({
+          :number => 4242424242424242,
+          :month => 9,
+          :year => Time.now.year + 1,
+          :first_name => 'John',
+          :last_name => 'Doe',
+          :verification_value => '123',
+          :type => 'visa'
+        })
+
+credit_card_2 = ActiveMerchant::Billing::CreditCard.new({
+          :number => 4929838635250031,
+          :month => 9,
+          :year => Time.now.year + 5,
+          :first_name => 'John',
+          :last_name => 'Doe',
+          :verification_value => '123',
+          :type => 'visa'
+        })
+        
+credit_card_3 = ActiveMerchant::Billing::CreditCard.new({
+          :number => 4929273971564532,
+          :month => 12,
+          :year => Time.now.year + 3,
+          :first_name => 'John',
+          :last_name => 'Doe',
+          :verification_value => '123',
+          :type => 'visa'
+        })
+
+sm = SubscriptionManagement.new(
+          :tariff_plans_config => 'subscription_management/samples/backpack.yml',
+          :taxes_config => 'subscription_management/samples/taxes.yml',
+          :gateways_config => 'recurring_billing/test/fixtures.yml',
+          :gateway => :paypal
+          )
+
+subscription_id = sm.subscribe(options)
+sm.pay_for_subscription(subscription_id, credit_card, {})
+features = sm.get_features(subscription_id)
+for feature in features
+  print "\n"+SubscriptionManagement.format_feature(feature)
+end
+
+options_sets = [{:card=>credit_card_2}, {:card=>credit_card_3, :start_date => Date.today + 42}]
+options_sets.each do |options|
+  print "\nTrying to update subscription using options: #{options.inspect}"
+  print "\nWarning: current billing profile on gateway will be canceled and re-created" unless sm.update_possible?(subscription_id, options)
+  sm.update_subscription(subscription_id, options)
+end
+
+sm.unsubscribe(subscription_id)

data/recurring_billing/lib/am_extensions.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + '/am_extensions/*.rb'].each{|g| require g}