htty 1.0.0

data/MIT-LICENSE.rdoc

@@ -0,0 +1,9 @@
+The MIT License
+
+Source code for _htty_ is copyright (c) 2010 Nils Jonsson[mailto:htty@nilsjonsson.com].
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,199 @@
+                                                  __  .__
+                  s         s                   _/  |_|  |__   ____
+   .uef^"        :8        :8      ..           \   __\  |  \_/ __ \
+ :d88E          .88       .88     @L             |  | |   Y  \  ___/
+ `888E         :888ooo   :888ooo 9888i   .dL     |__| |___|  /\___  >
+  888E .z8k -*8888888 -*8888888 `Y888k:*888.     __________\/_____\/____________________
+  888E~?888L  8888      8888      888E  888I    /   |   \__    ___/\__    ___/\______   \
+  888E  888E  8888      8888      888E  888I   /    ~    \|    |     |    |    |     ___/
+  888E  888E  8888      8888      888E  888I   \    Y    /|    |     |    |    |    |
+  888E  888E .8888Lu=  .8888Lu=   888E  888I    \___|_  / |____|     |____|    |____|
+  888E  888E ^%888*    ^%888*    x888N><888'    ______\/___________________.___.
+ m888N= 888>   'Y"       'Y"      "88"  888     \__    ___/\__    ___/\__  |   |
+  `Y"   888                             88F       |    |     |    |    /   |   |
+       J88"                            98"        |    |     |    |    \____   |
+       @%                            ./"          |____|     |____|    / ______|
+     :"                             ~`                                 \/
+
+
+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.
+
+= Installation
+
+It couldn't be much easier.
+
+ $ gem install htty
+
+You'll need Ruby and RubyGems. It's known to work well under OS X against Ruby v1.8.7 and v1.9.2 under OS X.
+
+= Features
+
+* Intuitive commands and command aliases
+* Support for familiar HTTP methods _GET_, _POST_, _PUT_, and _DELETE_, as well as _HEAD_, _OPTIONS_ and _TRACE_
+* Automatic URL-encoding of query-string parameters and URL fragments
+* Transcripts, both verbose and summary
+* Dead-simple cookie handling and redirect following
+* Built-in help
+
+The things you can do with _htty_ are:
+
+* <b>Build a request</b> -- you can tweak the address, headers, cookies, and body at will
+* <b>Send the request to the server</b> -- after the request is sent, it remains unchanged in your session history
+* <b>Inspect the server's response</b> -- you can look at the status, headers, cookies, and body in various ways
+* <b>Review history</b> -- a normal and a verbose transcript of your session are available at all times (destroyed when you quit _htty_)
+* <b>Reuse previous requests</b> -- you can refer to prior requests and copy them
+
+= Examples
+
+Here are a few annotated _htty_ session transcripts to get you started.
+
+== Querying a web service
+
+This simple example shows how to explore read-only web services with _htty_.
+
+link:../doc_bin/esvapi1.png
+
+You can point _htty_ at a complete or partial web URL. If you don't supply a URL, \http://0.0.0.0/ (port 80) will be used. You can vary the protocol scheme, userinfo, host, port, path, query string, and fragment as you wish.
+
+The _htty_ shell prompt shows the address of the current request.
+
+The +get+ command is one of seven HTTP request methods supported. A concise summary of the response is shown when you issue a request.
+
+You can follow redirects using the +follow+ command.
+
+link:../doc_bin/esvapi2.png
+
+You can tweak segments of the address at will. Here we are navigating the site's path hierarchy, which you can do with relative as well as absolute pathspecs.
+
+link:../doc_bin/esvapi3.png
+
+Here we add query-string parameters. Notice that characters that require URL encoding are automatically URL-encoded (unless they are part of a URL-encoded expression).
+
+The +headers-response+ and +body-response+ commands reveal the details of a response.
+
+link:../doc_bin/esvapi4.png
+
+There was some cruft in the web service's response (a horizontal line, a passage reference, verse numbers, a copyright stamp, and line breaks). We eliminate it by using API options provided by the web service we're talking to.
+
+We do a Julia Child maneuver and use the +address+ command to change the entire URL, rather than add individual query-string parameters one by one.
+
+Exit your session at any time by typing +quit+.
+
+== Working with cookies
+
+The next example demonstrates _htty_'s cookies features, as well as how to review and revisit past requests.
+
+link:../doc_bin/google1.png
+
+Notice that when cookies are offered in a response, a bold asterisk (it looks like a cookie) appears in the response summary. The same cookie symbol appears next to the _Set-Cookie_ header when you display response headers.
+
+link:../doc_bin/google2.png
+
+The +cookies-use+ command copies cookies out of the response into the next request. The cookie symbol appears next to the _Cookie_ header when you display request headers.
+
+link:../doc_bin/google3.png
+
+An abbreviated history is available through the +history+ command. Information about requests in the history includes request method, URL, number of headers (and a cookie symbol, if cookies were sent), and the size of the body. Information about responses in the history includes response code, number of headers (and a cookie symbol, if cookies were received), and the size of the body.
+
+Note that history contains only numbered HTTP request and response pairs, not a record of all the commands you enter.
+
+The +reuse+ command makes a copy of the headers and body of an earlier request for you to build on.
+
+== Understanding complex HTTP conversations at a glance using history
+
+Assume that we have the following Sinatra application listening on Sinatra's default port, 4567.
+
+ require 'sinatra'
+
+ get '/all-good' do
+   [200, [['Set-Cookie', 'foo=bar; baz']], 'Hello World!']
+ end
+
+ get '/huh' do
+   [404, 'What?']
+ end
+
+ get '/hurl' do
+   [500, 'Barf!']
+ end
+
+ post '/give-it-to-me' do
+   redirect '/all-good'
+ end
+
+This application expects _GET_ and _POST_ requests and responds in various contrived ways.
+
+link:../doc_bin/sinatra1.png
+
+Here you can see a request body being specified. Type +body-set+ to enter body data, and terminate it by typing Return three times consecutively.
+
+Also note how different response codes are rendered:
+
+* Response codes between 200 and 299 appear black on green to indicate success
+* Response codes between 300 and 399 appear white on blue to indicate redirection
+* Response codes between 400 and 499 appear white on red to indicate failure
+* Response codes between 500 and 599 appear flashing black on yellow to indicate a server error
+
+link:../doc_bin/sinatra2.png
+
+As with the abbreviated history demonstrated earlier, verbose history shows a numbered list of requests and the responses they elicited. All information exchanged between client and server is shown.
+
+== Getting help
+
+You can learn how to use _htty_ commands from within _htty_.
+
+link:../doc_bin/help.png
+
+The +help+ command takes an optional argument of the abbreviated or full name of a command.
+
+= Coming soon
+
+Here are some features that are coming down the pike.
+
+== HTTP Secure URLs
+
+The HTTPS code is broken right now. Pardon the dust.
+
+== Commands for streamlining web form submission
+
+These features will make _htty_ better at screen-scraping.
+
+Using any of the forthcoming +form+ commands will clear any non-form content in the body of the request. Adding at least one URL-encoded form parameter to the request will set the _Content-Type_ header to _application/x-www-form-urlencoded_. Removing all URL-encoded form parameters will remove this header.
+
+* +form+ -- display all form parameters offered in the response
+* +form-fill+ -- prompt in turn for a value for each of the form inputs in the response
+* <tt>form-add _name_ _value_</tt> -- add a URL-encoded form parameter for the request, using the specified name and value
+* <tt>form-remove _name_</tt> -- remove a URL-encoded form parameter from the request, using the specified name
+* +form-remove-all+ -- remove all URL-encoded form parameters from the request
+
+You will also be able to pop open a browser window containing request and response bodies.
+
+== Shiny _curses_ goodness
+
+We'll have command history using the arrow keys, command autocompletion, and Tab key navigation of forms.
+
+== Custom command aliases and shell emulation of _http-console_
+
+You should be able to make your own command aliases.
+
+_http-console_ has a nice command-line. We should have an _http-console_ skin for _htty_.
+
+= Contributing
+
+Your patches are welcome, and you will receive attribution here for good stuff.
+
+Fork the official _htty_ repository located at http://github.com/htty/htty and send a pull request to htty[http://github.com/htty].
+
+= News and information
+
+Stay in touch with the _htty_ project by following the Twitter account: get_htty[http://twitter.com/get_htty].
+
+You can also get help in the \#htty channel on Freenode[http://webchat.freenode.net/?channels=htty].
+
+= Credits
+
+The author, Nils&nbsp;Jonsson[mailto:htty@nilsjonsson.com], owes a debt of inspiration to the http-console[http://github.com/cloudhead/http-console] project.
+
+= License
+
+Released under the MIT&nbsp;License[link:MIT-LICENSE_rdoc.html].

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/htty.rb

@@ -0,0 +1,14 @@
+# Loads constants defined within HTTY.
+
+# Contains the implementation of _htty_.
+module HTTY
+
+  # The version of this release of _htty_.
+  VERSION = File.read("#{File.dirname __FILE__}/../VERSION").chomp
+
+end
+
+Dir.glob "#{File.dirname __FILE__}/htty/*.rb" do |f|
+  require File.expand_path("#{File.dirname __FILE__}/htty/" +
+                           File.basename(f, '.rb'))
+end

data/app/htty/cli.rb

@@ -0,0 +1,77 @@
+# Defines HTTY::CLI and loads constants defined within HTTY::CLI.
+
+require File.expand_path("#{File.dirname __FILE__}/cli/commands")
+require File.expand_path("#{File.dirname __FILE__}/cli/commands/help")
+require File.expand_path("#{File.dirname __FILE__}/cli/commands/quit")
+require File.expand_path("#{File.dirname __FILE__}/cli/display")
+require File.expand_path("#{File.dirname __FILE__}/session")
+
+module HTTY; end
+
+# Encapsulates the command-line interface to _htty_.
+class HTTY::CLI
+
+  include HTTY::CLI::Display
+
+  # Returns the HTTY::Session created from command-line arguments.
+  attr_reader :session
+
+  # Instantiates a new HTTY::CLI with the specified _command_line_arguments_.
+  def initialize(command_line_arguments)
+    exit unless @session = rescuing_from(ArgumentError) do
+      everything_but_options = command_line_arguments.reject do |a|
+        a[0..0] == '-'
+      end
+      HTTY::Session.new(everything_but_options.first)
+    end
+  end
+
+  # Takes over stdin, stdout, and stderr to expose #session to command-line
+  # interaction.
+  def run!
+    say_hello
+    catch :quit do
+      loop do
+        begin
+          unless (command = prompt_for_command)
+            $stderr.puts notice('Unrecognized command')
+            puts notice('Try typing ' +
+                        strong(HTTY::CLI::Commands::Help.command_line))
+            next
+          end
+          if ARGV.include?('--debug')
+            command.perform
+          else
+            rescuing_from Exception do
+              command.perform
+            end
+          end
+        rescue Interrupt
+          puts
+          puts notice('Type ' +
+                      strong(HTTY::CLI::Commands::Quit.command_line) +
+                      ' to quit')
+          next
+        end
+      end
+    end
+    say_goodbye
+  end
+
+private
+
+  def prompt_for_command
+    command_line = ''
+    while command_line.empty? do
+      print strong(session.requests.last.uri) + normal('> ')
+      command_line = $stdin.gets.chomp.strip
+    end
+    HTTY::CLI::Commands.build_for command_line, :session => session
+  end
+
+end
+
+Dir.glob "#{File.dirname __FILE__}/cli/*.rb" do |f|
+  require File.expand_path("#{File.dirname __FILE__}/cli/" +
+                           File.basename(f, '.rb'))
+end

data/app/htty/cli/command.rb

@@ -0,0 +1,185 @@
+# Defines HTTY::CLI::Command.
+
+require 'abbrev'
+require 'shellwords'
+require File.expand_path("#{File.dirname __FILE__}/display")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+# A base class for all HTTY::CLI::Commands.
+class HTTY::CLI::Command
+
+  extend HTTY::CLI::Display
+
+  # Returns a command that the command is an alias for, otherwise +nil+.
+  def self.alias_for; end
+
+  # Returns command classes that are aliases for the command.
+  def self.aliases
+    namespace_siblings.select do |s|
+      s.alias_for == self
+    end
+  end
+
+  # Returns a new HTTY::CLI::Commands::Command if the specified _command_line_
+  # references it, otherwise +nil+. If an _attributes_ hash is specified, it is
+  # used to initialize the 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])
+        return new(attributes.merge(:arguments => arguments.strip.shellsplit))
+      end
+      return new(attributes)
+    end
+    nil
+  end
+
+  # Returns the name of a category under which help for the command should
+  # appear.
+  def self.category
+    return nil unless alias_for
+    alias_for.category
+  end
+
+  # Returns the string used to invoke the command from the command line. Its
+  # abbreviation is calculated to avoid collision with other commands in the
+  # same module.
+  def self.command_line
+    my_command_line = command_line_for_class_name(name)
+    other_command_lines = namespace_siblings.collect do |s|
+      if s.method_defined?(:command_line)
+        s.command_line
+      else
+        command_line_for_class_name s.name
+      end
+    end
+    all_command_lines = [my_command_line] + other_command_lines
+    all_abbrevs = Abbrev.abbrev(all_command_lines).group_by do |abbrev,
+                                                                command_line|
+      command_line
+    end.collect do |command_line, abbrevs|
+      abbrevs.sort_by do |command_line, abbrev|
+        command_line
+      end.first
+    end
+    my_abbrev = all_abbrevs.detect do |abbrev, command_line|
+      command_line == my_command_line
+    end.first
+    my_abbrev_regexp = Regexp.new("^(#{Regexp.escape my_abbrev})(.*)$")
+    my_command_line.gsub my_abbrev_regexp do
+      $2.empty? ? $1 : "#{$1}[#{$2}]"
+    end
+  end
+
+  # Returns the arguments for the command-line usage of the command.
+  def self.command_line_arguments
+    return alias_for.command_line_arguments if alias_for
+    nil
+  end
+
+  # Returns the help text for the command.
+  def self.help
+    return "Alias for #{strong alias_for.command_line}" if alias_for
+    "(Help for #{strong command_line} is not available)"
+  end
+
+  # Returns the extended help text for the _get_ command.
+  def self.help_extended
+    return "(Extended help for #{command_line} is not available.)" unless help
+    "#{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
+  end
+
+  # Returns related command classes for the command.
+  def self.see_also_commands
+    Array(alias_for)
+  end
+
+  # Returns the arguments provided to the command.
+  attr_reader :arguments
+
+  # Returns the session within which the command operates.
+  attr_reader :session
+
+  # Initializes a new HTTY::CLI::Command with attribute values specified in the
+  # _attributes_ hash.
+  #
+  # Valid _attributes_ keys include:
+  #
+  # * <tt>:arguments</tt>
+  # * <tt>:session</tt>
+  def initialize(attributes={})
+    @arguments = Array(attributes[:arguments])
+    @session   = attributes[:session]
+  end
+
+  # Performs the command, or raises NotImplementedError.
+  def perform
+    unless (alias_for = self.class.alias_for)
+      raise NotImplementedError, 'not implemented yet'
+    end
+    alias_for.new(:arguments => arguments, :session => session).perform
+  end
+
+protected
+
+  # Yields the last request in #session. If that request already has a response,
+  # then it adds the result of the +yield+ to the requests of #session.
+  def add_request_if_has_response
+    requests     = session.requests
+    last_request = requests.last
+    if last_request.response
+      requests << yield(last_request)
+    else
+      requests[requests.length - 1] = yield(last_request)
+    end
+    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