Class: HTTY::CLI::Commands::CookiesAdd

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

Overview

Encapsulates the cookies-add 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

+ (Object) category

Returns the name of a category under which help for the cookies-add command should appear.



18
19
20
# File 'lib/htty/cli/commands/cookies_add.rb', line 18

def self.category
  'Building Requests'
end

+ (Object) command_line_arguments

Returns the arguments for the command-line usage of the cookies-add command.



24
25
26
# File 'lib/htty/cli/commands/cookies_add.rb', line 24

def self.command_line_arguments
  'NAME [VALUE]'
end

+ (Object) help

Returns the help text for the cookies-add command.



29
30
31
# File 'lib/htty/cli/commands/cookies_add.rb', line 29

def self.help
  'Adds a cookie to the request'
end

+ (Object) help_extended

Returns the extended help text for the cookies-add command.



34
35
36
37
38
39
40
41
42
43
# File 'lib/htty/cli/commands/cookies_add.rb', line 34

def self.help_extended
  'Adds a cookie used for the request. Does not communicate with the '   +
  "host.\n"                                                              +
  "\n"                                                                   +
  'Cookies are not required to have unique names. You can add multiple ' +
  'cookies with the same name, and they will be removed in '             +
  "last-in-first-out order.\n"                                           +
  "\n"                                                                   +
  'Cookies are not required to have values, either.'
end

+ (Object) see_also_commands

Returns related command classes for the cookies-add command.



46
47
48
49
50
51
# File 'lib/htty/cli/commands/cookies_add.rb', line 46

def self.see_also_commands
  [HTTY::CLI::Commands::Cookies,
   HTTY::CLI::Commands::CookiesRemove,
   HTTY::CLI::Commands::CookiesRemoveAll,
   HTTY::CLI::Commands::CookiesUse]
end

Instance Method Details

- (Object) perform

Performs the cookies-add command.



54
55
56
57
58
# File 'lib/htty/cli/commands/cookies_add.rb', line 54

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