acquiring-sdk-ruby 0.1.0

data/lib/worldline/acquiring/sdk/v1/ping/ping_client.rb

@@ -0,0 +1,52 @@
+#
+# This file was automatically generated.
+#
+require 'worldline/acquiring/sdk/api_resource'
+require 'worldline/acquiring/sdk/communication/response_exception'
+require 'worldline/acquiring/sdk/v1/exception_factory'
+require 'worldline/acquiring/sdk/v1/domain/api_payment_error_response'
+
+module Worldline
+  module Acquiring
+    module SDK
+      module V1
+        module Ping
+          # Ping client. Thread-safe.
+          class PingClient < Worldline::Acquiring::SDK::ApiResource
+
+            # @param parent       [Worldline::Acquiring::SDK::ApiResource]
+            # @param path_context [Hash, nil]
+            def initialize(parent, path_context)
+              super(parent: parent, path_context: path_context)
+            end
+
+            # Resource /services/v1/ping - {https://docs.acquiring.worldline-solutions.com/api-reference#tag/Ping/operation/ping Check API connection}
+            #
+            # @param context [Worldline::Acquiring::SDK::CallContext, nil]
+            # @raise [Worldline::Acquiring::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+            # @raise [Worldline::Acquiring::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
+            # @raise [Worldline::Acquiring::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
+            #        or there was a conflict (HTTP status code 404, 409 or 410)
+            # @raise [Worldline::Acquiring::SDK::V1::PlatformException] if something went wrong at the Worldline Acquiring platform,
+            #        the Worldline Acquiring platform was unable to process a message from a downstream partner/acquirer,
+            #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+            # @raise [Worldline::Acquiring::SDK::V1::ApiException] if the Worldline Acquiring platform returned any other error
+            def ping(context = nil)
+              uri = instantiate_uri('/services/v1/ping', nil)
+              @communicator.get(
+                uri,
+                nil,
+                nil,
+                nil,
+                context)
+            rescue Worldline::Acquiring::SDK::Communication::ResponseException => e
+              error_type = Worldline::Acquiring::SDK::V1::Domain::ApiPaymentErrorResponse
+              error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+              raise Worldline::Acquiring::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/worldline/acquiring/sdk/v1/ping.rb

@@ -0,0 +1,4 @@
+#
+# This file was automatically generated.
+#
+Dir[File.join(__dir__, 'ping', '*.rb')].each { |f| require f }

data/lib/worldline/acquiring/sdk/v1/platform_exception.rb

@@ -0,0 +1,23 @@
+#
+# This file was automatically generated.
+#
+require_relative 'api_exception'
+
+module Worldline
+  module Acquiring
+    module SDK
+      module V1
+        # Represents an error response from the Worldline Acquiring platform when something went wrong at the Worldline Acquiring platform or further downstream.
+        class PlatformException < ApiException
+
+          # Create a new PlatformException.
+          # @see ApiException#initialize
+          def initialize(status_code, response_body, type, title, status, detail, instance,
+                         message='The Worldline Acquiring platform returned an error response')
+            super(status_code, response_body, type, title, status, detail, instance, message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/worldline/acquiring/sdk/v1/reference_exception.rb

@@ -0,0 +1,23 @@
+#
+# This file was automatically generated.
+#
+require_relative 'api_exception'
+
+module Worldline
+  module Acquiring
+    module SDK
+      module V1
+        # Represents an error response from the Worldline Acquiring platform when a non-existing or removed object is trying to be accessed.
+        class ReferenceException < ApiException
+
+          # Create a new ReferenceException.
+          # @see ApiException#initialize
+          def initialize(status_code, response_body, type, title, status, detail, instance,
+                         message='The Worldline Acquiring platform returned a reference error response')
+            super(status_code, response_body, type, title, status, detail, instance, message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/worldline/acquiring/sdk/v1/v1_client.rb

@@ -0,0 +1,43 @@
+#
+# This file was automatically generated.
+#
+require 'worldline/acquiring/sdk/api_resource'
+require 'worldline/acquiring/sdk/v1/acquirer/acquirer_client'
+require 'worldline/acquiring/sdk/v1/ping/ping_client'
+
+module Worldline
+  module Acquiring
+    module SDK
+      module V1
+        # V1 client.
+        #
+        # Thread safe.
+        class V1Client < Worldline::Acquiring::SDK::ApiResource
+
+          # @param parent       [Worldline::Acquiring::SDK::ApiResource]
+          # @param path_context [Hash, nil]
+          def initialize(parent, path_context)
+            super(parent: parent, path_context: path_context)
+          end
+
+          # Resource /processing/v1/{acquirerId}
+          #
+          # @param acquirer_id [String]
+          # @return [Worldline::Acquiring::SDK::V1::Acquirer::AcquirerClient]
+          def acquirer(acquirer_id)
+            Worldline::Acquiring::SDK::V1::Acquirer::AcquirerClient.new(self, {
+              'acquirerId'.freeze => acquirer_id,
+            })
+          end
+
+          # Resource /services/v1/ping
+          #
+          # @return [Worldline::Acquiring::SDK::V1::Ping::PingClient]
+          def ping
+            Worldline::Acquiring::SDK::V1::Ping::PingClient.new(self, nil)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/worldline/acquiring/sdk/v1/validation_exception.rb

@@ -0,0 +1,23 @@
+#
+# This file was automatically generated.
+#
+require_relative 'api_exception'
+
+module Worldline
+  module Acquiring
+    module SDK
+      module V1
+        # Represents an error response from the Worldline Acquiring platform when validation of requests failed.
+        class ValidationException < ApiException
+
+          # Create a new ValidationException.
+          # @see ApiException#initialize
+          def initialize(status_code, response_body, type, title, status, detail, instance,
+                         message='The Worldline Acquiring platform returned an incorrect request error response')
+            super(status_code, response_body, type, title, status, detail, instance, message)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+#
+# This file was automatically generated.
+#
+Dir[File.join(__dir__, 'v1', '*.rb')].each { |f| require f }

data/lib/worldline/acquiring/sdk.rb

@@ -0,0 +1 @@
+Dir[File.join(__dir__, 'sdk', '*.rb')].each { |f| require f }

data/spec/comparable_extension.rb

@@ -0,0 +1,29 @@
+require 'worldline/acquiring/sdk/communication/request_param'
+
+module Worldline::Acquiring::SDK::Communication
+
+  # extension of the RequestParam object to support comparison
+  class RequestParam
+
+    def ==(other)
+      other.instance_variables.each do |var|
+        unless instance_variable_get(var).to_s == other.instance_variable_get(var).to_s
+          return false
+        end
+      end
+      true
+    end
+  end
+
+  # extension of the RequestHeader object to support comparison
+  class RequestHeader
+
+    def ==(other)
+      other.instance_variables.each do |var|
+        unless instance_variable_get(var).to_s == other.instance_variable_get(var).to_s
+          return false
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/resources/authentication/oauth2AccessToken.expired.json

@@ -0,0 +1,4 @@
+{
+  "access_token": "expiredAccessToken",
+  "expires_in": -1
+}

data/spec/fixtures/resources/authentication/oauth2AccessToken.invalidClient.json

@@ -0,0 +1,4 @@
+{
+  "error": "unauthorized_client",
+  "error_description": "INVALID_CREDENTIALS: Invalid client credentials"
+}

data/spec/fixtures/resources/authentication/oauth2AccessToken.json

@@ -0,0 +1,4 @@
+{
+  "access_token": "accessToken",
+  "expires_in": 300
+}

data/spec/fixtures/resources/communication/getWithQueryParams.json

@@ -0,0 +1,3 @@
+{
+   "convertedAmount" : 4547504
+}

data/spec/fixtures/resources/communication/getWithoutQueryParams.json

@@ -0,0 +1,3 @@
+{
+    "result": "OK"
+}

data/spec/fixtures/resources/communication/notFound.html

@@ -0,0 +1 @@
+Not Found

data/spec/fixtures/resources/communication/postWithBadRequestResponse.json

@@ -0,0 +1,11 @@
+{
+    "errorId": "0953f236-9e54-4f23-9556-d66bc757dda8",
+    "errors": [
+        {
+            "code": "21000020",
+            "requestId": "24146",
+            "message": "VALUE **************** OF FIELD CREDITCARDNUMBER DID NOT PASS THE LUHNCHECK",
+            "httpStatusCode": 400
+        }
+    ]
+}

data/spec/fixtures/resources/communication/postWithCreatedResponse.json

@@ -0,0 +1,6 @@
+{
+    "payment": {
+        "id": "000000123410000595980000100001",
+        "status": "PENDING_APPROVAL"
+    }
+}

data/spec/fixtures/resources/communication/unknownServerError.json

@@ -0,0 +1,10 @@
+{
+    "errorId": "fbff1179-7ba4-4894-9021-d8a0011d23a7",
+    "errors": [
+        {
+            "code": "9999",
+            "message": "UNKNOWN_SERVER_ERROR",
+            "httpStatusCode": 500
+        }
+    ]
+}

data/spec/fixtures/resources/logging/bodyNoObfuscation.json

@@ -0,0 +1,7 @@
+{
+	"amount": {
+		"currencyCode": "EUR",
+		"amount": 1000
+	},
+	"authorizationType": "PRE_AUTHORIZATION"
+}

data/spec/fixtures/resources/logging/bodyWithBinObfuscated.json

@@ -0,0 +1,3 @@
+{
+    "bin": "123456**"
+}

data/spec/fixtures/resources/logging/bodyWithBinOriginal.json

@@ -0,0 +1,3 @@
+{
+    "bin": "12345678"
+}

data/spec/fixtures/resources/logging/bodyWithCardCustomObfuscated.json

@@ -0,0 +1,13 @@
+{
+	"amount": {
+		"currencyCode": "CAD",
+		"amount": 2345
+	},
+	"cardPaymentData": {
+		"cardData": {
+			"cardSecurityCode": "***",
+			"cardNumber": "123456******3456",
+			"expiryDate": "**2024"
+		}
+	}
+}

data/spec/fixtures/resources/logging/bodyWithCardObfuscated.json

@@ -0,0 +1,13 @@
+{
+	"amount": {
+		"currencyCode": "CAD",
+		"amount": 2345
+	},
+	"cardPaymentData": {
+		"cardData": {
+			"cardSecurityCode": "***",
+			"cardNumber": "************3456",
+			"expiryDate": "**2024"
+		}
+	}
+}

data/spec/fixtures/resources/logging/bodyWithCardOriginal.json

@@ -0,0 +1,13 @@
+{
+	"amount": {
+		"currencyCode": "CAD",
+		"amount": 2345
+	},
+	"cardPaymentData": {
+		"cardData": {
+			"cardSecurityCode": "123",
+			"cardNumber": "1234567890123456",
+			"expiryDate": "122024"
+		}
+	}
+}

data/spec/fixtures/resources/logging/bodyWithObjectObfuscated.json

@@ -0,0 +1,5 @@
+{
+    "name": ****,
+    "name": {
+    }
+}

data/spec/fixtures/resources/logging/bodyWithObjectOriginal.json

@@ -0,0 +1,5 @@
+{
+    "name": true,
+    "name": {
+    }
+}

data/spec/fixtures/resources/properties.oauth2.yml

@@ -0,0 +1,8 @@
+--- # YAML settings used in testing the SDK
+  acquiring.api.endpoint.host: api.preprod.acquiring.worldline-solutions.com
+  acquiring.api.authorizationType: OAuth2
+  acquiring.api.oauth2.tokenUri: https://sso.preprod.acquiring.worldline-solutions.com/auth/realms/acquiring_api/protocol/openid-acquiring/token
+  acquiring.api.connectTimeout: 1000
+  acquiring.api.socketTimeout: 1000
+  acquiring.api.maxConnections: 100
+  acquiring.api.integrator: Worldline

data/spec/fixtures/resources/properties.proxy.yml

@@ -0,0 +1,14 @@
+--- # YAML settings used in testing the SDK
+  acquiring.api.endpoint.host: api.preprod.acquiring.worldline-solutions.com
+  acquiring.api.authorizationType: OAuth2
+  acquiring.api.oauth2.tokenUri: https://sso.preprod.acquiring.worldline-solutions.com/auth/realms/acquiring_api/protocol/openid-acquiring/token
+  acquiring.api.connectTimeout: 1000
+  acquiring.api.socketTimeout: 1000
+  acquiring.api.maxConnections: 10
+  acquiring.api.integrator: Worldline
+  # change uri to preferred proxy
+  acquiring.api.proxy.uri: http://localhost:9999
+  # change username and password to authentication credentials for the proxy, omit the entries if no authentication is required
+  # authentication is done using basic proxy authentication. Therefore, to avoid leaking credentials you should connect to the proxy using SSL
+  acquiring.api.proxy.username: test-user
+  acquiring.api.proxy.password: test-password

data/spec/integration/connection_pooling_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'integration_setup'
+require 'worldline/acquiring/sdk/factory'
+require 'yaml'
+
+describe 'connection pooling with the server' do
+
+  before(:context){WebMock.allow_net_connect!}
+  after(:context){WebMock.disable_net_connect!}
+
+  it 'runs with one connection per request' do
+    run_connection_pooling_test(10, 10)
+  end
+
+  it 'runs with one connection per two requests' do
+    run_connection_pooling_test(10, 5)
+  end
+
+  it 'runs with one connection for 10 requests' do
+    run_connection_pooling_test(10, 1)
+  end
+end
+
+class Event  # as per https://emptysqua.re/blog/an-event-synchronization-primitive-for-ruby/
+  def initialize
+    @lock = Mutex.new
+    @cond = ConditionVariable.new
+    @flag = false
+  end
+
+  def set
+    @lock.synchronize do
+      @flag = true
+      @cond.broadcast
+    end
+  end
+
+  def wait
+    @lock.synchronize do
+      unless @flag
+        @cond.wait(@lock)
+      end
+    end
+  end
+end
+
+# sends *request_count* requests with a maximum number of connections in the connection pool equal to *max_connections*
+def run_connection_pooling_test(request_count, max_connections)
+  configuration = Integration.init_communicator_configuration(max_connections: max_connections)
+  begin
+    communicator = Worldline::Acquiring::SDK::Factory.create_communicator_from_configuration(configuration)
+    flag = Event.new
+    runner_threads = Array.new(request_count){ |i| Thread.new{run_request(i, communicator, flag)} }
+    flag.set
+  ensure
+    communicator.close unless communicator.nil?
+  end
+  results = Array.new(request_count){ |i| runner_threads[i].value }  # returned values are arrays of size 2
+  puts "running times of #{request_count} threads using #{max_connections} connections:"
+  puts "each pair is the thread's start and end time in milliseconds"
+  results.each do |pair|
+    puts pair[0].to_s + ' ' + pair[1].to_s
+  end
+end
+
+def run_request(i, communicator, flag)
+  request = Integration.get_dcc_rate_request
+
+  client = Worldline::Acquiring::SDK::Factory.create_client_from_communicator(communicator)
+  flag.wait
+  start_time = Time.now
+  client.v1.acquirer(Integration::ACQUIRER_ID).merchant(Integration::MERCHANT_ID).dynamic_currency_conversion.request_dcc_rate(request)
+  [start_time.to_i*1000, Time.now.to_i*1000]
+end