adyen 1.4.1 → 1.5.0

data/lib/adyen/api/payment_service.rb

@@ -98,15 +98,16 @@ module Adyen
 
       def authorise_one_click_payment_request_body
         validate_parameters!(:recurring_detail_reference,
-                             :shopper => [:email, :reference],
-                             :card    => [:cvc])
-        content = ONE_CLICK_PAYMENT_BODY_PARTIAL % [@params[:recurring_detail_reference], @params[:card][:cvc]]
+                             :shopper => [:email, :reference])
+        content = one_click_card_partial
+        content << ONE_CLICK_PAYMENT_BODY_PARTIAL % [@params[:recurring_detail_reference]]
         payment_request_body(content)
       end
 
       def payment_request_body(content)
         validate_parameters!(:merchant_account, :reference, :amount => [:currency, :value])
         content << amount_partial
+        content << installments_partial if @params[:installments]
         content << shopper_partial if @params[:shopper]
         content << fraud_offset_partial if @params[:fraud_offset]
         LAYOUT % [@params[:merchant_account], @params[:reference], content]
@@ -139,8 +140,18 @@ module Adyen
         AMOUNT_PARTIAL % @params[:amount].values_at(:currency, :value)
       end
 
+      def one_click_card_partial
+        if @params[:card] && @params[:card][:encrypted] && @params[:card][:encrypted][:json]
+          ENCRYPTED_CARD_PARTIAL % [@params[:card][:encrypted][:json]]
+        else
+          validate_parameters!(:card => [:cvc])
+          card  = @params[:card].values_at(:cvc)
+          ONE_CLICK_CARD_PARTIAL % card
+        end
+      end
+
       def card_partial
-        if @params[:card] and @params[:card][:encrypted] and @params[:card][:encrypted][:json]
+        if @params[:card] && @params[:card][:encrypted] && @params[:card][:encrypted][:json]
           ENCRYPTED_CARD_PARTIAL % [@params[:card][:encrypted][:json]]
         else
           validate_parameters!(:card => [:holder_name, :number, :cvc, :expiry_year, :expiry_month])
@@ -150,15 +161,21 @@ module Adyen
         end
       end
 
+      def installments_partial
+        if @params[:installments] && @params[:installments][:value]
+          INSTALLMENTS_PARTIAL % @params[:installments].values_at(:value)
+        end
+      end
+
       def shopper_partial
         @params[:shopper].map { |k, v| SHOPPER_PARTIALS[k] % v }.join("\n")
       end
-      
+
       def fraud_offset_partial
         validate_parameters!(:fraud_offset)
         FRAUD_OFFSET_PARTIAL % @params[:fraud_offset]
       end
-        
+
       class AuthorisationResponse < Response
         ERRORS = {
           "validation 101 Invalid card number"                           => [:number,       'is not a valid creditcard number'],
@@ -171,7 +188,8 @@ module Adyen
         AUTHORISED = 'Authorised'
         REFUSED    = 'Refused'
 
-        response_attrs :result_code, :auth_code, :refusal_reason, :psp_reference
+        response_attrs :result_code, :auth_code, :refusal_reason, :psp_reference,
+          :additional_data
 
         def success?
           super && params[:result_code] == AUTHORISED
@@ -217,10 +235,28 @@ module Adyen
               :psp_reference  => result.text('./payment:pspReference'),
               :result_code    => result.text('./payment:resultCode'),
               :auth_code      => result.text('./payment:authCode'),
+              :additional_data => parse_additional_data(result.xpath('.//payment:additionalData')),
               :refusal_reason => (invalid_request? ? fault_message : result.text('./payment:refusalReason'))
             }
           end
         end
+
+        private
+          def parse_additional_data(xpath)
+            if xpath.empty?
+              {}
+            else
+              results = {}
+
+              xpath.map do |node|
+                key = node.text('./payment:entry/payment:key')
+                value = node.text('./payment:entry/payment:value')
+                results[key] = value unless key.empty?
+              end
+
+              results
+            end
+          end
       end
 
       class ModificationResponse < Response

data/lib/adyen/api/simple_soap_client.rb

@@ -8,14 +8,14 @@ module Adyen
     # The base class of the API classes that map to Adyen SOAP services.
     class SimpleSOAPClient
       # @private
-      ENVELOPE = <<EOS
-<?xml version="1.0"?>
-<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-  <soap:Body>
-    %s
-  </soap:Body>
-</soap:Envelope>
-EOS
+      ENVELOPE = <<-EOXML.strip.freeze
+        <?xml version="1.0"?>
+        <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+          <soap:Body>
+            %s
+          </soap:Body>
+        </soap:Envelope>
+      EOXML
 
       # A CA file used to verify certificates when connecting to Adyen.
       #

data/lib/adyen/api/templates/payment_service.rb

@@ -5,24 +5,24 @@ module Adyen
         private
 
         def modification_request(method, body = nil)
-          return <<EOS
-    <payment:#{method} xmlns:payment="http://payment.services.adyen.com" xmlns:recurring="http://recurring.services.adyen.com" xmlns:common="http://common.services.adyen.com">
-      <payment:modificationRequest>
-        <payment:merchantAccount>%s</payment:merchantAccount>
-        <payment:originalReference>%s</payment:originalReference>
-        #{body}
-      </payment:modificationRequest>
-    </payment:#{method}>
-EOS
+          <<-EOXML
+            <payment:#{method} xmlns:payment="http://payment.services.adyen.com" xmlns:recurring="http://recurring.services.adyen.com" xmlns:common="http://common.services.adyen.com">
+              <payment:modificationRequest>
+                <payment:merchantAccount>%s</payment:merchantAccount>
+                <payment:originalReference>%s</payment:originalReference>
+                #{body}
+              </payment:modificationRequest>
+            </payment:#{method}>
+          EOXML
         end
 
         def modification_request_with_amount(method)
-          modification_request(method, <<EOS)
-        <payment:modificationAmount>
-          <common:currency>%s</common:currency>
-          <common:value>%s</common:value>
-        </payment:modificationAmount>
-EOS
+          modification_request(method, <<-EOXML)
+            <payment:modificationAmount>
+              <common:currency>%s</common:currency>
+              <common:value>%s</common:value>
+            </payment:modificationAmount>
+          EOXML
         end
       end
 
@@ -36,26 +36,26 @@ EOS
       CANCEL_OR_REFUND_LAYOUT = modification_request(:cancelOrRefund)
 
       # @private
-      LAYOUT = <<EOS
-    <payment:authorise xmlns:payment="http://payment.services.adyen.com" xmlns:recurring="http://recurring.services.adyen.com" xmlns:common="http://common.services.adyen.com">
-      <payment:paymentRequest>
-        <payment:merchantAccount>%s</payment:merchantAccount>
-        <payment:reference>%s</payment:reference>
-%s
-      </payment:paymentRequest>
-    </payment:authorise>
-EOS
+      LAYOUT = <<-EOXML
+        <payment:authorise xmlns:payment="http://payment.services.adyen.com" xmlns:recurring="http://recurring.services.adyen.com" xmlns:common="http://common.services.adyen.com">
+          <payment:paymentRequest>
+            <payment:merchantAccount>%s</payment:merchantAccount>
+            <payment:reference>%s</payment:reference>
+            %s
+          </payment:paymentRequest>
+        </payment:authorise>
+      EOXML
 
       # @private
-      AMOUNT_PARTIAL = <<EOS
+      AMOUNT_PARTIAL = <<-EOXML
         <payment:amount>
           <common:currency>%s</common:currency>
           <common:value>%s</common:value>
         </payment:amount>
-EOS
+      EOXML
 
       # @private
-      CARD_PARTIAL = <<EOS
+      CARD_PARTIAL = <<-EOXML
         <payment:card>
           <payment:holderName>%s</payment:holderName>
           <payment:number>%s</payment:number>
@@ -63,10 +63,24 @@ EOS
           <payment:expiryYear>%s</payment:expiryYear>
           <payment:expiryMonth>%02d</payment:expiryMonth>
         </payment:card>
-EOS
+      EOXML
+
+      # @private
+      ONE_CLICK_CARD_PARTIAL = <<-EOXML
+        <payment:card>
+          <payment:cvc>%s</payment:cvc>
+        </payment:card>
+      EOXML
 
       # @private
-      ENCRYPTED_CARD_PARTIAL = <<EOS
+      INSTALLMENTS_PARTIAL = <<-EOXML
+        <payment:installments>
+          <common:value>%s</common:value>
+        </payment:installments>
+      EOXML
+
+      # @private
+      ENCRYPTED_CARD_PARTIAL = <<-EOXML
         <additionalAmount xmlns="http://payment.services.adyen.com" xsi:nil="true" />
         <additionalData xmlns="http://payment.services.adyen.com">
           <entry>
@@ -74,34 +88,31 @@ EOS
             <value xsi:type="xsd:string">%s</value>
           </entry>
         </additionalData>
-EOS
+      EOXML
 
       # @private
-      ENABLE_RECURRING_CONTRACTS_PARTIAL = <<EOS
+      ENABLE_RECURRING_CONTRACTS_PARTIAL = <<-EOXML
         <payment:recurring>
           <payment:contract>RECURRING,ONECLICK</payment:contract>
         </payment:recurring>
-EOS
+      EOXML
 
       # @private
-      RECURRING_PAYMENT_BODY_PARTIAL = <<EOS
+      RECURRING_PAYMENT_BODY_PARTIAL = <<-EOXML
         <payment:recurring>
           <payment:contract>RECURRING</payment:contract>
         </payment:recurring>
         <payment:selectedRecurringDetailReference>%s</payment:selectedRecurringDetailReference>
         <payment:shopperInteraction>ContAuth</payment:shopperInteraction>
-EOS
+      EOXML
 
       # @private
-      ONE_CLICK_PAYMENT_BODY_PARTIAL = <<EOS
+      ONE_CLICK_PAYMENT_BODY_PARTIAL = <<-EOXML
         <payment:recurring>
           <payment:contract>ONECLICK</payment:contract>
         </payment:recurring>
         <payment:selectedRecurringDetailReference>%s</payment:selectedRecurringDetailReference>
-        <payment:card>
-          <payment:cvc>%s</payment:cvc>
-        </payment:card>
-EOS
+      EOXML
 
       # @private
       SHOPPER_PARTIALS = {
@@ -110,7 +121,7 @@ EOS
         :ip        => '        <payment:shopperIP>%s</payment:shopperIP>',
         :statement => '        <payment:shopperStatement>%s</payment:shopperStatement>',
       }
-                              
+
       # @private
       FRAUD_OFFSET_PARTIAL = '<payment:fraudOffset>%s</payment:fraudOffset>'
     end

data/lib/adyen/api/test_helpers.rb

@@ -8,48 +8,48 @@ module Adyen
       #
       # This module extends the {PaymentService} class and thus these methods are callable on it.
       module TestHelpers
-        AUTHORISE_RESPONSE = SimpleSOAPClient::ENVELOPE % <<EOS
-    <ns1:authoriseResponse xmlns:ns1="http://payment.services.adyen.com">
-      <ns1:paymentResult>
-        <additionalData xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <authCode xmlns="http://payment.services.adyen.com">1234</authCode>
-        <dccAmount xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <dccSignature xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <fraudResult xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <issuerUrl xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <md xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <paRequest xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <pspReference xmlns="http://payment.services.adyen.com">9876543210987654</pspReference>
-        <refusalReason xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <resultCode xmlns="http://payment.services.adyen.com">Authorised</resultCode>
-      </ns1:paymentResult>
-    </ns1:authoriseResponse>
-EOS
+        AUTHORISE_RESPONSE = SimpleSOAPClient::ENVELOPE % <<-EOXML
+          <ns1:authoriseResponse xmlns:ns1="http://payment.services.adyen.com">
+            <ns1:paymentResult>
+              <additionalData xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <authCode xmlns="http://payment.services.adyen.com">1234</authCode>
+              <dccAmount xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <dccSignature xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <fraudResult xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <issuerUrl xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <md xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <paRequest xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <pspReference xmlns="http://payment.services.adyen.com">9876543210987654</pspReference>
+              <refusalReason xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <resultCode xmlns="http://payment.services.adyen.com">Authorised</resultCode>
+            </ns1:paymentResult>
+          </ns1:authoriseResponse>
+        EOXML
 
-        AUTHORISATION_REFUSED_RESPONSE = SimpleSOAPClient::ENVELOPE % <<EOS
-    <ns1:authoriseResponse xmlns:ns1="http://payment.services.adyen.com">
-      <ns1:paymentResult>
-        <additionalData xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <authCode xmlns="http://payment.services.adyen.com">1234</authCode>
-        <dccAmount xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <dccSignature xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <fraudResult xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <issuerUrl xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <md xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <paRequest xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
-        <pspReference xmlns="http://payment.services.adyen.com">9876543210987654</pspReference>
-        <refusalReason xmlns="http://payment.services.adyen.com">You need to actually own money.</refusalReason>
-        <resultCode xmlns="http://payment.services.adyen.com">Refused</resultCode>
-      </ns1:paymentResult>
-    </ns1:authoriseResponse>
-EOS
+        AUTHORISATION_REFUSED_RESPONSE = SimpleSOAPClient::ENVELOPE % <<-EOXML
+          <ns1:authoriseResponse xmlns:ns1="http://payment.services.adyen.com">
+            <ns1:paymentResult>
+              <additionalData xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <authCode xmlns="http://payment.services.adyen.com">1234</authCode>
+              <dccAmount xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <dccSignature xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <fraudResult xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <issuerUrl xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <md xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <paRequest xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
+              <pspReference xmlns="http://payment.services.adyen.com">9876543210987654</pspReference>
+              <refusalReason xmlns="http://payment.services.adyen.com">You need to actually own money.</refusalReason>
+              <resultCode xmlns="http://payment.services.adyen.com">Refused</resultCode>
+            </ns1:paymentResult>
+          </ns1:authoriseResponse>
+        EOXML
 
-        AUTHORISATION_REQUEST_INVALID_RESPONSE = SimpleSOAPClient::ENVELOPE % <<EOS
-    <soap:Fault>
-      <faultcode>soap:Server</faultcode>
-      <faultstring>validation 101 Invalid card number</faultstring>
-    </soap:Fault>
-EOS
+        AUTHORISATION_REQUEST_INVALID_RESPONSE = SimpleSOAPClient::ENVELOPE % <<-EOXML
+          <soap:Fault>
+            <faultcode>soap:Server</faultcode>
+            <faultstring>validation 101 Invalid card number</faultstring>
+          </soap:Fault>
+        EOXML
 
         # @return [AuthorisationResponse] A authorisation succeeded response instance.
         def success_stub
@@ -104,15 +104,15 @@ EOS
       #
       # This module extends the {RecurringService} class and thus these methods are callable on it.
       module TestHelpers
-        DISABLE_RESPONSE = SimpleSOAPClient::ENVELOPE % <<EOS
-    <ns1:disableResponse xmlns:ns1="http://recurring.services.adyen.com">
-      <ns1:result>
-        <response xmlns="http://recurring.services.adyen.com">
-          %s
-        </response>
-      </ns1:result>
-    </ns1:disableResponse>
-EOS
+        DISABLE_RESPONSE = SimpleSOAPClient::ENVELOPE % <<-EOXML
+          <ns1:disableResponse xmlns:ns1="http://recurring.services.adyen.com">
+            <ns1:result>
+              <response xmlns="http://recurring.services.adyen.com">
+                %s
+              </response>
+            </ns1:result>
+          </ns1:disableResponse>
+        EOXML
 
         # @return [DisableResponse] A ‘disable succeeded’ response instance.
         def disabled_stub

data/lib/adyen/api/xml_querier.rb

@@ -31,6 +31,10 @@ module Adyen
         def perform_xpath(query, root_node)
           root_node.xpath(query, NS)
         end
+
+        def stringify_nodeset(nodeset)
+          nodeset.to_xml(encoding: 'UTF-8')
+        end
       end
 
       class REXMLBackend
@@ -48,7 +52,11 @@ module Adyen
 
         def perform_xpath(query, root_node)
           REXML::XPath.match(root_node, query, NS)
-        end        
+        end
+
+        def stringify_nodeset(nodeset)
+          nodeset.map { |n| n.to_s }.join("")
+        end
       end
 
       # @return A backend to handle XML parsing.
@@ -116,7 +124,7 @@ module Adyen
 
       # @return [String] A string representation of this node.
       def to_s
-        Array === @node ? @node.join("") : @node.to_s
+        backend.stringify_nodeset(@node)
       end
 
       # @yield [XMLQuerier] A member of this node set, ready to be queried.

data/lib/adyen/encoding.rb

@@ -7,7 +7,7 @@ module Adyen
   module Encoding
     def self.hmac_base64(hmac_key, message)
       digest = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), hmac_key, message)
-      Base64.encode64(digest).strip
+      Base64.strict_encode64(digest).strip
     end
 
     def self.gzip_base64(message)
@@ -15,7 +15,7 @@ module Adyen
       gz  = Zlib::GzipWriter.new(sio)
       gz.write(message)
       gz.close
-      Base64.encode64(sio.string).gsub("\n", "")
+      Base64.strict_encode64(sio.string)
     end
   end
 end

data/lib/adyen/form.rb

@@ -119,6 +119,10 @@ module Adyen
         parameters[:billing_address_sig] = calculate_billing_address_signature(parameters, shared_secret)
       end
 
+      if parameters[:shopper]
+        parameters[:shopper_sig] = calculate_shopper_signature(parameters, shared_secret)
+      end
+
       return parameters
     end
 
@@ -165,6 +169,20 @@ module Adyen
       }.join('&')
     end
 
+    # @see Adyen::Form.redirect_url
+    #
+    # Returns an absolute URL very similar to the one returned by Adyen::Form.redirect_url
+    # except that it uses the directory.shtml call which returns a list of all available
+    # payment methods
+    #
+    # @param [Hash] parameters The payment parameters to include in the payment request.
+    # @return [String] An absolute URL to redirect to the Adyen payment system.
+    def payment_methods_url(parameters = {})
+      url(nil, :directory) + '?' + flat_payment_parameters(parameters).map { |(k, v)|
+        "#{k}=#{CGI.escape(v)}"
+      }.join('&')
+    end
+
     # Returns a HTML snippet of hidden INPUT tags with the provided payment parameters.
     # The snippet can be included in a payment form that POSTs to the Adyen payment system.
     #
@@ -266,6 +284,20 @@ module Adyen
       Adyen::Encoding.hmac_base64(shared_secret, calculate_billing_address_signature_string(parameters[:billing_address]))
     end
 
+    # shopperSig: shopper.firstName + shopper.infix + shopper.lastName + shopper.gender + shopper.dateOfBirthDayOfMonth + shopper.dateOfBirthMonth + shopper.dateOfBirthYear + shopper.telephoneNumber
+    # (Note that you can send only shopper.firstName and shopper.lastName if you like. Do NOT include shopperSocialSecurityNumber in the shopperSig!)
+    def calculate_shopper_signature_string(parameters)
+      %w(first_name infix last_name gender date_of_birth_day_of_month date_of_birth_month date_of_birth_year telephone_number).map do |key|
+        parameters[key.to_sym]
+      end.join
+    end
+
+    def calculate_shopper_signature(parameters, shared_secret = nil)
+      shared_secret ||= parameters.delete(:shared_secret)
+      raise ArgumentError, "Cannot calculate shopper request signature with empty shared_secret" if shared_secret.to_s.empty?
+      Adyen::Encoding.hmac_base64(shared_secret, calculate_shopper_signature_string(parameters[:shopper]))
+    end
+
     ######################################################
     # REDIRECT SIGNATURE CHECKING
     ######################################################