halcyon 0.4.0 → 0.5.0

data/lib/halcyon/server/exceptions.rb

@@ -1,41 +0,0 @@
-#--
-#  Created by Matt Todd on 2007-12-14.
-#  Copyright (c) 2007. All rights reserved.
-#++
-
-#--
-# module
-#++
-
-module Halcyon
-  class Server
-    class Base
-      module Exceptions #:nodoc:
-        
-        #--
-        # Exception classes
-        #++
-        
-        Halcyon::Exceptions::HTTP_ERROR_CODES.to_a.each do |http_error|
-          status, body = http_error
-          class_eval(
-            "class #{body.gsub(/( |\-)/,'')} < Halcyon::Exceptions::Base\n"+
-            "  def initialize(s=#{status}, e='#{body}')\n"+
-            "    super\n"+
-            "  end\n"+
-            "end"
-          );
-        end
-        
-        #--
-        # Exception Lookup
-        #++
-        
-        def self.lookup(status)
-          self.const_get(Halcyon::Exceptions::HTTP_ERROR_CODES[status].gsub(/( |\-)/,''))
-        end
-        
-      end
-    end
-  end
-end

data/lib/halcyon/server/router.rb

@@ -1,103 +0,0 @@
-#--
-#  Created by Matt Todd on 2007-12-14.
-#  Copyright (c) 2007. All rights reserved.
-#++
-
-#--
-# dependencies
-#++
-
-begin
-  %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
-
-#--
-# module
-#++
-
-module Halcyon
-  class Server
-    
-    # = Routing
-    # 
-    # Handles routing.
-    # 
-    # == Usage
-    # 
-    #   class Xy < Halcyon::Server::Base
-    #     route do |r|
-    #       r.match('/path/to/match').to(:action => 'do_stuff')
-    #       {:action => 'not_found'} # the default route
-    #     end
-    #     def do_stuff(params)
-    #       [200, {}, 'OK']
-    #     end
-    #   end
-    # 
-    # == Default Routes
-    # 
-    # Supplying a default route if none of the others match is good practice,
-    # but is unnecessary as the predefined route is always, automatically,
-    # going to contain a redirection to the +not_found+ method which already
-    # exists in Halcyon::Server::Base. This method is freely overwritable, and
-    # is recommended for those that wish to handle unroutable requests
-    # themselves.
-    # 
-    # In order to set a different default route, simply end the call to +route+
-    # with a hash containing the action (and optionally the module) to run.
-    # 
-    # == The Hard Work
-    # 
-    # The mechanics of the router are solely from the efforts of the Merb
-    # community. This functionality is completely ripped right out of Merb
-    # and makes it functional. All credit to them, and be sure to check out
-    # their great framework: if Halcyon isn't quite what you need, maybe Merb
-    # is.
-    # 
-    # http://merbivore.com/
-    class Router < Merb::Router
-      
-      # Retrieves the last value from the +route+ call in Halcyon::Server::Base
-      # and, if it's a Hash, sets it to +@@default_route+ to designate the
-      # failover route. If +route+ is not a Hash, though, the internal default
-      # should be used instead (as the last returned value is probably a Route
-      # object returned by the +r.match().to()+ call).
-      # 
-      # Used exclusively internally.
-      def self.default_to route
-        @@default_route = route.is_a?(Hash) ? route : {:action => 'not_found'}
-      end
-      
-      # Called internally by the Halcyon::Server::Base#call method to match
-      # the current request against the currently defined routes. Returns the
-      # params list defined in the +to+ routing definition, opting for the
-      # 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)
-        # 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(/\/+/, '/')
-        path = path[0..-2] if (path[-1] == ?/) && path.size > 1
-        req = Struct.new(:path, :method).new(path, env['REQUEST_METHOD'].downcase.to_sym)
-        
-        # perform match
-        route = self.match(req, {})
-        
-        # 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." if env['halcyon.logger'].is_a? Logger
-          @@default_route
-        else
-          # params (including action and module if set) for the matching route
-          route[1]
-        end
-      end
-      
-    end
-  end
-end

data/spec/halcyon/error_spec.rb

@@ -1,55 +0,0 @@
-describe "Halcyon::Server Errors" do
-  
-  before do
-    @app = Specr.new :port => 4000
-  end
-  
-  it "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
-  
-  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
-      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
-  
-  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
-      e.class.to_s.should == 'NotFound'
-    end
-  end
-  
-end

data/spec/halcyon/server_spec.rb

@@ -1,105 +0,0 @@
-describe "Halcyon::Server" do
-  
-  before do
-    @app = Specr.new :port => 4000
-  end
-  
-  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
-  
-  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
-    @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
-  
-  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
-  
-  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
-  
-  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
-  
-  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
-  end
-  
-  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.open(pid_file){|file|file.read.should == "#{$$}\n"}
-  end
-  
-  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'}
-  end
-  
-  it "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
-  
-  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
-    
-    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
-  
-  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).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