connect-sdk-ruby 1.0.0

data/examples/merchant/sessions/create_session_example.rb

@@ -0,0 +1,34 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/sessions/session_request'
+
+Sessions = Ingenico::Connect::SDK::Domain::Sessions
+
+def example
+  get_client do |client|
+    tokens = []
+    tokens << '126166b16ed04b3ab85fb06da1d7a167'
+    tokens << '226166b16ed04b3ab85fb06da1d7a167'
+    tokens << '122c5b4d-dd40-49f0-b7c9-3594212167a9'
+    tokens << '326166b16ed04b3ab85fb06da1d7a167'
+    tokens << '426166b16ed04b3ab85fb06da1d7a167'
+
+    body = Sessions::SessionRequest.new
+    body.tokens = tokens
+
+    response = client.merchant('merchantId').sessions().create(body)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/tokens/approve_sepa_direct_debit_token_example.rb

@@ -0,0 +1,29 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/token/approve_token_request'
+
+Token = Ingenico::Connect::SDK::Domain::Token
+
+def example
+  get_client do |client|
+    body = Token::ApproveTokenRequest.new
+    body.mandate_signature_date = '20150201'
+    body.mandate_signature_place = 'Monument Valley'
+    body.mandate_signed = true
+
+    client.merchant('merchantId').tokens().approvesepadirectdebit('tokenId', body)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/tokens/create_token_example.rb

@@ -0,0 +1,82 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/definitions/address'
+require 'ingenico/connect/sdk/domain/definitions/bank_account_bban'
+require 'ingenico/connect/sdk/domain/definitions/company_information'
+require 'ingenico/connect/sdk/domain/token/create_token_request'
+require 'ingenico/connect/sdk/domain/token/customer_token'
+require 'ingenico/connect/sdk/domain/token/mandate_non_sepa_direct_debit'
+require 'ingenico/connect/sdk/domain/token/personal_information_token'
+require 'ingenico/connect/sdk/domain/token/personal_name_token'
+require 'ingenico/connect/sdk/domain/token/token_non_sepa_direct_debit'
+require 'ingenico/connect/sdk/domain/token/token_non_sepa_direct_debit_payment_product705_specific_data'
+
+Definitions = Ingenico::Connect::SDK::Domain::Definitions
+Token = Ingenico::Connect::SDK::Domain::Token
+
+def example
+  get_client do |client|
+    billing_address = Definitions::Address.new
+    billing_address.additional_info = 'Suite II'
+    billing_address.city = 'Monument Valley'
+    billing_address.country_code = 'US'
+    billing_address.house_number = '1'
+    billing_address.state = 'Utah'
+    billing_address.street = 'Desertroad'
+    billing_address.zip = '84536'
+
+    company_information = Definitions::CompanyInformation.new
+    company_information.name = 'Acme Labs'
+
+    name = Token::PersonalNameToken.new
+    name.first_name = 'Wile'
+    name.surname = 'Coyote'
+    name.surname_prefix = 'E.'
+
+    personal_information = Token::PersonalInformationToken.new
+    personal_information.name = name
+
+    customer = Token::CustomerToken.new
+    customer.billing_address = billing_address
+    customer.company_information = company_information
+    customer.merchant_customer_id = '1234'
+    customer.personal_information = personal_information
+
+    bank_account_bban = Definitions::BankAccountBban.new
+    bank_account_bban.account_number = '000000123456'
+    bank_account_bban.bank_code = '05428'
+    bank_account_bban.branch_code = '11101'
+    bank_account_bban.check_digit = 'X'
+    bank_account_bban.country_code = 'IT'
+
+    payment_product705_specific_data = Token::TokenNonSepaDirectDebitPaymentProduct705SpecificData.new
+    payment_product705_specific_data.authorisation_id = '123456'
+    payment_product705_specific_data.bank_account_bban = bank_account_bban
+
+    mandate = Token::MandateNonSepaDirectDebit.new
+    mandate.payment_product705_specific_data = payment_product705_specific_data
+
+    non_sepa_direct_debit = Token::TokenNonSepaDirectDebit.new
+    non_sepa_direct_debit.customer = customer
+    non_sepa_direct_debit.mandate = mandate
+
+    body = Token::CreateTokenRequest.new
+    body.non_sepa_direct_debit = non_sepa_direct_debit
+    body.payment_product_id = 705
+
+    response = client.merchant('merchantId').tokens().create(body)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/tokens/delete_token_example.rb

@@ -0,0 +1,27 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/merchant/tokens/delete_token_params'
+
+Tokens = Ingenico::Connect::SDK::Merchant::Tokens
+
+def example
+  get_client do |client|
+    query = Tokens::DeleteTokenParams.new
+    query.mandate_cancel_date = '20150102'
+
+    client.merchant('merchantId').tokens().delete('tokenId', query)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/tokens/get_token_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.merchant('merchantId').tokens().get('tokenId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/tokens/update_token_example.rb

@@ -0,0 +1,76 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/definitions/address'
+require 'ingenico/connect/sdk/domain/definitions/card_without_cvv'
+require 'ingenico/connect/sdk/domain/definitions/company_information'
+require 'ingenico/connect/sdk/domain/token/update_token_request'
+require 'ingenico/connect/sdk/domain/token/customer_token'
+require 'ingenico/connect/sdk/domain/token/personal_information_token'
+require 'ingenico/connect/sdk/domain/token/personal_name_token'
+require 'ingenico/connect/sdk/domain/token/token_card'
+require 'ingenico/connect/sdk/domain/token/token_card_data'
+
+Definitions = Ingenico::Connect::SDK::Domain::Definitions
+Token = Ingenico::Connect::SDK::Domain::Token
+
+def example
+  get_client do |client|
+    billing_address = Definitions::Address.new
+    billing_address.additional_info = 'b'
+    billing_address.city = 'Monument Valley'
+    billing_address.country_code = 'US'
+    billing_address.house_number = '13'
+    billing_address.state = 'Utah'
+    billing_address.street = 'Desertroad'
+    billing_address.zip = '84536'
+
+    company_information = Definitions::CompanyInformation.new
+    company_information.name = 'Acme Labs'
+
+    name = Token::PersonalNameToken.new
+    name.first_name = 'Wile'
+    name.surname = 'Coyote'
+    name.surname_prefix = 'E.'
+
+    personal_information = Token::PersonalInformationToken.new
+    personal_information.name = name
+
+    customer = Token::CustomerToken.new
+    customer.billing_address = billing_address
+    customer.company_information = company_information
+    customer.merchant_customer_id = '1234'
+    customer.personal_information = personal_information
+
+    card_without_cvv = Definitions::CardWithoutCvv.new
+    card_without_cvv.card_number = '4567350000427977'
+    card_without_cvv.cardholder_name = 'Wile E. Coyote'
+    card_without_cvv.expiry_date = '0820'
+    card_without_cvv.issue_number = '12'
+
+    data = Token::TokenCardData.new
+    data.card_without_cvv = card_without_cvv
+
+    card = Token::TokenCard.new
+    card.customer = customer
+    card.data = data
+
+    body = Token::UpdateTokenRequest.new
+    body.card = card
+    body.payment_product_id = 1
+
+    client.merchant('merchantId').tokens().update('tokenId', body)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/lib/ingenico/connect/sdk.rb

@@ -0,0 +1,27 @@
+prefix = 'ingenico/connect/sdk/'
+
+require prefix + 'logging'
+require prefix + 'exceptions'
+
+require prefix + 'marshaller'
+require prefix + 'response_header'
+require prefix + 'authenticator'
+require prefix + 'data_object'
+require prefix + 'proxy_configuration'
+require prefix + 'connection'
+require prefix + 'pooled_connection'
+require prefix + 'communicator'
+require prefix + 'endpoint_configuration'
+require prefix + 'communicator_configuration'
+require prefix + 'client'
+require prefix + 'call_context'
+require prefix + 'api_resource'
+require prefix + 'session'
+require prefix + 'response'
+require prefix + 'request_param'
+require prefix + 'request_header'
+require prefix + 'param_request'
+require prefix + 'meta_data_provider'
+require prefix + 'factory'
+
+require prefix + 'defaultimpl'

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

@@ -0,0 +1,52 @@
+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 contains data about the returned response.
+  class ApiException < RuntimeError
+
+    # Creates a new ApiException that reports an error response from the GlobalCollect platform.
+    # It reports the following:
+    # status_code::   HTTP status code the response
+    # response_body:: HTTP response body
+    # error_id::      Error id of the error, may be _nil_
+    # 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')
+      super(message)
+      @status_code = status_code
+      @response_body = response_body
+      @error_id = error_id
+      if errors.nil?
+        @errors = [].freeze
+      else
+        @errors = errors
+      end
+    end
+
+    # HTTP status code of the returned response.
+    attr_reader :status_code
+
+    # Message body of the returned response.
+    attr_reader :response_body
+
+    # An error id corresponding to the error that occurred, if available.
+    attr_reader :error_id
+
+    # A list of errors received from the GlobalCollect platform;
+    # may be empty but never _nil_
+    attr_reader :errors
+
+    def to_s
+      str = super.to_s
+      if @status_code > 0
+        str += '; status_code=' + @status_code.to_s
+      end
+      if !@response_body.nil? && @response_body.length > 0
+        str += "; response_body='" + @response_body + "'"
+      end
+      str.to_s
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+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.
+  class ApiResource
+
+    # Creates a new ApiResource.
+    # arg::               Parent class or {Ingenico::Connect::SDK::Communicator} instance.
+    #                     If a parent class is given its communicator will be used for communication.
+    # path_context::      Hash that contains substitutions for generic locations in the url path.
+    #                     This hash will be used to instantiate a concrete url used to access specific resources.
+    #                     For example in the url https://api-sandbox.globalcollect.com/!{version}/!{merchantId}/payments
+    #                     !{version} and !{merchantId} can be instantiated using the hash
+    #                     !{'version' => 'v1', 'merchantId' => '1234'}. The final url in this case will be
+    #                     https://api-sandbox.globalcollect.com/v1/1234/payments.
+    # client_meta_info::  JSON string containing the meta data for the client.
+    def initialize(arg, path_context, client_meta_info=FALSE)
+      if client_meta_info == FALSE
+        if arg.nil?
+          raise ArgumentError.new('parent is required')
+        end
+        @parent = arg
+        @communicator = arg.communicator
+        @path_context = path_context
+        @client_meta_info = arg.client_meta_info
+      else
+        if arg.nil?
+          raise ArgumentError.new('communicator is required')
+        end
+        @parent = nil
+        @communicator = arg
+        @path_context = path_context
+        @client_meta_info = client_meta_info
+      end
+    end
+
+    # {Ingenico::Connect::SDK::Communicator} instance that provides communication with the GlobalCollect platform.
+    attr_reader :communicator
+
+    # JSON string containing client info specific to the current client.
+    attr_reader :client_meta_info
+
+    protected
+
+    # Returns the X-GCS-ClientMetaInfo header as a {Ingenico::Connect::SDK::RequestHeader}
+    def client_headers
+      if @client_meta_info.nil?
+        nil
+      else
+        [RequestHeader.new('X-GCS-ClientMetaInfo', @client_meta_info)]
+      end
+    end
+
+    def instantiate_uri(uri, path_context=FALSE)
+      if path_context == FALSE
+        uri = replace_all(uri, @path_context)
+        unless @parent.nil?
+          uri = @parent.instantiate_uri(uri)
+        end
+        uri
+      else
+        uri = replace_all(uri, path_context)
+        instantiate_uri(uri)
+      end
+    end
+
+    def create_exception(status_code, response_body, error_object, context)
+      if error_object.is_a?(Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse) && !error_object.payment_result.nil?
+        return DeclinedPaymentException.new(status_code, response_body, error_object)
+      elsif error_object.is_a?(Ingenico::Connect::SDK::Domain::Payout::PayoutErrorResponse) && !error_object.payout_result.nil?
+        return DeclinedPayoutException.new(status_code, response_body, error_object)
+      elsif error_object.is_a?(Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse) && !error_object.refund_result.nil?
+        return DeclinedRefundException.new(status_code, response_body, error_object)
+      end
+      if !(error_object.is_a?(Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse) ||
+        error_object.is_a?(Ingenico::Connect::SDK::Domain::Payout::PayoutErrorResponse) ||
+        error_object.is_a?(Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse) ||
+        error_object.is_a?(Ingenico::Connect::SDK::Domain::Errors::ErrorResponse))
+        raise ArgumentError.new("unsupported error object type: " + error_object.class.name)
+      else
+        error_id = error_object.error_id
+        errors = error_object.errors
+      end
+      case status_code
+        when 400
+           return ValidationException.new(status_code, response_body, error_id, errors)
+        when 403
+          return AuthorizationException.new(status_code, response_body, error_id, errors)
+        when 404, 410
+          return ReferenceException.new(status_code, response_body, error_id, errors)
+        when 409
+          if is_idempotence_error(errors, context)
+            idempotence_key = context.idempotence_key
+            idempotence_request_timestamp = context.idempotence_request_timestamp
+            return IdempotenceException.new(status_code, response_body, error_id,
+                                            errors, idempotence_key,
+                                            idempotence_request_timestamp)
+          else
+            return ReferenceException.new(status_code, response_body, error_id, errors)
+          end
+        when 500, 502, 503
+          return GlobalCollectException.new(status_code, response_body, error_id, errors)
+        else
+          return ApiException.new(status_code, response_body, error_id, errors)
+      end
+    end
+
+    private
+
+    def replace_all(uri, path_context)
+      unless path_context.nil?
+        path_context.each do |key, value|
+          uri = uri.gsub('{' + key + '}', value)
+        end
+      end
+      uri
+    end
+
+    def is_idempotence_error(errors, context)
+      !context.nil? && !context.idempotence_key.nil? && errors.length == 1 &&
+          errors[0].code == '1409'
+    end
+  end
+end