htty 1.0.0

data/app/htty/cli/commands/headers_unset_all.rb

@@ -0,0 +1,48 @@
+# 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")
+require File.expand_path("#{File.dirname __FILE__}/headers_unset")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _headers-unset-all_ command.
+class HTTY::CLI::Commands::HeadersUnsetAll < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _headers-unset-all_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the help text for the _headers-unset-all_ command.
+  def self.help
+    'Removes all headers from the request'
+  end
+
+  # 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.'
+  end
+
+  # Returns related command classes for the _headers-unset-all_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HeadersRequest,
+     HTTY::CLI::Commands::HeadersUnset,
+     HTTY::CLI::Commands::HeadersSet]
+  end
+
+  # Performs the _headers-unset-all_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.headers_unset_all(*arguments)
+    end
+  end
+
+end

data/app/htty/cli/commands/help.rb

@@ -0,0 +1,100 @@
+# 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")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _help_ command.
+class HTTY::CLI::Commands::Help < HTTY::CLI::Command
+
+  include HTTY::CLI::Display
+
+  # Returns the arguments for the command-line usage of the _help_ command.
+  def self.command_line_arguments
+    '[command]'
+  end
+
+  # Returns the help text for the _help_ command.
+  def self.help
+    'Displays this help table, or help on the specified command'
+  end
+
+  # Performs the _help_ command.
+  def perform
+    return display_help if arguments.empty?
+
+    unless arguments.length == 1
+      raise ArgumentError,
+            "wrong number of arguments (#{arguments.length} for 1)"
+    end
+
+    display_help_for arguments.first
+  end
+
+private
+
+  def display_help
+    maximum_width = HTTY::CLI::Commands.inject 0 do |max, c|
+      width = c.command_line.length + (c.command_line_arguments || '').length
+      [max, width].max
+    end
+    categories_in_order = ['Navigation',
+                           'Building Requests',
+                           'Issuing Requests',
+                           'Inspecting Responses',
+                           nil]
+    HTTY::CLI::Commands.select do |c|
+      # Filter out commands not yet implemented.
+      c.instance_methods(false).collect(&:to_sym).include?(:perform) ||
+      (c.alias_for &&
+       c.alias_for.instance_methods(false).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
+    end.each do |category, commands|
+      category ||= 'Miscellaneous'
+      puts
+      puts((' ' * ((80 - category.length) / 2)) +
+           strong(format(category, :underlined)))
+      puts
+      commands.each do |c|
+        justification = maximum_width - c.command_line.length + 4
+        puts indent(strong(c.command_line))                      +
+             " #{c.command_line_arguments}".ljust(justification) +
+             word_wrap_indented(c.help, (2 + maximum_width + 4)..80).lstrip
+      end
+    end
+    puts
+    self
+  end
+
+  def display_help_for(argument)
+    if (command = HTTY::CLI::Commands.build_for(argument))
+      c = command.class
+      puts
+      puts indent(strong(c.command_line)) + " #{c.command_line_arguments}"
+      puts
+      puts word_wrap_indented(c.help_extended)
+      unless c.see_also_commands.empty?
+        puts
+        puts indent(strong('See also:'))
+        puts
+        (c.aliases + c.see_also_commands).each do |see_also_command|
+          puts indent("* #{see_also_command.command_line}")
+        end
+      end
+      puts
+      return self
+    end
+    $stderr.puts notice("Can't display help for unrecognized command")
+    puts notice("Try typing #{strong self.class.command_line}")
+    self
+  end
+
+end

data/app/htty/cli/commands/history.rb

@@ -0,0 +1,60 @@
+# 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")
+require File.expand_path("#{File.dirname __FILE__}/reuse")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _history_ command.
+class HTTY::CLI::Commands::History < HTTY::CLI::Command
+
+  include HTTY::CLI::Display
+
+  # Returns the name of a category under which help for the _history_ command
+  # should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the help text for the _history_ command.
+  def self.help
+    'Displays previous request-response activity in this session'
+  end
+
+  # 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.'
+  end
+
+  # Returns related command classes for the _history_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HistoryVerbose, HTTY::CLI::Commands::Reuse]
+  end
+
+  # Performs the _history_ command.
+  def perform
+    requests = session.requests
+    number_width = Math.log10(requests.length).to_i + 1
+    requests.each_with_index do |request, index|
+      next unless request.response
+
+      number = (index + 1).to_s.rjust(number_width)
+      print "#{strong number} "
+      show_request request
+
+      print((' ' * number_width), ' ')
+      show_response request.response
+    end
+  end
+
+end

data/app/htty/cli/commands/history_verbose.rb

@@ -0,0 +1,81 @@
+# 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")
+require File.expand_path("#{File.dirname __FILE__}/../display")
+require File.expand_path("#{File.dirname __FILE__}/history")
+require File.expand_path("#{File.dirname __FILE__}/reuse")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _history-verbose_ command.
+class HTTY::CLI::Commands::HistoryVerbose < HTTY::CLI::Command
+
+  include HTTY::CLI::Display
+
+  # Returns the name of a category under which help for the _history-verbose_
+  # command should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the help text for the _history_ command.
+  def self.help
+    'Displays the details of previous request-response activity in this session'
+  end
+
+  # 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"                  +
+    "\n"                                                                  +
+    'All headers and body content of each request-response pair are shown.'
+  end
+
+  # Returns related command classes for the _history-verbose_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::History, HTTY::CLI::Commands::Reuse]
+  end
+
+  # Performs the _history-verbose_ command.
+  def perform
+    requests = session.requests
+    number_width = Math.log10(requests.length).to_i + 1
+    displayed_one = false
+    requests.each_with_index do |request, index|
+      next unless request.response
+
+      puts(strong('-' * 80)) if displayed_one
+      displayed_one = true
+
+      number = (index + 1).to_s.rjust(number_width)
+      print "#{strong number} "
+      show_request request
+
+      puts unless request.headers.empty?
+      show_headers request.headers, HTTY::Request::COOKIES_HEADER_NAME
+
+      unless request.body.to_s.empty?
+        puts
+        puts request.body
+      end
+
+      puts
+      show_response request.response
+
+      puts unless request.response.headers.empty?
+      show_headers request.response.headers, HTTY::Response::COOKIES_HEADER_NAME
+
+      unless request.response.body.to_s.empty?
+        puts
+        puts request.response.body
+      end
+    end
+  end
+
+end

data/app/htty/cli/commands/host_set.rb

@@ -0,0 +1,59 @@
+# 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
+
+class HTTY::CLI; end
+
+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
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _host-set_ command.
+  def self.command_line_arguments
+    'host'
+  end
+
+  # Returns the help text for the _host-set_ command.
+  def self.help
+    "Changes the host of the request's address"
+  end
+
+  # 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"                                                            +
+    "\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"                                   +
+    "\n"                                                                     +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _host-set_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Address]
+  end
+
+  # Performs the _host-set_ command.
+  def perform
+    add_request_if_has_response do |request|
+      notify_if_cookies_cleared request do
+        request.host_set(*arguments)
+      end
+    end
+  end
+
+end

data/app/htty/cli/commands/http_delete.rb

@@ -0,0 +1,40 @@
+# 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")
+require File.expand_path("#{File.dirname __FILE__}/http_post")
+require File.expand_path("#{File.dirname __FILE__}/http_put")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _http-delete_ command.
+class HTTY::CLI::Commands::HttpDelete < HTTY::CLI::Command
+
+  include HTTY::CLI::HTTPMethodCommand
+
+  # Returns the help text for the _http-delete_ command.
+  def self.help
+    'Issues an HTTP DELETE using the current request'
+  end
+
+  # Returns the extended help text for the _http-delete_ command.
+  def self.help_extended
+    "Issues an HTTP DELETE using the current request.\n"                     +
+    "\n"                                                                     +
+    'Any request body you may set is ignored (i.e., it is not sent as part ' +
+    'of the request).'
+  end
+
+  # Returns related command classes for the _http-delete_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HttpGet,
+     HTTY::CLI::Commands::HttpPost,
+     HTTY::CLI::Commands::HttpPut]
+  end
+
+end

data/app/htty/cli/commands/http_get.rb

@@ -0,0 +1,42 @@
+# 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")
+require File.expand_path("#{File.dirname __FILE__}/http_delete")
+require File.expand_path("#{File.dirname __FILE__}/http_post")
+require File.expand_path("#{File.dirname __FILE__}/http_put")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _http-get_ command.
+class HTTY::CLI::Commands::HttpGet < HTTY::CLI::Command
+
+  include HTTY::CLI::HTTPMethodCommand
+
+  # Returns the help text for the _http-get_ command.
+  def self.help
+    'Issues an HTTP GET using the current request'
+  end
+
+  # Returns the extended help text for the _http-get_ command.
+  def self.help_extended
+    "Issues an HTTP GET using the current request.\n"                        +
+    "\n"                                                                     +
+    'Any request body you may set is ignored (i.e., it is not sent as part ' +
+    'of the request).'
+  end
+
+  # Returns related command classes for the _http-get_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Follow,
+     HTTY::CLI::Commands::HttpPost,
+     HTTY::CLI::Commands::HttpPut,
+     HTTY::CLI::Commands::HttpDelete]
+  end
+
+end

data/app/htty/cli/commands/http_head.rb

@@ -0,0 +1,36 @@
+# 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")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _http-head_ command.
+class HTTY::CLI::Commands::HttpHead < HTTY::CLI::Command
+
+  include HTTY::CLI::HTTPMethodCommand
+
+  # Returns the help text for the _http-head_ command.
+  def self.help
+    'Issues an HTTP HEAD using the current request'
+  end
+
+  # Returns the extended help text for the _http-head_ command.
+  def self.help_extended
+    "Issues an HTTP HEAD using the current request.\n"                        +
+    "\n"                                                                     +
+    'Any request body you may set is ignored (i.e., it is not sent as part ' +
+    'of the request).'
+  end
+
+  # Returns related command classes for the _http-head_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HttpGet]
+  end
+
+end