Class: HTTY::CLI::Commands::HeadersSet

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

Overview

Encapsulates the headers-set 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, 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

.category ⇒ Object

Returns the name of a category under which help for the headers-set command should appear.



8
9
10
 
# File 'lib/htty/cli/commands/headers_set.rb', line 8

def self.category
  'Building Requests'
end

.command_line_arguments ⇒ Object

Returns the arguments for the command-line usage of the headers-set command.



14
15
16
 
# File 'lib/htty/cli/commands/headers_set.rb', line 14

def self.command_line_arguments
  'NAME VALUE'
end

.help ⇒ Object

Returns the help text for the headers-set command.



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

def self.help
  'Sets a header of the request'
end

.help_extended ⇒ Object

Returns the extended help text for the headers-set command.



24
25
26
27
28
29
30
 
# File 'lib/htty/cli/commands/headers_set.rb', line 24

def self.help_extended
  'Sets a header used for the request. Does not communicate with the '  +
  "host.\n"                                                             +
  "\n"                                                                  +
  'Headers must have unique names. When you set a header that already ' +
  'exists, its value will be changed.'
end

.see_also_commands ⇒ Object

Returns related command classes for the headers-set command.



33
34
35
36
37
 
# File 'lib/htty/cli/commands/headers_set.rb', line 33

def self.see_also_commands
  [HTTY::CLI::Commands::HeadersRequest,
   HTTY::CLI::Commands::HeadersUnset,
   HTTY::CLI::Commands::HeadersUnsetAll]
end

Instance Method Details

#perform ⇒ Object

Performs the headers-set command.



40
41
42
43
44
 
# File 'lib/htty/cli/commands/headers_set.rb', line 40

def perform
  add_request_if_new do |request|
    request.header_set(*arguments)
  end
end