Class: StatusClient

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/clients/status_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ StatusClient

Initialize the StatusClient class with an API client instance.

Parameters:

  • connection (LockstepApi) —

    The API client object for this connection



22
23
24
 
# File 'lib/lockstep_sdk/clients/status_client.rb', line 22

def initialize(connection)
    @connection = connection
end

Instance Method Details

#ping ⇒ Object

Verifies that your application can successfully call the Lockstep Platform API and returns a successful code regardless of your authentication status or permissions.

The Ping API can be used to verify that your app is working correctly. The Ping API will always return 200 OK. If you call this API and you receive a code other than 200 OK, you should check your network connectivity. A response code of anything other than 200 means that a routing issue or proxy issue may prevent your application from reaching the Lockstep API



32
33
34
35
 
# File 'lib/lockstep_sdk/clients/status_client.rb', line 32

def ping()
    path = "/api/v1/Status"
    @connection.request(:get, path, nil, nil)
end