htty 1.0.0

data/app/htty/cli/commands.rb

@@ -0,0 +1,43 @@
+# Loads constants defined within HTTY::CLI::Commands.
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+# Contains classes that implement commands in the user interface.
+module HTTY::CLI::Commands
+
+  extend Enumerable
+
+  # Returns a HTTY::CLI::Command descendant whose command line representation
+  # matches the specified _command_line_. If an _attributes_ hash is specified,
+  # it is used to initialize the command.
+  def self.build_for(command_line, attributes={})
+    each do |klass|
+      if (command = klass.build_for(command_line, attributes))
+        return command
+      end
+    end
+    nil
+  end
+
+  # Yields each HTTY::CLI::Command descendant in turn.
+  def self.each
+    Dir.glob "#{File.dirname __FILE__}/commands/*.rb" do |f|
+      class_name = File.basename(f, '.rb').gsub(/^(.)/) do |initial|
+        initial.upcase
+      end.gsub(/_(\S)/) do |initial|
+        initial.gsub(/_/, '').upcase
+      end
+      klass = const_get(class_name) rescue nil
+      yield klass if klass
+    end
+    self
+  end
+
+end
+
+Dir.glob "#{File.dirname __FILE__}/commands/*.rb" do |f|
+  require File.expand_path("#{File.dirname __FILE__}/commands/" +
+                           File.basename(f, '.rb'))
+end

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

@@ -0,0 +1,84 @@
+# Defines HTTY::CLI::Commands::Address.
+
+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__}/port_set")
+require File.expand_path("#{File.dirname __FILE__}/scheme_set")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _address_ command.
+class HTTY::CLI::Commands::Address < HTTY::CLI::Command
+
+  include HTTY::CLI::CookieClearingCommand
+
+  # Returns the name of a category under which help for the _address_ command
+  # should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _address_ command.
+  def self.command_line_arguments
+    'address'
+  end
+
+  # Returns the help text for the _address_ command.
+  def self.help
+    'Changes the address of the request'
+  end
+
+  # Returns the extended help text for the _address_ command.
+  def self.help_extended
+    'Changes the address used for the request. Does not communicate with the ' +
+    "endpoint.\n"                                                              +
+    "\n"                                                                       +
+    'The URL you supply can be partial. At a minimum, you must specify a '     +
+    'host. The optional and required elements of an address are illustrated '  +
+    "below:\n"                                                                 +
+    "\n"                                                                       +
+    "https://steve:woodside@apple.com:6666/store?q=ipad#sold-to-date\n"        +
+    "\\______/\\_____________/\\_______/\\___/\\____/\\_____/\\___________/\n" +
+    "   1.          2.          3.     4.   5.     6.        7.\n"             +
+    "\n"                                                                       +
+    "1. A scheme, or protocol identifier (i.e., 'http://' or 'https://' -- "   +
+    "optional)\n"                                                              +
+    "2. Userinfo (e.g., 'username:password@' -- optional)\n"                   +
+    "3. A host (i.e., a hostname or IP address -- required)\n"                 +
+    "4. A TCP port number (i.e., ':0' through ':65535' -- optional)\n"         +
+    "5. A path (optional)\n"                                                   +
+    "6. A query string (e.g., '?foo=bar&baz=qux' -- optional)\n"               +
+    "7. A fragment (e.g., '#fragment-name' -- optional)\n"                     +
+    "\n"                                                                       +
+    'If (1) is omitted, HTTP is used, except if (4) is specified as port '     +
+    "443, in which case HTTPS is used.\n"                                      +
+    "\n"                                                                       +
+    "If (3) is omitted, host 0.0.0.0 is used.\n"                               +
+    "\n"                                                                       +
+    'If (4) is omitted, port 80 is used, except if (1) is specified as '       +
+    "HTTPS, in which case port 443 is used.\n"                                 +
+    "\n"                                                                       +
+    "If (5) is omitted, the root path (i.e., \"/\") is used.\n"                +
+    "\n"                                                                       +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _address_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::SchemeSet, HTTY::CLI::Commands::PortSet]
+  end
+
+  # Performs the _address_ command.
+  def perform
+    add_request_if_has_response do |request|
+      notify_if_cookies_cleared request do
+        request.address(*arguments)
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,20 @@
+# Defines HTTY::CLI::Commands::BodyClear.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/body_unset")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _body-clear_ command.
+class HTTY::CLI::Commands::BodyClear < HTTY::CLI::Command
+
+  # Returns the command that the _body-clear_ command is an alias for.
+  def self.alias_for
+    HTTY::CLI::Commands::BodyUnset
+  end
+
+end

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

@@ -0,0 +1,51 @@
+# Defines HTTY::CLI::Commands::BodyRequest.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/body_response")
+require File.expand_path("#{File.dirname __FILE__}/body_set")
+require File.expand_path("#{File.dirname __FILE__}/body_unset")
+require File.expand_path("#{File.dirname __FILE__}/headers_request")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _body-request_ command.
+class HTTY::CLI::Commands::BodyRequest < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _body-request_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the help text for the _body-request_ command.
+  def self.help
+    'Displays the body of the request'
+  end
+
+  # Returns the extended help text for the _body-request_ command.
+  def self.help_extended
+    'Displays the body content used for the request. Does not communicate ' +
+    'with the endpoint.'
+  end
+
+  # Returns related command classes for the _body-request_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::BodySet,
+     HTTY::CLI::Commands::BodyUnset,
+     HTTY::CLI::Commands::HeadersRequest,
+     HTTY::CLI::Commands::BodyResponse]
+  end
+
+  # Performs the _body-request_ command.
+  def perform
+    if (body = session.requests.last.body)
+      puts body unless body.empty?
+    end
+    self
+  end
+
+end

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

@@ -0,0 +1,59 @@
+# 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")
+require File.expand_path("#{File.dirname __FILE__}/headers_response")
+require File.expand_path("#{File.dirname __FILE__}/status")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _body-response_ command.
+class HTTY::CLI::Commands::BodyResponse < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _body_ command
+  # should appear.
+  def self.category
+    'Inspecting Responses'
+  end
+
+  # Returns the string used to invoke the _body-response_ command from the
+  # command line.
+  def self.command_line
+    'body[-response]'
+  end
+
+  # Returns the help text for the _body-response_ command.
+  def self.help
+    'Displays the body of the response'
+  end
+
+  # 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.'
+  end
+
+  # Returns related command classes for the _body-response_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HeadersResponse,
+     HTTY::CLI::Commands::Status,
+     HTTY::CLI::Commands::BodyRequest]
+  end
+
+  # Performs the _body-response_ command.
+  def perform
+    unless (response = session.last_response)
+      raise HTTY::NoResponseError
+    end
+    unless (body = response.body).strip.empty?
+      puts body
+    end
+    self
+  end
+
+end

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

@@ -0,0 +1,58 @@
+# Defines HTTY::CLI::Commands::BodySet.
+
+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_unset")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _body-set_ command.
+class HTTY::CLI::Commands::BodySet < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _body-set_ command
+  # should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the help text for the _body-set_ command.
+  def self.help
+    'Sets the body of the request'
+  end
+
+  # 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"                                                        +
+    "\n"                                                                     +
+    'Hit Return three times in a row to signify the end of the body.'
+  end
+
+  # Returns related command classes for the _body-set_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::BodyRequest, HTTY::CLI::Commands::BodyUnset]
+  end
+
+  # Performs the _body-set_ command.
+  def perform
+    add_request_if_has_response do |request|
+      lines            = []
+      empty_line_count = 0
+      while empty_line_count < 2 do
+        lines << $stdin.gets.chomp
+        empty_line_count = lines.last.empty? ? (empty_line_count + 1) : 0
+      end
+      request.body_set lines.join("\n").gsub(/[\r\n]+$/, '')
+      body = lines.join("\n")
+      while body.chomp != body
+        body.chomp!
+      end
+      request.body_set body
+    end
+  end
+
+end

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

@@ -0,0 +1,45 @@
+# 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")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _body-unset_ command.
+class HTTY::CLI::Commands::BodyUnset < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _body-unset_ command
+  # should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the help text for the _body-unset_ command.
+  def self.help
+    'Clears the body of the request'
+  end
+
+  # 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.'
+  end
+
+  # Returns related command classes for the _body-unset_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::BodyRequest, HTTY::CLI::Commands::BodySet]
+  end
+
+  # Performs the _body-unset_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.body_unset
+    end
+  end
+
+end

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

@@ -0,0 +1,20 @@
+# Defines HTTY::CLI::Commands::Cd.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/path_set")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _cd_ command.
+class HTTY::CLI::Commands::Cd < HTTY::CLI::Command
+
+  # Returns the command that the _cd_ command is an alias for.
+  def self.alias_for
+    HTTY::CLI::Commands::PathSet
+  end
+
+end

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

@@ -0,0 +1,20 @@
+# Defines HTTY::CLI::Commands::CookieAdd.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/cookies_add")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _cookie-add_ command.
+class HTTY::CLI::Commands::CookieAdd < HTTY::CLI::Command
+
+  # Returns the command that the _cookie-add_ command is an alias for.
+  def self.alias_for
+    HTTY::CLI::Commands::CookiesAdd
+  end
+
+end

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

@@ -0,0 +1,20 @@
+# Defines HTTY::CLI::Commands::CookieRemove.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/cookies_remove")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _cookie-remove_ command.
+class HTTY::CLI::Commands::CookieRemove < HTTY::CLI::Command
+
+  # Returns the command that the _cookie-remove_ command is an alias for.
+  def self.alias_for
+    HTTY::CLI::Commands::CookiesRemove
+  end
+
+end

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

@@ -0,0 +1,68 @@
+# Defines HTTY::CLI::Commands::Cookies.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+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")
+require File.expand_path("#{File.dirname __FILE__}/cookies_use")
+require File.expand_path("#{File.dirname __FILE__}/headers_request")
+require File.expand_path("#{File.dirname __FILE__}/headers_response")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _cookies_ command.
+class HTTY::CLI::Commands::Cookies < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _cookies_ command
+  # should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the help text for the _cookies_ command.
+  def self.help
+    'Displays the cookies of the request'
+  end
+
+  # 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"                                                         +
+    "\n"                                                                      +
+    "This command displays cookies extracted from the request's 'Cookie' "    +
+    "header, which is nevertheless shown when you type 'headers-request'.\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 cleared automatically when you change hosts.'
+  end
+
+  # Returns related command classes for the _cookies_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::CookiesAdd,
+     HTTY::CLI::Commands::CookiesRemove,
+     HTTY::CLI::Commands::CookiesRemoveAll,
+     HTTY::CLI::Commands::CookiesUse,
+     HTTY::CLI::Commands::HeadersRequest,
+     HTTY::CLI::Commands::HeadersResponse]
+  end
+
+  # Performs the _cookies_ command.
+  def perform
+    cookies = session.requests.last.cookies
+    margin = cookies.inject 0 do |result, cookie|
+      [cookie.first.length, result].max
+    end
+    cookies.each do |name, value|
+      puts "#{name.rjust margin}: #{value}"
+    end
+    self
+  end
+
+end