Class: HTTY::CLI::Commands::BodyResponse

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

Overview

Encapsulates the body-response command.

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 inherited from HTTY::CLI::Command

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

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

Constructor Details

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

Class Method Details

.categoryObject

Returns the name of a category under which help for the body-response command should appear.



19
20
21
# File 'lib/htty/cli/commands/body_response.rb', line 19

def self.category
  'Inspecting Responses'
end

.command_lineObject

Returns the string used to invoke the body-response command from the command line.



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

def self.command_line
  'body[-response]'
end

.helpObject

Returns the help text for the body-response command.



30
31
32
# File 'lib/htty/cli/commands/body_response.rb', line 30

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

.help_extendedObject

Returns the extended help text for the body-response command.



35
36
37
38
# File 'lib/htty/cli/commands/body_response.rb', line 35

def self.help_extended
  'Displays the body content received in the response. Does not ' +
  'communicate with the host.'
end

.see_also_commandsObject

Returns related command classes for the body-response command.



41
42
43
44
45
46
# File 'lib/htty/cli/commands/body_response.rb', line 41

def self.see_also_commands
  [HTTY::CLI::Commands::BodyResponseOpen,
   HTTY::CLI::Commands::HeadersResponse,
   HTTY::CLI::Commands::Status,
   HTTY::CLI::Commands::BodyRequest]
end

Instance Method Details

#performObject

Performs the body-response command.



49
50
51
52
53
54
55
56
57
# File 'lib/htty/cli/commands/body_response.rb', line 49

def perform
  unless (response = session.last_response)
    raise HTTY::NoResponseError
  end
  unless (body = response.body).to_s.empty?
    puts body
  end
  self
end