htty 1.0.0

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

@@ -0,0 +1,24 @@
+# Defines HTTY::CLI::Commands::Quit.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _quit_ command.
+class HTTY::CLI::Commands::Quit < HTTY::CLI::Command
+
+  # Returns the help text for the _quit_ command.
+  def self.help
+    'Quits htty'
+  end
+
+  # Performs the _quit_ command.
+  def perform
+    throw :quit
+  end
+
+end

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

@@ -0,0 +1,74 @@
+# 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")
+require File.expand_path("#{File.dirname __FILE__}/history_verbose")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _reuse_ command.
+class HTTY::CLI::Commands::Reuse < HTTY::CLI::Command
+
+  include HTTY::CLI::Display
+
+  # Returns the name of a category under which help for the _reuse_ command
+  # should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _reuse_ command.
+  def self.command_line_arguments
+    'index'
+  end
+
+  # Returns the help text for the _reuse_ command.
+  def self.help
+    'Copies a previous request by the index number shown in history'
+  end
+
+  # Returns the extended help text for the _reuse_ 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"                                                     +
+    "\n"                                                                       +
+    'The argument is an index number that appears when you type '              +
+    "#{strong HTTY::CLI::Commands::History.command_line}."
+  end
+
+  # Returns related command classes for the _reuse_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::History, HTTY::CLI::Commands::HistoryVerbose]
+  end
+
+  # Performs the _reuse_ command.
+  def perform
+    unless arguments.length == 1
+      raise ArgumentError,
+            "wrong number of arguments (#{arguments.length} for 1)"
+    end
+
+    requests = session.requests
+    requests_with_responses = requests.select do |r|
+      r.response
+    end
+    raise 'no requests in history' if requests_with_responses.empty?
+
+    index = arguments.first.to_i
+    unless (1..requests_with_responses.length).include?(index)
+      raise ArgumentError,
+            "index must be between 1 and #{requests_with_responses.length}"
+    end
+
+    add_request_if_has_response do
+      requests[index - 1].send :dup_without_response
+    end
+  end
+
+end

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

@@ -0,0 +1,69 @@
+# 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")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _scheme-set_ command.
+class HTTY::CLI::Commands::SchemeSet < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _scheme-set_ command
+  # should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _scheme-set_ command.
+  def self.command_line_arguments
+    'scheme'
+  end
+
+  # Returns the help text for the _scheme-set_ command.
+  def self.help
+    "Changes the scheme (protocol identifier) of the request's address"
+  end
+
+  # 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"                                    +
+    "\n"                                                                      +
+    "The scheme you supply must be either 'http' or 'https'. Changing the "   +
+    "scheme has no effect on the port, and vice versa.\n"                     +
+    "\n"                                                                      +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _scheme-set_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Address, HTTY::CLI::Commands::PortSet]
+  end
+
+  # Initializes a new HTTY::CLI::SchemeSet with attribute values specified in
+  # the _attributes_ hash.
+  #
+  # Valid _attributes_ keys include:
+  #
+  # * <tt>:arguments</tt>
+  # * <tt>:session</tt>
+  def initialize(attributes={})
+    super attributes
+    @arguments.collect! do |a|
+      a.gsub(/:\/\/$/, '')
+    end
+  end
+
+  # Performs the _scheme-set_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.scheme_set(*arguments)
+    end
+  end
+
+end

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

@@ -0,0 +1,52 @@
+# Defines HTTY::CLI::Commands::Status.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../display")
+require File.expand_path("#{File.dirname __FILE__}/body_response")
+require File.expand_path("#{File.dirname __FILE__}/headers_response")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _status_ command.
+class HTTY::CLI::Commands::Status < HTTY::CLI::Command
+
+  include HTTY::CLI::Display
+
+  # Returns the name of a category under which help for the _status_ command
+  # should appear.
+  def self.category
+    'Inspecting Responses'
+  end
+
+  # Returns the help text for the _status_ command.
+  def self.help
+    'Displays the status of the response'
+  end
+
+  # Returns the extended help text for the _status_ command.
+  def self.help_extended
+    'Displays the status signal received in the response. Does not ' +
+    "communicate with the endpoint.\n"                               +
+    "\n"                                                             +
+    'Status is displayed automatically when a response is received.'
+  end
+
+  # Returns related command classes for the _status_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::BodyResponse, HTTY::CLI::Commands::HeadersResponse]
+  end
+
+  # Performs the _status_ command.
+  def perform
+    unless (response = session.last_response)
+      raise HTTY::NoResponseError
+    end
+    show_response response
+    self
+  end
+
+end

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

@@ -0,0 +1,13 @@
+# Defines HTTY::CLI::Commands::Undo.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _undo_ command.
+class HTTY::CLI::Commands::Undo < HTTY::CLI::Command
+end

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

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

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

@@ -0,0 +1,56 @@
+# Defines HTTY::CLI::Commands::UserinfoSet.
+
+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__}/userinfo_unset")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _userinfo-set_ command.
+class HTTY::CLI::Commands::UserinfoSet < HTTY::CLI::Command
+
+  include HTTY::CLI::UrlEscaping
+
+  # Returns the name of a category under which help for the _userinfo-set_
+  # command should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _userinfo-set_
+  # command.
+  def self.command_line_arguments
+    'userinfo'
+  end
+
+  # Returns the help text for the _userinfo-set_ command.
+  def self.help
+    "Sets the userinfo of the request's address"
+  end
+
+  # Returns the extended help text for the _userinfo-set_ command.
+  def self.help_extended
+    'Sets the userinfo used for the request. Does not communicate with the ' +
+    "endpoint.\n"                                                            +
+    "\n"                                                                     +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _userinfo-set_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::UserinfoUnset, HTTY::CLI::Commands::Address]
+  end
+
+  # Performs the _userinfo-set_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.userinfo_set(*escape_or_warn_of_escape_sequences(arguments))
+    end
+  end
+
+end

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

@@ -0,0 +1,47 @@
+# Defines HTTY::CLI::Commands::UserinfoUnset.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/address")
+require File.expand_path("#{File.dirname __FILE__}/userinfo_set")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _userinfo-unset_ command.
+class HTTY::CLI::Commands::UserinfoUnset < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _userinfo-unset_
+  # command should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the help text for the _userinfo-unset_ command.
+  def self.help
+    "Removes the userinfo from the request's address"
+  end
+
+  # Returns the extended help text for the _userinfo-unset_ command.
+  def self.help_extended
+    'Removes the userinfo used for the request. Does not communicate with ' +
+    "the endpoint.\n"                                                       +
+    "\n"                                                                    +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _userinfo-unset_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::UserinfoSet, HTTY::CLI::Commands::Address]
+  end
+
+  # Performs the _userinfo-unset_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.userinfo_unset(*arguments)
+    end
+  end
+
+end

data/app/htty/cli/cookie_clearing_command.rb

@@ -0,0 +1,26 @@
+# Defines HTTY::CLI::CookieClearingCommand.
+
+require File.expand_path("#{File.dirname __FILE__}/display")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+# Encapsulates behavior common to all HTTY::CLI::Command subclasses that can
+# result in cookies being cleared automatically.
+module HTTY::CLI::CookieClearingCommand
+
+  include HTTY::CLI::Display
+
+protected
+
+  def notify_if_cookies_cleared(request)
+    had_cookies = !request.cookies.empty?
+    new_request = yield
+    if (had_cookies && new_request.cookies.empty?)
+      puts notice('Cookies cleared')
+    end
+    new_request
+  end
+
+end

data/app/htty/cli/display.rb

@@ -0,0 +1,182 @@
+# Defines HTTY::CLI::Display.
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+# Encapsulates the display logic of _htty_'s command-line interface.
+module HTTY::CLI::Display
+
+  FORMATS = {:bold                    => '1',
+             :underlined              => '4',
+             :blinking                => '5',
+             :inverse                 => '7',
+             :foreground_black        => '30',
+             :foreground_dark_red     => '31',
+             :foreground_dark_green   => '32',
+             :foreground_dark_yellow  => '33',
+             :foreground_dark_blue    => '34',
+             :foreground_dark_magenta => '35',
+             :foreground_dark_cyan    => '36',
+             :foreground_light_gray   => '37',
+             :foreground_dark_default => '39',
+             :foreground_dark_gray    => '1;30',
+             :foreground_red          => '1;31',
+             :foreground_green        => '1;32',
+             :foreground_yellow       => '1;33',
+             :foreground_blue         => '1;34',
+             :foreground_magenta      => '1;35',
+             :foreground_cyan         => '1;36',
+             :foreground_white        => '1;37',
+             :foreground_default      => '1;39',
+             :background_black        => '40',
+             :background_dark_red     => '41',
+             :background_dark_green   => '42',
+             :background_dark_yellow  => '43',
+             :background_dark_blue    => '44',
+             :background_dark_magenta => '45',
+             :background_dark_cyan    => '46',
+             :background_light_gray   => '47',
+             :background_default      => '49'}
+
+  def format(string, *attributes)
+    segments = attributes.collect do |a|
+      "\x1b[#{FORMATS[a]}m"
+    end
+    segments << string
+    segments << "\x1b[0m"
+    segments.join ''
+  end
+
+  def rescuing_from(*exception_classes)
+    yield
+  rescue Interrupt
+    nil
+  rescue *exception_classes => e
+    $stderr.puts notice(sentence_case(e.message))
+    nil
+  end
+
+  def indent(string, column=2)
+    "#{' ' * column}#{string}"
+  end
+
+  def logotype
+    format ' htty ', :bold, :background_dark_red, :foreground_yellow
+  end
+
+  def notice(string)
+    "*** #{string}"
+  end
+
+  def normal(string)
+    return string
+    # format string, :foreground_dark_default
+  end
+
+  def say(message, style=:normal)
+    puts send(style, notice(message))
+  end
+
+  def say_goodbye
+    say 'Happy Trails To You!'
+  end
+
+  def say_header(message, style=:normal)
+    puts send(style, notice('')) + highlight(messag)
+  end
+
+  def say_hello
+    puts normal(notice('Welcome to ')) + logotype + normal(', the ') +
+         strong('HTTP TTY') + normal('. Heck To The Yeah!')
+  end
+
+  def show_headers(headers, show_asterisk_next_to=nil)
+    asterisk_symbol = nil
+    margin = headers.inject 0 do |result, header|
+      header_name = header.first
+      asterisk_symbol ||= (header_name == show_asterisk_next_to) ? '*' : nil
+      asterisk = (header_name == show_asterisk_next_to) ? asterisk_symbol : ''
+      [(header_name.length + asterisk.length), result].max
+    end
+    headers.each do |name, value|
+      asterisk = (name == show_asterisk_next_to) ? asterisk_symbol : nil
+      puts "#{name.rjust margin - asterisk.to_s.length}:#{strong asterisk} " +
+           value
+    end
+  end
+
+  def show_request(request)
+    method = format(" #{request.request_method.to_s.upcase} ", :inverse)
+    print "#{method} "
+    cookies_asterisk = request.cookies.empty? ? '' : strong('*')
+    body_length = request.body.to_s.length
+    body_size   = body_length.zero? ? 'empty' : "#{body_length}-character"
+    puts [request.uri,
+          pluralize('header', request.headers.length) + cookies_asterisk,
+          "#{body_size} body"].join(' -- ')
+  end
+
+  def show_response(response)
+    code, description = response.status
+    case code.to_i
+      when 100...200, 300...400
+        print format(" #{code} ", :background_dark_blue, :foreground_white)
+      when 200...300
+        print format(" #{code} ", :background_dark_green, :foreground_black)
+      when 500...600
+        print format(" #{code} ", :inverse, :blinking,
+                                  :background_black, :foreground_yellow)
+      else
+        print format(" #{code} ", :background_dark_red, :foreground_white)
+    end
+    print ' '
+    cookies_asterisk = response.cookies.empty? ? '' : strong('*')
+    body_length = response.body.to_s.length
+    body_size   = body_length.zero? ? 'empty' : "#{body_length}-character"
+    puts([description,
+          pluralize('header', response.headers.length) + cookies_asterisk,
+          "#{body_size} body"].join(' -- '))
+  end
+
+  def strong(string)
+    format string, :bold
+  end
+
+  def word_wrap(text, column=nil)
+    word_wrap_indented(text, (0..(column || 80)))
+  end
+
+  # Adapted from
+  # http://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#M002281
+  def word_wrap_indented(text, columns=2..80)
+    indent_by, wrap_at = columns.min, columns.max - columns.min
+    text.split("\n").collect do |line|
+      (wrap_at < line.length)                              ?
+      line.gsub(/(.{1,#{wrap_at}})(\s+|$)/, "\\1\n").strip :
+      line
+    end.join("\n").split("\n").collect do |line|
+      indent line, indent_by
+    end.join "\n"
+  end
+
+private
+
+  def pluralize(word, number)
+    case number
+      when 0
+        "no #{word}s"
+      when 1
+        "1 #{word}"
+      else
+        "#{number} #{word}s"
+    end
+  end
+
+  def sentence_case(text)
+    text.gsub(/^./) do |letter|
+      letter.upcase
+    end
+  end
+
+end