connect-sdk-ruby 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85c0d7f702a3ef4aa7a1bf4e2c83ebc9c2199aaa
-  data.tar.gz: 88edb5adb9229f3036aa266fdd9f7fa66269d0f7
+  metadata.gz: 980877434fcc0d67e0a3b79881d54a496584dff0
+  data.tar.gz: 84819aa760a8d93e692c0b2cbce97fa7a20a2f7c
 SHA512:
-  metadata.gz: 09402138eb1e17e54f88208f7d5ea73defd4ec165fa56708e198b786d25b3007ca1f70dde785fe6358c7821455aba3a0419ec9c944d9faadf2abe72270e55cac
-  data.tar.gz: 8de8c3c286df14bc037b046abe1158eb634ac31583dad110360d958269143106b0befadaae812baeac504c00130445a6d9ec9b264d44a764c715358e3173f9e0
+  metadata.gz: 7299829037d437656d41cee2a9331a67f35cc736d0ab7bfc7a368e771243f6ce62ebd6ba5f32b6080f40ce53f0c0a28fc976dcedf0f2013f897c17a1688f011f
+  data.tar.gz: 015e6059dc121b9dc0c34085147c173aa854802eaeef3e47a38e8d6cad9917964cebe3cd19774ef8e3973f554b86940c1040252770bf4794de63e75b4b7a7385

data/README.md

@@ -12,7 +12,7 @@ The Ruby SDK helps you to communicate with the [Ingenico Connect](http://www.ing
 
 Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys. 
 
-See the [Ingenico Connect Developer Hub](https://developer.globalcollect.com/documentation/sdk/server/ruby/) for more information on how to use the SDK.
+See the [Ingenico Connect Developer Hub](https://epayments.developer-ingenico.com/documentation/sdk/server/ruby/) for more information on how to use the SDK.
 
 ## Structure of this repository
 

data/connect-sdk-ruby.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |spec|
   spec.name           = 'connect-sdk-ruby'
-  spec.version        = '1.7.0'
+  spec.version        = '1.8.0'
   spec.authors        = ['Ingenico ePayments']
   spec.email          = ['github@epay.ingenico.com']
-  spec.summary        = %q{SDK to communicate with the GlobalCollect platform using the Ingenico Connect Server API}
-  spec.description    = %q{SDK to communicate with the GlobalCollect platform using the Ingenico Connect Server API}
+  spec.summary        = %q{SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API}
+  spec.description    = %q{SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API}
   spec.homepage       = %q{https://github.com/Ingenico-ePayments/connect-sdk-ruby}
   spec.license        = 'MIT'
 

data/examples/merchant/payments/create_payment_example.rb

@@ -21,6 +21,7 @@ require 'ingenico/connect/sdk/domain/payment/order_invoice_data'
 require 'ingenico/connect/sdk/domain/payment/order_references'
 require 'ingenico/connect/sdk/domain/payment/personal_information'
 require 'ingenico/connect/sdk/domain/payment/personal_name'
+require 'ingenico/connect/sdk/domain/payment/shopping_cart'
 
 Definitions = Ingenico::Connect::SDK::Domain::Definitions
 Payment = Ingenico::Connect::SDK::Domain::Payment
@@ -96,6 +97,16 @@ def example
     customer.shipping_address = shipping_address
     customer.vat_number = '1234AB5678CD'
 
+    invoice_data = Payment::OrderInvoiceData.new
+    invoice_data.invoice_date = '20140306191500'
+    invoice_data.invoice_number = '000000123'
+
+    references = Payment::OrderReferences.new
+    references.descriptor = 'Fast and Furry-ous'
+    references.invoice_data = invoice_data
+    references.merchant_order_id = 123456
+    references.merchant_reference = 'AcmeOrder0001'
+
     items = []
 
     item1_amount_of_money = Definitions::AmountOfMoney.new
@@ -128,21 +139,14 @@ def example
 
     items << item2
 
-    invoice_data = Payment::OrderInvoiceData.new
-    invoice_data.invoice_date = '20140306191500'
-    invoice_data.invoice_number = '000000123'
-
-    references = Payment::OrderReferences.new
-    references.descriptor = 'Fast and Furry-ous'
-    references.invoice_data = invoice_data
-    references.merchant_order_id = 123456
-    references.merchant_reference = 'AcmeOrder0001'
+    shopping_cart = Payment::ShoppingCart.new
+    shopping_cart.items = items
 
     order = Payment::Order.new
     order.amount_of_money = amount_of_money
     order.customer = customer
-    order.items = items
     order.references = references
+    order.shopping_cart = shopping_cart
 
     body = Payment::CreatePaymentRequest.new
     body.card_payment_method_specific_input = card_payment_method_specific_input

data/examples/merchant/payouts/create_payout_example.rb

@@ -11,6 +11,7 @@ require 'ingenico/connect/sdk/domain/definitions/bank_account_iban'
 require 'ingenico/connect/sdk/domain/definitions/company_information'
 require 'ingenico/connect/sdk/domain/definitions/contact_details_base'
 require 'ingenico/connect/sdk/domain/payment/personal_name'
+require 'ingenico/connect/sdk/domain/payout/bank_transfer_payout_method_specific_input'
 require 'ingenico/connect/sdk/domain/payout/create_payout_request'
 require 'ingenico/connect/sdk/domain/payout/payout_customer'
 require 'ingenico/connect/sdk/domain/payout/payout_references'
@@ -55,17 +56,20 @@ def example
     customer.contact_details = contact_details
     customer.name = name
 
+    bank_transfer_payout_method_specific_input = Payout::BankTransferPayoutMethodSpecificInput.new
+    bank_transfer_payout_method_specific_input.bank_account_iban = bank_account_iban
+    bank_transfer_payout_method_specific_input.customer = customer
+    bank_transfer_payout_method_specific_input.payout_date = '20150102'
+    bank_transfer_payout_method_specific_input.payout_text = 'Payout Acme'
+    bank_transfer_payout_method_specific_input.swift_code = 'swift'
+
     references = Payout::PayoutReferences.new
     references.merchant_reference = 'AcmeOrder001'
 
     body = Payout::CreatePayoutRequest.new
     body.amount_of_money = amount_of_money
-    body.bank_account_iban = bank_account_iban
-    body.customer = customer
-    body.payout_date = '20150102'
-    body.payout_text = 'Payout Acme'
+    body.bank_transfer_payout_method_specific_input = bank_transfer_payout_method_specific_input
     body.references = references
-    body.swift_code = 'swift'
 
     begin
       response = client.merchant('merchantId').payouts().create(body)

data/lib/ingenico/connect/sdk/api_exception.rb

@@ -1,11 +1,11 @@
 module Ingenico::Connect::SDK
 
   # Base class for many exceptions raised by the SDK.
-  # It is raised when an error response is received from the GlobalCollect platform.
+  # It is raised when an error response is received from the Ingenico ePayments platform.
   # It contains data about the returned response.
   class ApiException < RuntimeError
 
-    # Creates a new ApiException that reports an error response from the GlobalCollect platform.
+    # Creates a new ApiException that reports an error response from the Ingenico ePayments platform.
     # It reports the following:
     # status_code::   HTTP status code the response
     # response_body:: HTTP response body
@@ -13,7 +13,7 @@ module Ingenico::Connect::SDK
     # errors::        A list of errors that occurred, may be empty
     # message::       Error message to include
     def initialize(status_code, response_body, error_id, errors,
-                   message='the GlobalCollect platform returned an error response')
+                   message='the Ingenico ePayments platform returned an error response')
       super(message)
       @status_code = status_code
       @response_body = response_body
@@ -34,7 +34,7 @@ module Ingenico::Connect::SDK
     # An error id corresponding to the error that occurred, if available.
     attr_reader :error_id
 
-    # A list of errors received from the GlobalCollect platform;
+    # A list of errors received from the Ingenico ePayments platform;
     # may be empty but never _nil_
     attr_reader :errors
 

data/lib/ingenico/connect/sdk/api_resource.rb

@@ -2,8 +2,8 @@ require 'ingenico/connect/sdk/domain/errors/error_response'
 
 module Ingenico::Connect::SDK
 
-  # Base class of all GlobalCollect platform API resources.
-  # Provides shared functionality to facilitate communication with the GlobalCollect platform.
+  # Base class of all Ingenico ePayments platform API resources.
+  # Provides shared functionality to facilitate communication with the Ingenico ePayments platform.
   class ApiResource
 
     # Creates a new ApiResource.
@@ -36,7 +36,7 @@ module Ingenico::Connect::SDK
       end
     end
 
-    # {Ingenico::Connect::SDK::Communicator} instance that provides communication with the GlobalCollect platform.
+    # {Ingenico::Connect::SDK::Communicator} instance that provides communication with the Ingenico ePayments platform.
     attr_reader :communicator
 
     # JSON string containing client info specific to the current client.

data/lib/ingenico/connect/sdk/authenticator.rb

@@ -1,6 +1,6 @@
 module Ingenico::Connect::SDK
 
-  # Abstract class that is responsible for authenticating requests sent to the GlobalCollect platform.
+  # Abstract class that is responsible for authenticating requests sent to the Ingenico ePayments platform.
   class Authenticator
 
     # Creates a signature to authenticate a request.

data/lib/ingenico/connect/sdk/authorization_exception.rb

@@ -1,12 +1,12 @@
 module Ingenico::Connect::SDK
 
-  # This exception is thrown when a request sent to the GlobalCollect platform is not correctly authenticated.
+  # This exception is thrown when a request sent to the Ingenico ePayments platform is not correctly authenticated.
   # Corresponds to a HTTP status code of 403.
   # @see ApiException#initialize
   class AuthorizationException < ApiException
 
     def initialize(status_code, response_body, error_id, errors,
-                   message='the GlobalCollect platform returned an authorization error response')
+                   message='the Ingenico ePayments platform returned an authorization error response')
       super(status_code, response_body, error_id, errors, message)
     end
   end

data/lib/ingenico/connect/sdk/call_context.rb

@@ -19,7 +19,7 @@ module Ingenico::Connect::SDK
     # and only the first request will be processed.
     attr_reader :idempotence_key
 
-    # If two or more requests arrive at the GlobalCollect platform with the same _idempotence_key_,
+    # If two or more requests arrive at the Ingenico ePayments platform with the same _idempotence_key_,
     # the _idempotence_request_timestamp_ will be set to the arrival time of the first of these requests.
     attr_accessor :idempotence_request_timestamp
   end

data/lib/ingenico/connect/sdk/client.rb

@@ -12,7 +12,7 @@ module Ingenico
   module Connect
     module SDK
 
-      # GlobalCollect platform client.
+      # Ingenico ePayments platform client.
       #
       # This client and all its child clients are bound to one specific value for the X-GCS-ClientMetaInfo header.
       #

data/lib/ingenico/connect/sdk/communication_exception.rb

@@ -1,6 +1,6 @@
 module Ingenico::Connect::SDK
 
-  # This exception is used when an error occurs during network communication with the GlobalCollect platform.
+  # This exception is used when an error occurs during network communication with the Ingenico ePayments platform.
   # A common cause is a timeout while connecting or when receiving or sending data.
   class CommunicationException < RuntimeError
 

data/lib/ingenico/connect/sdk/communicator.rb

@@ -2,7 +2,7 @@ require 'uri'
 
 module Ingenico::Connect::SDK
 
-  # Class responsible for facilitating communication with the GlobalCollect platform.
+  # Class responsible for facilitating communication with the Ingenico ePayments platform.
   # It combines the following classes to provide communication functionality:
   #
   # session::     {Ingenico::Connect::SDK::Session} that stores data for network communication and facilitates network communication
@@ -27,13 +27,13 @@ module Ingenico::Connect::SDK
       @marshaller = marshaller
     end
 
-    # Performs a GET request to the GlobalCollect platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
+    # Performs a GET request to the Ingenico ePayments platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
     #
     # Throws:
     # ResponseException::       Thrown if the request could not be fulfilled successfully.
     #                           This occurs for example if the request is not authenticated correctly
     # NotFoundException::       Thrown if the requested resource is not found
-    # CommunicationException::  Thrown if there is an error in communicating with the GlobalCollect platform.
+    # CommunicationException::  Thrown if there is an error in communicating with the Ingenico ePayments platform.
     #                           This occurs for example if a timeout occurs.
     def get(relative_path, request_headers, request_parameters, response_type, context)
       connection = @session.connection
@@ -51,13 +51,13 @@ module Ingenico::Connect::SDK
       process_response(response, response_type, relative_path, context)
     end
 
-    # Performs a DELETE request to the GlobalCollect platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
+    # Performs a DELETE request to the Ingenico ePayments platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
     #
     # Throws:
     # ResponseException::       Thrown if the request could not be fulfilled successfully.
     #                           This occurs for example if the request is not authenticated correctly.
     # NotFoundException::       Thrown if the referred resource is not found.
-    # CommunicationException::  Thrown if there is an error in communicating with the GlobalCollect platform.
+    # CommunicationException::  Thrown if there is an error in communicating with the Ingenico ePayments platform.
     #                           This occurs for example if a timeout occurs.
     def delete(relative_path, request_headers, request_parameters, response_type, context)
       connection = @session.connection
@@ -75,13 +75,13 @@ module Ingenico::Connect::SDK
       process_response(response, response_type, relative_path, context)
     end
 
-    # Performs a POST request to the GlobalCollect platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
+    # Performs a POST request to the Ingenico ePayments platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
     #
     # Throws:
     # ResponseException::       Thrown if the request could not be fulfilled successfully.
     #                           This occurs for example if the request is not authenticated correctly.
     # NotFoundException::       Thrown if the referred resource is not found.
-    # CommunicationException::  Thrown if there is an error in communicating with the GlobalCollect platform.
+    # CommunicationException::  Thrown if there is an error in communicating with the Ingenico ePayments platform.
     #                           This occurs for example if a timeout occurs.
     def post(relative_path, request_headers, request_parameters, request_body,
              response_type, context)
@@ -105,13 +105,13 @@ module Ingenico::Connect::SDK
       process_response(response, response_type, relative_path, context)
     end
 
-    # Performs a PUT request to the GlobalCollect platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
+    # Performs a PUT request to the Ingenico ePayments platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
     #
     # Throws:
     # ResponseException::       Thrown if the request could not be fulfilled successfully.
     #                           This occurs for example if the request is not authenticated correctly.
     # NotFoundException::       Thrown if the referred resource is not found.
-    # CommunicationException::  Thrown if there is an error in communicating with the GlobalCollect platform.
+    # CommunicationException::  Thrown if there is an error in communicating with the Ingenico ePayments platform.
     #                           This occurs for example if a timeout occurs.
     def put(relative_path, request_headers, request_parameters, request_body,
             response_type, context)
@@ -209,7 +209,7 @@ module Ingenico::Connect::SDK
     # Adds several standard headers to the http headers.
     #
     # http_method::     'GET', 'DELETE', 'POST' or 'PUT' depending on the HTTP method being used
-    # uri::             The full URI as a URI object to the GlobalCollect platform,
+    # uri::             The full URI as a URI object to the Ingenico ePayments platform,
     #                   including the relative path and request parameters.
     # request_headers:: List of {Ingenico::Connect::SDK::RequestHeader} in which which new headers will be added
     # context::         {Ingenico::Connect::SDK::CallContext} object that will be used to produce

data/lib/ingenico/connect/sdk/communicator_configuration.rb

@@ -2,14 +2,14 @@ module Ingenico::Connect::SDK
 
   # A CommunicatorConfiguration stores all data used to initialize an {Ingenico::Connect::SDK::Communicator}. It stores the following:
   #
-  # api_endpoint::            The base url to the GlobalCollect platform.
+  # api_endpoint::            The base url to the Ingenico ePayments platform.
   # api_key_id::              The identifier of the _secret_api_key_ used to authenticate requests.
-  # secret_api_key::          The key used to authenticate requests sent to the GlobalCollect platform.
+  # secret_api_key::          The key used to authenticate requests sent to the Ingenico ePayments platform.
   # authorization_type::      String describing the authorization protocol to follow.
-  # connect_timeout::         The number of seconds before a connection attempt with the GlobalCollect platform times out.
+  # connect_timeout::         The number of seconds before a connection attempt with the Ingenico ePayments platform times out.
   # socket_timeout::          The number of seconds before a timeout occurs
-  #                           when transmitting data to or from the GlobalCollect platform.
-  # max_connections::         The number of connections with the GlobalCollect platform
+  #                           when transmitting data to or from the Ingenico ePayments platform.
+  # max_connections::         The number of connections with the Ingenico ePayments platform
   #                           that are kept alive in the connection pool. These connections will be reused when possible.
   # proxy_configuration::     {Ingenico::Connect::SDK::ProxyConfiguration} instance that stores the url to a proxy to be used in all communication,
   #                           or nil if no proxy should be used.
@@ -22,14 +22,14 @@ module Ingenico::Connect::SDK
     # properties::              A hash that may contain any of the other parameters.
     #                           If a parameter is given in both the _properties_ and separately,
     #                           the separate value takes precedence.
-    # api_endpoint::            The base url to the GlobalCollect platform.
+    # api_endpoint::            The base url to the Ingenico ePayments platform.
     # api_key_id::              The identifier of the _secret_api_key_ used to authenticate requests.
-    # secret_api_key::          The key used to authenticate requests sent to the GlobalCollect platform.
+    # secret_api_key::          The key used to authenticate requests sent to the Ingenico ePayments platform.
     # authorization_type::      String describing the authorization protocol to follow.
-    # connect_timeout::         The number of seconds before a connection attempt with the GlobalCollect platform times out.
+    # connect_timeout::         The number of seconds before a connection attempt with the Ingenico ePayments platform times out.
     # socket_timeout::          The number of seconds before a timeout occurs
-    #                           when transmitting data to or from the GlobalCollect platform.
-    # max_connections::         The number of connections with the GlobalCollect platform
+    #                           when transmitting data to or from the Ingenico ePayments platform.
+    # max_connections::         The number of connections with the Ingenico ePayments platform
     #                           that are kept alive in the connection pool. These connections will be reused when possible.
     # proxy_configuration::     {Ingenico::Connect::SDK::ProxyConfiguration} instance that stores the url to a proxy to be used in all communication,
     #                           or nil if no proxy should be used.
@@ -83,7 +83,7 @@ module Ingenico::Connect::SDK
       end
     end
 
-    # Base URL to the GlobalCollect platform
+    # Base URL to the Ingenico ePayments platform
     attr_accessor :api_endpoint
 
     # Identifier of the _secret_api_key_ used in authentication.

data/lib/ingenico/connect/sdk/declined_payment_exception.rb

@@ -1,6 +1,6 @@
 module Ingenico::Connect::SDK
 
-  # Indicates that a payment is declined by the GlobalCollect platform or one of its downstream partners/acquirers.
+  # Indicates that a payment is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
   class DeclinedPaymentException < DeclinedTransactionException
 
     # Create a new DeclinedPaymentException.
@@ -15,7 +15,7 @@ module Ingenico::Connect::SDK
       @errors = errors
     end
 
-    # The declined payment result returned by the GlobalCollect platform.
+    # The declined payment result returned by the Ingenico ePayments platform.
     # Given as a {Ingenico::Connect::SDK::Domain::Payment::CreatePaymentResult} object.
     def payment_result
       if @errors.nil?
@@ -34,7 +34,7 @@ module Ingenico::Connect::SDK
         payment = nil
       end
       if payment.nil?
-        'the GlobalCollect platform returned a declined payment response'
+        'the Ingenico ePayments platform returned a declined payment response'
       else
         "declined payment '" + payment.id + "' with status '" +
             payment.status + "'"

data/lib/ingenico/connect/sdk/declined_payout_exception.rb

@@ -1,6 +1,6 @@
 module Ingenico::Connect::SDK
 
-  # Indicates that a payout is declined by the GlobalCollect platform or one of its downstream partners/acquirers.
+  # Indicates that a payout is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
   class DeclinedPayoutException < DeclinedTransactionException
 
     # Create a new DeclinedPayoutException.
@@ -15,7 +15,7 @@ module Ingenico::Connect::SDK
       @errors = errors
     end
 
-    # The declined payout result as returned by the GlobalCollect platform.
+    # The declined payout result as returned by the Ingenico ePayments platform.
     # Given as a {Ingenico::Connect::SDK::Domain::Payout::PayoutResult} object.
     def payout_result
       if @errors.nil?
@@ -34,7 +34,7 @@ module Ingenico::Connect::SDK
         payout = nil
       end
       if payout.nil?
-        'the GlobalCollect platform returned a declined payout response'
+        'the Ingenico ePayments platform returned a declined payout response'
       else
         "declined payment '" + payout.id + "' with status '" +
             payout.status + "'"

data/lib/ingenico/connect/sdk/declined_refund_exception.rb

@@ -2,7 +2,7 @@ require 'ingenico/connect/sdk/declined_transaction_exception'
 
 module Ingenico::Connect::SDK
 
-  # Indicates that a refund is declined by the GlobalCollect platform or one of its downstream partners/acquirers.
+  # Indicates that a refund is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
   class DeclinedRefundException < DeclinedTransactionException
 
     # Create a new DeclinedRefundException
@@ -17,7 +17,7 @@ module Ingenico::Connect::SDK
       @errors = errors
     end
 
-    # The declined refund result as returned by the GlobalCollect platform.
+    # The declined refund result as returned by the Ingenico ePayments platform.
     # Given as a {Ingenico::Connect::SDK::Domain::Refund::RefundResult} object.
     def refund_result
       if @errors.nil?
@@ -36,7 +36,7 @@ module Ingenico::Connect::SDK
         refund = nil
       end
       if refund.nil?
-        'the GlobalCollect platform returned a declined refund response'
+        'the Ingenico ePayments platform returned a declined refund response'
       else
         "declined refund '" + refund.id + "' with status '" +
             refund.status + "'"

data/lib/ingenico/connect/sdk/declined_transaction_exception.rb

@@ -1,6 +1,6 @@
 module Ingenico::Connect::SDK
 
-  # Indicates that a transaction is declined by the GlobalCollect platform or one of its downstream partners/acquirers.
+  # Indicates that a transaction is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
   class DeclinedTransactionException < ApiException
 
     # Create a new DeclinedTransactionException.

data/lib/ingenico/connect/sdk/defaultimpl/default_authenticator.rb

@@ -4,7 +4,7 @@ require 'base64'
 module Ingenico::Connect::SDK
   module DefaultImpl
 
-    # Authenticates requests made to the GlobalCollect platform using the HMAC algorithm.
+    # Authenticates requests made to the Ingenico ePayments platform using the HMAC algorithm.
     class DefaultAuthenticator < Authenticator
 
       # HMAC algorithm used to generate the signature