paysimple 1.0.0

data/History.txt

@@ -0,0 +1,5 @@
+== 1.0.0 / 2007-06-29
+
+* 1 major enhancement
+  * Birthday!
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 [Jonathan Younger]
+
+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 PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL 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/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.txt
+Rakefile
+init.rb
+lib/paysimple.rb
+lib/usaepay.wsdl
+test/paysimple_test.rb
+uninstall.rb

data/README.txt

@@ -0,0 +1,152 @@
+[PaySimple](http://www.paysimple.com) is a payment gateway providing credit card
+processing, check processing and recurring / subscription billing services.
+
+== DESCRIPTION:
+
+This library provides a simple interface to find, create, edit, delete, and query subscriptions
+using the PaySimple SOAP API. [PaySimple API](https://www.usaepay.com/developer/docs/beta5)
+
+
+== Installation:
+
+The simple way:
+  $ sudo gem install paysimple
+
+Directly from repository:
+  $ svn co svn://svn.roundhaus.com/daikini/plugins/paysimple
+
+== Requirements:
+
+* soap4r 1.5.6 or higher
+
+== Configuration:
+
+When you signup for a PaySimple account you can setup a source key and optionally a pin and client ip address.
+These are your credentials when using the PaySimple API.
+
+  PaySimple.key = "123456"
+  PaySimple.pin = "topsecret"
+  PaySimple.client_ip = "192.168.0.1"
+
+
+== Usage:
+
+  require 'paysimple'
+
+  # Bill Jennifer $12.00 monthly
+  begin
+    customer_number = PaySimple::Subscription.create(
+      :CustomerID => 12345,
+      :BillingAddress => {
+        :FirstName => "Jennifer",
+        :LastName => "Smith"
+      },
+      :CreditCardData => {
+        :CardNumber => '4444555566667779',
+        :CardExpiration => '0908'
+      },
+      :Schedule => :monthly,
+      :Next => "2008-09-05",
+      :Amount => 12.00
+    )
+
+    puts "Subscription created with Customer Number: #{customer_number}"
+  rescue Exception => e
+    puts "An error occurred: #{e.message}"
+  end
+
+
+  # Update subscription to use new credit card
+  begin
+    customer_number = 12345
+    response = PaySimple::Subscription.update(
+      customer_number,
+      :CreditCardData => {
+        :CardNumber => '4444555566667779',
+        :CardExpiration => '0908'
+      }
+    )
+
+    puts "Subscription updated"
+  rescue Exception => e
+    puts "An error occurred: #{e.message}"
+  end
+
+
+  # Delete subscription
+  begin
+    customer_number = 12345
+    response = PaySimple::Subscription.delete(customer_number)
+
+    puts "Subscription removed from active use."
+  rescue Exception => e
+    puts "An error occurred: #{e.message}"
+  end
+
+
+  # Find an existing subscription
+  begin
+    customer_number = 12345
+    customer = PaySimple::Subscription.find(customer_number)
+
+    puts "Found subscription for #{ [customer["BillingAddress"]["FirstName"], customer["BillingAddress"]["LastName"]].join(" ")}"
+  rescue Exception => e
+    puts "An error occurred: #{e.message}"
+  end
+
+
+  # Process one-time sale against existing subscription
+  begin
+    customer_number = 12345
+    response = PaySimple::Subscription.charge(customer_number, :Amount => 34.56)
+
+    if response['Response'] == "Approved"
+      puts "One-time charge successful."
+    else
+      puts "An error occurred: #{response['Error']}"
+    end
+  rescue Exception => e
+    puts "An error occurred: #{e.message}"
+  end
+
+
+  # Search for transactions
+  begin
+    response = PaySimple::Subscription.query(
+      [ 
+        { :Field => 'amount', :Type => 'gt', :Value => '5.0' }
+      ]
+    )
+
+    response.transactions.each do |transaction|
+      puts "CustomerID = #{transaction['CustomerID']}, Amount = #{transaction['Details']['Amount']}"
+    end
+  rescue Exception => e
+    puts "An error occurred: #{e.message}"
+  end
+
+
+== LICENSE:
+
+paysimple is licensed under the MIT License.
+
+Copyright (c) 2007 [Jonathan Younger], released under the MIT license
+
+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 PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 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/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'hoe'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require './lib/paysimple.rb'
+
+Hoe.new('paysimple', PaySimple::VERSION) do |p|
+  p.rubyforge_name = 'paysimple'
+  p.author = ["Jonathan Younger"]
+  p.email = ["jonathan@daikini.com"]
+  p.summary = "Ruby library for the PaySimple payment gateway."
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = "http://paysimple.rubyforge.org/"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = "" # Release to root
+  p.extra_deps << ["soap4r", ">= 1.5.6"]
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the paysimple plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the paysimple plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PaySimple'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'paysimple'

data/lib/paysimple.rb

@@ -0,0 +1,256 @@
+require 'rubygems'
+gem 'soap4r', '>= 1.5.6' # 1.5.6 or higher
+require 'soap/wsdlDriver' 
+require 'digest/sha1'
+
+# [PaySimple](http://www.paysimple.com) is a payment gateway providing credit card
+# processing, check processing and recurring / subscription billing services.
+#
+# This library provides a simple interface to find, create, edit, delete, and query subscriptions
+# using the PaySimple SOAP API. [PaySimple API](https://www.usaepay.com/developer/docs/beta5)
+#
+# == Installation
+#
+# The simple way:
+#   $ sudo gem install paysimple
+#
+# Directly from repository:
+#   $ ./script/plugin install svn://svn.roundhaus.com/daikini/plugins/paysimple
+#
+# Directly from repository using piston:
+#   $ piston import svn://svn.roundhaus.com/daikini/plugins/paysimple vendor/plugins/paysimple
+#
+# == Configuration
+#
+# When you signup for a PaySimple account you can setup a source key and optionally a pin and client ip address.
+# These are your credentials when using the PaySimple API.
+#
+#   PaySimple.key = "123456"
+#   PaySimple.pin = "topsecret"
+#   PaySimple.client_ip = "192.168.0.1"
+#
+class PaySimple
+  VERSION = "1.0.0"
+  WSDL_URL = File.dirname(__FILE__) + '/usaepay.wsdl'
+  
+  class << self
+    attr_accessor :key, :pin, :client_ip
+  end
+  self.key = "TestMerchant"
+  
+  class Subscription
+    class << self
+      # # Bill Jennifer $12.00 monthly
+      # begin
+      #   customer_number = PaySimple::Subscription.create(
+      #     :CustomerID => 12345,
+      #     :BillingAddress => {
+      #       :FirstName => "Jennifer",
+      #       :LastName => "Smith"
+      #     },
+      #     :CreditCardData => {
+      #       :CardNumber => '4444555566667779',
+      #       :CardExpiration => '0908'
+      #     },
+      #     :Schedule => :monthly,
+      #     :Next => "2008-09-05",
+      #     :Amount => 12.00
+      #   )
+      # 
+      #   puts "Subscription created with Customer Number: #{customer_number}"
+      # rescue Exception => e
+      #   puts "An error occurred: #{e.message}"
+      # end
+      def create(options)
+        PaySimple.send_request(:addCustomer, { :NumLeft => 0, :Enabled => true }.merge(options))
+      end
+      
+      # # Update subscription to use new credit card
+      # begin
+      #   customer_number = 12345
+      #   response = PaySimple::Subscription.update(
+      #     customer_number,
+      #     :CreditCardData => {
+      #       :CardNumber => '4444555566667779',
+      #       :CardExpiration => '0908'
+      #     }
+      #   )
+      #     
+      #   puts "Subscription updated"
+      # rescue Exception => e
+      #   puts "An error occurred: #{e.message}"
+      # end
+      def update(customer_number, options)
+        customer = find(customer_number)
+        options = PaySimple.symbolize_hash(options)
+        
+        # Add the existing customer properties to the options hash unless they already exist
+        [
+          :CustomerID,
+          :SendReceipt, 
+          :ReceiptNote, 
+          :Notes, 
+          :User, 
+          :Source, 
+          :Schedule, 
+          :Next, 
+          :NumLeft, 
+          :Amount, 
+          :Enabled, 
+          :CustomData, 
+          :Description, 
+          :OrderID
+        ].each do |property|
+          options[property] = customer[property.to_s] unless options.has_key?(property)
+        end
+        
+        # Add the existing customer address properties to the options hash unless they already exist
+        options[:BillingAddress] ||= {}
+        [
+          :FirstName,
+          :LastName,
+          :Company,
+          :Street,
+          :Street2,
+          :City,
+          :State,
+          :Zip,
+          :Country,
+          :Phone,
+          :Fax,
+          :Email
+        ].each do |property|
+          options[:BillingAddress][property] = customer["BillingAddress"][property.to_s] unless options[:BillingAddress].has_key?(property)
+        end
+        
+        # Add the existing customer credit card properties to the options hash unless they already exist
+        options[:CreditCardData] ||= {}
+        [
+          :CardNumber,
+          :CardExpiration,
+          :CardCode,
+          :AvsStreet,
+          :AvsZip,
+          :CardPresent,
+          :MagStripe,
+          :TermType,
+          :MagSupport,
+          :XID,
+          :CAVV,
+          :ECI,
+          :InternalCardAuth,
+          :Pares
+        ].each do |property|
+          options[:CreditCardData][property] = customer["CreditCardData"][property.to_s] unless options[:CreditCardData].has_key?(property)
+        end
+        
+        # Add the existing customer check properties to the options hash unless they already exist
+        options[:CheckData] ||= {}
+        [
+          :CheckNumber,
+          :Routing,
+          :Account,
+          :SSN,
+          :DriversLicense,
+          :DriversLicenseState
+        ].each do |property|
+          options[:CheckData][property] = customer["CheckData"][property.to_s] unless options[:CheckData].has_key?(property)
+        end
+        
+        PaySimple.send_request(:updateCustomer, customer_number, options)
+      end
+      
+      # # Delete subscription
+      # begin
+      #   customer_number = 12345
+      #   response = PaySimple::Subscription.delete(customer_number)
+      # 
+      #   puts "Subscription removed from active use."
+      # rescue Exception => e
+      #   puts "An error occurred: #{e.message}"
+      # end
+      def delete(customer_number)
+        PaySimple.send_request(:deleteCustomer, customer_number)
+      end
+    
+      # # Find an existing subscription
+      # begin
+      #   customer_number = 12345
+      #   customer = PaySimple::Subscription.find(customer_number)
+      # 
+      #   puts "Found subscription for #{ [customer["BillingAddress"]["FirstName"], customer["BillingAddress"]["LastName"]].join(" ")}"
+      # rescue Exception => e
+      #   puts "An error occurred: #{e.message}"
+      # end
+      def find(customer_number)
+        PaySimple.send_request(:getCustomer, customer_number)
+      end
+      
+      # # Process one-time sale against existing subscription
+      # begin
+      #   customer_number = 12345
+      #   response = PaySimple::Subscription.charge(customer_number, :Amount => 34.56)
+      # 
+      #   if response['Response'] == "Approved"
+      #     puts "One-time charge successful."
+      #   else
+      #     puts "An error occurred: #{response['Error']}"
+      #   end
+      # rescue Exception => e
+      #   puts "An error occurred: #{e.message}"
+      # end
+      def charge(customer_number, options, auth_only = false)
+        PaySimple.send_request(:runCustomerSale, customer_number, options, auth_only)
+      end
+      
+      # # Search for transactions
+      # begin
+      #   response = PaySimple::Subscription.query(
+      #     [ 
+      #       { :Field => 'amount', :Type => 'gt', :Value => '5.0' }
+      #     ]
+      #   )
+      # 
+      #   response.transactions.each do |transaction|
+      #     puts "CustomerID = #{transaction['CustomerID']}, Amount = #{transaction['Details']['Amount']}"
+      #   end
+      # rescue Exception => e
+      #   puts "An error occurred: #{e.message}"
+      # end
+      def query(options)
+        match_all = options.delete(:match_all)
+        start = options.delete(:start) || 0
+        limit = options.delete(:limit) || 100
+        PaySimple.send_request(:searchTransactions, options, match_all, start, limit)
+      end
+    end
+  end
+  
+  private
+  class << self
+    def symbolize_hash(hash)
+      hash.inject({}) { |h,(k,v)| h[k.to_sym] = v; h }
+    end
+    
+    def token
+      seed = "#{Time.now.to_i}#{rand(999999)}"
+      hash = Digest::SHA1.hexdigest([key, seed, pin].join)
+      { 
+        'SourceKey' => key,
+        'PinHash' => {
+          'Type' => "sha1",
+          'Seed' => seed,
+          'HashValue' => hash
+        },
+        'ClientIP' => client_ip
+      }
+    end
+    
+    def send_request(request, *args)
+      @driver ||= SOAP::WSDLDriverFactory.new(WSDL_URL).create_rpc_driver
+      @driver.options["protocol.http.ssl_config.verify_mode"] = nil
+      @driver.send(request, token, *args)
+    end
+  end
+
+end