acquiring-sdk-ruby 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1cf4fab55c249c693a8dc3bf79a073ba4c7872749456176d240a35857e6aaea
-  data.tar.gz: 9fa08df0c3c56e197ed97a2673d56786b6d96b09d578fc98499c709006443853
+  metadata.gz: 65d7222393ac5f2bc3d6fa6738fef483ffd4f9b0dcb77ed5ad390961553accb5
+  data.tar.gz: 97b45c00cea7585aed7b908cd9b1dd91c22a1060e3519a576217df7fd04e53ab
 SHA512:
-  metadata.gz: 9f2f6fdc4c9c9e1f4ad96c0737b1e04d74ed90843dc22722eecba9038168509ef773cf38a99f4fec3e8d0c3e81f0fe5489a3c4d1f08290e0dbdde8ec14109c44
-  data.tar.gz: 0a5a872eb1619a6ae7f292945294c57a9baf8e67a208b22921bfda1088a8927d851c753ce02e7adaa4543539c49f8a4ab030e8420b91bc963dfc9914713b3c88
+  metadata.gz: 7b50b4baee7d42009803815a3d589fb7603933b7b8d6b3f85cfb5dbcdce0db817437cdea48a494126bd9192107e6889639a181e0a44d078ee035c194b727e54a
+  data.tar.gz: 6afbcb7fbbab00f166160127c25777539f6a44a34bb47e4ee3dbadff1058e2a3699d0cecf079a24462904207d5ed16a63a95254c4d105a0f8bcd83f1978622ff

data/acquiring-sdk-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = 'acquiring-sdk-ruby'
-  spec.version        = '1.2.0'
+  spec.version        = '1.3.0'
   spec.authors        = ['Worldline Acquiring']
   spec.email          = ['github.acquiring@worldline.com']
   spec.summary        = %q{SDK to communicate with the Worldline Acquiring platform using the Worldline Acquiring API}

data/lib/worldline/acquiring/sdk/authentication/oauth2_authenticator.rb

@@ -1,6 +1,7 @@
 require 'concurrent'
 require 'worldline/acquiring/sdk/authentication/authenticator'
 require 'worldline/acquiring/sdk/authentication/oauth2_exception'
+require 'worldline/acquiring/sdk/authentication/oauth2_scopes'
 require 'worldline/acquiring/sdk/communication/default_connection'
 require 'worldline/acquiring/sdk/communication/request_header'
 
@@ -17,7 +18,7 @@ module Worldline
 
             def initialize(path, scopes)
               @path = path
-              @scopes = scopes.join(' ')
+              @scopes = scopes
             end
 
             attr_reader :path
@@ -39,10 +40,7 @@ module Worldline
           # While at the moment all scopes fit in one request, keep this code so we can easily add more token types if necessary.
           # The empty path will ensure that all paths will match, as each full path ends with an empty string.
           TOKEN_TYPES = [
-            TokenType.new('', [
-              'processing_payment', 'processing_refund', 'processing_credittransfer', 'processing_accountverification',
-              'processing_balanceinquiry', 'processing_operation_reverse', 'processing_dcc_rate', 'services_ping'
-            ]),
+            TokenType.new('', OAuth2Scopes.all.join(' ')),
           ]
 
           public
@@ -67,14 +65,21 @@ module Worldline
             @connect_timeout = communicator_configuration.connect_timeout
             @socket_timeout = communicator_configuration.socket_timeout
             @proxy_configuration = communicator_configuration.proxy_configuration
+
+            oauth2_scopes = communicator_configuration.oauth2_scopes
+            if oauth2_scopes.nil? || oauth2_scopes.empty?
+              @path_to_scopes_mapper = lambda { |path| get_token_type(path).scopes }
+            else
+              @path_to_scopes_mapper = lambda { |_| oauth2_scopes }
+            end
           end
 
           # @param http_method     [String, nil] 'GET', 'PUT', 'POST' or 'DELETE' indicating which HTTP method will be used with the request
           # @param resource_uri    [URI::HTTP, nil] URI object that includes #path and #query of the URL that will be used, #query may be *nil*
           # @param request_headers [Array<Worldline::Acquiring::SDK::Communication::RequestHeader>, nil] all headers used by the request
           def get_authorization(http_method, resource_uri, request_headers)
-            token_type = get_token_type(resource_uri&.path)
-            access_token = @access_tokens.compute(token_type.path) { |existing_token| get_valid_access_token(existing_token, token_type) }
+            scopes = @path_to_scopes_mapper.call(resource_uri&.path)
+            access_token = @access_tokens.compute(scopes) { |existing_token| get_valid_access_token(existing_token, scopes) }
             "Bearer #{access_token.token}"
           end
 
@@ -89,9 +94,9 @@ module Worldline
             raise ArgumentError.new("scope could not be found for path '#{full_path}'")
           end
 
-          def get_valid_access_token(existing_token, token_type)
+          def get_valid_access_token(existing_token, scopes)
             if is_token_invalid(existing_token)
-              return get_access_token(token_type)
+              return get_access_token(scopes)
             end
             existing_token
           end
@@ -100,9 +105,9 @@ module Worldline
             not access_token or access_token.expiration < Time.now
           end
 
-          def get_access_token(token_type)
+          def get_access_token(scopes)
             request_headers = [RequestHeader.new('Content-Type', 'application/x-www-form-urlencoded')]
-            request_body = "grant_type=client_credentials&client_id=#{@client_id}&client_secret=#{@client_secret}&scope=#{token_type.scopes}"
+            request_body = "grant_type=client_credentials&client_id=#{@client_id}&client_secret=#{@client_secret}&scope=#{scopes}"
 
             start_time = Time.now
 

data/lib/worldline/acquiring/sdk/authentication/oauth2_scopes.rb

@@ -0,0 +1,73 @@
+#
+# This file was automatically generated.
+#
+module Worldline
+  module Acquiring
+    module SDK
+      module Authentication
+        module OAuth2Scopes
+          private
+
+          SCOPES_BY_OPERATION = {
+            "v1" => {
+              "processPayment" => ["processing_payment"],
+              "getPaymentStatus" => ["processing_payment"],
+              "simpleCaptureOfPayment" => ["processing_payment"],
+              "reverseAuthorization" => ["processing_payment"],
+              "incrementPayment" => ["processing_payment"],
+              "createRefund" => ["processing_refund"],
+              "processStandaloneRefund" => ["processing_refund"],
+              "getRefund" => ["processing_refund"],
+              "captureRefund" => ["processing_refund"],
+              "reverseRefundAuthorization" => ["processing_refund"],
+              "processAccountVerification" => ["processing_accountverification"],
+              "processBalanceInquiry" => ["processing_balanceinquiry"],
+              "technicalReversal" => ["processing_operation_reverse"],
+              "requestDccRate" => ["processing_dcc_rate"],
+              "ping" => ["services_ping"]
+            }
+          }
+
+          ALL_SCOPES = SCOPES_BY_OPERATION.values.map { |m| m.values }.flatten.uniq.freeze
+
+          public
+
+          # Returns all available scopes.
+          def self.all
+            ALL_SCOPES
+          end
+
+          # Returns all scopes needed for all operations of the given API version.
+          def self.for_api_version(api_version)
+            operations = SCOPES_BY_OPERATION[api_version] || {}
+            operations.values.flatten.uniq.freeze
+          end
+
+          # Returns all scopes needed for the given operation of the given API version.
+          def self.for_operation(api_version, operation_id)
+            operations = SCOPES_BY_OPERATION[api_version] || {}
+            scopes = operations[operation_id] || []
+            scopes.uniq.freeze
+          end
+
+          # Returns all scopes needed for the given operations of the given API version.
+          def self.for_operations(api_version, *operation_ids)
+            operations = SCOPES_BY_OPERATION[api_version] || {}
+            operation_ids.map { |operation_id| operations[operation_id] || [] }.flatten.uniq.freeze
+          end
+
+          # Returns all scopes needed for the operations that pass the given filter.
+          # The first argument to the filter is the API version, the second is the operation id.
+          def self.for_filtered_operations(filter)
+            SCOPES_BY_OPERATION.keys.map { |api_version|
+              operations = SCOPES_BY_OPERATION[api_version]
+              operations.keys
+                        .filter { |operation_id| filter.call(api_version, operation_id) }
+                        .map { |operation_id| operations[operation_id] }
+            }.flatten.uniq.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/worldline/acquiring/sdk/communication/metadata_provider.rb

@@ -14,7 +14,7 @@ module Worldline
         class MetadataProvider
           private
 
-          SDK_VERSION = '1.2.0'.freeze
+          SDK_VERSION = '1.3.0'.freeze
           SERVER_META_INFO_HEADER = 'X-WL-ServerMetaInfo'.freeze
           PROHIBITED_HEADERS = [SERVER_META_INFO_HEADER, 'Date', 'Content-Type', 'Authorization'].sort!.freeze
           CHARSET = 'utf-8'.freeze

data/lib/worldline/acquiring/sdk/communicator_configuration.rb

@@ -11,6 +11,7 @@ module Worldline
       # @attr [String] authorization_secret A secret used for authorization. The meaning of this secret is different for each authorization type.
       #                                     For instance, for OAuth2 this is the client secret
       # @attr [String] oauth2_token_uri     The OAuth2 token URI
+      # @attr [String] oauth2_scopes        The OAuth2 scopes; leave empty to let the SDK provide a set of defaults
       # @attr [String] authorization_type   String representing the authentication algorithm used
       # @attr [Integer] connect_timeout     The number of seconds before a connection attempt with the Worldline Acquiring platform times out.
       # @attr [Integer] socket_timeout      The number of seconds before a timeout occurs when transmitting data to or from the Worldline Acquiring platform.
@@ -50,6 +51,7 @@ module Worldline
         # @param oauth2_client_secret    [String, nil] The OAuth2 client secret.
         #                                This is an alias for _authorization_secret_.
         # @param oauth2_token_uri        [String, nil] The OAuth2 token URI.
+        # @param oauth2_scopes           [String, nil] The OAuth2 scopes; leave empty to let the SDK provide a set of defaults
         # @param authorization_type      [String, nil] string describing the authorization protocol to follow.
         # @param connect_timeout         [Integer, nil] the number of seconds before a connection attempt with the Worldline Acquiring platform times out.
         # @param socket_timeout          [Integer, nil] the number of seconds before a timeout occurs when transmitting data to or from the Worldline Acquiring platform.
@@ -61,7 +63,7 @@ module Worldline
         # @param shopping_cart_extension [Worldline::Acquiring::SDK::Domain::ShoppingCartExtension, nil] stores shopping cart-related metadata.
         def initialize(properties: nil, api_endpoint: nil,
                        authorization_id: nil, authorization_secret: nil,
-                       oauth2_client_id: nil, oauth2_client_secret: nil, oauth2_token_uri: nil,
+                       oauth2_client_id: nil, oauth2_client_secret: nil, oauth2_token_uri: nil, oauth2_scopes: nil,
                        authorization_type: nil,
                        connect_timeout: nil, socket_timeout: nil,
                        max_connections: nil, proxy_configuration: nil,
@@ -70,6 +72,7 @@ module Worldline
             @api_endpoint = get_endpoint(properties)
             @authorization_type = Authentication::AuthorizationType.get_authorization(properties['acquiring.api.authorizationType'])
             @oauth2_token_uri = properties['acquiring.api.oauth2.tokenUri']
+            @oauth2_scopes = properties['acquiring.api.oauth2.scopes']
             @connect_timeout = properties['acquiring.api.connectTimeout']
             @socket_timeout = properties['acquiring.api.socketTimeout']
             @max_connections = get_property(properties, 'acquiring.api.maxConnections', DEFAULT_MAX_CONNECTIONS)
@@ -104,6 +107,9 @@ module Worldline
           if oauth2_token_uri
             @oauth2_token_uri = oauth2_token_uri
           end
+          if oauth2_scopes
+            @oauth2_scopes = oauth2_scopes
+          end
           if authorization_type
             @authorization_type = authorization_type
           end
@@ -132,6 +138,7 @@ module Worldline
         attr_accessor :authorization_id
         attr_accessor :authorization_secret
         attr_accessor :oauth2_token_uri
+        attr_accessor :oauth2_scopes
         attr_accessor :authorization_type
 
         attr_accessor :connect_timeout

data/spec/integration/custom_oauth2_scopes_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'yaml'
+require 'integration_setup'
+require 'webmock/rspec'
+
+describe 'custom OAuth2 scopes' do
+
+  before(:context){WebMock.allow_net_connect!}
+  after(:context){WebMock.disable_net_connect!}
+
+  ['processing_dcc_rate', 'processing_dcc_rate services_ping', '', nil].each do |oauth2_scopes|
+    it "'#{oauth2_scopes || 'nil'}' are valid" do
+      configuration = Integration.init_communicator_configuration
+      configuration.oauth2_scopes = oauth2_scopes
+
+      Factory.create_client_from_configuration(configuration) do |client|
+        request = Integration.get_dcc_rate_request
+        response = client.v1.acquirer(Integration::ACQUIRER_ID).merchant(Integration::MERCHANT_ID).dynamic_currency_conversion.request_dcc_rate(request)
+
+        expect(response.proposal).to_not be_nil
+        expect(response.proposal.original_amount).to_not be_nil
+        expect(response.proposal.original_amount.amount).to eq(request.transaction.amount.amount)
+        expect(response.proposal.original_amount.currency_code).to eq(request.transaction.amount.currency_code)
+        expect(response.proposal.original_amount.number_of_decimals).to eq(request.transaction.amount.number_of_decimals)
+        expect(response.proposal.resulting_amount.currency_code).to eq(request.target_currency)
+      end
+    end
+  end
+
+  it 'misses required scope' do
+    configuration = Integration.init_communicator_configuration
+    configuration.oauth2_scopes = 'services_ping'
+
+    Factory.create_client_from_configuration(configuration) do |client|
+      request = Integration.get_dcc_rate_request
+      expect{client.v1.acquirer(Integration::ACQUIRER_ID).merchant(Integration::MERCHANT_ID).dynamic_currency_conversion.request_dcc_rate(request)}
+        .to raise_error(Worldline::Acquiring::SDK::V1::AuthorizationException)
+    end
+  end
+
+  it 'has an invalid scope' do
+    configuration = Integration.init_communicator_configuration
+    configuration.oauth2_scopes = 'processing_dcc_rate invalid_scope'
+
+    Factory.create_client_from_configuration(configuration) do |client|
+      request = Integration.get_dcc_rate_request
+      expect {client.v1.acquirer(Integration::ACQUIRER_ID).merchant(Integration::MERCHANT_ID).dynamic_currency_conversion.request_dcc_rate(request)}
+        .to raise_error(Worldline::Acquiring::SDK::Authentication::OAuth2Exception)
+              .with_message(/There was an error while retrieving the OAuth2 access token: invalid_scope - .*/)
+    end
+  end
+end

data/spec/lib/authentication/oauth2_scopes_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe 'OAuth2Scopes' do
+
+  it 'all should contain the correct scopes' do
+    all_scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.all
+    expect(all_scopes).to include('processing_payment')
+    expect(all_scopes).to include('processing_dcc_rate')
+    expect(all_scopes).to include('services_ping')
+
+    all_scopes_string = all_scopes.join(' ')
+    expect(all_scopes_string.length).to be <= 260
+  end
+
+  it 'for v1 should contain the correct scopes' do
+    scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.for_api_version('v1')
+    expect(scopes).to include('processing_payment')
+    expect(scopes).to include('processing_dcc_rate')
+    expect(scopes).to include('services_ping')
+  end
+
+  it 'for an unknown API version should contain no scopes' do
+    scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.for_api_version('v-1')
+    expect(scopes).to eq([])
+  end
+
+  it 'for v1 processPayment should contain the correct scopes' do
+    scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.for_operation('v1', 'processPayment')
+    expect(scopes).to include('processing_payment')
+  end
+
+  it 'for v1 requestDccRate should contain the correct scopes' do
+    scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.for_operation('v1', 'requestDccRate')
+    expect(scopes).to include('processing_dcc_rate')
+  end
+
+  it 'for an unknown operation should contain no scopes' do
+    scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.for_operation('v1', 'unknown')
+    expect(scopes).to eq([])
+  end
+
+  it 'for an unknown API version should contain no scopes' do
+    scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.for_operation('v-1', 'processPayment')
+    expect(scopes).to eq([])
+  end
+
+  it 'for multiple v1 operations should contain the correct scopes' do
+    scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.for_operations('v1', 'processPayment', 'requestDccRate', 'unknown')
+    expect(scopes).to include('processing_payment')
+    expect(scopes).to include('processing_dcc_rate')
+    expect(scopes).not_to include('services_ping')
+  end
+
+  it 'for multiple operations of an unknown API version should contain no scopes' do
+    scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.for_operations('v-1', 'processPayment', 'requestDccRate')
+    expect(scopes).to eq([])
+  end
+
+  it 'for filtered operations should contain the correct scopes' do
+    operation_ids = [ 'processPayment', 'requestDccRate', 'unknown' ]
+    scopes = Worldline::Acquiring::SDK::Authentication::OAuth2Scopes.for_filtered_operations(lambda { |api_version, operation_id| api_version == 'v1' && operation_ids.include?(operation_id) })
+    expect(scopes).to include('processing_payment')
+    expect(scopes).to include('processing_dcc_rate')
+    expect(scopes).not_to include('services_ping')
+  end
+end

data/spec/lib/communicator_configuration_spec.rb

@@ -22,6 +22,7 @@ describe 'CommunicatorConfiguration' do
 
     expect(communicator_config.authorization_id).to be_nil
     expect(communicator_config.authorization_secret).to be_nil
+    expect(communicator_config.oauth2_scopes).to be_nil
     expect(communicator_config.proxy_configuration).to be_nil
     expect(communicator_config.integrator).to be_nil
     expect(communicator_config.shopping_cart_extension).to be_nil
@@ -46,6 +47,7 @@ describe 'CommunicatorConfiguration' do
 
     expect(communicator_config.authorization_id).to be_nil
     expect(communicator_config.authorization_secret).to be_nil
+    expect(communicator_config.oauth2_scopes).to be_nil
     expect(proxy_config).to be_truthy
     expect(proxy_config.scheme).to eq('http')
     expect(proxy_config.host).to eq('proxy.example.org')
@@ -75,6 +77,7 @@ describe 'CommunicatorConfiguration' do
 
     expect(communicator_config.authorization_id).to be_nil
     expect(communicator_config.authorization_secret).to be_nil
+    expect(communicator_config.oauth2_scopes).to be_nil
     expect(proxy_config).to be_truthy
     expect(proxy_config.scheme).to eq('http')
     expect(proxy_config.host).to eq('proxy.example.org')
@@ -102,6 +105,7 @@ describe 'CommunicatorConfiguration' do
 
     expect(communicator_config.authorization_id).to be_nil
     expect(communicator_config.authorization_secret).to be_nil
+    expect(communicator_config.oauth2_scopes).to be_nil
     expect(communicator_config.proxy_configuration).to be_nil
   end
 
@@ -170,6 +174,7 @@ describe 'CommunicatorConfiguration' do
 
     expect(communicator_config.authorization_id).to be_nil
     expect(communicator_config.authorization_secret).to be_nil
+    expect(communicator_config.oauth2_scopes).to be_nil
     expect(communicator_config.proxy_configuration).to be_nil
     expect(communicator_config.integrator).to eq('Worldline.Integrator')
     expect(communicator_config.shopping_cart_extension).to be_truthy
@@ -178,4 +183,22 @@ describe 'CommunicatorConfiguration' do
     expect(communicator_config.shopping_cart_extension.version).to eq('1.0')
     expect(communicator_config.shopping_cart_extension.extension_id).to eq('ExtensionId')
   end
+
+  it 'stores custom OAuth2 scopes' do
+    yaml = '---
+            acquiring.api.endpoint.host: api.preprod.acquiring.worldline-solutions.com
+            acquiring.api.authorizationType: OAuth2
+            acquiring.api.oauth2.scopes: processing_dcc_rate invalid_scope
+            acquiring.api.connectTimeout: 20
+            acquiring.api.socketTimeout: 10'
+    config = YAML.load(yaml)
+
+    communicator_config = CommunicatorConfiguration.new(properties: config)
+
+    expect(communicator_config.api_endpoint).to eq('https://api.preprod.acquiring.worldline-solutions.com')
+    expect(communicator_config.authorization_type).to eq('OAuth2')
+    expect(communicator_config.connect_timeout).to eq(20)
+    expect(communicator_config.socket_timeout).to eq(10)
+    expect(communicator_config.oauth2_scopes).to eq('processing_dcc_rate invalid_scope')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acquiring-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Worldline Acquiring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-19 00:00:00.000000000 Z
+date: 2025-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -148,6 +148,7 @@ files:
 - lib/worldline/acquiring/sdk/authentication/authorization_type.rb
 - lib/worldline/acquiring/sdk/authentication/oauth2_authenticator.rb
 - lib/worldline/acquiring/sdk/authentication/oauth2_exception.rb
+- lib/worldline/acquiring/sdk/authentication/oauth2_scopes.rb
 - lib/worldline/acquiring/sdk/call_context.rb
 - lib/worldline/acquiring/sdk/client.rb
 - lib/worldline/acquiring/sdk/communication.rb
@@ -302,12 +303,14 @@ files:
 - spec/fixtures/resources/properties.oauth2.yml
 - spec/fixtures/resources/properties.proxy.yml
 - spec/integration/connection_pooling_spec.rb
+- spec/integration/custom_oauth2_scopes_spec.rb
 - spec/integration/multipart_form_data_spec.rb
 - spec/integration/process_payment_spec.rb
 - spec/integration/request_dcc_rate_spec.rb
 - spec/integration/sdk_proxy_spec.rb
 - spec/integration_setup.rb
 - spec/lib/authentication/oauth2_authenticator_spec.rb
+- spec/lib/authentication/oauth2_scopes_spec.rb
 - spec/lib/client_spec.rb
 - spec/lib/communication/default_connection_logger_spec.rb
 - spec/lib/communication/default_connection_spec.rb
@@ -367,12 +370,14 @@ test_files:
 - spec/fixtures/resources/properties.oauth2.yml
 - spec/fixtures/resources/properties.proxy.yml
 - spec/integration/connection_pooling_spec.rb
+- spec/integration/custom_oauth2_scopes_spec.rb
 - spec/integration/multipart_form_data_spec.rb
 - spec/integration/process_payment_spec.rb
 - spec/integration/request_dcc_rate_spec.rb
 - spec/integration/sdk_proxy_spec.rb
 - spec/integration_setup.rb
 - spec/lib/authentication/oauth2_authenticator_spec.rb
+- spec/lib/authentication/oauth2_scopes_spec.rb
 - spec/lib/client_spec.rb
 - spec/lib/communication/default_connection_logger_spec.rb
 - spec/lib/communication/default_connection_spec.rb