mollie-api-ruby 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74f551510fa882249e3224bd53e50334ccce5d9f4538b0c9fdf94cd86eb25bd1
-  data.tar.gz: 2208eac855cb783b5183c4b64f604ce9981b2196eeaa92cdfd71061b0e98a56a
+  metadata.gz: 58916be713b9cf5128476188f1b0e61dc51f04d9e41b48b09c053b923e9daf39
+  data.tar.gz: 2f514f685d55211565be7197d5b9b36e587894582bdc515f4eb75ce19c481f10
 SHA512:
-  metadata.gz: 50eb679501ae91cdf624127d13d5e45be32624864c166c3ff75fff563e0accc9e24874142b279c019b48f848f061e87c18f3c8092a34120588ca869de7e01498
-  data.tar.gz: 54cd23ca6361f723a622d00b05724373632f2ab395dcb51d8343e37467c0a14d7da23b758cd127fc7340c0e7bdd57fea837a1cfaa0b18eb0fb0a8889d1fd3c7c
+  metadata.gz: f3dd1ed54bf737169dbd652f3314ce258c03a87d3b73ed0f8e2473ff2acfef1c08cd5b06349d370f564ee318964a78757978fc948d975f6e0733b1d60a69ff52
+  data.tar.gz: cad4e544c9cb525bbc94d1a4caf5585590456345ec1bd74fe08f4fe73a5292d4c721b7df2226f6721311487f3ef319bc69d8664863ca864792399cd48f067669

data/.github/workflows/push.yml

@@ -0,0 +1,27 @@
+name: Publish gem
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+*
+
+jobs:
+  publish:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+    
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## 4.13.0 - 2023-05-22
+
+  - (09489be) Add HTTP response details to RequestError
+  - (fe5d114) Add Terminals API
+
 ## 4.12.0 - 2023-01-29
 
   - (f180b47) Add support for idempotency keys

data/Rakefile

@@ -1,3 +1,5 @@
+require 'bundler/gem_tasks'
+
 task default: %w[test]
 
 task :test do

data/examples/terminals/get.rb

@@ -0,0 +1 @@
+terminal = Mollie::Terminal.get("term_7MgL4wea46qkRcoTZjWEH")

data/examples/terminals/list.rb

@@ -0,0 +1 @@
+terminals = Mollie::Terminal.all

data/lib/mollie/client.rb

@@ -130,11 +130,11 @@ module Mollie
         {} # No Content
       when 404
         json = JSON.parse(response.body)
-        exception = ResourceNotFoundError.new(json)
+        exception = ResourceNotFoundError.new(json, response)
         raise exception
       else
         json = JSON.parse(response.body)
-        exception = Mollie::RequestError.new(json)
+        exception = Mollie::RequestError.new(json, response)
         raise exception
       end
     end

data/lib/mollie/exception.rb

@@ -5,17 +5,30 @@ module Mollie
   class RequestError < Mollie::Exception
     attr_accessor :status, :title, :detail, :field, :links
 
-    def initialize(error)
+    def initialize(error, response = nil)
       exception.status = error['status']
       exception.title  = error['title']
       exception.detail = error['detail']
       exception.field  = error['field']
       exception.links  = error['_links']
+      self.response = response
     end
 
     def to_s
       "#{status} #{title}: #{detail}"
     end
+
+    def http_headers
+      response.to_hash if response
+    end
+
+    def http_body
+      response.body if response
+    end
+
+    private
+
+    attr_accessor :response
   end
 
   class ResourceNotFoundError < RequestError

data/lib/mollie/terminal.rb

@@ -0,0 +1,59 @@
+module Mollie
+  class Terminal < Base
+
+    STATUS_PENDING   = "pending".freeze
+    STATUS_ACTIVE    = "active".freeze
+    STATUS_INACTIVE  = "inactive".freeze
+
+    attr_accessor :id,
+                  :profile_id,
+                  :status,
+                  :brand,
+                  :model,
+                  :serial_number,
+                  :currency,
+                  :description,
+                  :created_at,
+                  :updated_at,
+                  :deactivated_at,
+                  :_links
+
+    alias links _links
+
+    def pending?
+      status == STATUS_PENDING
+    end
+
+    def active?
+      status == STATUS_ACTIVE
+    end
+
+    def inactive?
+      status == STATUS_INACTIVE
+    end
+
+    def created_at=(created_at)
+      @created_at = begin
+                      Time.parse(created_at.to_s)
+                    rescue StandardError
+                      nil
+                    end
+    end
+
+    def updated_at=(updated_at)
+      @updated_at = begin
+                      Time.parse(updated_at.to_s)
+                    rescue StandardError
+                      nil
+                    end
+    end
+
+    def deactivated_at=(deactivated_at)
+      @deactivated_at = begin
+                          Time.parse(deactivated_at.to_s)
+                        rescue StandardError
+                          nil
+                        end
+    end
+  end
+end

data/lib/mollie/version.rb

@@ -1,3 +1,3 @@
 module Mollie
-  VERSION = '4.12.0'.freeze
+  VERSION = '4.13.0'.freeze
 end

data/lib/mollie.rb

@@ -28,6 +28,7 @@ require 'mollie/profile'
 require 'mollie/refund'
 require 'mollie/settlement'
 require 'mollie/subscription'
+require 'mollie/terminal'
 
 require 'mollie/customer/mandate'
 require 'mollie/customer/payment'

data/test/fixtures/terminals/get.json

@@ -0,0 +1,23 @@
+{
+    "id": "term_7MgL4wea46qkRcoTZjWEH",
+    "profileId": "pfl_QkEhN94Ba",
+    "status": "active",
+    "brand": "PAX",
+    "model": "A920",
+    "serialNumber": "1234567890",
+    "currency": "EUR",
+    "description": "Terminal #12345",
+    "createdAt": "2022-02-12T11:58:35.0Z",
+    "updatedAt": "2022-11-15T13:32:11+00:00",
+    "deactivatedAt": "2022-02-12T12:13:35.0Z",
+    "_links": {
+        "self": {
+            "href": "https://api.mollie.com/v2/terminals/term_7MgL4wea46qkRcoTZjWEH",
+            "type": "application/hal+json"
+        },
+        "documentation": {
+            "href": "https://docs.mollie.com/reference/v2/terminals-api/get-terminal",
+            "type": "text/html"
+        }
+    }
+}

data/test/fixtures/terminals/list.json

@@ -0,0 +1,34 @@
+{
+    "count": 3,
+    "_embedded": {
+        "terminals": [
+            {
+                "resource": "terminal",
+                "id": "terminal_one"
+            },
+            {
+                "resource": "terminal",
+                "id": "terminal_two"
+            },
+            {
+                "resource": "terminal",
+                "id": "terminal_three"
+            }
+        ]
+    },
+    "_links": {
+        "self": {
+            "href": "https://api.mollie.com/v2/terminals",
+            "type": "application/hal+json"
+        },
+        "previous": null,
+        "next": {
+            "href": "https://api.mollie.com/v2/terminals?from=term_7MgL4wea46qkRcoTZjWEH",
+            "type": "application/hal+json"
+        },
+        "documentation": {
+            "href": "https://docs.mollie.com/reference/v2/terminals-api/list-terminals",
+            "type": "text/html"
+        }
+    }
+}

data/test/mollie/base_test.rb

@@ -44,6 +44,7 @@ module Mollie
       assert_equal 'my-id', resource.id
       assert_equal 'object-id', resource.testobject_id
     end
+
     def test_get_with_invalid_identifiers
       assert_raises(Mollie::Exception) { TestObject.get(nil) }
       assert_raises(Mollie::Exception) { TestObject.get(" ") }

data/test/mollie/exception_test.rb

@@ -0,0 +1,87 @@
+require 'helper'
+
+module Mollie
+  class ExceptionTest < Test::Unit::TestCase
+    def test_attributes
+      stub_request(:post, 'https://api.mollie.com/v2/payments')
+        .to_return(status: 422, headers: { "Content-Type" => "application/hal+json}" }, body: %(
+          {
+              "status": 422,
+              "title": "Unprocessable Entity",
+              "detail": "The amount is higher than the maximum",
+              "field": "amount",
+              "_links": {
+                 "documentation": {
+                      "href": "https://docs.mollie.com/errors",
+                      "type": "text/html"
+                  }
+              }
+          }
+        ))
+
+      exception = assert_raise(Mollie::RequestError) do
+        Mollie::Payment.create(
+          amount:       { value: "1000000000.00", currency: "EUR" },
+          description:  "Order #66",
+          redirect_url: "https://www.example.org/payment/completed",
+        )
+      end
+
+      assert_equal 422, exception.status
+      assert_equal "Unprocessable Entity", exception.title
+      assert_equal "The amount is higher than the maximum", exception.detail
+      assert_equal "amount", exception.field
+      assert_equal "https://docs.mollie.com/errors", exception.links["documentation"]["href"]
+      assert_equal "text/html", exception.links["documentation"]["type"]
+    end
+
+    def test_exception_message
+      stub_request(:get, 'https://api.mollie.com/v2/payments/tr_WDqYK6vllg')
+        .to_return(status: 401, headers: { "Content-Type" => "application/hal+json}" }, body: %(
+          {
+              "status": 401,
+              "title": "Unauthorized Request",
+              "detail": "Missing authentication, or failed to authenticate",
+              "_links": {
+                  "documentation": {
+                      "href": "https://docs.mollie.com/overview/authentication",
+                      "type": "text/html"
+                  }
+              }
+          }
+        ))
+
+      exception = assert_raise(Mollie::RequestError) { Payment.get('tr_WDqYK6vllg') }
+      assert_equal '401 Unauthorized Request: Missing authentication, or failed to authenticate', exception.message
+    end
+
+    def test_http_attributes
+      body = %({
+        "status": 422,
+        "title": "Unprocessable Entity",
+        "detail": "The amount is higher than the maximum",
+        "field": "amount",
+        "_links": {
+          "documentation": {
+            "href": "https://docs.mollie.com/errors",
+            "type": "text/html"
+          }
+        }
+      })
+
+      stub_request(:post, 'https://api.mollie.com/v2/payments')
+        .to_return(status: 422, headers: { "Content-Type" => "application/hal+json" }, body: body)
+
+      exception = assert_raise(Mollie::RequestError) do
+        Mollie::Payment.create(
+          amount:       { value: "1000000000.00", currency: "EUR" },
+          description:  "Order #66",
+          redirect_url: "https://www.example.org/payment/completed",
+        )
+      end
+
+      assert_equal({ "content-type" => ["application/hal+json"] }, exception.http_headers)
+      assert_equal(body, exception.http_body)
+    end
+  end
+end

data/test/mollie/terminal_test.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+module Mollie
+  class TerminalTest < Test::Unit::TestCase
+    GET_TERMINAL = read_fixture('terminals/get.json')
+    LIST_TERMINALS = read_fixture('terminals/list.json')
+
+    def test_get_terminal
+      stub_request(:get, "https://api.mollie.com/v2/terminals/term_7MgL4wea46qkRcoTZjWEH")
+        .to_return(status: 200, body: GET_TERMINAL, headers: {})
+
+      terminal = Terminal.get("term_7MgL4wea46qkRcoTZjWEH")
+
+      assert_equal "term_7MgL4wea46qkRcoTZjWEH", terminal.id
+      assert_equal "pfl_QkEhN94Ba", terminal.profile_id
+      assert_equal "active", terminal.status
+      assert_equal "PAX", terminal.brand
+      assert_equal "A920", terminal.model
+      assert_equal "1234567890", terminal.serial_number
+      assert_equal "EUR", terminal.currency
+      assert_equal "Terminal #12345", terminal.description
+      assert_equal Time.parse("2022-02-12T11:58:35.0Z"), terminal.created_at
+      assert_equal Time.parse("2022-11-15T13:32:11+00:00"), terminal.updated_at
+      assert_equal Time.parse("2022-02-12T12:13:35.0Z"), terminal.deactivated_at
+    end
+
+    def test_status_pending
+      assert Terminal.new(status: Terminal::STATUS_PENDING).pending?
+      assert !Terminal.new(status: "not-pending").pending?
+    end
+
+    def test_status_active
+      assert Terminal.new(status: Terminal::STATUS_ACTIVE).active?
+      assert !Terminal.new(status: "not-active").active?
+    end
+
+    def test_status_inactive
+      assert Terminal.new(status: Terminal::STATUS_INACTIVE).inactive?
+      assert !Terminal.new(status: "not-inactive").inactive?
+    end
+
+    def test_list_terminals
+      stub_request(:get, "https://api.mollie.com/v2/terminals")
+        .to_return(status: 200, body: LIST_TERMINALS, headers: {})
+
+      terminals = Terminal.all
+
+      assert_equal 3, terminals.size
+      assert_equal "terminal_one", terminals[0].id
+      assert_equal "terminal_two", terminals[1].id
+      assert_equal "terminal_three", terminals[2].id
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mollie-api-ruby
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.13.0
 platform: ruby
 authors:
 - Mollie B.V.
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-25 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,6 +81,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/build.yml"
 - ".github/workflows/codeql.yml"
+- ".github/workflows/push.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -180,6 +181,8 @@ files:
 - examples/subscriptions/get.rb
 - examples/subscriptions/list.rb
 - examples/subscriptions/update.rb
+- examples/terminals/get.rb
+- examples/terminals/list.rb
 - lib/cacert.pem
 - lib/mollie-api-ruby.rb
 - lib/mollie.rb
@@ -216,6 +219,7 @@ files:
 - lib/mollie/settlement/payment.rb
 - lib/mollie/settlement/refund.rb
 - lib/mollie/subscription.rb
+- lib/mollie/terminal.rb
 - lib/mollie/util.rb
 - lib/mollie/version.rb
 - mollie-api-ruby.gemspec
@@ -250,6 +254,8 @@ files:
 - test/fixtures/shipments/update.json
 - test/fixtures/subscriptions/get.json
 - test/fixtures/subscriptions/get_payments.json
+- test/fixtures/terminals/get.json
+- test/fixtures/terminals/list.json
 - test/helper.rb
 - test/mollie/amount_test.rb
 - test/mollie/base_test.rb
@@ -259,6 +265,7 @@ files:
 - test/mollie/customer/payment_test.rb
 - test/mollie/customer/subscription_test.rb
 - test/mollie/customer_test.rb
+- test/mollie/exception_test.rb
 - test/mollie/invoice_test.rb
 - test/mollie/list_test.rb
 - test/mollie/method_test.rb
@@ -280,13 +287,14 @@ files:
 - test/mollie/settlement/payment_test.rb
 - test/mollie/settlement/refund_test.rb
 - test/mollie/settlement_test.rb
+- test/mollie/terminal_test.rb
 - test/mollie/util_test.rb
 - test/run-test.rb
 homepage: https://github.com/mollie/mollie-api-ruby
 licenses:
 - BSD
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -301,8 +309,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
-signing_key:
+rubygems_version: 3.5.9
+signing_key: 
 specification_version: 4
 summary: Official Mollie API Client for Ruby
 test_files:
@@ -337,6 +345,8 @@ test_files:
 - test/fixtures/shipments/update.json
 - test/fixtures/subscriptions/get.json
 - test/fixtures/subscriptions/get_payments.json
+- test/fixtures/terminals/get.json
+- test/fixtures/terminals/list.json
 - test/helper.rb
 - test/mollie/amount_test.rb
 - test/mollie/base_test.rb
@@ -346,6 +356,7 @@ test_files:
 - test/mollie/customer/payment_test.rb
 - test/mollie/customer/subscription_test.rb
 - test/mollie/customer_test.rb
+- test/mollie/exception_test.rb
 - test/mollie/invoice_test.rb
 - test/mollie/list_test.rb
 - test/mollie/method_test.rb
@@ -367,5 +378,6 @@ test_files:
 - test/mollie/settlement/payment_test.rb
 - test/mollie/settlement/refund_test.rb
 - test/mollie/settlement_test.rb
+- test/mollie/terminal_test.rb
 - test/mollie/util_test.rb
 - test/run-test.rb