Class: Ingenico::Connect::SDK::Client

Inherits:
ApiResource show all
Includes:
Logging::LoggingCapable
Defined in:
lib/ingenico/connect/sdk/client.rb

Overview

Ingenico ePayments platform client.

This client and all its child clients are bound to one specific value for the X-GCS-ClientMetaInfo header.

To get a new client with a different header value, use with_client_meta_info.

Thread safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(communicator, client_meta_info = nil) ⇒ Client

communicator

Ingenico::Connect::SDK::Communicator

client_meta_info

String



31
32
33
 
# File 'lib/ingenico/connect/sdk/client.rb', line 31

def initialize(communicator, client_meta_info=nil)
  super(communicator, {'apiVersion' => Client.API_VERSION}, client_meta_info)
end

Class Method Details

.API_VERSION ⇒ Object 



25
26
27
 
# File 'lib/ingenico/connect/sdk/client.rb', line 25

def self.API_VERSION
  'v1'
end

Instance Method Details

#close ⇒ Object

Releases any system resources associated with this object.



77
78
79
 
# File 'lib/ingenico/connect/sdk/client.rb', line 77

def close
  @communicator.close
end

#close_expired_connections ⇒ Object

Utility method that delegates the call to this client’s communicator.



61
62
63
 
# File 'lib/ingenico/connect/sdk/client.rb', line 61

def close_expired_connections
  @communicator.close_expired_connections
end

#close_idle_connections(idle_time) ⇒ Object

Utility method that delegates the call to this client’s communicator.



56
57
58
 
# File 'lib/ingenico/connect/sdk/client.rb', line 56

def close_idle_connections(idle_time)
  @communicator.close_idle_connections(idle_time)
end

#disable_logging ⇒ Object

Turns off logging.



72
73
74
 
# File 'lib/ingenico/connect/sdk/client.rb', line 72

def disable_logging
  @communicator.disable_logging
end

#enable_logging(communicator_logger) ⇒ Object

Turns on logging using the given communicator logger.

communicator_logger

Ingenico::Connect::SDK::Logging::CommunicatorLogger



67
68
69
 
# File 'lib/ingenico/connect/sdk/client.rb', line 67

def enable_logging(communicator_logger)
  @communicator.enable_logging(communicator_logger)
end

#merchant(merchant_id) ⇒ Object

Resource /{merchantId}

merchant_id

String

Returns

Merchant::MerchantClient



84
85
86
87
88
 
# File 'lib/ingenico/connect/sdk/client.rb', line 84

def merchant(merchant_id)
  Ingenico::Connect::SDK::Merchant::MerchantClient.new(self, {
    'merchantId' => merchant_id,
  })
end

#with_client_meta_info(client_meta_info) ⇒ Object

client_meta_info

JSON string containing the meta data for the client

Returns

A Client which uses the passed meta data for the X-GCS-ClientMetaInfo header.

Raises

Ingenico::Connect::SDK::MarshallerSyntaxException if the given clientMetaInfo is not a valid JSON string



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/ingenico/connect/sdk/client.rb', line 38

def with_client_meta_info(client_meta_info)
  if @client_meta_info.nil? && client_meta_info.nil?
    self
  elsif client_meta_info.nil?
    return Client.new(@communicator, nil)
  else
    # Checking to see if this is valid JSON (no JSON parse exceptions)
    @communicator.marshaller.unmarshal(client_meta_info, DataObject)
    client_meta_info = Base64.strict_encode64(client_meta_info)
    if @client_meta_info == client_meta_info
      self
    else
      return Client.new(@communicator, client_meta_info)
    end
  end
end