buckaruby 1.0.2 → 1.1.0

data/lib/buckaruby/iban.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buckaruby
   # Helper for calculating the IBAN for a given account number, bank code and country code.
   class Iban

data/lib/buckaruby/ideal.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
+
 module Buckaruby
   module Ideal
     ISSUERS = {
       "ABNANL2A" => "ABN AMRO",
       "ASNBNL21" => "ASN Bank",
-      "BUNQNL2A" => "Bunq",
+      "BUNQNL2A" => "bunq",
       "INGBNL2A" => "ING",
       "KNABNL2H" => "Knab bank",
+      "MOYONL21" => "Moneyou",
       "RABONL2U" => "Rabobank",
       "RBRBNL21" => "RegioBank",
       "SNSBNL2A" => "SNS Bank",
       "TRIONL2U" => "Triodos Bank",
       "FVLBNL22" => "Van Lanschot"
-    }
+    }.freeze
   end
 end

data/lib/buckaruby/language.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buckaruby
   module Language
     DUTCH = 'nl-NL'

data/lib/buckaruby/operation.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module Buckaruby
   module Operation
     TRANSACTION_REQUEST = "TransactionRequest"
     TRANSACTION_STATUS = "TransactionStatus"
+    REFUND_INFO = "RefundInfo"
+    CANCEL_TRANSACTION = "CancelTransaction"
   end
 end

data/lib/buckaruby/payment_method.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module Buckaruby
   module PaymentMethod
-    IDEAL = "ideal"
+    IDEAL = "ideal" # iDEAL collecting
+    IDEAL_PROCESSING = "idealprocessing" # iDEAL processing
+
     SEPA_DIRECT_DEBIT = "sepadirectdebit"
     PAYPAL = "paypal"
     BANCONTACT_MISTER_CASH = "bancontactmrcash"

data/lib/buckaruby/request.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'bigdecimal'
 require 'cgi'
 require 'date'
-require 'logger'
 require 'net/http'
 require 'openssl'
 require 'uri'
@@ -9,20 +10,18 @@ require 'uri'
 module Buckaruby
   # Base class for any request.
   class Request
-    def initialize(options)
-      @options = options
-
-      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    def initialize(config)
+      @config = config
+      @logger = config.logger
     end
 
     def execute(options)
-      uri = URI.parse(api_url)
+      uri = URI.parse(@config.api_url)
       uri.query = "op=#{options[:operation]}" if options[:operation]
 
-      raw_response = post_buckaroo(uri, build_request_data(options))
-      response = parse_response(raw_response)
+      response = post_buckaroo(uri, build_request_data(options))
 
-      @logger.debug("[execute] response: #{response.inspect}")
+      # @logger.debug("[execute] response: #{response.inspect}")
 
       response
     end
@@ -46,7 +45,8 @@ module Buckaruby
         raise InvalidResponseException, raw_response
       end
 
-      return raw_response.body
+      raw_response.body
+
     # Try to catch some common exceptions Net::HTTP might raise
     rescue Errno::ETIMEDOUT, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, Errno::EHOSTUNREACH,
            IOError, SocketError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::OpenTimeout,
@@ -55,14 +55,14 @@ module Buckaruby
     end
 
     def build_request_data(options)
-      params = { brq_websitekey: @options[:website] }
+      params = { brq_websitekey: @config.website }
 
       params.merge!(build_request_params(options))
 
       params[:add_buckaruby] = "Buckaruby #{Buckaruby::VERSION}"
 
       # Sign the data with our secret key.
-      params[:brq_signature] = Signature.generate_signature(params, @options)
+      params[:brq_signature] = Signature.generate_signature(params, @config)
 
       params
     end
@@ -70,20 +70,6 @@ module Buckaruby
     def post_data(params)
       params.map { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
     end
-
-    def parse_response(body)
-      query = CGI.parse(body)
-      query.each { |key, value| query[key] = value.first }
-      query
-    end
-
-    def test?
-      @options[:mode] == :test
-    end
-
-    def api_url
-      test? ? Urls::TEST_URL : Urls::PRODUCTION_URL
-    end
   end
 
   # Base class for a transaction request.
@@ -97,7 +83,7 @@ module Buckaruby
         brq_payment_method: options[:payment_method],
         brq_culture: options[:culture] || Language::DUTCH,
         brq_currency: options[:currency] || Currency::EURO,
-        brq_amount: BigDecimal.new(options[:amount].to_s).to_s("F"),
+        brq_amount: BigDecimal(options[:amount].to_s).to_s("F"),
         brq_invoicenumber: options[:invoicenumber]
       }
 
@@ -127,6 +113,12 @@ module Buckaruby
           brq_service_ideal_issuer: options[:payment_issuer],
           brq_service_ideal_version: "2"
         )
+      when PaymentMethod::IDEAL_PROCESSING
+        params.merge!(
+          brq_service_idealprocessing_action: Action::PAY,
+          brq_service_idealprocessing_issuer: options[:payment_issuer],
+          brq_service_idealprocessing_version: "2"
+        )
       when PaymentMethod::SEPA_DIRECT_DEBIT
         params.merge!(
           brq_service_sepadirectdebit_action: Action::PAY,
@@ -175,6 +167,44 @@ module Buckaruby
     end
   end
 
+  # Request for a creating a refund.
+  class RefundTransactionRequest < Request
+    def execute(options)
+      super(options.merge(operation: Operation::TRANSACTION_REQUEST))
+    end
+
+    def build_request_params(options)
+      params = {
+        brq_payment_method: options[:payment_method],
+        brq_amount_credit: BigDecimal(options[:amount].to_s).to_s("F"),
+        brq_currency: options[:currency] || Currency::EURO,
+        brq_invoicenumber: options[:invoicenumber]
+      }
+
+      key = :"brq_service_#{options[:payment_method]}_action"
+      params[key] = Action::REFUND
+
+      params[:brq_originaltransaction] = options[:transaction_id]
+
+      params
+    end
+  end
+
+  # Request for retrieving refund information.
+  class RefundInfoRequest < Request
+    def execute(options)
+      super(options.merge(operation: Operation::REFUND_INFO))
+    end
+
+    def build_request_params(options)
+      params = {}
+
+      params[:brq_transaction] = options[:transaction_id]
+
+      params
+    end
+  end
+
   # Request for getting the status of a transaction.
   class StatusRequest < Request
     def execute(options)
@@ -190,4 +220,17 @@ module Buckaruby
       params
     end
   end
+
+  # Request for cancelling a transaction.
+  class CancelRequest < Request
+    def execute(options)
+      super(options.merge(operation: Operation::CANCEL_TRANSACTION))
+    end
+
+    def build_request_params(options)
+      params = { brq_transaction: options[:transaction_id] }
+
+      params
+    end
+  end
 end

data/lib/buckaruby/response.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'cgi'
 require 'date'
 
 module Buckaruby
@@ -5,32 +8,74 @@ module Buckaruby
   class Response
     attr_reader :params
 
-    def initialize(response, options)
-      @params = Support::CaseInsensitiveHash.new(response)
+    def initialize(body, config)
+      @logger = config.logger
+
+      @response = parse_response(body)
+      @params = Support::CaseInsensitiveHash.new(@response)
+
+      @logger.debug("[response] params: #{params.inspect}")
+
+      verify_signature!(@response, config)
+    end
+
+    def status
+      # See http://support.buckaroo.nl/index.php/Statuscodes
+      case params[:brq_statuscode]
+      when '190'
+        TransactionStatus::SUCCESS
+      when '490', '491', '492'
+        TransactionStatus::FAILED
+      when '690'
+        TransactionStatus::REJECTED
+      when '790', '791', '792', '793'
+        TransactionStatus::PENDING
+      when '890', '891'
+        TransactionStatus::CANCELLED
+      end
+    end
 
-      verify_signature!(response, options)
+    def timestamp
+      parse_time(params[:brq_timestamp])
     end
 
     private
 
-    def verify_signature!(response, options)
+    def parse_response(body)
+      if body.is_a?(Hash)
+        response = body
+      else
+        response = CGI.parse(body)
+        response.each { |key, value| response[key] = value.first }
+      end
+
+      response
+    end
+
+    def verify_signature!(response, config)
       if params[:brq_apiresult] != "Fail"
         sent_signature = params[:brq_signature]
-        generated_signature = Signature.generate_signature(response, options)
+        generated_signature = Signature.generate_signature(response, config)
 
         if sent_signature != generated_signature
           raise SignatureException.new(sent_signature, generated_signature)
         end
       end
     end
+
+    def parse_time(time)
+      time ? Time.strptime(time, '%Y-%m-%d %H:%M:%S') : nil
+    end
   end
 
-  # Base class for a transaction response.
-  class TransactionResponse < Response
+  # Base for a transaction response.
+  module TransactionResponse
     def account_bic
       case payment_method
       when PaymentMethod::IDEAL
         params[:brq_service_ideal_consumerbic]
+      when PaymentMethod::IDEAL_PROCESSING
+        params[:brq_service_idealprocessing_consumerbic]
       when PaymentMethod::SEPA_DIRECT_DEBIT
         params[:brq_service_sepadirectdebit_customerbic]
       end
@@ -40,6 +85,8 @@ module Buckaruby
       case payment_method
       when PaymentMethod::IDEAL
         params[:brq_service_ideal_consumeriban]
+      when PaymentMethod::IDEAL_PROCESSING
+        params[:brq_service_idealprocessing_consumeriban]
       when PaymentMethod::SEPA_DIRECT_DEBIT
         params[:brq_service_sepadirectdebit_customeriban]
       end
@@ -49,6 +96,8 @@ module Buckaruby
       case payment_method
       when PaymentMethod::IDEAL
         params[:brq_service_ideal_consumername] || params[:brq_customer_name]
+      when PaymentMethod::IDEAL_PROCESSING
+        params[:brq_service_idealprocessing_consumername] || params[:brq_customer_name]
       when PaymentMethod::SEPA_DIRECT_DEBIT
         params[:brq_service_sepadirectdebit_customername] || params[:brq_customer_name]
       end
@@ -90,10 +139,6 @@ module Buckaruby
       params[:brq_relatedtransaction_reversal]
     end
 
-    def timestamp
-      parse_time(params[:brq_timestamp])
-    end
-
     def transaction_id
       params[:brq_transactions]
     end
@@ -123,19 +168,7 @@ module Buckaruby
     end
 
     def transaction_status
-      # See http://support.buckaroo.nl/index.php/Statuscodes
-      case params[:brq_statuscode]
-      when '190'
-        TransactionStatus::SUCCESS
-      when '490', '491', '492'
-        TransactionStatus::FAILED
-      when '690'
-        TransactionStatus::REJECTED
-      when '790', '791', '792', '793'
-        TransactionStatus::PENDING
-      when '890', '891'
-        TransactionStatus::CANCELLED
-      end
+      status
     end
 
     def to_h
@@ -165,39 +198,75 @@ module Buckaruby
       date ? Date.strptime(date, '%Y-%m-%d') : nil
     end
 
-    def parse_time(time)
-      time ? Time.strptime(time, '%Y-%m-%d %H:%M:%S') : nil
-    end
-
     def parse_payment_method(method)
       method ? method.downcase : nil
     end
   end
 
-  # Base class for a transaction response via the API.
-  class TransactionApiResponse < TransactionResponse
-    def initialize(response, options)
-      super(response, options)
+  # Base class for a response via the API.
+  class ApiResponse < Response
+    def initialize(response, config)
+      super(response, config)
 
-      if params[:brq_apiresult].nil? || params[:brq_apiresult] == "Fail"
+      if params[:brq_apiresult].nil? || params[:brq_apiresult].casecmp("fail").zero?
         raise ApiException, params
       end
     end
   end
 
   # Response when creating a new transaction.
-  class SetupTransactionResponse < TransactionApiResponse
+  class SetupTransactionResponse < ApiResponse
+    include TransactionResponse
   end
 
   # Response when creating a recurrent transaction.
-  class RecurrentTransactionResponse < TransactionApiResponse
+  class RecurrentTransactionResponse < ApiResponse
+    include TransactionResponse
+  end
+
+  # Response when creating a refund transaction.
+  class RefundTransactionResponse < ApiResponse
+    include TransactionResponse
+  end
+
+  # Response when retrieving the refund information.
+  class RefundInfoResponse < ApiResponse
+    def payment_method
+      params[:brq_refundinfo_1_servicecode]
+    end
+
+    def refundable?
+      !params[:brq_refundinfo_1_isrefundable].nil? && params[:brq_refundinfo_1_isrefundable].casecmp("true").zero?
+    end
+
+    def maximum_amount
+      params[:brq_refundinfo_1_maximumrefundamount]
+    end
+
+    def invoicenumber
+      params[:brq_refundinfo_1_invoice]
+    end
+
+    def currency
+      params[:brq_refundinfo_1_refundcurrency]
+    end
   end
 
   # Response when getting the status of a transaction.
-  class StatusResponse < TransactionApiResponse
+  class StatusResponse < ApiResponse
+    include TransactionResponse
+
+    def cancellable?
+      !params[:brq_transaction_cancelable].nil? && params[:brq_transaction_cancelable].casecmp("true").zero?
+    end
+  end
+
+  # Response when cancelling a transaction.
+  class CancelResponse < ApiResponse
   end
 
   # Response when verifying the Buckaroo callback.
-  class CallbackResponse < TransactionResponse
+  class CallbackResponse < Response
+    include TransactionResponse
   end
 end