htty 1.2.1 → 1.3.0

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+.rvmrc
+.yardoc/
+*.gem
+Gemfile.lock
+doc/
+pkg/*
+spec/system/scenarios/**/actual_*

data/.yardopts

@@ -0,0 +1 @@
+--file MIT-LICENSE.markdown --file History.markdown --no-private --protected --title "htty, the HTTP TTY"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'ruby-debug',   '~> 0.2',  :platforms => 'ruby_18'
+  gem 'ruby-debug19', '~> 0.11', :platforms => 'ruby_19'
+end

data/History.markdown

@@ -1,34 +1,42 @@
 Version history for the _htty_ project
 ======================================
 
-v1.2.1, Wed 12/01/2010
----------------------
+<a name="v1.3.0"></a>v1.3.0, Fri 2/25/2011
+-------------------------------------------
+
+* Added the `body-request-open` and `body-response-open` commands for viewing body content in an external program \[with help from [rbxbx](http://github.com/rbxbx "rbxbx at GitHub")\]
+* Added validation of the URL scheme
+* Added support for the [rubygems-test](http://rubygems.org/gems/rubygems-test) gem for compatibility testing in the field
+* Refined dependencies
+
+<a name="v1.2.1"></a>v1.2.1, Wed 12/01/2010
+-------------------------------------------
 
 * Made Ruby v1.8.7 or later a requirement for gem installation
 * Upgraded dependencies
 
-v1.2.0, Wed 12/01/2010
----------------------
+<a name="v1.2.0"></a>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
----------------------
+<a name="v1.1.6"></a>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
----------------------
+<a name="v1.1.5"></a>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
----------------------
+<a name="v1.1.4"></a>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
@@ -36,25 +44,25 @@ v1.1.4, Sat 10/16/2010
   - Support duplicate keys
   - Support keys with brackets in their names, à la Rails
 
-v1.1.3, Tue 10/12/2010
----------------------
+<a name="v1.1.3"></a>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
----------------------
+<a name="v1.1.2"></a>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
----------------------
+<a name="v1.1.1"></a>v1.1.1, Tue 9/28/2010
+------------------------------------------
 
 * Classified RubyGems for building documentation as development-only dependencies
 
-v1.1.0, Tue 9/28/2010
----------------------
+<a name="v1.1.0"></a>v1.1.0, Tue 9/28/2010
+------------------------------------------
 
 * Added HTTP Secure support
 * Added HTTP Basic Authentication support
@@ -67,7 +75,7 @@ v1.1.0, Tue 9/28/2010
 * Fixed various bugs
 * Corrected and expanded built-in help content
 
-v1.0.0, Mon 9/06/2010
----------------------
+<a name="v1.0.0"></a>v1.0.0, Mon 9/06/2010
+------------------------------------------
 
 (First release)

data/MIT-LICENSE.markdown

@@ -1,7 +1,7 @@
 The MIT License
 ===============
 
-Source code for _htty_ is Copyright © 2010 [Nils Jonsson](mailto:htty@nilsjonsson.com).
+Source code for _htty_ is Copyright © 2010–2011 [Nils Jonsson](mailto:htty@nilsjonsson.com) and [contributors](http://github.com/htty/htty/contributors "htty contributors at GitHub").
 
 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:
 

data/README.markdown

@@ -27,12 +27,12 @@
                  |____|     |____|    / ______|
                                       \/
 
-[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.
+[htty](http://htty.github.com) is a console application for interacting with web servers. It’s a fun way to explore web APIs and to learn the ins and outs of HTTP.
 
 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")
 
-Installation
-============
+<a name="installation"></a>Installation
+=======================================
 
 It couldn’t be much easier.
 
@@ -40,8 +40,8 @@ It couldn’t be much easier.
 
 You’ll need Ruby and RubyGems. It’s known to work well under OS X against Ruby v1.8.7 and v1.9.2.
 
-Features
-========
+<a name="features"></a>Features
+===============================
 
 * Intuitive, Tab-completed commands and command aliases
 * Support for familiar HTTP methods _GET_, _POST_, _PUT_, and _DELETE_, as well as _HEAD_, _OPTIONS_ and _TRACE_
@@ -60,13 +60,13 @@ The things you can do with _htty_ are:
 * **Review history** — a normal and a verbose transcript of your session are available at all times (destroyed when you quit _htty_)
 * **Reuse previous requests** — you can refer to prior requests and copy them
 
-Examples
-========
+<a name="examples"></a>Examples
+===============================
 
 Here are a few annotated _htty_ session transcripts to get you started.
 
-Querying a web service
-----------------------
+<a name="basic-example"></a>Querying a web service
+--------------------------------------------------
 
 This simple example shows how to explore a read-only web service with _htty_.
 
@@ -98,8 +98,8 @@ We do a Julia Child maneuver and use the `address` command to change the entire
 
 Exit your session at any time by typing `quit`.
 
-Working with cookies
---------------------
+<a name="cookies-example"></a>Working with cookies
+--------------------------------------------------
 
 The next example demonstrates _htty_’s HTTP Secure support and cookies features, as well as how to review and revisit past requests.
 
@@ -121,8 +121,8 @@ Note that history contains only numbered HTTP request and response pairs, not a
 
 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
-------------------------------------------------------------------
+<a name="history-example"></a>Understanding complex HTTP conversations at a glance using history
+------------------------------------------------------------------------------------------------
 
 Now we’ll look at _htty_’s HTTP Basic Authentication support and learn how to display unabbreviated transcripts of _htty_ sessions.
 
@@ -167,8 +167,8 @@ Different response codes are rendered with colors that suggest their meaning:
 
 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
-------------
+<a name="help"></a>Getting help
+-------------------------------
 
 You can learn how to use _htty_ commands from within _htty_.
 
@@ -176,13 +176,13 @@ You can learn how to use _htty_ commands from within _htty_.
 
 The `help` command takes an optional argument of the abbreviated or full name of a command.
 
-Coming soon
-===========
+<a name="coming-soon"></a>Coming soon
+=====================================
 
 Here are some features that are coming down the pike.
 
-Commands for streamlining web form submission
----------------------------------------------
+<a name="forms-coming-soon"></a>Commands for streamlining web form submission
+-----------------------------------------------------------------------------
 
 These features will make _htty_ better at screen-scraping.
 
@@ -196,43 +196,43 @@ 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.
 
-Custom command aliases and shell emulation of _http-console_
-------------------------------------------------------------
+<a name="custom-aliases-coming-soon"></a>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
-============
+<a name="contributing"></a>Contributing
+=======================================
 
 Report defects and feature requests on [GitHub Issues](http://github.com/htty/htty/issues).
 
 Your patches are welcome, and you will receive attribution here for good stuff. Fork [the official _htty_ repository](http://github.com/htty/htty "htty’s ‘htty’ repository at GitHub") and send a pull request.
 
-News and information
-====================
+<a name="contact"></a>News and information
+==========================================
 
 Stay in touch with the _htty_ project by following [@get_htty](http://twitter.com/get_htty "get_htty at Twitter") on Twitter.
 
 You can also get help in the [#htty channel on Freenode](http://webchat.freenode.net/?channels=htty).
 
-Credits [![Flattr this](http://api.flattr.com/button/button-compact-static-100x17.png)](http://flattr.com/thing/68277/htty-the-HTTP-TTY "Flattr this")
-=======
+<a name="credits"></a>Credits [![Flattr this](http://api.flattr.com/button/button-compact-static-100x17.png)](http://flattr.com/thing/68277/htty-the-HTTP-TTY "Flattr this")
+=============================
 
 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](https://github.com/htty/htty/contributors "htty contributors at GitHub") (in alphabetical order):
+Thanks to [contributors](http://github.com/htty/htty/contributors "htty contributors at GitHub") (in alphabetical order):
 
-* 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"))
+* Rob Dawson (ephox-rob/[rojotek](http://github.com/rojotek "rojotek at GitHub"))
+* Bo Frederiksen ([bofrede](http://github.com/bofrede "bofrede at GitHub"))
+* Johannes Gorset ([jgorset](http://github.com/jgorset "jgorset at GitHub"))
+* Carson McDonald ([carsonmcdonald](http://github.com/carsonmcdonald "carsonmcdonald at GitHub"))
+* Sam Nguyen ([dtjm](http://github.com/dtjm "dtjm at GitHub"))
+* Robert Pitts ([rbxbx](http://github.com/rbxbx "rbxbx at GitHub"))
+* Matt Sanders ([mattsa](http://github.com/mattsa "mattsa at GitHub"))
 
-License
-=======
+<a name="license"></a>License
+=============================
 
 Released under the [MIT License](http://htty.github.com/file.MIT-LICENSE.html).

data/Rakefile

@@ -0,0 +1,85 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+yard, rspec = false, false
+
+namespace :build do
+  begin
+    require 'yard'
+  rescue LoadError
+    desc '(Not available -- install YARD)'
+    task :doc do
+      STDERR.puts '*** Install YARD in order to build documentation'
+    end
+  else
+    yard = true
+    YARD::Rake::YardocTask.new :doc
+  end
+end
+
+namespace :lib do
+  desc "Check the source for missing 'require' statements. Set the 'VERBOSE' " +
+       'environment variable to "t[rue]" to display the name of each file as ' +
+       'it is loaded.'
+  task :find_missing_requires do
+    def verbose?
+      ENV['VERBOSE'].to_s =~ /^T/i
+    end
+
+    Dir.glob 'lib/**/*.rb' do |f|
+      if verbose?
+        puts "* #{f}"
+      else
+        print "\x1b[1;32m.\x1b[0m"
+      end
+      command = "/usr/bin/env ruby -e 'require File.expand_path(#{f.inspect})'"
+      break unless system(command)
+    end
+    puts unless verbose?
+  end
+end
+
+begin
+  require 'rspec/core/rake_task'
+rescue LoadError
+  desc '(Not available -- install RSpec)'
+  task :spec do
+    STDERR.puts '*** Install RSpec in order to run specs'
+  end
+else
+  rspec = true
+
+  def define_spec_task(name, as_subdirectory=true)
+    RSpec::Core::RakeTask.new name do |t|
+      t.rspec_opts = ['--color']
+      # TODO: Change '-d' to '--debug' when that `rspec` bug is fixed
+      t.rspec_opts << '-d'
+
+      directory = as_subdirectory ? "spec/#{name}" : 'spec'
+      t.pattern = "#{directory}/**/*_spec.rb"
+    end
+  end
+
+  namespace :spec do |n|
+    %w(unit integration system).each do |type_of_spec|
+      desc "Run #{type_of_spec} specs"
+      define_spec_task type_of_spec
+    end
+  end
+
+  desc 'Run all specs'
+  define_spec_task :spec, false
+end
+
+if yard && !rspec
+  desc 'Generate YARD documentation'
+  task '' => :doc
+  task :default => :doc
+else
+  desc 'Run all specs'
+  task '' => :spec
+  task :default => :spec
+end
+
+# Support the 'gem test' command.
+task :test => :spec

data/autotest/discover.rb

@@ -0,0 +1,3 @@
+Autotest.add_discovery do
+  'rspec2'
+end

data/htty.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'htty/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'htty'
+  s.version     = HTTY::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nils Jonsson']
+  s.email       = ['htty@nilsjonsson.com']
+  s.homepage    = 'http://htty.github.com'
+  s.summary     = 'The HTTP TTY'
+  s.description = 'htty is a console application for interacting with web '   +
+                  "servers. It's a fun way to explore web APIs and to learn " +
+                  'the ins and outs of HTTP.'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.add_dependency 'mime-types', '~> 1.0'
+
+  s.add_development_dependency 'bluecloth', '~> 2.0'
+  s.add_development_dependency 'rake',      '~> 0.8'
+  s.add_development_dependency 'rspec',     '~> 2.0'
+  s.add_development_dependency 'yard',      '~> 0.2'
+
+  s.rubyforge_project = 'htty'
+  s.has_rdoc          = true
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+                      File.basename f
+                    end
+  s.require_paths = %w(lib)
+end

data/lib/htty.rb

@@ -1,10 +1,5 @@
 # Contains the implementation of _htty_.
-module HTTY
-
-  # The version of this release of _htty_.
-  VERSION = File.read("#{File.dirname __FILE__}/../VERSION").chomp
-
-end
+module HTTY; end
 
 Dir.glob "#{File.dirname __FILE__}/htty/*.rb" do |f|
   require File.expand_path("#{File.dirname __FILE__}/htty/" +

data/lib/htty/cli/body_open_command.rb

@@ -0,0 +1,93 @@
+require 'mime/types'
+require File.expand_path("#{File.dirname __FILE__}/../platform")
+require File.expand_path("#{File.dirname __FILE__}/../tempfile_preserving_extname")
+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 open
+# body content in an external viewer program.
+module HTTY::CLI::BodyOpenCommand
+
+  module ClassMethods
+
+    # Returns the arguments for the command-line usage of the command.
+    def command_line_arguments
+      '[OPTIONS]'
+    end
+
+    # Returns the extended help text for the command.
+    def help_extended
+      "#{help_extended_preamble}\n"                                            +
+      "\n"                                                                     +
+      'The shell command used to launch the program is platform-specific. On ' +
+      "Windows, the 'start' command is used. On other platforms, the 'open' "  +
+      "command is used. (The 'open' command may not be available on your "     +
+      "system.)\n"                                                             +
+      "\n"                                                                     +
+      'You may specify options to be passed to the program. For example, on '  +
+      'Mac OS X, your default program for HTML files may be Google Chrome, '   +
+      'but you can launch Firefox instead by typing '                          +
+      "#{strong command_line + ' -a firefox'}. Likewise, on Windows your "     +
+      'default program for HTML files may be Internet Explorer, but you can '  +
+      "launch Opera instead by typing #{strong command_line + ' opera'}."
+    end
+
+  end
+
+  def self.included(other_module)
+    other_module.extend ClassMethods
+    other_module.module_eval do
+      include HTTY::CLI::Display
+    end
+ end
+
+private
+
+  def open(payload)
+    if (body = payload.body).to_s.empty?
+      puts notice("#{payload.class.name.split('::').last} does not have a body")
+      return self
+    end
+    content_type_header = payload.headers.detect do |name, value|
+      name == 'Content-Type'
+    end
+    content_type = content_type_header ? content_type_header.last : nil
+    tempfile = render_to_file(body, content_type)
+    path = platform_path(tempfile.path)
+    arguments_to_open = arguments.empty? ? '' : " #{arguments.join ' '}"
+    `#{open_command}#{arguments_to_open} #{path}`
+  end
+
+  def open_command
+    HTTY::Platform.windows? ? 'start' : 'open'
+  end
+
+  def platform_path(path)
+    HTTY::Platform.windows? ? path.gsub('/', '\\') : path
+  end
+
+  def render_to_file(body, content_type)
+    filename = "htty.#{tempfile_extension content_type}"
+    HTTY::TempfilePreservingExtname.new(filename).tap do |f|
+      f.write body
+      f.close
+    end
+  end
+
+  def tempfile_extension(content_type)
+    unless (types = MIME::Types[content_type].first)
+      if content_type.to_s.empty?
+        puts notice("No 'Content-Type' header value -- assuming 'text/html'")
+      else
+        puts notice("Unrecognized 'Content-Type' header value " +
+                    "'#{content_type}' -- using 'text/html' instead")
+      end
+      return 'html'
+    end
+    type.extensions.first
+  end
+
+end