Module: Octokit::Client::ServiceStatus

Included in:
Octokit::Client
Defined in:
lib/octokit/client/service_status.rb

Overview

Methods for the GitHub Status API

See Also:

Constant Summary collapse

SUMMARY_ROOT =

Root for status API

'https://www.githubstatus.com/api/v2/summary.json'
STATUS_ROOT = 
'https://www.githubstatus.com/api/v2/status.json'
COMPONENTS_ROOT = 
'https://www.githubstatus.com/api/v2/components.json'

Instance Method Summary collapse

Instance Method Details

#github_status ⇒ Sawyer::Resource

Returns the current system status

Returns:

  • (Sawyer::Resource) —

    GitHub status

See Also:



27
28
29
 
# File 'lib/octokit/client/service_status.rb', line 27

def github_status
  get(STATUS_ROOT)
end

#github_status_last_message ⇒ Sawyer::Resource

Returns the last human communication, status, and timestamp.

Returns:

  • (Sawyer::Resource) —

    GitHub status last message

See Also:



35
36
37
 
# File 'lib/octokit/client/service_status.rb', line 35

def github_status_last_message
  get(COMPONENTS_ROOT).components.first
end

#github_status_messages ⇒ Array<Sawyer::Resource>

Returns the most recent human communications with status and timestamp.

Returns:

  • (Array<Sawyer::Resource>) —

    GitHub status messages

See Also:



43
44
45
 
# File 'lib/octokit/client/service_status.rb', line 43

def github_status_messages
  get(COMPONENTS_ROOT).components
end

#github_status_summary ⇒ <Sawyer::Resource>

Returns a summary with the current status and the last status messages.

Returns:

  • (<Sawyer::Resource>) —

    GitHub status summary

See Also:



19
20
21
 
# File 'lib/octokit/client/service_status.rb', line 19

def github_status_summary
  get(SUMMARY_ROOT)
end