adyen-ruby-api-library 11.3.0 → 12.0.0

data/spec/transfers_spec.rb

@@ -33,6 +33,34 @@ RSpec.describe Adyen::Transfers, service: 'transfers' do
       .to eq(200)
   end
 
+  it 'makes a cashouts POST call' do
+    request_body = JSON.parse(json_from_file('mocks/requests/Transfers/initiate_cashout.json'))
+
+    response_body = json_from_file('mocks/responses/Transfers/initiate_cashout.json')
+
+    url = @shared_values[:client].service_url(@shared_values[:service], 'cashouts',
+                                              @shared_values[:client].transfers.version)
+    WebMock.stub_request(:post, url)
+           .with(
+             body: request_body,
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: response_body
+           )
+
+    result = @shared_values[:client].transfers.cash_out_api.initiate_cashout(request_body)
+    response_hash = result.response
+
+    expect(result.status)
+      .to eq(200)
+    expect(response_hash).to eq(JSON.parse(response_body))
+    expect(response_hash).to be_a Adyen::HashWithAccessors
+    expect(response_hash).to be_a_kind_of Hash
+  end
+
   it 'makes a transactions GET call' do
     response_body = json_from_file('mocks/responses/Transfers/make_transfer.json')
 

data/spec/utils/consumer_smoke.rb

@@ -0,0 +1,23 @@
+# Consumer smoke test for the HMAC validator, run by hmac_validator_spec.rb.
+# Executed in a clean Ruby process that only loads the library.
+# Exits non-zero (via abort) when the library cannot be used standalone.
+
+require 'adyen-ruby-api-library'
+
+validator = Adyen::Utils::HmacValidator.new
+key = '44782DEF547AAA06C910C43932B1EB0C71FC68D9D0C057550C48EC2ACF6BA056'
+webhook_request_item = {
+  'additionalData' => { 'hmacSignature' => 'coqCmt/IZ4E3CzPvMY8zTjQVL5hYJUiBRg8UU+iCWo0=' },
+  'amount' => { 'value' => 1130, 'currency' => 'EUR' },
+  'pspReference' => '7914073381342284',
+  'eventCode' => 'AUTHORISATION',
+  'merchantAccountCode' => 'TestMerchant',
+  'merchantReference' => 'TestPayment-1407325143704',
+  'paymentMethod' => 'visa',
+  'success' => 'true'
+}
+
+abort 'valid_webhook_hmac? returned false' unless validator.valid_webhook_hmac?(webhook_request_item, key)
+
+payload_sign = validator.calculate_webhook_payload_hmac('payload', key)
+abort "unexpected payload hmac: #{payload_sign}" unless payload_sign == 'McjT0WKyyQ5Zqv3FC9sVNf14NYfSAZa1chxoXY3yIlE='

data/spec/utils/hmac_validator_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'open3'
 
 RSpec.describe Adyen::Utils::HmacValidator do
   let(:validator) { described_class.new }
@@ -77,6 +78,60 @@ RSpec.describe Adyen::Utils::HmacValidator do
       expect(validator.valid_webhook_payload_hmac?(hmac_signature, key, payload)).to be true
     end
 
+    it 'returns false when additionalData hmacSignature is nil' do
+      webhook_request_item['additionalData'] = { 'hmacSignature' => nil }
+
+      expect(validator.valid_webhook_hmac?(webhook_request_item, key)).to be false
+    end
+
+    it 'returns false when payload webhook hmac_signature is nil' do
+      payload = json_from_file('mocks/responses/Webhooks/mixed_webhook.json')
+
+      expect(validator.valid_webhook_payload_hmac?(nil, key, payload)).to be false
+    end
+
+  end
+
+  describe 'consumer-side regression' do
+    # Run the validator in a clean Ruby process that only loads the library, like
+    # a consumer application, so test dependencies cannot mask missing dependencies.
+    it 'computes HMAC signatures in a clean consumer process' do
+      lib_dir = File.expand_path('../../lib', __dir__)
+      smoke_test = File.expand_path('consumer_smoke.rb', __dir__)
+
+      stdout, stderr, status = Open3.capture3(Gem.ruby, '-I', lib_dir, smoke_test)
+
+      expect(status).to be_success,
+                        "library must work in a clean consumer process.\nstdout: #{stdout}\nstderr: #{stderr}"
+    end
+  end
+
+  describe 'deprecated methods' do
+    around do |example|
+      previous = Warning[:deprecated]
+      Warning[:deprecated] = true
+      example.run
+    ensure
+      Warning[:deprecated] = previous
+    end
+
+    it 'valid_notification_hmac? emits a deprecation warning and still validates' do
+      result = nil
+      expect do
+        result = validator.valid_notification_hmac?(webhook_request_item, key)
+      end.to output(/\[DEPRECATED\] `valid_notification_hmac\?` is deprecated\. Use valid_webhook_hmac\?\(\) instead\.\n/).to_stderr
+
+      expect(result).to be true
+    end
+
+    it 'calculate_notification_hmac emits a deprecation warning and still calculates' do
+      result = nil
+      expect do
+        result = validator.calculate_notification_hmac(webhook_request_item, key)
+      end.to output(/\[DEPRECATED\] `calculate_notification_hmac` is deprecated\. Use calculate_webhook_hmac\(\) instead\.\n/).to_stderr
+
+      expect(result).to eq expected_sign
+    end
   end
 end
 # rubocop:enable Metrics/BlockLength

data/templates/api-small.mustache

@@ -18,9 +18,11 @@ module Adyen
     # {{{summary}}}{{^summary}}{{operationId}}{{/summary}}{{#isDeprecated}}
     #
     # Deprecated {{#vendorExtensions.x-deprecatedInVersion}}since {{#appName}}{{{.}}}{{/appName}} v{{.}}{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}
-    # {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}{{/isDeprecated}}
+    # {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}
+    # @deprecated{{/isDeprecated}}
     def {{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}({{#bodyParams}}request, {{/bodyParams}}{{#requiredParams}}{{^isQueryParam}}{{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}, {{/isQueryParam}}{{/requiredParams}}headers: {}{{#queryParams}}{{#-first}}, query_params: {}{{/-first}}{{/queryParams}})
-      endpoint = build_endpoint('{{path}}'{{#pathParams}}, {{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}{{/pathParams}})
+      {{#isDeprecated}}Adyen::Deprecation.warn(:{{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}{{#vendorExtensions.x-deprecatedInVersion}}, since: '{{#lambda.escapeSingleQuotedString}}{{#appName}}{{{.}}}{{/appName}} v{{.}}{{/lambda.escapeSingleQuotedString}}'{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}, message: '{{#lambda.escapeSingleQuotedString}}{{{.}}}{{/lambda.escapeSingleQuotedString}}'{{/vendorExtensions.x-deprecatedMessage}})
+      {{/isDeprecated}}endpoint = build_endpoint('{{#lambda.escapeSingleQuotedString}}{{{path}}}{{/lambda.escapeSingleQuotedString}}'{{#pathParams}}, {{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}{{/pathParams}})
       {{#queryParams}}{{#-first}}endpoint += create_query_string(query_params){{/-first}}{{/queryParams}}
       action = { method: '{{#lambda.lowercase}}{{httpMethod}}{{/lambda.lowercase}}', url: endpoint }
   {{#bodyParams}}        

data/templates/api.mustache

@@ -17,9 +17,11 @@ module Adyen
     # {{{summary}}}{{^summary}}{{operationId}}{{/summary}}{{#isDeprecated}}
     #
     # Deprecated {{#vendorExtensions.x-deprecatedInVersion}}since {{#appName}}{{{.}}}{{/appName}} v{{.}}{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}
-    # {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}{{/isDeprecated}}
+    # {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}
+    # @deprecated{{/isDeprecated}}
     def {{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}({{#bodyParams}}request, {{/bodyParams}}{{#pathParams}}{{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}, {{/pathParams}}headers: {}{{#queryParams}}{{#-first}}, query_params: {}{{/-first}}{{/queryParams}})
-      endpoint = build_endpoint('{{path}}'{{#pathParams}}, {{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}{{/pathParams}})
+      {{#isDeprecated}}Adyen::Deprecation.warn(:{{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}{{#vendorExtensions.x-deprecatedInVersion}}, since: '{{#lambda.escapeSingleQuotedString}}{{#appName}}{{{.}}}{{/appName}} v{{.}}{{/lambda.escapeSingleQuotedString}}'{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}, message: '{{#lambda.escapeSingleQuotedString}}{{{.}}}{{/lambda.escapeSingleQuotedString}}'{{/vendorExtensions.x-deprecatedMessage}})
+      {{/isDeprecated}}endpoint = build_endpoint('{{#lambda.escapeSingleQuotedString}}{{{path}}}{{/lambda.escapeSingleQuotedString}}'{{#pathParams}}, {{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}{{/pathParams}})
       {{#queryParams}}{{#-first}}endpoint += create_query_string(query_params){{/-first}}{{/queryParams}}
       action = { method: '{{#lambda.lowercase}}{{httpMethod}}{{/lambda.lowercase}}', url: endpoint }
   {{#bodyParams}}        

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adyen-ruby-api-library
 version: !ruby/object:Gem::Version
-  version: 11.3.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Adyen
@@ -103,6 +103,7 @@ files:
 - bin/setup
 - lib/adyen-ruby-api-library.rb
 - lib/adyen/client.rb
+- lib/adyen/deprecation.rb
 - lib/adyen/errors.rb
 - lib/adyen/hash_with_accessors.rb
 - lib/adyen/result.rb
@@ -115,15 +116,18 @@ files:
 - lib/adyen/services/balancePlatform/balances_api.rb
 - lib/adyen/services/balancePlatform/bank_account_validation_api.rb
 - lib/adyen/services/balancePlatform/card_orders_api.rb
+- lib/adyen/services/balancePlatform/custom_payout_schedules_sweeps_api.rb
 - lib/adyen/services/balancePlatform/direct_debit_mandates_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/manage_sca_devices_api.rb
+- lib/adyen/services/balancePlatform/managed_payout_schedules_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
 - lib/adyen/services/balancePlatform/platform_api.rb
+- lib/adyen/services/balancePlatform/recurring_top_ups_api.rb
 - lib/adyen/services/balancePlatform/sca_association_management_api.rb
 - lib/adyen/services/balancePlatform/sca_device_management_api.rb
 - lib/adyen/services/balancePlatform/transaction_rules_api.rb
@@ -171,6 +175,7 @@ files:
 - lib/adyen/services/management/api_key_merchant_level_api.rb
 - lib/adyen/services/management/client_key_company_level_api.rb
 - lib/adyen/services/management/client_key_merchant_level_api.rb
+- lib/adyen/services/management/donation_campaigns_api.rb
 - lib/adyen/services/management/my_api_credential_api.rb
 - lib/adyen/services/management/payment_methods_merchant_level_api.rb
 - lib/adyen/services/management/payout_settings_merchant_level_api.rb
@@ -213,6 +218,7 @@ files:
 - lib/adyen/services/terminalCloudAPI.rb
 - lib/adyen/services/transfers.rb
 - lib/adyen/services/transfers/capital_api.rb
+- lib/adyen/services/transfers/cash_out_api.rb
 - lib/adyen/services/transfers/transactions_api.rb
 - lib/adyen/services/transfers/transfers_api.rb
 - lib/adyen/utils/hmac_validator.rb
@@ -244,6 +250,7 @@ files:
 - spec/checkout_spec.rb
 - spec/client_spec.rb
 - spec/data_protection_spec.rb
+- spec/deprecation_spec.rb
 - spec/disputes_spec.rb
 - spec/errors_spec.rb
 - spec/fund_spec.rb
@@ -270,16 +277,29 @@ files:
 - spec/mocks/requests/Account/update_account_holder_state.json
 - spec/mocks/requests/Account/upload_document.json
 - spec/mocks/requests/BalanceControl/balance_transfer.json
+- spec/mocks/requests/BalancePlatform/apply_managed_schedule.json
+- spec/mocks/requests/BalancePlatform/begin_sca_device_registration.json
 - spec/mocks/requests/BalancePlatform/create_account_holder.json
+- spec/mocks/requests/BalancePlatform/create_recurring_top_up.json
+- spec/mocks/requests/BalancePlatform/create_sweep.json
 - spec/mocks/requests/BalancePlatform/create_transfer_limit.json
 - spec/mocks/requests/BalancePlatform/create_webhook_setting.json
+- spec/mocks/requests/BalancePlatform/finish_sca_device_registration.json
+- spec/mocks/requests/BalancePlatform/submit_sca_association.json
 - spec/mocks/requests/BalancePlatform/update_account_holder.json
+- spec/mocks/requests/BalancePlatform/update_balance_account_managed_schedule.json
 - spec/mocks/requests/BalancePlatform/update_mandate.json
+- spec/mocks/requests/BalancePlatform/update_recurring_top_ups.json
+- spec/mocks/requests/BalancePlatform/update_sweep.json
 - spec/mocks/requests/BinLookup/get_3ds_availability.json
 - spec/mocks/requests/BinLookup/get_cost_estimate.json
 - spec/mocks/requests/Checkout/amount_updates.json
 - spec/mocks/requests/Checkout/apple_pay_sessions.json
 - spec/mocks/requests/Checkout/capture.json
+- spec/mocks/requests/Checkout/card_details.json
+- spec/mocks/requests/Checkout/create_stored_payment_method.json
+- spec/mocks/requests/Checkout/donation_campaigns.json
+- spec/mocks/requests/Checkout/donations.json
 - spec/mocks/requests/Checkout/generic_cancel.json
 - spec/mocks/requests/Checkout/modifications_request.json
 - spec/mocks/requests/Checkout/orders.json
@@ -292,9 +312,12 @@ files:
 - spec/mocks/requests/Checkout/payment_methods_balance.json
 - spec/mocks/requests/Checkout/payment_session.json
 - spec/mocks/requests/Checkout/payments.json
+- spec/mocks/requests/Checkout/paypal_update_order.json
 - spec/mocks/requests/Checkout/psp_cancel.json
 - spec/mocks/requests/Checkout/refund.json
+- spec/mocks/requests/Checkout/reversals.json
 - spec/mocks/requests/Checkout/sessions.json
+- spec/mocks/requests/Checkout/update_session.json
 - spec/mocks/requests/Checkout/verify.json
 - spec/mocks/requests/DataProtection/request_subject_erasure.json
 - spec/mocks/requests/Disputes/retrieve_applicable_defense_reasons.json
@@ -307,7 +330,10 @@ files:
 - spec/mocks/requests/Fund/transfer_funds.json
 - spec/mocks/requests/Hop/get_onboarding_url.json
 - spec/mocks/requests/LegalEntityManagement/create_business_line.json
+- spec/mocks/requests/Management/create_donation_campaign.json
 - spec/mocks/requests/Management/create_store.json
+- spec/mocks/requests/Management/list_nonprofits.json
+- spec/mocks/requests/Management/update_donation_campaign.json
 - spec/mocks/requests/Notification/create_notification_configuration.json
 - spec/mocks/requests/Notification/delete_notification_configurations.json
 - spec/mocks/requests/Notification/get_notification_configuration.json
@@ -346,6 +372,7 @@ files:
 - spec/mocks/requests/TerminalCloudAPI/connected_terminals.json
 - spec/mocks/requests/TerminalCloudAPI/sync_payment.json
 - spec/mocks/requests/Transfers/get_transactions.json
+- spec/mocks/requests/Transfers/initiate_cashout.json
 - spec/mocks/requests/Transfers/make_transfer.json
 - spec/mocks/responses/Account/check_account_holder.json
 - spec/mocks/responses/Account/close_account.json
@@ -365,18 +392,35 @@ files:
 - spec/mocks/responses/Account/update_account_holder_state.json
 - spec/mocks/responses/Account/upload_document.json
 - spec/mocks/responses/BalanceControl/balance_transfer.json
+- spec/mocks/responses/BalancePlatform/apply_managed_schedule.json
+- spec/mocks/responses/BalancePlatform/begin_sca_device_registration.json
 - spec/mocks/responses/BalancePlatform/create_account_holder.json
+- spec/mocks/responses/BalancePlatform/create_recurring_top_up.json
+- spec/mocks/responses/BalancePlatform/create_sweep.json
 - spec/mocks/responses/BalancePlatform/create_transfer_limit.json
 - spec/mocks/responses/BalancePlatform/create_webhook_setting.json
+- spec/mocks/responses/BalancePlatform/finish_sca_device_registration.json
 - spec/mocks/responses/BalancePlatform/get_all_authorised_card_users.json
+- spec/mocks/responses/BalancePlatform/get_all_sweeps_for_balance_account.json
 - spec/mocks/responses/BalancePlatform/get_all_webhook_settings.json
 - spec/mocks/responses/BalancePlatform/get_balance_account.json
+- spec/mocks/responses/BalancePlatform/get_balance_account_managed_schedule_by_id.json
+- spec/mocks/responses/BalancePlatform/get_balance_account_managed_schedules.json
+- spec/mocks/responses/BalancePlatform/get_balance_platform_managed_schedule_by_id.json
+- spec/mocks/responses/BalancePlatform/get_balance_platform_managed_schedules.json
 - spec/mocks/responses/BalancePlatform/get_list_of_mandates.json
 - spec/mocks/responses/BalancePlatform/get_mandate_by_id.json
+- spec/mocks/responses/BalancePlatform/get_payout_schedule_executions.json
+- spec/mocks/responses/BalancePlatform/get_recurring_top_ups.json
 - spec/mocks/responses/BalancePlatform/get_specific_transfer_limit.json
+- spec/mocks/responses/BalancePlatform/get_sweep.json
 - spec/mocks/responses/BalancePlatform/get_tax_form_summary.json
 - spec/mocks/responses/BalancePlatform/get_transfer_limits.json
+- spec/mocks/responses/BalancePlatform/submit_sca_association.json
 - spec/mocks/responses/BalancePlatform/update_account_holder.json
+- spec/mocks/responses/BalancePlatform/update_balance_account_managed_schedule.json
+- spec/mocks/responses/BalancePlatform/update_recurring_top_ups.json
+- spec/mocks/responses/BalancePlatform/update_sweep.json
 - spec/mocks/responses/BinLookup/get_3ds_availability.json
 - spec/mocks/responses/BinLookup/get_cost_estimate.json
 - spec/mocks/responses/Capital/calculate-preliminary-offer-from-dynamic-offer.json
@@ -394,6 +438,10 @@ files:
 - spec/mocks/responses/Checkout/amount_updates.json
 - spec/mocks/responses/Checkout/apple_pay_sessions.json
 - spec/mocks/responses/Checkout/capture.json
+- spec/mocks/responses/Checkout/card_details.json
+- spec/mocks/responses/Checkout/create_stored_payment_method.json
+- spec/mocks/responses/Checkout/donation_campaigns.json
+- spec/mocks/responses/Checkout/donations.json
 - spec/mocks/responses/Checkout/generic_cancel.json
 - spec/mocks/responses/Checkout/get-payment-link.json
 - spec/mocks/responses/Checkout/modifications.json
@@ -407,11 +455,14 @@ files:
 - spec/mocks/responses/Checkout/payment_methods_balance.json
 - spec/mocks/responses/Checkout/payment_session.json
 - spec/mocks/responses/Checkout/payments.json
+- spec/mocks/responses/Checkout/paypal_update_order.json
 - spec/mocks/responses/Checkout/psp_cancel.json
 - spec/mocks/responses/Checkout/refund.json
+- spec/mocks/responses/Checkout/reversals.json
 - spec/mocks/responses/Checkout/sessions-success.json
 - spec/mocks/responses/Checkout/stored_payment_methods.json
 - spec/mocks/responses/Checkout/update-payment-link.json
+- spec/mocks/responses/Checkout/update_session.json
 - spec/mocks/responses/Checkout/verify.json
 - spec/mocks/responses/DataProtection/request_subject_erasure.json
 - spec/mocks/responses/Disputes/retrieve_applicable_defense_reasons.json
@@ -426,7 +477,10 @@ files:
 - spec/mocks/responses/LegalEntityManagement/create_business_line.json
 - spec/mocks/responses/LegalEntityManagement/get_legal_entity.json
 - spec/mocks/responses/Management/create_store.json
+- spec/mocks/responses/Management/donation_campaign.json
 - spec/mocks/responses/Management/get_companies.json
+- spec/mocks/responses/Management/list_donation_campaigns.json
+- spec/mocks/responses/Management/list_nonprofits.json
 - spec/mocks/responses/Notification/create_notification_configuration.json
 - spec/mocks/responses/Notification/delete_notification_configurations.json
 - spec/mocks/responses/Notification/get_notification_configuration.json
@@ -466,6 +520,7 @@ files:
 - spec/mocks/responses/TerminalCloudAPI/connected_terminals.json
 - spec/mocks/responses/TerminalCloudAPI/sync_payment.json
 - spec/mocks/responses/Transfers/get_transactions.json
+- spec/mocks/responses/Transfers/initiate_cashout.json
 - spec/mocks/responses/Transfers/make_transfer.json
 - spec/mocks/responses/Webhooks/backslash_webhook.json
 - spec/mocks/responses/Webhooks/colon_webhook.json
@@ -483,6 +538,7 @@ files:
 - spec/stored_value_spec.rb
 - spec/terminal_cloud_api_spec.rb
 - spec/transfers_spec.rb
+- spec/utils/consumer_smoke.rb
 - spec/utils/hmac_validator_spec.rb
 - templates/api-single.mustache
 - templates/api-small.mustache
@@ -502,7 +558,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="