htty 1.0.0 → 1.1.0

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

@@ -1,5 +1,4 @@
-# Defines HTTY::CLI::Commands::Status.
-
+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__}/body_response")
@@ -29,9 +28,13 @@ class HTTY::CLI::Commands::Status < HTTY::CLI::Command
 
   # 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"                                                             +
+    'Displays the status signal, the number of headers, and size of the body ' +
+    "received in the response. Does not communicate with the host.\n"          +
+    "\n"                                                                       +
+    "If a '#{HTTY::Response::COOKIES_HEADER_NAME}' request header is "         +
+    'present, a bold asterisk (it looks like a cookie) appears next to the '   +
+    "headers summary.\n"                                                       +
+    "\n"                                                                       +
     'Status is displayed automatically when a response is received.'
   end
 

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

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

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

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

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

@@ -1,5 +1,4 @@
-# Defines HTTY::CLI::Commands::UserinfoSet.
-
+require File.expand_path("#{File.dirname __FILE__}/../../request")
 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")
@@ -25,7 +24,7 @@ class HTTY::CLI::Commands::UserinfoSet < HTTY::CLI::Command
   # Returns the arguments for the command-line usage of the _userinfo-set_
   # command.
   def self.command_line_arguments
-    'userinfo'
+    'username [password]'
   end
 
   # Returns the help text for the _userinfo-set_ command.
@@ -35,10 +34,18 @@ class HTTY::CLI::Commands::UserinfoSet < HTTY::CLI::Command
 
   # 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.'
+    'Sets the userinfo used for the request. Does not communicate with the '   +
+    "host.\n"                                                                  +
+    "\n"                                                                       +
+    "Userinfo will be URL-encoded if necessary.\n"                             +
+    "\n"                                                                       +
+    'When userinfo is set, a corresponding '                                   +
+    "'#{HTTY::Request::AUTHORIZATION_HEADER_NAME}' header is set "             +
+    "automatically.\n"                                                         +
+    "\n"                                                                       +
+    'The console prompt shows the address for the current request. Userinfo '  +
+    'appears in normal type while the rest of the address appears in bold to ' +
+    'indicate that userinfo is sent to the host in the form of a header.'
   end
 
   # Returns related command classes for the _userinfo-set_ command.
@@ -49,7 +56,22 @@ class HTTY::CLI::Commands::UserinfoSet < HTTY::CLI::Command
   # Performs the _userinfo-set_ command.
   def perform
     add_request_if_has_response do |request|
-      request.userinfo_set(*escape_or_warn_of_escape_sequences(arguments))
+      arguments = self.arguments
+      if (arguments.length == 1) && (arguments.first.scan(':').length == 1)
+        arguments = arguments.first.split(':')
+      end
+      arguments = escape_mercantile(escape_or_warn_of_escape_sequences(arguments))
+      self.class.notify_if_cookies_cleared request do
+        request.userinfo_set(*arguments)
+      end
+    end
+  end
+
+private
+
+  def escape_mercantile(arguments)
+    arguments.collect do |a|
+      a.gsub '@', '%40'
     end
   end
 

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

@@ -1,5 +1,3 @@
-# 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")
@@ -27,7 +25,7 @@ class HTTY::CLI::Commands::UserinfoUnset < HTTY::CLI::Command
   # 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"                                                       +
+    "the host.\n"                                                           +
     "\n"                                                                    +
     'The console prompt shows the address for the current request.'
   end
@@ -40,7 +38,9 @@ class HTTY::CLI::Commands::UserinfoUnset < HTTY::CLI::Command
   # Performs the _userinfo-unset_ command.
   def perform
     add_request_if_has_response do |request|
-      request.userinfo_unset(*arguments)
+      self.class.notify_if_cookies_cleared request do
+        request.userinfo_unset(*arguments)
+      end
     end
   end
 

data/{app → lib}/htty/cli/display.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::Display.
-
 module HTTY; end
 
 class HTTY::CLI; end
@@ -74,6 +72,21 @@ module HTTY::CLI::Display
     # format string, :foreground_dark_default
   end
 
+  def pluralize(word, number)
+    case number
+      when 0
+        "no #{word}s"
+      when 1
+        "1 #{word}"
+      else
+        "#{number} #{word}s"
+    end
+  end
+
+  def prompt(request)
+    format_request_uri(request.uri) + normal('> ')
+  end
+
   def say(message, style=:normal)
     puts send(style, notice(message))
   end
@@ -91,18 +104,26 @@ module HTTY::CLI::Display
          strong('HTTP TTY') + normal('. Heck To The Yeah!')
   end
 
-  def show_headers(headers, show_asterisk_next_to=nil)
-    asterisk_symbol = nil
+  def show_headers(headers, options={})
+    show_asterisk_next_to   = options[:show_asterisk_next_to]
+    show_mercantile_next_to = options[:show_mercantile_next_to]
+
+    asterisk_symbol, mercantile_symbol = nil, 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
+      asterisk_symbol   ||= (header_name == show_asterisk_next_to)   ? '*' : nil
+      mercantile_symbol ||= (header_name == show_mercantile_next_to) ? '@' : nil
+      asterisk   = (header_name == show_asterisk_next_to)   ? asterisk_symbol   : ''
+      mercantile = (header_name == show_mercantile_next_to) ? mercantile_symbol : ''
+      [(header_name.length + [asterisk.length, mercantile.length].max),
+       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
+      asterisk   = (name == show_asterisk_next_to)   ? asterisk_symbol   : nil
+      mercantile = (name == show_mercantile_next_to) ? mercantile_symbol : nil
+      justified_name = name.rjust margin -
+                       [asterisk.to_s.length, mercantile.to_s.length].max
+      puts "#{justified_name}:#{strong(asterisk || mercantile)} " + value
     end
   end
 
@@ -112,7 +133,7 @@ module HTTY::CLI::Display
     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,
+    puts [format_request_uri(request.uri),
           pluralize('header', request.headers.length) + cookies_asterisk,
           "#{body_size} body"].join(' -- ')
   end
@@ -162,15 +183,15 @@ module HTTY::CLI::Display
 
 private
 
-  def pluralize(word, number)
-    case number
-      when 0
-        "no #{word}s"
-      when 1
-        "1 #{word}"
-      else
-        "#{number} #{word}s"
+  def format_request_uri(uri)
+    if uri.userinfo
+      userinfo_with_at = "#{uri.userinfo}@"
+      before_userinfo, after_userinfo = uri.to_s.split(userinfo_with_at, 2)
+      return strong(before_userinfo)  +
+             normal(userinfo_with_at) +
+             strong(after_userinfo)
     end
+    return strong(uri)
   end
 
   def sentence_case(text)

data/{app → lib}/htty/cli/http_method_command.rb

@@ -1,10 +1,6 @@
-# Defines HTTY::CLI::HTTPMethodCommand.
-
 require File.expand_path("#{File.dirname __FILE__}/../request")
 require File.expand_path("#{File.dirname __FILE__}/display")
 require File.expand_path("#{File.dirname __FILE__}/commands/cookies_use")
-# This 'require' statement leads to an unresolvable circular dependency.
-# require File.expand_path("#{File.dirname __FILE__}/commands/follow")
 
 module HTTY; end
 
@@ -16,8 +12,8 @@ module HTTY::CLI::HTTPMethodCommand
 
   include HTTY::CLI::Display
 
-  # Returns the name of a category under which help for the _http-get_ command
-  # should appear.
+  # Returns the name of a category under which help for the command should
+  # appear.
   def self.category
     'Issuing Requests'
   end
@@ -27,8 +23,8 @@ module HTTY::CLI::HTTPMethodCommand
     add_request_if_has_response do |request|
       request = request.send("#{method}!", *arguments)
       unless body? || request.body.to_s.empty?
-        puts notice("The body of your #{method.upcase} request is not being " +
-                    'sent')
+        puts notice("The body of your #{method.to_s.upcase} request is not " +
+                    'being sent')
       end
       notify_if_cookies
       notify_if_follow

data/{app → lib}/htty/cli/url_escaping.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CLI::UrlEscaping.
-
 require 'uri'
 require File.expand_path("#{File.dirname __FILE__}/display")
 

data/{app → lib}/htty/cookies_util.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::CookiesUtil.
-
 module HTTY; end
 
 # Provides support for marshaling HTTP cookies to and from strings.

data/{app → lib}/htty/no_location_header_error.rb

@@ -1,4 +1,4 @@
-# Defines HTTY::NoLocationHeaderError.
+require File.expand_path("#{File.dirname __FILE__}/response")
 
 module HTTY; end
 
@@ -6,7 +6,8 @@ module HTTY; end
 class HTTY::NoLocationHeaderError < StandardError
 
   def initialize
-    super "response does not have a 'Location' header"
+    super 'response does not have a ' +
+          "'#{HTTY::Response::LOCATION_HEADER_NAME}' header"
   end
 
 end

data/{app → lib}/htty/no_response_error.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::NoResponseError.
-
 module HTTY; end
 
 # Indicates that HTTY::Request#response was missing.

data/{app → lib}/htty/no_set_cookie_header_error.rb

@@ -1,4 +1,4 @@
-# Defines HTTY::NoSetCookieHeaderError.
+require File.expand_path("#{File.dirname __FILE__}/response")
 
 module HTTY; end
 
@@ -7,7 +7,8 @@ module HTTY; end
 class HTTY::NoSetCookieHeaderError < StandardError
 
   def initialize
-    super "response does not have a 'Set-Cookie' header"
+    super "response does not have a '#{HTTY::Response::COOKIES_HEADER_NAME}' " +
+          'header'
   end
 
 end

data/{app → lib}/htty/ordered_hash.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::OrderedHash.
-
 module HTTY; end
 
 # Represents a Hash that preserves the insertion order of values. This class
@@ -17,7 +15,8 @@ class HTTY::OrderedHash
     end
   end
 
-  def initialize_copy(source) #:nodoc:
+  # @private
+  def initialize_copy(source)
     super
     @inner_hash = @inner_hash.dup
     @inner_keys = @inner_keys.dup

data/{app → lib}/htty/payload.rb

@@ -1,5 +1,3 @@
-# Defines HTTY::Payload.
-
 require File.expand_path("#{File.dirname __FILE__}/ordered_hash")
 
 module HTTY; end
@@ -39,7 +37,8 @@ protected
     end
   end
 
-  def initialize_copy(source) #:nodoc:
+  # @private
+  def initialize_copy(source)
     super
     @body    = @body.dup if @body
     @headers = @headers.dup

data/{app → lib}/htty/request.rb

@@ -1,5 +1,4 @@
-# Defines HTTY::Request.
-
+require 'base64'
 require 'pathname'
 require 'uri'
 require File.expand_path("#{File.dirname __FILE__}/../htty")
@@ -16,7 +15,8 @@ module HTTY; end
 # Encapsulates an HTTP(S) request.
 class HTTY::Request < HTTY::Payload
 
-  COOKIES_HEADER_NAME = 'Cookie'
+  AUTHORIZATION_HEADER_NAME = 'Authorization'
+  COOKIES_HEADER_NAME       = 'Cookie'
 
   METHODS_SENDING_BODY = [:post, :put]
 
@@ -65,9 +65,6 @@ class HTTY::Request < HTTY::Payload
     authority               = build_authority(components)
     path_query_and_fragment = build_path_query_and_fragment(components)
     path_query_and_fragment ||= '/' if authority
-    unless scheme == 'http://'
-      raise ArgumentError, "#{scheme.inspect} is not yet supported"
-    end
     URI.parse([scheme, authority, path_query_and_fragment].join)
   end
 
@@ -110,10 +107,13 @@ class HTTY::Request < HTTY::Payload
 
 protected
 
-  def self.clear_cookies_if_host_changes(request)
+  def self.set_up_cookies_and_authentication(request)
     previous_host = request.uri.host
     yield
     request.cookies_remove_all unless request.uri.host == previous_host
+
+    request.send :establish_basic_authentication
+
     request
   end
 
@@ -133,10 +133,12 @@ public
   def initialize(address)
     super({:headers => [['User-Agent', "htty/#{HTTY::VERSION}"]]})
     @uri = self.class.parse_uri(address)
+    establish_basic_authentication
     establish_content_length
   end
 
-  def initialize_copy(source) #:nodoc:
+  # @private
+  def initialize_copy(source)
     super
     @response = @response.dup if @response
     @uri      = @uri.dup
@@ -157,12 +159,12 @@ public
     uri = self.class.parse_uri(address)
     if response
       dup = dup_without_response
-      return self.class.clear_cookies_if_host_changes(dup) do
+      return self.class.send(:set_up_cookies_and_authentication, dup) do
         dup.uri = uri
       end
     end
 
-    self.class.clear_cookies_if_host_changes self do
+    self.class.send(:set_up_cookies_and_authentication, self) do
       @uri = uri
     end
   end
@@ -263,7 +265,7 @@ public
     raise HTTY::NoResponseError unless response
 
     location_header = response.headers.detect do |name, value|
-      name == 'Location'
+      name == HTTY::Response::LOCATION_HEADER_NAME
     end
     unless location_header && location_header.last
       raise HTTY::NoLocationHeaderError
@@ -411,7 +413,8 @@ public
   end
 
   # Establishes a new #uri with the specified _userinfo_.
-  def userinfo_set(userinfo)
+  def userinfo_set(username, password=nil)
+    userinfo = [username, password].compact.join(':')
     rebuild_uri :userinfo => userinfo
   end
 
@@ -429,8 +432,11 @@ protected
     request
   end
 
-  def establish_content_length
-    header_set 'Content-Length', body.to_s.length
+  def establish_basic_authentication
+    value = uri.userinfo                                                 ?
+            "Basic #{Base64.encode64(URI.unescape(uri.userinfo)).chomp}" :
+            nil
+    header_set AUTHORIZATION_HEADER_NAME, value
   end
 
   def path_query_and_fragment
@@ -445,7 +451,7 @@ protected
     components = URI::HTTP::COMPONENT.inject({}) do |result, c|
       result.merge c => uri.send(c)
     end
-    self.class.clear_cookies_if_host_changes self do
+    self.class.send(:set_up_cookies_and_authentication, self) do
       @uri = self.class.build_uri(components.merge(changed_components))
     end
   end
@@ -462,6 +468,10 @@ private
                                :port     => uri.port
   end
 
+  def establish_content_length
+    header_set 'Content-Length', body.to_s.length
+  end
+
   def request!(method)
     request = response ? dup_without_response : self
     request.instance_variable_set '@request_method', method