class SysAid

The main SysAid class

Public Class Methods

call(method, message) click to toggle source

Proxy for @@client.call but allows us to catch the various exceptions which may happen due to network errors, SOAP errors, etc., which otherwise would have to be caught in many different places.

# File lib/sysaid.rb, line 21
def self.call(method, message)
  begin
    return @@client.call(method, message)
  rescue SocketError => e
      raise SysAidException, "Socket error communicating with SysAid: #{e.message}"
  rescue Errno::EHOSTUNREACH => e
    raise SysAidException, "Server unreachable error communicating with SysAid: #{e.message}"
  rescue Savon::SOAPFault => e
    raise SysAidException, "SOAP error communicating with SysAid: #{e.message}"
  rescue Net::ReadTimeout => e
    raise SysAidException, "Network timeout communicating with SysAid: #{e.message}"
  end
end
client() click to toggle source

Accessor for internal SysaidApiService object. Used by SysAid::Ticket

# File lib/sysaid.rb, line 14
def self.client
  @@client
end
ensure_logged_in() click to toggle source

The SysAid API isn't clear on what creates an API timeout. It's possible to login and make SOAP calls many minutes later but the API seems to timeout at some point. With the exception of the added delay, there's no harm in simply logging in over and over with each call, so we do this in ensure_logged_in until we can get a better answer on what we can do with the SysAid API to actually ensure we're logged in.

# File lib/sysaid.rb, line 57
def self.ensure_logged_in
  self.login unless self.logged_in?
end
logged_in?() click to toggle source

Returns true if logged into SysAid server Note: By design, logged_in? will try to log in if it isn't already

Example:

>> SysAid.logged_in?
=> true
# File lib/sysaid.rb, line 67
def self.logged_in?
  puts "SysAid.logged_in? called" if @@server_settings[:debug]

  # Until official word comes from the company, we're going to login every time
  # to avoid a problem with undetected timeouts.
  #if @@logged_in == false
    login
  #end

  if @@logged_in
    return true
  else
    return false
  end
end
login(account = nil, username = nil, password = nil, wsdl_uri = nil, debug = nil) click to toggle source

self.login does not require credentials be passed every time. SysAid sometimes times out the session and we can simply call 'login' again with the saved credentials to get around the timeout.

# File lib/sysaid.rb, line 86
def self.login(account = nil, username = nil, password = nil, wsdl_uri = nil, debug = nil)
  puts "SysAid.login" if @@server_settings[:debug]

  if account and username and password and wsdl_uri
    # Save server settings in case we need to log in again later
    @@server_settings = { :account => account, :username => username, :password => password, :wsdl_uri => wsdl_uri }
    # 'debug' parameter cannot default to false else it would override default, so use nil and check
    @@server_settings[:debug] = debug if debug != nil
  end

  begin
    @@client = Savon.client(wsdl: @@server_settings[:wsdl_uri], log: @@server_settings[:debug])

    # login
    unless @@server_settings[:account].nil?
      # Call login
      response = self.call(:login, message: { accountId: @@server_settings[:account], userName: @@server_settings[:username], password: @@server_settings[:password] })

      # Retrieve response
      @@session_id = response.to_hash[:login_response][:return]

      @@logged_in = true
    end
  rescue Net::ReadTimeout => e
    # This isn't the API timeout, this is a normal socket timeout error.
    raise SysAidException, "Unable to log into SysAid server: #{e.message}"
  end
end
server_settings() click to toggle source

Accessor for server settings. Used by SysAid::Ticket

# File lib/sysaid.rb, line 43
def self.server_settings
  @@server_settings
end
server_settings=(server_settings) click to toggle source 
# File lib/sysaid.rb, line 46
def self.server_settings=(server_settings)
  @@server_settings = server_settings
  # If they don't pass in debug, set it to false to maintain default settings
  @@server_settings[:debug] = false if server_settings[:debug].nil?
end
session_id() click to toggle source

Accessor for session ID returned by SysAid server. Used by SysAid::Ticket

# File lib/sysaid.rb, line 37
def self.session_id
  @@session_id
end