ruby-saferpay 0.0.2

data/History.txt

@@ -0,0 +1,12 @@
+== 0.0.2 / 2007-08-14
+
+* 3 minor enhancement
+  * Inquiry
+  * Docs
+  * Tests
+  
+== 0.0.1 / 2007-08-12
+
+* 1 major enhancement
+  * Basic SCAI
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/ruby-saferpay
+lib/ruby-saferpay.rb
+lib/ruby-saferpay/version.rb
+test/test_ruby-saferpay.rb

data/README.txt

@@ -0,0 +1,218 @@
+ruby-saferpay
+= ELC-Tecnologies[http://www.elctech.com], http://www.elctech.com
+
+== DESCRIPTION:
+  
+Saferpay (http://www.saferpay.com) is a european e-commerce payment services provider, present mostly in Switzerland, Germany and Austria but expanding elsewhere as well.
+This gem provides a ruby interface to the "Saferpay Card Authorization Interface" (SCAI) part of the API. The code also contain a "payinit" method that is part of the "Virtual Terminal" (VT) approach to ecommerce payments.
+
+The SCAI interface is used when the merchant wishes to keep the acquirer on her/his own website for the whole duration of the transaction (client payment details transits through *both* the merchant site and the saferpay database ) whereas VT implies a redirect to the saferpay site.
+
+== FEATURES/PROBLEMS:
+
+* supports both common credit cards and direct debit cards ("Lastschrift")
+* support for VT style payments is incomplete
+
+
+== SYNOPSIS:
+  
+Init (info from saferpay test account; they're the same for all test accounts):
+  @pan        =  "9451123100000004"        #  Saferpay test PAN
+  @accountid  =  "99867-94913159"          #  Saferpay test ACCOUNTID
+  @exp        =  "1107"                    #  This will change for other test accounts I guess... Might just be three months ahead of Time.now
+  @sfp  = Saferpay.new( @accountid, @pan, @exp )
+  
+Reserve:
+  <tt>@sfp.reserve(30000, "USD")</tt>
+  
+Amounts are divided by 100. We're talking cents here, not dollars...
+  
+Capture last transaction:
+  <tt>@sfp.capture</tt>
+  
+Capture with a transacaton ID "4hj34hj4hh34h4j3hj4h334":
+  <tt>@sfp.capture("4hj34hj4hh34h4j3hj4h334")</tt>
+  
+== REQUIREMENTS:
+
+Saferpay:
+* A saferpay account
+* openssl-0.9.7: saferpay docs says "d" version, but "m" seem to work; 0.9.8 does _not_ work. MacPorts package: "openssl97"
+  
+* A working saferpay installation
+As of today (august '07), the linux distribution have issues and compilation has not been straightforward (I have used the libidpapp lib from the binary distribution and compiled the saferpay executable from the source distribution, using 
+  make -f saferpay.mk
+The libs from the binary distribution require lbstdc++5 (not standard on most modern linux distros).
+
+YMMV.
+
+The Mac binary distribution is for OS X 10.2, so that's pretty useless today; the Mac source distribution is not compiling (and is outdated). 
+
+Use the linux source distribution with modified makefiles as follows:
+
+Makefile:
+  PREFIX = /usr
+  SSLVERSION = openssl-0.9.7b
+  SSLEAYDIR = ../$(SSLVERSION)
+
+
+  all:
+
+    make -f idpapp.mk
+    cp ./out/libidpapp.dylib $(PREFIX)/lib
+
+    make -f saferpay.mk
+    cp idpapi.h ./out
+    cp idperrc.h ./out
+    cp ./out/settings.template ./out/settings.xml
+
+  install:
+    cp ./out/libidpapp.s* $(PREFIX)/lib  
+
+  clean:
+    make -f idpapp.mk clean
+    make -f saferpay.mk clean
+
+  xs: all
+    perl -e 'system("cd perl/MessageObject\nperl Makefile.PL\nmake");'
+    perl -e 'system("cd perl/MessageFactory\nperl Makefile.PL\nmake");'
+    perl -e 'system("cd perl/ConfigurationSetup\nperl Makefile.PL\nmake");'
+
+  testxs:
+    perl -e 'system("cd perl/ConfigurationSetup\nmake test");'
+    perl -e 'system("cd perl/MessageFactory\nmake test");'
+
+  installxs:
+    perl -e 'system("cd perl/ConfigurationSetup\nmake install");'
+    perl -e 'system("cd perl/MessageFactory\nmake install");'
+    perl -e 'system("cd perl/MessageObject\nmake install");'
+
+  cleanxs:
+    perl -e 'system("cd perl/ConfigurationSetup\nmake clean");'
+    perl -e 'system("cd perl/MessageFactory\nmake clean");'
+    perl -e 'system("cd perl/MessageObject\nmake clean");'
+
+  testmk:
+    echo "SSLVERSION: $(SSLVERSION)"
+    echo "SSLEAYDIR: $(SSLEAYDIR)"
+    
+  
+saferpay.mk:
+  ####### Compiler, tools and options
+  CC  =  gcc
+  CXX  =  g++
+
+  #CFLAGS  =  -pipe -fPIC -O2
+  CFLAGS  =  -pipe -fPIC -O2 -DUNIX -DHAVE_UNISTD_H -DHAVE_STDLIB_H
+  CXXFLAGS=  -pipe -fPIC -O2
+  INCPATH  =    
+
+  LINK  =  g++
+  LFLAGS  =  -fPIC -ldl
+  LIBS  =  -lidpapp
+  MOC  =  $(QTDIR)/bin/moc
+
+  TAR  =  tar -cf
+  GZIP  =  gzip -9f
+
+  ####### Files
+
+  HEADERS =  idpapi.h \
+      idperrc.h
+  SOURCES =  saferpay.c
+  OBJECTS =  saferpay.o
+  SRCMOC  =  
+  OBJMOC  =  
+  DIST  =  
+  TARGET  =  ./out/saferpay
+
+  ####### Implicit rules
+
+  .SUFFIXES: .cpp .cxx .cc .C .c
+
+  .cpp.o:
+    $(CXX) -c $(CXXFLAGS) $(INCPATH) -o $@ $<
+
+  .cxx.o:
+    $(CXX) -c $(CXXFLAGS) $(INCPATH) -o $@ $<
+
+  .cc.o:
+    $(CXX) -c $(CXXFLAGS) $(INCPATH) -o $@ $<
+
+  .C.o:
+    $(CXX) -c $(CXXFLAGS) $(INCPATH) -o $@ $<
+
+  .c.o:
+    $(CC) -c $(CFLAGS) $(INCPATH) -o $@ $<
+
+  ####### Build rules
+
+  all: $(TARGET)
+
+  $(TARGET): $(OBJECTS) $(OBJMOC) 
+    $(LINK) $(LFLAGS) -o $(TARGET) $(OBJECTS) $(OBJMOC) $(LIBS)
+
+  moc: $(SRCMOC)
+
+  tmake: saferpay.mk
+
+  # no more tmake
+
+
+  dist:
+    $(TAR) saferpay.tar saferpay.pro $(SOURCES) $(HEADERS) $(DIST)
+    $(GZIP) saferpay.tar
+
+  clean:
+    -rm -f $(OBJECTS) $(OBJMOC) $(SRCMOC) $(TARGET)
+    -rm -f *~ core
+
+  ####### Compile
+
+  saferpay.o: saferpay.c \
+      idpapi.h \
+      idperrc.h
+
+Ruby:  
+* Log4r is needed for logging (will log to GEMDIR/lib/log if user can write there)
+* Hpricot is needed for XML parse (overkill?)
+
+== INSTALL:
+* saferpay tools (see docs and comments above)
+* a working saferpay installation (run <tt>saferpay --help</tt> for more info and look at the Saferpay docs)
+* <tt>sudo gem install ruby-saferpay</tt>
+* test:
+  cd GEM_INSTALLATION_DIR
+  rake
+  
+
+The gem expects the saferpay installtion to be found in <tt>/opt/saferpay/</tt>. For the time being hack the source to change this:
+  BASEDIR     = '/opt/saferpay/'
+  EXECUTABLE  = 'saferpay'
+  CONFIG      = BASEDIR
+  
+  
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 ELC Tecnologies
+
+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,16 @@
+require 'rubygems'
+require 'hoe'
+require './lib/ruby-saferpay/version.rb'
+require './lib/ruby-saferpay.rb'
+
+Hoe.new('ruby-saferpay', RubySaferpay::VERSION::STRING) do |p|
+  p.rubyforge_name = 'ruby-saferpay'
+  p.author = 'David Palm (ELC Tecnologies)'
+  p.email = 'dpalm@elctech.com'
+  p.summary = 'Ruby interface to the saferpay e-commerce payment provider'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps  <<  ['log4r']
+  p.extra_deps  <<  ['hpricot']
+end

data/lib/ruby-saferpay.rb

@@ -0,0 +1,357 @@
+#!/usr/bin/env ruby
+#
+#  Created by David Palm for ELC Tecnologies on 2007-08-12.
+#  Copyright (c) 2007. All rights reserved.
+
+require	'rubygems'
+require	'log4r'
+require 'net/https'
+require 'uri'
+require 'net/https'
+require	'hpricot'
+
+class Saferpay
+	
+	class WireProtocolError <StandardError; end
+	class AttributeError <StandardError; end
+	class ConfigError <RuntimeError; end
+	# TODO: is there an eleant way of having the error messages "jump" out of here when a Transaction error is raised?
+	class TransactionError <StandardError
+		
+		ERRORS	=	[
+			{:code => 0, :short_message => 'Authorization Successful', :long_message => ''},
+			{:code => 5, :short_message => 'Access Denied', :long_message => 'The access to the specified account was denied by Saferpay.'},
+			{:code => 21, :short_message => 'Invalid Structure', :long_message => 'Invalid structure of request.'},
+			{:code => 22, :short_message => 'Unknown Action', :long_message => 'Unknown action attribute.'},
+			{:code => 23, :short_message => 'Invalid Action', :long_message => 'Invalid action attribute or action not possible.'},
+			{:code => 61, :short_message => 'Invalid Card', :long_message => 'The static checks failed on this card (range check, LUHN check digit).'},
+			{:code => 62, :short_message => 'Invalid Date', :long_message => 'Invalid expiration date.'},
+			{:code => 63, :short_message => 'Card Expired', :long_message => 'The card has expired.'},
+			{:code => 64, :short_message => 'Unknown Card', :long_message => 'The card type is unknown the BIN range could not be assigned to a known card brand.'},
+			{:code => 65, :short_message => 'Authorization Denied', :long_message => 'The processor has denied the transaction request.'},
+			{:code => 67, :short_message => 'No Contract', :long_message => '"No contract exists for the card/currency combination specified.'},
+			{:code => 68, :short_message => 'Ambigous Contract', :long_message => '"More than one contracts exist for the specified card/currency combination.'},
+			{:code => 75, :short_message => 'Missing Parameter', :long_message => 'One or more mandatory parameters are missing'},
+			{:code => 76, :short_message => 'Connect Failed', :long_message => 'The connection to the card processor could not be established or was broken during the request. Retry the request.'},
+			{:code => 77, :short_message => 'No Endpoint', :long_message => 'No endpoint is specified for the processor of the card. This processor may not support online authorization of cards.'},
+			{:code => 78, :short_message => 'Internal Error', :long_message => 'A system error has occurred during processing the request. Retry the request if possible.'},
+			{:code => 80, :short_message => 'No Terminal', :long_message => 'Terminal does not exist.'},
+			{:code => 82, :short_message => 'Not Found', :long_message => 'Transaction not found.'},
+			{:code => 83, :short_message => 'Invalid Currency', :long_message => 'The specified currency code is invalid.'},
+			{:code => 84, :short_message => 'Invalid Amount', :long_message => 'The specified amout is invalid or does not match the rules for the currency.'},
+			{:code => 87, :short_message => 'Prevalidate Denied', :long_message => 'Access denied.'},
+			{:code => 88, :short_message => 'Reservation Invalid', :long_message => 'Reservation invalid.'},
+			{:code => 89, :short_message => 'Reservation Overbooked', :long_message => 'Amount of reservation overbooked.'},
+			{:code => 90, :short_message => 'Contract Disabled', :long_message => 'The contract for this card is currently disabled.'},
+			{:code => 97, :short_message => 'Already Captured', :long_message => 'Transaction already captured (PayComplete)'},
+			{:code => 98, :short_message => 'Invalid Signature', :long_message => 'Invalid signature'},
+			{:code => 102, :short_message => 'Not Supported', :long_message => 'Function not supported by provider.'},
+			{:code => 104, :short_message => 'Denied Blacklist', :long_message => 'Card number in customer black list.'},
+			{:code => 105, :short_message => 'Denied Country', :long_message => 'Card number not in country BIN range list.'},
+			{:code => 151, :short_message => 'Timeout Response', :long_message => 'Timeout waiting on authorization response. Retry the request.'},
+			{:code => 152, :short_message => 'Unknown Error', :long_message => 'Unknown (system) error.'},
+			{:code => 301, :short_message => 'Authentication Error', :long_message => 'An error happened during the authentication request. The merchant application could choose to:\n- continue the payment without authentication or\n- ask customer for other payment method or\n- stop the payment.'}			
+		]
+		attr_reader :error
+		def initialize(saferpay_reply)
+			if saferpay_reply.is_a? String
+				result	=	Hpricot.parse(cmd_result).at('idp').attributes['result'].to_i rescue 152
+			elsif saferpay_reply.is_a? Hash
+				result	=	saferpay_reply['result'].to_i rescue 152
+			elsif saferpay_reply.is_a? Fixnum
+				result	=	saferpay_reply
+			else
+				result	=	152 # Unknown error
+			end
+			@error	=	ERRORS.any?{|err| err[:code] == result}
+		end
+	end
+
+	LOGNAME			=	File.basename(__FILE__, '.rb')
+	LOGDIR			=	File.dirname(__FILE__)+'/log'
+
+	# TODO: re-work this. Use a ".saferpayrc" file with config info?
+	BASEDIR			=	'/opt/saferpay/'
+	EXECUTABLE	=	'saferpay'
+	CONFIG			=	BASEDIR
+	
+	# Supported currencies. Please note that these are the ones Saferpay supports;
+	# and not necessarily the ones your account support. You might encounter "unsupported
+	# currency" errors even if the currency is among the following.
+	# (Test account supports at least USD, EUR, CHF)
+	CURRENCIES	=	['CHF','CZK','DKK','EUR','GBP','PLN','SEK','USD']
+	
+	attr_accessor	:account_id
+	attr_reader	:current_transaction
+	
+	def initialize( account_id = "99867-94913159", pan = "9451123100000004", expiry_date = nil, cvc = nil, name = nil, tolerance = 0 )
+		Saferpay.check_install
+		@current_transaction	=	nil
+		
+		@account_id	=	account_id
+		@pan				=	pan
+		@expiry_date=	expiry_date
+		@cvc				=	cvc
+		@name				=	name
+		@tolerance	=	tolerance	# Amount tolerance in percent. The finally captured amount is AMOUNT + TOLERANCE
+	end
+	
+	# Convenience method to:
+	# 1. Authorize (reserve)
+	# 2. Capture
+	# 3. Batch clear (needed/wanted? Probably not...)
+	def pay(amount, currency = 'EUR' )
+		reserve amount, currency
+		capture
+		details
+	end
+	
+	def details( transaction_id = nil )
+		transaction_id =  @current_transaction.transaction_id if transaction_id.nil?
+		cmd	=	"#{BASEDIR}#{EXECUTABLE} -exec -p #{CONFIG} -m Inquiry -a ID #{transaction_id} -a TYPE Transaction -a TOKEN \"(not used)\""
+		#logger.debug "#{self.class}#details COMMAND: #{cmd}"
+		do_direct_cc cmd
+	end
+	
+	def reserve( amount, currency )
+		check_params amount, currency
+		@current_transaction	=	TransactionParams.new(
+					:amount				=>	amount,
+					:currency			=>	currency,
+					:accountid		=>	@account_id,
+					:pan					=>	@pan,
+					:exp					=>	@expiry_date
+					)
+		do_direct_cc
+	end
+
+	def refund( amount, currency )
+		check_params amount, currency
+		@current_transaction	=	TransactionParams.new(
+					:amount				=>	amount,
+					:currency			=>	currency,
+					:accountid		=>	@account_id,
+					:pan					=>	@pan,
+					:exp					=>	@expiry_date,
+					:action				=>	"Credit"
+					)
+		do_direct_cc
+	end
+	
+	def refund_last
+		refund_transaction @current_transaction.transaction_id
+	end
+	
+	def refund_transaction( transaction_id )
+		cmd			=	"#{BASEDIR}#{EXECUTABLE} -capt -p #{CONFIG} -i #{transaction_id} -t \"(not used)\""
+		do_direct_cc cmd
+	end	
+
+	# Capture the amount of the transaction with id transaction_id
+	# Defaults to capturing the current transaction's amount.
+	def capture( transaction_id = nil, token = nil, params = nil )
+	  transaction_id =  @current_transaction.transaction_id if transaction_id.nil?
+	  token          =  @current_transaction.token if token.nil?
+	  cmd			=	"#{BASEDIR}#{EXECUTABLE} -capt -p #{CONFIG} -i #{transaction_id} -t \"#{token}\" #{params}"
+		do_direct_cc cmd
+	end
+	
+	def cancel( transaction_id = nil, token = nil )
+	  transaction_id  = @current_transaction.transaction_id if transaction_id.nil?
+	  token           = @current_transaction.token if token.nil?
+	  params          = "-a ACTION Cancel"
+	  
+		capture transaction_id, token, params
+	end
+
+	# Direct debit on aquierer's bank account.
+	# This will always fail with the test account.
+	# Takes an account number (10 digits) and a mysterious 'BLZ' number (8 digits).
+	# This is a very common payment method in Germany and Austria
+	def debit_card_reserve( amount, currency, account_number, blz )
+		check_params amount, currency
+		raise AttributeError, "Account number is a ten digit number" unless account_number.length == 10
+		raise AttributeError, "BLZ is a eight digit number" unless blz.length == 8
+		@current_transaction	=	TransactionParams.new(
+					:amount				=>	amount,
+					:currency			=>	currency,
+					:accountid		=>	@account_id,
+					:track2				=>	"\";59#{blz}=#{account_number}\""
+					)
+		do_direct_cc		
+	end
+	alias :lastschrift :debit_card_reserve
+	
+	# Create and send a payinit message. For use with the Virtual Terminal (VT). 
+	# Unfinished (meaning: it works, but need tests and some love and also a 
+	# couple of more methods to handle the paycomplete and other types of messages.
+	# Take it for what it is: a stub)
+	def payinit( amount, currency, description, backlink = 'http://localhost', faillink = 'http://localhost', successlink = 'http://localhost', notifyurl = 'http://localhost')
+		@current_transaction	=	TransactionParams.new(
+					:amount				=>	amount,
+					:currency			=>	currency,
+					:description	=>	description,
+					:accountid		=>	@account_id,
+					:backlink			=>	backlink,
+					:faillink			=>	faillink,
+					:successlink	=>	successlink,
+					:notifyurl		=>	notifyurl
+					)
+		cmd	=	"#{BASEDIR}#{EXECUTABLE} -payinit -p #{CONFIG} -a #{@current_transaction.to_s}"
+		logger.debug "#{self.class}#payinit Will execute command:\n#{cmd}"
+		payinit	=	%x{#{cmd} 2>&1}
+
+		logger.debug "#{self.class}#payinit result: #{payinit.inspect}"
+
+		unless $?.success?
+			logger.error "#{self.class}#payinit FAILED error status: #{$?.inspect}"
+			return false
+		else
+			logger.debug "#{self.class}#payinit Saferpay URI generated"
+		end
+		
+		uri	=	URI.parse( payinit )
+		logger.debug "#{self.class}#payinit Built an uri object. Host: #{uri.host}, port: #{uri.port}"
+		http	=	Net::HTTP.new( uri.host, uri.port )
+		http.use_ssl = true
+		result =	http.start do |http|
+			logger.debug "#{self.class}#payinit GETting uri: #{uri.request_uri}"
+			http.get(uri.request_uri)
+		end
+		unless result.is_a? Net::HTTPOK
+			logger.error "#{self.class}#payinit Cannot reach saferpay site."
+			# TODO: Should re-raise here?
+			return false
+		end
+		
+		# TODO: this suck
+		if result.body =~ /missing ACCOUNTID attribute/
+			raise AttributeError, 'Missing ACCOUNTID attribute'
+		end
+		case result.body
+		when /missing ACCOUNTID attribute/
+			raise AttributeError, 'Missing ACCOUNTID attribute'
+		when /missing BACKLINK attribute/
+			raise AttributeError, 'Missing BACKLINK attribute'
+		when /missing FAILLINK attribute/
+			raise AttributeError, 'Missing FAILLINK attribute'
+		when /missing SUCCESSLINK|NOTIFYURL attribute/
+			raise AttributeError, 'Missing SUCCESSLINK|NOTIFYURL attribute'
+		end
+		
+		result
+	end
+	
+private
+	
+	# Execute the saferpay ommand. Defaults to the most common type of command.
+	# TODO: should return a Transaction object
+	def do_direct_cc( cmd = nil )
+		cmd	=	"#{BASEDIR}#{EXECUTABLE} -exec -p #{CONFIG} -m Authorization -a #{@current_transaction.to_s}" if cmd.nil?
+		cmd_result	=	%x{#{cmd} 2>&1}
+
+		unless $?.success?
+			logger.error "#{self.class}#do_direct_cc FAILED \nError status: #{$?.inspect}\nCommand:#{cmd}\nCommand result: #{cmd_result}"
+			raise TransactionError.new(cmd_result)
+		else
+		  unless cmd_result.empty?
+				#logger.debug "#{self.class}#do_direct_cc Got a result:\n\t#{cmd_result}\n\tCommand: #{cmd}\n-------------------\n"
+  			result	=	Hpricot.parse(cmd_result).at('idp').attributes # A hash
+  			if result['result'] === "0"
+					@current_transaction.transaction_id =	result['id']
+					@current_transaction.token =	result['token']
+				elsif result['msgtype'] == 'InquiryResponse'
+					# TODO: check for valid InquiryResponse message
+				else
+  				logger.error "#{self.class}#do_direct_cc FAILED \nError status: #{$?.inspect}\nCommand:#{cmd}\nCommand result: #{cmd_result}"
+					raise TransactionError.new(result)
+  			end
+  		else
+				result =	true
+		  end
+		end
+		result
+	end
+	
+	def check_params(amount, currency) #:nodoc:
+		raise ArgumentError, "Amount has to be an integer" unless amount.is_a? Fixnum
+		raise ArgumentError, "Amount has to be a positive integer" unless amount > 1
+		raise ArgumentError, "Currency has to be string" unless currency.is_a? String
+		raise AttributeError, "Unsupported currency" unless CURRENCIES.include? currency		
+	end
+		
+	def logger # :nodoc:
+		@@loger ||= Saferpay.setup_logging
+	end
+	
+	def self.logger #:nodoc:
+		@@loger ||= Saferpay.setup_logging
+	end
+
+	#	Setup logging for class
+	def self.setup_logging #:nodoc:
+		@@logger				=	Log4r::Logger.new LOGNAME
+		@@logger.outputters	<<	Log4r::Outputter.stdout
+		begin
+			op							=	Log4r::FileOutputter.new LOGNAME, :filename => "#{LOGDIR}/#{LOGNAME}.log", :trunc => false
+			op.formatter		=	Log4r::PatternFormatter.new(:pattern => "[%c, %d, %l] :: %M")
+			@@logger.outputters	<<	op
+		rescue StandardError
+			@@logger.debug("CANNOT WRITE LOGFILE TO \"#{LOGDIR}/#{LOGNAME}.log\". Proceeding anyway.")
+		end
+		@@logger
+	end
+
+	#	Check installation
+	def self.check_install #:nodoc:
+		unless File.exist?(BASEDIR+EXECUTABLE)
+			raise ConfigError, "No saferpay executable in \"#{BASEDIR}#{EXECUTABLE}\""
+		end
+		
+		unless File.executable?(BASEDIR+EXECUTABLE)
+			raise ConfigError, "Saferpay binary in \"#{BASEDIR}#{EXECUTABLE}\" is not executable"
+		end
+		
+		result	=	%x{#{BASEDIR+EXECUTABLE} --help}
+		# saferpay --help has an exit code of "1", so can't check for success...
+		#unless $?.success?
+		unless result =~ /^SAFERPAY COMMAND LINE UTILITY/
+			raise ConfigError, "Cannot execute \"#{BASEDIR+EXECUTABLE} --help\". Result: #{result}\nExit code: #{$?.inspect}"
+		end
+
+		unless File.exist?(BASEDIR+'config.xml')
+			raise ConfigError, "No config.xml file. Need to run \"saferpay -config\" maybe?"
+		end
+		
+		# Should contain: <IDP MSGTYPE="SetupResponse" GXID="0A5365AB-BCBD-4D72-88C3-32BFD5F09912" CUSTOMERID="99867" VERSION="1" VTAUTOURL="https://www.saferpay.com/user/setup.asp" VTURL="https://www.saferpay.com/vt/Pay.asp" VTKEYID="1-0" CAPTUREURL="https://www.saferpay.com/vt/capture.asp" VTSCRIPTURL="http://www.saferpay.com/OpenSaferpayScript.asp"/>
+		conf	=	File.read(BASEDIR+'config.xml')
+		unless conf =~ /<IDP MSGTYPE="SetupResponse"/
+			raise ConfigError, "config.xml looks borked"
+		end
+		
+		unless File.directory? BASEDIR+'keys'
+			raise ConfigError, "No keys directory; configuration needed"
+		end
+
+		unless File.exist?(BASEDIR+'keys/current')
+			raise ConfigError, "No current key in keys directory"
+		end
+		
+		true	
+	end
+
+	class TransactionParams
+		DEFAULTS	=	{}
+
+		attr_accessor :params, :transaction_id, :token
+		def initialize( params )
+			@params					=	DEFAULTS.merge( params )
+			@transaction_id	=	nil
+			@token				  = nil
+		end
+		
+		def to_s
+			@params.map{|k,v| "#{k.to_s.upcase} #{v}"}.join " -a "
+		end
+	end
+end

data/lib/ruby-saferpay/version.rb

@@ -0,0 +1,9 @@
+module RubySaferpay #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/test_ruby-saferpay.rb

@@ -0,0 +1,162 @@
+require 'yaml'
+require	'tmpdir'
+require 'test/unit'
+require 'lib/ruby-saferpay.rb'
+
+class SaferpayTest < Test::Unit::TestCase
+	def setup
+		@pan				=	"9451123100000004"	# Saferpay test PAN
+		@accountid	=	"99867-94913159"		#	Saferpay test ACCOUNTID
+		@exp				=	"1107"							#	This will change for other test accounts I guess... Might just be three months ahead of Time.now
+		@sfp	= Saferpay.new( @accountid, @pan, @exp )
+		@sfp2	= Saferpay.new( @accountid, @pan, @exp )
+	end
+	
+	def test_install
+		assert_nothing_raised { Saferpay.check_install }
+	end
+	
+	def test_reserve
+		assert_nothing_raised{
+			res	=	@sfp.reserve( 300, "USD" )
+			assert_is_authorization_response res
+		}
+	end
+	
+	def test_reserve_with_bad_params
+		assert_raise( ArgumentError )		{	@sfp.reserve( 300 )						}
+		assert_raise( ArgumentError )		{	@sfp.reserve( "300", "USD" )	}
+		assert_raise( ArgumentError )		{	@sfp.reserve( "300", "300" )	}
+		assert_raise( Saferpay::AttributeError )	{	@sfp.reserve( 300, "OOO" )	}
+	end
+	
+	def test_reserve_with_suported_currency_but_not_in_contract
+		assert_raise( Saferpay::TransactionError )	{ 
+			res	=	@sfp.reserve( 300, "SEK" )
+			assert_is_authorization_response res
+		}
+	end
+	
+	def test_refund
+		res	=	@sfp.reserve( 350, "CHF" )
+		assert_is_authorization_response res		
+	end
+	
+	def test_refund_with_bad_params
+		assert_raise( ArgumentError )		{	@sfp.refund( 300 )					}
+		assert_raise( ArgumentError )		{	@sfp.refund( "300", "USD" )	}
+		assert_raise( ArgumentError )		{	@sfp.refund( "300", "300" )	}
+		assert_raise( Saferpay::AttributeError )	{	@sfp.refund( 300, "OOO" )	}
+		assert_nothing_raised{ @sfp.refund( 10,"EUR" ) }		
+	end
+	
+	def test_refund_last
+		@sfp.reserve( 1000, 'USD' )
+		assert @sfp.refund_last
+	
+		assert_raise( NoMethodError	)		{ @sfp2.refund_last	}
+	end
+	
+	def test_capture
+		@sfp.reserve( 600, 'EUR' )
+		assert @sfp.capture
+		
+		assert_raise( NoMethodError	)		{ @sfp2.capture	}
+	end
+	
+	def test_cancel
+		@sfp.reserve( 600, 'EUR' )
+		@sfp.capture
+		assert @sfp.cancel
+	end
+	
+	def test_debit_card_reserve
+		assert_raise( ArgumentError ) { @sfp.debit_card_reserve	}
+		assert_raise( Saferpay::TransactionError )	{ 
+			@sfp.debit_card_reserve(100200, "EUR", "1234567890", "12345678")
+			assert_is_authorization_response res
+		}		
+	end
+	
+	def test_details
+		assert_raise ( NoMethodError ) { @sfp.details }
+		assert_nothing_raised{
+			@sfp.reserve( 3000, "USD" )
+			@sfp.capture
+			@sfp.details
+		}
+		
+		assert_nothing_raised{
+			res	=	@sfp.reserve( 1000, "USD" )
+			@sfp.capture
+			
+			res2 = @sfp.reserve( 1100, "USD" )
+			@sfp.capture
+			
+			assert_not_equal @sfp.details( res['id'] ), @sfp.details( res2['id'] )
+			assert_not_equal @sfp.details( res['id'] ), @sfp.details
+		}		
+	end
+	
+	def test_pay
+		res	=	@sfp.pay( 4000 )
+		assert_is_inquiry_response res
+	end
+	
+	
+private
+	def assert_is_inquiry_response(res)
+		assert_instance_of Hash, res
+		assert_is_saferpay_response res
+		require_these	=	[:pan, :track2, :exp, :cccountry, :cvc, :accountid, :contractnumber, :amount, :currency, :providerid, :providername, :authcode,:authmessage, :authdate, :application,  :eci, :settled, :settledate, :action, :cancelled, :closed]
+		assert	require_these.all?{ |param| res.has_key? param.to_s },	"Required parameter is missing in response: #{res.inspect}"
+		assert res['msgtype']	== "InquiryResponse",	"Msgtype is not \"InquiryResponse\""
+	end
+
+	#<IDP MSGTYPE="InquiryResponse" 
+		# ID="rItIQfb77lnztAAUfW5Cb6zUr1fA" 
+		# PAN="9451123100000004" 
+		# TRACK2=";9451123100000004=0711?0" 
+		# EXP="0711" 
+		# CCCOUNTRY="XX" 
+		# CVC="no" 
+		# ACCOUNTID="99867-94913159" 
+		# CONTRACTNUMBER="123456789" 
+		# AMOUNT="4000" 
+		# CURRENCY="EUR" 
+		# PROVIDERID="90" 
+		# PROVIDERNAME="Saferpay Test Card" 
+		# AUTHCODE="745000" 
+		# AUTHMESSAGE="" 
+		# AUTHDATE="20070814 12:04:08" 
+		# APPLICATION="Saferpay Card Authorization Interface" 
+		# ECI="0" 
+		# SETTLED="yes" 
+		# SETTLEDATE="20070814 12:04:09" 
+		# ACTION="Debit" 
+		# CANCELLED="no" 
+		# CLOSED="no"
+	#/>
+	def assert_is_authorization_response(res)
+		assert_instance_of Hash, res
+		assert_is_saferpay_response res
+		assert res['msgtype']	== "AuthorizationResponse",	"Msgtype is not \"AuthorizationResponse\""
+		assert res.has_key?( 'result' ),							"No result code received in response"
+		assert res['result'] == "0", 									"Result code is not Zero (\"0\")"
+		assert res.has_key?( 'token' ),								"No token in response"
+		assert res['token']	== "(unused)",						"Token is not \"(unused)\""
+	end
+	
+	def assert_is_saferpay_response(res)
+		assert res.has_key?( 'accountid' ),						"No accountid received in response"
+		assert res['accountid'] == @accountid,				"Accountid is not the test accountid"
+		assert res.has_key?( 'msgtype' ),							"No msgtype in response"
+		assert res.has_key?( 'authcode' ),						"No authcode in response"
+		assert res.has_key?( 'id' ),									"No id in response"
+		assert res.has_key?( 'providerid' ),					"No providerid in response"
+		assert res.has_key?( 'providername' ),				"No providername in response"
+		assert res.has_key?( 'cccountry' ),						"No cccountry in response"
+		assert res.has_key?( 'contractnumber' ),			"No contractnumber in response"		
+	end
+	
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: ruby-saferpay
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+date: 2007-08-15 00:00:00 +02:00
+summary: Ruby interface to the saferpay e-commerce payment provider
+require_paths: 
+- lib
+email: dpalm@elctech.com
+homepage: = ELC-Tecnologies[http://www.elctech.com], http://www.elctech.com
+rubyforge_project: ruby-saferpay
+description: "The SCAI interface is used when the merchant wishes to keep the acquirer on her/his own website for the whole duration of the transaction (client payment details transits through *both* the merchant site and the saferpay database ) whereas VT implies a redirect to the saferpay site.  == FEATURES/PROBLEMS:  * supports both common credit cards and direct debit cards (\"Lastschrift\") * support for VT style payments is incomplete  == SYNOPSIS:  Init (info from saferpay test account; they're the same for all test accounts): @pan        =  \"9451123100000004\"        #  Saferpay test PAN @accountid  =  \"99867-94913159\"          #  Saferpay test ACCOUNTID @exp        =  \"1107\"                    #  This will change for other test accounts I guess... Might just be three months ahead of Time.now @sfp  = Saferpay.new( @accountid, @pan, @exp )  Reserve: <tt>@sfp.reserve(30000, \"USD\")</tt>  Amounts are divided by 100. We're talking cents here, not dollars...  Capture last transaction: <tt>@sfp.capture</tt>  Capture with a transacaton ID \"4hj34hj4hh34h4j3hj4h334\": <tt>@sfp.capture(\"4hj34hj4hh34h4j3hj4h334\")</tt>  == REQUIREMENTS:"
+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
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- David Palm (ELC Tecnologies)
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/ruby-saferpay
+- lib/ruby-saferpay.rb
+- lib/ruby-saferpay/version.rb
+- test/test_ruby-saferpay.rb
+test_files: 
+- test/test_ruby-saferpay.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- ruby-saferpay
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: