mollie-api-ruby 4.13.0 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58916be713b9cf5128476188f1b0e61dc51f04d9e41b48b09c053b923e9daf39
-  data.tar.gz: 2f514f685d55211565be7197d5b9b36e587894582bdc515f4eb75ce19c481f10
+  metadata.gz: 06f14768975850db4a88530cf6cfbe4d4b80f274c2616736ba6af908e83a044c
+  data.tar.gz: d7eae71e95f7d0b06646fcc39b069658dc0d808874654fdfd9b2353f1af70d3c
 SHA512:
-  metadata.gz: f3dd1ed54bf737169dbd652f3314ce258c03a87d3b73ed0f8e2473ff2acfef1c08cd5b06349d370f564ee318964a78757978fc948d975f6e0733b1d60a69ff52
-  data.tar.gz: cad4e544c9cb525bbc94d1a4caf5585590456345ec1bd74fe08f4fe73a5292d4c721b7df2226f6721311487f3ef319bc69d8664863ca864792399cd48f067669
+  metadata.gz: d450cb135d44a6b17b51cdb5921aa03fa9a3796c540b427fb8796251177c776f5d3541f4bccf10739f1bf17fdc65611a318ae6ed17938718d915d487000ac435
+  data.tar.gz: 9a8fad769b51f90ecf0a4d464661b5e22cda7304b32388091019bb754d66eed1abe731f598547778e8357e302500f32a33a2c740a60b725625e03ed261ec29a2

data/.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0']
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
 
     name: Ruby (${{ matrix.ruby-version }})
     steps:

data/CHANGELOG.md

@@ -4,7 +4,19 @@
 
 All notable changes to this project will be documented in this file.
 
-## 4.13.0 - 2023-05-22
+## 4.15.0 - 2024-12-01
+
+  - (f659c19) Add Balance API
+
+## 4.14.0 - 2024-11-02
+
+  - (0876f2b) Add Payment Links API
+  - (9ab5e1b) Fix dependency warnings (#176)
+  - (87a6c9a) Update supported payment methods
+  - (afb6251) IMP-610: Use correct authorize URL
+  - (002708c) changelog_uri to gemspec
+
+## 4.13.0 - 2024-05-22
 
   - (09489be) Add HTTP response details to RequestError
   - (fe5d114) Add Terminals API

data/README.md

@@ -1,9 +1,9 @@
 <p align="center">
-  <img src="https://info.mollie.com/hubfs/github/ruby/logo.png" width="128" height="128"/>
+  <img src="https://github.com/mollie/mollie-api-ruby/assets/39294/5d35df48-e5c0-4de6-8541-159d9d8aa6f6.png" width="128" height="128"/>
 </p>
 <h1 align="center">Mollie API client for Ruby</h1>
 
-<img src="https://info.mollie.com/hubfs/github/ruby/editor.png" />
+<img src="https://github.com/mollie/mollie-api-ruby/assets/39294/4838e149-4707-41c7-9aeb-bb86e68adc2c.png" />
 
 > LOOKING FOR VERSION v2.2.X README? [CLICK HERE](https://github.com/mollie/mollie-api-ruby/tree/v2.2.1)
 
@@ -24,11 +24,11 @@ To use the Mollie API client, the following things are required:
 
 ## Installation
 
-By far the easiest way to install the Mollie API client is to install it with [gem](http://rubygems.org/). Note: v4.8.0 and higher are not published on rubygems.org, see [GH-140](https://github.com/mollie/mollie-api-ruby/issues/140) for details.
+By far the easiest way to install the Mollie API client is to install it with [gem](http://rubygems.org/).
 
 ```
 # Gemfile
-gem "mollie-api-ruby", github: "mollie/mollie-api-ruby", tag: "v4.11.0"
+gem "mollie-api-ruby"
 
 $ gem install mollie-api-ruby
 ```

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/examples/connect/authorize.rb

@@ -5,7 +5,7 @@ client = Rack::OAuth2::Client.new(
   secret:                 secret,
   state:                  'some_state',
   redirect_uri:           redirect_url,
-  authorization_endpoint: 'https://www.mollie.com/oauth2/authorize',
+  authorization_endpoint: 'https://my.mollie.com/oauth2/authorize',
   token_endpoint:         'https://api.mollie.com/oauth2/tokens'
 )
 

data/examples/connect/tokens.rb

@@ -5,7 +5,7 @@ client = Rack::OAuth2::Client.new(
   secret:                 secret,
   state:                  'some_state',
   redirect_uri:           redirect_url,
-  authorization_endpoint: 'https://www.mollie.com/oauth2/authorize',
+  authorization_endpoint: 'https://my.mollie.com/oauth2/authorize',
   token_endpoint:         'https://api.mollie.com/oauth2/tokens'
 )
 

data/examples/payment-links/create.rb

@@ -0,0 +1,5 @@
+payment_link = Mollie::PaymentLink.create(
+  description: "Bicycle tires",
+  amount: { currency: "EUR", value: "24.95" }
+)
+

data/examples/payment-links/delete.rb

@@ -0,0 +1 @@
+Mollie::PaymentLink.delete("pl_4Y0eZitmBnQ6IDoMqZQKh")

data/examples/payment-links/get.rb

@@ -0,0 +1 @@
+payment_link = Mollie::PaymentLink.get("pl_4Y0eZitmBnQ6IDoMqZQKh")

data/examples/payment-links/list-payments.rb

@@ -0,0 +1,2 @@
+payment_link = Mollie::PaymentLink.get("pl_4Y0eZitmBnQ6IDoMqZQKh")
+payments = payment_link.payments

data/examples/payment-links/list.rb

@@ -0,0 +1 @@
+payment_links = Mollie::PaymentLink.all

data/examples/payment-links/update.rb

@@ -0,0 +1,5 @@
+payment_link = Mollie::PaymentLink.update(
+  "pl_4Y0eZitmBnQ6IDoMqZQKh",
+  description: "Bicycle tires",
+  archived: true
+)

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/base.rb

@@ -71,6 +71,8 @@ module Mollie
           path.last
         end
       end
+
+      alias_method :embedded_resource_name, :resource_name
     end
 
     def update(data = {})

data/lib/mollie/list.rb

@@ -9,7 +9,7 @@ module Mollie
       @klass = klass
 
       list_attributes['items'] ||= if list_attributes['_embedded']
-                                     list_attributes['_embedded'].fetch(klass.resource_name, [])
+                                     list_attributes['_embedded'].fetch(klass.embedded_resource_name, [])
                                    else
                                      []
                                    end

data/lib/mollie/method.rb

@@ -1,21 +1,33 @@
 module Mollie
   class Method < Base
+    ALMA           = 'alma'.freeze
     APPLEPAY       = 'applepay'.freeze
     BANCONTACT     = 'bancontact'.freeze
+    BANCOMAT_PAY   = 'bancomatpay'.freeze
     BANKTRANSFER   = 'banktransfer'.freeze
     BELFIUS        = 'belfius'.freeze
+    BILLIE         = 'billie'.freeze
+    BLIK           = 'bilk'.freeze
     CREDITCARD     = 'creditcard'.freeze
     DIRECTDEBIT    = 'directdebit'.freeze
     EPS            = 'eps'.freeze
     GIFTCARD       = 'giftcard'.freeze
     GIROPAY        = 'giropay'.freeze
     IDEAL          = 'ideal'.freeze
+    IN3            = 'in3'.freeze
     INGHOMEPAY     = 'inghomepay'.freeze
     KBC            = 'kbc'.freeze
+    MYBANK         = 'mybank'.freeze
     PAYPAL         = 'paypal'.freeze
     PAYSAFECARD    = 'paysafecard'.freeze
     PRZELEWY24     = 'przelewy24'.freeze
+    RIVERTY        = 'riverty'.freeze
     SOFORT         = 'sofort'.freeze
+    SATISPAY       = 'satispay'.freeze
+    TRUSTLY        = 'trustly'.freeze
+    TWINT          = 'twint'.freeze
+    VOUCHER        = 'voucher'.freeze
+    KLARNA         = 'klarna'.freeze
     KLARNASLICEIT  = 'klarnasliceit'.freeze
     KLARNAPAYLATER = 'klarnapaylater'.freeze
 

data/lib/mollie/payment_link.rb

@@ -0,0 +1,70 @@
+module Mollie
+  class PaymentLink < Base
+    attr_accessor :id,
+      :mode,
+      :description,
+      :archived,
+      :redirect_url,
+      :webhook_url,
+      :profile_id,
+      :_links
+
+    attr_reader :amount,
+      :created_at,
+      :paid_at,
+      :updated_at,
+      :expires_at
+
+    alias_method :links, :_links
+
+    def self.embedded_resource_name(_parent_id = nil)
+      "payment_links"
+    end
+
+    def self.resource_name(_parent_id = nil)
+      "payment-links"
+    end
+
+    def amount=(amount)
+      @amount = Mollie::Amount.new(amount)
+    end
+
+    def archived?
+      archived
+    end
+
+    def created_at=(created_at)
+      @created_at = Time.parse(created_at.to_s)
+    end
+
+    def paid_at=(paid_at)
+      @paid_at = Time.parse(paid_at.to_s)
+    rescue
+      nil
+    end
+
+    def updated_at=(updated_at)
+      @updated_at = Time.parse(updated_at.to_s)
+    rescue
+      nil
+    end
+
+    def expires_at=(expires_at)
+      @expires_at = Time.parse(expires_at.to_s)
+    rescue
+      nil
+    end
+
+    def payment_link
+      Util.extract_url(links, "payment_link")
+    end
+
+    def payments(options = {})
+      resource_url = Util.extract_url(links, "self")
+      payments_url = File.join(resource_url, "/payments")
+
+      response = Mollie::Client.instance.perform_http_call("GET", payments_url, nil, {}, options)
+      Mollie::List.new(response, Mollie::Payment)
+    end
+  end
+end

data/lib/mollie/version.rb

@@ -1,3 +1,3 @@
 module Mollie
-  VERSION = '4.13.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'
@@ -23,6 +24,7 @@ require 'mollie/order'
 require 'mollie/organization'
 require 'mollie/partner'
 require 'mollie/payment'
+require 'mollie/payment_link'
 require 'mollie/permission'
 require 'mollie/profile'
 require 'mollie/refund'
@@ -30,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/mollie-api-ruby.gemspec

@@ -16,11 +16,18 @@ Gem::Specification.new do |s|
   s.email = ['info@mollie.com']
   s.homepage = 'https://github.com/mollie/mollie-api-ruby'
   s.license = 'BSD'
-  s.required_ruby_version = '>= 2.3.8'
+  s.metadata = {
+    'changelog_uri' => 'https://github.com/mollie/mollie-api-ruby/blob/master/CHANGELOG.md'
+  }
+
+  s.required_ruby_version = '>= 2.5'
 
   s.files = `git ls-files`.split("\n")
   s.test_files = Dir['test/**/*']
 
+  s.add_dependency('ostruct', '~> 0.6.0')
+  s.add_dependency('bigdecimal', '~> 3.1', '>= 3.1.8')
+
   s.add_development_dependency('rake')
   s.add_development_dependency('rubocop', '~> 0.57.2')
   s.add_development_dependency('test-unit')

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"
+    }
+  }
+}