adyen_jpiqueras 2.3.0

data/lib/adyen/api/response.rb

@@ -0,0 +1,61 @@
+module Adyen
+  module API
+    # The base class of all responses returned by API calls to Adyen.
+    class Response
+      # Defines shortcut accessor methods, to {Response#params}, for the given parameters.
+      def self.response_attrs(*attrs)
+        attrs.each do |attr|
+          define_method(attr) { params[attr] }
+        end
+      end
+
+      # @return [Net::HTTPResponse] The response object returned by Net::HTTP.
+      attr_reader :http_response
+
+      # @param [Net::HTTPResponse] http_response The response object returned by Net::HTTP.
+      def initialize(http_response)
+        @http_response = http_response
+      end
+
+      # @return [String] The raw body of the response object.
+      def body
+        @http_response.body
+      end
+
+      # @return [Boolean] Whether or not the request was successful.
+      def success?
+        !http_failure?
+      end
+
+      # @return [Boolean] Whether or not the HTTP request was a success.
+      def http_failure?
+        !@http_response.is_a?(Net::HTTPSuccess)
+      end
+
+      # @return [Boolean] Whether or not the SOAP request itself was a success.
+      # Adyen returns a 500 status code for e.g. failed CC validation and in this case, we don't
+      # want to throw a server error but rather treat it as something normal.
+      def server_error?
+        @http_response.is_a?(Net::HTTPServerError) && fault_message.nil?
+      end
+
+      # @return [XMLQuerier] The response body wrapped in a XMLQuerier.
+      def xml_querier
+        @xml_querier ||= XMLQuerier.xml(@http_response.body)
+      end
+
+      # @return [Hash] Subclasses return the parsed response body.
+      def params
+        raise "The Adyen::API::Response#params method should be overridden in a subclass."
+      end
+
+      # @return [String,nil] The SOAP failure message, if there is one.
+      def fault_message
+        @fault_message ||= begin
+          message = xml_querier.text('//soap:Fault/faultstring')
+          message unless message.empty?
+        end
+      end
+    end
+  end
+end

data/lib/adyen/api/simple_soap_client.rb

@@ -0,0 +1,134 @@
+require 'net/https'
+
+require 'adyen/api/response'
+require 'adyen/api/xml_querier'
+
+module Adyen
+  module API
+    # The base class of the API classes that map to Adyen SOAP services.
+    class SimpleSOAPClient
+      # @private
+      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.
+      #
+      # @see http://curl.haxx.se/ca/cacert.pem
+      CACERT = File.expand_path('../cacert.pem', __FILE__)
+
+      class StandardError < ::StandardError
+        def initialize(response, action, endpoint)
+          @response, @action, @endpoint = response, action, endpoint
+        end
+
+        private
+
+        def message_prefix
+          %{[#{@response.http_response.code} #{@response.http_response.message}] A %s error occurred while calling SOAP action `#{@action}' on endpoint `#{@endpoint}'.}
+        end
+      end
+
+      class ClientError < StandardError
+        def message
+          "#{message_prefix % "client"} Fault message: #{@response.fault_message}."
+        end
+      end
+
+      class ServerError < StandardError
+        def message
+          message_prefix % 'server'
+        end
+      end
+
+      class << self
+        # When a response instance has been assigned, the subsequent call to
+        # {SimpleSOAPClient#call_webservice_action} will not make a remote call, but simply return
+        # the stubbed response instance. This is obviously meant for making payments from tests.
+        #
+        # @see PaymentService::TestHelpers
+        # @see RecurringService::TestHelpers
+        #
+        # @return [Response] The stubbed Response subclass instance.
+        attr_accessor :stubbed_response
+
+        # @return [URI]      A URI based on the ENDPOINT_URI constant defined on subclasses, where
+        #                    the environment type has been interpolated. E.g. Test environment.
+        def endpoint
+          @endpoint ||= URI.parse(const_get('ENDPOINT_URI') % Adyen.configuration.environment)
+        end
+      end
+
+      # @return [Hash]       A hash of key-value pairs required for the action that is to be called.
+      attr_reader :params
+
+      # @param [Hash] params A hash of key-value pairs required for the action that is to be called.
+      #                      These are merged with the Adyen::API.default_params.
+      def initialize(params = {})
+        @params = Adyen.configuration.default_api_params.merge(params)
+      end
+
+      def validate_parameter_value!(param, value)
+        if value.nil? || value =~ /^\s*$/
+          raise ArgumentError, "The required parameter `:#{param}' is missing."
+        end
+      end
+
+      def validate_parameters!(*params)
+        params.each do |param|
+          case param
+          when Symbol
+            validate_parameter_value!(param, @params[param])
+          when Hash
+            param.each do |name, attrs|
+              validate_parameter_value!(name, @params[name])
+              attrs.each { |attr| validate_parameter_value!("#{name} => :#{attr}", @params[name][attr]) }
+            end
+          end
+        end
+      end
+
+      # This method wraps the given XML +data+ in a SOAP envelope and posts it to +action+ on the
+      # +endpoint+ defined for the subclass.
+      #
+      # The result is a response object, with XMLQuerier, ready to be queried.
+      #
+      # If a {stubbed_response} has been set, then said response is returned and no actual remote
+      # calls are made.
+      #
+      # @param [String]   action         The remote action to call.
+      # @param [String]   data           The XML data to post to the remote action.
+      # @param [Response] response_class The Response subclass used to wrap the response from Adyen.
+      def call_webservice_action(action, data, response_class)
+        if response = self.class.stubbed_response
+          self.class.stubbed_response = nil
+          response
+        else
+          endpoint = self.class.endpoint
+
+          post = Net::HTTP::Post.new(endpoint.path, 'Accept' => 'text/xml', 'Content-Type' => 'text/xml; charset=utf-8', 'SOAPAction' => action)
+          post.basic_auth(Adyen.configuration.api_username, Adyen.configuration.api_password)
+          post.body = ENVELOPE % data
+
+          request = Net::HTTP.new(endpoint.host, endpoint.port)
+          request.use_ssl = true
+          request.ca_file = CACERT
+          request.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+          request.start do |http|
+            http_response = http.request(post)
+            response = response_class.new(http_response)
+            raise ClientError.new(response, action, endpoint) if http_response.is_a?(Net::HTTPClientError)
+            raise ServerError.new(response, action, endpoint) if response.server_error?
+            response
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,159 @@
+module Adyen
+  module API
+    class PaymentService < SimpleSOAPClient
+      class << self
+        private
+
+        def modification_request(method, body = nil)
+          <<-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, <<-EOXML)
+            <payment:modificationAmount>
+              <common:currency>%s</common:currency>
+              <common:value>%s</common:value>
+            </payment:modificationAmount>
+          EOXML
+        end
+      end
+
+      # @private
+      CAPTURE_LAYOUT          = modification_request_with_amount(:capture)
+      # @private
+      REFUND_LAYOUT           = modification_request_with_amount(:refund)
+      # @private
+      CANCEL_LAYOUT           = modification_request(:cancel)
+      # @private
+      CANCEL_OR_REFUND_LAYOUT = modification_request(:cancelOrRefund)
+
+      # @private
+      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 = <<-EOXML
+        <payment:amount>
+          <common:currency>%s</common:currency>
+          <common:value>%s</common:value>
+        </payment:amount>
+      EOXML
+
+      # @private
+      CARD_PARTIAL = <<-EOXML
+        <payment:card>
+          <payment:holderName>%s</payment:holderName>
+          <payment:number>%s</payment:number>
+          <payment:expiryYear>%s</payment:expiryYear>
+          <payment:expiryMonth>%02d</payment:expiryMonth>
+          %s
+        </payment:card>
+      EOXML
+
+      # @private
+      CARD_CVC_PARTIAL = <<-EOXML
+        <payment:cvc>%s</payment:cvc>
+      EOXML
+
+      # @private
+      ONE_CLICK_CARD_PARTIAL = <<-EOXML
+        <payment:card>
+          <payment:cvc>%s</payment:cvc>
+        </payment:card>
+      EOXML
+
+      # @private
+      INSTALLMENTS_PARTIAL = <<-EOXML
+        <payment:installments>
+          <common:value>%s</common:value>
+        </payment:installments>
+      EOXML
+
+      SOCIAL_SECURITY_NUMBER_PARTIAL = <<-EOXML
+        <payment:socialSecurityNumber>%s</payment:socialSecurityNumber>
+      EOXML
+
+     # @private
+      DELIVERY_DATE_PARTIAL = <<-EOXML
+        <deliveryDate xmlns="http://payment.services.adyen.com">%s</deliveryDate>
+      EOXML
+
+      # @private
+      SELECTED_BRAND_PARTIAL = <<-EOXML
+        <payment:selectedBrand>%s</payment:selectedBrand>
+      EOXML
+
+      # @private
+      SHOPPER_NAME_PARTIAL = <<-EOXML
+        <payment:shopperName>
+          <common:firstName>%s</common:firstName>
+          <common:lastName>%s</common:lastName>
+        </payment:shopperName>
+      EOXML
+
+      # @private
+      ENCRYPTED_CARD_PARTIAL = <<-EOXML
+        <additionalAmount xmlns="http://payment.services.adyen.com" xsi:nil="true" />
+        <additionalData xmlns="http://payment.services.adyen.com">
+          <entry>
+            <key xsi:type="xsd:string">card.encrypted.json</key>
+            <value xsi:type="xsd:string">%s</value>
+          </entry>
+        </additionalData>
+      EOXML
+
+      # @private
+      ENABLE_RECURRING_CONTRACTS_PARTIAL = <<-EOXML
+        <payment:recurring>
+          <payment:contract>RECURRING,ONECLICK</payment:contract>
+        </payment:recurring>
+      EOXML
+
+      # @private
+      RECURRING_PAYMENT_BODY_PARTIAL = <<-EOXML
+        <payment:recurring>
+          <payment:contract>RECURRING</payment:contract>
+        </payment:recurring>
+        <payment:selectedRecurringDetailReference>%s</payment:selectedRecurringDetailReference>
+        <payment:shopperInteraction>ContAuth</payment:shopperInteraction>
+      EOXML
+
+      # @private
+      ONE_CLICK_PAYMENT_BODY_PARTIAL = <<-EOXML
+        <payment:recurring>
+          <payment:contract>ONECLICK</payment:contract>
+        </payment:recurring>
+        <payment:selectedRecurringDetailReference>%s</payment:selectedRecurringDetailReference>
+      EOXML
+
+      # @private
+      SHOPPER_PARTIALS = {
+        :reference => '        <payment:shopperReference>%s</payment:shopperReference>',
+        :email     => '        <payment:shopperEmail>%s</payment:shopperEmail>',
+        :ip        => '        <payment:shopperIP>%s</payment:shopperIP>',
+        :statement => '        <payment:shopperStatement>%s</payment:shopperStatement>',
+      }
+
+      # @private
+      FRAUD_OFFSET_PARTIAL = '<payment:fraudOffset>%s</payment:fraudOffset>'
+
+      # @private
+      CAPTURE_DELAY_PARTIAL = '<payment:captureDelayHours>%s</payment:captureDelayHours>'
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module Adyen
+  module API
+    class RecurringService < SimpleSOAPClient
+      # @private
+      LIST_LAYOUT = <<EOS
+    <recurring:listRecurringDetails xmlns:payment="http://payment.services.adyen.com" xmlns:recurring="http://recurring.services.adyen.com">
+      <recurring:request>
+        <recurring:recurring>
+          <payment:contract>RECURRING</payment:contract>
+        </recurring:recurring>
+        <recurring:merchantAccount>%s</recurring:merchantAccount>
+        <recurring:shopperReference>%s</recurring:shopperReference>
+      </recurring:request>
+    </recurring:listRecurringDetails>
+EOS
+
+      # @private
+      DISABLE_LAYOUT = <<EOS
+    <recurring:disable xmlns:recurring="http://recurring.services.adyen.com">
+      <recurring:request>
+        <recurring:merchantAccount>%s</recurring:merchantAccount>
+        <recurring:shopperReference>%s</recurring:shopperReference>
+        %s
+      </recurring:request>
+    </recurring:disable>
+EOS
+
+      # @private
+      RECURRING_DETAIL_PARTIAL = <<EOS
+        <recurring:recurringDetailReference>%s</recurring:recurringDetailReference>
+EOS
+
+      STORE_TOKEN_LAYOUT = <<EOS
+    <recurring:storeToken xmlns:recurring="http://recurring.services.adyen.com" xmlns:payment="http://payment.services.adyen.com">
+      <recurring:request>
+        <recurring:recurring>
+          <payment:contract>RECURRING</payment:contract>
+        </recurring:recurring>
+        <recurring:merchantAccount>%s</recurring:merchantAccount>
+        <recurring:shopperReference>%s</recurring:shopperReference>
+        <recurring:shopperEmail>%s</recurring:shopperEmail>
+        %s
+      </recurring:request>
+    </recurring:storeToken>
+EOS
+
+      # @private
+      CARD_PARTIAL = <<EOS
+        <recurring:card>
+          <payment:holderName>%s</payment:holderName>
+          <payment:number>%s</payment:number>
+          <payment:cvc>%s</payment:cvc>
+          <payment:expiryYear>%s</payment:expiryYear>
+          <payment:expiryMonth>%02d</payment:expiryMonth>
+        </recurring:card>
+EOS
+      # Electronic bank debit in Germany. Semi real-time payment method.
+      # @private
+      ELV_PARTIAL = <<EOS
+        <recurring:elv>
+          <payment:bankLocation>%s</payment:bankLocation>
+          <payment:bankName>%s</payment:bankName>
+          <payment:bankLocationId>%s</payment:bankLocationId>
+          <payment:accountHolderName>%s</payment:accountHolderName>
+          <payment:bankAccountNumber>%02d</payment:bankAccountNumber>
+        </recurring:elv>
+EOS
+
+    end
+  end
+end

data/lib/adyen/api/test_helpers.rb

@@ -0,0 +1,133 @@
+require 'adyen/api/payment_service'
+
+module Adyen
+  module API
+    class PaymentService < SimpleSOAPClient
+      # A collection of test helpers that create and assign stubbed response instances for a
+      # subsequent remote call.
+      #
+      # This module extends the {PaymentService} class and thus these methods are callable on it.
+      module TestHelpers
+        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 % <<-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 % <<-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
+          http_response = Net::HTTPOK.new('1.1', '200', 'OK')
+          def http_response.body; AUTHORISE_RESPONSE; end
+          PaymentService::AuthorisationResponse.new(http_response)
+        end
+
+        # @return [AuthorisationResponse] An authorisation refused response instance.
+        def refused_stub
+          http_response = Net::HTTPOK.new('1.1', '200', 'OK')
+          def http_response.body; AUTHORISATION_REFUSED_RESPONSE; end
+          PaymentService::AuthorisationResponse.new(http_response)
+        end
+
+        # @return [AuthorisationResponse] An ‘invalid request’ response instance.
+        def invalid_stub
+          http_response = Net::HTTPOK.new('1.1', '200', 'OK')
+          def http_response.body; AUTHORISATION_REQUEST_INVALID_RESPONSE; end
+          PaymentService::AuthorisationResponse.new(http_response)
+        end
+
+        # Assigns a {#success_stub}, meaning the subsequent authoristaion request will be authorised.
+        #
+        # @return [AuthorisationResponse] A authorisation succeeded response instance.
+        def stub_success!
+          @stubbed_response = success_stub
+        end
+
+        # Assigns a {#refused_stub}, meaning the subsequent authoristaion request will be refused.
+        #
+        # @return [AuthorisationResponse] An authorisation refused response instance.
+        def stub_refused!
+          @stubbed_response = refused_stub
+        end
+
+        # Assigns a {#invalid_stub}, meaning the subsequent authoristaion request will be refused,
+        # because the request was invalid.
+        #
+        # @return [AuthorisationResponse] An ‘invalid request’ response instance.
+        def stub_invalid!
+          @stubbed_response = invalid_stub
+        end
+      end
+
+      extend TestHelpers
+    end
+
+    class RecurringService < SimpleSOAPClient
+      # A collection of test helpers that create and assign stubbed response instances for a
+      # subsequent remote call.
+      #
+      # This module extends the {RecurringService} class and thus these methods are callable on it.
+      module TestHelpers
+        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
+          http_response = Net::HTTPOK.new('1.1', '200', 'OK')
+          def http_response.body; DISABLE_RESPONSE % DisableResponse::DISABLED_RESPONSES.first; end
+          RecurringService::DisableResponse.new(http_response)
+        end
+
+        # Assigns a {#disabled_stub}, meaning the subsequent disable request will be successful.
+        def stub_disabled!
+          @stubbed_response = disabled_stub
+        end
+      end
+
+      extend TestHelpers
+    end
+  end
+end