halcyon 0.3.22 → 0.4.0

data/Rakefile

@@ -78,17 +78,17 @@ 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"
+    sh "bacon -r~/lib/bacon/output -rlib/halcyon -rtest/spec_helper spec/**/* -s > spec/SPEC"
   end
   
   desc "run rspec"
   task :run do
-    sh "spec -c -rlib/halcyon -rspec/spec_helper spec/**/*"
+    sh "bacon -r~/lib/bacon/output -rlib/halcyon -rspec/spec_helper spec/**/* -o CTestUnit"
   end
   
   desc "run rspec verbosely"
   task :verb do
-    sh "spec -c -rlib/halcyon -rspec/spec_helper spec/**/* --format s"
+    sh "bacon -r~/lib/bacon/output -rlib/halcyon -rspec/spec_helper spec/**/* -o CSpecDox"
   end
 end
 

data/bin/halcyon

@@ -146,17 +146,22 @@ if !File.exists?("#{options[:app]}.rb")
   abort "Halcyon did not find the app #{options[:app]}. Check your path and try again."
 end
 
+require options[:app]
+appname = File.basename(options[:app]).capitalize.gsub(/_([a-z])/){|m|m[1].chr.capitalize}
 begin
-  require options[:app]
-  app = Object.const_get(File.basename(options[:app]).capitalize.gsub(/_([a-z])/){|m|m[1].chr.capitalize})
+  app = Object.const_get(appname)
 rescue NameError => e
-  abort "Unable to load #{File.basename(options[:app]).capitalize.gsub(/_([a-z])/){|m|m[1].chr.capitalize}}. Please ensure your server is so named."
+  abort "Unable to load #{appname}. Please ensure your server is so named."
 end
 
 #--
 # prepare server
 #++
 begin
+  # attempt to require the server
+  begin; require options[:server].capitalize; rescue LoadError; end
+  
+  # get the appropriate Rack Handler
   server = Rack::Handler.const_get(options[:server].capitalize)
 rescue NameError
   servers = {
@@ -164,7 +169,8 @@ rescue NameError
     'fastcgi' => 'FastCGI',
     'lsws'    => 'LSWS',
     'mongrel' => 'Mongrel',
-    'webrick' => 'WEBrick'
+    'webrick' => 'WEBrick',
+    'thin'    => 'Thin'
   }
   abort "Unsupported server (missing Rack Handler). Did you mean to specify #{options[:server]}?" unless servers.key? options[:server]
   server = Rack::Handler.const_get(servers[options[:server]])
@@ -196,4 +202,4 @@ end
 # start server
 #++
 
-server.run app, :Port => options[:port]
+server.run app, :Port => Integer(options[:port])

data/lib/halcyon.rb

@@ -10,18 +10,14 @@ $:.unshift File.dirname(__FILE__)
 # dependencies
 #++
 
-%w(halcyon/support/hashext).each {|dep|require dep}
-
-class Hash
-  include HashExt::Keys
-end
+%w(rubygems merb/core_ext).each {|dep|require dep}
 
 #--
 # module
 #++
 
 module Halcyon
-  VERSION = [0,3,22]
+  VERSION = [0,4,0]
   def self.version
     VERSION.join('.')
   end
@@ -43,6 +39,16 @@ module Halcyon
     abort "READ THE DAMNED RDOCS!"
   end
   
+  #--
+  # Module Autoloading
+  #++
+  
+  class Server
+    module Auth
+      autoload :Basic, 'halcyon/server/auth/basic'
+    end
+  end
+  
 end
 
 %w(halcyon/exceptions).each {|dep|require dep}

data/lib/halcyon/client/base.rb

@@ -176,37 +176,29 @@ module Halcyon
       #++
       
       # Performs a GET request on the URI specified.
-      def get(uri)
+      def get(uri, headers={})
         req = Net::HTTP::Get.new(uri)
-        req["Content-Type"] = CONTENT_TYPE
-        req["User-Agent"] = USER_AGENT
-        request(req)
+        request(req, headers)
       end
       
       # Performs a POST request on the URI specified.
-      def post(uri, data)
+      def post(uri, data, headers={})
         req = Net::HTTP::Post.new(uri)
-        req["Content-Type"] = CONTENT_TYPE
-        req["User-Agent"] = USER_AGENT
         req.body = format_body(data)
-        request(req)
+        request(req, headers)
       end
       
       # Performs a DELETE request on the URI specified.
-      def delete(uri)
+      def delete(uri, headers={})
         req = Net::HTTP::Delete.new(uri)
-        req["Content-Type"] = CONTENT_TYPE
-        req["User-Agent"] = USER_AGENT
-        request(req)
+        request(req, headers)
       end
       
       # Performs a PUT request on the URI specified.
-      def put(uri, data)
+      def put(uri, data, headers={})
         req = Net::HTTP::Put.new(uri)
-        req["Content-Type"] = CONTENT_TYPE
-        req["User-Agent"] = USER_AGENT
         req.body = format_body(data)
-        request(req)
+        request(req, headers)
       end
       
     private
@@ -223,13 +215,26 @@ module Halcyon
       # (defined in Halcyon::Exceptions) which all inherit from
       # +Halcyon::Exceptions::Base+. It is up to the client to handle these
       # exceptions specifically.
-      def request(req)
+      def request(req, headers={})
+        # define essential headers for Halcyon::Server's picky requirements
+        req["Content-Type"] = CONTENT_TYPE
+        req["User-Agent"] = USER_AGENT
+        
+        # apply provided headers
+        headers.each do |pair|
+          header, value = pair
+          req[header] = value
+        end
+        
+        # provide hook for modifying the headers
+        req = headers(req) if respond_to? :headers
+        
         # prepare and send HTTP request
         res = Net::HTTP.start(@uri.host, @uri.port) {|http|http.request(req)}
         
         # parse response
         body = JSON.parse(res.body)
-        body.symbolize_keys! if body.respond_to? :symbolize_keys!
+        body.symbolize_keys!
         
         # handle non-successes
         raise Halcyon::Client::Base::Exceptions.lookup(body[:status]).new unless res.kind_of? Net::HTTPSuccess
@@ -245,7 +250,9 @@ module Halcyon
       # format according to Net::HTTP for sending through as a Hash.
       def format_body(data)
         data = {:body => data} unless data.is_a? Hash
-        data.map{|key,value|"&#{key}=#{value}&"}.join
+        data.symbolize_keys!
+        # uses the Merb Hash#to_params method defined in merb/core_ext.
+        data.to_params
       end
       
     end

data/lib/halcyon/client/exceptions.rb

@@ -21,7 +21,7 @@ module Halcyon
           class_eval(
             "class #{body.gsub(/( |\-)/,'')} < Halcyon::Exceptions::Base\n"+
             "  def initialize(s=#{status}, e='#{body}')\n"+
-            "    super s, e\n"+
+            "    super\n"+
             "  end\n"+
             "end"
           );

data/lib/halcyon/exceptions.rb

@@ -19,6 +19,7 @@ module Halcyon
       def initialize(status, error)
         @status = status
         @error = error
+        super "[#{@status}] #{@error}"
       end
     end
     

data/lib/halcyon/server/auth/basic.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+#--
+#  Created by Matt Todd on 2008-01-16.
+#  Copyright (c) 2008. All rights reserved.
+#++
+
+#--
+# module
+#++
+
+module Halcyon
+  class Server
+    module Auth
+      
+      # = Introduction
+      # 
+      # The Auth::Basic class provides an alternative to the Server::Base
+      # class for creating servers with HTTP Basic Authentication built in.
+      # 
+      # == Usage
+      # 
+      # In order to provide for HTTP Basic Authentication in your server,
+      # it would first need to inherit from this class instead of Server::Base
+      # and then provide a method to check for the existence of the credentials
+      # and respond accordingly. This looks like the following:
+      # 
+      #   class AuthenticatedApp < Halcyon::Server::Auth::Basic
+      #     def basic_authorization(username, password)
+      #       [username, password] == ['rupert', 'secret']
+      #     end
+      #     # write normal Halcyon server app here
+      #   end
+      # 
+      # The credentials passed to the +basic_authorization+ method are pulled
+      # from the appropriate Authorization header value and parsed from the
+      # base64 values. If no Authorization header value is passed, an exception
+      # is thrown resulting in the appropriate response to the client.
+      class Basic < Server::Base
+        
+        AUTHORIZATION_KEYS = ['HTTP_AUTHORIZATION', 'X-HTTP_AUTHORIZATION', 'X_HTTP_AUTHORIZATION']
+        
+        # Determines the appropriate HTTP Authorization header to refer to when
+        # plucking out the header for processing.
+        def authorization_key
+          @authorization_key ||= AUTHORIZATION_KEYS.detect{|k|@env.has_key?(k)}
+        end
+        
+        alias :_run :run
+        
+        # Ensures that the HTTP Authentication header is included, the Basic
+        # scheme is being used, and the credentials pass the +basic_auth+
+        # test. If any of these fail, an Unauthorized exception is raised
+        # (except for non-Basic schemes), otherwise the +route+ is +run+
+        # normally.
+        # 
+        # See the documentation for the +basic_auth+ class method for details
+        # concerning the credentials and action inclusion/exclusion.
+        def run(route)
+          # test credentials if the action is one specified to be tested
+          if ((@@auth[:except].nil? && @@auth[:only].nil?) || # the default is to test if no restrictions
+            (!@@auth[:only].nil? && @@auth[:only].include?(route[:action].to_sym)) || # but if the action is in the :only directive, test
+            (!@@auth[:except].nil? && !@@auth[:except].include?(route[:action].to_sym))) # or if the action is not in the :except directive, test
+            
+            # make sure there's an authorization header
+            raise Base::Exceptions::Unauthorized.new unless !authorization_key.nil?
+            
+            # make sure the request is via the Basic protocol
+            scheme = @env[authorization_key].split.first.downcase.to_sym
+            raise Base::Exceptions::BadRequest.new unless scheme == :basic
+            
+            # make sure the credentials pass the test
+            credentials = @env[authorization_key].split.last.unpack("m*").first.split(':', 2)
+            raise Base::Exceptions::Unauthorized.new unless @@auth[:method].call(*credentials)
+          end
+          
+          # success, so run the route normally
+          _run(route)
+        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
+        
+        # Provides a way to define a test as well as set limits on what is
+        # tested for Basic Authorization. This method should be called in the
+        # definition of the server. A simple example would look like:
+        # 
+        #   class Servr < Halcyon::Server::Auth::Basic
+        #     basic_auth :only => [:grant] do |user, pass|
+        #       # test credentials
+        #     end
+        #     # routes and actions follow...
+        #   end
+        # 
+        # Two acceptable options include <tt>:only</tt> and <tt>:except</tt>.
+        def self.basic_auth(options={}, &proc)
+          instance_eval do
+            @@auth = options.merge(:method => proc)
+          end
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/halcyon/server/base.rb

@@ -17,10 +17,11 @@ module Halcyon
   class Server
     
     DEFAULT_OPTIONS = {
+      :root => Dir.pwd,
       :environment => 'none',
       :port => 9267,
       :host => 'localhost',
-      :server => 'mongrel',
+      :server => Gem.searcher.find('thin').nil? ? 'mongrel' : 'thin',
       :pid_file => '/var/run/halcyon.{server}.{app}.{port}.pid',
       :log_file => '/var/log/halcyon.{app}.log',
       :log_level => 'info',
@@ -66,8 +67,8 @@ module Halcyon
     #   end
     # 
     # Two routes are (effectively) defined here, the first being to watch for
-    # all requests in the format +/hello/:name+ where the word pattern is
-    # stored and transmitted as the appropriate keys in the params hash.
+    # all requests in the format <tt>/hello/:name</tt> where the word pattern
+    # is stored and transmitted as the appropriate keys in the params hash.
     # 
     # Once we've got our inputs specified, we can start to handle requests:
     # 
@@ -76,18 +77,18 @@ module Halcyon
     #       r.match('/hello/:name').to(:action => 'greet')
     #       {:action => 'not_found'} # default route
     #     end
-    #     def greet(p); {:status=>200, :body=>"Hi #{p[:name]}"}; end
+    #     def greet; {:status=>200, :body=>"Hi #{params[:name]}"}; end
     #   end
     # 
     # You will notice that we only define the method +greet+ and that it
     # returns a Hash object containing a +status+ code and +body+ content.
     # This is the most basic way to send data, but if all you're doing is
     # replying that the request was successful and you have data to return,
-    # the method +ok+ (an alias of +standard_response+) with the +body+ param
-    # as its sole parameter is sufficient.
+    # the method +ok+ (an alias of <tt>standard_response</tt>) with the +body+
+    # param as its sole parameter is sufficient.
     # 
     # 
-    #   def greet(p); ok("Hi #{p[:name]}"); end
+    #   def greet; ok("Hi #{params[:name]}"); end
     # 
     # You'll also notice that there's no method called +not_found+; this is
     # because it is already defined and behaves almost exactly like the +ok+
@@ -99,9 +100,13 @@ module Halcyon
     # route actually matches, so it doesn't need any of the extra path to match
     # against.
     # 
+    # Lastly, the use of +params+ inside the method is simply a method call
+    # to a hash of the parameters gleaned from the route, such as +:name+ or
+    # any other variables passed to it.
+    # 
     # == The Filesystem
     # 
-    # It's important to note that the +halcyon+ commandline tool expects the to
+    # It's important to note that the +halcyon+ commandline tool expects to
     # find your server inheriting +Halcyon::Server::Base+ with the same exact
     # name as its filename, though with special rules.
     # 
@@ -109,7 +114,8 @@ module Halcyon
     # that your server's class name be +AppServer+ as it capitalizes each word
     # and removes all underscores, etc.
     # 
-    # Keep this in mind when naming your class and your file.
+    # Keep this in mind when naming your class and your file, though this
+    # restriction is only temporary.
     # 
     # NOTE: This really isn't a necessary step if you write your own deployment
     # script instead of using the +halcyon+ commandline tool (as it is simply
@@ -175,11 +181,11 @@ module Halcyon
       # Most of your requests will have all the data it needs inside of the
       # +params+ you receive for your action, but for POST and PUT requests
       # (you are being RESTful, right?) you will need to retrieve your data
-      # from the +POST+ property of the +@req+ request. Here's how:
+      # from the method +post+. Here's how:
       # 
-      #   @req.POST['key'] => "value"
+      #   post[:key] => "value"
       # 
-      # As you can see, keys specifically are strings and values as well. What
+      # As you can see, keys specifically are symbols and values as well. What
       # this means is that your POST data that you send to the server needs to
       # be careful to provide a flat Hash (if anything other than a Hash is
       # passed, it is packed up into a hash similar to +{:body=>data}+) or at
@@ -188,7 +194,7 @@ module Halcyon
       # (though this could change). Here's how you would reconstruct your
       # special hash:
       # 
-      #   value = JSON.parse(@req.POST['key'])
+      #   value = JSON.parse(post[:key])
       # 
       # That will take care of reconstructing your Hash.
       # 
@@ -253,7 +259,7 @@ module Halcyon
       # that a proper JSON response may be rendered by +call+.
       # 
       # With this in mind, it is preferred that, for any errors that should
-      # result in a given HTTP Response code other than 200, an appropriate
+      # result in a given HTTP Response code other than 2xx, an appropriate
       # exception should be thrown which is then handled by this method's
       # rescue clause.
       # 
@@ -309,32 +315,37 @@ module Halcyon
       # requests.
       # 
       # It is preferred for these methods to throw Exceptions::Base exceptions
-      # (or one of its inheriters) instead of handling them manually.
+      # (or one of its inheriters) instead of handling them manually. This
+      # ensures that the actual action is not run when in fact it shouldn't,
+      # otherwise you could be allowing unauthenticated users privileged
+      # information or allowing them to perform destructive actions.
       def run(route)
         # make sure the request meets our expectations
         acceptable_request! unless $debug || $test
         
         # pull params
-        params = route.reject{|key, val| [:action, :module].include? key}
-        params.merge!(query_params)
+        @params = route.reject{|key, val| [:action, :module].include? key}
+        @params.merge!(query_params)
         
         # pre call hook
-        before_call(route, params) if respond_to? :before_call
+        before_call if respond_to? :before_call
         
         # handle module actions differently than non-module actions
         if route[:module].nil?
           # call action
-          res = send(route[:action], params)
+          res = send(route[:action])
         else
           # call module action
           mod = self.dup
           mod.instance_eval(&(@@modules[route[:module].to_sym]))
-          res = mod.send(route[:action], params)
+          res = mod.send(route[:action])
         end
         
         # after call hook
         after_call if respond_to? :after_call
         
+        @params = {}
+        
         res
       rescue Halcyon::Exceptions::Base => e
         @logger.warn "#{uri} => #{e.error}"
@@ -399,8 +410,13 @@ module Halcyon
         @pid = File.new(@config[:pid_file].gsub('{n}', server_cluster_number), "w", 0644)
         @pid << "#{$$}\n"; @pid.close
         
-        # log existence and ready status
+        # log existence
         @logger.info "PID file created. PID is #{$$}."
+        
+        # call startup callback if defined
+        startup if respond_to? :startup
+        
+        # log ready state
         @logger.info "Started. Awaiting connectivity. Listening on #{@config[:port]}..."
         
         # trap signals to die (when killed by the user) gracefully
@@ -424,7 +440,13 @@ module Halcyon
       
       # Closes the logger and deletes the PID file.
       def clean_up
+        # don't try to clean up what's cleaned up already
         return if defined? @cleaned_up
+        
+        # run shutdown hook if defined
+        shutdown if respond_to? :shutdown
+        
+        # close logger, delete PID file, flag clean state
         @logger.close
         File.delete(@pid.path) if File.exist?(@pid.path)
         @cleaned_up = true
@@ -528,12 +550,12 @@ module Halcyon
       # 
       # The accepted level values are as follows:
       # 
-      #   debug
-      #   info
-      #   warn
-      #   error
-      #   fatal
-      #   unknown
+      # * debug
+      # * info
+      # * warn
+      # * error
+      # * fatal
+      # * unknown
       # 
       # These are the exact way you can refer to the logger level you'd like to
       # log at from all points of option specification (listed above in order
@@ -694,9 +716,14 @@ module Halcyon
         raise Exceptions::NotFound.new(404, body)
       end
       
+      # Returns the params of the current request, set in the +run+ method.
+      def params
+        @params
+      end
+      
       # Returns the params following the ? in a given URL as a hash
       def query_params
-        @env['QUERY_STRING'].split(/&/).inject({}){|h,kp| k,v = kp.split(/=/); h[k] = v; h}
+        @env['QUERY_STRING'].split(/&/).inject({}){|h,kp| k,v = kp.split(/=/); h[k] = v; h}.symbolize_keys!
       end
       
       # Returns the URI requested
@@ -706,11 +733,41 @@ module Halcyon
         URI.parse(@env['REQUEST_URI'] || @env['PATH_INFO']).path
       end
       
-      # Returns the Request Method as a lowercase symbol
+      # Returns the Request Method as a lowercase symbol.
+      # 
+      # One useful situation for this method would be similar to this:
+      # 
+      #   case method
+      #   when :get
+      #     # perform reading operations
+      #   when :post
+      #     # perform updating operations
+      #   when :put
+      #     # perform creating operations
+      #   when :delete
+      #     # perform deleting options
+      #   end
+      # 
+      # It can also be used in many other cases, like throwing an exception if
+      # an action is called with an unexpected method.
       def method
         @env['REQUEST_METHOD'].downcase.to_sym
       end
       
+      # Returns the POST data hash, making the keys symbols first.
+      # 
+      # Use like <tt>post[:post_param]</tt>.
+      def post
+        @req.POST.symbolize_keys!
+      end
+      
+      # Returns the GET data hash, making the keys symbols first.
+      # 
+      # Use like <tt>get[:get_param]</tt>.
+      def get
+        @req.GET.symbolize_keys!
+      end
+      
     end
     
   end

data/lib/halcyon/server/exceptions.rb

@@ -21,7 +21,7 @@ module Halcyon
           class_eval(
             "class #{body.gsub(/( |\-)/,'')} < Halcyon::Exceptions::Base\n"+
             "  def initialize(s=#{status}, e='#{body}')\n"+
-            "    super s, e\n"+
+            "    super\n"+
             "  end\n"+
             "end"
           );

data/lib/halcyon/server/router.rb

@@ -8,7 +8,7 @@
 #++
 
 begin
-  %w(rubygems merb/core_ext merb/router).each {|dep|require dep}
+  %w(rubygems merb/core_ext merb/router uri).each {|dep|require dep}
 rescue LoadError => e
   abort "Merb must be installed for Routing to function. Please install Merb."
 end

data/spec/halcyon/error_spec.rb

@@ -1,10 +1,10 @@
-context "Halcyon::Server Errors" do
+describe "Halcyon::Server Errors" do
   
-  before(:each) do
+  before do
     @app = Specr.new :port => 4000
   end
   
-  specify "should provide shorthand methods for errors which should throw an appropriate exception" do
+  it "should provide shorthand methods for errors which should throw an appropriate exception" do
     begin
       @app.not_found
     rescue Halcyon::Exceptions::Base => e
@@ -20,7 +20,7 @@ context "Halcyon::Server Errors" do
     end
   end
   
-  specify "supports numerous standard HTTP request error exceptions with lookup by status code" do
+  it "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
@@ -44,7 +44,7 @@ context "Halcyon::Server Errors" do
     end
   end
   
-  specify "should have a short inheritence chain to make catching generically simple" do
+  it "should have a short inheritence chain to make catching generically simple" do
     begin
       Halcyon::Server::Base::Exceptions::NotFound.new
     rescue Halcon::Exceptions::Base => e

data/spec/halcyon/router_spec.rb

@@ -1,31 +1,31 @@
-context "Halcyon::Server::Router" do
+describe "Halcyon::Server::Router" do
   
-  before(:each) do
+  before do
     @app = Specr.new :port => 4000
   end
   
-  specify "should prepares routes correctly when written correctly" do
+  it "should prepares routes correctly when written correctly" do
     # routes have been defined for Specr
-    Halcyon::Server::Router.routes.should_not == []
+    Halcyon::Server::Router.routes.should.not == []
     Halcyon::Server::Router.routes.length.should > 0
   end
   
-  specify "should match URIs to the correct route" do
+  it "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
+  it "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
+  it "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
+  it "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
   

data/spec/halcyon/server_spec.rb

@@ -1,16 +1,16 @@
-context "Halcyon::Server" do
+describe "Halcyon::Server" do
   
-  before(:each) do
+  before do
     @app = Specr.new :port => 4000
   end
   
-  specify "should dispatch methods according to their respective routes" do
+  it "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
+  it "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
@@ -20,44 +20,44 @@ context "Halcyon::Server" do
     @app.ok(['OK', 'Sure Thang', 'Correcto']).should == {:status => 200, :body => ['OK', 'Sure Thang', 'Correcto']}
   end
   
-  specify "should handle requests and respond with JSON" do
+  it "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
+  it "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
+  it "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
+  it "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
+    prev_line.should.not == last_line
   end
   
-  specify "should create a PID file while running with the correct process ID" do
+  it "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.exist?(pid_file).should.be.true?
     File.open(pid_file){|file|file.read.should == "#{$$}\n"}
   end
   
-  specify "should parse URI query params correctly" do
+  it "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'}
+    @app.query_params.should == {:query => 'value', :lang => 'en-US'}
   end
   
-  specify "should parse the URI correctly" do
+  it "should parse the URI correctly" do
     Rack::MockRequest.new(@app).get("http://localhost:4000/slaughterhouse/5")
     @app.uri.should == '/slaughterhouse/5'
     
@@ -68,7 +68,7 @@ context "Halcyon::Server" do
     @app.uri.should == '/'
   end
   
-  specify "should provide a quick way to find out what method the request was performed using" do
+  it "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
     
@@ -82,12 +82,24 @@ context "Halcyon::Server" do
     @app.method.should == :delete
   end
   
-  specify "should deny all unacceptable requests" do
+  it "should provide convenient access to GET and POST data" do
+    Rack::MockRequest.new(@app).get("/#{rand}?foo=bar")
+    @app.get[:foo].should == 'bar'
+    
+    Rack::MockRequest.new(@app).post("/#{rand}", :input => {:foo => 'bar'}.to_params)
+    @app.post[:foo].should == 'bar'
+  end
+  
+  it "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}")
+    Rack::MockRequest.new(@app).get("/#{rand}")
     @app.acceptable_request! rescue Halcyon::Exceptions::Base
   end
   
+  it "should record the correct environment details" do
+    @app.instance_eval { @config[:root].should == Dir.pwd }
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: halcyon
 version: !ruby/object:Gem::Version 
-  version: 0.3.22
+  version: 0.4.0
 platform: ruby
 authors: 
 - Matt Todd
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-07 00:00:00 -05:00
+date: 2008-02-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,8 +54,6 @@ files:
 - 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
@@ -65,12 +63,12 @@ files:
 - lib/halcyon/client.rb
 - lib/halcyon/exceptions.rb
 - lib/halcyon/server
+- lib/halcyon/server/auth
+- lib/halcyon/server/auth/basic.rb
 - lib/halcyon/server/base.rb
 - lib/halcyon/server/exceptions.rb
 - lib/halcyon/server/router.rb
 - lib/halcyon/server.rb
-- lib/halcyon/support
-- lib/halcyon/support/hashext.rb
 - lib/halcyon.rb
 has_rdoc: true
 homepage: http://halcyon.rubyforge.org

data/lib/halcyon/support/hashext.rb

@@ -1,59 +0,0 @@
-# Pulled out from http://dev.rubyonrails.org/browser/trunk/activesupport/lib/active_support/core_ext/hash/keys.rb
-module HashExt #:nodoc:
-  module Keys #:nodoc:
-    # Return a new hash with all keys converted to strings.
-    def stringify_keys
-      inject({}) do |options, (key, value)|
-        options[key.to_s] = value
-        options
-      end
-    end
-    
-    # Destructively convert all keys to strings.
-    def stringify_keys!
-      keys.each do |key|
-        unless key.class.to_s == "String" # weird hack to make the tests run when string_ext_test.rb is also running
-          self[key.to_s] = self[key]
-          delete(key)
-        end
-      end
-      self
-    end
-    
-    # Return a new hash with all keys converted to symbols.
-    def symbolize_keys
-      inject({}) do |options, (key, value)|
-        value = value.symbolize_keys if value.respond_to? :symbolize_keys # recursive # MT 2007-12-04
-        options[key.to_sym || key] = value
-        options
-      end
-    end
-    
-    # Destructively convert all keys to symbols.
-    def symbolize_keys!
-      keys.each do |key|
-        unless key.is_a?(Symbol) || (new_key = key.to_sym).nil?
-          self[new_key] = self[key]
-          self[new_key].symbolize_keys! if self[new_key].respond_to? :symbolize_keys!
-          delete(key)
-        end
-      end
-      self
-    end
-    
-    alias_method :to_options,  :symbolize_keys
-    alias_method :to_options!, :symbolize_keys!
-    
-    # Validate all keys in a hash match *valid keys, raising ArgumentError on a mismatch.
-    # Note that keys are NOT treated indifferently, meaning if you use strings for keys but assert symbol
-    # as keys, this will fail.
-    # examples:
-    #   { :name => "Rob", :years => "28" }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key(s): years"
-    #   { :name => "Rob", :age => "28" }.assert_valid_keys("name", "age") # => raises "ArgumentError: Unknown key(s): years, name"
-    #   { :name => "Rob", :age => "28" }.assert_valid_keys(:name, :age) # => passes, raises nothing
-    def assert_valid_keys(*valid_keys)
-      unknown_keys = keys - [valid_keys].flatten
-      raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
-    end
-  end
-end

data/spec/SPEC

@@ -1,29 +0,0 @@
-
-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

@@ -1,237 +0,0 @@
-<?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>