htty 1.0.0 → 1.1.0

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::HeadersSet.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/headers_request")
 require File.expand_path("#{File.dirname __FILE__}/headers_unset")
@@ -34,7 +32,7 @@ class HTTY::CLI::Commands::HeadersSet < HTTY::CLI::Command
   # Returns the extended help text for the _headers-set_ command.
   def self.help_extended
     'Sets a header used for the request. Does not communicate with the '  +
-    "endpoint.\n"                                                         +
+    "host.\n"                                                             +
     "\n"                                                                  +
     'Headers must have unique names. When you set a header that already ' +
     'exists, its value will be changed.'

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::HeadersUnset.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/headers_request")
 require File.expand_path("#{File.dirname __FILE__}/headers_set")
@@ -33,8 +31,7 @@ class HTTY::CLI::Commands::HeadersUnset < HTTY::CLI::Command
 
   # Returns the extended help text for the _headers-unset_ command.
   def self.help_extended
-    'Removes a header used for the request. Does not communicate with the ' +
-    'endpoint.'
+    'Removes a header used for the request. Does not communicate with the host.'
   end
 
   # Returns related command classes for the _headers-unset_ command.

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::HeadersUnsetAll.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/headers_request")
 require File.expand_path("#{File.dirname __FILE__}/headers_set")
@@ -28,7 +26,7 @@ class HTTY::CLI::Commands::HeadersUnsetAll < HTTY::CLI::Command
   # Returns the extended help text for the _headers-unset-all_ command.
   def self.help_extended
     'Removes all headers used for the request. Does not communicate with the ' +
-    'endpoint.'
+    'host.'
   end
 
   # Returns related command classes for the _headers-unset-all_ command.

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::Help.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/../commands")
 require File.expand_path("#{File.dirname __FILE__}/../display")
@@ -25,6 +23,12 @@ class HTTY::CLI::Commands::Help < HTTY::CLI::Command
     'Displays this help table, or help on the specified command'
   end
 
+  # Returns the extended help text for the _help_ command.
+  def self.help_extended
+    'Displays a table containing available commands and a brief description ' +
+    'of each, or detailed help on the specified command.'
+  end
+
   # Performs the _help_ command.
   def perform
     return display_help if arguments.empty?
@@ -51,9 +55,9 @@ private
                            nil]
     HTTY::CLI::Commands.select do |c|
       # Filter out commands not yet implemented.
-      c.instance_methods(false).collect(&:to_sym).include?(:perform) ||
+      c.instance_methods.collect(&:to_sym).include?(:perform) ||
       (c.alias_for &&
-       c.alias_for.instance_methods(false).collect(&:to_sym).include?(:perform))
+       c.alias_for.instance_methods.collect(&:to_sym).include?(:perform))
     end.group_by(&:category).sort_by do |category, commands|
       # Group commands by category and give the categories a custom order.
       categories_in_order.index category

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::History.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/../display")
 require File.expand_path("#{File.dirname __FILE__}/history_verbose")
@@ -29,11 +27,11 @@ class HTTY::CLI::Commands::History < HTTY::CLI::Command
 
   # Returns the extended help text for the _history_ command.
   def self.help_extended
-    'Displays previous request-response activity in this session. Does not '   +
-    "communicate with the endpoint.\n"                                         +
-    "\n"                                                                       +
-    'Only a summary of each request-response pair is shown; headers and body ' +
-    'content are omitted.'
+    'Displays previous request-response activity in this session. Does not '  +
+    "communicate with the host.\n"                                            +
+    "\n"                                                                      +
+    'Only a summary of each request-response pair is shown; the contents of ' +
+    'headers and bodies are hidden.'
   end
 
   # Returns related command classes for the _history_ command.

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::HistoryVerbose.
-
 require File.expand_path("#{File.dirname __FILE__}/../../request")
 require File.expand_path("#{File.dirname __FILE__}/../../response")
 require File.expand_path("#{File.dirname __FILE__}/../command")
@@ -32,7 +30,7 @@ class HTTY::CLI::Commands::HistoryVerbose < HTTY::CLI::Command
   # Returns the extended help text for the _history_ command.
   def self.help_extended
     'Displays the details of previous request-response activity in this ' +
-    "session. Does not communicate with the endpoint.\n"                  +
+    "session. Does not communicate with the host.\n"                      +
     "\n"                                                                  +
     'All headers and body content of each request-response pair are shown.'
   end
@@ -58,7 +56,9 @@ class HTTY::CLI::Commands::HistoryVerbose < HTTY::CLI::Command
       show_request request
 
       puts unless request.headers.empty?
-      show_headers request.headers, HTTY::Request::COOKIES_HEADER_NAME
+      show_headers request.headers,
+                   :show_asterisk_next_to => HTTY::Request::COOKIES_HEADER_NAME,
+                   :show_mercantile_next_to => HTTY::Request::AUTHORIZATION_HEADER_NAME
 
       unless request.body.to_s.empty?
         puts
@@ -69,7 +69,8 @@ class HTTY::CLI::Commands::HistoryVerbose < HTTY::CLI::Command
       show_response request.response
 
       puts unless request.response.headers.empty?
-      show_headers request.response.headers, HTTY::Response::COOKIES_HEADER_NAME
+      show_headers request.response.headers,
+                   :show_asterisk_next_to => HTTY::Response::COOKIES_HEADER_NAME
 
       unless request.response.body.to_s.empty?
         puts

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

@@ -1,7 +1,4 @@
-# Defines HTTY::CLI::Commands::HostSet.
-
 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")
 
 module HTTY; end
@@ -13,8 +10,6 @@ module HTTY::CLI::Commands; end
 # Encapsulates the _host-set_ command.
 class HTTY::CLI::Commands::HostSet < HTTY::CLI::Command
 
-  include HTTY::CLI::CookieClearingCommand
-
   # Returns the name of a category under which help for the _host-set_ command
   # should appear.
   def self.category
@@ -34,7 +29,7 @@ class HTTY::CLI::Commands::HostSet < HTTY::CLI::Command
   # Returns the extended help text for the _host-set_ command.
   def self.help_extended
     'Changes the host used for the request. Does not communicate with the '  +
-    "endpoint.\n"                                                            +
+    "host.\n"                                                                +
     "\n"                                                                     +
     "The host you supply can be either a hostname (e.g., 'github.com') or "  +
     "an IP address (e.g., '127.0.0.1').\n"                                   +
@@ -50,7 +45,7 @@ class HTTY::CLI::Commands::HostSet < HTTY::CLI::Command
   # Performs the _host-set_ command.
   def perform
     add_request_if_has_response do |request|
-      notify_if_cookies_cleared request do
+      self.class.notify_if_cookies_cleared request do
         request.host_set(*arguments)
       end
     end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::PathSet.
-
 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")
@@ -34,7 +32,9 @@ class HTTY::CLI::Commands::PathSet < HTTY::CLI::Command
   # Returns the extended help text for the _path-set_ command.
   def self.help_extended
     'Changes the path used for the request. Does not communicate with the ' +
-    "endpoint.\n"                                                           +
+    "host.\n"                                                               +
+    "\n"                                                                    +
+    "The path will be URL-encoded if necessary.\n"                          +
     "\n"                                                                    +
     'The console prompt shows the address for the current request.'
   end
@@ -47,7 +47,9 @@ class HTTY::CLI::Commands::PathSet < HTTY::CLI::Command
   # Performs the _path-set_ command.
   def perform
     add_request_if_has_response do |request|
-      request.path_set(*escape_or_warn_of_escape_sequences(arguments))
+      self.class.notify_if_cookies_cleared request do
+        request.path_set(*escape_or_warn_of_escape_sequences(arguments))
+      end
     end
   end
 

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::PortSet.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/address")
 require File.expand_path("#{File.dirname __FILE__}/scheme_set")
@@ -32,7 +30,7 @@ class HTTY::CLI::Commands::PortSet < HTTY::CLI::Command
   # Returns the extended help text for the _port-set_ command.
   def self.help_extended
     'Changes the TCP port used for the request. Does not communicate with '  +
-    "the endpoint.\n"                                                        +
+    "the host.\n"                                                            +
     "\n"                                                                     +
     "The port you supply must be an integer between 0 and 65,535. Changing " +
     "the port has no effect on the scheme, and vice versa.\n"                +
@@ -48,7 +46,9 @@ class HTTY::CLI::Commands::PortSet < HTTY::CLI::Command
   # Performs the _port-set_ command.
   def perform
     add_request_if_has_response do |request|
-      request.port_set(*arguments)
+      self.class.notify_if_cookies_cleared request do
+        request.port_set(*arguments)
+      end
     end
   end
 

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

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

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

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

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

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

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::QuerySet.
-
 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")
@@ -31,14 +29,17 @@ class HTTY::CLI::Commands::QuerySet < HTTY::CLI::Command
 
   # Returns the help text for the _query-set_ command.
   def self.help
-    "Sets a query string parameter in the request's address"
+    "Sets a query-string parameter in the request's address"
   end
 
   # Returns the extended help text for the _query-set_ command.
   def self.help_extended
-    'Sets a query string parameter used for the request. Does not ' +
-    "communicate with the endpoint.\n"                              +
-    "\n"                                                            +
+    'Sets a query-string parameter used for the request. Does not '            +
+    "communicate with the host.\n"                                             +
+    "\n"                                                                       +
+    'The name and value of the query-string parameter will be URL-encoded if ' +
+    "necessary.\n"                                                             +
+    "\n"                                                                       +
     'The console prompt shows the address for the current request.'
   end
 
@@ -52,7 +53,9 @@ class HTTY::CLI::Commands::QuerySet < HTTY::CLI::Command
   # Performs the _query-set_ command.
   def perform
     add_request_if_has_response do |request|
-      request.query_set(*escape_or_warn_of_escape_sequences(arguments))
+      self.class.notify_if_cookies_cleared request do
+        request.query_set(*escape_or_warn_of_escape_sequences(arguments))
+      end
     end
   end
 

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

@@ -1,6 +1,5 @@
-# Defines HTTY::CLI::Commands::QueryUnset.
-
 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")
 require File.expand_path("#{File.dirname __FILE__}/query_set")
 require File.expand_path("#{File.dirname __FILE__}/query_unset_all")
@@ -14,6 +13,8 @@ module HTTY::CLI::Commands; end
 # Encapsulates the _query-unset_ command.
 class HTTY::CLI::Commands::QueryUnset < HTTY::CLI::Command
 
+  include HTTY::CLI::UrlEscaping
+
   # Returns the name of a category under which help for the _query-unset_
   # command should appear.
   def self.category
@@ -28,13 +29,16 @@ class HTTY::CLI::Commands::QueryUnset < HTTY::CLI::Command
 
   # Returns the help text for the _query-unset_ command.
   def self.help
-    "Removes a query string parameter from the request's address"
+    "Removes a query-string parameter from the request's address"
   end
 
   # Returns the extended help text for the _query-unset_ command.
   def self.help_extended
-    'Removes a query string parameter used for the request. Does not ' +
-    "communicate with the endpoint.\n"                                 +
+    'Removes a query-string parameter used for the request. Does not ' +
+    "communicate with the host.\n"                                     +
+    "\n"                                                               +
+    'The name of the query-string parameter will be URL-encoded if '   +
+    "necessary.\n"                                                     +
     "\n"                                                               +
     'The console prompt shows the address for the current request.'
   end
@@ -49,7 +53,9 @@ class HTTY::CLI::Commands::QueryUnset < HTTY::CLI::Command
   # Performs the _query-unset_ command.
   def perform
     add_request_if_has_response do |request|
-      request.query_unset(*arguments)
+      self.class.notify_if_cookies_cleared request do
+        request.query_unset(*escape_or_warn_of_escape_sequences(arguments))
+      end
     end
   end
 

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::QueryUnsetAll.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/address")
 require File.expand_path("#{File.dirname __FILE__}/query_set")
@@ -28,7 +26,7 @@ class HTTY::CLI::Commands::QueryUnsetAll < HTTY::CLI::Command
   # Returns the extended help text for the _query-unset-all_ command.
   def self.help_extended
     'Clears the query string used for the request. Does not communicate with ' +
-    "the endpoint.\n"                                                          +
+    "the host.\n"                                                              +
     "\n"                                                                       +
     'The console prompt shows the address for the current request.'
   end
@@ -43,7 +41,9 @@ class HTTY::CLI::Commands::QueryUnsetAll < HTTY::CLI::Command
   # Performs the _query-unset-all_ command.
   def perform
     add_request_if_has_response do |request|
-      request.query_unset_all(*arguments)
+      self.class.notify_if_cookies_cleared request do
+        request.query_unset_all(*arguments)
+      end
     end
   end
 

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

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

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::Reuse.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/../display")
 require File.expand_path("#{File.dirname __FILE__}/history")
@@ -36,7 +34,7 @@ class HTTY::CLI::Commands::Reuse < HTTY::CLI::Command
   def self.help_extended
     'Copies the properties of a previous request to be used for the request, ' +
     'using the request index number shown in history. Does not communicate '   +
-    "with the endpoint.\n"                                                     +
+    "with the host.\n"                                                         +
     "\n"                                                                       +
     'The argument is an index number that appears when you type '              +
     "#{strong HTTY::CLI::Commands::History.command_line}."
@@ -69,6 +67,9 @@ class HTTY::CLI::Commands::Reuse < HTTY::CLI::Command
     add_request_if_has_response do
       requests[index - 1].send :dup_without_response
     end
+
+    puts notice("Using a copy of request ##{index}")
+    self
   end
 
 end

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

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Commands::SchemeSet.
-
 require File.expand_path("#{File.dirname __FILE__}/../command")
 require File.expand_path("#{File.dirname __FILE__}/address")
 require File.expand_path("#{File.dirname __FILE__}/port_set")
@@ -32,7 +30,7 @@ class HTTY::CLI::Commands::SchemeSet < HTTY::CLI::Command
   # Returns the extended help text for the _scheme-set_ command.
   def self.help_extended
     'Changes the scheme, or protocol identifier, used for the request. Does ' +
-    "not communicate with the endpoint.\n"                                    +
+    "not communicate with the host.\n"                                        +
     "\n"                                                                      +
     "The scheme you supply must be either 'http' or 'https'. Changing the "   +
     "scheme has no effect on the port, and vice versa.\n"                     +
@@ -62,7 +60,9 @@ class HTTY::CLI::Commands::SchemeSet < HTTY::CLI::Command
   # Performs the _scheme-set_ command.
   def perform
     add_request_if_has_response do |request|
-      request.scheme_set(*arguments)
+      self.class.notify_if_cookies_cleared request do
+        request.scheme_set(*arguments)
+      end
     end
   end