connect-sdk-ruby 1.36.0 → 2.0.0

data/lib/ingenico/connect/sdk/webhooks/secret_key_store.rb

@@ -6,8 +6,8 @@ module Ingenico::Connect::SDK
 
       # Retrieve secret key for given key id
       #
-      # key_id:: given key id
-      # Raises {Ingenico::Connect::SDK::Webhooks::SecretKeyNotAvailableException} if the secret key for the given key id is not available.
+      # @param key_id [String] key id of the secret key
+      # @raise [Ingenico::Connect::SDK::Webhooks::SecretKeyNotAvailableException] if the secret key for the given key id is not available.
       def get_secret_key(key_id)
         raise NotImplementedError
       end

data/lib/ingenico/connect/sdk/webhooks/signature_validation_exception.rb

@@ -7,7 +7,7 @@ module Ingenico::Connect::SDK
       # Creates a new SignatureValidationException
       #
       # @param [Hash] args the options to create the Exception with
-      # @option args [String]  :message the error message
+      # @option args [String] :message the error message
       # @option args [RuntimeError] :cause an Error object that causes the Exception
       def initialize(args)
         super(args[:message]) # NOTE: can be nil

data/lib/ingenico/connect/sdk/webhooks/webhooks_event.rb

@@ -1,46 +1,40 @@
 module Ingenico::Connect::SDK
   module Webhooks
 
+    # @attr [String] api_version
+    # @attr [String] id
+    # @attr [String] created
+    # @attr [String] merchant_id
+    # @attr [String] type
+    # @attr [Ingenico::Connect::SDK::Domain::Payment::PaymentResponse] payment
+    # @attr [Ingenico::Connect::SDK::Domain::Payout::PayoutResponse] refund
+    # @attr [Ingenico::Connect::SDK::Domain::Refund::RefundResponse] payout
+    # @attr [Ingenico::Connect::SDK::Domain::Token::TokenResponse] token
     class WebhooksEvent < Ingenico::Connect::SDK::DataObject
 
-      # String
       attr_accessor :api_version
-
-      # String
       attr_accessor :id
-
-      # String
       attr_accessor :created
-
-      # String
       attr_accessor :merchant_id
-
-      # String
       attr_accessor :type
 
-      # {Ingenico::Connect::SDK::Domain::Payment::PaymentResponse}
       attr_accessor :payment
-
-      # {Ingenico::Connect::SDK::Domain::Payout::PayoutResponse}
       attr_accessor :refund
-
-      # {Ingenico::Connect::SDK::Domain::Refund::RefundResponse}
       attr_accessor :payout
-
-      # {Ingenico::Connect::SDK::Domain::Token::TokenResponse}
       attr_accessor :token
 
+      # @return [Hash]
       def to_h
         hash = super
-        add_to_hash(hash, 'apiVersion', @api_version)
-        add_to_hash(hash, 'id', @id)
-        add_to_hash(hash, 'created', @created)
-        add_to_hash(hash, 'merchantId', @merchant_id)
-        add_to_hash(hash, 'type', @type)
-        add_to_hash(hash, 'payment', @payment)
-        add_to_hash(hash, 'refund', @refund)
-        add_to_hash(hash, 'payout', @payout)
-        add_to_hash(hash, 'token', @token)
+        hash['apiVersion'] = @api_version unless @api_version.nil?
+        hash['id'] = @id unless @id.nil?
+        hash['created'] = @created unless @created.nil?
+        hash['merchantId'] = @merchant_id unless @merchant_id.nil?
+        hash['type'] = @type unless @type.nil?
+        hash['payment'] = @payment.to_h unless @payment.nil?
+        hash['refund'] = @refund.to_h unless @refund.nil?
+        hash['payout'] = @payout.to_h unless @payout.nil?
+        hash['token'] = @token.to_h unless @token.nil?
         hash
       end
 

data/lib/ingenico/connect/sdk/webhooks/webhooks_helper.rb

@@ -13,10 +13,10 @@ module Ingenico::Connect::SDK
         @secret_key_store = secret_key_store
       end
 
-      # Unmarshals the given body, while also validating it using the given
-      # request headers.
-      # body:: body of the request, a String
-      # request_headers:: headers of the request, as an Array of {Ingenico::Connect::SDK::RequestHeader}
+      # Unmarshals the given body, while also validating it using the given request headers.
+      #
+      # @param body            [String] body of the request
+      # @param request_headers [Array<Ingenico::Connect::SDK::RequestHeader>] headers of the request
       def unmarshal(body, request_headers)
         validate(body, request_headers)
         event = @marshaller.unmarshal(body, WebhooksEvent)
@@ -26,8 +26,8 @@ module Ingenico::Connect::SDK
 
       # Validates incoming request using request headers
       #
-      # body:: body of the request, a String
-      # request_headers:: headers of the request which is an Array of {Ingenico::Connect::SDK::RequestHeader}
+      # @param body            [String] body of the request
+      # @param request_headers [Array<Ingenico::Connect::SDK::RequestHeader>] headers of the request
       def validate(body, request_headers)
         validate_body(body, request_headers)
       end
@@ -42,8 +42,8 @@ module Ingenico::Connect::SDK
 
       # Validates the body using given request headers
       #
-      # body:: a String converted from byte array
-      # request_headers:: headers of the request, as an Array of SDK::RequestHeader
+      # @param body            [String] body of the request
+      # @param request_headers [Array<Ingenico::Connect::SDK::RequestHeader>] headers of the request
       def validate_body(body, request_headers)
         signature = get_header_value(request_headers, HEADER_SIGNATURE)
         key_id = get_header_value(request_headers, HEADER_KEY_ID)
@@ -59,8 +59,9 @@ module Ingenico::Connect::SDK
       end
 
       # Checks two signatures
-      # signature:: a String
-      # expected_signature:: a String
+      #
+      # @param signature          [String]
+      # @param expected_signature [String]
       def equal_signatures?(signature, expected_signature)
         # NOTE: copy the signatures to avoid runtime tampering via references
         signature = signature.dup.freeze

data/spec/integration/multipart_form_data_spec.rb

@@ -0,0 +1,214 @@
+require 'json'
+require 'spec_helper'
+require 'integration_setup'
+require 'webmock/rspec'
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/data_object'
+require 'ingenico/connect/sdk/multipart_form_data_object'
+require 'ingenico/connect/sdk/multipart_form_data_request'
+require 'ingenico/connect/sdk/uploadable_file'
+
+describe 'multipart/form-data support' do
+  before(:context) { WebMock.allow_net_connect! }
+  after(:context) { WebMock.disable_net_connect! }
+
+  it 'Can send a Multipart Form Data Object POST upload with a response' do
+    configuration = Integration.init_communicator_configuration
+    configuration.api_endpoint = 'http://httpbin.org'
+
+    multipart = Ingenico::Connect::SDK::MultipartFormDataObject.new
+    multipart.add_file 'file', Ingenico::Connect::SDK::UploadableFile.new(
+      'file.txt', 'file-content', 'text/plain'
+    )
+
+    multipart.add_value 'value', 'Hello World'
+
+    communicator = Ingenico::Connect::SDK::Factory.create_communicator_from_configuration configuration
+
+    response = communicator.post('/post', nil, nil, multipart,
+                                 HttpBinResponse, nil)
+
+    expect(response.form['value']).to eq 'Hello World'
+    expect(response.files['file']).to eq 'file-content'
+  end
+
+  it 'Can send a Multipart Form Data Request POST upload with a response' do
+    configuration = Integration.init_communicator_configuration
+    configuration.api_endpoint = 'http://httpbin.org'
+
+    multipart = Ingenico::Connect::SDK::MultipartFormDataObject.new
+    multipart.add_file 'file', Ingenico::Connect::SDK::UploadableFile.new(
+      'file.txt', 'file-content', 'text-plain'
+    )
+
+    multipart.add_value 'value', 'Hello World'
+
+    communicator = Ingenico::Connect::SDK::Factory.create_communicator_from_configuration configuration
+
+    response = communicator.post '/post', nil, nil,
+                                 MultipartFormDataObjectWrapper.new(multipart), HttpBinResponse, nil
+
+    expect(response.form['value']).to eq 'Hello World'
+    expect(response.files['file']).to eq 'file-content'
+  end
+
+  it 'Can send a Multipart Form Data Object POST upload with a binary response' do
+    configuration = Integration.init_communicator_configuration
+    configuration.api_endpoint = 'http://httpbin.org'
+
+    multipart = Ingenico::Connect::SDK::MultipartFormDataObject.new
+    multipart.add_file 'file', Ingenico::Connect::SDK::UploadableFile.new(
+      'file.txt', 'file-content', 'text/plain'
+    )
+    multipart.add_value 'value', 'Hello World'
+
+    communicator = Ingenico::Connect::SDK::Factory.create_communicator_from_configuration configuration
+
+    data = ''
+    communicator.post_with_binary_response '/post', nil, nil,
+                                           multipart, nil do |_, c|
+      data = c.read.force_encoding('UTF-8')
+    end
+    response = JSON.parse data
+
+    expect(response['form']['value']).to eq 'Hello World'
+    expect(response['files']['file']).to eq 'file-content'
+  end
+
+  it 'Can send a Multipart Form Data Request POST upload with a binary response' do
+    configuration = Integration.init_communicator_configuration
+    configuration.api_endpoint = 'http://httpbin.org'
+
+    multipart = Ingenico::Connect::SDK::MultipartFormDataObject.new
+    multipart.add_file 'file', Ingenico::Connect::SDK::UploadableFile.new(
+      'file.txt', 'file-content', 'text/plain'
+    )
+    multipart.add_value 'value', 'Hello World'
+
+    communicator = Ingenico::Connect::SDK::Factory.create_communicator_from_configuration configuration
+
+    data = ''
+    communicator.post_with_binary_response '/post', nil, nil,
+                                           MultipartFormDataObjectWrapper.new(multipart), nil do |_, c|
+      data = c.read.force_encoding('UTF-8')
+    end
+    response = JSON.parse data
+
+    expect(response['form']['value']).to eq 'Hello World'
+    expect(response['files']['file']).to eq 'file-content'
+  end
+
+  it 'Can send a Multipart Form Data Object PUT upload with a response' do
+    configuration = Integration.init_communicator_configuration
+    configuration.api_endpoint = 'http://httpbin.org'
+
+    multipart = Ingenico::Connect::SDK::MultipartFormDataObject.new
+    multipart.add_file 'file', Ingenico::Connect::SDK::UploadableFile.new(
+      'file.txt', 'file-content', 'text/plain'
+    )
+
+    multipart.add_value 'value', 'Hello World'
+
+    communicator = Ingenico::Connect::SDK::Factory.create_communicator_from_configuration configuration
+
+    response = communicator.put('/put', nil, nil, multipart,
+                                HttpBinResponse, nil)
+
+    expect(response.form['value']).to eq 'Hello World'
+    expect(response.files['file']).to eq 'file-content'
+  end
+
+  it 'Can send a Multipart Form Data Request PUT upload with a response' do
+    configuration = Integration.init_communicator_configuration
+    configuration.api_endpoint = 'http://httpbin.org'
+
+    multipart = Ingenico::Connect::SDK::MultipartFormDataObject.new
+    multipart.add_file 'file', Ingenico::Connect::SDK::UploadableFile.new(
+      'file.txt', 'file-content', 'text-plain'
+    )
+
+    multipart.add_value 'value', 'Hello World'
+
+    communicator = Ingenico::Connect::SDK::Factory.create_communicator_from_configuration configuration
+
+    response = communicator.put '/put', nil, nil,
+                                MultipartFormDataObjectWrapper.new(multipart), HttpBinResponse, nil
+
+    expect(response.form['value']).to eq 'Hello World'
+    expect(response.files['file']).to eq 'file-content'
+  end
+
+  it 'Can send a Multipart Form Data Object PUT upload with a binary response' do
+    configuration = Integration.init_communicator_configuration
+    configuration.api_endpoint = 'http://httpbin.org'
+
+    multipart = Ingenico::Connect::SDK::MultipartFormDataObject.new
+    multipart.add_file 'file', Ingenico::Connect::SDK::UploadableFile.new(
+      'file.txt', 'file-content', 'text/plain'
+    )
+    multipart.add_value 'value', 'Hello World'
+
+    communicator = Ingenico::Connect::SDK::Factory.create_communicator_from_configuration configuration
+
+    data = ''
+    communicator.put_with_binary_response '/put', nil, nil,
+                                          multipart, nil do |_, c|
+      data = c.read.force_encoding('UTF-8')
+    end
+    response = JSON.parse data
+
+    expect(response['form']['value']).to eq 'Hello World'
+    expect(response['files']['file']).to eq 'file-content'
+  end
+
+  it 'Can send a Multipart Form Data Request PUT upload with a binary response' do
+    configuration = Integration.init_communicator_configuration
+    configuration.api_endpoint = 'http://httpbin.org'
+
+    multipart = Ingenico::Connect::SDK::MultipartFormDataObject.new
+    multipart.add_file 'file', Ingenico::Connect::SDK::UploadableFile.new(
+      'file.txt', 'file-content', 'text/plain'
+    )
+    multipart.add_value 'value', 'Hello World'
+
+    communicator = Ingenico::Connect::SDK::Factory.create_communicator_from_configuration configuration
+
+    data = ''
+    communicator.put_with_binary_response '/put', nil, nil,
+                                                     MultipartFormDataObjectWrapper.new(multipart), nil do |_, c|
+      data = c.read.force_encoding('UTF-8')
+    end
+    response = JSON.parse data
+
+    expect(response['form']['value']).to eq 'Hello World'
+    expect(response['files']['file']).to eq 'file-content'
+  end
+end
+
+class HttpBinResponse < Ingenico::Connect::SDK::DataObject
+  @form = nil
+  @files = nil
+
+  attr_reader :form
+  attr_reader :files
+
+  def from_hash(hash)
+    super
+    @form = hash['form'] if hash.key? 'form'
+    @files = hash['files'] if hash.key? 'files'
+  end
+end
+
+class MultipartFormDataObjectWrapper < Ingenico::Connect::SDK::MultipartFormDataRequest
+  @multipart = nil
+
+  attr_reader :multipart
+
+  def initialize(multipart)
+    @multipart = multipart
+  end
+
+  def to_multipart_form_data_object
+    @multipart
+  end
+end

data/spec/lib/defaultimpl/default_connection_idempotence_spec.rb

@@ -67,8 +67,8 @@ describe 'DefaultConnectionIdempotence' do
 
     expect{response = CLIENT.merchant('20000').payments.create(request, call_context)}.
         to raise_error(Ingenico::Connect::SDK::DeclinedPaymentException){ |err|
-      expect(err.status_code).to be(402)
-      expect(err.response_body).to be(response_body)
+      expect(err.status_code).to eq(402)
+      expect(err.response_body).to eq(response_body)
       expect(call_context.idempotence_key).to eq(idempotence_key)
       expect(call_context.idempotence_request_timestamp).to be_nil
     }
@@ -89,8 +89,8 @@ describe 'DefaultConnectionIdempotence' do
 
     expect{response = CLIENT.merchant('20000').payments.create(request, call_context)}.
         to raise_error(Ingenico::Connect::SDK::DeclinedPaymentException){ |err|
-      expect(err.status_code).to be(402)
-      expect(err.response_body).to be(response_body)
+      expect(err.status_code).to eq(402)
+      expect(err.response_body).to eq(response_body)
       expect(call_context.idempotence_key).to eq(idempotence_key)
       expect(call_context.idempotence_request_timestamp.to_s).to eq(idempotence_timestamp.to_s)
     }
@@ -111,8 +111,8 @@ describe 'DefaultConnectionIdempotence' do
 
     expect{response = CLIENT.merchant('20000').payments.create(request, call_context)}.
         to raise_error(Ingenico::Connect::SDK::IdempotenceException){ |err|
-      expect(err.status_code).to be(409)
-      expect(err.response_body).to be(response_body)
+      expect(err.status_code).to eq(409)
+      expect(err.response_body).to eq(response_body)
       expect(call_context.idempotence_key).to eq(idempotence_key)
       expect(call_context.idempotence_request_timestamp.to_s).to eq(idempotence_timestamp.to_s)
     }
@@ -130,7 +130,7 @@ def create_payment_request
   order = Payments::Order.new
   order.customer = customer
   card = Definitions::Card.new
-  card.ccv = '123'
+  card.cvv = '123'
   card.card_number = '4567350000427977'
   card.expiry_date = '1220'
   card_payment_method_specific_input = Payments::CardPaymentMethodSpecificInput.new

data/spec/lib/defaultimpl/default_connection_logger_spec.rb

@@ -406,8 +406,6 @@ describe 'DefaultConnectionLogging' do
 
   # tests a read timeout
   it 'logs timeouts' do
-    response_body = IO.read(resource_prefix + 'notFound.html')
-
     stub_request(:get, 'https://api-sandbox.globalcollect.com/v1/1234/services/testconnection')
         .to_raise(HTTPClient::ReceiveTimeoutError)
 
@@ -464,8 +462,6 @@ describe 'DefaultConnectionLogging' do
   end
 
   it 'can log errors individually' do
-    response_body = IO.read(resource_prefix + 'notFound.html')
-
     stub_request(:get, 'https://api-sandbox.globalcollect.com/v1/1234/services/testconnection')
         .to_return{ |request| CLIENT.enable_logging(logger)
     raise HTTPClient::ReceiveTimeoutError.new}

data/spec/lib/defaultimpl/default_connection_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'uri'
+require 'stringio'
 require 'sinatra'
 
 DefaultConnection ||= Ingenico::Connect::SDK::DefaultImpl::DefaultConnection
@@ -99,9 +100,18 @@ describe DefaultConnection do
   context 'sending and receiving' do
 
     class DummyResponse
-      def status
+      def pop
+        self
+      end
+
+      def status_code
         200
       end
+
+      def content
+        StringIO.new(body || '')
+      end
+
       attr_accessor :headers, :body, :content_type, :uri
     end
 
@@ -110,21 +120,29 @@ describe DefaultConnection do
         # mock the HTTPClient obj inside DefaultConnection
         # for each type of requests so no real requests will be made
         client = connection.instance_variable_get(:@http_client)
-          allow(client).to receive(:get) do |uri, hash|
+        allow(client).to receive(:get_async) do |uri, hash|
+          dummy_response = DummyResponse.new
+          dummy_response.headers = hash[:header]
+          dummy_response.uri = uri
+          dummy_response
+        end
+
+        allow(client).to receive(:delete_async) do |uri, hash|
           dummy_response = DummyResponse.new
           dummy_response.headers = hash[:header]
           dummy_response.uri = uri
           dummy_response
         end
 
-        allow(client).to receive(:delete) do |uri, hash|
+        allow(client).to receive(:post_async) do |uri, hash|
           dummy_response = DummyResponse.new
           dummy_response.headers = hash[:header]
           dummy_response.uri = uri
+          dummy_response.body = hash[:body]
           dummy_response
         end
 
-        allow(client).to receive(:post) do |uri, hash|
+        allow(client).to receive(:put_async) do |uri, hash|
           dummy_response = DummyResponse.new
           dummy_response.headers = hash[:header]
           dummy_response.uri = uri
@@ -132,7 +150,7 @@ describe DefaultConnection do
           dummy_response
         end
 
-        allow(client).to receive(:put) do |uri, hash|
+        allow(client).to receive(:request_async) do |_method, uri, hash|
           dummy_response = DummyResponse.new
           dummy_response.headers = hash[:header]
           dummy_response.uri = uri
@@ -141,7 +159,7 @@ describe DefaultConnection do
         end
       end
 
-      let(:headers) { { 'header1' => 'dummy', 'header2' => 'yammy' } }
+      let(:headers) { { 'Content-Type' => 'application/json', 'header1' => 'dummy', 'header2' => 'yammy' } }
       let(:sdk_headers) { headers.map {|k, v| Ingenico::Connect::SDK::ResponseHeader.new(k, v) } }
       let(:uri) { URI('http://foobar.com/v1/1234/services/convert/amount?source=EUR&amount=1000&target=USD') }
 
@@ -154,28 +172,34 @@ describe DefaultConnection do
       end
 
       it 'sends the correct get request' do
-        res = connection.get(uri, sdk_headers)
-        expect(sdk_headers_to_s(res.headers)).to eq(sdk_headers_to_s(sdk_headers))
+        response_headers = nil
+        connection.get(uri, sdk_headers) { |s, h, c| response_headers = h }
+        expect(sdk_headers_to_s(response_headers)).to eq(sdk_headers_to_s(sdk_headers))
       end
 
       it 'sends the correct delete request' do
-        res = connection.delete(uri, sdk_headers)
-        expect(sdk_headers_to_s(res.headers)).to eq(sdk_headers_to_s(sdk_headers))
+        response_headers = nil
+        connection.delete(uri, sdk_headers) { |s, h, c| response_headers = h }
+        expect(sdk_headers_to_s(response_headers)).to eq(sdk_headers_to_s(sdk_headers))
       end
 
       context 'with body' do
         let(:body) { 'dummy body' }
 
         it 'sends the correct post request' do
-          res = connection.post(uri, sdk_headers, body)
-          expect(res.get_header_value('Content-Type')).to eq('application/json')
-          expect(res.body).to eq(body)
+          response_headers = nil
+          response_body = ''
+          connection.post(uri, sdk_headers, body) { |s, h, c| response_headers, response_body = h, c.read.force_encoding('UTF-8') }
+          expect(ResponseHeader.get_header_value(response_headers, 'Content-Type')).to eq('application/json')
+          expect(response_body).to eq(body)
         end
 
         it 'sends the correct put request' do
-          res = connection.put(uri, sdk_headers, body)
-          expect(res.get_header_value('Content-Type')).to eq('application/json')
-          expect(res.body).to eq(body)
+          response_headers = nil
+          response_body = ''
+          connection.put(uri, sdk_headers, body) { |s, h, c| response_headers, response_body = h, c.read.force_encoding('UTF-8') }
+          expect(ResponseHeader.get_header_value(response_headers, 'Content-Type')).to eq('application/json')
+          expect(response_body).to eq(body)
         end
       end
 
@@ -241,7 +265,7 @@ describe DefaultConnection do
 
         # TODO: DELETE is basically the same, do we need to test it?
         it 'logs the correct get request' do
-          connection.get(uri, sdk_headers)
+          connection.get(uri, sdk_headers) { |s, h, c| }
           expect($stdout.string).to match(regex)
           match_info = $stdout.string.match(regex)
           expect(match_info[2]).to eq('GET')
@@ -253,7 +277,7 @@ describe DefaultConnection do
         context 'with body' do
           let(:body) { 'dummy body' }
           it 'logs the correct post request' do
-            connection.post(uri, sdk_headers, body)
+            connection.post(uri, sdk_headers, body) { |s, h, c| }
             expect($stdout.string).to match(with_body_regex)
             match_info = $stdout.string.match(with_body_regex)
             expect(match_info[2]).to eq('POST')
@@ -304,25 +328,24 @@ describe DefaultConnection do
     let(:sdk_headers) { [] }
 
     it 'uses persistent connection if HTTP 1.1 is supported' do
-      100.times { connection.get(uri, sdk_headers) }
+      100.times { connection.get(uri, sdk_headers) { |x, y| } }
       expect(connection.session_count).to eq(1)
     end
 
     it 'retrieves the correct json file' do
-      res = connection.get(uri, sdk_headers)
+      response_body = ''
+      connection.get(uri, sdk_headers) { |status, headers, body| response_body = body.read.force_encoding('UTF-8') }
       prefix = 'spec/fixtures/resources/defaultimpl/'
-      expect(res.body).to eq(IO.read(prefix + 'convertAmount.json'))
+      expect(response_body).to eq(IO.read(prefix + 'convertAmount.json'))
     end
 
     it 'can explicitly close connections' do
-      connection.get(uri, sdk_headers)
-      expect(connection.session_count).to eq(1)
+      connection.get(uri, sdk_headers) { |x, y| }
 
       connection.close
       expect(connection.session_count).to eq(0)
 
-      connection.get(uri, sdk_headers)
-      expect(connection.session_count).to eq(1)
+      connection.get(uri, sdk_headers) { |x, y| }
     end
   end
 end