mollie-api-ruby 4.15.0 → 4.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06f14768975850db4a88530cf6cfbe4d4b80f274c2616736ba6af908e83a044c
-  data.tar.gz: d7eae71e95f7d0b06646fcc39b069658dc0d808874654fdfd9b2353f1af70d3c
+  metadata.gz: 8c69f3ca558a810762900aa7a74798129377ee91d41b136d5b32428085451d8f
+  data.tar.gz: cde2ea24aa5eeae5218d71af093b7081e9dbcdd5f94dd9b84bb7f9cef9d841de
 SHA512:
-  metadata.gz: d450cb135d44a6b17b51cdb5921aa03fa9a3796c540b427fb8796251177c776f5d3541f4bccf10739f1bf17fdc65611a318ae6ed17938718d915d487000ac435
-  data.tar.gz: 9a8fad769b51f90ecf0a4d464661b5e22cda7304b32388091019bb754d66eed1abe731f598547778e8357e302500f32a33a2c740a60b725625e03ed261ec29a2
+  metadata.gz: 25f7c4a575b44e5ce96a8842fdb9c95f817f0beb0ab7150d221394a2b6c906921d538a8a398e6aab6f0569e772ef589fbdb6c75f51d6caa02ad9e95b6e313987
+  data.tar.gz: 27d0e5486b0e3c18f6e69eadc606aaaa75a32bd851780a3bebfbbd2f7952193743cfd3c2c7a133cd553292bfe561ca99727717bb710b62eba679d48576a8a49c

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## 4.16.0 - 2025-03-19
+
+  - (9caf303) Support embedded payment captures and chargebacks
+  - (ed1916e) Add support for embedded refunds
+  - (c322aca) Avoid frozen string literals warnings with Ruby 3.4
+
 ## 4.15.0 - 2024-12-01
 
   - (f659c19) Add Balance API

data/examples/payments/get.rb

@@ -1 +1,4 @@
 payment = Mollie::Payment.get('tr_7UhSN1zuXS')
+
+# With embedded resources
+payment = Mollie::Payment.get('tr_7UhSN1zuXS', embed: 'captures,chargebacks,refunds')

data/lib/mollie/client.rb

@@ -50,8 +50,8 @@ module Mollie
       @api_key         = api_key
       @version_strings = []
 
-      add_version_string 'Mollie/' << VERSION
-      add_version_string 'Ruby/' << RUBY_VERSION
+      add_version_string "Mollie/#{VERSION}"
+      add_version_string "Ruby/#{RUBY_VERSION}"
       add_version_string OpenSSL::OPENSSL_VERSION.split(' ').slice(0, 2).join '/'
     end
 

data/lib/mollie/payment.rb

@@ -197,15 +197,33 @@ module Mollie
     end
 
     def refunds(options = {})
-      Payment::Refund.all(options.merge(payment_id: id))
+      resources = (attributes['_embedded']['refunds'] if attributes['_embedded'])
+
+      if resources.nil?
+        Payment::Refund.all(options.merge(payment_id: id))
+      else
+        List.new({ '_embedded' => { 'refunds' => resources } }, Payment::Refund)
+      end
     end
 
     def chargebacks(options = {})
-      Payment::Chargeback.all(options.merge(payment_id: id))
+      resources = (attributes['_embedded']['chargebacks'] if attributes['_embedded'])
+
+      if resources.nil?
+        Payment::Chargeback.all(options.merge(payment_id: id))
+      else
+        List.new({ '_embedded' => { 'chargebacks' => resources } }, Payment::Chargeback)
+      end
     end
 
     def captures(options = {})
-      Payment::Capture.all(options.merge(payment_id: id))
+      resources = (attributes['_embedded']['captures'] if attributes['_embedded'])
+
+      if resources.nil?
+        Payment::Capture.all(options.merge(payment_id: id))
+      else
+        List.new({ '_embedded' => { 'captures' => resources } }, Payment::Capture)
+      end
     end
 
     def customer(options = {})

data/lib/mollie/version.rb

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

data/test/fixtures/payments/get_embedded_resources.json

@@ -0,0 +1,126 @@
+{
+  "resource": "payment",
+  "id": "tr_WDqYK6vllg",
+  "mode": "test",
+  "createdAt": "2018-03-20T13:13:37+00:00",
+  "amount": {
+    "value": "10.00",
+    "currency": "EUR"
+  },
+  "description": "Order #12345",
+  "method": null,
+  "metadata": {
+    "order_id": "12345"
+  },
+  "status": "open",
+  "isCancelable": false,
+  "locale": "nl_NL",
+  "restrictPaymentMethodsToCountry": "NL",
+  "expiresAt": "2018-03-20T13:28:37+00:00",
+  "details": null,
+  "profileId": "pfl_QkEhN94Ba",
+  "sequenceType": "oneoff",
+  "redirectUrl": "https://webshop.example.org/order/12345/",
+  "webhookUrl": "https://webshop.example.org/payments/webhook/",
+  "_embedded": {
+    "captures": [
+      {
+        "resource": "capture",
+        "id": "cpt_mNepDkEtco6ah3QNPUGYH",
+        "mode": "test",
+        "amount": {
+          "value": "10.00",
+          "currency": "EUR"
+        },
+        "status": "succeeded",
+        "createdAt": "2025-03-19T15:03:34+00:00",
+        "description": "Capture for order #12345",
+        "settlementAmount": {
+          "value": "10.00",
+          "currency": "EUR"
+        },
+        "paymentId": "tr_WDqYK6vllg",
+        "_links": {
+          "self": {
+            "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg/captures/cpt_mNepDkEtco6ah3QNPUGYH",
+            "type": "application/hal+json"
+          },
+          "payment": {
+            "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg",
+            "type": "application/hal+json"
+          }
+        }
+      }
+    ],
+    "chargebacks": [
+      {
+        "resource": "chargeback",
+        "id": "chb_ls7ahg",
+        "amount": {
+          "value": "10.00",
+          "currency": "EUR"
+        },
+        "created_at": "2022-01-03T13:20:37+00:00",
+        "payment_id": "tr_WDqYK6vllg",
+        "settlement_amount": {
+          "value": "-10.00",
+          "currency": "EUR"
+        },
+        "_links": {
+          "self": {
+            "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg/chargebacks/chb_ls7ahg",
+            "type": "application/hal+json"
+          },
+          "payment": {
+            "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg",
+            "type": "application/hal+json"
+          }
+        }
+      }
+    ],
+    "refunds": [
+      {
+        "resource": "refund",
+        "id": "re_vD3Jm32wQt",
+        "mode": "test",
+        "amount": {
+          "value": "329.99",
+          "currency": "EUR"
+        },
+        "status": "pending",
+        "createdAt": "2019-01-15T15:41:21+00:00",
+        "description": "Required quantity not in stock, refunding one photo book.",
+        "metadata": null,
+        "paymentId": "tr_WDqYK6vllg",
+        "settlementAmount": {
+          "value": "-329.99",
+          "currency": "EUR"
+        },
+        "_links": {
+          "self": {
+            "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg/refunds/re_vD3Jm32wQt",
+            "type": "application/hal+json"
+          },
+          "payment": {
+            "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg",
+            "type": "application/hal+json"
+          }
+        }
+      }
+    ]
+  },
+  "_links": {
+    "self": {
+      "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg",
+      "type": "application/hal+json"
+    },
+    "checkout": {
+      "href": "https://www.mollie.com/payscreen/select-method/WDqYK6vllg",
+      "type": "text/html"
+    },
+    "documentation": {
+      "href": "https://docs.mollie.com/reference/v2/payments-api/get-payment",
+      "type": "text/html"
+    }
+  }
+}

data/test/mollie/payment_test.rb

@@ -2,6 +2,8 @@ require 'helper'
 
 module Mollie
   class PaymentTest < Test::Unit::TestCase
+    GET_PAYMENT_WITH_EMBEDDED_RESOURCES = read_fixture('payments/get_embedded_resources.json')
+
     def test_setting_attributes
       attributes = {
         resource:   'payment',
@@ -233,6 +235,36 @@ module Mollie
       assert_equal 'NL', payment.restrict_payment_methods_to_country
     end
 
+    def test_embedded_captures
+      stub_request(:get, 'https://api.mollie.com/v2/payments/tr_WDqYK6vllg?embed=captures')
+        .to_return(status: 200, body: GET_PAYMENT_WITH_EMBEDDED_RESOURCES, headers: {})
+
+      payment = Payment.get('tr_WDqYK6vllg', embed: 'captures')
+
+      assert_equal 'cpt_mNepDkEtco6ah3QNPUGYH', payment.captures.first.id
+      assert_equal 1, payment.captures.size
+    end
+
+    def test_embedded_chargebacks
+      stub_request(:get, 'https://api.mollie.com/v2/payments/tr_WDqYK6vllg?embed=chargebacks')
+        .to_return(status: 200, body: GET_PAYMENT_WITH_EMBEDDED_RESOURCES, headers: {})
+
+      payment = Payment.get('tr_WDqYK6vllg', embed: 'chargebacks')
+
+      assert_equal 'chb_ls7ahg', payment.chargebacks.first.id
+      assert_equal 1, payment.chargebacks.size
+    end
+
+    def test_embedded_refunds
+      stub_request(:get, 'https://api.mollie.com/v2/payments/tr_WDqYK6vllg?embed=refunds')
+        .to_return(status: 200, body: GET_PAYMENT_WITH_EMBEDDED_RESOURCES, headers: {})
+
+      payment = Payment.get('tr_WDqYK6vllg', embed: 'refunds')
+
+      assert_equal 're_vD3Jm32wQt', payment.refunds.first.id
+      assert_equal 1, payment.refunds.size
+    end
+
     def test_list_refunds
       stub_request(:get, 'https://api.mollie.com/v2/payments/pay-id/refunds')
         .to_return(status: 200, body: %({"_embedded" : {"refunds" : [{"id":"ref-id", "payment_id":"pay-id"}]}}), headers: {})

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mollie-api-ruby
 version: !ruby/object:Gem::Version
-  version: 4.15.0
+  version: 4.16.0
 platform: ruby
 authors:
 - Mollie B.V.
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-01 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct
@@ -304,6 +303,7 @@ files:
 - test/fixtures/payment_links/list.json
 - test/fixtures/payment_links/update.json
 - test/fixtures/payments/get.json
+- test/fixtures/payments/get_embedded_resources.json
 - test/fixtures/refunds/get.json
 - test/fixtures/shipments/create.json
 - test/fixtures/shipments/get.json
@@ -355,7 +355,6 @@ licenses:
 - BSD
 metadata:
   changelog_uri: https://github.com/mollie/mollie-api-ruby/blob/master/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -370,8 +369,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Official Mollie API Client for Ruby
 test_files:
@@ -408,6 +406,7 @@ test_files:
 - test/fixtures/payment_links/list.json
 - test/fixtures/payment_links/update.json
 - test/fixtures/payments/get.json
+- test/fixtures/payments/get_embedded_resources.json
 - test/fixtures/refunds/get.json
 - test/fixtures/shipments/create.json
 - test/fixtures/shipments/get.json