adyen_jpiqueras 2.3.0

data/lib/adyen/rest.rb

@@ -0,0 +1,67 @@
+require 'adyen/base'
+require 'adyen/rest/client'
+require 'adyen/rest/signature'
+
+module Adyen
+
+  # The Adyen::REST module allows you to interact with Adyen's REST API.
+  #
+  # The primary method here is {Adyen::REST.session}, which will yield a
+  # {Adyen::REST::Client} which you can use to send API requests.
+  #
+  # If you need more than one client instance, for instance because you
+  # have multiple acounts set up with different permissions, you can instantiate
+  # clients yourself using {Adyen::REST::Client.new}
+  #
+  # @example Using the singleton Client instance
+  #
+  #     Adyen::REST.session do |client|
+  #       client.http.read_timeout = 5
+  #       response = client.api_request(...)
+  #       # ...
+  #     end
+  #
+  # @example Using a your own Client instance
+  #
+  #     Adyen::REST::Client.new('test', 'username', 'password').session do |client|
+  #       client.http.read_timeout = 5
+  #       response = client.api_request(...)
+  #       # ...
+  #     end
+  #
+  #
+  # @see Adyen::REST.session Use Adyen::REST.session to run code against the API.
+  # @see Adyen::REST::Client Adyen::REST::Client implements the actual API calls.
+  module REST
+
+    # Provides a singelton REST API client this is configured using the values in
+    # <tt>Adyen.configuration</tt>.
+    #
+    # @param options [Hash] (see Adyen::REST::Client#initialize)
+    # @return [Adyen::REST::Client] A configured client instance
+    # @see .session
+    # @see Adyen::REST::Client.new To instantiate Clients yourself, in case you need more than one.
+    def self.client
+      Adyen::REST::Client.new(
+        Adyen.configuration.environment,
+        Adyen.configuration.api_username,
+        Adyen.configuration.api_password
+      )
+    end
+
+    # Exectutes a session against the Adyen REST API.
+    #
+    # It will use a standard client from {Adyen::REST.client}, or it uses a provided client.
+    # The client will be yielded to the block, and will be closed after the block is finisged
+    #
+    # @param client [Adyen::REST::Client] A custom API client if a default one won't do.
+    # @yield The provided block will be called in which you can interact with the API using
+    #   the provided client. The client will be closed after the block returns.
+    # @yieldparam client [Adyen::REST::Client] The REST client to use for the session.
+    # @return [void]
+    # @see Adyen::REST::Client#session
+    def self.session(client = self.client, &block)
+      client.session(&block)
+    end
+  end
+end

data/lib/adyen/rest/authorise_payment.rb

@@ -0,0 +1,234 @@
+module Adyen
+  module REST
+
+    # This module implements the <b>Payment.authorise</b>, and <b>Payment.authorise3d</b>
+    # API calls, and includes a custom response class to make handling the response easier.
+    module AuthorisePayment
+
+      class Request < Adyen::REST::Request
+
+        def set_amount(currency, value)
+          self['amount'] = { currency: currency, value: value }
+        end
+
+        def set_encrypted_card_data(source)
+          encrypted_json = if source.respond_to?(:params)
+            source.params['adyen-encrypted-data']
+          elsif source.is_a?(Hash) && source.key?('adyen-encrypted-data')
+            source['adyen-encrypted-data']
+          else
+            source
+          end
+
+          self['additional_data.card.encrypted.json'] = encrypted_json
+        end
+
+        def set_browser_info(request)
+          self['shopper_ip']                 = request.ip
+          self['browser_info.accept_header'] = request['Accept'] || "text/html;q=0.9,*/*",
+          self['browser_info.user_agent']    = request.user_agent
+        end
+
+        def set_3d_secure_parameters(request)
+          set_browser_info(request)
+          self['pa_response'] = request.params['PaRes']
+          self['md']          = request.params['MD']
+        end
+      end
+
+      # The Response class implements some extensions for the authorise payment call.
+      # @see Adyen::REST::Response
+      class Response < Adyen::REST::Response
+
+        # Checks whether the authorisation was successful.
+        # @return [Boolean] <tt>true</tt> iff the authorisation was successful, and the
+        #   authorised amount can be captured.
+        def authorised?
+          result_code == AUTHORISED
+        end
+
+        alias_method :authorized?, :authorised?
+
+        # Check whether the payment was refused.
+        # @return [Boolean] <tt>true</tt> iff the authorisation was not successful.
+        def refused?
+          result_code == REFUSED
+        end
+
+        # Checks whether the result of the authorization call was RedirectShopper,
+        # which means that the customer has to be redirected away from your site to
+        # complete the 3Dsecure transaction.
+        # @return [Boolean] <tt>true</tt> iff the shopper has to be redirected,
+        #   <tt>false</tt> in any other case.
+        def redirect_shopper?
+          result_code == REDIRECT_SHOPPER
+        end
+
+        # Returns the result code from the transaction.
+        # @return [String] The result code.
+        # @see #authorised?
+        # @see #refused?
+        # @see #redirect_shopper?
+        def result_code
+          self[:result_code]
+        end
+
+        private
+
+        AUTHORISED       = 'Authorised'.freeze
+        REFUSED          = 'Refused'.freeze
+        REDIRECT_SHOPPER = 'RedirectShopper'.freeze
+        private_constant :AUTHORISED, :REFUSED, :REDIRECT_SHOPPER
+      end
+
+      # Generates <tt>Payment.authorise</tt> request for Adyen's webservice.
+      # @param (see #authorise_payment)
+      # @return [Adyen::REST::Request] The request to send
+      # @see #authorise_payment
+      def authorise_payment_request(attributes = {})
+        Adyen::REST::AuthorisePayment::Request.new('Payment.authorise', attributes,
+            response_class: Adyen::REST::AuthorisePayment::Response)
+      end
+
+      # Sends an authorise payment request to Adyen's webservice.
+      # @param attributes [Hash] The attributes to include in the request.
+      # @return [Adyen::REST::AuthorisePayment::Response] The response from Adyen.
+      #   The response responds to <tt>.authorised?</tt> to check whether the
+      #   authorization was successful.
+      # @see Adyen::REST::AuthorisePayment::Response#authorised?
+      def authorise_payment(attributes)
+        request = authorise_payment_request(attributes)
+        execute_request(request)
+      end
+
+      # Generates a <tt>Payment.authorise3d</tt> request to Adyen's webservice.
+      #
+      # The response differs based on the credit card uses in the transaction.
+      # For some credit cards, an additional offsite step may be required to complete
+      # the transaction. Check <tt>.redirect_shopper?</tt> to see if this is the case.
+      # Other cards are not 3DSecure-enabled, and may immediately authorise the
+      # transaction. Check <tt>.authorised?</tt> to see if this is the case.
+      #
+      # @param attributes [Hash] The attributes to include in the request.
+      # @return [Adyen::REST::AuthorisePayment::Response] The response from Adyen.
+      # @see Adyen::REST::AuthorisePayment::Response#redirect_shopper?
+      # @see Adyen::REST::AuthorisePayment::Response#authorised?
+      def authorise_payment_3dsecure_request(attributes = {})
+        Adyen::REST::AuthorisePayment::Request.new('Payment.authorise3d', attributes,
+            response_class: Adyen::REST::AuthorisePayment::Response)
+      end
+
+      # Sends a 3Dsecure-enabled authorise payment request to Adyen's webservice.
+      #
+      # The response differs based on the credit card uses in the transaction.
+      # For some credit cards, an additional offsite step may be required to complete
+      # the transaction. Check <tt>.redirect_shopper?</tt> to see if this is the case.
+      # Other cards are not 3DSecure-enabled, and may immediately authorise the
+      # transaction. Check <tt>.authorised?</tt> to see if this is the case.
+      #
+      # @param attributes [Hash] The attributes to include in the request.
+      # @return [Adyen::REST::AuthorisePayment::Response] The response from Adyen.
+      # @see Adyen::REST::AuthorisePayment::Response#redirect_shopper?
+      # @see Adyen::REST::AuthorisePayment::Response#authorised?
+      def authorise_payment_3dsecure(attributes)
+        request = authorise_payment_3dsecure_request(attributes)
+        execute_request(request)
+      end
+
+      # Generates <tt>Payment.authorise</tt> request with recurring for Adyen's webservice.
+      # @param (see #authorise_recurring_payment)
+      # @return [Adyen::REST::Request] The request to send
+      # @see #authorise_recurring_payment
+      def authorise_recurring_payment_request(attributes={})
+        Adyen::REST::AuthoriseRecurringPayment::Request.new('Payment.authorise', attributes,
+            response_class: Adyen::REST::AuthorisePayment::Response)
+      end
+
+      # Sends an authorise recurring payment request to Adyen's webservice.
+      # @param attributes [Hash] The attributes to include in the request.
+      # @return [Adyen::REST::AuthorisePayment::Response] The response from Adyen.
+      #   The response responds to <tt>.authorised?</tt> to check whether the
+      #   authorization was successful.
+      # @see Adyen::REST::AuthorisePayment::Response#authorised?
+      def authorise_recurring_payment(attributes)
+        request = authorise_recurring_payment_request(attributes)
+        execute_request(request)
+      end
+
+      # Generates <tt>Payment.authorise</tt> request with recurring for Adyen's webservice.
+      # This method can be called if a previous contract was established with #authorise_recurring_payment
+      # @param (see #authorise_recurring_payment)
+      # @return [Adyen::REST::Request] The request to send
+      # @see #authorise_recurring_payment
+      def reauthorise_recurring_payment_request(attributes={})
+        Adyen::REST::ReauthoriseRecurringPayment::Request.new('Payment.authorise', attributes,
+            response_class: Adyen::REST::AuthorisePayment::Response)
+      end
+
+      # Sends an authorise recurring payment request to Adyen's webservice.
+      # This method can be called if a previous contract was established with #authorise_recurring_payment
+      # @param attributes [Hash] The attributes to include in the request.
+      # @return [Adyen::REST::AuthorisePayment::Response] The response from Adyen.
+      #   The response responds to <tt>.authorised?</tt> to check whether the
+      #   authorization was successful.
+      # @see Adyen::REST::AuthorisePayment::Response#authorised?
+      def reauthorise_recurring_payment(attributes)
+        request = reauthorise_recurring_payment_request(attributes)
+        execute_request(request)
+      end
+
+      # The Response class implements some extensions for the list recurring details call.
+      # @see Adyen::REST::Response
+      class ListRecurringDetailsResponse < Adyen::REST::Response
+        # Returns a list of recurring details
+        # @return [Array] A not empty array if there is at least a recurring detail
+        def details
+          mapped_attributes = {
+            :recurring_detail_reference => "recurringDetailReference",
+            :creation_date => "creationDate",
+            :variant => "variant",
+            :card_holder_name => "card.holderName",
+            :card_expiry_month => "card.expiryMonth",
+            :card_expiry_year => "card.expiryYear",
+            :card_number => "card.number"
+          }
+
+          map_response_list("details", mapped_attributes)
+        end
+
+        # Returns a list of recurring details references
+        # @return [Array] A not empty array if there is at least a recurring detail reference
+        def references
+          details.map { |detail| detail[:recurring_detail_reference] }
+        end
+      end
+
+      # Generates <tt>Recurring.listRecurringDetails</tt> request for Adyen's webservice.
+      # @param (see #list_recurring_details)
+      # @return [Adyen::REST::ListRecurringDetailsPayment::Request] The request to send
+      # @see #list_recurring_details
+      def list_recurring_details_request(attributes = {})
+        Adyen::REST::ListRecurringDetailsPayment::Request.new('Recurring.listRecurringDetails', attributes,
+            response_class: Adyen::REST::AuthorisePayment::ListRecurringDetailsResponse)
+      end
+
+      # Sends an list recurring details request to Adyen's webservice.
+      # @param attributes [Hash] The attributes to include in the request.
+      # @return [Adyen::REST::AuthorisePayment::ListRecurringDetailsResponse] The response from Adyen.
+      # The response responds to <tt>.details</tt> and <tt>.references</tt> with recurring data.
+      # @see Adyen::REST::AuthorisePayment::ListRecurringDetailsResponse#references
+      # @see Adyen::REST::AuthorisePayment::ListRecurringDetailsResponse#details
+      def list_recurring_details(attributes)
+        request = list_recurring_details_request(attributes)
+        execute_request(request)
+      end
+
+      alias_method :authorize_payment_request, :authorise_payment_request
+      alias_method :authorize_payment, :authorise_payment
+      alias_method :authorize_payment_3dsecure_request, :authorise_payment_3dsecure_request
+      alias_method :authorize_payment_3dsecure, :authorise_payment_3dsecure
+      alias_method :reauthorize_recurring_payment_request, :reauthorise_recurring_payment_request
+      alias_method :reauthorize_recurring_payment, :reauthorise_recurring_payment
+    end
+  end
+end

data/lib/adyen/rest/authorise_recurring_payment.rb

@@ -0,0 +1,46 @@
+module Adyen
+  module REST
+
+    # This modules implements the recurring requests using<b>Payment.authorise</b> by subclassing Adyen::REST::AuthorisePayment::Request it only adds mandatory fields to it
+    # Those requests can be called using #Adyen::Rest::AuthorisePayment.authorise_recurring_payment and #Adyen::Rest::AuthorisePayment.reauthorise_recurring_payment
+    module AuthoriseRecurringPayment
+      class Request < Adyen::REST::AuthorisePayment::Request
+        def initialize(action, attributes, options)
+          attributes[:recurring] ||= { contract: 'RECURRING' }
+          super(action, attributes, options)
+          @required_attributes += ['shopperEmail',
+            'recurring.contract',
+            'shopperReference',
+          ]
+        end
+      end
+    end
+
+    module ReauthoriseRecurringPayment
+      class Request < Adyen::REST::AuthorisePayment::Request
+        def initialize(action, attributes, options)
+          attributes[:recurring] ||= { contract: 'RECURRING' }
+          attributes[:shopper_interaction] ||= 'ContAuth'
+          attributes[:selected_recurring_detail_reference] ||= 'LATEST'
+          super(action, attributes, options)
+          @required_attributes += ['shopperEmail',
+            'shopperReference',
+            'recurring.contract',
+            'shopperInteraction'
+          ]
+        end
+      end
+    end
+
+    module ListRecurringDetailsPayment
+      class Request < Adyen::REST::Request
+        def initialize(action, attributes, options)
+          attributes[:recurring] ||= { contract: 'RECURRING' }
+          super(action, attributes, options)
+          @required_attributes += ['recurring.contract',
+            'shopperReference']
+        end
+      end
+    end
+  end
+end

data/lib/adyen/rest/client.rb

@@ -0,0 +1,127 @@
+require 'cgi'
+require 'net/http'
+
+require 'adyen/rest/errors'
+require 'adyen/rest/request'
+require 'adyen/rest/response'
+require 'adyen/rest/authorise_payment'
+require 'adyen/rest/authorise_recurring_payment'
+require 'adyen/rest/modify_payment'
+require 'adyen/rest/payout'
+
+module Adyen
+  module REST
+
+    # The Client class acts as a client to Adyen's REST webservice.
+    #
+    # @!attribute environment [r]
+    #   The adyen environment to interact with. Either <tt>'live'</tt> or <tt>'test'</tt>.
+    #   @return [String]
+    class Client
+      include AuthorisePayment
+      include ModifyPayment
+      include Payout
+
+      attr_reader :environment
+
+      # @param environment [String] The Adyen environment to interface with. Either
+      #   <tt>'live'</tt> or <tt>'test'</tt>.
+      # @param username [String] The webservice username, e.g. <tt>ws@Company.Account</tt>
+      # @param password [String] The password associated with the username
+      # @param default_api_params [Hash] Default arguments that will be used for every API call
+      def initialize(environment, username, password)
+        @environment, @username, @password = environment, username, password
+      end
+
+      # Closes the client.
+      #
+      # - This will terminate the HTTP connection.
+      # - After calling this method, the behavior of any further method calls against
+      #   this client instance is undefined.
+      #
+      # @return [void]
+      def close
+        @http.finish if @http && @http.started?
+        @http = nil
+      end
+
+      # Runs a client session against the Adyen REST service for the duration of the block,
+      # and closes the connection afterwards.
+      #
+      # @yield The provided block will be called in which you can interact with the API using
+      #   the provided client. The client will be closed after the block returns.
+      # @return [void]
+      def session
+        yield(self)
+      ensure
+        close
+      end
+
+
+      # The underlying <tt>Net::HTTP</tt> instance that is used to execute HTTP
+      # request against the API.
+      #
+      # You can use this to set options on the Net::HTTP instance, like <tt>read_timeout</tt>.
+      # Many of these options will only work if you set them before the HTTP connection is
+      # opened, i.e. before doing the first API call.
+      #
+      # @return [Net::HTTP] The underlying Net::HTTP instance the client uses to perform HTTP request.
+      def http
+        @http ||= Net::HTTP.new(endpoint.host, endpoint.port).tap do |http|
+          http.use_ssl = endpoint.scheme == 'https'
+        end
+      end
+
+      # Executes an API request, and returns a reponse of the given type.
+      #
+      # @param request [Adyen::REST::Request] The API request to execute.
+      #   <tt>validate!</tt> will be called on the this object before the
+      #   request is made.
+      # @param response_type [Class] The response type to use. Use either
+      #   <tt>Adyen::REST::Response</tt> or a subclass.
+      # @return [Adyen::REST::Response] A response instance of the provided type
+      # @see execute_http_request The <tt>execute_http_request</tt> takes care
+      #   of  executing the underlying HTTP request.
+      def execute_request(request)
+        request.validate!
+        http_response = execute_http_request(request)
+        request.build_response(http_response)
+      end
+
+      protected
+
+      # Executes a HTTP request against Adyen's REST webservice.
+      # @param request [Adyen::REST::Request] The request to execute.
+      # @return [Net::HTTPResponse] The response from the server.
+      # @raise [Adyen::REST::Error] if the HTTP response code was not 200.
+      # @see #http Use the <tt>http</tt> method to set options on the underlying
+      #   <tt>Net::HTTP</tt> object, like timeouts.
+      def execute_http_request(request)
+        http_request = Net::HTTP::Post.new(request.path)
+        http_request.basic_auth(@username, @password)
+        http_request.set_form_data(request.form_data)
+
+        case response = http.request(http_request)
+        when Net::HTTPOK
+          return response
+        when Net::HTTPInternalServerError
+          raise Adyen::REST::ResponseError.new(response.body)
+        when Net::HTTPUnauthorized
+          raise Adyen::REST::Error.new("Webservice credentials are incorrect")
+        else
+          raise Adyen::REST::Error.new("Unexpected HTTP response code: #{response.code} | response body: #{response.body}")
+        end
+      end
+
+      # The endpoint URI for this client.
+      # @return [URI] The endpoint to use for the environment.
+      def endpoint
+        @endpoint ||= URI(ENDPOINT % [environment])
+      end
+
+      # @see Adyen::REST::Client#endpoint
+      ENDPOINT = 'https://pal-%s.adyen.com/'
+      private_constant :ENDPOINT
+    end
+  end
+end