mollie-api-ruby 4.14.0 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 727393f8a67630c11c052da7b282456a2ca751cbbd23b39825bca74bbbe5192d
-  data.tar.gz: c0c66af4d34388f7ce8648d33a1cb94b8ff0ac433e419ce2996aa55b1f727b0f
+  metadata.gz: 06f14768975850db4a88530cf6cfbe4d4b80f274c2616736ba6af908e83a044c
+  data.tar.gz: d7eae71e95f7d0b06646fcc39b069658dc0d808874654fdfd9b2353f1af70d3c
 SHA512:
-  metadata.gz: 9d99d066f8f1a02e06158680e5bdef30f329fada43091e49eda123534cb9e7449a0792ae30a30a2ffc0efe1b7c0da587dba14c6bf82e8bd4810cdd025038e93d
-  data.tar.gz: 2f6998f5f91999f5c794d2d3479c26552e6487f006221b9e51149f165ec80b7ea392c636e3f2b328e8e0bd13e47bdbcfcc967e5fed67257f33b7ad321ff88768
+  metadata.gz: d450cb135d44a6b17b51cdb5921aa03fa9a3796c540b427fb8796251177c776f5d3541f4bccf10739f1bf17fdc65611a318ae6ed17938718d915d487000ac435
+  data.tar.gz: 9a8fad769b51f90ecf0a4d464661b5e22cda7304b32388091019bb754d66eed1abe731f598547778e8357e302500f32a33a2c740a60b725625e03ed261ec29a2

data/CHANGELOG.md

@@ -4,6 +4,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## 4.15.0 - 2024-12-01
+
+  - (f659c19) Add Balance API
+
 ## 4.14.0 - 2024-11-02
 
   - (0876f2b) Add Payment Links API

data/examples/balances/get-primary.rb

@@ -0,0 +1 @@
+primary_balance = Mollie::Balance.primary

data/examples/balances/get-report.rb

@@ -0,0 +1,2 @@
+balance = Mollie::Balance.get("bal_gVMhHKqSSRYJyPsuoPNFH")
+report = balance.report

data/examples/balances/get.rb

@@ -0,0 +1 @@
+balance = Mollie::Balance.get("bal_gVMhHKqSSRYJyPsuoPNFH")

data/examples/balances/list-transactions.rb

@@ -0,0 +1,2 @@
+balance = Mollie::Balance.get("bal_gVMhHKqSSRYJyPsuoPNFH")
+transactions = balance.transactions

data/examples/balances/list.rb

@@ -0,0 +1 @@
+balances = Mollie::Balance.all

data/lib/mollie/balance/report.rb

@@ -0,0 +1,25 @@
+module Mollie
+  class Balance
+    class Report < Base
+      attr_accessor :balance_id,
+                    :time_zone,
+                    :grouping,
+                    :totals,
+                    :_links
+
+      attr_reader :from,
+                  :until
+
+      alias links _links
+
+      def from=(from)
+        @from = Date.parse(from)
+      end
+
+      def until=(until_date)
+        # `until` is a reserved keyword
+        @until = Date.parse(until_date)
+      end
+    end
+  end
+end

data/lib/mollie/balance/transaction.rb

@@ -0,0 +1,41 @@
+module Mollie
+  class Balance
+    class Transaction < Base
+      attr_accessor :id,
+                    :type,
+                    :_links
+
+      attr_reader :result_amount,
+                  :initial_amount,
+                  :deductions,
+                  :context,
+                  :created_at
+
+      alias links _links
+
+      def self.embedded_resource_name
+        "balance_transactions"
+      end
+
+      def result_amount=(amount)
+        @result_amount = Mollie::Amount.new(amount)
+      end
+
+      def initial_amount=(amount)
+       @initial_amount = Mollie::Amount.new(amount)
+      end
+
+      def deductions=(amount)
+       @deductions = Mollie::Amount.new(amount)
+      end
+
+      def context=(context)
+        @context = OpenStruct.new(context) if context.is_a?(Hash)
+      end
+
+      def created_at=(created_at)
+        @created_at = Time.parse(created_at.to_s)
+      end
+    end
+  end
+end

data/lib/mollie/balance.rb

@@ -0,0 +1,53 @@
+module Mollie
+  class Balance < Base
+    attr_accessor :id,
+                  :mode,
+                  :currency,
+                  :description,
+                  :status,
+                  :transfer_frequency,
+                  :transfer_reference,
+                  :_links
+
+    attr_reader :transfer_threshold,
+                :transfer_destination,
+                :available_amount,
+                :pending_amount,
+                :created_at
+
+    alias links _links
+
+    def self.primary(options = {})
+      get('primary', options)
+    end
+
+    def transfer_threshold=(amount)
+      @transfer_threshold = Mollie::Amount.new(amount)
+    end
+
+    def transfer_destination=(transfer_destination)
+      @transfer_destination = OpenStruct.new(transfer_destination) if transfer_destination.is_a?(Hash)
+    end
+
+    def available_amount=(amount)
+      @available_amount = Mollie::Amount.new(amount)
+    end
+
+    def pending_amount=(amount)
+      @pending_amount = Mollie::Amount.new(amount)
+    end
+
+    def created_at=(created_at)
+      @created_at = Time.parse(created_at.to_s)
+    end
+
+    def report(options = {})
+      response = Client.instance.perform_http_call("GET", "balances/#{id}", "report", {}, options)
+      Balance::Report.new(response)
+    end
+
+    def transactions(options = {})
+      Balance::Transaction.all(options.merge(balance_id: id))
+    end
+  end
+end

data/lib/mollie/version.rb

@@ -1,3 +1,3 @@
 module Mollie
-  VERSION = '4.14.0'.freeze
+  VERSION = '4.15.0'.freeze
 end

data/lib/mollie.rb

@@ -13,6 +13,7 @@ require 'mollie/version'
 
 require 'mollie/base'
 require 'mollie/amount'
+require 'mollie/balance'
 require 'mollie/chargeback'
 require 'mollie/client'
 require 'mollie/customer'
@@ -31,6 +32,8 @@ require 'mollie/settlement'
 require 'mollie/subscription'
 require 'mollie/terminal'
 
+require 'mollie/balance/report'
+require 'mollie/balance/transaction'
 require 'mollie/customer/mandate'
 require 'mollie/customer/payment'
 require 'mollie/customer/subscription'

data/test/fixtures/balances/get.json

@@ -0,0 +1,38 @@
+{
+  "resource": "balance",
+  "id": "bal_gVMhHKqSSRYJyPsuoPNFH",
+  "mode": "live",
+  "currency": "EUR",
+  "description": "Primary balance",
+  "availableAmount": {
+    "currency": "EUR",
+    "value": "905.25"
+  },
+  "pendingAmount": {
+    "currency": "EUR",
+    "value": "0.00"
+  },
+  "transferFrequency": "twice-a-month",
+  "transferThreshold": {
+    "currency": "EUR",
+    "value": "5.00"
+  },
+  "transferReference": "Mollie settlement",
+  "transferDestination": {
+    "type": "bank-account",
+    "beneficiaryName": "John Doe",
+    "bankAccount": "NL55INGB0000000000"
+  },
+  "status": "active",
+  "createdAt": "2019-01-10T12:06:28+00:00",
+  "_links": {
+    "self": {
+      "href": "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH",
+      "type": "application/hal+json"
+    },
+    "documentation": {
+      "href": "https://docs.mollie.com/reference/get-balance",
+      "type": "text/html"
+    }
+  }
+}

data/test/fixtures/balances/list.json

@@ -0,0 +1,34 @@
+{
+  "count": 1,
+  "_embedded": {
+    "balances": [
+      {
+        "resource": "balance",
+        "id": "bal_one"
+      },
+      {
+        "resource": "balance",
+        "id": "bal_two"
+      },
+      {
+        "resource": "balance",
+        "id": "bal_three"
+      }
+    ]
+  },
+  "_links": {
+    "documentation": {
+      "href": "https://docs.mollie.com/reference/v2/balances-api/list-balances",
+      "type": "text/html"
+    },
+    "self": {
+      "href": "https://api.mollie.com/v2/balances?limit=5",
+      "type": "application/hal+json"
+    },
+    "previous": null,
+    "next": {
+      "href": "https://api.mollie.com/v2/balances?from=bal_gVMhHKqSSRYJyPsuoPABC&limit=5",
+      "type": "application/hal+json"
+    }
+  }
+}

data/test/fixtures/balances/list_transactions.json

@@ -0,0 +1,65 @@
+{
+  "count": 2,
+  "_embedded": {
+    "balance_transactions": [
+      {
+        "resource": "balance_transaction",
+        "id": "baltr_QM24QwzUWR4ev4Xfgyt29A",
+        "type": "refund",
+        "resultAmount": {
+          "currency": "EUR",
+          "value": "-10.25"
+        },
+        "initialAmount": {
+          "currency": "EUR",
+          "value": "-10.00"
+        },
+        "deductions": {
+          "currency": "EUR",
+          "value": "-0.25"
+        },
+        "context": {
+          "paymentId": "tr_7UhSN1zuXS",
+          "refundId": "re_4qqhO89gsT"
+        },
+        "createdAt": "2021-01-10T12:06:28+00:00"
+      },
+      {
+        "resource": "balance_transaction",
+        "id": "baltr_WhmDwNYR87FPDbiwBhUXCh",
+        "type": "payment",
+        "resultAmount": {
+          "currency": "EUR",
+          "value": "9.71"
+        },
+        "initialAmount": {
+          "currency": "EUR",
+          "value": "10.00"
+        },
+        "deductions": {
+          "currency": "EUR",
+          "value": "-0.29"
+        },
+        "context": {
+          "paymentId": "tr_7UhSN1zuXS"
+        },
+        "createdAt": "2021-01-10T12:06:28+00:00"
+      }
+    ]
+  },
+  "_links": {
+    "self": {
+      "href": "...",
+      "type": "application/hal+json"
+    },
+    "previous": null,
+    "next": {
+      "href": "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH/transactions?from=baltr_rXeW2yPqqDUyfAqq8fS5Bg&limit=5",
+      "type": "application/hal+json"
+    },
+    "documentation": {
+      "href": "...",
+      "type": "text/html"
+    }
+  }
+}

data/test/fixtures/balances/report.json

@@ -0,0 +1,149 @@
+{
+  "resource": "balance-report",
+  "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH",
+  "timeZone": "Europe/Amsterdam",
+  "from": "2024-01-01",
+  "until": "2024-01-31",
+  "grouping": "transaction-categories",
+  "totals": {
+    "open": {
+      "available": {
+        "amount": {
+          "currency": "EUR",
+          "value": "0.00"
+        }
+      },
+      "pending": {
+        "amount": {
+          "currency": "EUR",
+          "value": "0.00"
+        }
+      }
+    },
+    "payments": {
+      "immediatelyAvailable": {
+        "amount": {
+          "currency": "EUR",
+          "value": "0.00"
+        }
+      },
+      "pending": {
+        "amount": {
+          "currency": "EUR",
+          "value": "4.98"
+        },
+        "subtotals": [
+          {
+            "transactionType": "payment",
+            "count": 1,
+            "amount": {
+              "currency": "EUR",
+              "value": "4.98"
+            },
+            "subtotals": [
+              {
+                "method": "ideal",
+                "count": 1,
+                "amount": {
+                  "currency": "EUR",
+                  "value": "4.98"
+                }
+              }
+            ]
+          }
+        ]
+      },
+      "movedToAvailable": {
+        "amount": {
+          "currency": "EUR",
+          "value": "0.00"
+        }
+      }
+    },
+    "refunds": {},
+    "capital": {},
+    "chargebacks": {},
+    "transfers": {},
+    "fee-prepayments": {
+      "immediatelyAvailable": {
+        "amount": {
+          "currency": "EUR",
+          "value": "0.00"
+        }
+      },
+      "movedToAvailable": {
+        "amount": {
+          "currency": "EUR",
+          "value": "-0.36"
+        },
+        "subtotals": [
+          {
+            "prepaymentPartType": "fee",
+            "count": 1,
+            "amount": {
+              "currency": "EUR",
+              "value": "-0.29"
+            },
+            "subtotals": [
+              {
+                "feeType": "payment-fee",
+                "method": "ideal",
+                "count": 1,
+                "amount": {
+                  "currency": "EUR",
+                  "value": "-0.29"
+                }
+              }
+            ]
+          },
+          {
+            "prepaymentPartType": "fee-vat",
+            "amount": {
+              "currency": "EUR",
+              "value": "-0.0609"
+            }
+          },
+          {
+            "prepaymentPartType": "fee-rounding-compensation",
+            "amount": {
+              "currency": "EUR",
+              "value": "-0.0091"
+            }
+          }
+        ]
+      },
+      "pending": {
+        "amount": {
+          "currency": "EUR",
+          "value": "-0.36"
+        },
+        "subtotals": []
+      }
+    },
+    "corrections": {},
+    "close": {
+      "available": {
+        "amount": {
+          "currency": "EUR",
+          "value": "0.00"
+        }
+      },
+      "pending": {
+        "amount": {
+          "currency": "EUR",
+          "value": "4.32"
+        }
+      }
+    }
+  },
+  "_links": {
+    "self": {
+      "href": "...",
+      "type": "application/hal+json"
+    },
+    "documentation": {
+      "href": "...",
+      "type": "text/html"
+    }
+  }
+}

data/test/mollie/balance/transaction_test.rb

@@ -0,0 +1,36 @@
+require 'helper'
+
+module Mollie
+  class Balance
+    class TransactionTest < Test::Unit::TestCase
+      def test_setting_attributes
+        attributes = {
+          id: "baltr_QM24QwzUWR4ev4Xfgyt29A",
+          type: "refund",
+          result_amount: { "value" => "-10.25", "currency" => "EUR" },
+          initial_amount: { "value" => "-10.00", "currency" => "EUR" },
+          deductions: { "value" => "0.25", "currency" => "EUR" },
+          context: {
+            "paymentId" => "tr_7UhSN1zuXS",
+            "refundId" => "re_4qqhO89gsT"
+          },
+          created_at: "2021-01-10T12:06:28+00:00"
+        }
+
+        balance = Balance::Transaction.new(attributes)
+
+        assert_equal "baltr_QM24QwzUWR4ev4Xfgyt29A", balance.id
+        assert_equal "refund", balance.type
+        assert_equal BigDecimal("-10.25"), balance.result_amount.value
+        assert_equal "EUR", balance.result_amount.currency
+        assert_equal BigDecimal("-10.00"), balance.initial_amount.value
+        assert_equal "EUR", balance.initial_amount.currency
+        assert_equal BigDecimal("0.25"), balance.deductions.value
+        assert_equal "EUR", balance.deductions.currency
+        assert_equal "tr_7UhSN1zuXS", balance.context.paymentId
+        assert_equal "re_4qqhO89gsT", balance.context.refundId
+        assert_equal Time.parse("2021-01-10T12:06:28+00:00"), balance.created_at
+      end
+    end
+  end
+end

data/test/mollie/balance_test.rb

@@ -0,0 +1,108 @@
+require "helper"
+
+module Mollie
+  class BalanceTest < Test::Unit::TestCase
+    GET_BALANCE = read_fixture('balances/get.json')
+    GET_BALANCE_REPORT = read_fixture('balances/report.json')
+    LIST_BALANCES = read_fixture('balances/list.json')
+    LIST_BALANCE_TRANSACTIONS = read_fixture('balances/list_transactions.json')
+
+    def test_setting_attributes
+      attributes = {
+        id: "bal_gVMhHKqSSRYJyPsuoPNFH",
+        mode: "live",
+        currency: "EUR",
+        description: "Primary balance",
+        available_amount: { "value" => "0.00", "currency" => "EUR" },
+        pending_amount: { "value" => "0.00", "currency" => "EUR" },
+        transfer_frequency: "twice-a-month",
+        transfer_threshold: { "value" => "5.00", "currency" => "EUR" },
+        transfer_reference: "Mollie settlement",
+        transfer_destination: {
+          type: "bank-account",
+          beneficiary_name: "John Doe",
+          bank_account: "NL55INGB0000000000"
+        },
+        status: "active",
+        created_at:  "2018-03-20T09:13:37+00:00",
+      }
+
+      balance = Mollie::Balance.new(attributes)
+
+      assert_equal "bal_gVMhHKqSSRYJyPsuoPNFH", balance.id
+      assert_equal "live", balance.mode
+      assert_equal "EUR", balance.currency
+      assert_equal "Primary balance", balance.description
+      assert_equal BigDecimal("0.00"), balance.available_amount.value
+      assert_equal "EUR", balance.available_amount.currency
+      assert_equal BigDecimal("0.00"), balance.pending_amount.value
+      assert_equal "EUR", balance.pending_amount.currency
+      assert_equal "twice-a-month", balance.transfer_frequency
+      assert_equal BigDecimal("5.00"), balance.transfer_threshold.value
+      assert_equal "EUR", balance.transfer_threshold.currency
+      assert_equal "Mollie settlement", balance.transfer_reference
+      assert_equal "bank-account", balance.transfer_destination.type
+      assert_equal "John Doe", balance.transfer_destination.beneficiary_name
+      assert_equal "NL55INGB0000000000", balance.transfer_destination.bank_account
+      assert_equal "active", balance.status
+      assert_equal Time.parse('2018-03-20T09:13:37+00:00'), balance.created_at
+    end
+
+    def test_get_balance
+      stub_request(:get, "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH")
+        .to_return(status: 200, body: GET_BALANCE, headers: {})
+
+      balance = Balance.get("bal_gVMhHKqSSRYJyPsuoPNFH")
+      assert_equal "bal_gVMhHKqSSRYJyPsuoPNFH", balance.id
+    end
+
+    def test_list_balances
+      stub_request(:get, 'https://api.mollie.com/v2/balances')
+        .to_return(status: 200, body: LIST_BALANCES, headers: {})
+
+      balances = Balance.all
+      assert_equal 3, balances.size
+      assert_equal 'bal_one', balances[0].id
+      assert_equal 'bal_two', balances[1].id
+      assert_equal 'bal_three', balances[2].id
+    end
+
+    def test_primary
+      stub_request(:get, "https://api.mollie.com/v2/balances/primary")
+        .to_return(status: 200, body: GET_BALANCE, headers: {})
+
+      balance = Balance.primary
+      assert_equal "bal_gVMhHKqSSRYJyPsuoPNFH", balance.id
+    end
+
+    def test_report
+      stub_request(:get, "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH")
+        .to_return(status: 200, body: GET_BALANCE, headers: {})
+
+      stub_request(:get, 'https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH/report')
+        .to_return(status: 200, body: GET_BALANCE_REPORT, headers: {})
+
+      report = Balance.get("bal_gVMhHKqSSRYJyPsuoPNFH").report
+
+      assert_equal Date.parse("2024-01-01"), report.from
+      assert_equal Date.parse("2024-01-31"), report.until
+      assert_equal "transaction-categories", report.grouping
+      assert_equal "4.98", report.totals.dig("payments", "pending", "amount", "value")
+      assert_equal "-0.36", report.totals.dig("fee_prepayments", "moved_to_available", "amount", "value")
+    end
+
+    def test_list_transactions
+      stub_request(:get, "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH")
+        .to_return(status: 200, body: GET_BALANCE, headers: {})
+
+      stub_request(:get, 'https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH/transactions')
+        .to_return(status: 200, body: LIST_BALANCE_TRANSACTIONS, headers: {})
+
+      transactions = Balance.get("bal_gVMhHKqSSRYJyPsuoPNFH").transactions
+      assert_equal 2, transactions.size
+
+      assert_equal "baltr_QM24QwzUWR4ev4Xfgyt29A", transactions[0].id
+      assert_equal "baltr_WhmDwNYR87FPDbiwBhUXCh", transactions[1].id
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mollie-api-ruby
 version: !ruby/object:Gem::Version
-  version: 4.14.0
+  version: 4.15.0
 platform: ruby
 authors:
 - Mollie B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-02 00:00:00.000000000 Z
+date: 2024-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct
@@ -129,6 +129,11 @@ files:
 - bin/setup
 - docs/migration_v2_2_x.md
 - docs/migration_v3_x.md
+- examples/balances/get-primary.rb
+- examples/balances/get-report.rb
+- examples/balances/get.rb
+- examples/balances/list-transactions.rb
+- examples/balances/list.rb
 - examples/captures/get-payment.rb
 - examples/captures/get-settlement.rb
 - examples/captures/get-shipment.rb
@@ -226,6 +231,9 @@ files:
 - lib/mollie-api-ruby.rb
 - lib/mollie.rb
 - lib/mollie/amount.rb
+- lib/mollie/balance.rb
+- lib/mollie/balance/report.rb
+- lib/mollie/balance/transaction.rb
 - lib/mollie/base.rb
 - lib/mollie/chargeback.rb
 - lib/mollie/client.rb
@@ -263,6 +271,10 @@ files:
 - lib/mollie/util.rb
 - lib/mollie/version.rb
 - mollie-api-ruby.gemspec
+- test/fixtures/balances/get.json
+- test/fixtures/balances/list.json
+- test/fixtures/balances/list_transactions.json
+- test/fixtures/balances/report.json
 - test/fixtures/captures/get.json
 - test/fixtures/captures/list.json
 - test/fixtures/customer/get.json
@@ -303,6 +315,8 @@ files:
 - test/fixtures/terminals/list.json
 - test/helper.rb
 - test/mollie/amount_test.rb
+- test/mollie/balance/transaction_test.rb
+- test/mollie/balance_test.rb
 - test/mollie/base_test.rb
 - test/mollie/chargeback_test.rb
 - test/mollie/client_test.rb
@@ -356,11 +370,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Official Mollie API Client for Ruby
 test_files:
+- test/fixtures/balances/get.json
+- test/fixtures/balances/list.json
+- test/fixtures/balances/list_transactions.json
+- test/fixtures/balances/report.json
 - test/fixtures/captures/get.json
 - test/fixtures/captures/list.json
 - test/fixtures/customer/get.json
@@ -401,6 +419,8 @@ test_files:
 - test/fixtures/terminals/list.json
 - test/helper.rb
 - test/mollie/amount_test.rb
+- test/mollie/balance/transaction_test.rb
+- test/mollie/balance_test.rb
 - test/mollie/base_test.rb
 - test/mollie/chargeback_test.rb
 - test/mollie/client_test.rb