breadmachine 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Southerden
+
+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/README.rdoc

@@ -0,0 +1,18 @@
+= breadmachine
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Matt Southerden. See LICENSE for details.

data/lib/breadmachine/dto/card.rb

@@ -0,0 +1,22 @@
+module BreadMachine
+  
+  class Card
+    
+    include BreadMachine::SecureTrading::CardXml
+    
+    attr_accessor :issuer
+    attr_accessor :number
+    attr_accessor :expiry_date
+    attr_accessor :start_date
+    attr_accessor :issue
+    attr_accessor :security_code
+    attr_accessor :transaction_verifier
+    attr_accessor :parent_transaction_reference
+    
+    def initialize(attributes = {})
+      attributes.each { |key, value| send("#{key}=", value) }
+    end
+    
+  end
+  
+end

data/lib/breadmachine/dto/customer_info.rb

@@ -0,0 +1,16 @@
+module BreadMachine
+    
+  class CustomerInfo
+    
+    attr_accessor :name_prefix, :first_name, :middle_name, :last_name, :name_suffix,
+                  :company, :street, :city, :state, :postcode, :iso_2_country,
+                  :telephone, :email,
+                  :accept, :user_agent
+    
+    def initialize(attributes = {})
+      attributes.each { |key, value| send("#{key}=", value) }
+    end
+    
+  end
+    
+end

data/lib/breadmachine/dto/order_info.rb

@@ -0,0 +1,13 @@
+module BreadMachine
+    
+  class OrderInfo
+    
+    attr_accessor :order_reference, :order_information
+    
+    def initialize(attributes = {})
+      attributes.each { |key, value| send("#{key}=", value) }
+    end
+    
+  end
+    
+end

data/lib/breadmachine/dto/three_d_secure_credentials.rb

@@ -0,0 +1,13 @@
+module BreadMachine
+  
+  class ThreeDSecureCredentials
+    
+    attr_accessor :enrolled, :pa_res, :md, :transaction_reference
+    
+    def initialize(attributes = {})
+      attributes.each { |key, value| send("#{key}=", value) }
+    end
+    
+  end
+  
+end

data/lib/breadmachine/extensions/money.rb

@@ -0,0 +1,9 @@
+class Money
+  class << self
+    
+    def sterling(amount)
+      Money.new(amount, "GBP")
+    end
+    
+  end
+end

data/lib/breadmachine/extensions.rb

@@ -0,0 +1 @@
+require 'breadmachine/extensions/money'

data/lib/breadmachine/secure_trading/auth_request.rb

@@ -0,0 +1,38 @@
+module BreadMachine
+  module SecureTrading
+    
+    class AuthRequest
+      
+      def initialize(amount, card, customer_info, order_info, settlement_day = 1)
+        @amount = amount
+        @card = card
+        @customer_info = BreadMachine::SecureTrading::CustomerInfoAuthXml.new(customer_info)
+        @order_info = BreadMachine::SecureTrading::OrderInfoXml.new(order_info)
+        @settlement_day = settlement_day
+      end
+      
+      def response(xml)
+        St3dAuthResponse.new(xml)
+      end
+      
+      def to_xml
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.Request("Type" => "AUTH") {
+          xml.Operation {
+            xml.Amount @amount.cents
+            xml.Currency BreadMachine::SecureTrading::configuration.currency
+            xml.SiteReference BreadMachine::SecureTrading::configuration.site_reference
+            xml.SettlementDay @settlement_day
+          }
+          xml << @customer_info.to_xml
+          xml.PaymentMethod {
+            xml << @card.to_xml
+          }
+          xml << @order_info.to_xml
+        }
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/auth_reversal_request.rb

@@ -0,0 +1,36 @@
+module BreadMachine
+  module SecureTrading
+    
+    class AuthReversalRequest
+      
+      def initialize(transaction, customer_info, order_info)
+        @transaction = transaction
+        @customer_info = BreadMachine::SecureTrading::CustomerInfoAuthXml.new(customer_info)
+        @order_info = BreadMachine::SecureTrading::OrderInfoXml.new(order_info)
+      end
+      
+      def response(xml)
+        St3dAuthResponse.new(xml)
+      end
+      
+      def to_xml
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.Request("Type" => "AUTHREVERSAL") {
+          xml.Operation {
+            xml.SiteReference BreadMachine::SecureTrading::configuration.site_reference
+          }
+          # xml << @customer_info.to_xml
+          xml.PaymentMethod {
+            xml.CreditCard {
+              xml.ParentTransactionReference @transaction.transaction_reference
+              xml.TransactionVerifier @transaction.transaction_verifier
+            }
+          }
+          # xml << @order_info.to_xml
+        }
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/auth_reversal_response.rb

@@ -0,0 +1,6 @@
+module BreadMachine
+  module SecureTrading
+    class AuthReversalResponse
+    end
+  end
+end

data/lib/breadmachine/secure_trading/card_xml.rb

@@ -0,0 +1,23 @@
+module BreadMachine
+  module SecureTrading
+
+    module CardXml
+      
+      def to_xml
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.CreditCard {
+          xml.Type @issuer
+          xml.Number @number
+          xml.ExpiryDate @expiry_date
+          xml.StartDate @start_date
+          xml.Issue @issue
+          xml.SecurityCode @security_code
+          xml.TransactionVerifier @transaction_verifier
+          xml.ParentTransactionReference @parent_transaction_reference
+        }
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/config.rb

@@ -0,0 +1,21 @@
+module BreadMachine
+  module SecureTrading
+    
+    class Config
+      
+      attr_accessor :currency, :site_reference, :term_url, :merchant_name
+      
+      module ClassMethods
+        def configuration
+          @configuration ||= BreadMachine::SecureTrading::Config.new
+        end
+
+        def configure(&block)
+          yield configuration
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/customer_info_auth_xml.rb

@@ -0,0 +1,40 @@
+module BreadMachine
+  module SecureTrading
+    
+    class CustomerInfoAuthXml
+      
+      def initialize(customer_info)
+        @customer_info = customer_info
+      end
+      
+      def to_xml
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.CustomerInfo {
+          xml.Postal {
+            xml.Name {
+              xml.NamePrefix @customer_info.name_prefix
+              xml.FirstName @customer_info.first_name
+              xml.MiddleName @customer_info.middle_name
+              xml.LastName @customer_info.last_name
+              xml.NameSuffix @customer_info.name_suffix
+            }
+            xml.Company @customer_info.company
+            xml.Street @customer_info.street
+            xml.City @customer_info.city
+            xml.StateProv @customer_info.state
+            xml.PostalCode @customer_info.postcode
+            xml.CountryCode @customer_info.iso_2_country
+          }
+          xml.Telecom {
+            xml.Phone @customer_info.telephone
+          }
+          xml.Online {
+            xml.Email @customer_info.email
+          }
+        }
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/customer_info_enrolment_xml.rb

@@ -0,0 +1,21 @@
+module BreadMachine
+  module SecureTrading
+    
+    class CustomerInfoEnrolmentXml
+      
+      def initialize(customer_info)
+        @customer_info = customer_info
+      end
+      
+      def to_xml
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.CustomerInfo {
+          xml.Accept @customer_info.accept
+          xml.UserAgent @customer_info.user_agent
+        }
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/order_info_xml.rb

@@ -0,0 +1,21 @@
+module BreadMachine
+  module SecureTrading
+    
+    class OrderInfoXml
+      
+      def initialize(order_info)
+        @order_info = order_info
+      end
+      
+      def to_xml
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.Order {
+          xml.OrderReference @order_info.order_reference
+          xml.OrderInformation @order_info.order_information
+        }
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/payment_methods.rb

@@ -0,0 +1,28 @@
+module BreadMachine
+  module SecureTrading
+    
+    module PaymentMethods
+      
+      def auth(*args)
+        request = SecureTrading::AuthRequest.new(*args)
+        return SecureTrading::XPay.exchange(request)
+      end
+      
+      def three_d_secure_enrolled?(*args)
+        request = SecureTrading::St3dCardQueryRequest.new(*args)
+        return SecureTrading::XPay.exchange(request)
+      end
+
+      def three_d_auth(*args)
+        request = SecureTrading::St3dAuthRequest.new(*args)
+        return SecureTrading::XPay.exchange(request)
+      end
+      
+      def reverse(*args)
+        request = SecureTrading::AuthReversalRequest.new(*args)
+        return SecureTrading::XPay.exchange(request)
+      end
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/st_3d_auth_request.rb

@@ -0,0 +1,41 @@
+module BreadMachine
+  module SecureTrading
+    
+    class St3dAuthRequest
+      
+      def initialize(amount, card, customer_info, order_info, three_d_secure, settlement_day = 1)
+        @amount = amount
+        @card = card
+        @card.parent_transaction_reference = three_d_secure.transaction_reference
+        @customer_info = BreadMachine::SecureTrading::CustomerInfoAuthXml.new(customer_info)
+        @order_info = BreadMachine::SecureTrading::OrderInfoXml.new(order_info)
+        @three_d_secure = BreadMachine::SecureTrading::ThreeDSecureCredentialsXml.new(three_d_secure)
+        @settlement_day = settlement_day
+      end
+      
+      def response(xml)
+        St3dAuthResponse.new(xml)
+      end
+      
+      def to_xml
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.Request("Type" => "ST3DAUTH") {
+          xml.Operation {
+            xml.Amount @amount.cents
+            xml.Currency BreadMachine::SecureTrading::configuration.currency
+            xml.SiteReference BreadMachine::SecureTrading::configuration.site_reference
+            xml.SettlementDay @settlement_day
+          }
+          xml << @customer_info.to_xml
+          xml.PaymentMethod {
+            xml << @card.to_xml
+            xml << @three_d_secure.to_xml
+          }
+          xml << @order_info.to_xml
+        }
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/st_3d_auth_response.rb

@@ -0,0 +1,25 @@
+module BreadMachine
+  module SecureTrading
+    
+    class St3dAuthResponse
+      
+      def initialize(xml)
+        @xml = Nokogiri::XML.parse(xml)
+      end
+      
+      def successful?
+        @xml.xpath('//OperationResponse/Result').text == "1"
+      end
+      
+      def transaction_reference
+        @xml.xpath('//OperationResponse/TransactionReference').text
+      end
+      
+      def transaction_verifier
+        @xml.xpath('//OperationResponse/TransactionVerifier').text
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/st_3d_card_query_request.rb

@@ -0,0 +1,37 @@
+module BreadMachine
+  module SecureTrading
+    
+    class St3dCardQueryRequest
+      
+      def initialize(amount, card, customer_info, order_info)
+        @amount = amount
+        @customer_info = BreadMachine::SecureTrading::CustomerInfoEnrolmentXml.new(customer_info)
+        @order_info = BreadMachine::SecureTrading::OrderInfoXml.new(order_info)
+        @card = card
+      end
+      
+      def response(xml)
+        St3dCardQueryResponse.new(xml)
+      end
+      
+      def to_xml
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.Request("Type" => "ST3DCARDQUERY") {
+          xml.Operation {
+            xml.Amount @amount.cents
+            xml.Currency BreadMachine::SecureTrading::configuration.currency
+            xml.SiteReference BreadMachine::SecureTrading::configuration.site_reference
+            xml.TermUrl BreadMachine::SecureTrading::configuration.term_url
+            xml.MerchantName BreadMachine::SecureTrading::configuration.merchant_name
+          }
+          xml << @customer_info.to_xml
+          xml.PaymentMethod {
+            xml << @card.to_xml
+          }
+          xml << @order_info.to_xml
+        }
+      end
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/st_3d_card_query_response.rb

@@ -0,0 +1,46 @@
+module BreadMachine
+  module SecureTrading
+    
+    class St3dCardQueryResponse
+      
+      def initialize(xml)
+        @xml = Nokogiri::XML.parse(xml)
+      end
+      
+      def successful?
+        @xml.xpath('//OperationResponse/Result').text == "1"
+      end
+      
+      def enrolled
+        {
+          'N/A' => :na,
+          'Y'   => :yes,
+          'N'   => :no,
+          'U'   => :unknown
+        }[@xml.xpath('//OperationResponse/Enrolled').text]
+      end
+      
+      def md
+        @xml.xpath('//OperationResponse/MD').text
+      end
+      
+      def pa_req
+        @xml.xpath('//OperationResponse/PaReq').text
+      end
+      
+      def acs_url
+        @xml.xpath('//OperationResponse/AcsUrl').text
+      end
+      
+      def transaction_reference
+        @xml.xpath('//OperationResponse/TransactionReference').text
+      end
+      
+      def auth_type
+        BreadMachine::SecureTrading::St3dAuthRequest
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/three_d_secure_credentials_xml.rb

@@ -0,0 +1,23 @@
+module BreadMachine
+  module SecureTrading
+    
+    class ThreeDSecureCredentialsXml
+      
+      def initialize(credentials)
+        @credentials = credentials
+      end
+      
+      def to_xml
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.ThreeDSecure {
+          xml.Enrolled @credentials.enrolled
+          xml.PaRes @credentials.pa_res
+          xml.MD @credentials.md
+          xml.TransactionReference @credentials.transaction_reference
+        }
+      end
+      
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/xpay.rb

@@ -0,0 +1,25 @@
+module BreadMachine
+  module SecureTrading
+
+    class XPay
+      def self.exchange(request)
+        
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.RequestBlock('Version' => '3.51') do |request_block|
+          request_block << request.to_xml
+          xml.Certificate BreadMachine::SecureTrading::configuration.site_reference
+        end
+
+        response_xml = nil
+        
+        XPaySocket.open("localhost", 5000) do |socket|
+          socket.write xml.xml
+          response_xml = socket.read
+        end
+        
+        request.response(response_xml)
+      end
+    end
+    
+  end
+end

data/lib/breadmachine/secure_trading/xpay_socket.rb

@@ -0,0 +1,22 @@
+module BreadMachine
+  module SecureTrading
+    
+    # This currently just delegates to TCPSocket, but this is where we will
+    # inject Fake Socket behaviour to disconnect from having the XPay
+    # client running during testing
+
+    class XPaySocket
+      
+      class << self
+        
+        def open(*args, &block)
+          TCPSocket.open(*args, &block)
+        end
+        
+      end
+      
+    end
+    
+  end
+end
+

data/lib/breadmachine/secure_trading.rb

@@ -0,0 +1,32 @@
+module BreadMachine
+  
+  module SecureTrading
+
+    autoload :Config, 'breadmachine/secure_trading/config'
+    autoload :PaymentMethods, 'breadmachine/secure_trading/payment_methods'
+
+    autoload :XPay, 'breadmachine/secure_trading/xpay'
+    autoload :XPaySocket, 'breadmachine/secure_trading/xpay_socket'
+
+    autoload :CardXml, 'breadmachine/secure_trading/card_xml'
+    
+    autoload :CustomerInfoAuthXml, 'breadmachine/secure_trading/customer_info_auth_xml'
+    autoload :CustomerInfoEnrolmentXml, 'breadmachine/secure_trading/customer_info_enrolment_xml'
+    autoload :ThreeDSecureCredentialsXml, 'breadmachine/secure_trading/three_d_secure_credentials_xml'
+    autoload :OrderInfoXml, 'breadmachine/secure_trading/order_info_xml'
+
+    autoload :St3dCardQueryRequest, 'breadmachine/secure_trading/st_3d_card_query_request'
+    autoload :St3dCardQueryResponse, 'breadmachine/secure_trading/st_3d_card_query_response'
+    
+    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'
+
+    extend BreadMachine::SecureTrading::Config::ClassMethods
+    
+  end
+  
+end

data/lib/breadmachine.rb

@@ -0,0 +1,27 @@
+require 'money'
+require 'nokogiri'
+require 'builder'
+
+require 'breadmachine/extensions'
+
+require 'breadmachine/secure_trading'
+
+module BreadMachine
+  
+  autoload :Card, 'breadmachine/dto/card'
+  autoload :CustomerInfo, 'breadmachine/dto/customer_info'
+  autoload :OrderInfo, 'breadmachine/dto/order_info'
+  autoload :ThreeDSecureCredentials, 'breadmachine/dto/three_d_secure_credentials'
+  
+  extend SecureTrading::PaymentMethods
+  
+end
+
+class Builder::XmlBase
+  
+  # Make generated xml easier to read by indenting appended xml strings out to
+  # the current indent level.
+  def <<(text)
+    _text(text.indent(@level * @indent))
+  end
+end