Class: HTTY::CLI::Commands::BodyResponseOpen

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

Overview

Encapsulates the body-response-open 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?, help_extended, #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-open command should appear.



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

def self.category
  'Inspecting Responses'
end

.command_lineObject

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



26
27
28
# File 'lib/htty/cli/commands/body_response_open.rb', line 26

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

.helpObject

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



31
32
33
# File 'lib/htty/cli/commands/body_response_open.rb', line 31

def self.help
  'Opens the body of the response in an external program'
end

.help_extended_preambleObject

Returns the preamble to the extended help text for the body-response-open command.



37
38
39
40
41
# File 'lib/htty/cli/commands/body_response_open.rb', line 37

def self.help_extended_preamble
  'Opens the body content received in the response in a program on your '    +
  'system that is mapped to the type of content. Does not communicate with ' +
  'the host.'
end

.see_also_commandsObject

Returns related command classes for the body-response-open command.



44
45
46
47
# File 'lib/htty/cli/commands/body_response_open.rb', line 44

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

Instance Method Details

#performObject

Performs the body-response-open command.



50
51
52
53
54
55
# File 'lib/htty/cli/commands/body_response_open.rb', line 50

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