buckaruby 1.7.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbc9889fbec21efa16afde817a492b839b2c69ae3c2d442ed5a4d0f8631d27ca
-  data.tar.gz: 3e09c5226383463a8364a16dcd21f70ace68632cede58ba48bc6c9d00e67470f
+  metadata.gz: eaefc0e467387241658fea872018f395d2e0cebdd467ea855f8754972f1d22b3
+  data.tar.gz: 7fa06dbb6978cbbd359a3ebcb7d2908e6d4394cc5b35f397ad25d39b1aff2775
 SHA512:
-  metadata.gz: 3f89515b95016c1f954b9862de10c98c8a9d82027a6276307c60ae73a68075c880d36ceb560a5858acc9eafc404737cabc096c16572f09f645f8324b95194d74
-  data.tar.gz: 38a8749448b840d033f60c2698f050594f4feef63ace780122801c6fe5a2739cc3ab4a67c364358a66132b59a1233c177fa89fb28ae206c8f98b180b1fa45eae
+  metadata.gz: c77704f6cf7b7b405191800d1d78001ab43f4c51f6ef3f881272db39308315256a92bc9dcb7cd7e5ae755123dc13d0008b77a6eca35590625a7190268564839d
+  data.tar.gz: 9b5c9573fea56fd98b3be526eabeee80d883d2dbd25886a0ee568e919e6af34e64a34d938f3a4440032fb996ff6e4a96eea2136e6f48809a2d02288442a10ad5

data/CHANGELOG.md

@@ -1,57 +1,5 @@
 # Buckaruby changelog
 
-## 1.7.0 (2021-07-16)
+We use [GitHub releases](https://github.com/KentaaNL/buckaruby/releases) for the CHANGELOG since version 2.0 of this gem.
 
-- 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)
-
-- 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)
-
-- Add Handelsbanken to the list of iDEAL issuers.
-
-## 1.1.0 (2018-06-01)
-
-- 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)
-
-- Recognize credit card transactions via Atos.
-- Fix detection of recurrent payments.
-- Minor improvements to exception handling.
-
-## 1.0.1 (2017-01-05)
-
-- Recognize status codes 792 & 793 as a pending transaction.
-- For SEPA Direct Debit, make the collect date configurable and let Buckaroo determine the default.
-
-## 1.0.0 (2016-11-24)
-
-- First public release.
+Check the 1.x branch for previous changes: https://github.com/KentaaNL/buckaruby/blob/1.x/CHANGELOG.md

data/README.md

@@ -6,6 +6,26 @@
 
 The Buckaruby gem provides a Ruby library for communicating with the Buckaroo Payment Engine 3.0.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Payment methods](#payment-methods)
+  - [Get issuers](#get-issuers)
+  - [Start transaction](#start-transaction)
+  - [Recurrent transaction](#recurrent-transaction)
+  - [Refund transaction](#refund-transaction)
+  - [Cancel transaction](#cancel-transaction)
+  - [Push response](#push-response)
+  - [Get status](#get-status)
+  - [Merchant variables](#merchant-variables)
+  - [Transaction request specification](#transaction-request-specification)
+  - [Error handling](#error-handling)
+- [Example](#example)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,14 +42,6 @@ Or install it yourself as:
 
 ## Usage
 
-Configure Buckaruby to use it in test or production (live) mode:
-
-```ruby
-Buckaruby::Gateway.mode = :production  # defaults to :test
-```
-
-### Initialization
-
 Create the gateway and configure it using your Buckaroo website key and secret key:
 
 ```ruby
@@ -49,7 +61,15 @@ gateway = Buckaruby::Gateway.new(
 )
 ```
 
-You can override the default mode with the parameter `mode`.
+The gateway is created for the live environment by default. If you want to use the testing environment, then add `test: true`:
+
+```ruby
+gateway = Buckaruby::Gateway.new(
+  website: "123456789",
+  secret: "abcdef1234567890",
+  test: true                  # use the testing environment; default is false
+)
+```
 
 ### Payment methods
 
@@ -59,6 +79,14 @@ To retrieve the payment methods enabled in Buckaroo and supported by this librar
 payment_methods = gateway.payment_methods
 ```
 
+### Get issuers
+
+When using iDEAL as payment method, it is mandatory to send the `issuer` parameter in the start transaction request. You can retrieve the list of available issuers with the method `issuers`. This will return a hash with the ID of the issuer (hash key) and the issuer name (hash value).
+
+```ruby
+issuers = gateway.issuers(Buckaruby::PaymentMethod::IDEAL)
+```
+
 ### Start transaction
 
 To start a new transaction, use the method `setup_transaction`:
@@ -67,7 +95,7 @@ To start a new transaction, use the method `setup_transaction`:
 options = {
   amount: 10,
   payment_method: Buckaruby::PaymentMethod::IDEAL,
-  payment_issuer: Buckaruby::Ideal::ISSUERS.keys.first,
+  issuer: "INGBNL2A",
   invoicenumber: "12345",
   return_url: "http://www.return.url/"
 }
@@ -123,7 +151,7 @@ For some transactions it's possible to do a refund: Buckaroo creates a new "reve
 First check if the transaction is refundable, with the parameter `transaction_id` set to the original transaction ID:
 
 ```ruby
-response = gateway.refundable?(transaction_id: "abcdefg")
+response = gateway.refundable_transaction?(transaction_id: "abcdefg")
 ```
 
 If the reponse is positive then you can refund the transaction with:
@@ -142,10 +170,10 @@ See `Buckaruby::RefundTransactionResponse` for more details.
 
 Sometimes a transaction can be cancelled, for example a SEPA Direct Debit transaction before it has been offered to the bank.
 
-You can check if the transaction is cancellable, by using the method `cancellable?` with the parameter `transaction_id`:
+You can check if the transaction is cancellable, by using the method `cancellable_transaction?` with the parameter `transaction_id`:
 
 ```ruby
-response = gateway.cancellable?(transaction_id: "abcdefg")
+response = gateway.cancellable_transaction?(transaction_id: "abcdefg")
 ```
 
 If the response is positive then you can cancel the transaction with:
@@ -160,13 +188,15 @@ If you try to cancel a transaction that's not cancellable, then a `Buckaruby::No
 
 ### Push response
 
-Buckaroo can be configured to send push notifications for transactions. You can use the method `callback` to verify and parse the push response:
+Buckaroo can be configured to send push notifications for transactions. You can use the method `parse_push` to verify and parse the push response:
 
 ```ruby
-response = gateway.callback(params)
+response = gateway.parse_push(params)
 ```
 
-See `Buckaruby::CallbackResponse` for more details.
+This method can also be used to parse the post data on the return page.
+
+See `Buckaruby::PushResponse` for more details.
 
 ### Get status
 
@@ -189,7 +219,7 @@ For example:
 options = {
   amount: 10,
   payment_method: Buckaruby::PaymentMethod::IDEAL,
-  payment_issuer: Buckaruby::Ideal::ISSUERS.keys.first,
+  issuer: "INGBNL2A",
   invoicenumber: "12345",
   return_url: "http://www.return.url/",
   custom: {
@@ -209,7 +239,7 @@ In the response, you can retrieve the custom and additional variables with the m
 ```ruby
 puts response.custom[:foo]
 puts response.additional[:myreference]
-````
+```
 
 ### Transaction request specification
 
@@ -241,6 +271,12 @@ All Buckaruby exceptions listed here inherit from the class `Buckaruby::Buckaroo
 
 For a complete and working example project check out [Buckaruby PoC](https://github.com/KentaaNL/buckaruby-poc).
 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/KentaaNL/buckaruby.

data/lib/buckaruby/action.rb

@@ -2,9 +2,9 @@
 
 module Buckaruby
   module Action
-    PAY = "Pay"
-    PAY_RECURRENT = "PayRecurrent"
-    REFUND = "Refund"
-    EXTRA_INFO = "ExtraInfo"
+    PAY = 'Pay'
+    PAY_RECURRENT = 'PayRecurrent'
+    REFUND = 'Refund'
+    EXTRA_INFO = 'ExtraInfo'
   end
 end

data/lib/buckaruby/amount.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module Buckaruby
+  # Helper for converting/formatting amounts.
+  class Amount
+    def initialize(amount)
+      @amount = BigDecimal(amount.to_s)
+    end
+
+    def positive?
+      @amount.positive?
+    end
+
+    def to_d
+      @amount
+    end
+
+    # Convert the amount to a String with 2 decimals.
+    def to_s
+      format('%.2f', @amount)
+    end
+  end
+end

data/lib/buckaruby/configuration.rb

@@ -5,69 +5,64 @@ require 'logger'
 module Buckaruby
   # Configuration settings for the Buckaruby Gateway.
   class Configuration
-    TEST_URL = "https://testcheckout.buckaroo.nl/nvp/"
-    PRODUCTION_URL = "https://checkout.buckaroo.nl/nvp/"
-
-    attr_reader :website, :secret, :mode, :hash_method, :logger
+    TEST_URL = 'https://testcheckout.buckaroo.nl/nvp/'
+    LIVE_URL = 'https://checkout.buckaroo.nl/nvp/'
 
     def initialize(options)
-      set_website(options)
-      set_secret(options)
-      set_buckaroo_mode(options)
-      set_hash_method(options)
-      set_logger(options)
+      @options = options
     end
 
     def test?
-      @mode == :test
+      @options.fetch(:test, false)
     end
 
-    def production?
-      @mode == :production
+    def live?
+      !test?
     end
 
     def api_url
-      test? ? TEST_URL : PRODUCTION_URL
-    end
-
-    private
-
-    def set_website(options)
-      @website = options[:website]
-
-      raise ArgumentError, "Missing required parameter: website" if @website.to_s.empty?
+      live? ? LIVE_URL : TEST_URL
     end
 
-    def set_secret(options)
-      @secret = options[:secret]
+    def website
+      @website ||= begin
+        website = @options[:website]
+        raise ArgumentError, 'Missing required parameter: website' if website.to_s.empty?
 
-      raise ArgumentError, "Missing required parameter: secret" if @secret.to_s.empty?
+        website
+      end
     end
 
-    # Set Buckaroo mode from options, class setting or the default (test).
-    def set_buckaroo_mode(options)
-      @mode = options.key?(:mode) ? options[:mode] : Gateway.mode
-      @mode ||= :test
+    def secret
+      @secret ||= begin
+        secret = @options[:secret]
+        raise ArgumentError, 'Missing required parameter: secret' if secret.to_s.empty?
 
-      if @mode != :test && @mode != :production
-        raise ArgumentError, "Invalid Buckaroo mode provided: #{@mode} (expected :test or :production)"
+        secret
       end
     end
 
-    # Set the hash method from options or default (SHA-1).
-    def set_hash_method(options)
-      @hash_method = (options[:hash_method] || "SHA1").downcase.to_sym
+    # Use the hash method from options or default (SHA-1).
+    def hash_method
+      @hash_method ||= begin
+        hash_method = (@options[:hash_method] || 'SHA1').downcase.to_sym
 
-      unless [:sha1, :sha256, :sha512].include?(@hash_method)
-        raise ArgumentError, "Invalid hash method provided: #{@hash_method} (expected :sha1, :sha256 or :sha512)"
+        unless [:sha1, :sha256, :sha512].include?(hash_method)
+          raise ArgumentError, "Invalid hash method provided: #{hash_method} (expected :sha1, :sha256 or :sha512)"
+        end
+
+        hash_method
       end
     end
 
-    # Set the logger from options, to Rails or to stdout.
-    def set_logger(options)
-      @logger   = options[:logger]
-      @logger ||= Rails.logger if defined?(Rails)
-      @logger ||= Logger.new(STDOUT)
+    # Use the logger from options, to Rails or to stdout.
+    def logger
+      @logger ||= begin
+        logger   = @options[:logger]
+        logger ||= Rails.logger if defined?(Rails)
+        logger ||= Logger.new($stdout)
+        logger
+      end
     end
   end
 end

data/lib/buckaruby/currency.rb

@@ -2,8 +2,8 @@
 
 module Buckaruby
   module Currency
-    EURO = "EUR"
-    BRITISH_POUND = "GBP"
-    US_DOLLAR = "USD"
+    EURO = 'EUR'
+    BRITISH_POUND = 'GBP'
+    US_DOLLAR = 'USD'
   end
 end

data/lib/buckaruby/exception.rb

@@ -12,13 +12,14 @@ module Buckaruby
     def initialize(params = {})
       @params = params
 
-      if status_message && status_code
-        message = "API request failed: #{status_message} (#{status_code})"
-      elsif error_message
-        message = "API request failed: #{error_message}"
-      else
-        message = "API request failed"
-      end
+      message =
+        if status_message && status_code
+          "API request failed: #{status_message} (#{status_code})"
+        elsif error_message
+          "API request failed: #{error_message}"
+        else
+          'API request failed'
+        end
 
       super(message)
     end
@@ -60,7 +61,7 @@ module Buckaruby
   class SignatureException < BuckarooException
     attr_reader :sent_signature, :generated_signature
 
-    def initialize(sent_signature = "", generated_signature = "")
+    def initialize(sent_signature, generated_signature)
       @sent_signature = sent_signature
       @generated_signature = generated_signature