Class: HTTY::CLI::Commands::Status

Inherits:
HTTY::CLI::Command show all
Includes:
Display
Defined in:
lib/htty/cli/commands/status.rb

Overview

Encapsulates the status command.

Constant Summary

Constant Summary

Constants included from Display

Display::FORMATS

Instance Attribute Summary

Attributes inherited from HTTY::CLI::Command

#arguments, #session

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Display

#break, #format, #formatted_prompt_for, #indent, #logotype, #normal, #notice, #pluralize, #rescuing_from, #say, #say_goodbye, #say_header, #say_hello, #show_headers, #show_request, #show_response, #strong, #word_wrap, #word_wrap_indented

Methods inherited from HTTY::CLI::Command

#add_request_if_new, alias_for, aliases, build_for, command_line, command_line_arguments, complete_for?, #initialize, notify_if_cookies_cleared, raw_name, sanitize_arguments

Constructor Details

This class inherits a constructor from HTTY::CLI::Command

Class Method Details

+ (Object) category

Returns the name of a category under which help for the status command should appear.



20
21
22
# File 'lib/htty/cli/commands/status.rb', line 20

def self.category
  'Inspecting Responses'
end

+ (Object) help

Returns the help text for the status command.



25
26
27
# File 'lib/htty/cli/commands/status.rb', line 25

def self.help
  'Displays the status of the response'
end

+ (Object) help_extended

Returns the extended help text for the status command.



30
31
32
33
34
35
36
37
38
39
# File 'lib/htty/cli/commands/status.rb', line 30

def self.help_extended
  'Displays the status signal, the number of headers, and size of the body ' +
  "received in the response. Does not communicate with the host.\n"          +
  "\n"                                                                       +
  "If a '#{HTTY::Response::COOKIES_HEADER_NAME}' request header is "         +
  'present, a bold asterisk (it looks like a cookie) appears next to the '   +
  "headers summary.\n"                                                       +
  "\n"                                                                       +
  'Status is displayed automatically when a response is received.'
end

+ (Object) see_also_commands

Returns related command classes for the status command.



42
43
44
# File 'lib/htty/cli/commands/status.rb', line 42

def self.see_also_commands
  [HTTY::CLI::Commands::BodyResponse, HTTY::CLI::Commands::HeadersResponse]
end

Instance Method Details

- (Object) perform

Performs the status command.



47
48
49
50
51
52
53
# File 'lib/htty/cli/commands/status.rb', line 47

def perform
  unless (response = session.last_response)
    raise HTTY::NoResponseError
  end
  show_response response
  self
end