onlinepayments-sdk-ruby 4.16.0 → 4.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0bb67c94bd5f8e000fb9688e71e346837dde955160058f9b6db9950797ebc5a
-  data.tar.gz: 4aadeaeba5d777d2c857bf082fe142349b61c6fe7f4d29b169b20d6dadd7b5c8
+  metadata.gz: 8e68d841d58a8709600390682acb7d45a026ce6996b259bb37291a63d84078ba
+  data.tar.gz: 99c0448333f7ccdacd4fd945b6d712e075dcb39ad27f4d541f66ddbc1558fad0
 SHA512:
-  metadata.gz: 30f4dfeb625a981c46c9955d9087a44c6e3938695e07b912b1b40fe6b4989d2cc39c0daf822238f1968f37f4be6915f00b39ed19f1aac3e52876ca119fb83d45
-  data.tar.gz: 7b2ca1a1b946893ec1044e19104a112158a087500adab1049295d00cf86ac2da9130a44f9ceeb47f3ae405e19fa7866fdbe3b9b12a2b4a3daf0761d50dc849a3
+  metadata.gz: 9caf954ae7682487cfd861661aacf9c504bd21cc63bbb0c0deb526b434df8778cd0ba9483104a1875fd7e356c1198a6885bbc749eda4409b3b917853376b43eb
+  data.tar.gz: da2a8e03c1ee39abab4e5713b01f9e175a8213fe5efddfb8d8fc641ccecfb03fffcf98a60ed0665c8a3d8dcbaaa92916c0105db1daaf125aee4771c06bd6a754

data/lib/onlinepayments/sdk/communicator.rb

@@ -104,7 +104,8 @@ module OnlinePayments::SDK
     # @param relative_path      [String] Path relative to the API endpoint
     # @param request_headers    [Array<OnlinePayments::SDK::RequestHeader>, nil] Optional array of request headers
     # @param request_parameters [OnlinePayments::SDK::ParamRequest, nil] Optional request parameters
-    # @param request_body       [OnlinePayments::SDK::DataObject] The optional request body
+    # @param request_body       [OnlinePayments::SDK::DataObject, OnlinePayments::SDK::MultipartFormDataObject, OnlinePayments::SDK::MultipartFormDataRequest] 
+    #                           The optional request body
     # @param response_type      [Type] The response type.
     # @param context            [OnlinePayments::SDK::CallContext, nil] Optional call context.
     # @return The response of the POST request as the given response type
@@ -119,7 +120,14 @@ module OnlinePayments::SDK
       request_headers ||= []
 
       body = nil
-      if request_body
+      if request_body.is_a? MultipartFormDataObject
+        request_headers.push(RequestHeader.new('Content-Type', request_body.content_type))
+        body = request_body
+      elsif request_body.is_a? MultipartFormDataRequest
+        multipart = request_body.to_multipart_form_data_object
+        request_headers.push(RequestHeader.new('Content-Type', multipart.content_type))
+        body = multipart
+      elsif request_body
         request_headers.push(RequestHeader.new('Content-Type', 'application/json'))
         body = @marshaller.marshal(request_body)
       else

data/lib/onlinepayments/sdk/defaultimpl/default_connection.rb

@@ -19,6 +19,7 @@ module OnlinePayments::SDK
       using RefineHTTPClient
 
       CONTENT_TYPE = 'Content-Type'.freeze
+      X_REQUEST_ID_HEADER = 'X-Request-Id'.freeze
       JSON_CONTENT_TYPE = 'application/json'.freeze
 
       # @param args [Hash] the parameters to initialize the connection with
@@ -144,12 +145,16 @@ module OnlinePayments::SDK
       # @param method          [String] 'GET', 'DELETE', 'POST' or 'PUT' depending on the HTTP method being used.
       # @param uri             [URI::HTTP] full URI of the location the request is targeted at, including query parameters.
       # @param request_headers [Array<OnlinePayments::SDK::RequestHeader>] list of headers that should be used as HTTP headers in the request.
-      # @param body            [String] request body.
+      # @param body            [String, OnlinePayments::SDK::MultipartFormDataObject] request body.
       # @yield (Integer, Array<OnlinePayments::SDK::ResponseHeader>, IO) The status code, headers and body of the response.
       # @raise [OnlinePayments::SDK::CommunicationException] when communication with the Online Payments platform was not successful.
       def request(method, uri, request_headers, body = nil)
         request_headers = convert_from_headers(request_headers)
         request_id = SecureRandom.uuid
+
+        # set X-Request-Id for better traceability
+        request_headers[X_REQUEST_ID_HEADER] = request_id
+
         content_type = request_headers[CONTENT_TYPE]
 
         info = { headers: request_headers, content_type: content_type }
@@ -163,14 +168,29 @@ module OnlinePayments::SDK
           response_status_code = nil
           response_content_type = nil
           response_body = ''
-          raw_request(method, uri, request_headers, body) do |status_code, headers, r_content_type, r_body|
-            response_headers = headers
-            response_status_code = status_code
-            response_content_type = r_content_type
-            response_body = r_body.read.force_encoding('UTF-8')
-            r_body = StringIO.new(response_body)
-
-            yield status_code, headers, r_body
+
+          if body.is_a? OnlinePayments::SDK::MultipartFormDataObject
+            multipart_request(method, uri, request_headers, body) do |status_code, headers, r_content_type, r_body|
+              response_headers = headers
+              response_status_code = status_code
+              response_content_type = r_content_type
+              unless binary_content_type? response_content_type
+                response_body = r_body.read.force_encoding('UTF-8')
+                r_body = StringIO.new(response_body)
+              end
+
+              yield status_code, headers, r_body
+            end
+          else
+            raw_request(method, uri, request_headers, body) do |status_code, headers, r_content_type, r_body|
+              response_headers = headers
+              response_status_code = status_code
+              response_content_type = r_content_type
+              response_body = r_body.read.force_encoding('UTF-8')
+              r_body = StringIO.new(response_body)
+
+              yield status_code, headers, r_body
+            end
           end
 
           log_response(request_id, response_status_code, start_time,
@@ -290,6 +310,52 @@ module OnlinePayments::SDK
           pipe.close
         end
       end
+
+      # Makes a request using the specified method
+      #
+      # Yields a status code, an array of {OnlinePayments::SDK::ResponseHeader},
+      # the content_type and body
+      def multipart_request(method, uri, headers, body = nil)
+        unless body.is_a? OnlinePayments::SDK::MultipartFormDataObject
+          raise ArgumentError, 'body should be a MultipartFormDataObject'
+        end
+
+        if method != 'post' && method != 'put'
+          raise ArgumentError, "method #{method} is not supported"
+        end
+
+        connection = @http_client.send method + '_async',
+                                       uri,
+                                       body: multipart_request_body(body),
+                                       header: headers
+
+        response = connection.pop
+        pipe = response.content
+        response_headers = convert_to_sdk_response_headers(response.headers)
+
+        begin
+          yield response.status_code, response_headers, response.content_type, pipe
+        ensure
+          pipe.close
+        end
+      end
+
+      # Creates a request body for the multipart request
+      def multipart_request_body( body )
+        request_body = []
+        body.files.each do |k, v|
+          request_body.push :content => v.content,
+                            'Content-Type' => v.content_type,
+                            'Content-Disposition' => "form-data; name=\"#{k}\"; filename=\"#{v.file_name}\"",
+                            'Content-Transfer-Encoding' => 'binary'
+        end
+
+        body.values.each do |k, v|
+          request_body << { :content => v,
+                            'Content-Disposition' => "form-data; name=\"#{k}\"" }
+        end
+        request_body
+      end
     end
   end
 end

data/lib/onlinepayments/sdk/multipart_form_data_object.rb

@@ -0,0 +1,44 @@
+require 'securerandom'
+
+module OnlinePayments::SDK
+
+  # A representation of a multipart/form-data object
+  class MultipartFormDataObject
+    def initialize
+      @boundary = SecureRandom.uuid
+      @content_type = 'multipart/form-data; boundary=' + @boundary
+      @values = {}
+      @files = {}
+    end
+
+    attr_reader :boundary
+    attr_reader :content_type
+    attr_reader :values
+    attr_reader :files
+
+    def add_value(parameter_name, value)
+      if parameter_name.nil? || parameter_name.strip.empty?
+        raise ArgumentError, 'parameter_name is required'
+      end
+      raise ArgumentError, 'value is required' if value.nil?
+      if @values.include?(parameter_name) || @files.include?(parameter_name)
+        raise ArgumentError, 'duplicate parameterName: ' + parameter_name
+      end
+
+      @values[parameter_name] = value
+    end
+
+    # Adds a file to the multipart Form Data Object
+    def add_file(parameter_name, uploadable_file)
+      if parameter_name.nil? || parameter_name.strip.empty?
+        raise ArgumentError, 'parameter_name is required'
+      end
+      raise ArgumentError, 'uploadable_file is required' if uploadable_file.nil?
+      if @values.include?(parameter_name) || @files.include?(parameter_name)
+        raise ArgumentError, 'duplicate parameterName: ' + parameter_name
+      end
+
+      @files[parameter_name] = uploadable_file
+    end
+  end
+end

data/lib/onlinepayments/sdk/multipart_form_data_request.rb

@@ -0,0 +1,9 @@
+module OnlinePayments::SDK
+  # A representation of a multipart/form-data request
+  class MultipartFormDataRequest
+    # @return [OnlinePayments::SDK::MultipartFormDataObject]
+    def to_multipart_form_data_object
+      raise NotImplementedError
+    end
+  end
+end

data/lib/onlinepayments/sdk/uploadable_file.rb

@@ -0,0 +1,30 @@
+module OnlinePayments::SDK
+
+    # A file that can be uploaded
+    #
+    # The allowed forms of content are defined by the Connection implementation
+    # The default implementation supports file paths and IO objects.
+    #
+    # @attr_reader [String] file_name       The name of the file.
+    # @attr_reader [String, IO] content     The file's content.
+    # @attr_reader [String] content_type    The file's content type.
+    # @attr_reader [Integer] content_length The file's content length, or -1 if not known.
+    class UploadableFile
+
+        def initialize(file_name, content, content_type, content_length=-1)
+            raise ArgumentError.new("file_name is required") if file_name.nil? or !file_name.strip
+            raise ArgumentError.new("content is required") if content.nil?
+            raise ArgumentError.new("content_type is required") if content_type.nil? or !content_type.strip
+
+            @file_name = file_name
+            @content = content
+            @content_type = content_type
+            @content_length = [content_length, -1].max
+        end
+
+        attr_reader :file_name
+        attr_reader :content
+        attr_reader :content_type
+        attr_reader :content_length
+    end
+end

data/onlinepayments-sdk-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = 'onlinepayments-sdk-ruby'
-  spec.version        = '4.16.0'
+  spec.version        = '4.17.0'
   spec.authors        = ['Worldline Direct support team']
   spec.email          = ['82139942+worldline-direct-support-team@users.noreply.github.com']
   spec.summary        = %q{SDK to communicate with the Online Payments platform using the Online Payments Server API}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onlinepayments-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 4.16.0
+  version: 4.17.0
 platform: ruby
 authors:
 - Worldline Direct support team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -416,6 +416,8 @@ files:
 - lib/onlinepayments/sdk/merchant/tokens/tokens_client.rb
 - lib/onlinepayments/sdk/meta_data_provider.rb
 - lib/onlinepayments/sdk/modules.rb
+- lib/onlinepayments/sdk/multipart_form_data_object.rb
+- lib/onlinepayments/sdk/multipart_form_data_request.rb
 - lib/onlinepayments/sdk/not_found_exception.rb
 - lib/onlinepayments/sdk/param_request.rb
 - lib/onlinepayments/sdk/payment_platform_exception.rb
@@ -426,6 +428,7 @@ files:
 - lib/onlinepayments/sdk/request_param.rb
 - lib/onlinepayments/sdk/response_exception.rb
 - lib/onlinepayments/sdk/response_header.rb
+- lib/onlinepayments/sdk/uploadable_file.rb
 - lib/onlinepayments/sdk/validation_exception.rb
 - lib/onlinepayments/sdk/webhooks.rb
 - lib/onlinepayments/sdk/webhooks/api_version_mismatch_exception.rb