Class: MessagebusSDK::MessagebusBase

Inherits:
Object
  • Object
show all
Defined in:
lib/messagebus-sdk/messagebus_base.rb

Constant Summary collapse

DEFAULT_API_ENDPOINT = 
'https://api.messagebus.com'
DEFAULT = 
'DEFAULT'
HEADER_SESSION_KEY = 
'X-MESSAGEBUS-SESSIONKEY'
SCOPE_ALL = 
'all'
TRUE_VALUE = 
'true'
MAX_TEMPLATE_MESSAGES = 
25
HTTP_READ_TIMEOUT = 
60
HTTP_GET = 
"GET"
HTTP_POST = 
"POST"
HTTP_PUT = 
"PUT"
HTTP_DELETE = 
"DELETE"

Instance Method Summary collapse

Constructor Details

#initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT) ⇒ MessagebusBase

Returns a new instance of MessagebusBase.



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/messagebus-sdk/messagebus_base.rb', line 36

def initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT)
  @api_endpoint = api_endpoint
  @api_key = api_key
  @http = nil
  @http_read_timeout = HTTP_READ_TIMEOUT
  init_http_connection(@api_endpoint)

  @results = base_response_params
  @rest_http_errors = define_rest_http_errors
  @return_json = true
  @file_handle = nil
end

Instance Method Details

#api_version ⇒ Object 



49
50
51
 
# File 'lib/messagebus-sdk/messagebus_base.rb', line 49

def api_version
  make_api_request("/api/version")
end

#cacert_info(cert_file) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/messagebus-sdk/messagebus_base.rb', line 53

def cacert_info(cert_file)
  @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
  if !File.exists?(cert_file)
    raise MessagebusSDK::MissingFileError.new("Unable to read file #{cert_file}")
  end
  @http.ca_file = File.join(cert_file)
end

#format_iso_time(time) ⇒ Object 



61
62
63
 
# File 'lib/messagebus-sdk/messagebus_base.rb', line 61

def format_iso_time(time)
  time.strftime("%Y-%m-%dT%H:%M:%SZ")
end

#read_timeout(s) ⇒ Object 



65
66
67
68
69
 
# File 'lib/messagebus-sdk/messagebus_base.rb', line 65

def read_timeout(s)
  if s > 0 and s < 600
    @http_read_timeout = s
  end
end