adyen-ruby-api-library 8.0.1 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 270b6ef403bd4388caeb109a653a812cb08a5ebca358f2524ddec2fb66f78133
-  data.tar.gz: e6c6eaf7eb56b10d02ba59955b504205f23c6c1793955aae2cb500e715a52aab
+  metadata.gz: 5a19405ed4decf65ccbb07223e8b69e56bd0bc5c0b03673159334d7bd7a47cb2
+  data.tar.gz: 51db3e77404a7ce0b91dd9c78aa00472e839d378cc2e3bbdcff0325443327c4c
 SHA512:
-  metadata.gz: 18302f40daecf83d3fd54a9c56df1906f5682a50b48d75fec756f0fb17a7c79697b9cb4a209d724d4d0a176d2c909b079e8c10f983ac7e2a473bfcbf157a9189
-  data.tar.gz: 70edb1785ca54271a9a32c1c1fa35bcee5d3e9cef6b36da96a3f611b9411d12422568ea80f2079ea9826f7666e77036a6ebfceeaa43216a8da492d6062b000c9
+  metadata.gz: a7b3119d610f63ab83ae68994e6cdcf1c6411f4a511d4f0ed7361a8542bc55b0a29d127d05d8f160eab148e7eaafb556dc5f08a63be235c39bc3bc95944b0f92
+  data.tar.gz: 73becdd9922b5a91bd995cdbb3231566a0deb1e0c0aaa15940eee19f9c043a9004900dac865fda4ff2f9da6079e2fc3d557ddd976cfed6c3e5a8142da6c4edb4

data/.github/workflows/codeql.yml

@@ -27,15 +27,15 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: ${{ matrix.language }}
           queries: +security-and-quality
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
+        uses: github/codeql-action/autobuild@v3
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3
         with:
           category: "/language:${{ matrix.language }}"

data/.github/workflows/gh_release.yml

@@ -12,7 +12,7 @@ jobs:
   github:
     permissions:
       contents: write
-    uses: Adyen/release-automation-action/.github/workflows/reusable-github-release.yml@v1.1.1
+    uses: Adyen/release-automation-action/.github/workflows/reusable-github-release.yml@v2.0.0
     with:
       release-title: Adyen Ruby API Library
       develop-branch: main

data/VERSION

@@ -1,2 +1,2 @@
-8.0.1
+9.1.0
 

data/lib/adyen/services/balancePlatform/balance_accounts_api.rb

@@ -34,15 +34,6 @@ module Adyen
       @client.call_adyen_api(@service, action, {}, headers, @version)
     end
 
-    def get_all_payment_instruments_for_balance_account(id, headers: {}, query_params: {})
-      endpoint = '/balanceAccounts/{id}/paymentInstruments'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
-      endpoint += create_query_string(query_params)
-      action = { method: 'get', url: endpoint }
-      @client.call_adyen_api(@service, action, {}, headers, @version)
-    end
-
     def get_all_sweeps_for_balance_account(balance_account_id, headers: {}, query_params: {})
       endpoint = '/balanceAccounts/{balanceAccountId}/sweeps'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')
@@ -61,6 +52,15 @@ module Adyen
       @client.call_adyen_api(@service, action, {}, headers, @version)
     end
 
+    def get_payment_instruments_linked_to_balance_account(id, headers: {}, query_params: {})
+      endpoint = '/balanceAccounts/{id}/paymentInstruments'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      endpoint += create_query_string(query_params)
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
     def get_sweep(balance_account_id, sweep_id, headers: {})
       endpoint = '/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')

data/lib/adyen/services/balancePlatform/card_orders_api.rb

@@ -0,0 +1,29 @@
+require_relative '../service'
+module Adyen
+  class CardOrdersApi < Service
+    attr_accessor :service, :version
+
+    def initialize(client, version = DEFAULT_VERSION)
+      super(client, version, 'BalancePlatform')
+    end
+
+    def get_card_order_items(id, headers: {}, query_params: {})
+      endpoint = '/cardorders/{id}/items'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      endpoint += create_query_string(query_params)
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    def list_card_orders(headers: {}, query_params: {})
+      endpoint = '/cardorders'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      endpoint += create_query_string(query_params)
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+  end
+end

data/lib/adyen/services/balancePlatform/manage_card_pin_api.rb

@@ -0,0 +1,38 @@
+require_relative '../service'
+module Adyen
+  class ManageCardPINApi < Service
+    attr_accessor :service, :version
+
+    def initialize(client, version = DEFAULT_VERSION)
+      super(client, version, 'BalancePlatform')
+    end
+
+    def change_card_pin(request, headers: {})
+      endpoint = '/pins/change'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+    def public_key(headers: {}, query_params: {})
+      endpoint = '/publicKey'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      endpoint += create_query_string(query_params)
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    def reveal_card_pin(request, headers: {})
+      endpoint = '/pins/reveal'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+  end
+end

data/lib/adyen/services/balancePlatform/payment_instruments_api.rb

@@ -52,6 +52,15 @@ module Adyen
       @client.call_adyen_api(@service, action, {}, headers, @version)
     end
 
+    def reveal_data_of_payment_instrument(request, headers: {})
+      endpoint = '/paymentInstruments/reveal'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
     def update_payment_instrument(request, id, headers: {})
       endpoint = '/paymentInstruments/{id}'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')

data/lib/adyen/services/balancePlatform.rb

@@ -1,8 +1,10 @@
 require_relative 'balancePlatform/account_holders_api'
 require_relative 'balancePlatform/balance_accounts_api'
 require_relative 'balancePlatform/bank_account_validation_api'
+require_relative 'balancePlatform/card_orders_api'
 require_relative 'balancePlatform/grant_accounts_api'
 require_relative 'balancePlatform/grant_offers_api'
+require_relative 'balancePlatform/manage_card_pin_api'
 require_relative 'balancePlatform/network_tokens_api'
 require_relative 'balancePlatform/payment_instrument_groups_api'
 require_relative 'balancePlatform/payment_instruments_api'
@@ -33,6 +35,10 @@ module Adyen
       @bank_account_validation_api ||= Adyen::BankAccountValidationApi.new(@client, @version)
     end
 
+    def card_orders_api
+      @card_orders_api ||= Adyen::CardOrdersApi.new(@client, @version)
+    end
+
     def grant_accounts_api
       @grant_accounts_api ||= Adyen::GrantAccountsApi.new(@client, @version)
     end
@@ -41,6 +47,10 @@ module Adyen
       @grant_offers_api ||= Adyen::GrantOffersApi.new(@client, @version)
     end
 
+    def manage_card_pin_api
+      @manage_card_pin_api ||= Adyen::ManageCardPINApi.new(@client, @version)
+    end
+
     def network_tokens_api
       @network_tokens_api ||= Adyen::NetworkTokensApi.new(@client, @version)
     end

data/lib/adyen/services/checkout/donations_api.rb

@@ -0,0 +1,20 @@
+require_relative '../service'
+module Adyen
+  class DonationsApi < Service
+    attr_accessor :service, :version
+
+    def initialize(client, version = DEFAULT_VERSION)
+      super(client, version, 'Checkout')
+    end
+
+    def donations(request, headers: {})
+      endpoint = '/donations'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+  end
+end

data/lib/adyen/services/checkout/payments_api.rb

@@ -16,15 +16,6 @@ module Adyen
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
 
-    def donations(request, headers: {})
-      endpoint = '/donations'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint)
-      
-      action = { method: 'post', url: endpoint }
-      @client.call_adyen_api(@service, action, request, headers, @version)
-    end
-
     def get_result_of_payment_session(session_id, headers: {}, query_params: {})
       endpoint = '/sessions/{sessionId}'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')

data/lib/adyen/services/checkout.rb

@@ -1,4 +1,5 @@
 require_relative 'checkout/classic_checkout_sdk_api'
+require_relative 'checkout/donations_api'
 require_relative 'checkout/modifications_api'
 require_relative 'checkout/orders_api'
 require_relative 'checkout/payment_links_api'
@@ -21,6 +22,10 @@ module Adyen
       @classic_checkout_sdk_api ||= Adyen::ClassicCheckoutSDKApi.new(@client, @version)
     end
 
+    def donations_api
+      @donations_api ||= Adyen::DonationsApi.new(@client, @version)
+    end
+
     def modifications_api
       @modifications_api ||= Adyen::ModificationsApi.new(@client, @version)
     end

data/lib/adyen/services/transfers/transfers_api.rb

@@ -7,10 +7,10 @@ module Adyen
       super(client, version, 'Transfers')
     end
 
-    def return_transfer(request, id, headers: {})
-      endpoint = '/transfers/{id}/returns'.gsub(/{.+?}/, '%s')
+    def return_transfer(request, transfer_id, headers: {})
+      endpoint = '/transfers/{transferId}/returns'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = format(endpoint, transfer_id)
       
       action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)

data/lib/adyen/utils/hmac_validator.rb

@@ -15,7 +15,8 @@ module Adyen
 
       def valid_webhook_hmac?(webhook_request_item, hmac_key)
         expected_sign = calculate_webhook_hmac(webhook_request_item, hmac_key)
-        merchant_sign = fetch(webhook_request_item, 'additionalData.hmacSignature')
+        merchant_sign =
+          webhook_request_item.dig('additionalData', 'hmacSignature')
 
         expected_sign == merchant_sign
       end
@@ -29,29 +30,20 @@ module Adyen
       def calculate_webhook_hmac(webhook_request_item, hmac_key)
         data = data_to_sign(webhook_request_item)
 
-        Base64.strict_encode64(OpenSSL::HMAC.digest(HMAC_ALGORITHM, [hmac_key].pack('H*'), data))
+        Base64.strict_encode64(
+          OpenSSL::HMAC.digest(HMAC_ALGORITHM, [hmac_key].pack('H*'), data)
+        )
       end
 
+      # TODO: Deprecate instead of aliasing
+      alias valid_notification_hmac? valid_webhook_hmac?
+      alias calculate_notification_hmac calculate_webhook_hmac
 
       def data_to_sign(webhook_request_item)
-        data = WEBHOOK_VALIDATION_KEYS.map { |key| fetch(webhook_request_item, key).to_s }
-                                    .join(DATA_SEPARATOR)
-      end
-
-      private
-
-      def fetch(hash, keys)
-        value = hash
-        keys.to_s.split('.').each do |key|
-          value = if key.to_i.to_s == key
-                    value[key.to_i]
-                  else
-                    value[key].nil? ? value[key.to_sym] : value[key]
-                  end
-          break if value.nil?
-        end
-
-        value
+        WEBHOOK_VALIDATION_KEYS
+          .map { webhook_request_item.dig(*_1.split('.')).to_s }
+          .compact
+          .join(DATA_SEPARATOR)
       end
     end
   end

data/lib/adyen/version.rb

@@ -1,4 +1,4 @@
 module Adyen
   NAME = 'adyen-ruby-api-library'.freeze
-  VERSION = '8.0.1'.freeze
+  VERSION = '9.1.0'.freeze
 end

data/spec/utils/hmac_validator_spec.rb

@@ -6,19 +6,19 @@ RSpec.describe Adyen::Utils::HmacValidator do
   let(:expected_sign) { 'coqCmt/IZ4E3CzPvMY8zTjQVL5hYJUiBRg8UU+iCWo0=' }
   let(:webhook_request_item) do
     {
-      additionalData: {
-        hmacSignature: expected_sign
+      'additionalData' => {
+        'hmacSignature' => expected_sign
       },
-      amount: {
-        value: 1130,
-        currency: 'EUR'
+      'amount' => {
+        'value' => 1130,
+        'currency' => 'EUR'
       },
-      pspReference: '7914073381342284',
-      eventCode: 'AUTHORISATION',
-      merchantAccountCode: 'TestMerchant',
-      merchantReference: 'TestPayment-1407325143704',
-      paymentMethod: 'visa',
-      success: 'true'
+      'pspReference' => '7914073381342284',
+      'eventCode' => 'AUTHORISATION',
+      'merchantAccountCode' => 'TestMerchant',
+      'merchantReference' => 'TestPayment-1407325143704',
+      'paymentMethod' => 'visa',
+      'success' => 'true'
     }
   end
 
@@ -44,22 +44,22 @@ RSpec.describe Adyen::Utils::HmacValidator do
     end
 
     it 'should validate backslashes correctly' do
-      webhook = JSON.parse(json_from_file("mocks/responses/Webhooks/backslash_webhook.json"))
+      webhook = JSON.parse(json_from_file('mocks/responses/Webhooks/backslash_webhook.json'))
       expect(validator.valid_webhook_hmac?(webhook, '74F490DD33F7327BAECC88B2947C011FC02D014A473AAA33A8EC93E4DC069174')).to be true
     end
 
     it 'should validate colons correctly' do
-      webhook = JSON.parse(json_from_file("mocks/responses/Webhooks/colon_webhook.json"))
+      webhook = JSON.parse(json_from_file('mocks/responses/Webhooks/colon_webhook.json'))
       expect(validator.valid_webhook_hmac?(webhook, '74F490DD33F7327BAECC88B2947C011FC02D014A473AAA33A8EC93E4DC069174')).to be true
     end
 
     it 'should validate forward slashes correctly' do
-      webhook = JSON.parse(json_from_file("mocks/responses/Webhooks/forwardslash_webhook.json"))
+      webhook = JSON.parse(json_from_file('mocks/responses/Webhooks/forwardslash_webhook.json'))
       expect(validator.valid_webhook_hmac?(webhook, '74F490DD33F7327BAECC88B2947C011FC02D014A473AAA33A8EC93E4DC069174')).to be true
     end
 
     it 'should validate mix of slashes and colon correctly' do
-      webhook = JSON.parse(json_from_file("mocks/responses/Webhooks/mixed_webhook.json"))
+      webhook = JSON.parse(json_from_file('mocks/responses/Webhooks/mixed_webhook.json'))
       expect(validator.valid_webhook_hmac?(webhook, '74F490DD33F7327BAECC88B2947C011FC02D014A473AAA33A8EC93E4DC069174')).to be true
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adyen-ruby-api-library
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 9.1.0
 platform: ruby
 authors:
 - Adyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-19 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -87,7 +87,6 @@ files:
 - ".github/workflows/release.yml"
 - ".github/workflows/ruby.yml"
 - ".github/workflows/rubygems_release.yml"
-- ".github/workflows/services.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
@@ -125,8 +124,10 @@ files:
 - lib/adyen/services/balancePlatform/account_holders_api.rb
 - lib/adyen/services/balancePlatform/balance_accounts_api.rb
 - lib/adyen/services/balancePlatform/bank_account_validation_api.rb
+- lib/adyen/services/balancePlatform/card_orders_api.rb
 - lib/adyen/services/balancePlatform/grant_accounts_api.rb
 - lib/adyen/services/balancePlatform/grant_offers_api.rb
+- lib/adyen/services/balancePlatform/manage_card_pin_api.rb
 - lib/adyen/services/balancePlatform/network_tokens_api.rb
 - lib/adyen/services/balancePlatform/payment_instrument_groups_api.rb
 - lib/adyen/services/balancePlatform/payment_instruments_api.rb
@@ -136,6 +137,7 @@ files:
 - lib/adyen/services/binLookup.rb
 - lib/adyen/services/checkout.rb
 - lib/adyen/services/checkout/classic_checkout_sdk_api.rb
+- lib/adyen/services/checkout/donations_api.rb
 - lib/adyen/services/checkout/modifications_api.rb
 - lib/adyen/services/checkout/orders_api.rb
 - lib/adyen/services/checkout/payment_links_api.rb
@@ -442,7 +444,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Official Adyen  Ruby API Library

data/.github/workflows/services.yml

@@ -1,28 +0,0 @@
-name: Ruby Library Services Generation
-
-on: [ workflow_dispatch ]
-
-jobs:
-  generate:
-    runs-on: ubuntu-latest
-    name: Generate Services
-    steps:
-      - uses: actions/checkout@v4
-      - run: make allServices
-      - name: Set PR variables
-        id: vars
-        run: |
-          echo ::set-output name=pr_title::"Update services"
-          echo ::set-output name=pr_body::"OpenAPI spec or templates produced new services on $(date +%d-%m-%Y) \
-            by [commit](https://github.com/Adyen/adyen-openapi/commit/$(git rev-parse HEAD))."
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v5
-        with:
-          token: ${{ secrets.ADYEN_AUTOMATION_BOT_ACCESS_TOKEN }}
-          committer: ${{ secrets.ADYEN_AUTOMATION_BOT_EMAIL }}
-          author: ${{ secrets.ADYEN_AUTOMATION_BOT_EMAIL }}
-          base: main
-          branch: automation/services
-          title: ${{ steps.vars.outputs.pr_title }}
-          body: ${{ steps.vars.outputs.pr_body }}
-          add-paths: lib/adyen/services