buckaruby 1.3.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9964baf09c9cec43bb7f60c48391d92a6a86bd444fc8203a7bf48aab2af40fa
-  data.tar.gz: 78cfb8676c812e6aa3eece2c6e8d61236640b4dcbc57e957f522420cb3e423d5
+  metadata.gz: bbc9889fbec21efa16afde817a492b839b2c69ae3c2d442ed5a4d0f8631d27ca
+  data.tar.gz: 3e09c5226383463a8364a16dcd21f70ace68632cede58ba48bc6c9d00e67470f
 SHA512:
-  metadata.gz: 0b4790df338a409eec26bf7d8b7149f655a40a43bfe6f425ffc69e861efc5b05f91b1a61582109c279fe2db4f9ebcdb32926582b28046bfb43149ef6cdc94bf9
-  data.tar.gz: 253733f74de7c6abeecfdbb255bfc951a224466fe36d33fc9cd71329e681e7202ef8a7e172768c9d1688f49491f8040dfbda1988730d1f060084007a3d4555ef
+  metadata.gz: 3f89515b95016c1f954b9862de10c98c8a9d82027a6276307c60ae73a68075c880d36ceb560a5858acc9eafc404737cabc096c16572f09f645f8324b95194d74
+  data.tar.gz: 38a8749448b840d033f60c2698f050594f4feef63ace780122801c6fe5a2739cc3ab4a67c364358a66132b59a1233c177fa89fb28ae206c8f98b180b1fa45eae

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+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/.rubocop.yml

@@ -5,7 +5,7 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   DisplayCopNames: true
   DisplayStyleGuide: true
 
@@ -15,6 +15,17 @@ Gemspec/RequiredRubyVersion:
   Enabled: false
 
 
+Layout/LineLength:
+  Enabled: false
+
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+
 Metrics/AbcSize:
   Max: 30
 
@@ -28,9 +39,6 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 9
 
-Metrics/LineLength:
-  Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
 
@@ -52,7 +60,7 @@ RSpec/DescribedClass:
   EnforcedStyle: explicit
 
 RSpec/ExampleLength:
-  Max: 15
+  Max: 17
 
 RSpec/MultipleExpectations:
   Max: 12
@@ -77,6 +85,15 @@ Style/ExpandPathArguments:
 Style/GuardClause:
   Enabled: false
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Style/IfUnlessModifier:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,27 +1,45 @@
 # Buckaruby changelog
 
+## 1.7.0 (2021-07-16)
+
+- Add payment method Giropay.
+
+## 1.6.0 (2021-04-15)
+
+- Add Revolut to the list of iDEAL issuers.
+
+## 1.5.0 (2020-11-17)
+
+- Add payment method Sofort.
+
+## 1.4.0 (2020-04-06)
+
+- Add `payment_methods` to retrieve all payment methods enabled by Buckaroo and supported by this library.
+- Add `specify_transaction` to get a specification for setting up a transaction.
+- Fix calculating the signature for long responses and indexed fields.
+
 ## 1.3.1 (2019-12-04)
 
 - Update list of credit card transaction types.
 
 ## 1.3.0 (2019-10-08)
 
-- Added payment method American Express.
+- Add payment method American Express.
 
 ## 1.2.0 (2019-08-06)
 
-- Added support for sending custom & additional variables with the request.
+- Add support for sending custom & additional variables with the request.
 
 ## 1.1.1 (2018-11-30)
 
-- Added Handelsbanken to the list of iDEAL issuers.
+- Add Handelsbanken to the list of iDEAL issuers.
 
 ## 1.1.0 (2018-06-01)
 
-- Added payment method iDEAL processing.
-- Added Moneyou to the list of iDEAL issuers.
-- Implemented refund transaction.
-- Implemented cancel transaction.
+- Add payment method iDEAL processing.
+- Add Moneyou to the list of iDEAL issuers.
+- Implement refund transaction.
+- Implement cancel transaction.
 
 ## 1.0.2 (2017-08-25)
 

data/Gemfile

@@ -6,7 +6,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rubocop', '~> 0.77.0'
-  gem 'rubocop-performance', '~> 1.5.1'
-  gem 'rubocop-rspec', '~> 1.37.0'
+  gem 'rubocop', '~> 0.81.0'
+  gem 'rubocop-performance', '~> 1.5.2'
+  gem 'rubocop-rspec', '~> 1.38.1'
 end

data/Gemfile.lock

@@ -1,52 +1,54 @@
 PATH
   remote: .
   specs:
-    buckaruby (1.3.1)
+    buckaruby (1.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     hashdiff (1.0.0)
     jaro_winkler (1.5.4)
     parallel (1.19.1)
-    parser (2.6.5.0)
+    parser (2.7.0.5)
       ast (~> 2.4.0)
-    public_suffix (3.1.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.77.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (0.81.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
-    rubocop-rspec (1.37.0)
+    rubocop-rspec (1.38.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
     webmock (2.3.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -58,11 +60,11 @@ PLATFORMS
 DEPENDENCIES
   buckaruby!
   bundler (~> 1.7)
-  rake (~> 10.0)
+  rake (~> 12.3)
   rspec (~> 3.0)
-  rubocop (~> 0.77.0)
-  rubocop-performance (~> 1.5.1)
-  rubocop-rspec (~> 1.37.0)
+  rubocop (~> 0.81.0)
+  rubocop-performance (~> 1.5.2)
+  rubocop-rspec (~> 1.38.1)
   webmock (~> 2.3)
 
 BUNDLED WITH

data/README.md

@@ -1,7 +1,7 @@
 # Buckaruby
 
 [![Gem Version](https://badge.fury.io/rb/buckaruby.svg)](https://badge.fury.io/rb/buckaruby)
-[![Build Status](https://travis-ci.org/KentaaNL/buckaruby.svg?branch=master)](https://travis-ci.org/KentaaNL/buckaruby)
+[![Build Status](https://github.com/KentaaNL/buckaruby/actions/workflows/test.yml/badge.svg)](https://github.com/KentaaNL/buckaruby/actions)
 [![Code Climate](https://codeclimate.com/github/KentaaNL/buckaruby/badges/gpa.svg)](https://codeclimate.com/github/KentaaNL/buckaruby)
 
 The Buckaruby gem provides a Ruby library for communicating with the Buckaroo Payment Engine 3.0.
@@ -51,6 +51,14 @@ gateway = Buckaruby::Gateway.new(
 
 You can override the default mode with the parameter `mode`.
 
+### Payment methods
+
+To retrieve the payment methods enabled in Buckaroo and supported by this library, you can use the method `payment_methods`. This method will return an array with all payment methods that can be used. See also `Buckaruby::PaymentMethod` for predefined constants.
+
+```ruby
+payment_methods = gateway.payment_methods
+```
+
 ### Start transaction
 
 To start a new transaction, use the method `setup_transaction`:
@@ -203,6 +211,18 @@ puts response.custom[:foo]
 puts response.additional[:myreference]
 ````
 
+### Transaction request specification
+
+To retrieve a specification about what needs to be sent with transaction request, you can use the method `specify_transaction`. The parameter `payment_method` is optional. When supplied it will only send the specification for that payment method.
+
+This request is also used by the `payment_methods` method to determine which services (payment methods) are enabled in Buckaroo.
+
+```ruby
+response = gateway.specify_transaction(payment_method: Buckaruby::PaymentMethod::IDEAL)
+```
+
+See `Buckaruby::TransactionSpecificationResponse` for more details.
+
 ### Error handling
 
 When missing or invalid parameters are passed to any method, an `ArgumentError` will be raised.

data/buckaruby.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 2.3"
 end

data/lib/buckaruby.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'buckaruby/support/case_insensitive_hash'
-
 require_relative 'buckaruby/action'
 require_relative 'buckaruby/currency'
 require_relative 'buckaruby/ideal'
@@ -13,6 +11,7 @@ require_relative 'buckaruby/transaction_type'
 
 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'

data/lib/buckaruby/field_mapper.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'support/case_insensitive_hash'
+
+module Buckaruby
+  # Map NVP fields to hashes and multiple values (with index) to arrays.
+  module FieldMapper
+    module_function
+
+    def map_fields(params, prefix)
+      results = []
+      index = 1
+
+      loop do
+        index_key = "#{prefix}_#{index}_" # brq_services_1_
+        index_length = index_key.split(/_[0-9]*_/).length # 1
+
+        # Get all fields starting with prefix and index.
+        fields = params.select { |key| key.to_s.start_with?(index_key) }
+
+        break if fields.empty?
+
+        result = Support::CaseInsensitiveHash.new
+
+        fields.each do |key, value|
+          splitted_key = key.to_s.split(/_[0-9]*_/) # ["brq_services", "name"]
+          key_length = splitted_key.length # 2
+          new_key = splitted_key[index_length] # name
+
+          if key_length == index_length + 1
+            # Add normal fields to the result.
+            result[new_key] = value
+          else
+            # Recursively map indexed fields.
+            result[new_key] ||= begin
+              new_prefix = [index_key, new_key].join
+              map_fields(fields, new_prefix)
+            end
+          end
+        end
+
+        break if result.empty?
+
+        results << result
+
+        index += 1
+      end
+
+      results
+    end
+  end
+end

data/lib/buckaruby/gateway.rb

@@ -17,7 +17,21 @@ module Buckaruby
       @logger = config.logger
     end
 
-    # Get a list with payment issuers.
+    # Returns the payment methods enabled by Buckaroo and supported by this library.
+    def payment_methods
+      valid_payment_methods = [
+        PaymentMethod::IDEAL, PaymentMethod::IDEAL_PROCESSING, PaymentMethod::VISA, PaymentMethod::MASTER_CARD,
+        PaymentMethod::MAESTRO, PaymentMethod::AMERICAN_EXPRESS, PaymentMethod::SEPA_DIRECT_DEBIT,
+        PaymentMethod::PAYPAL, PaymentMethod::BANCONTACT_MISTER_CASH, PaymentMethod::SOFORT
+      ]
+
+      response = execute_request(:specify_transaction)
+      services = response.services.map { |service| service[:name] }
+
+      services & valid_payment_methods
+    end
+
+    # Get a list with payment issuers (currently only iDEAL).
     def issuers(payment_method)
       if payment_method != PaymentMethod::IDEAL && payment_method != PaymentMethod::IDEAL_PROCESSING
         raise ArgumentError, "Invalid payment method, only iDEAL is supported."
@@ -46,6 +60,13 @@ module Buckaruby
       execute_request(:recurrent_transaction, options)
     end
 
+    # Retrieve the specification for setting up a transaction.
+    def specify_transaction(options = {})
+      @logger.debug("[specify_transaction] options=#{options.inspect}")
+
+      execute_request(:specify_transaction, options)
+    end
+
     # Checks if a transaction is refundable.
     def refundable?(options = {})
       @logger.debug("[refundable?] options=#{options.inspect}")
@@ -150,8 +171,9 @@ module Buckaruby
       validate_amount!(options)
 
       valid_payment_methods = [
-        PaymentMethod::IDEAL, PaymentMethod::IDEAL_PROCESSING, PaymentMethod::VISA, PaymentMethod::MASTER_CARD, PaymentMethod::MAESTRO,
-        PaymentMethod::AMERICAN_EXPRESS, PaymentMethod::SEPA_DIRECT_DEBIT, PaymentMethod::PAYPAL, PaymentMethod::BANCONTACT_MISTER_CASH
+        PaymentMethod::IDEAL, PaymentMethod::IDEAL_PROCESSING, PaymentMethod::VISA, PaymentMethod::MASTER_CARD,
+        PaymentMethod::MAESTRO, PaymentMethod::AMERICAN_EXPRESS, PaymentMethod::SEPA_DIRECT_DEBIT,
+        PaymentMethod::PAYPAL, PaymentMethod::BANCONTACT_MISTER_CASH, PaymentMethod::SOFORT, PaymentMethod::GIROPAY
       ]
       validate_payment_method!(options, valid_payment_methods)
 
@@ -223,7 +245,7 @@ module Buckaruby
     end
 
     # Build and execute a request.
-    def execute_request(request_type, options)
+    def execute_request(request_type, options = {})
       request = build_request(request_type)
       response = request.execute(options)
 
@@ -232,6 +254,8 @@ module Buckaruby
         SetupTransactionResponse.new(response, config)
       when :recurrent_transaction
         RecurrentTransactionResponse.new(response, config)
+      when :specify_transaction
+        TransactionSpecificationResponse.new(response, config)
       when :refund_transaction
         RefundTransactionResponse.new(response, config)
       when :refund_info
@@ -250,6 +274,8 @@ module Buckaruby
         SetupTransactionRequest.new(config)
       when :recurrent_transaction
         RecurrentTransactionRequest.new(config)
+      when :specify_transaction
+        TransactionSpecificationRequest.new(config)
       when :refund_transaction
         RefundTransactionRequest.new(config)
       when :refund_info