buckaruby 1.7.0 → 2.0.1

data/lib/buckaruby/response.rb

@@ -8,17 +8,17 @@ require 'date'
 module Buckaruby
   # Base class for any response.
   class Response
-    attr_reader :params
+    attr_reader :response
 
     def initialize(body, config)
-      @logger = config.logger
-
       @response = parse_response(body)
-      @params = Support::CaseInsensitiveHash.new(@response)
 
-      @logger.debug("[response] params: #{params.inspect}")
+      logger = config.logger
+      logger.debug("[response] params: #{params.inspect}")
+    end
 
-      verify_signature!(@response, config)
+    def params
+      @params ||= Support::CaseInsensitiveHash.new(response)
     end
 
     def status
@@ -34,7 +34,7 @@ module Buckaruby
         custom = Support::CaseInsensitiveHash.new
 
         params.each do |key, value|
-          next unless key.upcase.start_with?("CUST_")
+          next unless key.upcase.start_with?('CUST_')
 
           new_key = key.to_s[5..-1]
           custom[new_key] = value
@@ -49,7 +49,7 @@ module Buckaruby
         additional = Support::CaseInsensitiveHash.new
 
         params.each do |key, value|
-          next unless key.upcase.start_with?("ADD_")
+          next unless key.upcase.start_with?('ADD_')
 
           new_key = key.to_s[4..-1]
           additional[new_key] = value
@@ -72,25 +72,14 @@ module Buckaruby
       response
     end
 
-    def verify_signature!(response, config)
-      if params[:brq_apiresult].nil? || params[:brq_apiresult].casecmp("fail") != 0
-        sent_signature = params[:brq_signature]
-        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
+      Time.strptime(time, '%Y-%m-%d %H:%M:%S') if time
     end
   end
 
   # Base for a transaction response.
   module TransactionResponse
-    def account_bic
+    def consumer_bic
       case payment_method
       when PaymentMethod::IDEAL
         params[:brq_service_ideal_consumerbic]
@@ -101,7 +90,7 @@ module Buckaruby
       end
     end
 
-    def account_iban
+    def consumer_iban
       case payment_method
       when PaymentMethod::IDEAL
         params[:brq_service_ideal_consumeriban]
@@ -112,7 +101,7 @@ module Buckaruby
       end
     end
 
-    def account_name
+    def consumer_name
       case payment_method
       when PaymentMethod::IDEAL
         params[:brq_service_ideal_consumername] || params[:brq_customer_name]
@@ -147,86 +136,77 @@ module Buckaruby
       parse_payment_method(params[:brq_payment_method] || params[:brq_transaction_method])
     end
 
-    def redirect_url
-      params[:brq_redirecturl]
-    end
-
-    def refund_transaction_id
-      params[:brq_relatedtransaction_refund]
-    end
-
-    def reversal_transaction_id
-      params[:brq_relatedtransaction_reversal]
-    end
-
     def transaction_id
       params[:brq_transactions]
     end
 
-    def transaction_type
-      TransactionType.parse(params[:brq_transaction_type], params[:brq_recurring])
-    end
-
     def transaction_status
       status
     end
 
-    def to_h
-      hash = {
-        account_bic: account_bic,
-        account_iban: account_iban,
-        account_name: account_name,
-        collect_date: collect_date,
-        invoicenumber: invoicenumber,
-        mandate_reference: mandate_reference,
-        payment_id: payment_id,
-        payment_method: payment_method,
-        refund_transaction_id: refund_transaction_id,
-        reversal_transaction_id: reversal_transaction_id,
-        timestamp: timestamp,
-        transaction_id: transaction_id,
-        transaction_type: transaction_type,
-        transaction_status: transaction_status
-      }.reject { |_key, value| value.nil? }
-
-      hash
+    def transaction_type
+      TransactionType.parse(params[:brq_transaction_type], params[:brq_recurring])
     end
 
     private
 
     def parse_date(date)
-      date ? Date.strptime(date, '%Y-%m-%d') : nil
+      Date.strptime(date, '%Y-%m-%d') if date
     end
 
     def parse_payment_method(method)
-      method ? method.downcase : nil
+      method&.downcase
     end
   end
 
   # Base class for a response via the API.
   class ApiResponse < Response
-    def initialize(response, config)
-      super(response, config)
+    def initialize(body, config)
+      super(body, config)
 
-      if params[:brq_apiresult].nil? || params[:brq_apiresult].casecmp("fail").zero?
+      if api_result.nil? || api_result.casecmp('fail').zero?
         raise ApiException, params
       end
+
+      Signature.verify!(config, response)
+    end
+
+    private
+
+    def api_result
+      params[:brq_apiresult]
     end
   end
 
   # Response when creating a new transaction.
   class SetupTransactionResponse < ApiResponse
     include TransactionResponse
+
+    def redirect_url
+      params[:brq_redirecturl]
+    end
   end
 
   # Response when creating a recurrent transaction.
   class RecurrentTransactionResponse < ApiResponse
     include TransactionResponse
+
+    def transaction_type
+      TransactionType::PAYMENT_RECURRENT
+    end
   end
 
   # Response when creating a refund transaction.
   class RefundTransactionResponse < ApiResponse
     include TransactionResponse
+
+    def refunded_transaction_id
+      params[:brq_relatedtransaction_refund]
+    end
+
+    def transaction_type
+      TransactionType::REFUND
+    end
   end
 
   # Response when retrieving the refund information.
@@ -236,7 +216,7 @@ module Buckaruby
     end
 
     def refundable?
-      !params[:brq_refundinfo_1_isrefundable].nil? && params[:brq_refundinfo_1_isrefundable].casecmp("true").zero?
+      !params[:brq_refundinfo_1_isrefundable].nil? && params[:brq_refundinfo_1_isrefundable].casecmp('true').zero?
     end
 
     def maximum_amount
@@ -257,7 +237,15 @@ module Buckaruby
     include TransactionResponse
 
     def cancellable?
-      !params[:brq_transaction_cancelable].nil? && params[:brq_transaction_cancelable].casecmp("true").zero?
+      !params[:brq_transaction_cancelable].nil? && params[:brq_transaction_cancelable].casecmp('true').zero?
+    end
+
+    def refunded_transaction_id
+      params[:brq_relatedtransaction_refund]
+    end
+
+    def reversed_transaction_id
+      params[:brq_relatedtransaction_reversal]
     end
   end
 
@@ -265,9 +253,23 @@ module Buckaruby
   class CancelResponse < ApiResponse
   end
 
-  # Response when verifying the Buckaroo callback.
-  class CallbackResponse < Response
+  # Response when verifying the push response.
+  class PushResponse < Response
     include TransactionResponse
+
+    def initialize(body, config)
+      super(body, config)
+
+      Signature.verify!(config, response)
+    end
+
+    def refunded_transaction_id
+      params[:brq_relatedtransaction_refund]
+    end
+
+    def reversed_transaction_id
+      params[:brq_relatedtransaction_reversal]
+    end
   end
 
   # Response when retrieving the specification for a transaction.

data/lib/buckaruby/signature.rb

@@ -8,21 +8,23 @@ module Buckaruby
   module Signature
     module_function
 
-    def generate_signature(params, config)
+    def generate(config, params)
+      string = generate_params_string(config.secret, params)
+
       case config.hash_method
       when :sha1
-        Digest::SHA1.hexdigest(generate_signature_string(params, config.secret))
+        Digest::SHA1.hexdigest(string)
       when :sha256
-        Digest::SHA256.hexdigest(generate_signature_string(params, config.secret))
+        Digest::SHA256.hexdigest(string)
       when :sha512
-        Digest::SHA512.hexdigest(generate_signature_string(params, config.secret))
+        Digest::SHA512.hexdigest(string)
       else
         raise ArgumentError, "Invalid hash method provided: #{config.hash_method}"
       end
     end
 
-    def generate_signature_string(params, secret)
-      sign_params = params.select { |key, _value| key.to_s.upcase.start_with?("BRQ_", "ADD_", "CUST_") && key.to_s.casecmp("BRQ_SIGNATURE").nonzero? }
+    def generate_params_string(secret, params)
+      sign_params = params.select { |key, _value| key.to_s.upcase.start_with?('BRQ_', 'ADD_', 'CUST_') && key.to_s.casecmp('BRQ_SIGNATURE').nonzero? }
       sign_params = order_signature_params(sign_params)
 
       string = sign_params.map { |param| "#{param[0]}=#{param[1]}" }.join
@@ -36,12 +38,29 @@ module Buckaruby
     #   that is identical to the beginning of a longer string, comes before the longer string.
     #   Take for example the following, comma separated, list which has been sorted:
     #     a_a, a0, a0a, a1a, aaA, aab, aba, aCa
-    CHAR_ORDER = "_01234567890abcdefghijklmnopqrstuvwxyz"
+    CHAR_ORDER = '_01234567890abcdefghijklmnopqrstuvwxyz'
 
     def order_signature_params(params)
       params.sort_by do |key, _value|
         key.to_s.downcase.each_char.map { |c| CHAR_ORDER.index(c) }
       end
     end
+
+    # Check the signature from the Buckaroo response with our generated signature.
+    def verify!(config, params)
+      sent_signature = params.find { |key, _value| key.to_s.casecmp('BRQ_SIGNATURE').zero? }&.last
+      generated_signature = Signature.generate(config, params)
+
+      if sent_signature.nil? || generated_signature.nil? || !safe_equals?(sent_signature, generated_signature)
+        raise SignatureException.new(sent_signature, generated_signature)
+      end
+    end
+
+    # Constant time string comparison.
+    def safe_equals?(signature, other_signature)
+      check = signature.bytesize ^ other_signature.bytesize
+      signature.bytes.zip(other_signature.bytes) { |x, y| check |= x ^ y.to_i }
+      check.zero?
+    end
   end
 end

data/lib/buckaruby/transaction_type.rb

@@ -23,22 +23,24 @@ module Buckaruby
              'C001',                                          # Transfer
 
              'C044', 'C192', 'C283', 'C293', 'C318', 'C345',
-             'C880', 'C963', 'V002', 'V032', 'V038', 'V044',
+             'C801', 'C802', 'C880', 'C963', 'V002', 'V032',
+             'V038', 'V044',
              'V192', 'V283', 'V293', 'V313', 'V318', 'V345',
              'V696',                                          # Visa
 
              'C043', 'C089', 'C273', 'C303', 'C328', 'C355',
-             'C876', 'C969', 'V001', 'V031', 'V037', 'V043',
-             'V089', 'V273', 'V303', 'V328', 'V355', 'V702',  # MasterCard
+             'C806', 'C807', 'C876', 'C969', 'V001', 'V031',
+             'V037', 'V043', 'V089', 'V273', 'V303', 'V328',
+             'V355', 'V702',                                  # MasterCard
 
-             'C046', 'C251', 'C288', 'C308', 'C333', 'C872',
-             'C972', 'V034', 'V040', 'V046', 'V094', 'V245',
-             'V288', 'V308', 'V333', 'V705',                  # Maestro
+             'C046', 'C251', 'C288', 'C308', 'C333', 'C811',
+             'C812', 'C872', 'C972', 'V034', 'V040', 'V046',
+             'V094', 'V245', 'V288', 'V308', 'V333', 'V705',  # Maestro
 
              'V003', 'V030', 'V036', 'V042'                   # American Express
 
           # Check the recurring flag to detect a normal or recurring transaction.
-          if brq_recurring && brq_recurring.casecmp("true").zero?
+          if brq_recurring&.casecmp('true')&.zero?
             TransactionType::PAYMENT_RECURRENT
           else
             TransactionType::PAYMENT
@@ -52,17 +54,18 @@ module Buckaruby
              'C101',                                          # Transfer
 
              'C080', 'C194', 'C281', 'C290', 'C315', 'C342',
-             'C881', 'C961', 'V068', 'V074', 'V080', 'V102',
-             'V194', 'V281', 'V290', 'V315', 'V342', 'V694',  # Visa
+             'C803', 'C881', 'C961', 'V068', 'V074', 'V080',
+             'V102', 'V194', 'V281', 'V290', 'V315', 'V342',
+             'V694',                                          # Visa
 
              'C079', 'C197', 'C300', 'C325', 'C352', 'C371',
-             'C877', 'C967', 'V067', 'V073', 'V079', 'V101',
-             'V149', 'V197', 'V300', 'V325', 'V352', 'V371',
-             'V700',                                          # MasterCard
+             'C808', 'C877', 'C967', 'V067', 'V073', 'V079',
+             'V101', 'V149', 'V197', 'V300', 'V325', 'V352',
+             'V371', 'V700',                                  # MasterCard
 
-             'C082', 'C252', 'C286', 'C305', 'C330', 'C873',
-             'C970', 'V070', 'V076', 'V082', 'V246', 'V286',
-             'V305', 'V330', 'V703',                          # Maestro
+             'C082', 'C252', 'C286', 'C305', 'C330', 'C813',
+             'C873', 'C970', 'V070', 'V076', 'V082', 'V246',
+             'V286', 'V305', 'V330', 'V703',                  # Maestro
 
              'V066', 'V072', 'V078', 'V103'                   # American Express
           TransactionType::REFUND
@@ -70,14 +73,14 @@ module Buckaruby
              'V111',                                          # PayPal
              'C544',                                          # Sofort
 
-             'C554', 'C593', 'C882', 'V132', 'V138', 'V144',
-             'V544', 'V592',                                  # Visa
+             'C554', 'C593', 'C804', 'C882', 'V132', 'V138',
+             'V144', 'V544', 'V592',                          # Visa
 
-             'C553', 'C589', 'C878', 'V131', 'V137', 'V143',
-             'V543', 'V589',                                  # MasterCard
+             'C553', 'C589', 'C809', 'C878', 'V131', 'V137',
+             'V143', 'V543', 'V589',                          # MasterCard
 
-             'C546', 'C551', 'C874', 'V134', 'V140', 'V146',
-             'V545', 'V546',                                  # Maestro
+             'C546', 'C551', 'C814', 'C874', 'V134', 'V140',
+             'V146', 'V545', 'V546',                          # Maestro
 
              'V130', 'V136', 'V142'                           # American Express
           TransactionType::REVERSAL

data/lib/buckaruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Buckaruby
-  VERSION = "1.7.0"
+  VERSION = '2.0.1'
 end

data/lib/buckaruby.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative 'buckaruby/action'
+require_relative 'buckaruby/amount'
 require_relative 'buckaruby/currency'
-require_relative 'buckaruby/ideal'
 require_relative 'buckaruby/language'
 require_relative 'buckaruby/operation'
 require_relative 'buckaruby/payment_method'
@@ -13,7 +13,6 @@ require_relative 'buckaruby/configuration'
 require_relative 'buckaruby/exception'
 require_relative 'buckaruby/field_mapper'
 require_relative 'buckaruby/gateway'
-require_relative 'buckaruby/iban'
 require_relative 'buckaruby/request'
 require_relative 'buckaruby/response'
 require_relative 'buckaruby/signature'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buckaruby
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Kentaa
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,41 +58,33 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.0'
 description: The Buckaruby gem provides a Ruby library for communicating with the
   Buckaroo Payment Engine 3.0.
 email:
-- support@kentaa.nl
+- developers@kentaa.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- buckaruby.gemspec
 - lib/buckaruby.rb
 - lib/buckaruby/action.rb
+- lib/buckaruby/amount.rb
 - lib/buckaruby/configuration.rb
 - lib/buckaruby/currency.rb
 - lib/buckaruby/exception.rb
 - lib/buckaruby/field_mapper.rb
 - lib/buckaruby/gateway.rb
-- lib/buckaruby/iban.rb
-- lib/buckaruby/ideal.rb
 - lib/buckaruby/language.rb
 - lib/buckaruby/operation.rb
 - lib/buckaruby/payment_method.rb
@@ -103,47 +95,11 @@ files:
 - lib/buckaruby/transaction_status.rb
 - lib/buckaruby/transaction_type.rb
 - lib/buckaruby/version.rb
-- spec/buckaruby/configuration_spec.rb
-- spec/buckaruby/field_mapper_spec.rb
-- spec/buckaruby/gateway_spec.rb
-- spec/buckaruby/iban_spec.rb
-- spec/buckaruby/signature_spec.rb
-- spec/buckaruby/support/case_insensitive_hash_spec.rb
-- spec/fixtures/responses/callback_invalid_signature.txt
-- spec/fixtures/responses/callback_payment_amex.txt
-- spec/fixtures/responses/callback_payment_cancelled.txt
-- spec/fixtures/responses/callback_payment_empty_transaction_type.txt
-- spec/fixtures/responses/callback_payment_failed.txt
-- spec/fixtures/responses/callback_payment_giropay.txt
-- spec/fixtures/responses/callback_payment_pending.txt
-- spec/fixtures/responses/callback_payment_rejected.txt
-- spec/fixtures/responses/callback_payment_sepa.txt
-- spec/fixtures/responses/callback_payment_sofort.txt
-- spec/fixtures/responses/callback_payment_success.txt
-- spec/fixtures/responses/callback_payment_visa.txt
-- spec/fixtures/responses/callback_recurrent_sepa.txt
-- spec/fixtures/responses/callback_recurrent_visa.txt
-- spec/fixtures/responses/callback_refund_amex.txt
-- spec/fixtures/responses/callback_refund_ideal.txt
-- spec/fixtures/responses/callback_refund_paypal.txt
-- spec/fixtures/responses/callback_reversal_paypal.txt
-- spec/fixtures/responses/callback_reversal_sepa.txt
-- spec/fixtures/responses/callback_valid_signature.txt
-- spec/fixtures/responses/cancel_success.txt
-- spec/fixtures/responses/recurrent_transaction_success.txt
-- spec/fixtures/responses/refund_info_error.txt
-- spec/fixtures/responses/refund_info_success.txt
-- spec/fixtures/responses/refund_transaction_success.txt
-- spec/fixtures/responses/setup_transaction_success.txt
-- spec/fixtures/responses/specify_transaction_success.txt
-- spec/fixtures/responses/status_cancellable.txt
-- spec/fixtures/responses/status_noncancellable.txt
-- spec/fixtures/responses/status_success.txt
-- spec/spec_helper.rb
 homepage: https://github.com/KentaaNL/buckaruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -152,52 +108,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby library for communicating with the Buckaroo Payment Engine 3.0.
-test_files:
-- spec/buckaruby/configuration_spec.rb
-- spec/buckaruby/field_mapper_spec.rb
-- spec/buckaruby/gateway_spec.rb
-- spec/buckaruby/iban_spec.rb
-- spec/buckaruby/signature_spec.rb
-- spec/buckaruby/support/case_insensitive_hash_spec.rb
-- spec/fixtures/responses/callback_invalid_signature.txt
-- spec/fixtures/responses/callback_payment_amex.txt
-- spec/fixtures/responses/callback_payment_cancelled.txt
-- spec/fixtures/responses/callback_payment_empty_transaction_type.txt
-- spec/fixtures/responses/callback_payment_failed.txt
-- spec/fixtures/responses/callback_payment_giropay.txt
-- spec/fixtures/responses/callback_payment_pending.txt
-- spec/fixtures/responses/callback_payment_rejected.txt
-- spec/fixtures/responses/callback_payment_sepa.txt
-- spec/fixtures/responses/callback_payment_sofort.txt
-- spec/fixtures/responses/callback_payment_success.txt
-- spec/fixtures/responses/callback_payment_visa.txt
-- spec/fixtures/responses/callback_recurrent_sepa.txt
-- spec/fixtures/responses/callback_recurrent_visa.txt
-- spec/fixtures/responses/callback_refund_amex.txt
-- spec/fixtures/responses/callback_refund_ideal.txt
-- spec/fixtures/responses/callback_refund_paypal.txt
-- spec/fixtures/responses/callback_reversal_paypal.txt
-- spec/fixtures/responses/callback_reversal_sepa.txt
-- spec/fixtures/responses/callback_valid_signature.txt
-- spec/fixtures/responses/cancel_success.txt
-- spec/fixtures/responses/recurrent_transaction_success.txt
-- spec/fixtures/responses/refund_info_error.txt
-- spec/fixtures/responses/refund_info_success.txt
-- spec/fixtures/responses/refund_transaction_success.txt
-- spec/fixtures/responses/setup_transaction_success.txt
-- spec/fixtures/responses/specify_transaction_success.txt
-- spec/fixtures/responses/status_cancellable.txt
-- spec/fixtures/responses/status_noncancellable.txt
-- spec/fixtures/responses/status_success.txt
-- spec/spec_helper.rb
+test_files: []

data/.github/workflows/test.yml

@@ -1,23 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - 1.x
-  pull_request:
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0']
-
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run tests
-      run: bundle exec rake

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.rvmrc
-.ruby-version
-.ruby-gemset
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp