halcyon 0.3.18 → 0.3.22

data/Rakefile

@@ -75,42 +75,39 @@ task :uninstall => [:clean] do
   sh %{sudo gem uninstall #{project[:name]}}
 end
 
-task 'run-spec' do
-  require 'spec'
-  $:.unshift(File.dirname(__FILE__))
-  stdout = []
-  class << stdout
-    def print(*e) concat(e); Kernel.print(*e); end
-    def puts(*e) concat(e); Kernel.puts(*e); end
-    def flush; end
+namespace 'spec' do
+  desc "generate spec"
+  task :gen do
+    sh "spec -c -rlib/halcyon -rspec/spec_helper spec/**/* --format s:spec/SPEC --format h:spec/SPEC.html"
   end
-  stderr = []
-  class << stderr
-    alias print <<
-    def print(*e) concat(e); Kernel.print(*e); end
-    def puts(*e) concat(e); Kernel.puts(*e); end
-    def flush; end
+  
+  desc "run rspec"
+  task :run do
+    sh "spec -c -rlib/halcyon -rspec/spec_helper spec/**/*"
+  end
+  
+  desc "run rspec verbosely"
+  task :verb do
+    sh "spec -c -rlib/halcyon -rspec/spec_helper spec/**/* --format s"
   end
-  ::Spec::Runner::CommandLine.run(['spec'], stderr, stdout, false, true)
-  exit_status = stdout.last.strip[/(\d+) failures?/, 1].to_i
-  at_exit{
-    exit(exit_status == 0 ? 0 : 1)
-  }
-end
-
-desc "run rspec"
-task :spec do
-  run = Rake::Task['run-spec']
-  run.execute
 end
 
-task :default => :spec
-
 desc "Do predistribution stuff"
-task :predist => [:chmod, :changelog, :rdoc]
+task :predist => [:chmod, :changelog, :manifest, :rdoc]
 
 def manifest
-  `darcs query manifest`.split("\n").map { |f| f.gsub(/\A\.\//, '') }
+  require 'find'
+  paths = []
+  manifest = File.new('MANIFEST', 'w+')
+  Find.find('.') do |path|
+    path.gsub!(/\A\.\//, '')
+    next if path =~ /(\.svn|doc|pkg|^\.|MANIFEST)/
+    paths << path
+  end
+  paths.sort.each do |path|
+    manifest.puts path
+  end
+  manifest.close
 end
 
 desc "Make binaries executable"
@@ -119,9 +116,14 @@ task :chmod do
   Dir["test/cgi/test*"].each { |binary| File.chmod(0775, binary) }
 end
 
-desc "Generate a ChangeLog"
+desc "Generate a MANIFEST"
+task :manifest do
+  manifest
+end
+
+desc "Generate a CHANGELOG"
 task :changelog do
-  sh "svn log >ChangeLog"
+  sh "svn log > CHANGELOG"
 end
 
 desc "Generate RDoc documentation"
@@ -146,3 +148,5 @@ desc "find . -name \"*.rb\" | xargs wc -l | grep total"
 task :loc do
   sh "find . -name \"*.rb\" | xargs wc -l | grep total"
 end
+
+task :default => Rake::Task['spec:run']

data/bin/halcyon

@@ -19,6 +19,7 @@
 #++
 
 $debug = false
+$test = false
 options = Halcyon::Server::DEFAULT_OPTIONS
 
 #--

data/lib/halcyon.rb

@@ -21,7 +21,7 @@ end
 #++
 
 module Halcyon
-  VERSION = [0,3,18]
+  VERSION = [0,3,22]
   def self.version
     VERSION.join('.')
   end
@@ -40,7 +40,7 @@ module Halcyon
   # For documentation on using Halcyon, check out the Halcyon::Server::Base and
   # Halcyon::Client::Base classes which contain much more usage documentation.
   def introduction
-    abort "READ THE DAMNED RDOCS FOO"
+    abort "READ THE DAMNED RDOCS!"
   end
   
 end

data/lib/halcyon/client/base.rb

@@ -221,8 +221,8 @@ module Halcyon
       # If the server responds with any kind of failure (anything with a status
       # that isn't 200), Halcyon will in turn raise the respective exception
       # (defined in Halcyon::Exceptions) which all inherit from
-      # +Halcyon::Client::Exceptions::Base+. It is up to the client to handle
-      # these exceptions specifically.
+      # +Halcyon::Exceptions::Base+. It is up to the client to handle these
+      # exceptions specifically.
       def request(req)
         # prepare and send HTTP request
         res = Net::HTTP.start(@uri.host, @uri.port) {|http|http.request(req)}
@@ -236,7 +236,7 @@ module Halcyon
         
         # return response
         body
-      rescue Halcyon::Client::Base::Exceptions::Base => e
+      rescue Halcyon::Exceptions::Base => e
         # log exception if logger is in place
         raise
       end

data/lib/halcyon/client/exceptions.rb

@@ -12,18 +12,6 @@ module Halcyon
     class Base
       module Exceptions #:nodoc:
         
-        #--
-        # Base Halcyon Exception
-        #++
-        
-        class Base < StandardError #:nodoc:
-          attr_accessor :status, :error
-          def initialize(status, error)
-            @status = status
-            @error = error
-          end
-        end
-        
         #--
         # Exception classes
         #++
@@ -31,7 +19,7 @@ module Halcyon
         Halcyon::Exceptions::HTTP_ERROR_CODES.to_a.each do |http_error|
           status, body = http_error
           class_eval(
-            "class #{body.gsub(/( |\-)/,'')} < Base\n"+
+            "class #{body.gsub(/( |\-)/,'')} < Halcyon::Exceptions::Base\n"+
             "  def initialize(s=#{status}, e='#{body}')\n"+
             "    super s, e\n"+
             "  end\n"+

data/lib/halcyon/exceptions.rb

@@ -9,6 +9,23 @@
 
 module Halcyon
   module Exceptions #:nodoc:
+    
+    #--
+    # Base Halcyon Exception
+    #++
+    
+    class Base < StandardError #:nodoc:
+      attr_accessor :status, :error
+      def initialize(status, error)
+        @status = status
+        @error = error
+      end
+    end
+    
+    #--
+    # HTTP Error Codes and Errors
+    #++
+    
     HTTP_ERROR_CODES = {
       400  => 'Bad Request',
       401  => 'Unauthorized',

data/lib/halcyon/server/base.rb

@@ -219,9 +219,6 @@ module Halcyon
         # instance
         @env['halcyon.logger'] = @logger
         
-        # set the acceptable remotes to include the remote IP if debugging is enabled
-        @config[:acceptable_remotes] << @env["REMOTE_ADDR"] if $debug
-        
         # pre run hook
         before_run(Time.now - @time_started) if respond_to? :before_run
         
@@ -289,6 +286,11 @@ module Halcyon
       # primarily only speaking with other apps on the same machine, though
       # your specific requirements may differ and change that.
       # 
+      # When in debug mode or in testing mode, the request filtering test is
+      # not fired, so all requests from all User Agents and locations will
+      # succeed. This is important to know if you plan on testing this specific
+      # feature while in debugging or testing modes.
+      # 
       # == Hooks, Callbacks, and Authentication
       # 
       # There is no Authentication mechanism built in to Halcyon (for the time
@@ -310,10 +312,7 @@ module Halcyon
       # (or one of its inheriters) instead of handling them manually.
       def run(route)
         # make sure the request meets our expectations
-        @config[:acceptable_requests].each do |req|
-          raise Exceptions::Base.new(req[2], req[3]) unless @env[req[0]] =~ req[1]
-        end
-        raise Exceptions::Forbidden.new unless @config[:acceptable_remotes].member? @env["REMOTE_ADDR"]
+        acceptable_request! unless $debug || $test
         
         # pull params
         params = route.reject{|key, val| [:action, :module].include? key}
@@ -337,13 +336,21 @@ module Halcyon
         after_call if respond_to? :after_call
         
         res
-      rescue Exceptions::Base => e
+      rescue Halcyon::Exceptions::Base => e
         @logger.warn "#{uri} => #{e.error}"
         # handles all content error exceptions
         @res.status = e.status
         {:status => e.status, :body => e.error}
       end
       
+      # Tests for acceptable requests if +$debug+ and +$test+ are not set.
+      def acceptable_request!
+        @config[:acceptable_requests].each do |req|
+          raise Halcyon::Exceptions::Base.new(req[2], req[3]) unless @env[req[0]] =~ req[1]
+        end
+        raise Exceptions::Forbidden.new unless @config[:acceptable_remotes].member? @env["REMOTE_ADDR"]
+      end
+      
       #--
       # Initialization and setup
       #++
@@ -373,18 +380,20 @@ module Halcyon
       def initialize(options = {})
         # save configuration options
         @config = DEFAULT_OPTIONS.merge(options)
+        @config[:app] ||= self.class.to_s.downcase
         
         # apply name options to log_file and pid_file configs
         apply_log_and_pid_file_name_options
         
-        # debug mode handling
+        # debug and test mode handling
         enable_debugging if $debug
+        enable_testing if $test
         
         # setup logging
-        setup_logging unless $debug
+        setup_logging unless $debug || $test
         
         # setup request filtering
-        setup_request_filters unless $debug
+        setup_request_filters unless $debug || $test
         
         # create PID file
         @pid = File.new(@config[:pid_file].gsub('{n}', server_cluster_number), "w", 0644)
@@ -397,8 +406,7 @@ module Halcyon
         # trap signals to die (when killed by the user) gracefully
         finalize =  Proc.new do
           @logger.info "Shutting down #{$$}."
-          @logger.close
-          File.delete(@pid.path)
+          clean_up
           exit
         end
         # http://en.wikipedia.org/wiki/Signal_%28computing%29
@@ -414,6 +422,14 @@ module Halcyon
         end
       end
       
+      # Closes the logger and deletes the PID file.
+      def clean_up
+        return if defined? @cleaned_up
+        @logger.close
+        File.delete(@pid.path) if File.exist?(@pid.path)
+        @cleaned_up = true
+      end
+      
       # Retreives the server cluster sequence number for the PID file.
       # 
       # This is deprecated and will be removed soon, probably for the 0.4.0
@@ -448,23 +464,41 @@ module Halcyon
       # debugging.
       def enable_debugging
         $debug = true
+        
+        # set the PID file name to /tmp/ unless PID file already exists
+        @config[:pid_file] = '/tmp/halcyon.{server}.{app}.{port}.pid' unless defined? @pid
+        apply_log_and_pid_file_name_options # reapply for {server}, {app}, and {port} to be set
+        
         # setup logger to STDOUT and log entering debugging mode
         @logger = Logger.new(STDOUT)
         @logger.progname = "#{self.class}#debug"
         @logger.level = Logger::DEBUG
         @logger.formatter = @config[:log_format]
         @logger.info "Entering debugging mode..."
-        
+      rescue Errno::EACCES
+      	abort "Can't access #{@config[:pid_file]}, try 'sudo #{$0}'"
+      end
+      
+      # This method is used to setup logging and the request handling methods
+      # for debugging.
+      def enable_testing
         # set the PID file name to /tmp/ unless PID file already exists
-        @config[:pid_file] = '/tmp/halcyon.{server}.{app}.{port}.pid' unless @pid.is_a? File
+        @config[:pid_file] = '/tmp/halcyon.testing.{app}.{port}.pid' unless defined? @pid
+        @config[:log_file] = '/tmp/halcyon.testing.{app}.log'
         apply_log_and_pid_file_name_options # reapply for {server}, {app}, and {port} to be set
         
-        # modify acceptable request's profiles
-        @config[:acceptable_requests] = [
-          ["HTTP_USER_AGENT", /.*/, 406, 'Not Acceptable'],
-          ["HTTP_USER_AGENT", /.*/, 415, 'Unsupported Media Type'] # content type isn't set when navigating via browser
-        ]
-        @logger.debug "ACCEPTABLE_REQUESTS modified to accept all User Agents (browsers)"
+        # setup logger and log entering testing mode
+        @logger = Logger.new(@config[:log_file])
+        @logger.progname = "#{self.class}#test"
+        @logger.level = Logger::DEBUG
+        @logger.formatter = @config[:log_format]
+        @logger.info "Entering testing mode..."
+        
+        # make sure we clean up after ourselves since we're in testing mode
+        at_exit {
+          clean_up
+          File.delete(@config[:log_file]) if File.exist?(@config[:log_file])
+        }
       rescue Errno::EACCES
       	abort "Can't access #{@config[:pid_file]}, try 'sudo #{$0}'"
       end
@@ -669,7 +703,7 @@ module Halcyon
       def uri
         # special parsing is done to remove the protocol, host, and port that
         # some Handlers leave in there. (Fixes inconsistencies.)
-        URI.parse(@env['REQUEST_URI']).path
+        URI.parse(@env['REQUEST_URI'] || @env['PATH_INFO']).path
       end
       
       # Returns the Request Method as a lowercase symbol

data/lib/halcyon/server/exceptions.rb

@@ -12,18 +12,6 @@ module Halcyon
     class Base
       module Exceptions #:nodoc:
         
-        #--
-        # Base Halcyon Exception
-        #++
-        
-        class Base < StandardError #:nodoc:
-          attr_accessor :status, :error
-          def initialize(status, error)
-            @status = status
-            @error = error
-          end
-        end
-        
         #--
         # Exception classes
         #++
@@ -31,7 +19,7 @@ module Halcyon
         Halcyon::Exceptions::HTTP_ERROR_CODES.to_a.each do |http_error|
           status, body = http_error
           class_eval(
-            "class #{body.gsub(/( |\-)/,'')} < Base\n"+
+            "class #{body.gsub(/( |\-)/,'')} < Halcyon::Exceptions::Base\n"+
             "  def initialize(s=#{status}, e='#{body}')\n"+
             "    super s, e\n"+
             "  end\n"+

data/lib/halcyon/server/router.rb

@@ -76,7 +76,8 @@ module Halcyon
       # default route if no match is made.
       def self.route(env)
         # pull out the path requested (WEBrick keeps the host and port and protocol in REQUEST_URI)
-        uri = URI.parse(env['REQUEST_URI']).path
+        # PATH_INFO is failover if REQUEST_URI is blank (like what Rack::MockRequest does)
+        uri = URI.parse(env['REQUEST_URI'] || env['PATH_INFO']).path
         
         # prepare request
         path = (uri ? uri.split('?').first : '').sub(/\/+/, '/')
@@ -89,7 +90,7 @@ module Halcyon
         # make sure a route is returned even if no match is found
         if route[0].nil?
           #return default route
-          env['halcyon.logger'].debug "No route found. Using default."
+          env['halcyon.logger'].debug "No route found. Using default." if env['halcyon.logger'].is_a? Logger
           @@default_route
         else
           # params (including action and module if set) for the matching route

data/spec/SPEC

@@ -0,0 +1,29 @@
+
+Halcyon::Server Errors
+- should provide shorthand methods for errors which should throw an appropriate exception
+- supports numerous standard HTTP request error exceptions with lookup by status code
+- should have a short inheritence chain to make catching generically simple
+
+Halcyon::Server::Router
+- should prepares routes correctly when written correctly
+- should match URIs to the correct route
+- should use the default route if no matching route is found
+- should map params in routes to parameters
+- should supply arbitrary routing param values included as a param even if not in the URI
+
+Halcyon::Server
+- should dispatch methods according to their respective routes
+- should provide various shorthand methods for simple responses but take custom response values
+- should handle requests and respond with JSON
+- should handle requests with param values in the URL
+- should route unmatchable requests to the default route and return JSON with appropriate status
+- should log activity
+- should create a PID file while running with the correct process ID
+- should parse URI query params correctly
+- should parse the URI correctly
+- should provide a quick way to find out what method the request was performed using
+- should deny all unacceptable requests
+
+Finished in 0.211129 seconds
+
+19 examples, 0 failures

data/spec/SPEC.html

@@ -0,0 +1,237 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html 
+  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>RSpec results</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Expires" content="-1" />
+  <meta http-equiv="Pragma" content="no-cache" />
+  <style type="text/css">
+  body {
+    margin: 0;
+    padding: 0;
+    background: #fff;
+    font-size: 80%;
+  }
+  </style>
+</head>
+<body>
+<div class="rspec-report">
+  <script type="text/javascript">
+    // <![CDATA[
+function moveProgressBar(percentDone) {
+  document.getElementById("rspec-header").style.width = percentDone +"%";
+}
+function makeRed(element_id) {
+  document.getElementById(element_id).style.background = '#C40D0D';
+  document.getElementById(element_id).style.color = '#FFFFFF';
+}
+
+function makeYellow(element_id) {
+  if (element_id == "rspec-header" && document.getElementById(element_id).style.background != '#C40D0D')
+  {
+    document.getElementById(element_id).style.background = '#FAF834';
+    document.getElementById(element_id).style.color = '#000000';
+  }
+  else
+  {
+    document.getElementById(element_id).style.background = '#FAF834';
+    document.getElementById(element_id).style.color = '#000000';
+  }
+}
+
+    // ]]>
+  </script>
+  <style type="text/css">
+#rspec-header {
+  background: #65C400; color: #fff;
+}
+
+.rspec-report h1 {
+  margin: 0px 10px 0px 10px;
+  padding: 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  font-size: 1.8em;
+}
+
+#summary {
+  margin: 0; padding: 5px 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  text-align: right;
+  position: absolute;
+  top: 0px;
+  right: 0px;
+}
+
+#summary p {
+  margin: 0 0 0 2px;
+}
+
+#summary #totals {
+  font-size: 1.2em;
+}
+
+.example_group {
+  margin: 0 10px 5px;
+  background: #fff;
+}
+
+dl {
+  margin: 0; padding: 0 0 5px;
+  font: normal 11px "Lucida Grande", Helvetica, sans-serif;
+}
+
+dt {
+  padding: 3px;
+  background: #65C400;
+  color: #fff;
+  font-weight: bold;
+}
+
+dd {
+  margin: 5px 0 5px 5px;
+  padding: 3px 3px 3px 18px;
+}
+
+dd.spec.passed {
+  border-left: 5px solid #65C400;
+  border-bottom: 1px solid #65C400;
+  background: #DBFFB4; color: #3D7700;
+}
+
+dd.spec.failed {
+  border-left: 5px solid #C20000;
+  border-bottom: 1px solid #C20000;
+  color: #C20000; background: #FFFBD3;
+}
+
+dd.spec.not_implemented {
+  border-left: 5px solid #FAF834;
+  border-bottom: 1px solid #FAF834;
+  background: #FCFB98; color: #131313;
+}
+
+dd.spec.pending_fixed {
+  border-left: 5px solid #0000C2;
+  border-bottom: 1px solid #0000C2;
+  color: #0000C2; background: #D3FBFF;
+}
+
+.backtrace {
+  color: #000;
+  font-size: 12px;
+}
+
+a {
+  color: #BE5C00;
+}
+
+/* Ruby code, style similar to vibrant ink */
+.ruby {
+  font-size: 12px;
+  font-family: monospace;
+  color: white;
+  background-color: black;
+  padding: 0.1em 0 0.2em 0;
+}
+
+.ruby .keyword { color: #FF6600; }
+.ruby .constant { color: #339999; }
+.ruby .attribute { color: white; }
+.ruby .global { color: white; }
+.ruby .module { color: white; }
+.ruby .class { color: white; }
+.ruby .string { color: #66FF00; }
+.ruby .ident { color: white; }
+.ruby .method { color: #FFCC00; }
+.ruby .number { color: white; }
+.ruby .char { color: white; }
+.ruby .comment { color: #9933CC; }
+.ruby .symbol { color: white; }
+.ruby .regex { color: #44B4CC; }
+.ruby .punct { color: white; }
+.ruby .escape { color: white; }
+.ruby .interp { color: white; }
+.ruby .expr { color: white; }
+
+.ruby .offending { background-color: gray; }
+.ruby .linenum {
+  width: 75px;
+  padding: 0.1em 1em 0.2em 0;
+  color: #000000;
+  background-color: #FFFBD3;
+}
+
+  </style>
+
+<div id="rspec-header">
+  <h1>RSpec Results</h1>
+
+  <div id="summary">
+    <p id="totals">&nbsp;</p>
+    <p id="duration">&nbsp;</p>
+  </div>
+</div>
+
+<div class="results">
+<div class="example_group">
+  <dl>
+  <dt id="example_group_1">Halcyon::Server Errors</dt>
+    <script type="text/javascript">moveProgressBar('5.2');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should provide shorthand methods for errors which should throw an appropriate exception</span></dd>
+    <script type="text/javascript">moveProgressBar('10.5');</script>
+    <dd class="spec passed"><span class="passed_spec_name">supports numerous standard HTTP request error exceptions with lookup by status code</span></dd>
+    <script type="text/javascript">moveProgressBar('15.7');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should have a short inheritence chain to make catching generically simple</span></dd>
+  </dl>
+</div>
+<div class="example_group">
+  <dl>
+  <dt id="example_group_2">Halcyon::Server::Router</dt>
+    <script type="text/javascript">moveProgressBar('21.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should prepares routes correctly when written correctly</span></dd>
+    <script type="text/javascript">moveProgressBar('26.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should match URIs to the correct route</span></dd>
+    <script type="text/javascript">moveProgressBar('31.5');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should use the default route if no matching route is found</span></dd>
+    <script type="text/javascript">moveProgressBar('36.8');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should map params in routes to parameters</span></dd>
+    <script type="text/javascript">moveProgressBar('42.1');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should supply arbitrary routing param values included as a param even if not in the URI</span></dd>
+  </dl>
+</div>
+<div class="example_group">
+  <dl>
+  <dt id="example_group_3">Halcyon::Server</dt>
+    <script type="text/javascript">moveProgressBar('47.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should dispatch methods according to their respective routes</span></dd>
+    <script type="text/javascript">moveProgressBar('52.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should provide various shorthand methods for simple responses but take custom response values</span></dd>
+    <script type="text/javascript">moveProgressBar('57.8');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should handle requests and respond with JSON</span></dd>
+    <script type="text/javascript">moveProgressBar('63.1');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should handle requests with param values in the URL</span></dd>
+    <script type="text/javascript">moveProgressBar('68.4');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should route unmatchable requests to the default route and return JSON with appropriate status</span></dd>
+    <script type="text/javascript">moveProgressBar('73.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should log activity</span></dd>
+    <script type="text/javascript">moveProgressBar('78.9');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should create a PID file while running with the correct process ID</span></dd>
+    <script type="text/javascript">moveProgressBar('84.2');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should parse URI query params correctly</span></dd>
+    <script type="text/javascript">moveProgressBar('89.4');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should parse the URI correctly</span></dd>
+    <script type="text/javascript">moveProgressBar('94.7');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should provide a quick way to find out what method the request was performed using</span></dd>
+    <script type="text/javascript">moveProgressBar('100.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should deny all unacceptable requests</span></dd>
+  </dl>
+</div>
+<script type="text/javascript">document.getElementById('duration').innerHTML = "Finished in <strong>0.211129 seconds</strong>";</script>
+<script type="text/javascript">document.getElementById('totals').innerHTML = "19 examples, 0 failures";</script>
+</div>
+</div>
+</body>
+</html>

data/spec/halcyon/error_spec.rb

@@ -0,0 +1,55 @@
+context "Halcyon::Server Errors" do
+  
+  before(:each) do
+    @app = Specr.new :port => 4000
+  end
+  
+  specify "should provide shorthand methods for errors which should throw an appropriate exception" do
+    begin
+      @app.not_found
+    rescue Halcyon::Exceptions::Base => e
+      e.status.should == 404
+      e.error.should == 'Not Found'
+    end
+    
+    begin
+      @app.not_found('Missing')
+    rescue Halcyon::Exceptions::Base => e
+      e.status.should == 404
+      e.error.should == 'Missing'
+    end
+  end
+  
+  specify "supports numerous standard HTTP request error exceptions with lookup by status code" do
+    begin
+      Halcyon::Server::Base::Exceptions::NotFound.new
+    rescue Halcyon::Exceptions::Base => e
+      e.status.should == 404
+      e.error.should == 'Not Found'
+    end
+    
+    Halcyon::Exceptions::HTTP_ERROR_CODES.each do |code, error|
+      begin
+        Halcyon::Server::Base::Exceptions.const_get(error.gsub(/( |\-)/,'')).new
+      rescue Halcyon::Exceptions::Base => e
+        e.status.should == code
+        e.error.should == error
+      end
+      begin
+        Halcyon::Server::Base::Exceptions.lookup(code).new
+      rescue Halcyon::Exceptions::Base => e
+        e.status.should == code
+        e.error.should == error
+      end
+    end
+  end
+  
+  specify "should have a short inheritence chain to make catching generically simple" do
+    begin
+      Halcyon::Server::Base::Exceptions::NotFound.new
+    rescue Halcon::Exceptions::Base => e
+      e.class.to_s.should == 'NotFound'
+    end
+  end
+  
+end

data/spec/halcyon/router_spec.rb

@@ -0,0 +1,32 @@
+context "Halcyon::Server::Router" do
+  
+  before(:each) do
+    @app = Specr.new :port => 4000
+  end
+  
+  specify "should prepares routes correctly when written correctly" do
+    # routes have been defined for Specr
+    Halcyon::Server::Router.routes.should_not == []
+    Halcyon::Server::Router.routes.length.should > 0
+  end
+  
+  specify "should match URIs to the correct route" do
+    Halcyon::Server::Router.route(Rack::MockRequest.env_for('/'))[:action].should == 'index'
+  end
+  
+  specify "should use the default route if no matching route is found" do
+    Halcyon::Server::Router.route(Rack::MockRequest.env_for('/erroneous/path'))[:action].should == 'not_found'
+    Halcyon::Server::Router.route(Rack::MockRequest.env_for("/random/#{rand}"))[:action].should == 'not_found'
+  end
+  
+  specify "should map params in routes to parameters" do
+     response = Halcyon::Server::Router.route(Rack::MockRequest.env_for('/hello/Matt'))
+     response[:action].should == 'greeter'
+     response[:name].should == 'Matt'
+  end
+  
+  specify "should supply arbitrary routing param values included as a param even if not in the URI" do
+    Halcyon::Server::Router.route(Rack::MockRequest.env_for('/'))[:arbitrary].should == 'random'
+  end
+  
+end

data/spec/halcyon/server_spec.rb

@@ -0,0 +1,93 @@
+context "Halcyon::Server" do
+  
+  before(:each) do
+    @app = Specr.new :port => 4000
+  end
+  
+  specify "should dispatch methods according to their respective routes" do
+    Rack::MockRequest.new(@app).get("/hello/Matt")
+    last_line = File.new(@app.instance_variable_get("@config")[:log_file]).readlines.last
+    last_line.should =~ /INFO \[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\] \(\d+\) Specr#test :: \[200\] .* => greeter \(.+\)/
+  end
+  
+  specify "should provide various shorthand methods for simple responses but take custom response values" do
+    response = {:status => 200, :body => 'OK'}
+    @app.ok.should == response
+    @app.success.should == response
+    @app.standard_response.should == response
+    
+    @app.ok('').should == {:status => 200, :body => ''}
+    @app.ok(['OK', 'Sure Thang', 'Correcto']).should == {:status => 200, :body => ['OK', 'Sure Thang', 'Correcto']}
+  end
+  
+  specify "should handle requests and respond with JSON" do
+    body = JSON.parse(Rack::MockRequest.new(@app).get("/").body)
+    body['status'].should == 200
+    body['body'].should == "Found"
+  end
+  
+  specify "should handle requests with param values in the URL" do
+    body = JSON.parse(Rack::MockRequest.new(@app).get("/hello/Matt").body)
+    body['status'].should == 200
+    body['body'].should == "Hello Matt"
+  end
+  
+  specify "should route unmatchable requests to the default route and return JSON with appropriate status" do
+    body = JSON.parse(Rack::MockRequest.new(@app).get("/garbage/request/url").body)
+    body['status'].should == 404
+    body['body'].should == "Not Found"
+  end
+  
+  specify "should log activity" do
+    prev_line = File.new(@app.instance_variable_get("@config")[:log_file]).readlines.last
+    Rack::MockRequest.new(@app).get("/url/that/will/not/be/found/#{rand}")
+    last_line = File.new(@app.instance_variable_get("@config")[:log_file]).readlines.last
+    last_line.should =~ /INFO \[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\] \(\d+\) Specr#test :: \[404\] .* => not_found \(.+\)/
+    prev_line.should_not == last_line
+  end
+  
+  specify "should create a PID file while running with the correct process ID" do
+    pid_file = @app.instance_variable_get("@config")[:pid_file]
+    File.exist?(pid_file).should be_true
+    File.open(pid_file){|file|file.read.should == "#{$$}\n"}
+  end
+  
+  specify "should parse URI query params correctly" do
+    Rack::MockRequest.new(@app).get("/?query=value&lang=en-US")
+    @app.query_params.should == {'query' => 'value', 'lang' => 'en-US'}
+  end
+  
+  specify "should parse the URI correctly" do
+    Rack::MockRequest.new(@app).get("http://localhost:4000/slaughterhouse/5")
+    @app.uri.should == '/slaughterhouse/5'
+    
+    Rack::MockRequest.new(@app).get("/slaughterhouse/5")
+    @app.uri.should == '/slaughterhouse/5'
+    
+    Rack::MockRequest.new(@app).get("")
+    @app.uri.should == '/'
+  end
+  
+  specify "should provide a quick way to find out what method the request was performed using" do
+    Rack::MockRequest.new(@app).get("/#{rand}")
+    @app.method.should == :get
+    
+    Rack::MockRequest.new(@app).post("/#{rand}")
+    @app.method.should == :post
+    
+    Rack::MockRequest.new(@app).put("/#{rand}")
+    @app.method.should == :put
+    
+    Rack::MockRequest.new(@app).delete("/#{rand}")
+    @app.method.should == :delete
+  end
+  
+  specify "should deny all unacceptable requests" do
+    conf = @app.instance_variable_get("@config")
+    conf[:acceptable_requests] = Halcyon::Server::ACCEPTABLE_REQUESTS
+    
+    Rack::MockRequest.new(@app).put("/#{rand}")
+    @app.acceptable_request! rescue Halcyon::Exceptions::Base
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'halcyon/server'
+require 'rack/mock'
+
+$test = true
+
+class Specr < Halcyon::Server::Base
+  
+  route do |r|
+    r.match('/hello/:name').to(:action => 'greeter')
+    r.match('/').to(:action => 'index', :arbitrary => 'random')
+  end
+  
+  def index(params)
+    ok('Found')
+  end
+  
+  def greeter(params)
+    ok("Hello #{params[:name]}")
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: halcyon
 version: !ruby/object:Gem::Version 
-  version: 0.3.18
+  version: 0.3.22
 platform: ruby
 authors: 
 - Matt Todd
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2007-12-31 00:00:00 -05:00
+date: 2008-01-07 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,13 @@ extra_rdoc_files:
 files: 
 - lib
 - Rakefile
+- spec/halcyon
+- spec/halcyon/error_spec.rb
+- spec/halcyon/router_spec.rb
+- spec/halcyon/server_spec.rb
+- spec/SPEC
+- spec/SPEC.html
+- spec/spec_helper.rb
 - lib/halcyon
 - lib/halcyon/client
 - lib/halcyon/client/base.rb