adyen-ruby-api-library 9.3.0 → 9.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff449a394e4dd652d0efd6591ab71af8063e0177d13aae02e78c7bc3af7ddc4b
-  data.tar.gz: 707f7d2440f5fc78badd977b592b268e803733093c96d6884cf3a55367562faf
+  metadata.gz: 2bf587eb5a52ec919b8350e31713947a7054d6b4a04ba498cd022ef34c4b1d37
+  data.tar.gz: 8a87040a48a4c56185bb3d845f8e773d733ade4fedb698a1d9304bf57ede34b6
 SHA512:
-  metadata.gz: 8106d7ea42e37fb28ff345794bae7211fbc1780fadce4964c7e73fcc7f2cca08bbc2b13ac68377715d44e050c1936f4e22b9fdf713a16932263eea88109fb1a3
-  data.tar.gz: b5cadf38c7088d82876cb7502b4dcdf78042accf5b6f7f8b6a420169856a98ea51f37fb8ac1d1a508a3beaaecc337d55645d802c19a85e1254360389e8727e7d
+  metadata.gz: 32837f501c49e01d69692e9bbb25c384a202f3867aec1c858dc1e4317729cd30496adaf798c4d78837dedcfd6fe8f139eb85990a5ba124c4fe284bbb60de3753
+  data.tar.gz: 1eba0cde36d9a7b3fe352fbdd2927875bbdfa239caf757d72348a3d4e7d8a32cbe2eb1cbe6df5fd45464c0de9fd2c0c704477839838025b4bb1de6985a6a1fba

data/README.md

@@ -22,7 +22,9 @@ This library supports the following:
 | [Stored Value API](https://docs.adyen.com/payment-methods/gift-cards/stored-value-api)                                        |     v46     | Manage both online and point-of-sale gift cards and other stored-value cards.                                                                                                                                                                                                                                                           | [StoredValue](lib/adyen/services/storedValue.rb)                     |
 | [Transfers API](https://docs.adyen.com/api-explorer/transfers/4/overview)                                                     |     v4      | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument.                                                                                                                        | [Transfers](lib/adyen/services/transfers.rb)                         |
 | [Cloud-based Terminal API](https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/terminal-api-reference/) |      -      | Our point-of-sale integration.                                                                                                                                                                                                                                                                                                          | [TerminalCloudAPI](lib/adyen/services/terminalCloudAPI.rb)           |
-| [Disputes API](https://docs.adyen.com/api-explorer/Disputes/30/overview)                                                      |     v30     | You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. | [Disputes](lib/adyen/services/disputes.rb)                           |
+| [Disputes API](https://docs.adyen.com/api-explorer/Disputes/30/overview)                                                      |     v30     | You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. | [Disputes](lib/adyen/services/disputes.rb)                                                                                      |
+| [POS Mobile API](https://docs.adyen.com/api-explorer/possdk/68/overview) |    v68     | The POS Mobile API is used in the mutual authentication flow between an Adyen Android or iOS [POS Mobile SDK](https://docs.adyen.com/point-of-sale/ipp-mobile/) and the Adyen payments platform. The POS Mobile SDK for Android or iOS devices enables businesses to accept in-person payments using a commercial off-the-shelf (COTS) device like a phone. For example, Tap to Pay transactions, or transactions on a mobile device in combination with a card reader. | [POS Mobile](lib/adyen/services/posMobile.rb) |
+
 
 For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/).
 

data/VERSION

@@ -1,2 +1,2 @@
-9.3.0
+9.4.0
 

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

@@ -0,0 +1,47 @@
+require_relative '../service'
+module Adyen
+  class ManageSCADevicesApi < Service
+    attr_accessor :service, :version
+
+    def initialize(client, version = DEFAULT_VERSION)
+      super(client, version, 'BalancePlatform')
+    end
+
+    def complete_registration_of_sca_device(request, id, headers: {})
+      endpoint = '/registeredDevices/{id}'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      
+      action = { method: 'patch', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+    def delete_registration_of_sca_device(id, headers: {}, query_params: {})
+      endpoint = '/registeredDevices/{id}'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      endpoint += create_query_string(query_params)
+      action = { method: 'delete', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    def initiate_registration_of_sca_device(request, headers: {})
+      endpoint = '/registeredDevices'.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 list_registered_sca_devices(headers: {}, query_params: {})
+      endpoint = '/registeredDevices'.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.rb

@@ -5,6 +5,7 @@ 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/manage_sca_devices_api'
 require_relative 'balancePlatform/network_tokens_api'
 require_relative 'balancePlatform/payment_instrument_groups_api'
 require_relative 'balancePlatform/payment_instruments_api'
@@ -51,6 +52,10 @@ module Adyen
       @manage_card_pin_api ||= Adyen::ManageCardPINApi.new(@client, @version)
     end
 
+    def manage_sca_devices_api
+      @manage_sca_devices_api ||= Adyen::ManageSCADevicesApi.new(@client, @version)
+    end
+
     def network_tokens_api
       @network_tokens_api ||= Adyen::NetworkTokensApi.new(@client, @version)
     end

data/lib/adyen/services/posMobile.rb

@@ -0,0 +1,21 @@
+require_relative './service'
+module Adyen
+  class PosMobile < Service
+    attr_accessor :service, :version
+
+    DEFAULT_VERSION = 68
+    def initialize(client, version = DEFAULT_VERSION)
+      super(client, version, 'PosMobile')
+    end
+
+    def create_communication_session(request, headers: {})
+      endpoint = '/sessions'.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/utils/hmac_validator.rb

@@ -13,6 +13,13 @@ module Adyen
         valid_webhook_hmac?(notification_request_item, hmac_key)
       end
 
+      # validates the HMAC signature of the NotificationRequestItem object. Use for webhooks that provide the
+      # hmacSignature as part of the payload `AdditionalData` (i.e. Payments)
+      #
+      # @param webhook_request_item [Object] The webhook request item.
+      # @param hmac_key [String] The HMAC key used to validate the payload.
+      
+      # @return [Boolean] Returns true if the HMAC signature is valid, otherwise false.      
       def valid_webhook_hmac?(webhook_request_item, hmac_key)
         expected_sign = calculate_webhook_hmac(webhook_request_item, hmac_key)
         merchant_sign =
@@ -21,12 +28,32 @@ module Adyen
         expected_sign == merchant_sign
       end
 
+      # validates the HMAC signature of a payload against an expected signature. Use for webhooks that provide the
+      # hmacSignature in the HTTP header (i.e. Banking, Management API)
+      #
+      # @param hmac_signature [String] The HMAC signature to validate.
+      # @param hmac_key [String] The HMAC key used to validate the payload.
+      # @param payload [String] The webhook payload.
+
+      # @return [Boolean] Returns true if the HMAC signature is valid, otherwise false.      
+      def valid_webhook_payload_hmac?(hmac_signature, hmac_key, payload)
+        expected_sign = calculate_webhook_payload_hmac(payload, hmac_key)
+        puts(expected_sign)
+        expected_sign == hmac_signature
+      end
+
       # <b>DEPRECATED:</b> Please use calculate_webhook_hmac() instead.
       def calculate_notification_hmac(notification_request_item, hmac_key)
         calculate_webhook_hmac(notification_request_item, hmac_key)
       end
 
     
+      def calculate_webhook_payload_hmac(data, hmac_key)
+        Base64.strict_encode64(
+          OpenSSL::HMAC.digest(HMAC_ALGORITHM, [hmac_key].pack('H*'), data)
+        )
+      end
+
       def calculate_webhook_hmac(webhook_request_item, hmac_key)
         data = data_to_sign(webhook_request_item)
 
@@ -35,6 +62,7 @@ module Adyen
         )
       end
 
+
       # TODO: Deprecate instead of aliasing
       alias valid_notification_hmac? valid_webhook_hmac?
       alias calculate_notification_hmac calculate_webhook_hmac

data/lib/adyen/version.rb

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

data/spec/utils/hmac_validator_spec.rb

@@ -62,6 +62,21 @@ RSpec.describe Adyen::Utils::HmacValidator do
       webhook = JSON.parse(json_from_file('mocks/responses/Webhooks/mixed_webhook.json'))
       expect(validator.valid_webhook_hmac?(webhook, '74F490DD33F7327BAECC88B2947C011FC02D014A473AAA33A8EC93E4DC069174')).to be true
     end
+
+    it 'should have an invalid payload hmac' do
+      hmac_signature = "wrong signature"
+      payload = json_from_file('mocks/responses/Webhooks/mixed_webhook.json')
+
+      expect(validator.valid_webhook_payload_hmac?(hmac_signature, key, payload)).to be false
+    end
+
+    it 'should have an valid payload hmac' do
+      hmac_signature = "93Av9t6OVkYCrVHU/xgiTkWGbulJz+Vcm2qO4TYQH2Q="
+      payload = json_from_file('mocks/responses/Webhooks/mixed_webhook.json')
+
+      expect(validator.valid_webhook_payload_hmac?(hmac_signature, key, payload)).to be true
+    end
+
   end
 end
 # rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adyen-ruby-api-library
 version: !ruby/object:Gem::Version
-  version: 9.3.0
+  version: 9.4.0
 platform: ruby
 authors:
 - Adyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -127,6 +127,7 @@ files:
 - 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/manage_sca_devices_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
@@ -189,6 +190,7 @@ files:
 - lib/adyen/services/payout/initialization_api.rb
 - lib/adyen/services/payout/instant_payouts_api.rb
 - lib/adyen/services/payout/reviewing_api.rb
+- lib/adyen/services/posMobile.rb
 - lib/adyen/services/posTerminalManagement.rb
 - lib/adyen/services/recurring.rb
 - lib/adyen/services/service.rb
@@ -443,7 +445,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Official Adyen  Ruby API Library