halcyon 0.3.7

data/lib/halcyon/server/exceptions.rb

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

data/lib/halcyon/server/router.rb

@@ -0,0 +1,100 @@
+#--
+#  Created by Matt Todd on 2007-12-14.
+#  Copyright (c) 2007. All rights reserved.
+#++
+
+#--
+# dependencies
+#++
+
+begin
+  %w(rubygems merb/core_ext merb/router).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)
+        uri = env['REQUEST_URI']
+        
+        # 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
+          @@default_route
+        else
+          # params (including action and module if set) for the matching route
+          route[1]
+        end
+      end
+      
+    end
+  end
+end

data/lib/halcyon/support/hashext.rb

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

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: halcyon
+version: !ruby/object:Gem::Version 
+  version: 0.3.7
+platform: ruby
+authors: 
+- Matt Todd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2007-12-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.1
+    version: 
+description: A JSON App Server Framework
+email: chiology@gmail.com
+executables: 
+- halcyon
+extensions: []
+
+extra_rdoc_files: 
+- lib
+files: 
+- lib
+- Rakefile
+- lib/halcyon
+- lib/halcyon/client
+- lib/halcyon/client/base.rb
+- lib/halcyon/client/exceptions.rb
+- lib/halcyon/client/router.rb
+- lib/halcyon/client.rb
+- lib/halcyon/exceptions.rb
+- lib/halcyon/server
+- 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
+post_install_message: 
+rdoc_options: 
+- --all
+- --quiet
+- --op
+- rdoc
+- --line-numbers
+- --inline-source
+- --title
+- "\"Halcyon documentation\""
+- --exclude
+- "\"^(_darcs|spec|pkg)/\""
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: A JSON App Server Framework
+test_files: []
+