mollie-api-ruby 4.9.0 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daa3c6e8a7c880ce66a0207c1ea3785e013095d605ad0c3a39b52fe0675c0bab
-  data.tar.gz: 67135ecb024b74073aa35a0235a929d0a17c2f2ddf495d74eb47afc098963653
+  metadata.gz: 1d80bc70f4fab363a9546ef3d08b7ce81d0d67a0bc9bfc4f5ae81f2e55fdb853
+  data.tar.gz: e10228e454d164a725c0d977cff690f17f4cdf8d2ad4f85c28c81059ae12bb6d
 SHA512:
-  metadata.gz: 8b7deb45b0c8537e38f4f72640398eb93a9a90108fefa9930b2575f8cb9e3c03cbaacdab2e37062d318cedbabe73d4f37a662627440605c1967388026763c015
-  data.tar.gz: 1d18195babbf2b7a4204849e1ff4fcaf57ce49fbaec01fe238d43cadb2319f01cab3fd08bdad56e745bbcac6748358e33730b564e2b5667f9f8ab3307780a252
+  metadata.gz: 313a6f14d2fd5f0ea96f3234a27eb8bbdd334ef7053fb290f416b5f13ceb29b8a9cf15809e37ec103db6d1721f334c39f1962eab3029814f3e404cc812a5b20a
+  data.tar.gz: 5fb49b6d256cc78d63c7ed41eaf9e1478c1a6ac8c413fb92e66cf2c3d2a58417b2c55435f228f0e600bcadaecd71f71a45c29d592f6d39e9659fa3ea21405ef0

data/.github/workflows/build.yml

@@ -0,0 +1,25 @@
+name: build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0']
+
+    name: Ruby (${{ matrix.ruby-version }})
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Run tests
+      run: bundle install && bundle exec rake test

data/CHANGELOG.md

@@ -4,6 +4,24 @@
 
 All notable changes to this project will be documented in this file.
 
+## 4.10.0 - 2021-11-20
+
+:warning: The `Profile#category_code` attribute is deprecated and will be removed in 2022. Please use the `business_category` parameter instead.
+
+  - (f0e695c) Order: add methods to retrieve embedded resources
+  - (e16864c) Order: add class to create order payments
+  - (5175cd3) Profile: add `business_category` attribute
+  - (3d2e370) Payment: add `amount_charged_back` attribute
+  - (3d6b403) Fix assignment method for `amount_captured`
+  - (37280c3) Migrate from Travis CI to GitHub Actions
+  - (33bb6bb) Add example to update orderlines
+  - (c70dbf6) fix: orderline update returns incorrect class
+  - (ca5935d) Add example to retrieve all available payment methods
+  - (457b853) Add "List all payment methods" API
+  - (9d8eebc) Method: add status attribute (#147)
+  - (506d52e) fix: Include parent resource in pagination calls
+  - (7e3b98d) Fix onboarding dashboard URL.
+
 ## 4.9.0 - 2020-05-17
 
   - Settlement: add `captures` helper method.

data/README.md

@@ -10,7 +10,7 @@
 > LOOKING FOR VERSION v3.1.X README? [CLICK HERE](https://github.com/mollie/mollie-api-ruby/tree/v3.1.6)
 
 [![Gem Version](https://badge.fury.io/rb/mollie-api-ruby.svg)](https://badge.fury.io/rb/mollie-api-ruby)
-[![](https://travis-ci.org/mollie/mollie-api-ruby.png)](https://travis-ci.org/mollie/mollie-api-ruby)
+[![Build Status](https://github.com/mollie/mollie-api-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/mollie/mollie-api-ruby/actions/workflows/build.yml)
 
 Accepting [iDEAL](https://www.mollie.com/en/payments/ideal), [Bancontact](https://www.mollie.com/en/payments/bancontact), [SOFORT Banking](https://www.mollie.com/en/payments/sofort), [Creditcard](https://www.mollie.com/en/payments/credit-card), [SEPA Bank transfer](https://www.mollie.com/en/payments/bank-transfer), [SEPA Direct debit](https://www.mollie.com/en/payments/direct-debit), [PayPal](https://www.mollie.com/en/payments/paypal), [KBC/CBC Payment Button](https://www.mollie.com/en/payments/kbc-cbc), [Belfius Direct Net](https://www.mollie.com/en/payments/belfius), [paysafecard](https://www.mollie.com/en/payments/paysafecard), [ING Home’Pay](https://www.mollie.com/en/payments/ing-homepay), [Gift cards](https://www.mollie.com/en/payments/gift-cards), [EPS](https://www.mollie.com/en/payments/eps), [Giropay](https://www.mollie.com/en/payments/giropay) and [Apple Pay](https://www.mollie.com/en/payments/apple-pay) online payments without fixed monthly costs or any punishing registration procedures. Just use the Mollie API to receive payments directly on your website or easily refund transactions to your customers.
 

data/examples/methods/list.rb

@@ -2,3 +2,7 @@ methods = Mollie::Method.all
 
 # Filter by amount and currency
 methods = Mollie::Method.all(amount: { value: '100.00', currency: 'EUR' })
+
+# Retrieve all payment methods that Mollie offers and can be activated by
+# the Organization.
+methods = Mollie::Method.all_available

data/examples/orders/create-payment.rb

@@ -0,0 +1 @@
+payment = Mollie::Order::Payment.create(order_id: "ord_kEn1PlbGa")

data/examples/orders/get.rb

@@ -1 +1,4 @@
-order = Mollie::Order.get('ord_kEn1PlbGa')
+order = Mollie::Order.get("ord_kEn1PlbGa")
+
+# Embed related resources
+order = Mollie::Order.get("ord_kEn1PlbGa", embed: "payments,refunds,shipments")

data/examples/orders/update-orderline.rb

@@ -0,0 +1,7 @@
+orderline_id = "odl_dgtxyl"
+
+order = Mollie::Order::Line.update(
+  orderline_id,
+  order_id: "ord_kEn1PlbGa",
+  sku: "new-sku-12345678"
+)

data/examples/profiles/create.rb

@@ -1,8 +1,8 @@
 profile = Mollie::Profile.create(
-  name:         'My website name',
-  website:      'https://www.mywebsite.com',
-  email:        'info@mywebsite.com',
-  phone:        '+31208202070',
-  categoryCode: '5399',
-  mode:         'live'
+  name:              'My website name',
+  website:           'https://www.mywebsite.com',
+  email:             'info@mywebsite.com',
+  phone:             '+31208202070',
+  business_category: 'OTHER_MERCHANDISE',
+  mode:              'live'
 )

data/lib/mollie/list.rb

@@ -38,7 +38,8 @@ module Mollie
       href = URI.parse(links['next']['href'])
       query = URI.decode_www_form(href.query).to_h
 
-      klass.all(options.merge(query))
+      response = Mollie::Client.instance.perform_http_call('GET', links['next']['href'], nil, {}, options.merge(query))
+      self.class.new(response, klass)
     end
 
     def previous(options = {})
@@ -47,7 +48,8 @@ module Mollie
       href = URI.parse(links['previous']['href'])
       query = URI.decode_www_form(href.query).to_h
 
-      klass.all(options.merge(query))
+      response = Mollie::Client.instance.perform_http_call('GET', links['previous']['href'], nil, {}, options.merge(query))
+      self.class.new(response, klass)
     end
   end
 end

data/lib/mollie/method.rb

@@ -25,7 +25,13 @@ module Mollie
                   :maximum_amount,
                   :image,
                   :issuers,
-                  :pricing
+                  :pricing,
+                  :status
+
+    def self.all_available(options = {})
+      response = Client.instance.perform_http_call("GET", "methods", "all", {}, options)
+      Mollie::List.new(response, Mollie::Method)
+    end
 
     def minimum_amount=(minimum_amount)
       @minimum_amount = Mollie::Amount.new(minimum_amount)

data/lib/mollie/onboarding.rb

@@ -20,7 +20,7 @@ module Mollie
     end
 
     def dashboard
-      Util.extract_url(links, 'onboarding')
+      Util.extract_url(links, 'dashboard')
     end
 
     def organization(options = {})

data/lib/mollie/order/line.rb

@@ -29,6 +29,10 @@ module Mollie
 
       alias links _links
 
+      def self.update(id, data = {})
+        request('PATCH', id, data) { |response| Order.new(response) }
+      end
+
       def cancelable?
         is_cancelable == true
       end

data/lib/mollie/order/payment.rb

@@ -0,0 +1,6 @@
+module Mollie
+  class Order
+    class Payment < ::Mollie::Payment
+    end
+  end
+end

data/lib/mollie/order.rb

@@ -130,8 +130,36 @@ module Mollie
       @completed_at = Time.parse(completed_at.to_s)
     end
 
+    def payments
+      resources = (attributes['_embedded']['payments'] if attributes['_embedded'])
+
+      if resources.nil?
+        List.new({}, Order::Payment)
+      else
+        List.new({ '_embedded' => { 'payments' => resources } }, Order::Payment)
+      end
+    end
+
     def refunds(options = {})
-      Order::Refund.all(options.merge(order_id: id))
+      resources = (attributes['_embedded']['refunds'] if attributes['_embedded'])
+
+      if resources.nil?
+        # To avoid breaking changes, fallback to /v2/order/*orderId*/refunds
+        # if the order was retrieved without embedded refunds.
+        Order::Refund.all(options.merge(order_id: id))
+      else
+        List.new({ '_embedded' => { 'refunds' => resources } }, Order::Refund)
+      end
+    end
+
+    def shipments
+      resources = (attributes['_embedded']['shipments'] if attributes['_embedded'])
+
+      if resources.nil?
+        List.new({}, Order::Shipment)
+      else
+        List.new({ '_embedded' => { 'shipments' => resources } }, Order::Shipment)
+      end
     end
 
     def refund!(options = {})

data/lib/mollie/payment.rb

@@ -25,6 +25,7 @@ module Mollie
                   :failed_at,
                   :amount,
                   :amount_captured,
+                  :amount_charged_back,
                   :amount_refunded,
                   :amount_remaining,
                   :description,
@@ -167,10 +168,14 @@ module Mollie
       @settlement_amount = Mollie::Amount.new(settlement_amount)
     end
 
-    def amount_captured
+    def amount_captured=(amount_captured)
       @amount_captured = Mollie::Amount.new(amount_captured)
     end
 
+    def amount_charged_back=(amount_charged_back)
+      @amount_charged_back = Mollie::Amount.new(amount_charged_back)
+    end
+
     def amount_remaining=(amount_remaining)
       @amount_remaining = Mollie::Amount.new(amount_remaining)
     end

data/lib/mollie/profile.rb

@@ -24,7 +24,9 @@ module Mollie
                   :website,
                   :email,
                   :phone,
-                  :category_code,
+                  :business_category,
+                  :category_code, # This parameter is deprecated and will be removed in 2022.
+                                  # Please use the businessCategory parameter instead.
                   :status,
                   :review,
                   :created_at,

data/lib/mollie/version.rb

@@ -1,3 +1,3 @@
 module Mollie
-  VERSION = '4.9.0'.freeze
+  VERSION = '4.10.0'.freeze
 end

data/lib/mollie.rb

@@ -33,6 +33,7 @@ require 'mollie/customer/payment'
 require 'mollie/customer/subscription'
 require 'mollie/onboarding'
 require 'mollie/order/line'
+require 'mollie/order/payment'
 require 'mollie/order/refund'
 require 'mollie/order/shipment'
 require 'mollie/payment/capture'

data/test/fixtures/customer/get.json

@@ -0,0 +1,36 @@
+{
+    "resource": "customer",
+    "id": "cst_8wmqcHMN4U",
+    "mode": "test",
+    "name": "Customer A",
+    "email": "customer@example.org",
+    "locale": "nl_NL",
+    "metadata": null,
+    "createdAt": "2018-04-06T13:23:21.0Z",
+    "_links": {
+        "self": {
+            "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U",
+            "type": "application/hal+json"
+        },
+        "dashboard": {
+            "href": "https://www.mollie.com/dashboard/org_123456789/customers/cst_8wmqcHMN4U",
+            "type": "text/html"
+        },
+        "mandates": {
+            "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/mandates",
+            "type": "application/hal+json"
+        },
+        "subscriptions": {
+            "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/subscriptions",
+            "type": "application/hal+json"
+        },
+        "payments": {
+            "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/payments",
+            "type": "application/hal+json"
+        },
+        "documentation": {
+            "href": "https://docs.mollie.com/reference/v2/customers-api/get-customer",
+            "type": "text/html"
+        }
+    }
+}

data/test/fixtures/customer/list-payments-next.json

@@ -0,0 +1,30 @@
+{
+    "count": 2,
+    "_embedded": {
+        "payments": [
+            {
+                "resource": "payment",
+                "id":"tr_3"
+            },
+            {
+                "resource": "payment",
+                "id":"tr_4"
+            }
+        ]
+    },
+    "_links": {
+        "documentation": {
+            "href": "https://docs.mollie.com/reference/v2/customers-api/list-customer-payments",
+            "type": "text/html"
+        },
+        "self": {
+            "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/payments?from=tr_3&limit=2",
+            "type": "application/hal+json"
+        },
+        "previous": {
+            "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/payments?from=tr_1&limit=2",
+            "type": "application/hal+json"
+        },
+        "next": null
+    }
+}

data/test/fixtures/customer/list-payments.json

@@ -0,0 +1,30 @@
+{
+    "count": 2,
+    "_embedded": {
+        "payments": [
+            {
+                "resource": "payment",
+                "id":"tr_1"
+            },
+            {
+                "resource": "payment",
+                "id":"tr_2"
+            }
+        ]
+    },
+    "_links": {
+        "documentation": {
+            "href": "https://docs.mollie.com/reference/v2/customers-api/list-customer-payments",
+            "type": "text/html"
+        },
+        "self": {
+            "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/payments?limit=2",
+            "type": "application/hal+json"
+        },
+        "previous": null,
+        "next": {
+            "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/payments?from=tr_3&limit=2",
+            "type": "application/hal+json"
+        }
+    }
+}

data/test/fixtures/methods/all.json

@@ -0,0 +1,92 @@
+{
+    "count": 3,
+    "_embedded": {
+        "methods": [
+            {
+                "resource": "method",
+                "id": "ideal",
+                "description": "iDEAL",
+                "minimumAmount": {
+                    "value": "0.01",
+                    "currency": "EUR"
+                },
+                "maximumAmount": {
+                    "value": "50000.00",
+                    "currency": "EUR"
+                },
+                "image": {
+                    "size1x": "https://www.mollie.com/external/icons/payment-methods/ideal.png",
+                    "size2x": "https://www.mollie.com/external/icons/payment-methods/ideal%402x.png",
+                    "svg": "https://www.mollie.com/external/icons/payment-methods/ideal.svg"
+                },
+                "status": "pending-boarding",
+                "_links": {
+                    "self": {
+                        "href": "https://api.mollie.com/v2/methods/ideal",
+                        "type": "application/hal+json"
+                    }
+                }
+            },
+            {
+                "resource": "method",
+                "id": "creditcard",
+                "description": "Credit card",
+                "minimumAmount": {
+                    "value": "0.01",
+                    "currency": "EUR"
+                },
+                "maximumAmount": {
+                    "value": "2000.00",
+                    "currency": "EUR"
+                },
+                "image": {
+                    "size1x": "https://www.mollie.com/external/icons/payment-methods/creditcard.png",
+                    "size2x": "https://www.mollie.com/external/icons/payment-methods/creditcard%402x.png",
+                    "svg": "https://www.mollie.com/external/icons/payment-methods/creditcard.svg"
+                },
+                "status": "pending-boarding",
+                "_links": {
+                    "self": {
+                        "href": "https://api.mollie.com/v2/methods/creditcard",
+                        "type": "application/hal+json"
+                    }
+                }
+            },
+            {
+                "resource": "method",
+                "id": "bancontact",
+                "description": "Bancontact",
+                "minimumAmount": {
+                    "value": "0.02",
+                    "currency": "EUR"
+                },
+                "maximumAmount": {
+                    "value": "50000.00",
+                    "currency": "EUR"
+                },
+                "image": {
+                    "size1x": "https://www.mollie.com/external/icons/payment-methods/bancontact.png",
+                    "size2x": "https://www.mollie.com/external/icons/payment-methods/bancontact%402x.png",
+                    "svg": "https://www.mollie.com/external/icons/payment-methods/bancontact.svg"
+                },
+                "status": null,
+                "_links": {
+                    "self": {
+                        "href": "https://api.mollie.com/v2/methods/bancontact",
+                        "type": "application/hal+json"
+                    }
+                }
+            }
+        ]
+    },
+    "_links": {
+        "documentation": {
+            "href": "https://docs.mollie.com/reference/v2/methods-api/list-all-methods",
+            "type": "text/html"
+        },
+        "self": {
+            "href": "https://api.mollie.com/v2/methods/all",
+            "type": "application/hal+json"
+        }
+    }
+}

data/test/fixtures/onboarding/me.json

@@ -10,7 +10,7 @@
             "href": "https://api.mollie.com/v2/onboarding/me",
             "type": "application/hal+json"
         },
-        "onboarding": {
+        "dashboard": {
             "href": "https://www.mollie.com/dashboard/onboarding",
             "type": "text/html"
         },

data/test/fixtures/orders/create_payment.json

@@ -0,0 +1,38 @@
+{
+    "resource": "payment",
+    "id": "tr_ncaPcAhuUV",
+    "mode": "live",
+    "createdAt": "2018-09-07T12:00:05+00:00",
+    "amount": {
+        "value": "1027.99",
+        "currency": "EUR"
+    },
+    "description": "Order #1337 (Lego cars)",
+    "method": null,
+    "metadata": null,
+    "status": "open",
+    "isCancelable": false,
+    "locale": "nl_NL",
+    "profileId": "pfl_URR55HPMGx",
+    "orderId": "ord_kEn1PlbGa",
+    "sequenceType": "oneoff",
+    "redirectUrl": "https://example.org/redirect",
+    "_links": {
+        "self": {
+            "href": "https://api.mollie.com/v2/payments/tr_ncaPcAhuUV",
+            "type": "application/hal+json"
+        },
+        "checkout": {
+            "href": "https://www.mollie.com/payscreen/select-method/ncaPcAhuUV",
+            "type": "text/html"
+        },
+        "dashboard": {
+            "href": "https://www.mollie.com/dashboard/org_123456789/payments/tr_ncaPcAhuUV",
+            "type": "text/html"
+        },
+        "order": {
+            "href": "https://api.mollie.com/v2/orders/ord_kEn1PlbGa",
+            "type": "application/hal+json"
+        }
+    }
+}

data/test/fixtures/orders/get.json

@@ -171,44 +171,6 @@
             }
         }
     ],
-    "_embedded": {
-        "payments": [
-            {
-                "resource": "payment",
-                "id": "tr_ncaPcAhuUV",
-                "mode": "live",
-                "createdAt": "2018-09-07T12:00:05+00:00",
-                "amount": {
-                    "value": "1027.99",
-                    "currency": "EUR"
-                },
-                "description": "Order #1337 (Lego cars)",
-                "method": null,
-                "metadata": null,
-                "status": "open",
-                "isCancelable": false,
-                "locale": "nl_NL",
-                "profileId": "pfl_URR55HPMGx",
-                "orderId": "ord_kEn1PlbGa",
-                "sequenceType": "oneoff",
-                "redirectUrl": "https://example.org/redirect",
-                "_links": {
-                    "self": {
-                        "href": "https://api.mollie.com/v2/payments/tr_ncaPcAhuUV",
-                        "type": "application/hal+json"
-                    },
-                    "checkout": {
-                        "href": "https://www.mollie.com/payscreen/select-method/ncaPcAhuUV",
-                        "type": "text/html"
-                    },
-                    "order": {
-                        "href": "https://api.mollie.com/v2/orders/ord_kEn1PlbGa",
-                        "type": "application/hal+json"
-                    }
-                }
-            }
-        ]
-    },
     "_links": {
         "self": {
             "href": "https://api.mollie.com/v2/orders/ord_kEn1PlbGa",