mollie-api-ruby 4.10.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d80bc70f4fab363a9546ef3d08b7ce81d0d67a0bc9bfc4f5ae81f2e55fdb853
-  data.tar.gz: e10228e454d164a725c0d977cff690f17f4cdf8d2ad4f85c28c81059ae12bb6d
+  metadata.gz: 74f551510fa882249e3224bd53e50334ccce5d9f4538b0c9fdf94cd86eb25bd1
+  data.tar.gz: 2208eac855cb783b5183c4b64f604ce9981b2196eeaa92cdfd71061b0e98a56a
 SHA512:
-  metadata.gz: 313a6f14d2fd5f0ea96f3234a27eb8bbdd334ef7053fb290f416b5f13ceb29b8a9cf15809e37ec103db6d1721f334c39f1962eab3029814f3e404cc812a5b20a
-  data.tar.gz: 5fb49b6d256cc78d63c7ed41eaf9e1478c1a6ac8c413fb92e66cf2c3d2a58417b2c55435f228f0e600bcadaecd71f71a45c29d592f6d39e9659fa3ea21405ef0
+  metadata.gz: 50eb679501ae91cdf624127d13d5e45be32624864c166c3ff75fff563e0accc9e24874142b279c019b48f848f061e87c18f3c8092a34120588ca869de7e01498
+  data.tar.gz: 54cd23ca6361f723a622d00b05724373632f2ab395dcb51d8343e37467c0a14d7da23b758cd127fc7340c0e7bdd57fea837a1cfaa0b18eb0fb0a8889d1fd3c7c

data/.github/workflows/codeql.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '30 20 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.travis.yml

@@ -8,7 +8,7 @@ deploy:
   gem: mollie-api-ruby
   provider: rubygems
   api_key:
-    secure: "JdYKjK+AZNNviyAW92ta16Kk/u1gLTyvUVjoiSrGchsMmx8pN107MERpn5klFzOTKcnmMn+h3eA0RzhsuA+eFBfd5X58kNlXzXzKzKvOKmjrH69jiUWAJ5PmepacvsKMCAovOOtkskFzifKUUkrkPv87KO1J97wsZ4ASX6q3MRs="
+    secure: "OQobSXpfwELzuh5prnwADPGwt3LHyD/EMuKlJ7aJ6CNveGQzvgGOtK52Cn3X9X8yAkX/PNJVXnPeFaKSQopcAJB30ySJMnPYGjQvIoiUOglMB8lJDFxcLtZ/21NXDf2f3cxYPmZkBGtFQeb/EEYBg4/vwjgWlJ/mcwnesLpwj5A="
   on:
     tags: true
     repo: mollie/mollie-api-ruby

data/CHANGELOG.md

@@ -4,6 +4,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## 4.12.0 - 2023-01-29
+
+  - (f180b47) Add support for idempotency keys
+  - (f0a47d1) Payment: add support for cancel_url
+  - (9db60b3) Order: add support for cancel_url
+  - (2f88990) Require non-empty ID when fetching a resource
+
+## 4.11.0 - 2022-03-01
+
+  - (1ef339e) Add Partner API
+
 ## 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.

data/README.md

@@ -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/).
+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.
 
 ```
 # Gemfile
-gem 'mollie-api-ruby'
+gem "mollie-api-ruby", github: "mollie/mollie-api-ruby", tag: "v4.11.0"
 
 $ gem install mollie-api-ruby
 ```

data/examples/organisations/get-partner.rb

@@ -0,0 +1 @@
+partner = Mollie::Partner.current

data/lib/mollie/base.rb

@@ -30,6 +30,8 @@ module Mollie
       end
 
       def get(id, options = {})
+        raise Mollie::Exception, "Invalid resource ID: #{id.inspect}" if id.nil? || id.strip.empty?
+
         request('GET', id, {}, options) do |response|
           new(response)
         end

data/lib/mollie/client.rb

@@ -72,6 +72,7 @@ module Mollie
 
       api_key      = http_body.delete(:api_key) || query.delete(:api_key) || @api_key
       api_endpoint = http_body.delete(:api_endpoint) || query.delete(:api_endpoint) || @api_endpoint
+      idempotency_key = http_body.delete(:idempotency_key) || query.delete(:idempotency_key)
 
       unless query.empty?
         camelized_query = Util.camelize_keys(query)
@@ -110,6 +111,10 @@ module Mollie
       request['Authorization'] = "Bearer #{api_key}"
       request['User-Agent']    = @version_strings.join(' ')
 
+      if http_method == 'POST' && idempotency_key
+        request['Idempotency-Key'] = idempotency_key
+      end
+
       begin
         response = client.request(request)
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,

data/lib/mollie/order.rb

@@ -25,6 +25,7 @@ module Mollie
                   :locale,
                   :metadata,
                   :redirect_url,
+                  :cancel_url,
                   :webhook_url,
                   :created_at,
                   :expires_at,

data/lib/mollie/partner.rb

@@ -0,0 +1,52 @@
+module Mollie
+  class Partner < Base
+    attr_accessor :partner_type,
+                  :is_commission_partner,
+                  :partner_contract_signed_at,
+                  :partner_contract_update_available,
+                  :_links
+
+    attr_reader :user_agent_tokens
+
+    alias links _links
+
+    def self.current(options = {})
+      response = Client.instance.perform_http_call('GET', 'organizations/me/partner', nil, {}, options)
+      new(response)
+    end
+
+    def type
+      partner_type
+    end
+
+    def commission_partner?
+      is_commission_partner
+    end
+
+    def contract_signed_at
+      @contract_signed_at = begin
+        Time.parse(partner_contract_signed_at)
+      rescue StandardError
+        nil
+      end
+    end
+
+    def contract_update_available?
+      partner_contract_update_available
+    end
+
+    def user_agent_tokens=(tokens)
+      @user_agent_tokens = tokens.map do |token|
+        OpenStruct.new(
+          token: token['token'],
+          starts_at: Time.parse(token['starts_at']),
+          ends_at: (Time.parse(token['ends_at']) unless token['ends_at'].nil?)
+        )
+      end
+    end
+
+    def signuplink
+      Util.extract_url(links, 'signuplink')
+    end
+  end
+end

data/lib/mollie/payment.rb

@@ -46,6 +46,7 @@ module Mollie
                   :_links,
                   :details,
                   :redirect_url,
+                  :cancel_url,
                   :webhook_url
 
     alias links _links

data/lib/mollie/version.rb

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

data/lib/mollie.rb

@@ -21,6 +21,7 @@ require 'mollie/list'
 require 'mollie/method'
 require 'mollie/order'
 require 'mollie/organization'
+require 'mollie/partner'
 require 'mollie/payment'
 require 'mollie/permission'
 require 'mollie/profile'

data/test/fixtures/orders/get.json

@@ -49,6 +49,7 @@
         "email": "luke@skywalker.com"
     },
     "redirectUrl": "https://example.org/redirect",
+    "cancelUrl": "https://example.org/cancel",
     "webhookUrl": "https://example.org/webhook",
     "expiredAt": "2018-08-30T09:29:56+00:02",
     "paidAt": "2018-08-26T09:29:56+00:00",

data/test/fixtures/organizations/partner.json

@@ -0,0 +1,26 @@
+{
+    "resource": "partner",
+    "partnerType": "signuplink",
+    "isCommissionPartner": true,
+    "userAgentTokens": [{
+        "token": "unique-token",
+        "startsAt": "2018-03-20T13:13:37+00:00",
+        "endsAt": null
+    }],
+    "partnerContractSignedAt": "2018-03-20T13:13:37+00:00",
+    "partnerContractUpdateAvailable": true,
+    "_links": {
+        "self": {
+            "href": "https://api.mollie.com/v2/organizations/me/partner",
+            "type": "application/hal+json"
+        },
+        "documentation": {
+            "href": "https://docs.mollie.com/reference/v2/organizations-api/get-partner",
+            "type": "text/html"
+        },
+        "signuplink": {
+            "href": "https://www.mollie.com/dashboard/signup/myCode?lang=en",
+            "type": "text/html"
+        }
+    }
+}

data/test/mollie/base_test.rb

@@ -44,6 +44,13 @@ 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(" ") }
+      assert_raises(Mollie::Exception) { TestObject.get("   ") }
+      assert_raises(Mollie::Exception) { TestObject.get("\t") }
+      assert_raises(Mollie::Exception) { TestObject.get("\n") }
+    end
 
     def test_create
       stub_request(:post, 'https://api.mollie.com/v2/testobjects')

data/test/mollie/client_test.rb

@@ -53,6 +53,18 @@ module Mollie
       assert_equal 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM', Mollie::Client.instance.api_key
     end
 
+    def test_post_with_idempotency_key
+      stub_request(:post, 'https://api.mollie.com/v2/payments')
+        .with(headers: { "Idempotency-Key" => '91d42bd5-e47f-4f4a-b38e-99333b264e78' })
+        .to_return(status: 200, body: '{}', headers: {})
+
+      payment = Mollie::Payment.create(
+        amount: { value: '10.00', currency: 'EUR' },
+        redirect_url: 'https://webshop.example.org/order/12345/',
+        idempotency_key: '91d42bd5-e47f-4f4a-b38e-99333b264e78'
+      )
+    end
+
     def test_get_request_convert_to_camel_case
       stub_request(:get, 'https://api.mollie.com/v2/my-method?myParam=ok')
         .to_return(status: 200, body: '{}', headers: {})

data/test/mollie/order_test.rb

@@ -75,6 +75,7 @@ module Mollie
       assert_equal '1337', order.metadata.order_id
       assert_equal 'Lego cars', order.metadata.description
       assert_equal 'https://example.org/redirect', order.redirect_url
+      assert_equal 'https://example.org/cancel', order.cancel_url
       assert_equal 'https://example.org/webhook', order.webhook_url
       assert_equal Time.parse('2018-08-02T09:29:56+00:00'), order.created_at
       assert_equal Time.parse('2018-08-30T09:29:56+00:00'), order.expires_at

data/test/mollie/partner_test.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+module Mollie
+  class PartnerTest < Test::Unit::TestCase
+    def setup
+      stub_request(:get, 'https://api.mollie.com/v2/organizations/me/partner')
+        .to_return(status: 200, body: read_fixture('organizations/partner.json'), headers: {})
+    end
+
+    def test_class_type
+      partner = Partner.current
+      assert_equal Mollie::Partner, partner.class
+    end
+
+    def test_partner_type
+      partner = Partner.current
+      assert_equal 'signuplink', partner.type
+    end
+
+    def test_commision_partner
+      partner = Partner.current
+      assert partner.commission_partner?
+    end
+
+    def test_contract_signed_at
+      partner = Partner.current
+      assert_equal Time.parse('2018-03-20T13:13:37+00:00'), partner.contract_signed_at
+    end
+
+    def test_contract_update_available?
+      partner = Partner.current
+      assert partner.contract_update_available?
+    end
+
+    def test_signuplink
+      partner = Partner.current
+      assert_equal 'https://www.mollie.com/dashboard/signup/myCode?lang=en', partner.signuplink
+    end
+
+    def test_user_agent_tokens
+      token = Partner.current.user_agent_tokens.first
+      assert_equal 'unique-token', token.token
+      assert_equal Time.parse('2018-03-20T13:13:37+00:00'), token.starts_at
+      assert_nil nil, token.ends_at
+    end
+  end
+end

data/test/mollie/payment_test.rb

@@ -32,6 +32,7 @@ module Mollie
         profile_id:    'pfl_QkEhN94Ba',
         sequence_type: 'oneoff',
         redirect_url:  'https://webshop.example.org/order/12345',
+        cancel_url:    'https://webshop.example.org/payments/cancel',
         webhook_url:   'https://webshop.example.org/payments/webhook',
         _links:        {
           'self' => {
@@ -72,8 +73,9 @@ module Mollie
       assert_equal 'nl_NL', payment.locale
       assert_equal 'NL', payment.country_code
       assert_equal 'pfl_QkEhN94Ba', payment.profile_id
-      assert_equal 'https://webshop.example.org/payments/webhook', payment.webhook_url
       assert_equal 'https://webshop.example.org/order/12345', payment.redirect_url
+      assert_equal 'https://webshop.example.org/payments/cancel', payment.cancel_url
+      assert_equal 'https://webshop.example.org/payments/webhook', payment.webhook_url
       assert_equal 'https://www.mollie.com/payscreen/select-method/7UhSN1zuXS', payment.checkout_url
       assert_equal false, payment.cancelable?
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mollie-api-ruby
 version: !ruby/object:Gem::Version
-  version: 4.10.0
+  version: 4.12.0
 platform: ruby
 authors:
 - Mollie B.V.
@@ -80,6 +80,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build.yml"
+- ".github/workflows/codeql.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -131,6 +132,7 @@ files:
 - examples/orders/update-orderline.rb
 - examples/orders/update.rb
 - examples/organisations/get-current.rb
+- examples/organisations/get-partner.rb
 - examples/organisations/get.rb
 - examples/payments/create.rb
 - examples/payments/delete.rb
@@ -200,6 +202,7 @@ files:
 - lib/mollie/order/refund.rb
 - lib/mollie/order/shipment.rb
 - lib/mollie/organization.rb
+- lib/mollie/partner.rb
 - lib/mollie/payment.rb
 - lib/mollie/payment/capture.rb
 - lib/mollie/payment/chargeback.rb
@@ -238,6 +241,7 @@ files:
 - test/fixtures/orders/refund_all.json
 - test/fixtures/orders/update.json
 - test/fixtures/orders/update_line.json
+- test/fixtures/organizations/partner.json
 - test/fixtures/payments/get.json
 - test/fixtures/refunds/get.json
 - test/fixtures/shipments/create.json
@@ -264,6 +268,7 @@ files:
 - test/mollie/order/shipment_test.rb
 - test/mollie/order_test.rb
 - test/mollie/organization_test.rb
+- test/mollie/partner_test.rb
 - test/mollie/payment/capture_test.rb
 - test/mollie/payment/chargeback_test.rb
 - test/mollie/payment/refund_test.rb
@@ -323,6 +328,7 @@ test_files:
 - test/fixtures/orders/refund_all.json
 - test/fixtures/orders/update.json
 - test/fixtures/orders/update_line.json
+- test/fixtures/organizations/partner.json
 - test/fixtures/payments/get.json
 - test/fixtures/refunds/get.json
 - test/fixtures/shipments/create.json
@@ -349,6 +355,7 @@ test_files:
 - test/mollie/order/shipment_test.rb
 - test/mollie/order_test.rb
 - test/mollie/organization_test.rb
+- test/mollie/partner_test.rb
 - test/mollie/payment/capture_test.rb
 - test/mollie/payment/chargeback_test.rb
 - test/mollie/payment/refund_test.rb