Class: Ingenico::Connect::SDK::CommunicatorConfiguration

Inherits:
EndpointConfiguration show all
Defined in:
lib/ingenico/connect/sdk/communicator_configuration.rb

Overview

A CommunicatorConfiguration stores all data used to initialize an Communicator.

Instance Attribute Summary collapse

Attributes inherited from EndpointConfiguration

#connect_timeout, #integrator, #max_connections, #proxy_configuration, #shopping_cart_extension, #socket_timeout

Instance Method Summary collapse

Methods inherited from EndpointConfiguration

DEFAULT_MAX_CONNECTIONS

Constructor Details

#initialize(properties: nil, api_endpoint: nil, api_key_id: nil, secret_api_key: nil, authorization_type: nil, connect_timeout: nil, socket_timeout: nil, max_connections: nil, proxy_configuration: nil, integrator: nil, shopping_cart_extension: nil) ⇒ CommunicatorConfiguration

Creates a new CommunicatorConfiguration instance.

If a properties object is given, it will be parsed like a hash in order to read these attributes. If a value is given in both the properties hash and as a separate parameter, the separate parameter will take precedence over the value in the properties.

See Also:

Parameters:

  • (defaults to: nil)

    hash that may contain any of the other parameters.

  • (defaults to: nil)

    the base URL to the Ingenico ePayments platform.

  • (defaults to: nil)

    the identifier of the secret_api_key used to authenticate requests.

  • (defaults to: nil)

    the key used to authenticate requests sent to the Ingenico ePayments platform.

  • (defaults to: nil)

    string describing the authorization protocol to follow.

  • (defaults to: nil)

    the number of seconds before a connection attempt with the Ingenico ePayments platform times out.

  • (defaults to: nil)

    the number of seconds before a timeout occurs when transmitting data to or from the Ingenico ePayments platform.

  • (defaults to: nil)

    the number of connections with the Ingenico ePayments platform that are kept alive in the connection pool. These connections will be reused when possible.

  • (defaults to: nil)

    stores the URL to a proxy to be used in all communication, or nil if no proxy should be used.

  • (defaults to: nil)

    name of the integrator

  • (defaults to: nil)

    stores shopping cart-related metadata.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ingenico/connect/sdk/communicator_configuration.rb', line 31

def initialize(properties: nil, api_endpoint: nil, api_key_id: nil,
               secret_api_key: nil, authorization_type: nil,
               connect_timeout: nil, socket_timeout: nil,
               max_connections: nil, proxy_configuration: nil,
               integrator: nil, shopping_cart_extension: nil)
  if properties
    super(properties, 'connect.api')
    unless properties.nil?
      @authorization_type = DefaultImpl::AuthorizationType.get_authorization(
          properties['connect.api.authorizationType'])
    end
  end
  if api_endpoint
    @api_endpoint = api_endpoint
  end
  if api_key_id
    @api_key_id = api_key_id
  end
  if secret_api_key
    @secret_api_key = secret_api_key
  end
  if authorization_type
    @authorization_type = authorization_type
  end
  if connect_timeout
    @connect_timeout = connect_timeout
  end
  if socket_timeout
    @socket_timeout = socket_timeout
  end
  if max_connections
    @max_connections = max_connections
  end
  if proxy_configuration
    @proxy_configuration = proxy_configuration
  end
  if integrator
    @integrator = integrator
  end
  if shopping_cart_extension
    @shopping_cart_extension = shopping_cart_extension
  end
end

Instance Attribute Details

#api_endpoint ⇒ String

Base URL to the Ingenico ePayments platform

Returns:

  • the current value of api_endpoint



9
10
11
 
# File 'lib/ingenico/connect/sdk/communicator_configuration.rb', line 9

def api_endpoint
  @api_endpoint
end

#api_key_id ⇒ String

Identifier of the secret_api_key used in authentication.

Returns:

  • the current value of api_key_id



9
10
11
 
# File 'lib/ingenico/connect/sdk/communicator_configuration.rb', line 9

def api_key_id
  @api_key_id
end

#authorization_type ⇒ String

String representing the authentication algorithm used

Returns:

  • the current value of authorization_type



9
10
11
 
# File 'lib/ingenico/connect/sdk/communicator_configuration.rb', line 9

def authorization_type
  @authorization_type
end

#secret_api_key ⇒ String

Secret key used in authentication

Returns:

  • the current value of secret_api_key



9
10
11
 
# File 'lib/ingenico/connect/sdk/communicator_configuration.rb', line 9

def secret_api_key
  @secret_api_key
end