adyen 1.6.0 → 2.0.0.pre1

data/lib/adyen/rest/request.rb

@@ -0,0 +1,107 @@
+module Adyen
+  module REST
+
+    # The request object models an API request to be sent to Adyen's webservice.
+    #
+    # Some API calls may use a subclass to model their request.
+    #
+    # @!attribute prefix [r]
+    #   The prefix to use for every request attribute (except action)
+    #   @return [String]
+    # @!attribute form_data [r]
+    #   The attributes to include in the API request as form data.
+    #   @return [Hash<String, String>] A dictionary of key value pairs
+    # @!required_attributes [r]
+    #   The list of required attributes that should show up in the request.
+    #   {#validate!} will fail if any of these attributes is missing or empty.
+    #   @return [Array<String>]
+    # @!attribute response_class [rw]
+    #   The response class to use to wrap the HTTP response to this request.
+    #   @return [Class]
+    # @!attribute response_options [rw]
+    #   The options to send to the response class initializer.
+    #   @return [Hash]
+    #
+    # @see Adyen::REST::Client
+    # @see Adyen::REST::Response
+    class Request
+      attr_reader :prefix, :form_data, :required_attributes
+      attr_accessor :response_class, :response_options
+
+      def initialize(action, attributes, options = {})
+        @prefix = options[:prefix]
+        @form_data = generate_form_data(action, attributes)
+
+        @response_class   = options[:response_class]   || Adyen::REST::Response
+        @response_options = options[:response_options] || {}
+
+        @required_attributes = ['action']
+      end
+
+      # Returns the request's action
+      # @return [String]
+      def action
+        form_data['action']
+      end
+
+      # Retrieves an attribute from the request
+      def [](attribute)
+        form_data[canonical_name(attribute)]
+      end
+
+      # Sets an attribute on the request
+      def []=(attribute, value)
+        form_data.merge!(flatten_attributes(attribute => value))
+        value
+      end
+
+      def merchant_account=(value)
+        self[:merchant_account] = value
+      end
+
+      # Runs validations on the request before it is sent.
+      # @return [void]
+      # @raises [Adyen::REST::RequestValidationFailed]
+      def validate!
+        required_attributes.each do |attribute|
+          if form_data[attribute].nil? || form_data[attribute].empty?
+            raise Adyen::REST::RequestValidationFailed, "#{attribute} is empty, but required!"
+          end
+        end
+      end
+
+      # Builds a Adyen::REST::Response instnace for a given Net::HTTP response.
+      # @param http_response [Net::HTTPResponse] The HTTP response return for this request.
+      # @return [Adyen::REST::Response] An instance of {Adyen::REST::Response}, or a subclass.
+      def build_response(http_response)
+        response_class.new(http_response, response_options)
+      end
+
+      protected
+
+      def canonical_name(name)
+        Adyen::Util.camelize(apply_prefix(name))
+      end
+
+      def apply_prefix(name)
+        prefix ? name.to_s.sub(/\A(?!#{Regexp.quote(prefix)}\.)/, "#{prefix}.") : name.to_s
+      end
+
+      # Flattens the {#attributes} hash and converts all the keys to camelcase.
+      # @return [Hash] A potentially nested hash of attributes.
+      # @return [Hash<String, String>] A dictionary of API request attributes that
+      #   can be included in an HTTP request as form data.
+      def flatten_attributes(attributes)
+        if prefix
+          Adyen::Util.flatten(prefix => attributes)
+        else
+          Adyen::Util.flatten(attributes)
+        end
+      end
+
+      def generate_form_data(action, attributes)
+        flatten_attributes(attributes).merge('action' => action.to_s)
+      end
+    end
+  end
+end

data/lib/adyen/rest/response.rb

@@ -0,0 +1,59 @@
+module Adyen
+  module REST
+
+    # The Response class models the HTTP response that is the result of a
+    # API call to Adyen's REST webservice.
+    #
+    # Some API calls may respond with an instance of a subclass, to make
+    # dealing with the response easier.
+    #
+    # @!attribute http_response [r]
+    #   The underlying net/http response.
+    #   @return [Net::HTTPResponse]
+    # @!attribute prefix [r]
+    #   The prefix to use when reading attributes from the response
+    #   @return [String]
+    #
+    # @see Adyen::REST::Client
+    # @see Adyen::REST::Request
+    class Response
+      attr_reader :http_response, :prefix, :attributes
+
+      def initialize(http_response, options = {})
+        @http_response = http_response
+        @prefix = options.key?(:prefix) ? options[:prefix].to_s : nil
+        @attributes = parse_response_attributes
+      end
+
+      # Looks up an attribute in the response.
+      # @return [String, nil] The value of the attribute if it was included in the response.
+      def [](name)
+        attributes[canonical_name(name)]
+      end
+
+      def has_attribute?(name)
+        attributes.has_key?(canonical_name(name))
+      end
+
+      def psp_reference
+        Integer(self[:psp_reference])
+      end
+
+      protected
+
+      def canonical_name(name)
+        Adyen::Util.camelize(apply_prefix(name))
+      end
+
+      def apply_prefix(name)
+        prefix ? name.to_s.sub(/\A(?!#{Regexp.quote(prefix)}\.)/, "#{prefix}.") : name.to_s
+      end
+
+      def parse_response_attributes
+        attributes = CGI.parse(http_response.body)
+        attributes.each { |key, values| attributes[key] = values.first }
+        attributes
+      end
+    end
+  end
+end

data/lib/adyen/util.rb

@@ -0,0 +1,147 @@
+require 'date'
+require 'openssl'
+require 'base64'
+
+module Adyen
+  module Util
+    extend self
+
+    # Returns a valid Adyen string representation for a date
+    def format_date(date)
+      case date
+      when Date, DateTime, Time
+        date.strftime('%Y-%m-%d')
+      when String
+        raise ArgumentError, "Invalid date notation: #{date.inspect}!" unless /^\d{4}-\d{2}-\d{2}$/ =~ date
+        date
+      else
+        raise ArgumentError, "Cannot convert #{date.inspect} to date!"
+      end
+    end
+
+    # Returns a valid Adyen string representation for a timestamp
+    def format_timestamp(time)
+      case time
+      when Date, DateTime, Time
+        time.strftime('%Y-%m-%dT%H:%M:%SZ')
+      when String
+        raise ArgumentError, "Invalid timestamp notation: #{time.inspect}!" unless /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}Z$/ =~ time
+        time
+      else
+        raise ArgumentError, "Cannot convert #{time.inspect} to timestamp!"
+      end
+    end
+
+    # Returns a base64-encoded signature for a message
+    # @param [String] hmac_key The secret key to use for the HMAC signature.
+    # @param [String] message The message to sign.
+    # @return [String] The signature, base64-encoded.
+    def hmac_base64(hmac_key, message)
+      digest = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), hmac_key, message)
+      Base64.strict_encode64(digest).strip
+    end
+
+    # Retuns a message gzip-compressed and base64-encoded.
+    # @param [String] message The message to compress and encode.
+    # @return [String] The compressed and encoded version of the message
+    def gzip_base64(message)
+      sio = StringIO.new
+      gz  = Zlib::GzipWriter.new(sio)
+      gz.write(message)
+      gz.close
+      Base64.strict_encode64(sio.string)
+    end
+
+    # Returns the camelized version of a string.
+    # @param [:to_s] identifier The identifier to turn to camelcase.
+    # @return [String] The camelcase version of the identifier provided.
+    def camelize(identifier)
+      CAMELCASE_EXCEPTIONS[identifier.to_s] || identifier.to_s.gsub(/_+(.)/) { $1.upcase }
+    end
+
+    # Returns the underscore version of a string.
+    # @param [:to_s] identifier The identifier to turn to underscore notation.
+    # @return [String] The underscore version of the identifier provided.
+    def underscore(identifier)
+      UNDERSCORE_EXCEPTIONS[identifier.to_s] || identifier.to_s
+        .gsub(/([A-Z]{2,})([A-Z])/) { "#{$1.downcase}#{$2}" }
+        .gsub(/(?!\A)([A-Z][a-z]*)/, '_\1')
+        .downcase
+    end
+
+    # Transforms the nested parameters Hash into a 'flat' Hash which is understood by adyen. This is:
+    #  * all keys are camelized
+    #  * all keys are stringified
+    #  * nested hash is flattened, keys are prefixed with root key
+    #
+    # @example
+    #    flatten {:billing_address => { :street => 'My Street'}}
+    #
+    #    # resolves in:
+    #    {'billingAddress.street' =>  'My Street'}
+    #
+    # @param [Hash] nested_hash The nested hash to transform
+    # @param [String] prefix The prefix to add to the key
+    # @param [Hash] return_hash The new hash which is retruned (needed for recursive calls)
+    # @return [Hash] The return hash filled with camelized and prefixed key, stringified value
+    def flatten(nested_hash, prefix = "", return_hash = {})
+      nested_hash ||= {}
+      nested_hash.inject(return_hash) do |hash, (key, value)|
+        key = "#{prefix}#{camelize(key)}"
+        if value.is_a?(Hash)
+          flatten(value, "#{key}.", return_hash)
+        else
+          hash[key] = value.to_s
+        end
+        hash
+      end
+    end
+
+    # Transforms a flat hash into a nested hash structure.
+    #  * all keys are underscored
+    #  * all keys are stringified
+    #  * flattened hash is deflattened, using . as namespace separator
+    #
+    # @example
+    #    deflatten {'billingAddress.street' =>  'My Street'}
+    #
+    #    # resolves in:
+    #    {'billing_address' => { 'street' => 'My Street'}}
+    #
+    # @param [Hash] flattened_hash The flat hash to transform
+    # @param [Hash] return_hash The new hash which will be returned (needed for recursive calls)
+    # @return [Hash] A nested hash structure, using strings as key.
+    def deflatten(flattened_hash, return_hash = {})
+      return return_hash if flattened_hash.nil?
+      flattened_hash.each do |key, value|
+        deflatten_pair(key, value, return_hash)
+      end
+      return_hash
+    end
+
+    private
+
+    def deflatten_pair(key, value, return_hash)
+      head, rest = key.split('.', 2)
+      key = underscore(head)
+      if rest.nil?
+        raise ArgumentError, "Duplicate key in flattened hash." if return_hash.key?(key)
+        return_hash[key] = value
+      else
+        return_hash[key] ||= {}
+        raise ArgumentError, "Key nesting conflict in flattened hash." unless return_hash[key].is_a?(Hash)
+        deflatten_pair(rest, value, return_hash[key])
+      end
+    end
+
+    # This hash contains exceptions to the standard underscore to camelcase conversion rules.
+    CAMELCASE_EXCEPTIONS = {
+      'shopper_ip' => 'shopperIP'
+    }
+
+    # This hash contains exceptions to the standard camelcase to underscore conversion rules.
+    UNDERSCORE_EXCEPTIONS = CAMELCASE_EXCEPTIONS.invert
+
+    private_constant :CAMELCASE_EXCEPTIONS, :UNDERSCORE_EXCEPTIONS
+  end
+end

data/lib/adyen/version.rb

@@ -1,5 +1,5 @@
 module Adyen
   # Version constant for the Adyen plugin.
   # Set it & commit the change before running rake release.
-  VERSION = "1.6.0"
+  VERSION = "2.0.0.pre1"
 end

data/test/form_test.rb

@@ -29,7 +29,7 @@ class FormTest < Minitest::Test
         :state_or_province    => 'Berlin',
         :country              => 'Germany',
       },
-    :shopper => {
+      :shopper => {
         :telephone_number       => '1234512345',
         :first_name             => 'John',
         :last_name              => 'Doe',
@@ -90,7 +90,7 @@ class FormTest < Minitest::Test
 
     params = CGI.parse(redirect_uri.query)
     attributes.each do |key, value|
-      assert_equal value.to_s, params[Adyen::Form.camelize(key).to_s].first
+      assert_equal value.to_s, params[Adyen::Util.camelize(key).to_s].first
     end
 
     assert params.key?('merchantSig'), "Expected a merchantSig parameter to be set"
@@ -107,7 +107,7 @@ class FormTest < Minitest::Test
 
     params = CGI.parse(redirect_uri.query)
     attributes.each do |key, value|
-      assert_equal value.to_s, params[Adyen::Form.camelize(key).to_s].first
+      assert_equal value.to_s, params[Adyen::Util.camelize(key).to_s].first
     end
 
     assert params.key?('merchantSig'), "Expected a merchantSig parameter to be set"
@@ -158,9 +158,9 @@ class FormTest < Minitest::Test
 
   def test_redirect_signature_check
     params = { 
-      :authResult => 'AUTHORISED', :pspReference => '1211992213193029',
-      :merchantReference => 'Internet Order 12345', :skinCode => '4aD37dJA',
-      :merchantSig => 'ytt3QxWoEhAskUzUne0P5VA9lPw='
+      'authResult' => 'AUTHORISED', 'pspReference' => '1211992213193029',
+      'merchantReference' => 'Internet Order 12345', 'skinCode' => '4aD37dJA',
+      'merchantSig' => 'ytt3QxWoEhAskUzUne0P5VA9lPw='
     }
 
     assert_equal params[:merchantSig], Adyen::Form.redirect_signature(params)
@@ -179,10 +179,17 @@ class FormTest < Minitest::Test
     assert_raises(ArgumentError) { Adyen::Form.redirect_signature_check(params.delete(:skinCode)) }
   end
 
-  def test_flatten
-    parameters = { 'billingAddress.street' => 'My Street' }
-    assert_equal parameters, Adyen::Form.flatten(:billing_address => { :street => 'My Street'})
-    assert_equal Hash.new, Adyen::Form.flatten(nil)
+  def test_redirect_signature_check
+    Adyen.configuration.register_form_skin(:testing, 'tifSfXeX', 'testing123', :merchant_account => 'VanBergenORG')
+
+# http://example.com/result?merchantReference=HPP+test+order+%25231&skinCode=tifSfXeX&shopperLocale=en_GB&paymentMethod=visa&authResult=AUTHORISED&pspReference=8814131153369759&merchantSig=il8cjgOiG4N9l2PlSf6h4EVQ6hk%253D
+    params = {
+      "merchantReference"=>CGI.unescape("HPP test order %231"), "skinCode"=>"tifSfXeX", 
+      "shopperLocale"=>"en_GB", "paymentMethod"=>"visa", "authResult"=>"AUTHORISED", 
+      "pspReference"=>"8814131148758652", "merchantSig"=> CGI.unescape("q8J9P%2Fp%2FYsbnnFn%2F83TFsv7Hais%3D")
+    }
+
+    assert_equal params['merchantSig'], Adyen::Form.redirect_signature(params)
   end
 
   def test_hidden_payment_form_fields

data/test/functional/payment_authorisation_api_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class PaymentAuthorisationAPITest < Minitest::Test
+  def setup
+    @client = Adyen::REST.client
+  end
+
+  def teardown
+    @client.close
+  end
+
+  def test_payment_api_request
+    response = @client.authorise_payment(
+      merchant_account: 'VanBergenORG',
+      amount: { currency: 'EUR', value: 1234 },
+      reference: 'Test order #1',
+      card: Adyen::TestCards::VISA
+    )
+
+    assert response.authorised?
+    assert response.psp_reference
+  end
+
+  def test_refused_payment_api_request
+    response = @client.authorise_payment(
+      merchant_account: 'VanBergenORG',
+      amount: { currency: 'EUR', value: 1234 },
+      reference: 'Test order #1',
+      card: Adyen::TestCards::VISA.merge(cvc: '123')
+    )
+
+    assert response.refused?
+    assert response.psp_reference
+    assert response.has_attribute?(:refusal_reason)
+  end
+
+  def test_payment_with_3d_secure_api_request
+    response = @client.authorise_payment(
+      merchant_account: 'VanBergenORG',
+      amount: { currency: 'EUR', value: 1234 },
+      reference: 'Test order #1',
+      card: Adyen::TestCards::MASTERCARD_3DSECURE,
+      browser_info: {
+        acceptHeader: "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+        userAgent: "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0"
+      }
+    )
+
+    assert response.redirect_shopper?
+    assert response.psp_reference
+    assert response.has_attribute?(:md)
+    assert_equal "https://test.adyen.com/hpp/3d/validate.shtml", response['issuer_url']
+  end
+end

data/test/functional/payment_modification_api_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class PaymentModificationAPITest < Minitest::Test
+  def setup
+    @client = Adyen::REST.client
+  end
+
+  def teardown
+    @client.close
+  end
+
+  def test_capture_payment_api_request
+    response = @client.capture_payment(
+      merchant_account: 'VanBergenORG',
+      modification_amount: { currency: 'EUR', value: 1234 },
+      reference: "functional test for cancellation",
+      original_reference: 7913939284323855
+    )
+
+    assert response.received?
+    assert response.psp_reference
+  end
+
+  def test_cancel_payment_api_request
+    response = @client.cancel_payment(
+      merchant_account: 'VanBergenORG',
+      reference: "functional test for cancellation",
+      original_reference: 7913939284323855
+    )
+
+    assert response.received?
+    assert response.psp_reference
+  end
+
+  def test_refund_payment_api_request
+    response = @client.refund_payment(
+      merchant_account: 'VanBergenORG',
+      modification_amount: { currency: 'EUR', value: 1234 },
+      reference: "functional test for cancellation",
+      original_reference: 7913939284323855
+    )
+
+    assert response.received?
+    assert response.psp_reference
+  end
+
+  def test_cancel_or_refund_payment_api_request
+    response = @client.cancel_or_refund_payment(
+      merchant_account: 'VanBergenORG',
+      reference: "functional test for cancellation",
+      original_reference: 7913939284323855
+    )
+
+    assert response.received?
+    assert response.psp_reference
+  end
+end