breadmachine 0.0.0 → 0.0.1

data/lib/breadmachine/secure_trading/xpay.rb

@@ -2,24 +2,135 @@ module BreadMachine
   module SecureTrading
 
     class XPay
+
+      # A class method which wraps the individual request block with the
+      # necessary xml for the XPay gateway.  Once the request is wrapped, this
+      # method writes it to the Xpay client and returns the response.
+      #
       def self.exchange(request)
-        
+        xpay = self.new
+        xpay.exchange(request)
+      end
+      
+      def exchange(request, retries = 3)
+        request_xml = generate_xml(request)
+        begin
+          response_xml = exchange_with_xpay_client(request_xml)
+          response = request.response(response_xml)
+          handle_errors(response)
+          return response
+        rescue BreadMachine::GatewayConnectionError
+          retry unless (retries -= 1) == 0
+          raise
+        end
+      end
+      
+      protected
+      
+      def generate_xml(request)
         xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.instruct!
         xml.RequestBlock('Version' => '3.51') do |request_block|
           request_block << request.to_xml
           xml.Certificate BreadMachine::SecureTrading::configuration.site_reference
         end
-
-        response_xml = nil
-        
+        return xml.to_s
+      end
+      
+      def exchange_with_xpay_client(request_xml)
         XPaySocket.open("localhost", 5000) do |socket|
-          socket.write xml.xml
-          response_xml = socket.read
+          socket.write request_xml
+          socket.read
+        end
+      end
+      
+      # Error codes from Xpay API documentation
+      #
+      # 100   Timeout reading from socket:
+      #       ST Xpay did not receive the full XML in the given time from your
+      #       application.
+      # 
+      # 101   Error reading from socket:
+      #       ST Xpay did not receive a correct connection request from your
+      #       application.
+      # 
+      # 1000  Failed to connect to a payment gateway:
+      #       The ST Xpay client was unable to find a payment gateway.
+      # 
+      # 1100  Failed to receive from payment gateway:
+      #       ST Xpay did not receive any response from the payment gateway.
+      # 
+      # 2100  Missing SiteReference or Certificate tag:
+      #       The XML ST Xpay received was missing the site reference and/or 
+      #       your secure ST Xpay certificate.
+      #
+      # 2500  [Various messages - One of the fields contains an invalid value]:
+      #       The information returned contains the field name that was omitted 
+      #       from the request or contained incorrect information.
+      #
+      # 3000  Gateway error:
+      #       A SecureTrading payment gateway failed to receive a full ST Xpay
+      #       request.
+      #
+      # 3010  Transaction Not Received Successfully:
+      #       A SecureTrading payment gateway obtained the request but failed to
+      #       decrypt it.
+      #
+      # 3100  Error with transaction details:
+      #       The data retrieved was incorrectly defined.
+      #
+      # 3100  Error in XML: Unknown Transaction Type:
+      #       The Request Type attribute was incorrect.
+      #
+      # 3100  Error Parsing XML (invalid site reference for this certificate):
+      #       The certificate included in the XML request is invalid for the
+      #       SecureTrading sitereference included in the XML.
+      #
+      # 3100  Gateway Connection Error:
+      #       The data obtained by ST Xpay was incorrect.
+      #
+      # 3100  Error parsing XML: [+reason]
+      #       The gateway obtained invalid XML.
+      #
+      # 3100  Invalid Merchant Configuration:
+      #       Merchant data on the gateway is inconsistent with merchant
+      #       information in the XML (For example. invalid currency,
+      #       payment type, etc).
+      #
+      # 3330  Transaction storage failure. Please try again later:
+      #       Gateway failed to store the transaction details before
+      #       authorisation.
+      #
+      # 3350  Transaction acceptance failure. Please try again later: 
+      #       Gateway failed to update the transaction details after performing
+      #       the authorisation.
+      # 
+      # 5000  Transport Error:
+      #       Failed to connect to acquiring bank or the acquiring bank did not
+      #       respond.
+      #
+      # 5100  Missing TransactionReference:
+      #       The transaction cannot be found in the database.
+      # 
+      # 10500 Various Message:
+      #       Xpay4 was unable to process your request.
+      #
+      def handle_errors(response)
+        if response.error?
+          message = response.message
+          case message.match(/\((\d+)\)/)[1].to_i
+            when 100, 101, 1000, 1100, 3000, 3010, 3330, 3350, 5000:
+              raise BreadMachine::GatewayConnectionError.new(message)
+            when 2100, 3100:
+              raise BreadMachine::MerchantConfigurationError.new(message)
+            when 2500, 5100, 10500:
+              raise BreadMachine::MerchantRequestError.new(message)
+          end
         end
-        
-        request.response(response_xml)
       end
+      
     end
-    
+
   end
-end
+end
+

data/lib/breadmachine/secure_trading/xpay_response.rb

@@ -0,0 +1,29 @@
+module BreadMachine
+  module SecureTrading
+    
+    class XpayResponse
+      
+      def initialize(xml)
+        @xml = Nokogiri::XML.parse(xml)
+      end
+      
+      # Checks whether there has been an error somewhere in the chain of servers
+      # which are processing your request (for example, if Visa's server cacked,
+      # or XPay had an internal error, this would come back as true).
+      #
+      def error?
+        result == '0'
+      end
+      
+      def result
+        @xml.xpath('//OperationResponse/Result').text
+      end
+      
+      def message
+        @xml.xpath('//OperationResponse/Message').text
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/xpay_socket.rb

@@ -10,7 +10,11 @@ module BreadMachine
       class << self
         
         def open(*args, &block)
-          TCPSocket.open(*args, &block)
+          begin
+            return TCPSocket.open(*args, &block)
+          rescue Errno::ECONNREFUSED
+            raise BreadMachine::GatewayConnectionError
+          end
         end
         
       end

data/lib/breadmachine/secure_trading.rb

@@ -7,6 +7,7 @@ module BreadMachine
 
     autoload :XPay, 'breadmachine/secure_trading/xpay'
     autoload :XPaySocket, 'breadmachine/secure_trading/xpay_socket'
+    autoload :XpayResponse, 'breadmachine/secure_trading/xpay_response'
 
     autoload :CardXml, 'breadmachine/secure_trading/card_xml'
     
@@ -21,9 +22,10 @@ module BreadMachine
     autoload :St3dAuthRequest, 'breadmachine/secure_trading/st_3d_auth_request'
     autoload :St3dAuthResponse, 'breadmachine/secure_trading/st_3d_auth_response'
     
-    autoload :AuthReversalRequest, 'breadmachine/secure_trading/auth_reversal_request'
     autoload :AuthRequest, 'breadmachine/secure_trading/auth_request'
-    # autoload :AuthResponse, 'breadmachine/secure_trading/st_3d_auth_response'
+
+    autoload :AuthReversalRequest, 'breadmachine/secure_trading/auth_reversal_request'
+    autoload :AuthReversalResponse, 'breadmachine/secure_trading/auth_reversal_response'
 
     extend BreadMachine::SecureTrading::Config::ClassMethods
     

data/lib/breadmachine.rb

@@ -1,9 +1,9 @@
 require 'money'
 require 'nokogiri'
 require 'builder'
+require 'activesupport'
 
 require 'breadmachine/extensions'
-
 require 'breadmachine/secure_trading'
 
 module BreadMachine
@@ -24,4 +24,9 @@ class Builder::XmlBase
   def <<(text)
     _text(text.indent(@level * @indent))
   end
-end
+end
+
+class BreadMachine::Exception < Exception; end;
+class BreadMachine::GatewayConnectionError < BreadMachine::Exception; end;
+class BreadMachine::MerchantConfigurationError < BreadMachine::Exception; end;
+class BreadMachine::MerchantRequestError < BreadMachine::Exception; end;

data/spec/secure_trading/auth_request_spec.rb

@@ -2,16 +2,25 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe BreadMachine::SecureTrading::AuthRequest do
   
-  it "should validate input data when initialized"
-
+  it "should ensure amount is Money of correct currency" do
+    BreadMachine::SecureTrading.configuration.currency = 'USD'
+    amount = Money.new(200_00, 'GBP')
+    
+    lambda {
+      @request = described_class.new(amount, @card, @customer_info, @order_info, @settlement_day)
+    }.should raise_error ArgumentError, "Currency mismatch"
+  end
+  
   describe "XML generation" do
     
     before(:each) do
+      BreadMachine::SecureTrading.configuration.currency = 'GBP'
       @amount = Money.sterling(12_99)
       @card = BreadMachine::Card.make
       @customer_info = BreadMachine::CustomerInfo.make(:auth)
       @order_info = BreadMachine::OrderInfo.make
-      @request = described_class.new(@amount, @card, @customer_info, @order_info)
+      @settlement_day = 1
+      @request = described_class.new(@amount, @card, @customer_info, @order_info, @settlement_day)
     end
     
     it "should set correct request type" do
@@ -35,10 +44,6 @@ describe BreadMachine::SecureTrading::AuthRequest do
       end
     end
     
-    it "should ensure amount is Money of correct currency" do
-      pending "Check that currency of amount matches currency specified in config"
-    end
-    
     it "should append CustomerInfo element" do
       request_xml.should have_tag("Request/CustomerInfo")
     end

data/spec/secure_trading/card_xml_spec.rb

@@ -1,54 +1,80 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-class TestCard
-  attr_accessor :issuer, :number, :expiry_date, :start_date, :issue, :security_code, :parent_transaction_reference
-  include BreadMachine::SecureTrading::CardXml
-end
-
 describe BreadMachine::SecureTrading::CardXml do
   
-  describe "xml representation generation" do
+  subject do
+    described_class.new(@card)
+  end
+  
+  def xml
+    Nokogiri::XML::Document.parse(subject.to_xml)
+  end
+
+  describe "xml representation from card" do
     
     before(:each) do
-      @card = TestCard.new
+      @card = BreadMachine::Card.new
     end
-    
+
     it "should have CreditCard root element" do
-      xml(@card).should have_tag('/CreditCard')
+      xml.should have_tag('/CreditCard')
     end
     
     it "should have correct Type element" do
       @card.issuer = 'Maestro'
-      xml(@card).should have_tag("CreditCard/Type", 'Maestro')
+      xml.should have_tag("CreditCard/Type", 'Maestro')
     end
     
     it "should have correct Number element" do
       @card.number = 6759050000000005
-      xml(@card).should have_tag("CreditCard/Number", '6759050000000005')
+      xml.should have_tag("CreditCard/Number", '6759050000000005')
     end
     
     it "should have correct ExpiryDate element" do
       @card.expiry_date = '07/11'
-      xml(@card).should have_tag("CreditCard/ExpiryDate", '07/11')
+      xml.should have_tag("CreditCard/ExpiryDate", '07/11')
     end
     
     it "should have correct StartDate element" do
       @card.start_date = '03/08'
-      xml(@card).should have_tag("CreditCard/StartDate", '03/08')
+      xml.should have_tag("CreditCard/StartDate", '03/08')
     end
     
     it "should have correct Issue element" do
       @card.issue = 2
-      xml(@card).should have_tag("CreditCard/Issue", '2')
+      xml.should have_tag("CreditCard/Issue", '2')
     end
     
     it "should have correct SecurityCode element" do
       @card.security_code = 789
-      xml(@card).should have_tag("CreditCard/SecurityCode", '789')
+      xml.should have_tag("CreditCard/SecurityCode", '789')
+    end
+    
+    it "should have correct ParentTransactionReference element" do
+      @card.transaction_reference = '13-2-9875373'
+      xml.should have_tag("CreditCard/ParentTransactionReference", '13-2-9875373')
+    end
+    
+  end
+  
+  describe "xml representation from transaction" do
+    
+    before(:each) do
+      @card = BreadMachine::Card.new
+    end
+    
+    it "should have CreditCard root element" do
+      xml.should have_tag('/CreditCard')
+    end
+    
+    it "should have correct TransactionVerifier element" do
+      @card.transaction_verifier = 'A_TRANSACTION_VERIFIER'
+      xml.should have_tag("CreditCard/TransactionVerifier", 'A_TRANSACTION_VERIFIER')
     end
     
-    def xml(card)
-      Nokogiri::XML::Document.parse(card.to_xml)
+    it "should have correct ParentTransactionReference element" do
+      @card.transaction_reference = 'A_TRANSACTION_REFERENCE'
+      xml.should have_tag("CreditCard/ParentTransactionReference", 'A_TRANSACTION_REFERENCE')
     end
     
   end

data/spec/secure_trading/order_info_xml_spec.rb

@@ -18,12 +18,12 @@ describe BreadMachine::SecureTrading::OrderInfoXml do
     generated_xml.should have_tag('/Order')
   end
 
-  it "should have correct Phone" do
+  it "should have correct OrderReference" do
     @order_info.order_reference = 'Order 12345'
     generated_xml.should have_tag('Order/OrderReference', 'Order 12345')
   end
   
-  it "should have correct Email" do
+  it "should have correct OrderInformation" do
     @order_info.order_information = '1 Bag of Assorted Widgets'
     generated_xml.should have_tag('Order/OrderInformation', '1 Bag of Assorted Widgets')
   end

data/spec/secure_trading/st_3d_auth_request_spec.rb

@@ -2,17 +2,26 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe BreadMachine::SecureTrading::St3dAuthRequest do
   
-  it "should validate input data when initialized"
-
+  it "should ensure amount is Money of correct currency" do
+    BreadMachine::SecureTrading.configuration.currency = 'USD'
+    amount = Money.new(200_00, 'GBP')
+    
+    lambda {
+      @request = described_class.new(amount, @card, @customer_info, @order_info, @three_d, @settlement_day)
+    }.should raise_error ArgumentError, "Currency mismatch"
+  end
+  
   describe "XML generation" do
     
     before(:each) do
+      BreadMachine::SecureTrading.configuration.currency = 'GBP'
       @amount = Money.sterling(12_99)
       @card = BreadMachine::Card.make
       @customer_info = BreadMachine::CustomerInfo.make(:auth)
       @order_info = BreadMachine::OrderInfo.make
       @three_d = BreadMachine::ThreeDSecureCredentials.make
-      @request = described_class.new(@amount, @card, @customer_info, @order_info, @three_d)
+      @settlement_day = 1
+      @request = described_class.new(@amount, @card, @customer_info, @order_info, @three_d, @settlement_day)
     end
     
     it "should set correct request type" do
@@ -36,10 +45,6 @@ describe BreadMachine::SecureTrading::St3dAuthRequest do
       end
     end
     
-    it "should ensure amount is Money of correct currency" do
-      pending "Check that currency of amount matches currency specified in config"
-    end
-    
     it "should append CustomerInfo element" do
       request_xml.should have_tag("Request/CustomerInfo")
     end

data/spec/secure_trading/st_3d_card_query_request_spec.rb

@@ -2,11 +2,19 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe BreadMachine::SecureTrading::St3dCardQueryRequest do
   
-  it "should validate input data when initialized"
+  it "should ensure amount is Money of correct currency" do
+    BreadMachine::SecureTrading.configuration.currency = 'USD'
+    amount = Money.new(200_00, 'GBP')
+    
+    lambda {
+      @request = described_class.new(amount, @card, @customer_info, @order_info)
+    }.should raise_error ArgumentError, "Currency mismatch"
+  end
 
   context "XML generation" do
     
     before(:each) do
+      BreadMachine::SecureTrading.configuration.currency = 'GBP'
       @card = BreadMachine::Card.make
       @customer_info = BreadMachine::CustomerInfo.make(:card_query)
       @order_info = BreadMachine::OrderInfo.make
@@ -25,7 +33,7 @@ describe BreadMachine::SecureTrading::St3dCardQueryRequest do
         config.term_url = 'http://www.example.com'
         config.merchant_name = "Bob's Widgets Inc."
       end
-      amount = Money.sterling(10_99)
+      amount = Money.us_dollar(10_99)
       
       @request = described_class.new(amount, @card, @customer_info, @order_info)
       
@@ -38,6 +46,15 @@ describe BreadMachine::SecureTrading::St3dCardQueryRequest do
       request_xml.should have_tag("Operation/MerchantName", "Bob's Widgets Inc.")
     end
     
+    it "should append to term_url if set in options" do
+      BreadMachine::SecureTrading.configuration.term_url = 'http://www.example.com'
+      options = {:term_url_append => '/some_value'}
+      
+      @request = described_class.new(@amount, @card, @customer_info, @order_info, options)
+      
+      request_xml.should have_tag("Operation/TermUrl", "http://www.example.com/some_value")
+    end
+    
     it "should append CustomerInfo element" do
       request_xml.should have_tag("Request/CustomerInfo")
     end
@@ -45,13 +62,7 @@ describe BreadMachine::SecureTrading::St3dCardQueryRequest do
     it "should append PaymentMethod element" do
       request_xml.should have_tag("Request/PaymentMethod")
     end
-    
-    it "should ensure amount is Money of correct currency" do
-      pending "Check that currency of amount matches currency specified in config"
-    end
         
-    it "should populate PaymentMethod element with correct data when querying from a previous ParentTransactionReference"
-    
     it "should append Order element" do
       request_xml.should have_tag("Request/Order")
     end

data/spec/secure_trading/st_3d_card_query_response_spec.rb

@@ -2,52 +2,109 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe BreadMachine::SecureTrading::St3dCardQueryResponse do
   
-  it "should be successful when Success element is 1" do
-    # TODO: this should probably be pushed up into a generic Response
-    @response = described_class.new(successful_response)
-    @response.should be_successful
+  describe "#successful?" do
+
+    it "should be successful when Result element is 1" do
+      response = described_class.new(successful_response(result = 1))
+      response.should be_successful
+    end
+
+    it "should be successful when Result element is 2" do
+      response = described_class.new(successful_response(result = 2))
+      response.should be_successful
+    end
+
+    it "should not be successful when Result element is 0" do
+      response = described_class.new(failed_response)
+      response.should_not be_successful
+    end
+
   end
   
-  it "should not be successful when Success element is 0" do
-    # TODO: this should probably be pushed up into a generic Response
-    @response = described_class.new(failed_response)
-    @response.should_not be_successful
+  describe "#error?" do
+    
+    it "should be error when Result element is 0" do
+      response = described_class.new(failed_response)
+      response.should be_error
+    end
+
+    it "should not be error when Result element is 1" do
+      response = described_class.new(successful_response(result = 1))
+      response.should_not be_error
+    end
+
+    it "should not be error when Result element is 2" do
+      response = described_class.new(successful_response(result = 2))
+      response.should_not be_error
+    end
+    
   end
   
-  it "should select PaReq" do
-    @response = described_class.new(successful_response)
-    @response.pa_req.should == "EXAMPLE-PA-REQ"
-  end
+  describe "accessors" do
   
-  it "should select MD" do
-    @response = described_class.new(successful_response)
-    @response.md.should == "EXAMPLE-MD"
-  end
+    it "should select PaReq" do
+      response = described_class.new(successful_response)
+      response.pa_req.should == "EXAMPLE-PA-REQ"
+    end
   
-  it "should select AcsUrl" do
-    @response = described_class.new(successful_response)
-    @response.acs_url.should == "https://securetrading.net/secureweb/testacs0.cgi"
-  end
+    it "should select MD" do
+      response = described_class.new(successful_response)
+      response.md.should == "EXAMPLE-MD"
+    end
+  
+    it "should select AcsUrl" do
+      response = described_class.new(successful_response)
+      response.acs_url.should == "https://securetrading.net/secureweb/testacs0.cgi"
+    end
   
-  it "should select TranscationReference" do
-    @response = described_class.new(successful_response)
-    @response.transaction_reference.should == "15-9-1266891"
+    it "should select TranscationReference" do
+      response = described_class.new(successful_response)
+      response.transaction_reference.should == "15-9-1266891"
+    end
+    
+    it "should select Enrolled" do
+      response = described_class.new(successful_response)
+      response.enrolled.should == "Y"
+    end
+    
   end
   
-  def successful_response
-    enrolled_response
+  describe "Auth type" do
+    
+    it "should return s3 secure auth for auth type when card is enrolled" do
+      response = described_class.new(successful_response(result = 1, enrolled = 'Y'))
+      response.auth_type.should == BreadMachine::SecureTrading::St3dAuthRequest
+    end
+    
+    it "should return s3 secure auth for auth type when card is not enrolled" do
+      response = described_class.new(successful_response(result = 1, enrolled = 'N'))
+      response.auth_type.should == BreadMachine::SecureTrading::St3dAuthRequest
+    end
+
+    it "should return standard auth for auth type when card provider is not part of scheme" do
+      response = described_class.new(successful_response(result = 2))
+      response.auth_type.should == BreadMachine::SecureTrading::AuthRequest
+    end
+    
+    it "should return standard auth for auth type when response is error" do
+      response = described_class.new(successful_response(result = 0))
+      response.auth_type.should == BreadMachine::SecureTrading::AuthRequest
+    end
+    
   end
+
+
   
-  def enrolled_response
-    <<-EOS
+  def successful_response(result = 1, enrolled = 'Y')
+    <<-XML
     <ResponseBlock Live="FALSE" Version="3.51">
       <Response Type="ST3DCARDQUERY">
         <OperationResponse>
           <TransactionReference>15-9-1266891</TransactionReference>
           <TransactionCompletedTimestamp>2009-09-24 14:50:41</TransactionCompletedTimestamp>
           <TransactionVerifier>AY4LBwreQ1qwbPpuH5PswO4eN7KD27qmNBLG03tCrhBSzLpRXKBXw+PwY7dcuzuGoQXAPVB7phZYZhcP8YcBy9LFXO8zRW02QaHhXXykY7+ekmsYdNGEYjeLE8wI2vUGpD9IrGySGgYQySq1zIFg1wtUg4LmyrlAlUyQUOvPof8c=</TransactionVerifier>
-          <Result>1</Result>
-          <Enrolled>Y</Enrolled>
+          <Result>#{result}</Result>
+          <Enrolled>#{enrolled}</Enrolled>
           <Html></Html>
           <MD>EXAMPLE-MD</MD>
           <PaReq>EXAMPLE-PA-REQ</PaReq>
@@ -60,7 +117,7 @@ describe BreadMachine::SecureTrading::St3dCardQueryResponse do
         </Order>
       </Response>
     </ResponseBlock>
-    EOS
+    XML
   end
   
   def failed_response

data/spec/secure_trading/st_auth_reversal_request_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe BreadMachine::SecureTrading::AuthReversalRequest do
+  
+  before(:each) do
+    transaction = mock('transaction')
+    transaction.stub(:transaction_reference => 'A_TRANSACTION_REFERENCE')
+    transaction.stub(:transaction_verifier => 'A_TRANSACTION_VERIFIER')
+    @order_info = BreadMachine::OrderInfo.make
+    @request = described_class.new(transaction, @order_info)
+  end
+
+  describe "XML generation" do
+    
+    def xml
+      Nokogiri::XML::Document.parse(@request.to_xml)
+    end
+    
+    it "should set correct request type" do
+      xml.should have_tag("/Request[@Type='AUTHREVERSAL']")
+    end
+    
+    it "should populate Operation element with correct data" do
+      BreadMachine::SecureTrading.configuration.site_reference = 'site12345'
+      
+      xml.should have_tag("Request/Operation")
+      xml.should have_tag("Operation/SiteReference", "site12345")
+    end
+
+    it "should append CreditCard element" do
+      xml.should have_tag("Request/PaymentMethod/CreditCard")
+    end
+        
+    it "should append Order element" do
+      xml.should have_tag("Request/Order")
+    end
+  end
+  
+  it "should return correct response" do
+    @request.response('<xml>').should be_a(BreadMachine::SecureTrading::AuthReversalResponse)
+  end
+end