htty 1.0.0 → 1.1.0

data/{app → lib}/htty/cli/commands/body_response.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::BodyResponse.
-
 require File.expand_path("#{File.dirname __FILE__}/../../no_response_error")
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/body_request")
@@ -35,7 +33,7 @@ class HTTY::CLI::Commands::BodyResponse < HTTY::CLI::Command
   # Returns the extended help text for the _body-response_ command.
   def self.help_extended
     'Displays the body content received in the response. Does not ' +
-    'communicate with the endpoint.'
+    'communicate with the host.'
   end
 
   # Returns related command classes for the _body-response_ command.

data/{app → lib}/htty/cli/commands/body_set.rb

@@ -1,6 +1,5 @@
-# Defines HTTY::CLI::Commands::BodySet.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../display")
 require File.expand_path("#{File.dirname __FILE__}/body_request")
 require File.expand_path("#{File.dirname __FILE__}/body_unset")
 
@@ -13,6 +12,8 @@ module HTTY::CLI::Commands; end
 # Encapsulates the _body-set_ command.
 class HTTY::CLI::Commands::BodySet < HTTY::CLI::Command
 
+  include HTTY::CLI::Display
+
   # Returns the name of a category under which help for the _body-set_ command
   # should appear.
   def self.category
@@ -27,7 +28,7 @@ class HTTY::CLI::Commands::BodySet < HTTY::CLI::Command
   # Returns the extended help text for the _body-set_ command.
   def self.help_extended
     'Sets the body content used for the request. Does not communicate with ' +
-    "the endpoint.\n"                                                        +
+    "the host.\n"                                                            +
     "\n"                                                                     +
     'Hit Return three times in a row to signify the end of the body.'
   end
@@ -40,10 +41,14 @@ class HTTY::CLI::Commands::BodySet < HTTY::CLI::Command
   # Performs the _body-set_ command.
   def perform
     add_request_if_has_response do |request|
+      puts notice('Hit Return three times to signify the end of the body')
       lines            = []
       empty_line_count = 0
       while empty_line_count < 2 do
-        lines << $stdin.gets.chomp
+        if (input = $stdin.gets).nil?
+          break
+        end
+        lines << input.chomp
         empty_line_count = lines.last.empty? ? (empty_line_count + 1) : 0
       end
       request.body_set lines.join("\n").gsub(/[\r\n]+$/, '')

data/{app → lib}/htty/cli/commands/body_unset.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::BodyUnset.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/body_request")
 require File.expand_path("#{File.dirname __FILE__}/body_set")
@@ -27,7 +25,7 @@ class HTTY::CLI::Commands::BodyUnset < HTTY::CLI::Command
   # Returns the extended help text for the _body-unset_ command.
   def self.help_extended
     'Clears the body content used for the request. Does not communicate with ' +
-    'the endpoint.'
+    'the host.'
   end
 
   # Returns related command classes for the _body-unset_ command.

data/{app → lib}/htty/cli/commands/cd.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::Cd.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/path_set")
 

data/{app → lib}/htty/cli/commands/cookie_add.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::CookieAdd.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/cookies_add")
 

data/{app → lib}/htty/cli/commands/cookie_remove.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::CookieRemove.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/cookies_remove")
 

data/{app → lib}/htty/cli/commands/cookies.rb

@@ -1,6 +1,6 @@
-# Defines HTTY::CLI::Commands::Cookies.
-
+require File.expand_path("#{File.dirname __FILE__}/../../request")
 require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../display")
 require File.expand_path("#{File.dirname __FILE__}/cookies_add")
 require File.expand_path("#{File.dirname __FILE__}/cookies_remove")
 require File.expand_path("#{File.dirname __FILE__}/cookies_remove_all")
@@ -17,6 +17,8 @@ module HTTY::CLI::Commands; end
 # Encapsulates the _cookies_ command.
 class HTTY::CLI::Commands::Cookies < HTTY::CLI::Command
 
+  include HTTY::CLI::Display
+
   # Returns the name of a category under which help for the _cookies_ command
   # should appear.
   def self.category
@@ -31,10 +33,12 @@ class HTTY::CLI::Commands::Cookies < HTTY::CLI::Command
   # Returns the extended help text for the _cookies_ command.
   def self.help_extended
     'Displays the cookies used for the request. Does not communicate with '   +
-    "the endpoint.\n"                                                         +
+    "the host.\n"                                                             +
     "\n"                                                                      +
-    "This command displays cookies extracted from the request's 'Cookie' "    +
-    "header, which is nevertheless shown when you type 'headers-request'.\n"  +
+    "This command displays cookies extracted from the request's "             +
+    "'#{HTTY::Request::COOKIES_HEADER_NAME}' header, which is nevertheless "  +
+    'shown when you type '                                                    +
+    "#{strong HTTY::CLI::Commands::HeadersRequest.command_line}.\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 '                +

data/{app → lib}/htty/cli/commands/cookies_add.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::CookiesAdd.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/cookies")
 require File.expand_path("#{File.dirname __FILE__}/cookies_remove")
@@ -35,7 +33,7 @@ class HTTY::CLI::Commands::CookiesAdd < HTTY::CLI::Command
   # Returns the extended help text for the _cookies-add_ command.
   def self.help_extended
     'Adds a cookie used for the request. Does not communicate with the '   +
-    "endpoint.\n"                                                          +
+    "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 '             +

data/{app → lib}/htty/cli/commands/cookies_clear.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::CookiesClear.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/cookies_remove_all")
 

data/{app → lib}/htty/cli/commands/cookies_remove.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::CookiesRemove.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/cookies")
 require File.expand_path("#{File.dirname __FILE__}/cookies_add")
@@ -35,7 +33,7 @@ class HTTY::CLI::Commands::CookiesRemove < HTTY::CLI::Command
   # Returns the extended help text for the _cookies-remove_ command.
   def self.help_extended
     'Removes a cookie used for the request. Does not communicate with the ' +
-    "endpoint.\n"                                                           +
+    "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 '              +

data/{app → lib}/htty/cli/commands/cookies_remove_all.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::CookiesRemoveAll.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/cookies")
 require File.expand_path("#{File.dirname __FILE__}/cookies_add")
@@ -29,7 +27,7 @@ class HTTY::CLI::Commands::CookiesRemoveAll < HTTY::CLI::Command
   # Returns the extended help text for the _cookies-remove-all_ command.
   def self.help_extended
     'Removes all cookies used for the request. Does not communicate with the ' +
-    'endpoint.'
+    'host.'
   end
 
   # Returns related command classes for the _cookies-remove-all_ command.

data/{app → lib}/htty/cli/commands/cookies_use.rb

@@ -1,6 +1,6 @@
-# Defines HTTY::CLI::Commands::CookiesUse.
-
+require File.expand_path("#{File.dirname __FILE__}/../../response")
 require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../display")
 require File.expand_path("#{File.dirname __FILE__}/cookies")
 require File.expand_path("#{File.dirname __FILE__}/cookies_add")
 require File.expand_path("#{File.dirname __FILE__}/cookies_remove")
@@ -16,6 +16,8 @@ module HTTY::CLI::Commands; end
 # Encapsulates the _cookies-use_ command.
 class HTTY::CLI::Commands::CookiesUse < HTTY::CLI::Command
 
+  include HTTY::CLI::Display
+
   # Returns the name of a category under which help for the _cookies-use_
   # command should appear.
   def self.category
@@ -30,7 +32,8 @@ class HTTY::CLI::Commands::CookiesUse < HTTY::CLI::Command
   # Returns the extended help text for the _cookies-use_ command.
   def self.help_extended
     'Sets the cookies of the request to the cookies offered in the response ' +
-    "(the 'Set-Cookie' header). Does not communicate with the endpoint."
+    "(the '#{HTTY::Response::COOKIES_HEADER_NAME}' header). Does not "        +
+    'communicate with the host.'
   end
 
   # Returns related command classes for the _cookies-use_ command.
@@ -50,7 +53,11 @@ class HTTY::CLI::Commands::CookiesUse < HTTY::CLI::Command
     end
 
     add_request_if_has_response do |request|
-      request.cookies_use session.last_response
+      changed_request = request.cookies_use(session.last_response)
+      phrase = pluralize('cookie', changed_request.cookies.length)
+      phrase = phrase[0..0].upcase + phrase[1..-1]
+      puts notice("#{phrase} now in use")
+      changed_request
     end
   end
 

data/{app → lib}/htty/cli/commands/delete.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::Delete.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/http_delete")
 

data/{app → lib}/htty/cli/commands/exit.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::Exit.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/quit")
 

data/{app → lib}/htty/cli/commands/follow.rb

@@ -1,7 +1,5 @@
-# Defines HTTY::CLI::Commands::Follow.
-
+require File.expand_path("#{File.dirname __FILE__}/../../response")
 require File.expand_path("#{File.dirname __FILE__}/../command")
-require File.expand_path("#{File.dirname __FILE__}/../cookie_clearing_command")
 require File.expand_path("#{File.dirname __FILE__}/address")
 require File.expand_path("#{File.dirname __FILE__}/http_get")
 
@@ -14,8 +12,6 @@ module HTTY::CLI::Commands; end
 # Encapsulates the _follow_ command.
 class HTTY::CLI::Commands::Follow < HTTY::CLI::Command
 
-  include HTTY::CLI::CookieClearingCommand
-
   # Returns the name of a category under which help for the _follow_ command
   # should appear.
   def self.category
@@ -25,13 +21,14 @@ class HTTY::CLI::Commands::Follow < HTTY::CLI::Command
   # Returns the help text for the _follow_ command.
   def self.help
     "Changes the address of the request to the value of the response's " +
-    "'Location' header"
+    "'#{HTTY::Response::LOCATION_HEADER_NAME}' header"
   end
 
   # Returns the extended help text for the _follow_ command.
   def self.help_extended
-    "Changes the address of the request to the value of the response's " +
-    "'Location' header. Does not communicate with the endpoint."
+    "Changes the address of the request to the value of the response's "      +
+    "'#{HTTY::Response::LOCATION_HEADER_NAME}' header. Does not communicate " +
+    'with the host.'
   end
 
   # Returns related command classes for the _follow_ command.
@@ -47,7 +44,7 @@ class HTTY::CLI::Commands::Follow < HTTY::CLI::Command
     end
 
     add_request_if_has_response do |request|
-      notify_if_cookies_cleared request do
+      self.class.notify_if_cookies_cleared request do
         request.follow session.last_response
       end
     end

data/{app → lib}/htty/cli/commands/form.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::Form.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 
 module HTTY; end

data/{app → lib}/htty/cli/commands/form_add.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::FormAdd.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 
 module HTTY; end

data/{app → lib}/htty/cli/commands/form_clear.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::FormClear.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/form_remove_all")
 

data/{app → lib}/htty/cli/commands/form_remove.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::FormRemove.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 
 module HTTY; end

data/{app → lib}/htty/cli/commands/form_remove_all.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::FormRemoveAll.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 
 module HTTY; end

data/{app → lib}/htty/cli/commands/fragment_clear.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::FragmentClear.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/fragment_unset")
 

data/{app → lib}/htty/cli/commands/fragment_set.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::FragmentSet.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/../url_escaping")
 require File.expand_path("#{File.dirname __FILE__}/address")
@@ -35,7 +33,9 @@ class HTTY::CLI::Commands::FragmentSet < HTTY::CLI::Command
   # Returns the extended help text for the _fragment-set_ command.
   def self.help_extended
     'Sets the page fragment used for the request. Does not communicate with ' +
-    "the endpoint.\n"                                                         +
+    "the host.\n"                                                             +
+    "\n"                                                                      +
+    "The page fragment will be URL-encoded if necessary.\n"                   +
     "\n"                                                                      +
     'The console prompt shows the address for the current request.'
   end
@@ -52,7 +52,9 @@ class HTTY::CLI::Commands::FragmentSet < HTTY::CLI::Command
       clean_arguments = arguments.collect do |a|
         a.gsub(/^#/, '')
       end
-      request.fragment_set(*escape_or_warn_of_escape_sequences(clean_arguments))
+      self.class.notify_if_cookies_cleared request do
+        request.fragment_set(*escape_or_warn_of_escape_sequences(clean_arguments))
+      end
     end
   end
 

data/{app → lib}/htty/cli/commands/fragment_unset.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::FragmentUnset.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/address")
 require File.expand_path("#{File.dirname __FILE__}/fragment_set")
@@ -27,7 +25,7 @@ class HTTY::CLI::Commands::FragmentUnset < HTTY::CLI::Command
   # Returns the extended help text for the _fragment-unset_ command.
   def self.help_extended
     'Removes the page fragment used for the request. Does not communicate ' +
-    "with the endpoint.\n"                                                  +
+    "with the host.\n"                                                      +
     "\n"                                                                    +
     'The console prompt shows the address for the current request.'
   end
@@ -41,7 +39,9 @@ class HTTY::CLI::Commands::FragmentUnset < HTTY::CLI::Command
   # Performs the _fragment-unset_ command.
   def perform
     add_request_if_has_response do |request|
-      request.fragment_unset(*arguments)
+      self.class.notify_if_cookies_cleared request do
+        request.fragment_unset(*arguments)
+      end
     end
   end
 

data/{app → lib}/htty/cli/commands/get.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::Get.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/http_get")
 

data/{app → lib}/htty/cli/commands/header_set.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::HeaderSet.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/headers_set")
 

data/{app → lib}/htty/cli/commands/header_unset.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::HeaderUnset.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/headers_unset")
 

data/{app → lib}/htty/cli/commands/headers_clear.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::HeadersClear.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/headers_unset_all")
 

data/{app → lib}/htty/cli/commands/headers_request.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::HeadersRequest.
-
 require File.expand_path("#{File.dirname __FILE__}/../../request")
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/../display")
@@ -34,11 +32,16 @@ class HTTY::CLI::Commands::HeadersRequest < HTTY::CLI::Command
 
   # Returns the extended help text for the _headers-request_ command.
   def self.help_extended
-    'Displays the headers used for the request. Does not communicate with '  +
-    "the endpoint.\n"                                                        +
-    "\n"                                                                     +
-    'Headers must have unique names. When you set a header that already '    +
-    'exists, its value will be changed.'
+    'Displays the headers 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.\n"                                     +
+    "\n"                                                                       +
+    "A '#{HTTY::Request::COOKIES_HEADER_NAME}' request header is marked with " +
+    'a bold asterisk (it looks like a cookie). Similarly, an '                 +
+    "'#{HTTY::Request::AUTHORIZATION_HEADER_NAME}' request header is marked "  +
+    "with a bold mercantile symbol ('@')."
   end
 
   # Returns related command classes for the _headers-request_ command.
@@ -63,7 +66,9 @@ class HTTY::CLI::Commands::HeadersRequest < HTTY::CLI::Command
               else
                 request.headers
               end
-    show_headers headers, HTTY::Request::COOKIES_HEADER_NAME
+    show_headers headers,
+                 :show_asterisk_next_to => HTTY::Request::COOKIES_HEADER_NAME,
+                 :show_mercantile_next_to => HTTY::Request::AUTHORIZATION_HEADER_NAME
     self
   end
 

data/{app → lib}/htty/cli/commands/headers_response.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::HeadersResponse.
-
 require File.expand_path("#{File.dirname __FILE__}/../../response")
 require File.expand_path("#{File.dirname __FILE__}/../../no_response_error")
 require File.expand_path("#{File.dirname __FILE__}/../command")
@@ -41,7 +39,10 @@ class HTTY::CLI::Commands::HeadersResponse < HTTY::CLI::Command
   # Returns the extended help text for the _headers-response_ command.
   def self.help_extended
     'Displays the headers received in the response. Does not communicate ' +
-    'with the endpoint.'
+    "with the host.\n"                                                     +
+    "\n"                                                                   +
+    "A '#{HTTY::Response::COOKIES_HEADER_NAME}' request header is marked " +
+    'with a bold asterisk (it looks like a cookie).'
   end
 
   # Returns related command classes for the _headers-response_ command.
@@ -58,7 +59,8 @@ class HTTY::CLI::Commands::HeadersResponse < HTTY::CLI::Command
     unless (response = session.last_response)
       raise HTTY::NoResponseError
     end
-    show_headers response.headers, HTTY::Response::COOKIES_HEADER_NAME
+    show_headers response.headers,
+                 :show_asterisk_next_to => HTTY::Response::COOKIES_HEADER_NAME
     self
   end