buckaruby 1.1.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46d2621253829070076f927150389b8dcf796576689e6b3a623a87777c31ddde
-  data.tar.gz: 73bf6810bb4b140331c5cebd8c5635daff496579e0950a495f2192fd5299914f
+  metadata.gz: '0919fe881e55079692ccd64dc45cae08ce54073ec33e2176b0bbfada27a333de'
+  data.tar.gz: b4b3a163d7365c76191d6b7988d82a40f50686adb318dac85f37f2baca9cae10
 SHA512:
-  metadata.gz: dacaf86700c9f959c9b888e4fa428d00eecc828aa20ea778973c507b9891d94c292243d3ff6dea9823dc48016549748257fa6888e1f64195ae836b6f975f471b
-  data.tar.gz: b07ac9a4d3295111ab5ecf80d3edfe294cb81e2bff867b44ef677c9608b9c448de33afff04e18c5d9500f29f24c4feec7193e46d9d13f385fa7ad3bbcae16eb1
+  metadata.gz: f9d4e71c901fccf8fcedc932e1c7c7e0086dffad4d6611dfc45343a0b62f5ce9c2f8bff764654be3e56006baccb78225fb97e03b1bb53c86b5f1bb1bc7839120
+  data.tar.gz: 5a54bc947866b1973a72023dcf3092850df0d9379b03eda9a3f5e4922f93418cae8be615f03d66804c9a6ea554bb110164ca59d7a57dd549b9705b1335e30b48

data/.gitignore

@@ -6,7 +6,6 @@
 .rvmrc
 .ruby-version
 .ruby-gemset
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/.rubocop.yml

@@ -1,14 +1,31 @@
 # Buckaruby RuboCop configuration
 
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 2.3
   DisplayCopNames: true
   DisplayStyleGuide: true
 
+
 # We target 2.3, but still want to support 2.0.
 Gemspec/RequiredRubyVersion:
   Enabled: false
 
+
+Layout/LineLength:
+  Enabled: false
+
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+
 Metrics/AbcSize:
   Max: 30
 
@@ -22,9 +39,6 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 9
 
-Metrics/LineLength:
-  Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
 
@@ -34,12 +48,30 @@ Metrics/ModuleLength:
 Metrics/PerceivedComplexity:
   Max: 9
 
+
 Naming/AccessorMethodName:
   Enabled: false
 
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 
+
+RSpec/DescribedClass:
+  EnforcedStyle: explicit
+
+RSpec/ExampleLength:
+  Max: 17
+
+RSpec/MultipleExpectations:
+  Max: 12
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+
 Style/BlockDelimiters:
   Exclude:
     - 'spec/**/*.rb'
@@ -53,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/.travis.yml

@@ -3,9 +3,9 @@ sudo: false
 cache: bundler
 before_install:
   - gem update --system
-  - gem install bundler
+  - gem install bundler -v '< 2'
 rvm:
-  - 2.2.10
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2

data/CHANGELOG.md

@@ -1,13 +1,37 @@
 # Buckaruby changelog
 
+## 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)
+
+- Add payment method American Express.
+
+## 1.2.0 (2019-08-06)
+
+- 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

@@ -5,4 +5,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in buckaruby.gemspec
 gemspec
 
-gem 'rubocop', '~> 0.60.0', group: :test
+group :test do
+  gem 'rubocop', '~> 0.81.0'
+  gem 'rubocop-performance', '~> 1.5.2'
+  gem 'rubocop-rspec', '~> 1.38.1'
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    buckaruby (1.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    hashdiff (1.0.0)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    public_suffix (3.1.1)
+    rainbow (3.0.0)
+    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.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.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.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    unicode-display_width (1.7.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  buckaruby!
+  bundler (~> 1.7)
+  rake (~> 12.3)
+  rspec (~> 3.0)
+  rubocop (~> 0.81.0)
+  rubocop-performance (~> 1.5.2)
+  rubocop-rspec (~> 1.38.1)
+  webmock (~> 2.3)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -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`:
@@ -170,6 +178,51 @@ response = gateway.status(transaction_id: 12345)
 
 See `Buckaruby::StatusResponse` for more details.
 
+### Merchant variables
+
+You can send custom variables and additional variables with each request.
+
+Use the parameter `custom` to build a hash with custom variables and `additional` for building a hash with additional variabeles.
+For example:
+
+```ruby
+options = {
+  amount: 10,
+  payment_method: Buckaruby::PaymentMethod::IDEAL,
+  payment_issuer: Buckaruby::Ideal::ISSUERS.keys.first,
+  invoicenumber: "12345",
+  return_url: "http://www.return.url/",
+  custom: {
+    foo: "bar",
+    quux: "42"
+  },
+  additional: {
+    myreference: "12345"
+  }
+}
+
+response = gateway.setup_transaction(options)
+```
+
+In the response, you can retrieve the custom and additional variables with the methods `custom` and `additional`:
+
+```ruby
+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 "rspec", "~> 3.5.0", ">= 3.5.0"
-  spec.add_development_dependency "webmock", "~> 2.3", ">= 2.3.2"
+  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::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
       ]
       validate_payment_method!(options, valid_payment_methods)
 
@@ -191,7 +213,7 @@ module Buckaruby
       validate_amount!(options)
 
       valid_payment_methods = [
-        PaymentMethod::VISA, PaymentMethod::MASTER_CARD, PaymentMethod::MAESTRO,
+        PaymentMethod::VISA, PaymentMethod::MASTER_CARD, PaymentMethod::MAESTRO, PaymentMethod::AMERICAN_EXPRESS,
         PaymentMethod::SEPA_DIRECT_DEBIT, PaymentMethod::PAYPAL
       ]
       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