adyen-ruby-api-library 11.0.0 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f7ba37ee06a22e3d1f014c6f5db4e64a9953a1b09e3486b343520464cacef8a
-  data.tar.gz: 42dcac0cf673d4136551db350fa75c19041349499f8d2d401f13f6367f0e6dc4
+  metadata.gz: 92b51bd749bf2197660b344467eb810e18fc85c595313444b25b0b1c6e5efd4e
+  data.tar.gz: fe1566a9a57a0be999ca83dc1704893050f13756f07529526fa457aa270bec6c
 SHA512:
-  metadata.gz: c21b9c1a93ffa502019fec7db2fcdcf6b7d8e2bea6b0acd3974a93274deef99db442027fc2a9477d9fbe69e27c726b01edd4f02adb376cc61ec25c77317d9823
-  data.tar.gz: f45339daac6e469bdd429ea87eb14e5adf25bf43fee4441c60ad2d70d41fbf8b6713ba9aba715bac0195bed10322c5eded6cf6ea98fb52da4968b5da919bc8e6
+  metadata.gz: acf09d5e10e31179b243638b37e9c5528193fad0b3bb0fcb6d667f8a75a045a79efeb8dec96338bbec1bc3f13efd608c9c4c231325c76123a98afb342155c830
+  data.tar.gz: e5e9e834d79ef4a52e8ecb5d863394dbdce70050f3f0e72577fa0cfdc39b1475bf984adbb1a02ef4d0376f3cd2aeb99ef976922e02e2c31b3ce207fe82c5cde3

data/README.md

@@ -1,6 +1,8 @@
 ![Ruby](https://user-images.githubusercontent.com/93914435/236416787-3da4dd32-0a7d-43f7-9aa4-8d77697c85f9.png)
 # Adyen API Library for Ruby
 
+[![Gem Version](https://img.shields.io/gem/v/adyen-ruby-api-library.svg)](https://rubygems.org/gems/adyen-ruby-api-library)
+
 This is the officially supported Ruby library for using Adyen's APIs.
 
 ## Supported APIs

data/VERSION

@@ -1,2 +1,2 @@
-11.0.0
+11.1.0
 

data/lib/adyen/client.rb

@@ -64,8 +64,6 @@ module Adyen
 
     # base URL for API given service and @env
     def service_url_base(service)
-      # maps 'Disputes' to expected service name 'DisputesService' for URL matching
-      service = 'DisputesService' if service == 'Disputes'
       if @env == :mock
         @mock_service_url_base
       else
@@ -82,8 +80,11 @@ module Adyen
         when 'PosTerminalManagement'
           url = "https://postfmapi-#{@env}.adyen.com/postfmapi/terminal"
           supports_live_url_prefix = false
-        when 'DataProtectionService', 'DisputesService'
-          url = "https://ca-#{@env}.adyen.com/ca/services/#{service}"
+        when 'Disputes'
+          url = "https://ca-#{@env}.adyen.com/ca/services/DisputeService"
+          supports_live_url_prefix = false
+        when 'DataProtection'
+          url = "https://ca-#{@env}.adyen.com/ca/services/DataProtectionService"
           supports_live_url_prefix = false
         when 'LegalEntityManagement'
           url = "https://kyc-#{@env}.adyen.com/lem"
@@ -107,6 +108,10 @@ module Adyen
         when 'PosMobile'
           url = "https://checkout-#{@env}.adyen.com/checkout/possdk"
           supports_live_url_prefix = true
+        when 'SessionAuthentication'
+          subdomain = @env == :live ? "authe-#{@env}" : @env
+          url = "https://#{subdomain}.adyen.com/authe/api"
+          supports_live_url_prefix = false
         else
           raise ArgumentError, 'Invalid service specified'
         end
@@ -140,7 +145,7 @@ module Adyen
     def call_adyen_api(service, action, request_data, headers, version, _with_application_info: false)
       # get URL for requested endpoint
       url = service_url(service, action.is_a?(String) ? action : action.fetch(:url), version)
-
+      
       auth_type = auth_type(service, request_data)
 
       # initialize Faraday connection object
@@ -223,6 +228,9 @@ module Adyen
         when 403
           full_message = build_error_message(response.body, 'Authorisation error')
           raise Adyen::PermissionError.new(full_message, request_data, response.body)
+        when 404
+          full_message = build_error_message(response.body, 'Not found error')
+          raise Adyen::NotFoundError.new(full_message, request_data, response.body)
         when 422
           full_message = build_error_message(response.body, 'Validation error')
           raise Adyen::ValidationError.new(full_message, request_data, response.body)
@@ -368,8 +376,10 @@ module Adyen
       full_message = default_message
       begin
         error_details = response_body
+        error_details = JSON.parse(response_body, symbolize_names: true) if response_body.is_a?(String)
+
         # check different attributes to support both RFC 7807 and legacy models
-        message = error_details[:detail] || error_details[:message]
+        message = error_details[:detail] || error_details[:message]  || error_details
         error_code = error_details[:errorCode]
         if message && error_code
           full_message = "#{message} ErrorCode: #{error_code}"

data/lib/adyen/errors.rb

@@ -105,6 +105,12 @@ module Adyen
     end
   end
 
+  class NotFoundError < AdyenError
+    def initialize(msg, request, response)
+      super(request, response, msg, 404)
+    end
+  end
+
   # catchall for errors which don't have more specific classes
   class APIError < AdyenError
     def initialize(msg, request, response, code)

data/lib/adyen/services/legalEntityManagement/legal_entities_api.rb

@@ -62,6 +62,16 @@ module Adyen
       @client.call_adyen_api(@service, action, {}, headers, @version)
     end
 
+    # Request periodic data review.
+    def request_periodic_review(id, headers: {})
+      endpoint = '/legalEntities/{id}/requestPeriodicReview'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
     # Update a legal entity
     def update_legal_entity(request, id, headers: {})
       endpoint = '/legalEntities/{id}'.gsub(/{.+?}/, '%s')

data/lib/adyen/services/payment/modifications_api.rb

@@ -5,7 +5,7 @@ module Adyen
   # Ref: https://openapi-generator.tech
   #
   # Do not edit the class manually.
-  class ModificationsApi < Service
+  class ClassicModificationsApi < Service
     attr_accessor :service, :version
 
     def initialize(client, version = DEFAULT_VERSION)

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

@@ -5,7 +5,7 @@ module Adyen
   # Ref: https://openapi-generator.tech
   #
   # Do not edit the class manually.
-  class PaymentsApi < Service
+  class ClassicPaymentsApi < Service
     attr_accessor :service, :version
 
     def initialize(client, version = DEFAULT_VERSION)

data/lib/adyen/services/payment.rb

@@ -18,11 +18,11 @@ module Adyen
     end
 
     def modifications_api
-      @modifications_api ||= Adyen::ModificationsApi.new(@client, @version)
+      @modifications_api ||= Adyen::ClassicModificationsApi.new(@client, @version)
     end
 
     def payments_api
-      @payments_api ||= Adyen::PaymentsApi.new(@client, @version)
+      @payments_api ||= Adyen::ClassicPaymentsApi.new(@client, @version)
     end
 
   end

data/lib/adyen/version.rb

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

data/renovate.json

@@ -1,5 +1,7 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": ["config:base"],
+  "extends": [
+    "config:recommended"
+  ],
   "minimumReleaseAge": "21 days"
 }

data/spec/checkout_spec.rb

@@ -8,6 +8,19 @@ RSpec.describe Adyen::Checkout, service: 'checkout' do
       service: 'Checkout'
     }
   end
+  
+  it 'uses the correct PaymentsApi for the Checkout service' do
+    # Load both API files to ensure there's no conflict after the fix.
+    load File.expand_path('../lib/adyen/services/payment/payments_api.rb', __dir__)
+    load File.expand_path('../lib/adyen/services/checkout/payments_api.rb', __dir__)
+
+    checkout = Adyen::Checkout.new(@shared_values[:client])
+    payments_api = checkout.payments_api
+
+    # Verify that the Checkout facade uses the correct PaymentsApi class.
+    expect(payments_api.class.name).to eq('Adyen::PaymentsApi')
+    expect(payments_api.service).to eq('Checkout')
+  end
 
   # must be created manually because every field in the response is an array
   it 'makes a payment_methods call' do

data/spec/client_spec.rb

@@ -300,9 +300,27 @@ RSpec.describe Adyen do
   it 'correctly maps Disputes to DisputesService and generates valid URL' do
     client = Adyen::Client.new(env: :test)
     expect(client.service_url_base('Disputes'))
-      .to eq('https://ca-test.adyen.com/ca/services/DisputesService')
+      .to eq('https://ca-test.adyen.com/ca/services/DisputeService')
   end  
 
+  it 'checks the creation of DataProtection url' do
+    client = Adyen::Client.new(env: :test)
+    expect(client.service_url_base('DataProtection'))
+      .to eq('https://ca-test.adyen.com/ca/services/DataProtectionService')
+  end  
+
+  it 'checks the creation of SessionAuthentication url for the test env' do
+    client = Adyen::Client.new(env: :test)
+    expect(client.service_url_base('SessionAuthentication'))
+      .to eq('https://test.adyen.com/authe/api')
+  end
+
+  it 'checks the creation of SessionAuthentication url for the live env' do
+    client = Adyen::Client.new(env: :live)
+    expect(client.service_url_base('SessionAuthentication'))
+      .to eq('https://authe-live.adyen.com/authe/api')
+  end
+
   it 'raises FormatError on 400 response and checks content' do
     client = Adyen::Client.new(api_key: 'api_key', env: :test)
     mock_faraday_connection = double(Faraday::Connection)
@@ -401,4 +419,41 @@ RSpec.describe Adyen do
       expect(error.msg).to eq('Unexpected error. ErrorCode: 999')
     end
   end
+
+  it 'raises NotFoundError on 404 response and checks content' do
+    client = Adyen::Client.new(api_key: 'api_key', env: :test)
+    mock_faraday_connection = double(Faraday::Connection)
+    error_body = "701 Version 71 is not supported, latest version: 68"
+    mock_response = Faraday::Response.new(status: 404, body: error_body)
+
+    allow(Faraday).to receive(:new).and_return(mock_faraday_connection)
+    allow(mock_faraday_connection).to receive_message_chain(:headers, :[]=)
+    allow(mock_faraday_connection).to receive(:post).and_return(mock_response)
+
+    expect {
+      client.checkout.payments_api.payments({})
+    }.to raise_error(Adyen::NotFoundError) do |error|
+      expect(error.code).to eq(404)
+      expect(error.msg).to eq('Not found error')
+    end
+  end
+
+   it 'raises NotFoundError on 404 response with an invalid JSON body' do
+    client = Adyen::Client.new(api_key: 'api_key', env: :test)
+    mock_faraday_connection = double(Faraday::Connection)
+    error_body = "this is an error message"  
+    mock_response = Faraday::Response.new(status: 404, body: error_body)
+
+    allow(Faraday).to receive(:new).and_return(mock_faraday_connection)
+    allow(mock_faraday_connection).to receive_message_chain(:headers, :[]=)
+    allow(mock_faraday_connection).to receive(:post).and_return(mock_response)
+
+    expect {
+      client.payment.payments_api.authorise({})
+    }.to raise_error(Adyen::NotFoundError) do |error|
+      expect(error.code).to eq(404)
+      expect(error.msg).to eq('Not found error')
+    end
+  end
+ 
 end

data/spec/data_protection_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe Adyen::DataProtection, service: 'Data Protection Service' do
+RSpec.describe Adyen::DataProtection, service: 'DataProtection' do
   # client instance to be used in dynamically generated tests
   client = create_client(:basic)
 
@@ -10,5 +10,5 @@ RSpec.describe Adyen::DataProtection, service: 'Data Protection Service' do
     %w[request_subject_erasure result SUCCESS]
   ]
 
-  generate_tests(client, 'DataProtectionService', test_sets, client.data_protection.data_protection_api)
+  generate_tests(client, 'DataProtection', test_sets, client.data_protection.data_protection_api)
 end

data/spec/disputes_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe Adyen::Disputes, service: 'disputes service' do
+RSpec.describe Adyen::Disputes, service: 'Disputes' do
   before(:all) do
     @shared_values = {
       client: create_client(:api_key),
@@ -11,9 +11,9 @@ RSpec.describe Adyen::Disputes, service: 'disputes service' do
   # methods / values to test for
   # format is defined in spec_helper
   it 'makes a retrieve_applicable_defense_reasons call' do
-    request_body = JSON.parse(json_from_file('mocks/requests/DisputesService/retrieve_applicable_defense_reasons.json'))
+    request_body = JSON.parse(json_from_file('mocks/requests/Disputes/retrieve_applicable_defense_reasons.json'))
 
-    response_body = json_from_file('mocks/responses/DisputesService/retrieve_applicable_defense_reasons.json')
+    response_body = json_from_file('mocks/responses/Disputes/retrieve_applicable_defense_reasons.json')
 
     url = @shared_values[:client].service_url(@shared_values[:service], 'retrieveApplicableDefenseReasons',
                                               @shared_values[:client].disputes.version)

data/spec/lem_spec.rb

@@ -60,4 +60,79 @@ RSpec.describe Adyen::LegalEntityManagement, service: 'LegalEntityManagement' do
     expect(result.status)
       .to eq(200)
   end
+
+  it 'makes a legal_entities GET call' do
+    legal_entity_id = 'LE322JV223222D5F4K62J7465'
+    response_body = json_from_file('mocks/responses/LegalEntityManagement/get_legal_entity.json')
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "legalEntities/#{legal_entity_id}",
+                                              @shared_values[:client].legal_entity_management.version)
+    WebMock.stub_request(:get, url)
+           .with(
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: response_body
+           )
+
+    result = @shared_values[:client].legal_entity_management.legal_entities_api.get_legal_entity(legal_entity_id)
+    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 'raises an error when calling legal_entities GET call' do
+    invalid_legal_entity_id = 'NON_EXISTENT_ID'
+    error_response_body = { status: 404, errorCode: '100', message: 'Legal entity not found', errorType: 'validation' }.to_json 
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "legalEntities/#{invalid_legal_entity_id}",
+                                              @shared_values[:client].legal_entity_management.version)
+    WebMock.stub_request(:get, url)
+           .with(
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             status: 404,
+             body: error_response_body
+           )
+
+    expect do
+      @shared_values[:client].legal_entity_management.legal_entities_api.get_legal_entity(invalid_legal_entity_id)
+    end.to raise_error(Adyen::NotFoundError) do |error|
+      expect(error.code).to eq(404)
+      expect(error.msg).to eq('Legal entity not found ErrorCode: 100')
+    end
+  end
+
+  it 'makes a LegaleEntity /requestPeriodicReview call' do
+    url = @shared_values[:client].service_url(@shared_values[:service], "legalEntities/LE123/requestPeriodicReview",
+                                              @shared_values[:client].legal_entity_management.version)
+    WebMock.stub_request(:post, url)
+           .with(
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: '{}'
+           )
+
+    result = @shared_values[:client].legal_entity_management.legal_entities_api.request_periodic_review('LE123')
+    result.response
+
+    expect(result.status)
+      .to eq(200)
+  end
+  
 end

data/spec/mocks/responses/LegalEntityManagement/get_legal_entity.json

@@ -0,0 +1,14 @@
+{
+  "id": "LE322JV223222D5F4K62J7465",
+  "type": "Organization",
+  "status": "Active",
+  "legalEntityCode": "LE322JV223222D5F4K62J7465",
+  "reference": "MyCompany",
+  "capabilities": [
+    {
+      "id": "capability_1",
+      "requested": true,
+      "allowed": true
+    }
+  ]
+}

data/templates/api-single.mustache

@@ -23,7 +23,7 @@ module Adyen
     {{#apiInfo}}
         {{#apis}}
     def {{classFilename}}
-      @{{classFilename}} ||= Adyen::{{classname}}.new(@client, @version)
+      @{{classFilename}} ||= Adyen::{{classicPrefix}}{{classname}}.new(@client, @version)
     end
 
         {{/apis}}

data/templates/api.mustache

@@ -6,7 +6,7 @@ module Adyen
   # Ref: https://openapi-generator.tech
   #
   # Do not edit the class manually.
-  class {{classname}} < Service
+  class {{classicPrefix}}{{classname}} < Service
     attr_accessor :service, :version
 
     def initialize(client, version = DEFAULT_VERSION)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adyen-ruby-api-library
 version: !ruby/object:Gem::Version
-  version: 11.0.0
+  version: 11.1.0
 platform: ruby
 authors:
 - Adyen
@@ -94,7 +94,6 @@ files:
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
-- Makefile
 - README.md
 - Rakefile
 - VERSION
@@ -269,8 +268,8 @@ files:
 - spec/mocks/requests/Checkout/refund.json
 - spec/mocks/requests/Checkout/sessions.json
 - spec/mocks/requests/Checkout/verify.json
-- spec/mocks/requests/DataProtectionService/request_subject_erasure.json
-- spec/mocks/requests/DisputesService/retrieve_applicable_defense_reasons.json
+- spec/mocks/requests/DataProtection/request_subject_erasure.json
+- spec/mocks/requests/Disputes/retrieve_applicable_defense_reasons.json
 - spec/mocks/requests/Fund/account_holder_balance.json
 - spec/mocks/requests/Fund/account_holder_transaction_list.json
 - spec/mocks/requests/Fund/payout_account_holder.json
@@ -371,8 +370,8 @@ files:
 - spec/mocks/responses/Checkout/stored_payment_methods.json
 - spec/mocks/responses/Checkout/update-payment-link.json
 - spec/mocks/responses/Checkout/verify.json
-- spec/mocks/responses/DataProtectionService/request_subject_erasure.json
-- spec/mocks/responses/DisputesService/retrieve_applicable_defense_reasons.json
+- spec/mocks/responses/DataProtection/request_subject_erasure.json
+- spec/mocks/responses/Disputes/retrieve_applicable_defense_reasons.json
 - spec/mocks/responses/Fund/account_holder_balance.json
 - spec/mocks/responses/Fund/account_holder_transaction_list.json
 - spec/mocks/responses/Fund/payout_account_holder.json
@@ -382,6 +381,7 @@ files:
 - spec/mocks/responses/Fund/transfer_funds.json
 - spec/mocks/responses/Hop/get_onboarding_url.json
 - 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/get_companies.json
 - spec/mocks/responses/Notification/create_notification_configuration.json

data/Makefile

@@ -1,79 +0,0 @@
-generator:=ruby
-openapi-generator-version:=6.4.0
-openapi-generator-url:=https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/$(openapi-generator-version)/openapi-generator-cli-$(openapi-generator-version).jar
-openapi-generator-jar:=build/openapi-generator-cli.jar
-openapi-generator-cli:=java -jar build/openapi-generator-cli.jar
-output:=build/out
-
-services:=balancePlatform checkout legalEntityManagement management payout transfers
-singleFileServices:=balanceControlService binLookup dataProtection recurring storedValue payment posTerminalManagement disputes
-
-binLookup: spec=BinLookupService-v54
-checkout: spec=CheckoutService-v71
-dataProtection: spec=DataProtectionService-v1
-storedValue: spec=StoredValueService-v46
-posTerminalManagement: spec=TfmAPIService-v1
-payment: spec=PaymentService-v68
-recurring: spec=RecurringService-v68
-payout: spec=PayoutService-v68
-management: spec=ManagementService-v3
-legalEntityManagement: spec=LegalEntityService-v3
-balancePlatform: spec=BalancePlatformService-v2
-balanceControlService: spec=BalanceControlService-v1
-transfers: spec=TransferService-v4
-disputes: spec=DisputeService-v30
-
-allServices: $(services) $(singleFileServices)
-
-$(services): build/spec $(openapi-generator-jar)
-	wget $(openapi-generator-url) -O build/openapi-generator-cli.jar
-	rm -rf $(output)
-	$(openapi-generator-cli) generate \
-		-i build/spec/json/$(spec).json \
-		-g $(generator) \
-		-c ./templates/config.yaml \
-		-o $(output) \
-		--global-property apis,apiTests=false,apiDocs=false,supportingFiles=api-single.rb\
-		--additional-properties serviceName=$@\
-		--skip-validate-spec
-	rm -f $(output)/lib/openapi_client/api/*-small.rb
-	mkdir -p lib/adyen/services/$@
-	mv $(output)/lib/openapi_client/api/*.rb lib/adyen/services/$@
-	mv $(output)/api/api-single.rb lib/adyen/services/$@.rb
-	rm -rf $(output)
-
-$(singleFileServices): build/spec
-	wget $(openapi-generator-url) -O build/openapi-generator-cli.jar
-	jq -e 'del(.paths[][].tags)' build/spec/json/$(spec).json > build/spec/json/$(spec).tmp
-	mv build/spec/json/$(spec).tmp build/spec/json/$(spec).json
-	rm -rf $(output)
-	$(openapi-generator-cli) generate \
-		-i build/spec/json/$(spec).json \
-		-g $(generator) \
-		-c ./templates/config.yaml \
-		-o $(output) \
-		--global-property apis,apiTests=false,apiDocs=false\
-		--additional-properties serviceName=$@\
-		--skip-validate-spec
-	mv $(output)/lib/openapi_client/api/*-small.rb lib/adyen/services/$@.rb
-	rm -rf $(output)
-
-templates: $(openapi-generator-jar)
-	$(openapi-generator-cli) author template -g $(generator) -o build/templates
-
-# Download the generator
-$(openapi-generator-jar):
-	wget --quiet -o /dev/null $(openapi-generator-url) -O $(openapi-generator-jar)
-
-build/spec:
-	git clone https://github.com/Adyen/adyen-openapi.git build/spec
-	perl -i -pe's/"openapi" : "3.[0-9].[0-9]"/"openapi" : "3.0.0"/' build/spec/json/*.json
-
-# Releases
-
-version:
-	perl -lne 'print "currentVersion=$$1" if /(\d+\.\d+\.\d+)/' < lib/adyen/version.rb >> "$$GITHUB_OUTPUT"
-
-version_files:=lib/adyen/version.rb
-bump:
-	perl -i -pe 's/$$ENV{"CURRENT_VERSION"}/$$ENV{"NEXT_VERSION"}/' $(version_files)