htty 1.1.6 → 1.2.0

data/History.markdown

@@ -1,6 +1,52 @@
 Version history for the _htty_ project
 ======================================
 
+v1.2.0, Wed 12/01/2010
+---------------------
+
+* Added support for Tab-key completion of user input [[carsonmcdonald](http://github.com/carsonmcdonald "carsonmcdonald at GitHub")]
+* Enhanced the `query-unset` command to accept an optional _value_ argument [[mattsa](http://github.com/mattsa "mattsa at GitHub")]
+
+v1.1.6, Mon 11/22/2010
+---------------------
+
+* Added the `query-add` and `query-remove` commands [[mattsa](http://github.com/mattsa "mattsa at GitHub")]:
+* Added context-sensitive help in connection with server certificate verification
+* Upgraded various dependencies
+
+v1.1.5, Wed 10/20/2010
+---------------------
+
+* Added the `ssl-verification*` commands for controlling the verification of server certificates [[dtjm](http://github.com/dtjm "dtjm at GitHub")]
+* Fixed a bug in the `query-set` command [[mattsa](http://github.com/mattsa "mattsa at GitHub")]
+* Fixed a Ruby < v1.9 compatibility problem
+
+v1.1.4, Sat 10/16/2010
+---------------------
+
+* Enhanced the `query-set` command [[mattsa](http://github.com/mattsa "mattsa at GitHub")] to:
+  - Accept an arbitrary number of arguments
+  - Support valueless keys
+  - Support duplicate keys
+  - Support keys with brackets in their names, à la Rails
+
+v1.1.3, Tue 10/12/2010
+---------------------
+
+* Fixed a bug in the arrow keys and Emacs key bindings support within the `body-set` command [ephox-rob/[rojotek](http://github.com/rojotek "rojotek at GitHub")]
+* Fixed a bug involving empty response bodies such as are received with _304 Not Modified_
+
+v1.1.2, Wed 9/29/2010
+---------------------
+
+* Stopped recording blank and repeated entries in the command history [[jgorset](http://github.com/jgorset "jgorset at GitHub")]
+* Fixed a bug in the help index
+
+v1.1.1, Tue 9/28/2010
+---------------------
+
+* Classified RubyGems for building documentation as development-only dependencies
+
 v1.1.0, Tue 9/28/2010
 ---------------------
 

data/README.markdown

@@ -27,7 +27,7 @@
                  |____|     |____|    / ______|
                                       \/
 
-[htty](http://htty.github.com) is a console application for interacting with HTTP servers. It’s something of a cross between _curl_ and the Lynx browser.
+[htty](http://htty.github.com) is a console application for interacting with HTTP servers. It’s something of a cross between [cURL](http://curl.haxx.se) and a browser.
 
 See what’s changed lately by reading the [project history](http://htty.github.com/file.History.html). [![Flattr this](http://api.flattr.com/button/button-compact-static-100x17.png)](http://flattr.com/thing/68277/htty-the-HTTP-TTY "Flattr this")
 
@@ -43,7 +43,7 @@ You’ll need Ruby and RubyGems. It’s known to work well under OS X against Ru
 Features
 ========
 
-* Intuitive commands and command aliases
+* Intuitive, Tab-completed commands and command aliases
 * Support for familiar HTTP methods _GET_, _POST_, _PUT_, and _DELETE_, as well as _HEAD_, _OPTIONS_ and _TRACE_
 * Support for HTTP Secure connections and HTTP Basic Authentication
 * Automatic URL-encoding of userinfo, paths, query-string parameters, and page fragments
@@ -159,8 +159,8 @@ Type `body-set` to enter body data, and terminate it by typing Return three time
 Different response codes are rendered with colors that suggest their meaning:
 
 * Response codes between 200 and 299 appear <span style="background-color: green; color: black; font-weight: bold; padding: 0 0.25em 0 0.25em;">black on green</span> to indicate success
-* Response codes between 300 and 399 appear <span style="background-color: blue; color: white; font-weight: bold; padding: 0 0.25em 0 0.25em;">white on blue</span> to indicate redirection
-* Response codes between 400 and 499 appear <span style="background-color: red; color: white; font-weight: bold; padding: 0 0.25em 0 0.25em;">white on red</span> to indicate failure
+* Response codes between 300 and 399 appear <span style="background-color: darkblue; color: white; font-weight: bold; padding: 0 0.25em 0 0.25em;">white on blue</span> to indicate redirection
+* Response codes between 400 and 499 appear <span style="background-color: darkred; color: white; font-weight: bold; padding: 0 0.25em 0 0.25em;">white on red</span> to indicate failure
 * Response codes between 500 and 599 appear <span style="background-color: yellow; color: black; font-weight: bold; padding: 0 0.25em 0 0.25em; text-decoration: blink;">flashing black on yellow</span> to indicate a server error
 
 ![Sinatra application example #2](http://htty.github.com/images/sinatra2.png)
@@ -196,11 +196,6 @@ Using any of the forthcoming `form` commands will clear any non-form content in
 
 You will also be able to pop open a browser window containing request and response bodies.
 
-Shiny autocomplete goodness
----------------------------
-
-We’ll have command command autocompletion, and possibly also Tab key navigation of forms.
-
 Custom command aliases and shell emulation of _http-console_
 ------------------------------------------------------------
 
@@ -227,10 +222,15 @@ Credits [![Flattr this](http://api.flattr.com/button/button-compact-static-100x1
 
 The author, [Nils Jonsson](mailto:htty@nilsjonsson.com), owes a debt of inspiration to the [_http-console_](http://github.com/cloudhead/http-console) project.
 
-Thanks to contributors:
+Thanks to [contributors](https://github.com/htty/htty/contributors "htty contributors at GitHub") (in alphabetical order):
 
-* Bo Frederiksen ([bofrede](http://github.com/bofrede "bofrede at GitHub")) for work on the CLI
-* Robert Pitts ([rbxbx](http://github.com/rbxbx "rbxbx at GitHub")) for work on the CLI and on RSpec specs
+* Rob Dawson (ephox-rob/[rojotek](https://github.com/rojotek "rojotek at GitHub"))
+* Bo Frederiksen ([bofrede](https://github.com/bofrede "bofrede at GitHub"))
+* Johannes Gorset ([jgorset](https://github.com/jgorset "jgorset at GitHub"))
+* Carson McDonald ([carsonmcdonald](https://github.com/carsonmcdonald "carsonmcdonald at GitHub"))
+* Sam Nguyen ([dtjm](https://github.com/dtjm "dtjm at GitHub"))
+* Robert Pitts ([rbxbx](https://github.com/rbxbx "rbxbx at GitHub"))
+* Matt Sanders ([mattsa](https://github.com/mattsa "mattsa at GitHub"))
 
 License
 =======

data/VERSION

@@ -1 +1 @@
-1.1.6
+1.2.0

data/lib/htty/cli.rb

@@ -23,6 +23,7 @@ class HTTY::CLI
       end
       HTTY::Session.new(everything_but_options.first)
     end
+    register_completion_proc
   end
 
   # Takes over stdin, stdout, and stderr to expose #session to command-line
@@ -79,6 +80,15 @@ private
     HTTY::CLI::Commands.build_for command_line, :session => session
   end
 
+  def register_completion_proc
+    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

data/lib/htty/cli/command.rb

@@ -84,6 +84,13 @@ class HTTY::CLI::Command
     nil
   end
 
+  # Returns +true+ if the specified _command_line_ can be autocompleted to the
+  # command.
+  def self.complete_for?(command_line)
+    command_name = command_line_for_class_name(name)
+    command_name[0...command_line.length] == command_line
+  end
+
   # Returns the help text for the command.
   def self.help
     return "Alias for #{strong alias_for.command_line}" if alias_for
@@ -96,25 +103,10 @@ class HTTY::CLI::Command
     "#{help}."
   end
 
-  # Returns an array of the classes or modules that contain this command.
-  def self.namespaces
-    container = nil
-    name.split('::')[0...-1].collect do |element|
-      if container.nil?
-        container = instance_eval("::#{element}", __FILE__, __LINE__)
-      else
-        container = container.module_eval(element, __FILE__, __LINE__)
-      end
-    end
-  end
-
-  # Returns an array of the constants that share this command's namespace.
-  def self.namespace_siblings
-    namespace = namespaces.last
-    other_commands = namespace.constants.collect do |constant|
-      type = namespace.module_eval(constant.to_s, __FILE__, __LINE__)
-      (type == self) ? nil : type
-    end.compact
+  # Returns the full name of the command as it appears on the command line,
+  # without abbreviations.
+  def self.raw_name
+    command_line_for_class_name name
   end
 
   # Returns related command classes for the command.
@@ -135,10 +127,49 @@ protected
 
 private
 
+  def self.command_line_for_class_name(class_name)
+    class_name.split('::').last.gsub(/(.)([A-Z])/, '\1-\2').downcase
+  end
+
+  def self.completion_optional(text)
+    return nil if text.empty?
+    char_length = (text[0..0] == '\\') ? 2 : 1
+    rest = (text.length > char_length)                ?
+           completion_optional(text[char_length..-1]) :
+           nil
+    "(?:#{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)
+    end
+    Regexp.new "^#{pattern}(\\s.+)?$", Regexp::IGNORECASE
+  end
+
+  def self.namespaces
+    container = nil
+    name.split('::')[0...-1].collect do |element|
+      if container.nil?
+        container = instance_eval("::#{element}", __FILE__, __LINE__)
+      else
+        container = container.module_eval(element, __FILE__, __LINE__)
+      end
+    end
+  end
+
+  def self.namespace_siblings
+    namespace = namespaces.last
+    other_commands = namespace.constants.collect do |constant|
+      type = namespace.module_eval(constant.to_s, __FILE__, __LINE__)
+      (type == self) ? nil : type
+    end.compact
+  end
+
 public
 
   # Returns the arguments provided to the command.
@@ -182,26 +213,4 @@ protected
     self
   end
 
-private
-
-  def self.command_line_for_class_name(class_name)
-    class_name.split('::').last.gsub(/(.)([A-Z])/, '\1-\2').downcase
-  end
-
-  def self.completion_optional(text)
-    return nil if text.empty?
-    char_length = (text[0..0] == '\\') ? 2 : 1
-    rest = (text.length > char_length)                ?
-           completion_optional(text[char_length..-1]) :
-           nil
-    "(?:#{text[0...char_length]}#{rest})?"
-  end
-
-  def self.make_command_line_regexp
-    pattern = Regexp.escape(command_line).gsub(/\\\[(.+)\\\]/) do |optional|
-      completion_optional($1)
-    end
-    Regexp.new "^#{pattern}(\\s.+)?$", Regexp::IGNORECASE
-  end
-
 end

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

@@ -1,5 +1,8 @@
 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_delete")
 
 module HTTY; end
 

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

@@ -26,7 +26,7 @@ class HTTY::CLI::Commands::QueryUnset < HTTY::CLI::Command
   # Returns the arguments for the command-line usage of the _query-unset_
   # command.
   def self.command_line_arguments
-    'NAME'
+    'NAME [VALUE]'
   end
 
   # Returns the help text for the _query-unset_ command.
@@ -63,7 +63,9 @@ class HTTY::CLI::Commands::QueryUnset < HTTY::CLI::Command
   def perform
     add_request_if_has_response do |request|
       self.class.notify_if_cookies_cleared request do
-        request.query_unset(*escape_or_warn_of_escape_sequences(arguments))
+        unset_method = (arguments.length == 2) ? :query_remove : :query_unset
+        request.send(unset_method,
+                     *escape_or_warn_of_escape_sequences(arguments))
       end
     end
   end

data/lib/htty/cli/http_method_command.rb

@@ -1,7 +1,9 @@
-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")
-require File.expand_path("#{File.dirname __FILE__}/commands/ssl_verification_off")
+# TODO: See if we can avoid circular references without omitting these 'require' statements
+# require File.expand_path("#{File.dirname __FILE__}/../request")
+# require File.expand_path("#{File.dirname __FILE__}/commands/cookies_use")
+# require File.expand_path("#{File.dirname __FILE__}/commands/follow")
+# require File.expand_path("#{File.dirname __FILE__}/commands/ssl_verification_off")
 
 module HTTY; end
 

data/spec/integration/htty/cli/commands/query_add_spec.rb

@@ -0,0 +1,51 @@
+require 'rspec'
+require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/session")
+require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/cli/commands/query_add")
+
+describe HTTY::CLI::Commands::QueryAdd do
+  let :klass do
+    subject.class
+  end
+
+  let :session do
+    HTTY::Session.new nil
+  end
+
+  def instance(*arguments)
+    klass.new :session => session, :arguments => arguments
+  end
+
+  describe 'with key argument only' do
+    describe 'without key already present' do
+      it 'should add key' do
+        instance('test').perform
+        session.requests.last.uri.query.should == 'test'
+      end
+    end
+
+    describe 'with key already present' do
+      it 'should add key' do
+        session.requests.last.uri.query = 'test=true'
+        instance('test').perform
+        session.requests.last.uri.query.should == 'test=true&test'
+      end
+    end
+  end
+
+  describe 'with key and value arguments' do
+    describe 'without key already present' do
+      it 'should add key and value' do
+        instance('test', 'true').perform
+        session.requests.last.uri.query.should == 'test=true'
+      end
+    end
+
+    describe 'with key already present' do
+      it 'should add key and value' do
+        session.requests.last.uri.query = 'test=true'
+        instance('test', 'false').perform
+        session.requests.last.uri.query.should == 'test=true&test=false'
+      end
+    end
+  end
+end

data/spec/integration/htty/cli/commands/query_remove_spec.rb

@@ -0,0 +1,37 @@
+require 'rspec'
+require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/session")
+require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/cli/commands/query_remove")
+
+describe HTTY::CLI::Commands::QueryRemove do
+  let :klass do
+    subject.class
+  end
+
+  let :session do
+    HTTY::Session.new nil
+  end
+
+  def instance(*arguments)
+    klass.new :session => session, :arguments => arguments
+  end
+
+  describe 'with existing query string with duplicate keys set' do
+    before :each do
+      session.requests.last.uri.query = 'test=true&test=false'
+    end
+
+    describe 'with only key specified' do
+      it 'should remove last entry' do
+        instance('test').perform
+        session.requests.last.uri.query.should == 'test=true'
+      end
+    end
+
+    describe 'with key and value specified' do
+      it 'should remove matching entry only' do
+        instance('test', 'true').perform
+        session.requests.last.uri.query.should == 'test=false'
+      end
+    end
+  end
+end

data/spec/integration/htty/cli/commands/query_set_spec.rb

@@ -0,0 +1,72 @@
+require 'rspec'
+require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/session")
+require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/cli/commands/query_set")
+
+describe HTTY::CLI::Commands::QuerySet do
+  let :klass do
+    subject.class
+  end
+
+  let :session do
+    HTTY::Session.new nil
+  end
+
+  def instance(*arguments)
+    klass.new :session => session, :arguments => arguments
+  end
+
+  describe 'with one argument' do
+    it 'should assign a single key' do
+      instance('test').perform
+      session.requests.last.uri.query.should == 'test'
+    end
+  end
+
+  describe 'with two arguments' do
+    it 'should assign a key-value pair' do
+      instance('test', 'true').perform
+      session.requests.last.uri.query.should == 'test=true'
+    end
+  end
+
+  describe 'with three arguments' do
+    it 'should assign a key-value pair and a valueless key' do
+      instance('test', 'true', 'more').perform
+      session.requests.last.uri.query.should == 'test=true&more'
+    end
+  end
+
+  describe 'with four arguments' do
+    it 'should assign two key-value pairs' do
+      instance('test', 'true', 'more', 'false').perform
+      session.requests.last.uri.query.should == 'test=true&more=false'
+    end
+  end
+
+  describe 'with duplicate keys' do
+    it 'should replace existing key' do
+      session.requests.last.uri.query = 'test=true'
+      instance('test', 'false').perform
+      session.requests.last.uri.query.should == 'test=false'
+    end
+
+    it 'should maintain field location' do
+      session.requests.last.uri.query = 'test=true&more=true'
+      instance('test', 'false').perform
+      session.requests.last.uri.query.should == 'test=false&more=true'
+    end
+
+    it 'should replace multiple instances with one' do
+      session.requests.last.uri.query = 'test=true&more=true&test=true'
+      instance('test', 'false').perform
+      session.requests.last.uri.query.should == 'test=false&more=true'
+    end
+
+    it 'should play nice with nested fields' do
+      session.requests.last.uri.query = 'test[my][]=1'
+      instance('test[my][]', '2').perform
+      instance('test', '3').perform
+      session.requests.last.uri.query.should == 'test[my][]=2&test=3'
+    end
+  end
+end