htty 1.4.1 → 1.5.0

data/lib/htty/cli/command.rb

@@ -27,18 +27,18 @@ class HTTY::CLI::Command
   def self.build_for(command_line, attributes={})
     command_line_regexp = make_command_line_regexp
     if (match = (command_line_regexp.match(command_line)))
-      all_attributes = attributes
-      if (arguments = match.captures[0])
-        begin
-          split_arguments = arguments.strip.shellsplit
-        rescue ArgumentError
-          return :unclosed_quote
+      begin
+        if (arguments = match.captures[0])
+          attributes = attributes.merge(
+            :arguments => sanitize_arguments(arguments.strip.shellsplit)
+          )
         end
-        return new(attributes.merge(:arguments => split_arguments))
+      rescue ArgumentError
+        :unclosed_quote
+      else
+        new(attributes)
       end
-      return new(attributes)
     end
-    nil
   end
 
   # Returns the name of a category under which help for the command should
@@ -114,14 +114,19 @@ class HTTY::CLI::Command
     Array(alias_for)
   end
 
+  # Escape, split, chop, ... arguments before they are used to build the
+  # command
+  def self.sanitize_arguments(arguments)
+    arguments
+  end
+
 protected
 
   # Displays a notice if cookies are cleared on the specified _request_ in the
   # course of the block.
   def self.notify_if_cookies_cleared(request)
-    had_cookies = cookies?(request)
     changed_request = yield
-    puts notice('Cookies cleared') if had_cookies && !cookies?(changed_request)
+    puts notice('Cookies cleared') if request.cookies? && !changed_request.cookies?
     changed_request
   end
 
@@ -140,10 +145,6 @@ private
     "(?:#{text[0...char_length]}#{rest})?"
   end
 
-  def self.cookies?(request)
-    !request.cookies.empty?
-  end
-
   def self.make_command_line_regexp
     pattern = Regexp.escape(command_line).gsub(/\\\[(.+)\\\]/) do |optional|
       completion_optional($1)
@@ -203,11 +204,11 @@ protected
   # Yields the last request in #session. If the block returns a different
   # request, it is added to the requests of #session.
   def add_request_if_new
-    requests     = session.requests
-    last_request = requests.last
-    unless (new_request = yield(last_request)).equal?(last_request)
-      requests << new_request
-    end
+    last_request = session.requests.last
+    maybe_next_request = yield(last_request)
+    session.requests << maybe_next_request unless (
+      maybe_next_request.nil? or maybe_next_request.equal?(last_request)
+    )
     self
   end
 

data/lib/htty/cli/commands/body_edit.rb

@@ -0,0 +1,89 @@
+require 'tempfile'
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../display")
+require File.expand_path("#{File.dirname __FILE__}/body_request")
+require File.expand_path("#{File.dirname __FILE__}/body_unset")
+require File.expand_path("#{File.dirname __FILE__}/body_set")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _body-edit_ command.
+class HTTY::CLI::Commands::BodyEdit < HTTY::CLI::Command
+
+  include HTTY::CLI::Display
+
+  # Returns the name of a category under which help for the _body-edit_ command
+  # should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the help text for the _body-edit_ command.
+  def self.help
+    'Sets the body of the request using a text editor'
+  end
+
+  # Returns the extended help text for the _body-edit_ command.
+  def self.help_extended
+    <<-EOH.gsub(/^(?: |\t)+/, '')
+    Sets the body content used for the request. Does not communicate with
+    the host.
+
+    Uses the editor specified in EDITOR environment variable. Your editor will
+    open with a temporary file, fill the file with the request body. When you
+    are done save the file and quit the editor. The exact content of the
+    temporary file will be used as the request body. The temporary file will be
+    removed after this command.
+
+    If you want to choose your editor, start htty with `EDITOR=vim htty`
+    replacing 'vim' with your editor of choice.
+    EOH
+  end
+
+  # Returns related command classes for the _body-edit_ command.
+  def self.see_also_commands
+    [ HTTY::CLI::Commands::BodyRequest,
+      HTTY::CLI::Commands::BodyUnset,
+      HTTY::CLI::Commands::BodySet
+    ]
+  end
+
+  # Performs the _body-edit_ command.
+  def perform
+    add_request_if_new do |request|
+      request.body_set(with_editor do |editor|
+        file = Tempfile.new('htty')
+        if last_request_body = session.requests.last.body
+          File.open(file.path, 'w+') {|f| f.write(last_request_body)}
+        end
+        result = system(editor + ' ' + file.path)
+        if not result
+          return empty_body_because("Unable to use '#{editor}' to edit request's body")
+        end
+        body = File.read(file.path)
+        file.unlink
+        body
+      end)
+    end
+  end
+
+  private
+
+  def with_editor
+    editor = ENV['EDITOR']
+    if editor.nil? || editor.empty?
+      return empty_body_because('EDITOR environment variable is not set.')
+    end
+    yield editor
+  end
+
+  def empty_body_because(reason)
+    puts notice(reason)
+    puts notice("See 'help body-edit' for further informations.")
+    empty_body = ''
+  end
+end

data/lib/htty/cli/commands/query_add.rb

@@ -60,6 +60,9 @@ class HTTY::CLI::Commands::QueryAdd < HTTY::CLI::Command
 
   # Performs the _query-add_ command.
   def perform
+    if arguments.empty?
+      raise ArgumentError, 'wrong number of arguments (0 for N)'
+    end
     add_request_if_new do |request|
       self.class.notify_if_cookies_cleared request do
         escaped_arguments = escape_or_warn_of_escape_sequences(arguments)

data/lib/htty/cli/commands/query_set.rb

@@ -60,6 +60,9 @@ class HTTY::CLI::Commands::QuerySet < HTTY::CLI::Command
 
   # Performs the _query-set_ command.
   def perform
+    if arguments.empty?
+      raise ArgumentError, 'wrong number of arguments (0 for N)'
+    end
     add_request_if_new do |request|
       self.class.notify_if_cookies_cleared request do
         escaped_arguments = escape_or_warn_of_escape_sequences(arguments)

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

@@ -13,7 +13,7 @@ module HTTY::CLI::Commands; end
 # Encapsulates the _userinfo-set_ command.
 class HTTY::CLI::Commands::UserinfoSet < HTTY::CLI::Command
 
-  include HTTY::CLI::UrlEscaping
+  extend HTTY::CLI::UrlEscaping
 
   # Returns the name of a category under which help for the _userinfo-set_
   # command should appear.
@@ -53,26 +53,20 @@ class HTTY::CLI::Commands::UserinfoSet < HTTY::CLI::Command
     [HTTY::CLI::Commands::UserinfoUnset, HTTY::CLI::Commands::Address]
   end
 
+  def self.sanitize_arguments(arguments)
+    if (arguments.length == 1) && (arguments.first.scan(':').length == 1)
+      arguments = arguments.first.split(':')
+    end
+    escape_or_warn_of_escape_sequences(arguments)
+  end
+
   # Performs the _userinfo-set_ command.
   def perform
     add_request_if_new do |request|
-      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
-
 end

data/lib/htty/cli/display.rb

@@ -39,10 +39,10 @@ module HTTY::CLI::Display
 
   def format(string, *attributes)
     segments = attributes.collect do |a|
-      "\x1b[#{FORMATS[a]}m"
+      "\e[#{FORMATS[a]}m"
     end
     segments << string
-    segments << "\x1b[0m"
+    segments << "\e[0m"
     segments.join ''
   end
 
@@ -69,7 +69,6 @@ module HTTY::CLI::Display
 
   def normal(string)
     return string
-    # format string, :foreground_dark_default
   end
 
   def pluralize(word, number)
@@ -83,7 +82,7 @@ module HTTY::CLI::Display
     end
   end
 
-  def prompt(request)
+  def formatted_prompt_for(request)
     format_request_uri(request.uri) + normal('> ')
   end
 
@@ -96,7 +95,7 @@ module HTTY::CLI::Display
   end
 
   def say_header(message, style=:normal)
-    puts send(style, notice('')) + highlight(messag)
+    puts send(style, notice('')) + highlight(message)
   end
 
   def say_hello
@@ -104,13 +103,17 @@ module HTTY::CLI::Display
          strong('HTTP TTY') + normal('. Heck To The Yeah!')
   end
 
+  def break
+    puts ''
+  end
+
   def show_headers(headers, options={})
-    show_asterisk_next_to   = options[:show_asterisk_next_to]
-    show_mercantile_next_to = options[:show_mercantile_next_to]
+    show_asterisk_next_to   = (options[:show_asterisk_next_to] || '').downcase
+    show_mercantile_next_to = (options[:show_mercantile_next_to] || '').downcase
 
     asterisk_symbol, mercantile_symbol = nil, nil
     margin = headers.inject 0 do |result, header|
-      header_name = header.first
+      header_name = header.first.downcase
       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   : ''
@@ -119,10 +122,9 @@ module HTTY::CLI::Display
        result].max
     end
     headers.each do |name, 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
+      asterisk   = (name.downcase == show_asterisk_next_to)   ? asterisk_symbol   : nil
+      mercantile = (name.downcase == 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

data/lib/htty/cli/input_device.rb

@@ -0,0 +1,75 @@
+require 'readline'
+
+module HTTY::CLI::InputDevice
+  def self.new(display)
+    if STDIN.tty?
+      TTY.new(display)
+    else
+      Pipe.new(display)
+    end
+  end
+
+  class Pipe
+    def initialize(display)
+      @display = display
+    end
+
+    def commands
+      STDIN.each_line do |command_line|
+        command_line.chomp!
+        command_line.strip!
+        next if command_line.empty?
+        @display.line(command_line)
+        yield command_line
+      end
+    end
+  end
+
+  class TTY
+    def initialize(display)
+      enable_completion
+      @display = display
+    end
+
+    def commands
+      loop do
+        begin
+          command_line = ''
+          while command_line.empty? do
+            if (command_line = Readline.readline(@display.formatted_prompt, true)).nil?
+              raise Interrupt
+            end
+            if whitespace?(command_line) || repeat?(command_line)
+              Readline::HISTORY.pop
+            end
+            command_line.chomp!
+            command_line.strip!
+          end
+          yield command_line
+        rescue Interrupt
+          @display.break
+          yield 'quit'
+        end
+      end
+    end
+
+    private
+
+    def enable_completion
+      Readline.completion_proc = proc do |input|
+        autocomplete_list = HTTY::CLI::Commands.select do |c|
+          c.complete_for? input
+        end
+        autocomplete_list.collect(&:raw_name)
+      end
+    end
+
+    def repeat?(command_line)
+      command_line == Readline::HISTORY.to_a[-2]
+    end
+
+    def whitespace?(command_line)
+      command_line.strip.empty?
+    end
+  end
+end

data/lib/htty/cli/url_escaping.rb

@@ -1,5 +1,5 @@
-require 'uri'
 require File.expand_path("#{File.dirname __FILE__}/display")
+require File.expand_path("#{File.dirname __FILE__}/../uri")
 
 module HTTY; end
 
@@ -17,7 +17,7 @@ module HTTY::CLI::UrlEscaping
             'sequences'
         a
       else
-        URI.escape a
+        HTTY::URI.escape_component(a)
       end
     end
   end

data/lib/htty/headers.rb

@@ -0,0 +1,81 @@
+require 'uri'
+require 'base64'
+
+module HTTY; end
+
+# Represents the Headers of a Request or a Response. Headers preserve the
+# insertion order and are case insensitive. A custom Hash is used because Hash
+# did not have this behavior in Ruby v1.8.7 and earlier.
+class HTTY::Headers
+
+  def initialize(hash={})
+    @inner_hash = {}
+    @inner_keys = {}
+    @ordered_keys = []
+    hash.each_pair do |key, value|
+      self[key] = value
+    end
+  end
+
+  def [](key)
+    @inner_hash[key.downcase]
+  end
+
+  def []=(key, value)
+    @ordered_keys << key.downcase unless @inner_hash.key?(key.downcase)
+    @inner_keys[key.downcase] = key
+    @inner_hash[key.downcase] = value
+    self
+  end
+
+  def ==(other_hash)
+    if other_hash.kind_of?(self.class)
+      return (other_hash.instance_variable_get('@inner_hash') == @inner_hash) &&
+             (other_hash.instance_variable_get('@inner_keys') == @inner_keys)
+    end
+    if other_hash.kind_of?(@inner_hash.class)
+      return other_hash.keys.all? do |k|
+        other_hash[k] == @inner_hash[k]
+      end
+    end
+    false
+  end
+
+  def clear
+    @inner_hash.clear
+    @inner_keys.clear
+    @ordered_keys.clear
+  end
+
+  def delete(key)
+    @ordered_keys.delete(key.downcase) if @inner_hash.key?(key.downcase)
+    @inner_keys.delete(key.downcase)
+    @inner_hash.delete(key.downcase)
+  end
+
+  def empty?
+    @inner_hash.empty?
+  end
+
+  def to_a
+    @ordered_keys.inject([]) do |result, normalized_key|
+      result + [[@inner_keys[normalized_key], @inner_hash[normalized_key]]]
+    end
+  end
+
+  def self.basic_authentication_for(username, password = nil)
+    ['Authorization',
+     'Basic ' + Base64.encode64(
+       URI.unescape([username, password].compact.join(':'))
+      ).chomp
+    ]
+  end
+
+  def self.credentials_from(basic_authentication)
+    if match = /^Basic (.+)$/.match(basic_authentication)
+      credentials = Base64.decode64(match[1]).split(':')
+      return yield *credentials if block_given?
+      return credentials
+    end
+  end
+end