docdata-order 1.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 10bb3f962150a565fe9b496efee90734099c09ff
-  data.tar.gz: 24489d017c6bd41765da9b4baf0bc46b8fff2bd1
+SHA256:
+  metadata.gz: 4e9a69ef9b4a6b563b917c5e8b4c1509796f580c285b84dac289a4b7e0d9c6ff
+  data.tar.gz: e4280bb171fb3aecf0412f4546f47054504ea986dd1491f0310e5ba87aba769d
 SHA512:
-  metadata.gz: 80158fcacd7d4640785952e0f55561f8888e8f92c80926ad3e2e23ab3a4273586eb51017a20133b9828c0b2c73e7ac975d31fde137e0db7100d0ddf5248b6b7b
-  data.tar.gz: 1539b96288ca0faaefb15a7aecb88cbd26daab80329fde08b1b4c2f653aab9420a529eb32fd43816368315071c44a9f4e5a7219c630867e5c03f1efaf9538a0c
+  metadata.gz: 8f1711b410acb0e21d1b2d2cbbe4097806dc08df39e03879d12f34def9bae4ea6290afbadffa02600fd42c1b9056c1dc2721513323f0880ac1b0d561ecb61c4e
+  data.tar.gz: b5c6891840ec43f427446bbeaaa43de2d2cf455e438b454eceebab361801338be784c687020eae1675e5d75d3e07fc11ed3562bca122d74c64338712ea0d96fb

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  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,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -1,16 +1,26 @@
 # Docdata-order RuboCop configuration
 
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.3
+  NewCops: enable
+  TargetRubyVersion: 2.4
   DisplayCopNames: true
   DisplayStyleGuide: true
+  Exclude:
+    - 'tmp/**/*'
+    - 'vendor/**/*'
 
-# We target 2.3, but still want to support 2.0.
-Gemspec/RequiredRubyVersion:
+
+Layout/LineLength:
   Enabled: false
 
+
 Metrics/AbcSize:
-  Max: 53
+  Max: 58
 
 Metrics/BlockLength:
   Exclude:
@@ -19,25 +29,27 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Enabled: false
 
-Metrics/LineLength:
-  Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
 
+
+RSpec/DescribedClass:
+  EnforcedStyle: explicit
+
+RSpec/ExampleLength:
+  Max: 41
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+
 Style/BlockDelimiters:
   Exclude:
     - 'spec/**/*.rb'
 
-Style/ExpandPathArguments:
-  Enabled: false
-
 Style/GuardClause:
   Enabled: false
 
-Style/SafeNavigation:
-  Enabled: false
-
 Style/StringLiterals:
   Enabled: false
 

data/Gemfile

@@ -5,4 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in docdata-order.gemspec
 gemspec
 
-gem 'rubocop', '~> 0.59.2'
+gem 'rubocop', '~> 1.12.0'
+gem 'rubocop-performance', '~> 1.10.2'
+gem 'rubocop-rake', '~> 0.5.1'
+gem 'rubocop-rspec', '~> 2.2.0'

data/Gemfile.lock

@@ -0,0 +1,106 @@
+PATH
+  remote: .
+  specs:
+    docdata-order (2.1.0)
+      savon (>= 2.0, < 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    ast (2.4.2)
+    builder (3.2.4)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    hashdiff (1.0.1)
+    httpi (2.4.5)
+      rack
+      socksify
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    nori (2.6.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    savon (2.12.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    socksify (1.7.1)
+    unicode-display_width (2.0.0)
+    wasabi (3.6.1)
+      addressable
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  docdata-order!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.12.0)
+  rubocop-performance (~> 1.10.2)
+  rubocop-rake (~> 0.5.1)
+  rubocop-rspec (~> 2.2.0)
+  webmock (~> 2.3, >= 2.3.2)
+
+BUNDLED WITH
+   2.2.17

data/README.md

@@ -1,11 +1,30 @@
 # Docdata::Order
 
 [![Gem Version](https://badge.fury.io/rb/docdata-order.svg)](https://badge.fury.io/rb/docdata-order)
-[![Build Status](https://travis-ci.org/KentaaNL/docdata-order.svg?branch=master)](https://travis-ci.org/KentaaNL/docdata-order)
+[![Build Status](https://github.com/KentaaNL/docdata-order/actions/workflows/test.yml/badge.svg)](https://github.com/KentaaNL/docdata-order/actions)
 [![Code Climate](https://codeclimate.com/github/KentaaNL/docdata-order/badges/gpa.svg)](https://codeclimate.com/github/KentaaNL/docdata-order)
 
 Docdata::Order is a Ruby client for the Docdata Order API version 1.3.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Initialization](#initialization)
+    - [Subject merchant](#subject-merchant)
+  - [Create an order](#create-an-order)
+    - [Redirecting directly to the payment page](#redirecting-directly-to-the-payment-page)
+    - [Initial payment request](#initial-payment-request)
+  - [Start a payment order](#start-a-payment-order)
+    - [Recurring payment request](#recurring-payment-request)
+  - [Retrieve status of an order](#retrieve-status-of-an-order)
+  - [Retrieve payment methods](#retrieve-payment-methods)
+  - [Refund a payment](#refund-a-payment)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,14 +48,25 @@ Or install it yourself as:
 Create a Docdata Order client and configure it with your merchant name and password:
 
 ```ruby
-order = Docdata::Order::Client.new("name", "password")
+client = Docdata::Order::Client.new("name", "password")
 ```
 
-The client is configured in live mode by default. To put the client in test mode, use `test: true` as third parameter.
+The client is configured to use the production environment by default. To use the Docdata test environment, add the parameter `test: true` when creating the client.
+
+#### Subject merchant
+
+If you want to use a merchant on whose behalf the requests should be executed (subject merchant), then you can add this to the parameters:
+
+```ruby
+client = Docdata::Order::Client.new("name", "password", subject_merchant: {
+  name: "subname",
+  token: "12345678"
+})
+```
 
 ### Create an order
 
-Create a new order with the `create` method. You need to provide the following parameters to create the order:
+Create a new order with the `create` method. You need to provide at least the following parameters to create the order:
 
 ```ruby
 options = {
@@ -60,7 +90,7 @@ options = {
   }
 }
 
-response = order.create(options)
+response = client.create(options)
 
 if response.success?
   puts response.order_key
@@ -72,29 +102,47 @@ end
 
 The `redirect_url` in the response will redirect the user to the Docdata Payment Menu (One Page Checkout).
 
-To create an order and automatically redirect to the bank using iDEAL as payment method, use the parameters above including:
+#### Redirecting directly to the payment page
+
+For some payment methods you can skip the Docdata One Page Checkout and redirect directly to the payment page of the specified payment method.
+This works for the payment methods iDEAL, Sofort and PayPal. For iDEAL, you also need to provide the issuer:
 
 ```ruby
-response = order.create(options.merge(
+response = client.create(options.merge(
   payment_method: Docdata::Order::PaymentMethod::IDEAL,
-  issuer_id: Docdata::Order::Ideal::ISSUERS.first[0],
+  issuer_id: "INGBNL2A",
   return_url: "http://yourwebshop.nl/payment_return"
 ))
 ```
 
+#### Initial payment request
+
+If you want to use this order to do recurring payments then you must first make an initial payment request and provide an unique merchant reference.
+This reference should then be used when a making recurring payments.
+
+```ruby
+response = client.create(options.merge(
+  initial: {
+    merchant_reference: "12345"
+  }
+))
+```
+
+See [Recurring payment request](#recurring-payment-request) how to make recurring payment requests.
+
 ### Start a payment order
 
-When using Webdirect, you can use `start` to start a payment order.
+When the One Page Checkout is not used (i.e. WebDirect) then you need to use `start` to start a payment order.
 
 ```ruby
 options = {
   order_key: "12345",
   payment_method: Docdata::Order::PaymentMethod::SEPA_DIRECT_DEBIT,
-  account_name: "Onderheuvel",
-  account_iban: "NL44RABO0123456789"
+  consumer_name: "Onderheuvel",
+  consumer_iban: "NL44RABO0123456789"
 }
 
-response = order.start(options)
+response = client.start(options)
 
 if response.success?
   puts response.payment_id
@@ -103,12 +151,24 @@ else
 end
 ```
 
+#### Recurring payment request
+
+To start a recurring payment request, you need to provide the unique merchant reference, used in the initial payment request:
+
+```ruby
+response = client.start(options.merge(
+  recurring: {
+    merchant_reference: "12345"
+  }
+))
+```
+
 ### Retrieve status of an order
 
 To retrieve the status of an order, use `status` with the order key:
 
 ```ruby
-response = order.status(order_key: "12345")
+response = client.status(order_key: "12345")
 
 if response.success?
   puts response.paid?
@@ -117,6 +177,33 @@ else
 end
 ```
 
+### Retrieve payment methods
+
+When an order has been created, you can retrieve the available payment methods (including issuers) by using `payment_methods` with the order key:
+
+```ruby
+response = client.payment_methods(order_key: "12345")
+
+if response.success?
+  puts response.payment_methods
+else
+  puts response.error_message
+end
+```
+
+### Refund a payment
+
+To refund a payment, use `refund` with the payment ID:
+
+```ruby
+response = client.refund(payment_id: "12345")
+
+if !response.success?
+  puts response.error_message
+end
+
+```
+
 ## 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.

data/docdata-order.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'docdata/order/version'
 
@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 2.3", ">= 2.3.2"
 

data/lib/docdata/order.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
+require "docdata/order/amount"
 require "docdata/order/client"
 require "docdata/order/exception"
 require "docdata/order/gender"
-require "docdata/order/ideal"
 require "docdata/order/payment_method"
 require "docdata/order/request"
 require "docdata/order/response"

data/lib/docdata/order/amount.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module Docdata
+  module Order
+    # Helper for converting/formatting amounts.
+    class Amount
+      class << self
+        def from_cents(cents)
+          new(cents.to_i / 100.0)
+        end
+      end
+
+      def initialize(amount)
+        @amount = BigDecimal(amount.to_s)
+      end
+
+      def to_d
+        @amount
+      end
+
+      def to_amount
+        @amount / 100.0
+      end
+
+      def to_cents
+        cents = @amount * 100
+        cents.to_i
+      end
+
+      # Convert the amount to a String with 2 decimals.
+      def to_s
+        format("%.2f", @amount)
+      end
+    end
+  end
+end

data/lib/docdata/order/client.rb

@@ -18,7 +18,7 @@ module Docdata
 
         response = client.call(:create, message: CreateRequest.new(params), attributes: { xmlns: XMLNS_DDP, version: DDP_VERSION })
 
-        raise Exception, response unless response.success?
+        raise Docdata::Order::Exception, response unless response.success?
 
         CreateResponse.new(params, response)
       end
@@ -28,7 +28,7 @@ module Docdata
 
         response = client.call(:start, message: StartRequest.new(params), attributes: { xmlns: XMLNS_DDP, version: DDP_VERSION })
 
-        raise Exception, response unless response.success?
+        raise Docdata::Order::Exception, response unless response.success?
 
         StartResponse.new(params, response)
       end
@@ -38,20 +38,38 @@ module Docdata
 
         response = client.call(:status_extended, message: ExtendedStatusRequest.new(params), attributes: { xmlns: XMLNS_DDP, version: DDP_VERSION })
 
-        raise Exception, response unless response.success?
+        raise Docdata::Order::Exception, response unless response.success?
 
         ExtendedStatusResponse.new(params, response)
       end
 
+      def refund(options = {})
+        params = @options.merge(options)
+
+        response = client.call(:refund, message: RefundRequest.new(params), attributes: { xmlns: XMLNS_DDP, version: DDP_VERSION })
+
+        raise Docdata::Order::Exception, response unless response.success?
+
+        RefundResponse.new(params, response)
+      end
+
+      def payment_methods(options = {})
+        params = @options.merge(options)
+
+        response = client.call(:list_payment_methods, message: ListPaymentMethodsRequest.new(params), attributes: { xmlns: XMLNS_DDP, version: DDP_VERSION })
+
+        raise Docdata::Order::Exception, response unless response.success?
+
+        ListPaymentMethodsResponse.new(params, response)
+      end
+
       private
 
       def client
         @client ||= begin
           params = { wsdl: wsdl_url, raise_errors: false, namespace_identifier: nil, namespaces: { "xmlns:ddp" => XMLNS_DDP } }
 
-          if @options[:debug]
-            params.merge!(log: true, log_level: :debug, pretty_print_xml: true)
-          end
+          params.merge!(log: true, log_level: :debug, pretty_print_xml: true) if @options[:debug]
 
           params[:logger] = Rails.logger if defined?(Rails)
 

data/lib/docdata/order/payment_method.rb

@@ -2,13 +2,28 @@
 
 module Docdata
   module Order
-    module PaymentMethod
+    # Payment method in Docdata, optionally with issuers.
+    class PaymentMethod
       IDEAL = "IDEAL"
       VISA = "VISA"
       MASTER_CARD = "MASTERCARD"
+      MAESTRO = "MAESTRO"
       AMERICAN_EXPRESS = "AMEX"
       PAYPAL = "PAYPAL_EXPRESS_CHECKOUT"
       SEPA_DIRECT_DEBIT = "SEPA_DIRECT_DEBIT"
+      BANCONTACT = "MISTERCASH"
+      SOFORT = "EBANKING"
+      GIROPAY = "GIROPAY"
+
+      attr_accessor :payment_method, :issuers
+
+      def initialize(payment_method)
+        @payment_method = payment_method
+      end
+
+      def to_s
+        payment_method
+      end
     end
   end
 end

data/lib/docdata/order/request.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "builder/xmlmarkup"
-require "bigdecimal"
 require "securerandom"
 
 module Docdata
@@ -18,7 +17,22 @@ module Docdata
         builder = Builder::XmlMarkup.new
 
         # Merchant credentials.
-        builder.merchant(name: merchant_name, password: merchant_password)
+        if subject_merchant
+          builder.merchant(name: merchant_name, password: merchant_password) do |merchant|
+            # The merchant on whose behalf this request should be executed.
+            merchant.subjectMerchant(name: subject_merchant_name, token: subject_merchant_token) do |subject|
+              if subject_merchant_fee
+                # The fee to apply to the subject merchant. If the fee is zero, then it is ignored. A fee can only be applied to create-order requests.
+                subject.fee(moment: subject_merchant_fee_moment) do |fee|
+                  fee.amount(subject_merchant_fee_amount, currency: subject_merchant_fee_currency)
+                  fee.description(subject_merchant_fee_description) if subject_merchant_fee_description
+                end
+              end
+            end
+          end
+        else
+          builder.merchant(name: merchant_name, password: merchant_password)
+        end
 
         build_request(builder)
 
@@ -57,6 +71,38 @@ module Docdata
         options.fetch(:merchant).fetch(:password)
       end
 
+      def subject_merchant
+        options[:subject_merchant]
+      end
+
+      def subject_merchant_name
+        subject_merchant.fetch(:name)
+      end
+
+      def subject_merchant_token
+        subject_merchant.fetch(:token)
+      end
+
+      def subject_merchant_fee
+        subject_merchant[:fee]
+      end
+
+      def subject_merchant_fee_moment
+        subject_merchant_fee[:moment] || "FULLY_PAID"
+      end
+
+      def subject_merchant_fee_description
+        subject_merchant_fee[:description]
+      end
+
+      def subject_merchant_fee_amount
+        Amount.new(subject_merchant_fee.fetch(:amount)).to_cents
+      end
+
+      def subject_merchant_fee_currency
+        subject_merchant_fee[:currency] || "EUR"
+      end
+
       def build_request
         raise NotImplementedError
       end
@@ -130,14 +176,21 @@ module Docdata
 
         # The description that is used by payment providers on shopper statements.
         builder.receiptText(receipt_text)
+
+        # The merchant_reference is used for recurring payments.
+        if initial
+          builder.paymentRequest do |payment_request|
+            payment_request.initialPaymentReference do |payment_reference|
+              payment_reference.merchantReference(merchant_reference)
+            end
+          end
+        end
       end
 
       private
 
       def amount
-        decimal = BigDecimal(options.fetch(:amount).to_s)
-        decimal *= 100 # to cents
-        decimal.to_i
+        Amount.new(options.fetch(:amount)).to_cents
       end
 
       def order_reference
@@ -211,6 +264,14 @@ module Docdata
       def receipt_text
         options.fetch(:description)[0, 49]
       end
+
+      def initial
+        options[:initial]
+      end
+
+      def merchant_reference
+        initial[:merchant_reference]
+      end
     end
 
     # Start a payment order (Webdirect).
@@ -219,22 +280,30 @@ module Docdata
         # Payment order key belonging to the order for which a transaction needs to be started.
         builder.paymentOrderKey(order_key)
 
-        builder.payment do |payment|
-          payment.paymentMethod(payment_method)
-
-          case payment_method
-          when PaymentMethod::IDEAL
-            payment.iDealPaymentInput do |input|
-              input.issuerId(issuer_id)
+        if recurring
+          builder.recurringPaymentRequest do |payment_request|
+            payment_request.initialPaymentReference do |payment_reference|
+              payment_reference.merchantReference(merchant_reference)
             end
-          when PaymentMethod::SEPA_DIRECT_DEBIT
-            payment.directDebitPaymentInput do |input|
-              input.holderName(account_name)
-              input.iban(account_iban)
-              input.bic(account_bic) if account_bic
+          end
+        else
+          builder.payment do |payment|
+            payment.paymentMethod(payment_method)
+
+            case payment_method
+            when PaymentMethod::IDEAL
+              payment.iDealPaymentInput do |input|
+                input.issuerId(issuer_id)
+              end
+            when PaymentMethod::SEPA_DIRECT_DEBIT
+              payment.directDebitPaymentInput do |input|
+                input.holderName(consumer_name)
+                input.iban(consumer_iban)
+                input.bic(consumer_bic) if consumer_bic
+              end
+            else
+              raise ArgumentError, "Payment method not supported: #{payment_method}"
             end
-          else
-            raise ArgumentError, "Payment method not supported: #{payment_method}"
           end
         end
       end
@@ -246,23 +315,31 @@ module Docdata
       end
 
       def payment_method
-        options.fetch(:payment_method)
+        options.fetch(:payment_method).to_s
       end
 
       def issuer_id
         options.fetch(:issuer_id)
       end
 
-      def account_name
-        options.fetch(:account_name)
+      def consumer_name
+        options.fetch(:consumer_name)
+      end
+
+      def consumer_iban
+        options.fetch(:consumer_iban)
+      end
+
+      def consumer_bic
+        options[:consumer_bic]
       end
 
-      def account_iban
-        options.fetch(:account_iban)
+      def recurring
+        options[:recurring]
       end
 
-      def account_bic
-        options[:account_bic]
+      def merchant_reference
+        recurring[:merchant_reference]
       end
     end
 
@@ -278,5 +355,57 @@ module Docdata
         options.fetch(:order_key)
       end
     end
+
+    # Create a refund request in the DocData system.
+    class RefundRequest < Request
+      def build_request(builder)
+        # The payment ID on which the refund request needs to be performed.
+        builder.paymentId(payment_id)
+
+        # Merchant's internal ID for identifying this refund.
+        builder.merchantRefundReference(refund_reference) if refund_reference
+
+        # Optional amount to refund.
+        builder.amount(amount, currency: currency) if amount
+
+        # Optional description for this refund.
+        builder.description(description) if description
+      end
+
+      private
+
+      def payment_id
+        options.fetch(:payment_id)
+      end
+
+      def refund_reference
+        options[:refund_reference]
+      end
+
+      def amount
+        Amount.new(options[:amount]).to_cents if options[:amount]
+      end
+
+      def currency
+        options[:currency] || "EUR"
+      end
+
+      def description
+        options[:description]
+      end
+    end
+
+    # Retrieve available payment methods for an Order.
+    class ListPaymentMethodsRequest < Request
+      def build_request(builder)
+        builder.paymentOrderKey(order_key)
+      end
+
+      private
+
+      def order_key
+        options.fetch(:order_key)
+      end
+    end
   end
 end

data/lib/docdata/order/response.rb

@@ -63,7 +63,7 @@ module Docdata
           when PaymentMethod::IDEAL
             params[:default_act] = true
             params[:ideal_issuer_id] = issuer_id if issuer_id
-          when PaymentMethod::PAYPAL
+          when PaymentMethod::PAYPAL, PaymentMethod::SOFORT
             params[:default_act] = true
           end
         end
@@ -93,7 +93,12 @@ module Docdata
       end
 
       def merchant_name
-        options.fetch(:merchant).fetch(:name)
+        # Use subject merchant when present, otherwise fallback to merchant.
+        if options[:subject_merchant]
+          options.fetch(:subject_merchant).fetch(:name)
+        else
+          options.fetch(:merchant).fetch(:name)
+        end
       end
 
       def client_language
@@ -101,7 +106,7 @@ module Docdata
       end
 
       def payment_method
-        options[:payment_method]
+        options[:payment_method].to_s
       end
 
       def issuer_id
@@ -280,7 +285,7 @@ module Docdata
         authorization_status == "CANCELED"
       end
 
-      def account_iban
+      def consumer_iban
         case payment_method
         when PaymentMethod::IDEAL
           payment_info = payment[:extended][:i_deal_payment_info]
@@ -291,7 +296,7 @@ module Docdata
         end
       end
 
-      def account_bic
+      def consumer_bic
         case payment_method
         when PaymentMethod::IDEAL
           payment_info = payment[:extended][:i_deal_payment_info]
@@ -302,7 +307,7 @@ module Docdata
         end
       end
 
-      def account_name
+      def consumer_name
         if payment_method == PaymentMethod::IDEAL
           payment_info = payment[:extended][:i_deal_payment_info]
           payment_info[:holder_name] if payment_info
@@ -319,9 +324,53 @@ module Docdata
       private
 
       def to_decimal(cents)
-        total = BigDecimal(cents)
-        total /= 100.0
-        total
+        Amount.from_cents(cents).to_d
+      end
+    end
+
+    # Response to a refund operation.
+    class RefundResponse < Response
+      def data
+        body[:refund_response]
+      end
+
+      def success?
+        data.key?(:refund_success)
+      end
+
+      def error?
+        data.key?(:refund_errors)
+      end
+
+      def errors
+        data[:refund_errors]
+      end
+    end
+
+    # Response to a list payment methods operation.
+    class ListPaymentMethodsResponse < Response
+      def data
+        body[:list_payment_methods_response]
+      end
+
+      def success?
+        data.key?(:list_payment_methods_success)
+      end
+
+      def error?
+        data.key?(:list_payment_methods_errors)
+      end
+
+      def errors
+        data[:list_payment_methods_errors]
+      end
+
+      def payment_methods
+        data[:list_payment_methods_success][:payment_method].map do |payment_method|
+          method = PaymentMethod.new(payment_method[:name])
+          method.issuers = payment_method[:issuers][:issuer].map { |issuer| [issuer.attributes["id"], issuer.to_s] }.to_h if payment_method.key?(:issuers)
+          method
+        end
       end
     end
   end

data/lib/docdata/order/urls.rb

@@ -5,11 +5,11 @@ module Docdata
     module Urls
       # WSDL location, see Order API 1.3.
       WSDL_LIVE_URL = "https://secure.docdatapayments.com/ps/services/paymentservice/1_3?wsdl"
-      WSDL_TEST_URL = "https://test.docdatapayments.com/ps/services/paymentservice/1_3?wsdl"
+      WSDL_TEST_URL = "https://testsecure.docdatapayments.com/ps/services/paymentservice/1_3?wsdl"
 
       # Payment Menu base URL, see Functional API.
       MENU_LIVE_URL = "https://secure.docdatapayments.com/ps/menu"
-      MENU_TEST_URL = "https://test.docdatapayments.com/ps/menu"
+      MENU_TEST_URL = "https://testsecure.docdatapayments.com/ps/menu"
     end
   end
 end

data/lib/docdata/order/version.rb

@@ -2,6 +2,6 @@
 
 module Docdata
   module Order
-    VERSION = "1.0.1"
+    VERSION = "2.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docdata-order
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Kentaa
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-05 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,19 +92,19 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - support@kentaa.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -112,10 +112,10 @@ files:
 - bin/setup
 - docdata-order.gemspec
 - lib/docdata/order.rb
+- lib/docdata/order/amount.rb
 - lib/docdata/order/client.rb
 - lib/docdata/order/exception.rb
 - lib/docdata/order/gender.rb
-- lib/docdata/order/ideal.rb
 - lib/docdata/order/payment_method.rb
 - lib/docdata/order/request.rb
 - lib/docdata/order/response.rb
@@ -125,7 +125,7 @@ homepage: https://github.com/KentaaNL/docdata-order
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,16 +133,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Ruby client for the Docdata Order API
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3

data/CHANGELOG.md

@@ -1,10 +0,0 @@
-# Docdata::Order changelog
-
-## 1.0.1 (2018-10-05)
-
-- Added Moneyou to the list of iDEAL issuers.
-- Fixed result of ExtendedStatusResponse#total_reversed.
-
-## 1.0.0 (2018-02-09)
-
-- First public release.

data/lib/docdata/order/ideal.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Docdata
-  module Order
-    module Ideal
-      ISSUERS = {
-        "ABNANL2A" => "ABN AMRO",
-        "ASNBNL21" => "ASN Bank",
-        "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
-end