adyen 0.3.8 → 1.0.0

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

@@ -0,0 +1,103 @@
+module Adyen
+  module API
+    class PaymentService < SimpleSOAPClient
+      class << self
+        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
+        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
+        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 = <<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
+
+      # @private
+      AMOUNT_PARTIAL = <<EOS
+        <payment:amount>
+          <common:currency>%s</common:currency>
+          <common:value>%s</common:value>
+        </payment:amount>
+EOS
+
+      # @private
+      CARD_PARTIAL = <<EOS
+        <payment: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>
+        </payment:card>
+EOS
+
+      # @private
+      ENABLE_RECURRING_CONTRACTS_PARTIAL = <<EOS
+        <payment:recurring>
+          <payment:contract>RECURRING,ONECLICK</payment:contract>
+        </payment:recurring>
+EOS
+
+      # @private
+      RECURRING_PAYMENT_BODY_PARTIAL = <<EOS
+        <payment:recurring>
+          <payment:contract>RECURRING</payment:contract>
+        </payment:recurring>
+        <payment:selectedRecurringDetailReference>%s</payment:selectedRecurringDetailReference>
+        <payment:shopperInteraction>ContAuth</payment:shopperInteraction>
+EOS
+
+      # @private
+      ONE_CLICK_PAYMENT_BODY_PARTIAL = <<EOS
+        <payment:recurring>
+          <payment:contract>ONECLICK</payment:contract>
+        </payment:recurring>
+        <payment:selectedRecurringDetailReference>%s</payment:selectedRecurringDetailReference>
+        <payment:card>
+          <payment:cvc>%s</payment:cvc>
+        </payment:card>
+EOS
+
+      # @private
+      SHOPPER_PARTIALS = {
+        :reference => '        <payment:shopperReference>%s</payment:shopperReference>',
+        :email     => '        <payment:shopperEmail>%s</payment:shopperEmail>',
+        :ip        => '        <payment:shopperIP>%s</payment:shopperIP>',
+      }
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Adyen
+  module API
+    class RecurringService < SimpleSOAPClient
+      # @private
+      LIST_LAYOUT = <<EOS
+    <recurring:listRecurringDetails xmlns:recurring="http://recurring.services.adyen.com">
+      <recurring:request>
+        <recurring:recurring>
+          <recurring:contract>RECURRING</recurring: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
+    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 % <<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
+
+        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_REQUEST_INVALID_RESPONSE = SimpleSOAPClient::ENVELOPE % <<EOS
+    <soap:Fault>
+      <faultcode>soap:Server</faultcode>
+      <faultstring>validation 101 Invalid card number</faultstring>
+    </soap:Fault>
+EOS
+
+        # @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 % <<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
+
+        # @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

data/lib/adyen/api/xml_querier.rb

@@ -0,0 +1,94 @@
+module Adyen
+  module API
+    # A simple wrapper around the raw response body returned by Adyen. It abstracts away the
+    # differences between REXML and Nokogiri, ensuring that this library will always work.
+    #
+    # At load time, it will first check if Nokogiri is available, otherwise REXML is used. This
+    # means that if you want to use Nokogiri and have it installed as a gem, you will have to make
+    # sure rubygems is loaded and the gem has been activated. Or assign the backend to use.
+    class XMLQuerier
+      # The namespaces used by Adyen.
+      NS = {
+        'soap'      => 'http://schemas.xmlsoap.org/soap/envelope/',
+        'payment'   => 'http://payment.services.adyen.com',
+        'recurring' => 'http://recurring.services.adyen.com',
+        'common'    => 'http://common.services.adyen.com'
+      }
+
+      class << self
+        # @return [:rexml, :nokogiri] The XML backend to use.
+        attr_reader :backend
+        def backend=(backend)
+          @backend = backend
+          class_eval do
+            private
+            if backend == :nokogiri
+              def document_for_xml(xml)
+                Nokogiri::XML::Document.parse(xml)
+              end
+              def perform_xpath(query)
+                @node.xpath(query, NS)
+              end
+            else
+              def document_for_xml(xml)
+                REXML::Document.new(xml)
+              end
+              def perform_xpath(query)
+                REXML::XPath.match(@node, query, NS)
+              end
+            end
+          end
+        end
+      end
+
+      begin
+        require 'nokogiri'
+        self.backend = :nokogiri
+      rescue LoadError
+        require 'rexml/document'
+        self.backend = :rexml
+      end
+
+      # @param [String, Array, Nokogiri::XML::NodeSet] data The XML data to wrap.
+      def initialize(data)
+        @node = data.is_a?(String) ? document_for_xml(data) : data
+      end
+
+      # @param [String] query The xpath query to perform.
+      # @yield [XMLQuerier] A new XMLQuerier scoped to the given +query+.
+      # @return [XMLQuerier] A new XMLQuerier scoped to the given +query+. Or, if a block is given,
+      #                      the result of calling the block.
+      def xpath(query)
+        result = self.class.new(perform_xpath(query))
+        block_given? ? yield(result) : result
+      end
+
+      # @param [String] query The xpath query to perform.
+      # @return [String] The contents of the text node indicated by the given +query+.
+      def text(query)
+        xpath("#{query}/text()").to_s.strip
+      end
+
+      # @return [Array, Nokogiri::XML::NodeSet] The children of this node.
+      def children
+        @node.first.children
+      end
+
+      # @return [Boolean] Returns whether or not this node is empty.
+      def empty?
+        @node.empty?
+      end
+
+      # @return [String] A string representation of this node.
+      def to_s
+        Array === @node ? @node.join("") : @node.to_s
+      end
+
+      # @yield [XMLQuerier] A member of this node set, ready to be queried.
+      # @return [Array] The list of nodes wrapped in XMLQuerier instances.
+      def map(&block)
+        @node.map { |n| self.class.new(n) }.map(&block)
+      end
+    end
+  end
+end

data/lib/adyen/configuration.rb

@@ -0,0 +1,139 @@
+class Adyen::Configuration
+
+  def initialize
+    @default_api_params  = {}
+    @default_form_params = {}
+    @form_skins          = {}
+  end
+
+  # The Rails environment for which to use to Adyen "live" environment.
+  LIVE_RAILS_ENVIRONMENTS = ['production']
+
+  # Setter voor the current Adyen environment.
+  # @param ['test', 'live'] env The Adyen environment to use
+  def environment=(env)
+    @environment = env
+  end
+
+  # Returns the current Adyen environment, either test or live.
+  #
+  # It will return the +override+ value if set, it will return the value set
+  # using Adyen.configuration.environment= otherwise. If this value also isn't set, the
+  # environment is determined with autodetect_environment.
+  #
+  # @param ['test', 'live'] override An environment to override the default with.
+  # @return ['test', 'live'] The Adyen environment that is currently being used.
+  def environment(override = nil)
+    override || @environment || autodetect_environment
+  end
+
+  # Autodetects the Adyen environment based on the RAILS_ENV constant.
+  # @return ['test', 'live'] The Adyen environment that corresponds to the Rails environment
+  def autodetect_environment
+    rails_env = if defined?(::Rails) && ::Rails.respond_to?(:env)
+      ::Rails.env.to_s
+    elsif defined?(::RAILS_ENV)
+      ::RAILS_ENV.to_s
+    end
+    
+    LIVE_RAILS_ENVIRONMENTS.include?(rails_env) ? 'live' : 'test'
+  end
+
+  # The username that’s used to authenticate for the Adyen SOAP services. It should look
+  # something like ‘+ws@AndyInc.SuperShop+’
+  #
+  # @return [String]
+  attr_accessor :api_username
+
+  # The password that’s used to authenticate for the Adyen SOAP services. You can configure it
+  # in the user management tool of the merchant area.
+  #
+  # @return [String]
+  attr_accessor :api_password
+
+  # Default arguments that will be used for every API call. You can override these default
+  # values by passing a diffferent value to the service class’s constructor.
+  #
+  # @example
+  #   Adyen.configuration.default_api_params[:merchant_account] = 'SuperShop'
+  #
+  # @return [Hash]
+  attr_accessor :default_api_params
+
+  # Default arguments that will be used for in every HTML form.
+  #
+  # @example
+  #   Adyen.configuration.default_form_params[:shared_secret] = 'secret'
+  #
+  # @return [Hash]
+  attr_accessor :default_form_params
+
+  ######################################################
+  # SKINS
+  ######################################################
+
+  # Returns all registered skins and their accompanying skin code and shared secret.
+  #
+  # @return [Hash] The hash of registered skins.
+  attr_reader :form_skins
+  
+  # Sets the registered skins.
+  #
+  # @param [Hash<Symbol, Hash>] hash A hash with the skin name as key and the skin parameter hash 
+  #    (which should include +:skin_code+ and +:shared_secret+) as value.
+  #
+  # @see Adyen::Configuration.register_form_skin
+  def form_skins=(hash)
+    @form_skins = hash.inject({}) do |skins, (name, skin)|
+      skins[name.to_sym] = skin.merge(:name => name.to_sym)
+      skins
+    end
+  end
+
+  # Registers a skin for later use.
+  #
+  # You can store a skin using a self defined symbol. Once the skin is registered,
+  # you can refer to it using this symbol instead of the hard-to-remember skin code.
+  # Moreover, the skin's shared_secret will be looked up automatically for calculting
+  # signatures.
+  #
+  # @example
+  #   Adyen::Configuration.register_form_skin(:my_skin, 'dsfH67PO', 'Dfs*7uUln9')
+  #
+  # @param [Symbol] name The name of the skin.
+  # @param [String] skin_code The skin code for this skin, as defined by Adyen.
+  # @param [String] shared_secret The shared secret used for signature calculation.
+  def register_form_skin(name, skin_code, shared_secret)
+    @form_skins[name.to_sym] = { :name => name.to_sym, :skin_code => skin_code, :shared_secret => shared_secret }
+  end
+
+  # Returns a skin information by name.
+  #
+  # @param [Symbol] skin_name The name of the skin
+  # @return [Hash, nil] A hash with the skin information, or nil if not found.
+  def form_skin_by_name(skin_name)
+    @form_skins[skin_name.to_sym]
+  end
+
+  # Returns skin information by code code.
+  #
+  # @param [String] skin_code The code of the skin.
+  #
+  # @return [Hash, nil] A hash with the skin information, or nil if not found.
+  def form_skin_by_code(skin_code)
+    if skin = @form_skins.detect { |(name, skin)| skin[:skin_code] == skin_code }
+      skin.last
+    end
+  end
+
+  # Returns the shared secret belonging to a skin.
+  #
+  # @param [String] skin_code The skin code of the skin
+  #
+  # @return [String, nil] The shared secret for the skin, or nil if not found.
+  def form_skin_shared_secret_by_code(skin_code)
+    if skin = form_skin_by_code(skin_code)
+      skin[:shared_secret]
+    end
+  end
+end