xpay 0.0.5 → 0.0.6

data/README.rdoc

@@ -11,6 +11,8 @@ http://www.securetrading.com/support/xpay.html for futher details, in depth spec
  $ gem install xpay
 
  * configure by either creating a yaml file at config/xpay.yml or call Xpay.set_config with a hash
+ * (make sure to use Xpay.set_config(options_hash) instead of setting the options direct as that would
+ * prevent the new xml from being generated)
  * the following options can be set:
     - merchant_name
     - version
@@ -20,7 +22,7 @@ http://www.securetrading.com/support/xpay.html for futher details, in depth spec
     - callback_url
 
 == Usage
- === An example of a 3D-Secure Transaction
+ * An example of a 3D-Secure Transaction
 
      -first: create the class instance for CreditCard, Customer and Operatioon
 
@@ -93,7 +95,7 @@ http://www.securetrading.com/support/xpay.html for futher details, in depth spec
 
          The possible values of rt are as above.
 
- === more examples to follow
+ * more examples to follow
 
 
 == Copyright

data/Rakefile

@@ -16,6 +16,7 @@ namespace :test do
   Rake::TestTask.new(:unit) do |test|
     test.libs << 'lib' << 'test'
     test.ruby_opts << '-rubygems'
+    test.test_files = FileList['test/*_test.rb']
     test.pattern   = 'test/xpay/**/*_test.rb'
     test.verbose = true
   end

data/UPGRADES

@@ -7,3 +7,11 @@
 
 0.0.3 => 0.0.4
   * bug fixed that prevents loading of MerchantName from config and create root xml
+
+0.0.4 => 0.0.5
+  * bug fix that prevents having a return value on make_payment with non ST3DCARDQUERY as request
+
+0.0.5 => 0.0.6
+  * bug fixed that prevents changing the config via hash
+  * added TransactionQuery as class that allows to query previous transactions
+  * force Issue number into string in CreditCard when given as Integer

data/lib/xpay.rb

@@ -20,6 +20,7 @@ module Xpay
   # default_currency: GBP
 
   autoload :Payment, 'xpay/payment'
+  autoload :TransactionQuery, 'xpay/transaction_query'
   autoload :CreditCard, 'xpay/core/creditcard'
   autoload :Customer, 'xpay/core/customer'
   autoload :Operation, 'xpay/core/operation'
@@ -45,6 +46,7 @@ module Xpay
   end
 
   class PaResMissing      < XpayError; end
+  class AttributeMissing  < XpayError; end
   class General           < XpayError; end
 
   class << self
@@ -75,6 +77,7 @@ module Xpay
       conf.each do |key, value|
         @xpay_config.send("#{key}=", value) if @xpay_config.respond_to? key
       end
+      @request_xml = create_root_xml
       return true
     end
 
@@ -94,6 +97,8 @@ module Xpay
       operation = request.add_element "Operation"
       site_ref = operation.add_element "SiteReference"
       site_ref.text = config.site_reference
+      operation.add_element("Currency").text = config.default_currency if config.default_currency 
+      operation.add_element("SettlementDay").text = config.settlement_day if config.settlement_day 
       if config.default_query == "ST3DCARDQUERY"
         mn = operation.add_element "MerchantName"
         mn.text = config.merchant_name

data/lib/xpay/core/creditcard.rb

@@ -2,6 +2,7 @@ module Xpay
   class CreditCard
     attr_accessor :card_type, :valid_until, :valid_from, :issue, :parent_transaction_ref, :transaction_verifier
     attr_writer :security_code
+
     def initialize(options={})
       if !options.nil? && options.is_a?(Hash)
         options.each do |key, value|
@@ -18,6 +19,10 @@ module Xpay
       @number = new_val.to_s.gsub(/[^0-9]/, "")
     end
 
+    def issue=(issue)
+      @issue = issue.to_s
+    end
+
     def security_code=(new_val)
       @security_code = new_val.to_s
     end

data/lib/xpay/payment.rb

@@ -67,10 +67,10 @@ module Xpay
     # query your instance e.g. p.response_block for further information
 
     def make_payment
-      @response_xml = self.process()
+      @response_xml = process()
       if request_method=="ST3DCARDQUERY"
         # In case the request was a ST3DCARDQUERY (the default case) the further processing depends on the respones. If it was an AUTH request than all is done and the response_xml gets processed
-        @response_xml = self.process() if response_code==0 # try once more if the response code is ZERO in ST3DCARDQUERY (According to securtrading tech support)
+        @response_xml = process() if response_code==0 # try once more if the response code is ZERO in ST3DCARDQUERY (According to securtrading tech support)
         case response_code
           when 1 # one means -> 3D AUTH required
             rewrite_request_block() # Rewrite the request block with information from the response, deleting unused items
@@ -85,20 +85,20 @@ module Xpay
               threedsecure = REXML::XPath.first(@request_xml, "//ThreeDSecure")
               pares = threedsecure.add_element("PaRes")
               pares.text = ""
-              @response_xml = self.process()
-              rt = REXML::XPath.first(@response_xml, "//Result").text.to_i
+              @response_xml = process()
+              rt = response_code
             end
           when 2 # TWO -> do a normal AUTH request
             rewrite_request_block("AUTH") # Rewrite the request block as AUTH request with information from the response, deleting unused items
-            @response_xml = self.process()
-            rt = REXML::XPath.first(@response_xml, "//Result").text.to_i
+            @response_xml = process()
+            rt = response_code
           else # ALL other cases, payment declined
-            rt = REXML::XPath.first(@response_xml, "//Result").text.to_i
+            rt = response_code
         end
       else
-        rt = REXML::XPath.first(@response_xml, "//Result").text.to_i
+        rt = response_code
       end
-      return rt
+      rt
     end
 
     # The response_block is a hash and can have one of several values:
@@ -175,33 +175,26 @@ module Xpay
       REXML::XPath.first(@request_xml, "//Request").attributes["Type"] = auth_type
 
       # delete term url and merchant name
-      op = REXML::XPath.first(@request_xml, "//Operation")
-      op.delete_element "TermUrl"
-      op.delete_element "MerchantName"
+      ops = REXML::XPath.first(@request_xml, "//Operation")
+      ["TermUrl", "MerchantName"].each { |e| ops.delete_element e }
 
       # delete accept and user agent in customer info
       customer_info = REXML::XPath.first(@request_xml, "//CustomerInfo")
-      customer_info.delete_element "//Accept"
-      customer_info.delete_element "//UserAgent"
+      ["Accept", "UserAgent"].each { |e| customer_info.delete_element e }
 
       # delete credit card details and add TransactionVerifier and TransactionReference from response xml
       # CC details are not needed anymore as verifier and reference are sufficient
       cc_details = REXML::XPath.first(@request_xml, "//CreditCard")
-      cc_details.delete_element "//Number"
-      cc_details.delete_element "//Type"
-      trans_ver = cc_details.add_element("TransactionVerifier")
-      trans_ver.text = REXML::XPath.first(@response_xml, "//TransactionVerifier").text
-      trans_ref = cc_details.add_element("ParentTransactionReference")
-      trans_ref.text = REXML::XPath.first(@response_xml, "//TransactionReference").text
+      ["Number", "Type", "SecurityCode", "StartDate", "ExpiryDate", "Issue"].each { |e| cc_details.delete_element e }
+      cc_details.add_element("TransactionVerifier").text = REXML::XPath.first(@response_xml, "//TransactionVerifier").text
+      cc_details.add_element("ParentTransactionReference").text = REXML::XPath.first(@response_xml, "//TransactionReference").text
 
       # unless it is an AUTH request, add additional required info for a 3DAUTH request
       unless auth_type == "AUTH"
         pm_method = REXML::XPath.first(@request_xml, "//PaymentMethod")
         threedsecure = pm_method.add_element("ThreeDSecure")
-        enrolled = threedsecure.add_element("Enrolled")
-        enrolled.text = REXML::XPath.first(@response_xml, "//Enrolled").text
-        md = threedsecure.add_element("MD")
-        md.text = REXML::XPath.first(@response_xml, "//MD").text rescue ""
+        threedsecure.add_element("Enrolled").text = REXML::XPath.first(@response_xml, "//Enrolled").text
+        threedsecure.add_element("MD").text = REXML::XPath.first(@response_xml, "//MD").text rescue ""
       end
       true
     end

data/lib/xpay/transaction.rb

@@ -10,24 +10,25 @@ module Xpay
     attr_accessor :request_xml
     attr_reader :three_secure, :response_xml, :response_block
 
-    def process()
-      a = TCPSocket.open("localhost", Xpay.config.port)
-      a.write(self.request_xml.to_s + "\n")
-      res = a.read()
-      a.close
-      # create an xml document, use everything from the start of <ResponseBlock to the end, discard header and status etc and return it
-      REXML::Document.new res[res.index("<ResponseBlock"), res.length]
-    end
 
     def request_method
       @request_method ||= REXML::XPath.first(@request_xml, "//Request").attributes["Type"]
     end
 
     def response_code
-      @response_code ||= REXML::XPath.first(@response_xml, "//Result").text.to_i rescue -1
+      REXML::XPath.first(@response_xml, "//Result").text.to_i rescue nil
     end
 
     private
+    def process()
+      a = TCPSocket.open("localhost", Xpay.config.port)
+      a.write(self.request_xml.to_s + "\n")
+      res = a.read()
+      a.close
+      # create an xml document, use everything from the start of <ResponseBlock to the end, discard header and status etc and return it
+      REXML::Document.new res[res.index("<ResponseBlock"), res.length]
+    end
+
     def response_xml=(new_val)
       @response_xml = new_val if new_val.is_a?(REXML::Document)
     end

data/lib/xpay/transaction_query.rb

@@ -0,0 +1,72 @@
+module Xpay
+
+  # This class allows you to query the status of a transaction processed with Xpay
+  # the following attributes are required:
+  # either a TransactionReference or your own OrderReference from a previous transaction
+  # and your SiteReference if not already set in the config, you can also pass it to overwrite it for this transaction
+  class TransactionQuery < Transaction
+    attr_accessor :transaction_reference, :order_reference, :site_reference, :site_alias
+
+    def initialize(options={})
+      @request_xml = REXML::Document.new(Xpay.root_to_s)
+      options.each do |key, value|
+        self.send("#{key}=", value) if self.respond_to? key
+      end
+      create_request
+    end
+
+    def query
+      @response_xml = process()
+      return response_code
+    end
+
+    # The response_block is a hash and can have one of several values:
+    # the follwing values are always present after a transaction and can be queried to gain further details of the transaction:
+    #   * result_code:
+    #       0 for failure, check error_code for further details
+    #       1 transaction was succesful
+    #       2 transaction was denied
+    #   * transaction_reference
+    #   * transactionverifier
+    #   * transaction_time
+    #   * auth_code
+    #   * amount
+    #   * the order reference
+    def response_block
+      create_response_block
+    end
+
+    private
+
+    # Write the xml document needed for processing, fill in elements need and delete unused ones from the root_xml
+    # raises an error if any necessary elements are missing
+    def create_request
+      raise AttributeMissing.new "(2500) TransactionReference or OrderReference need to be present." if (transaction_reference.nil? && order_reference.nil?)
+      raise AttributeMissing.new "(2500) SiteReference must be present." if (site_reference.nil? && (REXML::XPath.first(@request_xml, "//SiteReference").text.blank? rescue true))
+      REXML::XPath.first(@request_xml, "//Request").attributes["Type"] = "TRANSACTIONQUERY"
+      ops = REXML::XPath.first(@request_xml, "//Operation")
+      ["TermUrl", "MerchantName", "Currency", "SettlementDay"].each { |e| ops.delete_element e }
+      (ops.elements["SiteReference"] || ops.add_element("SiteReference")).text = self.site_reference if self.site_reference
+      (ops.elements["TransactionReference"] || ops.add_element("TransactionReference")).text = self.transaction_reference if self.transaction_reference
+      order = REXML::XPath.first(@request_xml, "//Operation")
+      (order.elements["OrderReference"] || order.add_element("OrderReference")).text = self.order_reference if self.order_reference
+      root = @request_xml.root
+      (root.elements["Certificate"] || root.add_element("Certificate")).text = self.site_alias if self.site_alias
+
+    end
+
+    def create_response_block
+      @response_xml.is_a?(REXML::Document) ?
+              {
+                      :result_code => (REXML::XPath.first(@response_xml, "//Result").text.to_i rescue nil),
+                      :transaction_reference => (REXML::XPath.first(@response_xml, "//TransactionReference").text rescue nil),
+                      :transactionverifier => (REXML::XPath.first(@response_xml, "//TransactionVerifier").text rescue nil),
+                      :transaction_time => (REXML::XPath.first(@response_xml, "//TransactionCompletedTimestamp").text rescue nil),
+                      :auth_code => (REXML::XPath.first(@response_xml, "//AuthCode").text rescue nil),
+                      :amount => (REXML::XPath.first(@response_xml, "//Amount").text.to_i rescue nil),
+                      :order_reference => (REXML::XPath.first(@response_xml, "//OrderReference").text rescue nil),
+              } : {}
+    end
+
+  end
+end

data/lib/xpay/version.rb

@@ -1,3 +1,3 @@
 module Xpay
-  Version = '0.0.5'
+  Version = '0.0.6'
 end

data/test/fixtures/config_load_test.xml

@@ -0,0 +1 @@
+<?xml version='1.0' encoding='ISO-8859-1'?><RequestBlock Version='3.52'><Request Type='AUTH'><Operation><SiteReference>testoutlet12091</SiteReference><Currency>USD</Currency><SettlementDay>2</SettlementDay></Operation></Request><Certificate>testoutlet12091</Certificate></RequestBlock>

data/test/fixtures/creditcards.yml

@@ -8,7 +8,7 @@ class_test:
   number: 4111111111111111
   security_code: 123
   valid_from: <%= Date.today.advance(:months => -5).strftime("%m/%y") %>
-  issue: "1"
+  issue: 1
 
 
 visa_no3d_auth:

data/test/fixtures/customer.xml

@@ -1 +1 @@
-<?xml version='1.0' encoding='ISO-8859-1'?><RequestBlock Version='3.51'><Request Type='ST3DCARDQUERY'><Operation><SiteReference>site12345</SiteReference><MerchantName>CompanyName</MerchantName><TermUrl>http://localhost/gateway_callback</TermUrl></Operation><CustomerInfo><Postal><Name>JOE BLOGGS<NamePrefix>MR</NamePrefix><FirstName>Joe</FirstName><MiddleName>X</MiddleName><LastName>Bloggs</LastName><NameSuffix>PhD</NameSuffix></Name><Company>NotInventedHere.com</Company><Street>tonowhere crescent</Street><City>beyond the rainbow on stale bread</City><StateProv>East-West Swampshire</StateProv><PostalCode>X01 Z10</PostalCode><CountryCode>GB</CountryCode></Postal><Telecom><Phone>07950 843 363</Phone></Telecom><Online><Email>joe.x.bloggs@notinventedhere.com</Email></Online><Accept>text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8</Accept><UserAgent>Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; GTB5; Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1) ; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; .NET CLR 3.0.04506; InfoPath.1; .NET4.0C; AskTbGLSV5/5.8.0.12304)</UserAgent></CustomerInfo></Request><Certificate>site12345</Certificate></RequestBlock>
+<?xml version='1.0' encoding='ISO-8859-1'?><RequestBlock Version='3.51'><Request Type='ST3DCARDQUERY'><Operation><SiteReference>site12345</SiteReference><Currency>GBP</Currency><SettlementDay>1</SettlementDay><MerchantName>CompanyName</MerchantName><TermUrl>http://localhost/gateway_callback</TermUrl></Operation><CustomerInfo><Postal><Name>JOE BLOGGS<NamePrefix>MR</NamePrefix><FirstName>Joe</FirstName><MiddleName>X</MiddleName><LastName>Bloggs</LastName><NameSuffix>PhD</NameSuffix></Name><Company>NotInventedHere.com</Company><Street>tonowhere crescent</Street><City>beyond the rainbow on stale bread</City><StateProv>East-West Swampshire</StateProv><PostalCode>X01 Z10</PostalCode><CountryCode>GB</CountryCode></Postal><Telecom><Phone>07950 843 363</Phone></Telecom><Online><Email>joe.x.bloggs@notinventedhere.com</Email></Online><Accept>text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8</Accept><UserAgent>Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; GTB5; Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1) ; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; .NET CLR 3.0.04506; InfoPath.1; .NET4.0C; AskTbGLSV5/5.8.0.12304)</UserAgent></CustomerInfo></Request><Certificate>site12345</Certificate></RequestBlock>

data/test/fixtures/default_config.xml

@@ -0,0 +1 @@
+<?xml version='1.0' encoding='ISO-8859-1'?><RequestBlock Version='3.51'><Request Type='ST3DCARDQUERY'><Operation><SiteReference>site12345</SiteReference><Currency>GBP</Currency><SettlementDay>1</SettlementDay><MerchantName>CompanyName</MerchantName><TermUrl>http://localhost/gateway_callback</TermUrl></Operation></Request><Certificate>site12345</Certificate></RequestBlock>

data/test/fixtures/operation.xml

@@ -1 +1 @@
-<?xml version='1.0' encoding='ISO-8859-1'?><RequestBlock Version='3.51'><Request Type='AUTH'><Operation><SiteReference>site56987</SiteReference><MerchantName>TestMerchant</MerchantName><TermUrl>https://localhost/3dcallback</TermUrl><Amount>1000</Amount><Currency>USD</Currency></Operation><Order><OrderReference>TestOrder1245</OrderReference><OrderInformation>TestOrderInfo</OrderInformation></Order></Request><Certificate>site56987</Certificate></RequestBlock>
+<?xml version='1.0' encoding='ISO-8859-1'?><RequestBlock Version='3.51'><Request Type='AUTH'><Operation><SiteReference>site56987</SiteReference><Currency>USD</Currency><SettlementDay>1</SettlementDay><MerchantName>TestMerchant</MerchantName><TermUrl>https://localhost/3dcallback</TermUrl><Amount>1000</Amount></Operation><Order><OrderReference>TestOrder1245</OrderReference><OrderInformation>TestOrderInfo</OrderInformation></Order></Request><Certificate>site56987</Certificate></RequestBlock>

data/test/fixtures/request_rewritten.xml

@@ -1 +1 @@
-<?xml version='1.0' encoding='ISO-8859-1'?><RequestBlock Version='3.51'><Request Type='ST3DAUTH'><Operation><SiteReference>site56987</SiteReference><Amount>1000</Amount><Currency>USD</Currency></Operation><PaymentMethod><CreditCard><StartDate>05/10</StartDate><ExpiryDate>01/11</ExpiryDate><SecurityCode>123</SecurityCode><Issue>1</Issue><TransactionVerifier>ArOH5um+qGhwLbuobJ5mdgzTr1qclm1j/qyG+VGDe9QSslGFXtwFA2A6jvM+qgUuZ0lLQPvJ82U1SkLOhm32dPRABlh0EkyrvKamrsDDRcsFZhWQLmS+yE0+keSaBq8C537NQAXIYcCYVvoOVKhDwdW4hZVfOtKFND+QxR2p89rw=</TransactionVerifier><ParentTransactionReference>17-9-1909368</ParentTransactionReference></CreditCard><ThreeDSecure><Enrolled>Y</Enrolled><MD>MTI4ODAwNjYzNi41MjAuMTc2MzczMzc3MDExMjg4MDA2NjM2LjUyMC4xNzYzNzMzNzcwMTEyODgwMDY2MzYuNTIwLjE3NjM3MzM3NzAxMTI4ODAwNjYzNi41MjAuMTc2MzczMzc3MDExMjg4MDA2NjM2LjUyMC4xNzYzNzMzNzcwMTEyODgwMDY2MzYuNTIwLjE3NjM3MzM3NzAxMTI4ODAwNjYzNi41MjAuMTc2MzczMzc3MDExMjg4MDA2NjM2LjUyMC4xNzYzNzMzNzcwMTEyODgwMDY2MzYuNTIwLjE3NjM3MzM3NzAxMTI4ODAwNjYzNi41MjAuMTc2MzczMzc3MDE=</MD></ThreeDSecure></PaymentMethod><CustomerInfo><Postal><Name>JOE BLOGGS<NamePrefix>MR</NamePrefix><FirstName>Joe</FirstName><MiddleName>X</MiddleName><LastName>Bloggs</LastName><NameSuffix>PhD</NameSuffix></Name><Company>NotInventedHere.com</Company><Street>tonowhere crescent</Street><City>beyond the rainbow on stale bread</City><StateProv>East-West Swampshire</StateProv><PostalCode>X01 Z10</PostalCode><CountryCode>GB</CountryCode></Postal><Telecom><Phone>07950 843 363</Phone></Telecom><Online><Email>joe.x.bloggs@notinventedhere.com</Email></Online></CustomerInfo><Order><OrderReference>TestOrder1245</OrderReference><OrderInformation>TestOrderInfo</OrderInformation></Order></Request><Certificate>site56987</Certificate></RequestBlock>
+<?xml version='1.0' encoding='ISO-8859-1'?><RequestBlock Version='3.51'><Request Type='ST3DAUTH'><Operation><SiteReference>site56987</SiteReference><Currency>USD</Currency><SettlementDay>1</SettlementDay><Amount>1000</Amount></Operation><PaymentMethod><CreditCard><TransactionVerifier>ArOH5um+qGhwLbuobJ5mdgzTr1qclm1j/qyG+VGDe9QSslGFXtwFA2A6jvM+qgUuZ0lLQPvJ82U1SkLOhm32dPRABlh0EkyrvKamrsDDRcsFZhWQLmS+yE0+keSaBq8C537NQAXIYcCYVvoOVKhDwdW4hZVfOtKFND+QxR2p89rw=</TransactionVerifier><ParentTransactionReference>17-9-1909368</ParentTransactionReference></CreditCard><ThreeDSecure><Enrolled>Y</Enrolled><MD>MTI4ODAwNjYzNi41MjAuMTc2MzczMzc3MDExMjg4MDA2NjM2LjUyMC4xNzYzNzMzNzcwMTEyODgwMDY2MzYuNTIwLjE3NjM3MzM3NzAxMTI4ODAwNjYzNi41MjAuMTc2MzczMzc3MDExMjg4MDA2NjM2LjUyMC4xNzYzNzMzNzcwMTEyODgwMDY2MzYuNTIwLjE3NjM3MzM3NzAxMTI4ODAwNjYzNi41MjAuMTc2MzczMzc3MDExMjg4MDA2NjM2LjUyMC4xNzYzNzMzNzcwMTEyODgwMDY2MzYuNTIwLjE3NjM3MzM3NzAxMTI4ODAwNjYzNi41MjAuMTc2MzczMzc3MDE=</MD></ThreeDSecure></PaymentMethod><CustomerInfo><Postal><Name>JOE BLOGGS<NamePrefix>MR</NamePrefix><FirstName>Joe</FirstName><MiddleName>X</MiddleName><LastName>Bloggs</LastName><NameSuffix>PhD</NameSuffix></Name><Company>NotInventedHere.com</Company><Street>tonowhere crescent</Street><City>beyond the rainbow on stale bread</City><StateProv>East-West Swampshire</StateProv><PostalCode>X01 Z10</PostalCode><CountryCode>GB</CountryCode></Postal><Telecom><Phone>07950 843 363</Phone></Telecom><Online><Email>joe.x.bloggs@notinventedhere.com</Email></Online></CustomerInfo><Order><OrderReference>TestOrder1245</OrderReference><OrderInformation>TestOrderInfo</OrderInformation></Order></Request><Certificate>site56987</Certificate></RequestBlock>

data/test/fixtures/root.xml

@@ -1 +1 @@
-<?xml version='1.0' encoding='ISO-8859-1'?><RequestBlock Version='3.51'><Request Type='ST3DCARDQUERY'><Operation><SiteReference>site12345</SiteReference></Operation></Request><Certificate>site12345</Certificate></RequestBlock>
+<RequestBlock Version='3.51'><Request Type='ST3DCARDQUERY'><Operation><Currency>GBP</Currency><SettlementDay>1</SettlementDay><MerchantName>CompanyName</MerchantName><TermUrl>http://localhost/gateway_callback</TermUrl></Operation></Request><Certificate>site12345</Certificate></RequestBlock>

data/test/fixtures/transactionquery.xml

@@ -0,0 +1 @@
+<RequestBlock Version='3.51'><Request Type='TRANSACTIONQUERY'><Operation><SiteReference>site1234</SiteReference><TransactionReference>17-9-1908322</TransactionReference><OrderReference>121-1010272211</OrderReference></Operation></Request><Certificate>site12345</Certificate></RequestBlock>

data/test/fixtures/transactionquery_response.xml

@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding='ISO-8859-1'?>
+<ResponseBlock Live="FALSE" Version="3.51">
+  <Response Type="TRANSACTIONQUERY">
+    <OperationResponse>
+      <TransactionReference>2-2-35117</TransactionReference>
+      <AuthCode>AUTH CODE: ab123</AuthCode>
+      <Result>1</Result>
+      <Amount>1234</Amount>
+      <TransactionCompletedTimestamp>2004-08-31 16:17:03</TransactionCompletedTimestamp>
+      <TransactionVerifier>ApTtGHQ/WUQYRj</TransactionVerifier>
+    </OperationResponse>
+    <Order>
+      <OrderReference>orderref0001</OrderReference>
+    </Order>
+  </Response>
+</ResponseBlock>

data/test/functional/transactionquery_functional_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+require 'xpay'
+
+
+class TransactionFunctionalTest < Test::Unit::TestCase
+
+  context "a visa succesful no 3D payment" do
+    setup do
+      options = {:creditcard => Xpay::CreditCard.new(credit_card("visa_no3d_auth")), :operation => Xpay::Operation.new(operation("test_1")), :customer => Xpay::Customer.new(customer("test_1"))}
+      @p = Xpay::Payment.new(options)
+      Xpay.config.port = 5000
+      @p.make_payment
+      @tq = Xpay::TransactionQuery.new(:transaction_reference => @p.response_block[:transaction_reference], :site_reference => "testoutlet12092", :site_alias => "testoutlet12092")
+      @tq.query
+    end
+
+    should "create a transaction query" do
+      d { @p.response_block.to_yaml }
+      assert_instance_of Xpay::TransactionQuery, @tq
+    end
+
+    should "have a non empty response block" do
+      assert !@tq.response_block.empty?
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -15,24 +15,22 @@ end
 def customer(which)
   conf = YAML::load(ERB.new(IO.read(File.expand_path(File.dirname(__FILE__) + '/fixtures/customer.yml'))).result)[which]
 end
-def customer_xml_string
-  x = REXML::Document.new(File.open(File.expand_path(File.dirname(__FILE__) + '/fixtures/customer.xml'))).root.to_s
-end
+
+
 
 def operation(which)
   conf = YAML::load(ERB.new(IO.read(File.expand_path(File.dirname(__FILE__) + '/fixtures/operation.yml'))).result)[which]
 end
-def operation_xml_string(which="operation")
-  operation_xml(which).root.to_s
-end
-def operation_xml(which="operation")
+
+
+def load_xml(which="")
   REXML::Document.new(File.open(File.expand_path(File.dirname(__FILE__) + "/fixtures/#{which}.xml")))
 end
-
-def root_xml_string
-  x = REXML::Document.new(File.open(File.expand_path(File.dirname(__FILE__) + '/fixtures/root.xml'))).root.to_s
+def load_xml_string(which="")
+  load_xml(which).root.to_s
 end
 
+
 def xpay_config(which)
   YAML::load(IO.read(File.expand_path(File.dirname(__FILE__) + '/fixtures/xpay_defaults.yml')))[which]
 end

data/test/xpay/core/customer_test.rb

@@ -56,7 +56,7 @@ class CustomerTest < Test::Unit::TestCase
     end
     should "create a xml document according to xpay spec" do
       @cus.add_to_xml(@request_xml)
-      assert_equal(customer_xml_string, @request_xml.root.to_s)
+      assert_equal(load_xml_string("customer"), @request_xml.root.to_s)
     end
   end
 

data/test/xpay/core/operation_test.rb

@@ -38,7 +38,7 @@ class OperationTest < Test::Unit::TestCase
     end
     should "create an xml document according to xpay spec" do
       @ops.add_to_xml(@request_xml)
-      assert_equal(operation_xml_string, @request_xml.root.to_s)
+      assert_equal  @request_xml.root.to_s, load_xml_string("operation")
     end
 
   end

data/test/xpay/payment_test.rb

@@ -53,7 +53,7 @@ class PaymentTest < Test::Unit::TestCase
   context "an empty payment instance with set 3D secure response" do
     setup do
       @p = Xpay::Payment.new()
-      @p.send("response_xml=", operation_xml("response_3d"))
+      @p.send("response_xml=", load_xml("response_3d"))
     end
 
     should "have a non-empty hash as a response block" do
@@ -69,13 +69,12 @@ class PaymentTest < Test::Unit::TestCase
       Xpay::Payment.send(:public, *Xpay::Payment.private_instance_methods)
       options = {:creditcard => Xpay::CreditCard.new(credit_card("class_test")), :operation => Xpay::Operation.new(operation("class_test")), :customer => Xpay::Customer.new(customer("class_test"))}
       @p = Xpay::Payment.new(options)
-      @p.send("response_xml=", operation_xml("response_3d"))
+      @p.send("response_xml=", load_xml("response_3d"))
 
     end
     should "have a new request_xml after rewrite" do
       @p.rewrite_request_block
-      assert_equal operation_xml_string("request_rewritten"), @p.request_xml.root.to_s
-      d { @p.request_xml.to_s }
+      assert_equal @p.request_xml.root.to_s, load_xml_string("request_rewritten")
     end
 
     should "have a non-empty hash as a response block" do
@@ -89,13 +88,13 @@ class PaymentTest < Test::Unit::TestCase
 
   context "a payment instance created from xml without PaRes" do
     should "throw error 2500, PaRes missing" do
-      options = {:xml => operation_xml_string("request_rewritten")}
+      options = {:xml => load_xml_string("request_rewritten")}
       assert_raise(Xpay::PaResMissing) {Xpay::Payment.new(options)}
     end
   end
   context "a payment instance created from xml without PaRes" do
     setup do
-      options = {:xml => operation_xml_string("request_rewritten"), :pares => "ABJASDKA+SDKAJ/SGDSAD"}
+      options = {:xml => load_xml_string("request_rewritten"), :pares => "ABJASDKA+SDKAJ/SGDSAD"}
       @p = Xpay::Payment.new(options)
     end
     should "should have a request_xml document" do

data/test/xpay/transactionquery_test.rb

@@ -0,0 +1,93 @@
+require "test_helper"
+require 'xpay'
+
+class TransactionQueryTest < Test::Unit::TestCase
+  context "an empty instance" do
+    should "raise attribute missing error" do
+      assert_raise(Xpay::AttributeMissing) { Xpay::TransactionQuery.new() }
+    end
+  end
+
+  context "an instance with missing site refence " do
+    setup do
+      ops = REXML::XPath.first(Xpay.root_xml, "//Operation")
+      ops.delete_element "SiteReference"
+    end
+
+    should "raise attribute missing error" do
+      assert_raise(Xpay::AttributeMissing) { Xpay::TransactionQuery.new(:transaction_reference => "17-9-1908322", :order_reference => "121-1010272211") }
+    end
+  end
+  context "an instance with empty site refence " do
+    setup do
+      REXML::XPath.first(Xpay.root_xml, "//SiteReference").text = ""
+    end
+
+    should "raise attribute missing error" do
+      assert_raise(Xpay::AttributeMissing) { Xpay::TransactionQuery.new(:transaction_reference => "17-9-1908322", :order_reference => "121-1010272211") }
+    end
+  end
+
+  context "a new instance with only a transaction reference" do
+    setup do
+      @t = Xpay::TransactionQuery.new({:transaction_reference => "17-9-1908322"})
+    end
+
+    should "instantiate without error" do
+      assert_instance_of Xpay::TransactionQuery, @t
+    end
+  end
+
+  context "a new instance with only a order reference" do
+    setup do
+      @t = Xpay::TransactionQuery.new({:order_reference => "17-9-1908322"})
+    end
+
+    should "instantiate without error" do
+      assert_instance_of Xpay::TransactionQuery, @t
+    end
+  end
+
+  context "a new instance" do
+    setup do
+      @t = Xpay::TransactionQuery.new({:transaction_reference => "17-9-1908322", :order_reference => "121-1010272211", :site_reference => "site1234"})
+    end
+
+    should "have a the same xml as the module" do
+      assert_equal @t.request_xml.root.to_s, load_xml_string("transactionquery")
+    end
+
+    should "have an empty repsonse block" do
+      assert @t.response_block.empty?
+    end
+
+    should "have attributes" do
+      assert @t.respond_to? :transaction_reference
+      assert @t.respond_to? :order_reference
+      assert @t.respond_to? :site_reference
+      assert @t.respond_to? :site_alias
+    end
+
+    context "given a response block" do
+      setup do
+        Xpay::TransactionQuery.send(:public, *Xpay::TransactionQuery.private_instance_methods)
+        @t.send("response_xml=", load_xml("transactionquery_response"))
+      end
+
+      should "have a response block" do
+        assert !@t.response_block.empty?
+      end
+
+      should "have values" do
+        rb = @t.response_block
+        assert_equal "2-2-35117", rb[:transaction_reference]
+        assert_equal "AUTH CODE: ab123", rb[:auth_code]
+        assert_equal 1, rb[:result_code]
+        assert_equal "2004-08-31 16:17:03", rb[:transaction_time]
+        assert_equal "ApTtGHQ/WUQYRj", rb[:transactionverifier]
+        assert_equal "orderref0001", rb[:order_reference]
+      end
+    end
+  end
+
+end

data/test/xpay_test.rb

@@ -1,5 +1,6 @@
 require 'test_helper'
 require 'xpay'
+
 class XpayTest < Test::Unit::TestCase
   context "the xpay module" do
     setup do
@@ -7,22 +8,31 @@ class XpayTest < Test::Unit::TestCase
     end
 
     should "have standard config xml" do
-      assert_kind_of(REXML::Document,@xpay.root_xml)
+      assert_kind_of(REXML::Document, @xpay.root_xml)
       assert_equal @xpay.config, OpenStruct.new(xpay_config("default"))
     end
     should "have xml document formed to xpay spec" do
-      assert_equal @xpay.root_xml.root.to_s, root_xml_string
+      assert_equal load_xml_string("root"), @xpay.root_xml.root.to_s
     end
+
     should "load a new config from yaml file" do
-      assert @xpay.load_config(File.expand_path(File.dirname(__FILE__)+ '/fixtures'))
+      assert @xpay.load_config(File.expand_path(File.dirname(__FILE__) + '/fixtures'))
     end
 
-    context "with new configuration" do
+    context "with new configuration from yaml file" do
 
       should "have a new config" do
         assert_equal @xpay.config, OpenStruct.new(xpay_config("config_load_test"))
       end
 
+      should "have a new root_xml" do
+        assert_equal load_xml_string("config_load_test"), @xpay.root_xml.root.to_s
+      end
+
+      should "have config.port 6000" do
+        assert_equal 6000, @xpay.config.port
+      end
+
       should "have an environment" do
         assert_equal @xpay.environment, "development"
       end
@@ -35,7 +45,9 @@ class XpayTest < Test::Unit::TestCase
     should "load a new config from hash" do
       assert @xpay.set_config(xpay_config("default"))
       assert_equal @xpay.config, OpenStruct.new(xpay_config("default"))
+      assert_equal load_xml_string("default_config"), @xpay.root_xml.root.to_s
     end
 
   end
 end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xpay
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Volker Pacher
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-26 00:00:00 +01:00
+date: 2010-10-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -121,6 +121,7 @@ files:
 - lib/xpay.rb
 - lib/xpay/transaction.rb
 - lib/xpay/version.rb
+- lib/xpay/transaction_query.rb
 - lib/xpay/core/customer.rb
 - lib/xpay/core/operation.rb
 - lib/xpay/core/creditcard.rb
@@ -128,22 +129,28 @@ files:
 - rails/init.rb
 - test/xpay_test.rb
 - test/fixtures/customer.xml
+- test/fixtures/config_load_test.xml
 - test/fixtures/operation.yml
+- test/fixtures/transactionquery.xml
 - test/fixtures/operation.xml
 - test/fixtures/response.xml
 - test/fixtures/creditcards.yml
+- test/fixtures/default_config.xml
 - test/fixtures/customer.yml
 - test/fixtures/xpay_defaults.yml
 - test/fixtures/request_rewritten.xml
+- test/fixtures/transactionquery_response.xml
 - test/fixtures/response_3d.xml
 - test/fixtures/root.xml
 - test/fixtures/config/xpay.yml
+- test/functional/transactionquery_functional_test.rb
 - test/functional/payment_functional_test.rb
 - test/test_helper.rb
 - test/xpay/core/creditcard_test.rb
 - test/xpay/core/customer_test.rb
 - test/xpay/core/operation_test.rb
 - test/xpay/payment_test.rb
+- test/xpay/transactionquery_test.rb
 - LICENSE
 - UPGRADES
 - README.rdoc