payment 0.9

data/lib/payment.rb

@@ -0,0 +1,81 @@
+#--
+# Copyright (c) 2005 Lucas Carlson
+#
+# 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.
+#++
+
+# == Welcome to Payment
+# 
+# Payment is used to process credit cards and electronic cash through merchant accounts.
+# 
+# To choose a gateway, require 'payment/gateway_name'. For example, if you want to use Authorize.net, do a require 'payment/authorize_net'. If you would like to use multiple gateways in the same code, simply do a require 'payment' and it will grab each gateway's code for you.
+# 
+# Payment was inspired by and has borrowed much of its infrastructure from the Business::OnlinePayment Perl module (http://search.cpan.org/~jasonk/Business-OnlinePayment-2.01/OnlinePayment.pm).
+# 
+# If you would like to loosely check the validity of a credit card without using a merchant account, look at the CreditCard module (http://rubyforge.org/projects/creditcard/).
+# 
+# == Example
+# 
+# require 'payment/authorize_net'
+# 
+# transaction = Payment::AuthorizeNet.new (
+#                       :login       => 'username',
+#                       :password    => 'password',
+#                       :amount      => '49.95',
+#                       :card_number => '1234123412341238',
+#                       :expiration  => '03/05',
+#                       :first_name  => 'John',
+#                       :last_name   => 'Doe'
+#                      )
+# transaction.submit
+# 
+# if transaction.success?
+#    puts "Card processed successfully: #{transaction.authorization}";
+# else
+#    puts "Card was rejected: #{transaction.error_message}";
+# end
+# 
+# == Currently Supported Gateways
+# 
+# * Authorize.Net (authorize_net) - http://www.authorize.net/
+# 
+# == Planned Support for the Following Gateways
+# 
+# * Trust Commerce - http://www.trustcommerce.com/
+# * Verisign Payflow Pro - http://www.verisign.com/
+# * Moneris - http://www.moneris.com/
+# * Cardstream - http://www.cardstream.com/
+# * Beanstream - http://www.beanstream.com/
+# * Vital - http://www.vitalps.com/
+# * Merchant Commerce - http://www.innuity.com/
+# * iAuthorizer - http://www.iauthorizer.com/
+# * Electronic Clearing House, Inc. - http://www.echo-inc.com/
+# * Bank of America eStores - http://www.bankofamerica.com/
+# * Network1Financial - http://www.eftsecure.com/
+# * eSec - http://www.esecpayments.com.au/
+# * Ingenico OCV - http://www.ingenico.com.au/
+# * St.George IPG - https://www.ipg.stgeorge.com.au/
+# * Jettis - http://www.jettis.com/
+# * PaymentsGateway.Net - http://www.paymentsgateway.net/
+# * PayConnect - http://www.paymentone.com/
+# * Secure Hosting UPG - http://www.securehosting.com/
+
+require 'payment/base'
+require 'payment/authorize_net'

data/lib/payment/authorize_net.rb

@@ -0,0 +1,207 @@
+# Author::    Lucas Carlson  (mailto:lucas@rufy.com)
+# Copyright:: Copyright (c) 2005 Lucas Carlson
+# License::   Distributes under the same terms as Ruby
+
+require 'payment/base'
+require 'cgi'
+require 'csv'
+
+module Payment
+
+class AuthorizeNet < Base
+	attr_reader :server_response, :avs_code, :order_number, :md5, :cvv2_response, :cavv_response
+	attr_accessor :first_name, :last_name, :transaction_key
+	
+	# version of the gateway's API	
+	API_VERSION = '3.1'
+	
+	# map the instance variable names to the gateway's requested variable names
+	FIELDS = {
+		'type' => 'x_Method',
+		'login' => 'x_Login',
+		'password' => 'x_Password',
+		'transaction_key' => 'x_Tran_Key',
+		'type' => 'x_Type',
+		'description' => 'x_Description',
+		'amount' => 'x_Amount',
+		'currency_code' => 'x_Currency_Code',
+		'invoice_num' => 'x_Invoice_Num',
+		'trans_id' => 'x_Trans_ID',
+		'auth_code' => 'x_Auth_Code',
+		'cust_id' => 'x_Cust_ID',
+		'customer_ip' => 'x_Customer_IP',
+		'last_name' => 'x_Last_Name',
+		'first_name' => 'x_First_Name',
+		'company' => 'x_Company',
+		'address' => 'x_Address',
+		'city' => 'x_City',
+		'state' => 'x_State',
+		'zip' => 'x_Zip',
+		'country' => 'x_Country',
+		'ship_to_last_name' => 'x_Ship_To_Last_Name',
+		'ship_to_first_name' => 'x_Ship_To_First_Name',
+		'ship_to_address' => 'x_Ship_To_Address',
+		'ship_to_city' => 'x_Ship_To_City',
+		'ship_to_state' => 'x_Ship_To_State',
+		'ship_to_zip' => 'x_Ship_To_Zip',
+		'ship_to_country' => 'x_Ship_To_Country',
+		'phone' => 'x_Phone',
+		'fax' => 'x_Fax',
+		'email' => 'x_Email',
+		'card_number' => 'x_Card_Num',
+		'expiration' => 'x_Exp_Date',
+		'card_code' => 'x_Card_Code',
+		'echeck_type' => 'x_Echeck_Type',
+		'account_name' => 'x_Bank_Acct_Name',
+		'account_number' => 'x_Bank_Acct_Num',
+		'account_type' => 'x_Bank_Acct_Type',
+		'bank_name' => 'x_Bank_Name',
+		'bank_aba_code' => 'x_Bank_ABA_Code',
+		'customer_org' => 'x_Customer_Organization_Type', 
+		'customer_ssn' => 'x_Customer_Tax_ID',
+		'drivers_license_num' => 'x_Drivers_License_Num',
+		'drivers_license_state' => 'x_Drivers_License_State',
+		'drivers_license_dob' => 'x_Drivers_License_DOB',
+		'recurring_billing' => 'x_Recurring_Billing',
+		'test_request' => 'x_Test_Request',
+		'adc_delim_data' => 'x_ADC_Delim_Data',
+		'adc_url' => 'x_ADC_URL',
+		'version' => 'x_Version',
+	}
+	
+	# map the actions to the merchant's action names
+	ACTIONS = {
+		'normal authorization' => 'AUTH_CAPTURE',
+		'authorization only'   => 'AUTH_ONLY',
+		'credit'               => 'CREDIT',
+		'post authorization'   => 'PRIOR_AUTH_CAPTURE',
+		'void'                 => 'VOID',
+	}
+
+	def initialize(options = {})
+		# set some sensible defaults
+		@url = 'https://secure.authorize.net/gateway/transact.dll'
+		@adc_delim_data = 'TRUE'
+		@adc_url = 'FALSE'
+		@version = API_VERSION
+		
+		# include all provided data
+		super options
+	end
+	
+	def submit			
+		uri = URI.parse @url
+		http = Net::HTTP.new uri.host, uri.port
+
+		http.verify_mode    = OpenSSL::SSL::VERIFY_NONE if @strict_ssl == false
+		http.use_ssl        = true
+		
+		begin
+			response  = http.post uri.path, post_data
+		rescue
+			@is_success = false
+			@error_message = "Could not access #{@url}. Error code #{response.code}. #{response.message}"
+			return
+		end
+		
+		col = nil		
+		CSV::Reader.parse response.body do |row|
+			col ||= row
+		end
+		
+		if col
+			@server_response = response.code
+			@result_code = col[0].data
+			@avs_code = col[5].data
+			@order_number = col[6].data
+			@md5 = col[37].data
+			@cvv2_response = col[38].data
+			@cavv_response = col[39].data
+
+			if @result_code == "1" # Approved/Pending/Test
+				@is_success = true
+				@authorization = col[4].data
+			else
+				@is_success = false
+				@error_code = col[2].data
+				@error_message = col[3].data
+			end
+		else
+			@is_success = false
+			@error_message = "Could not interpret the result. #{response.body}"
+		end
+		
+		return @is_success
+	end
+	
+	def post_data
+		prepare_data
+
+		post_array = Array.new
+		FIELDS.each do |loc_var, gate_var|
+			if @@required.include?(loc_var) && eval("@#{loc_var}").nil?
+				raise PaymentError, "The required variable '#{loc_var}' was left empty"
+			else
+				value = eval "CGI.escape(@#{loc_var}.to_s)"
+				post_array << "#{gate_var}=#{value}"
+			end
+		end
+
+		return post_array.join("&")
+	end
+	
+	def prepare_data
+		# make sensible changes to data
+		@card_number = @card_number.to_s.gsub(/[^\d]/, "") unless @card_number.nil?
+		
+		@test_request = @test_transaction == true ? "TRUE" : "FALSE"
+
+		if @recurring_billing.class != String
+			if @recurring_billing == true
+				@recurring_billing = "YES"
+			elsif @recurring_billing == false
+				@recurring_billing = "NO"
+			end
+		end
+		
+		@expiration = @expiration.strftime "%m/%y" rescue nil # in case a date or time is passed
+		
+		@type = (@type.nil? && @card_number) ? 'CC' : @type.upcase
+		
+		# convert the action
+		if ACTIONS.include?(@action)
+			@action = ACTIONS[@action]
+		elsif ! ACTIONS.has_value?(@action)
+			raise PaymentError, "The action '#{@action}' is not valid"
+		end		
+		
+		# add some required fields specific to this payment gateway and the provided data
+		@@required.concat %w(type action login test_request adc_delim_data adc_url)
+
+		if @transaction_key.nil?
+			@@required.concat %w(password)
+		else
+			@@required.concat %w(transaction_key)
+		end
+		
+		unless @type == 'VOID'
+			if @type == 'ECHECK'
+				@@required.concat %w(amount routing_code account_number account_type bank_name account_name account_type)
+				@@required.concat %w(customer_org customer_ssn) unless @customer_org.nil?
+			elsif @type == 'CC'
+				@@required.concat %w(amount)
+				if @action == 'PRIOR_AUTH_CAPTURE'
+					@@required.concat @order_number ? %w(order_number) : %w(card_number expiration)
+				else
+					@@required.concat %w(last_name first_name card_number expiration)
+				end
+			else
+				raise PaymentError, "Can't handle transaction type: #{@type}"
+			end
+		end
+		
+		@@required.uniq!
+	end
+end
+
+end

data/lib/payment/base.rb

@@ -0,0 +1,38 @@
+# Author::    Lucas Carlson  (mailto:lucas@rufy.com)
+# Copyright:: Copyright (c) 2005 Lucas Carlson
+# License::   Distributes under the same terms as Ruby
+
+require 'net/http'
+require 'net/https'
+
+module Payment
+
+class PaymentError < StandardError; end # :nodoc:
+
+class Base
+	attr_reader :error_message, :authorization, :transaction_type, :result_code
+	attr_accessor :url
+	attr_accessor :require_avs, :test_transaction, :strict_ssl
+	attr_accessor :type, :login, :password, :action, :description, :amount, :invoice_number, :customer_id, :name, :address, :city, :state, :zip, :country, :phone, :fax, :email, :card_number, :expiration, :account_number, :routing_code, :bank_name
+	
+	@@required = []
+
+	def initialize(options = {})
+		# set some sensible defaults
+		@strict_ssl = true
+		@action = 'credit'
+		
+		# include all provided data
+		options.each { |method, value| eval "@#{method} = '#{value}'" if methods.include? "#{method}=" }
+	end
+
+	def submit
+		raise PaymentError, "No gateway specified"
+	end
+	
+	def success?
+		@is_success ? true : false
+	end
+end
+
+end

metadata

@@ -0,0 +1,40 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.3
+specification_version: 1
+name: payment
+version: !ruby/object:Gem::Version 
+  version: "0.9"
+date: 2005-02-04
+summary: Payment is used to process credit cards and electronic cash through merchant accounts.
+require_paths: 
+  - lib
+email: lucas@rufy.com
+homepage: http://payment.rubyforge.org
+rubyforge_project: payment
+description: "These functions tell you whether a credit card number is self-consistent using known algorithms for credit card numbers. All non-integer values are removed from the string before parsing so that you don't have to worry about the format of the string."
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Lucas Carlson
+files: 
+  - lib/payment
+  - lib/payment.rb
+  - lib/payment/authorize_net.rb
+  - lib/payment/base.rb
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: []