halcyon 0.4.0 → 0.5.0

data/AUTHORS

@@ -0,0 +1 @@
+* Matt Todd <chiology@gmail.com>

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Matt Todd <http://purl.org/net/maraby>.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+http://www.opensource.org/licenses/mit-license.php

data/README

@@ -0,0 +1,107 @@
+= Halcyon
+== JSON Application Framework
+
+A JSON Web Application Framework for developing lightweight applications
+interfaced via JSON-encoded HTTP requests. This is ideal for back end
+applications serving functionality for other applications.
+
+Halcyon consists of two parts, the server application and the client. The
+server application is similar to a Merb or Rails app, without the need for
+implementing views, and the client is used to facilitate talking to the
+application from other applications.
+
+
+== On Rack
+
+Halcyon is a Rack application, meaning that it can sit right along with any
+other Rack app, such as a Merb or Rails app, and can be manipulated by any
+kind of Rack middleware/filter. This means that interfacing with Halcyon in
+unconventional ways is trivial since the Rack specification makes communicating
+with Rack apps dead simple.
+
+
+== Development
+
+Halcyon is actively being developed by a very small community of developers and
+contributors. Halcyon has seen a good deal of paradigm shift up until the 0.5.0
+release, but with that release its internal API has stabilized and should
+remain fairly backwards compatible from here on.
+
+The changes made on the way to the 0.5.0 codebase were to remove all of the
+server-like code to make Halcyon more application-centric and also to model
+application development and structure to be more Rails- or Merb-like, though
+this was just the natural evolution of Halcyon's design.
+
+
+== Installation
+
+A Gem of Halcyon is available.  You can install it with:
+
+  $ sudo gem install halcyon
+
+The latest development release can be installed with RubyGems:
+
+  $ sudo gem install halcyon --source http://halcyon.rubyforge.org/latest/
+
+Alternatively, you can install the latest development efforts from the git
+repository, located at http://github.com/mtodd/halcyon:
+
+  $ git clone git://github.com/mtodd/halcyon.git
+  $ cd halcyon; rake install
+
+Don't forget to install the JSON gem for improved performance:
+
+  $ sudo gem install json
+
+More in depth documentation can be found at
+http://halcyon.rubyforge.org/docs/installation.html.
+
+
+== Usage
+
+After installing a Halcyon app, you can generate a new app, similar to the
+<tt>rails</tt> or <tt>merb-gen app</tt> commands, with this:
+
+  $ halcyon init app_name
+
+This will create a directory and generate a skeletal Halcyon application. You
+can run this application without changing anything; here's how:
+
+  $ cd app_name
+  $ halcyon start -p 4647
+
+A great tutorial to dive right into using Halcyon and writing apps is located
+at http://halcyon.rubyforge.org/docs/tutorial.html. This will step you through
+what to do, what to expect, and what it means.
+
+
+== Contact
+
+Please mail bugs, suggestions and patches to <mailto:chiology@gmail.com>.
+
+You are also welcome to join the #halcyon channel on irc.freenode.net.
+
+Our website is up so stop by and check out what's going down. Our address is
+http://halcyon.rubyforge.org/. On there you will find information about our
+mailing list as well, so do stop by.
+
+
+== Thanks To
+
+* Bill Marquette, typo correction, reviewing examples
+* Elliott Cable, missing dependency, Thin testing
+* ramstedt, Mongrel on JRuby port numericality issue (#14)
+* Ben Simpson, PHP Client bug fixes
+* Eivind Uggedal, dependencies for Router support of resources
+
+
+== Links
+
+Halcyon:: <http://halcyon.rubyforge.org/>
+Aurora:: <http://aurora.rubyforge.org/>
+
+Rack:: <http://rack.rubyforge.org/>
+Merb:: <http://merbivore.com/>
+JSON:: <http://json.rubyforge.org/>
+
+Matt Todd:: <http://maraby.org/>

data/Rakefile

@@ -4,7 +4,7 @@ $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "lib")))
 
 include FileUtils
 
-require 'lib/halcyon'
+require 'halcyon'
 
 project = {
   :name => "halcyon",
@@ -21,13 +21,14 @@ project = {
     --op rdoc
     --line-numbers
     --inline-source
-    --title "Halcyon\ Documentation"
+    --title "Halcyon\ API"
     --exclude "^(_darcs|spec|pkg|.svn)/"
   ],
   :dependencies => {
-    'json_pure' => '>=1.1.1',
-    'rack' => '>=0.2.0',
-    'merb' => '>=0.4.1'
+    'json_pure' => '>=1.1.2',
+    'rack' => '>=0.3.0',
+    'merb' => '>=0.9.2',
+    'rubigen' => '>=1.2.4'
   },
   :requirements => 'install the json gem to get faster JSON parsing',
   :ruby_version_required => '>=1.8.6'
@@ -37,6 +38,7 @@ BASEDIR = File.expand_path(File.dirname(__FILE__))
 
 spec = Gem::Specification.new do |s|
   s.name = project[:name]
+  s.rubyforge_project = project[:name]
   s.version = project[:version]
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
@@ -55,7 +57,7 @@ spec = Gem::Specification.new do |s|
   }
   s.requirements << project[:requirements]
   s.required_ruby_version = project[:ruby_version_required]
-  s.files = (project[:rdoc_files] + %w[Rakefile] + Dir["{spec,lib}/**/*"]).uniq
+  s.files = (project[:rdoc_files] + %w[Rakefile README LICENSE AUTHORS] + Dir["{spec,lib,example,support}/**/*"]).uniq
 end
 
 Rake::GemPackageTask.new(spec) do |p|

data/bin/halcyon

@@ -1,205 +1,4 @@
-#!/usr/bin/env ruby -wKU
-#--
-#  Created by Matt Todd on 2007-10-25.
-#  Copyright (c) 2007. All rights reserved.
-#++
+#!/usr/bin/env ruby
 
-# Blatantly stolen from Chris Neukirchen's rackup utility for running Rack
-# apps. (Forgive me, it just made too much sense to use your Rack bootstrap
-# code for my Rack bootstrap.)
-
-#--
-# dependencies
-#++
-
-%w(rubygems halcyon/server optparse).each{|dep|require dep}
-
-#--
-# default options
-#++
-
-$debug = false
-$test = false
-options = Halcyon::Server::DEFAULT_OPTIONS
-
-#--
-# parse options
-#++
-
-opts = OptionParser.new("", 24, '  ') do |opts|
-  opts.banner << "Halcyon, JSON Server Framework\n"
-  opts.banner << "http://halcyon.rubyforge.org/\n"
-  opts.banner << "\n"
-  opts.banner << "Usage: halcyon [options] appname\n"
-  opts.banner << "\n"
-  opts.banner << "Put -c or --config first otherwise it will overwrite higher precedence options."
-  
-  opts.separator ""
-  opts.separator "Options:"
-  
-  opts.on("-d", "--debug", "set debugging flag (set $debug to true)") { $debug = true }
-  opts.on("-D", "--Debug", "enable verbose debugging (set $debug and $DEBUG to true)") { $debug = true; $DEBUG = true }
-  opts.on("-w", "--warn", "turn warnings on for your script") { $-w = true }
-  
-  opts.on("-I", "--include PATH", "specify $LOAD_PATH (multiples OK)") do |path|
-    $:.unshift(*path.split(":"))
-  end
-  
-  opts.on("-r", "--require LIBRARY", "require the library, before executing your script") do |library|
-    require library
-  end
-  
-  opts.on("-c", "--config PATH", "load configuration (YAML) from PATH") do |conf_file|
-    if File.exist?(conf_file)
-      require 'yaml'
-      
-      # load the config file
-      begin
-        conf = YAML.load_file(conf_file)
-      rescue Errno::EACCES
-        abort("Can't access #{conf_file}, try 'sudo #{$0}'")
-      end
-      
-      # store config file path so SIGHUP and SIGUSR2 will reload the config in case it changes
-      options[:config_file] = conf_file
-      
-      # parse config
-      case conf
-      when String
-        # config file given was just the commandline options
-        ARGV.replace(conf.split)
-        opts.parse! ARGV
-      when Hash
-        conf.symbolize_keys!
-        options = options.merge(conf)
-      when Array
-        # TODO (MT) support multiple servers (or at least specifying which
-        # server's configuration to load)
-        warn "Your configuration file is setup for multiple servers. This is not a supported feature yet."
-        warn "However, we've pulled the first server entry as this server's configuration."
-        # an array of server configurations
-        # default to the first entry since multiple server configurations isn't
-        # precisely worked out yet.
-        options = options.merge(conf[0])
-      else
-        abort "Config file in an unsupported format. Config files must be YAML or the commandline flags"
-      end
-    else
-      abort "Config file failed to load. #{conf_file} was not found. Correct the path and try again."
-    end
-  end
-  
-  opts.on("-s", "--server SERVER", "serve using SERVER (default: #{options[:server]})") do |serv|
-    options[:server] = serv
-  end
-  
-  opts.on("-o", "--host HOST", "listen on HOST (default: #{options[:host]})") do |host|
-    options[:host] = host
-  end
-  
-  opts.on("-p", "--port PORT", "use PORT (default: #{options[:port]})") do |port|
-    options[:port] = port
-  end
-  
-  opts.on("-l", "--logfile PATH", "log access to PATH (default: #{options[:log_file]})") do |log_file|
-    options[:log_file] = log_file
-  end
-  
-  opts.on("-L", "--loglevel LEVEL", "log level (default: #{options[:log_level]})") do |log_file|
-    options[:log_level] = log_file
-  end
-  
-  opts.on("-P", "--pidfile PATH", "save PID to PATH (default: #{options[:pid_file]})") do |log_file|
-    options[:pid_file] = log_file
-  end
-  
-  opts.on("-e", "--env ENVIRONMENT", "use ENVIRONMENT for defaults (default: #{options[:environment]})") do |env|
-    options[:environment] = env
-  end
-  
-  opts.on_tail("-h", "--help", "Show this message") do
-    puts opts
-    exit
-  end
-  
-  opts.on_tail("-v", "--version", "Show version") do
-    # require 'halcyon'
-    puts "Halcyon #{Halcyon::Server.version}"
-    exit
-  end
-  
-  begin
-    opts.parse! ARGV
-  rescue OptionParser::InvalidOption => e
-    abort "You used an unsupported option. Try: halcyon -h"
-  end
-end
-
-abort "Halcyon needs an app to run. Try: halcyon -h" if ARGV.empty? 
-options[:app] = ARGV.shift
-
-#--
-# load app
-#++
-
-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
-  app = Object.const_get(appname)
-rescue NameError => e
-  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 = {
-    'cgi'     => 'CGI',
-    'fastcgi' => 'FastCGI',
-    'lsws'    => 'LSWS',
-    'mongrel' => 'Mongrel',
-    '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]])
-end
-
-#--
-# prepare app environment
-#++
-
-case options[:environment]
-when "development"
-  app = Rack::Builder.new {
-    use Rack::CommonLogger, STDERR  unless server.name =~ /CGI/
-    use Rack::ShowExceptions
-    use Rack::Reloader
-    use Rack::Lint
-    run app.new(options)
-  }.to_app
-when "deployment"
-  app = Rack::Builder.new {
-    use Rack::CommonLogger, STDERR  unless server.name =~ /CGI/
-    run app.new(options)
-  }.to_app
-else
-  app = app.new(options)
-end
-
-#--
-# start server
-#++
-
-server.run app, :Port => Integer(options[:port])
+require File.join(File.dirname(__FILE__), '..', 'lib', 'halcyon')
+Halcyon::Runner.run! ARGV

data/lib/halcyon.rb

@@ -1,54 +1,67 @@
-#!/usr/bin/env ruby
-#--
-#  Created by Matt Todd on 2007-12-14.
-#  Copyright (c) 2007. All rights reserved.
-#++
-
 $:.unshift File.dirname(__FILE__)
 
-#--
-# dependencies
-#++
-
-%w(rubygems merb/core_ext).each {|dep|require dep}
-
-#--
-# module
-#++
+%w(rubygems rack merb-core/core_ext merb-core/vendor/facets merb-core/dispatch/router json uri).each {|dep|require dep}
 
+# Provides global values, like the root of the current application directory,
+# the current logger, the application name, and the framework version.
+# 
+# Examples
+#   Halcyon.app #=> AppName
+#   Halcyon.root #=> Dir.pwd
+#   Halcyon.config #=> {:allow_from => :all, :logging => {...}, ...}
+#   Halcyon.paths #=> {:config => Halcyon.root/'config', ...}
+#   Halcyon.logger #=> #<Logger>
+#   Halcyon.version #=> "0.5.0"
 module Halcyon
-  VERSION = [0,4,0]
-  def self.version
-    VERSION.join('.')
-  end
   
-  # = Introduction
-  # 
-  # Halcyon is a JSON Web Server Framework intended to be used for fast, small
-  # data transactions, like for AJAX-intensive sites or for special services like
-  # authentication centralized for numerous web apps in the same cluster.
-  # 
-  # The possibilities are pretty limitless: the goal of Halcyon was simply to be
-  # lightweight, fast, simple to implement and use, and able to be extended.
-  # 
-  # == Usage
-  # 
-  # 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!"
-  end
+  VERSION = [0,5,0] unless defined?(Halcyon::VERSION)
   
-  #--
-  # Module Autoloading
-  #++
+  autoload :Application, 'halcyon/application'
+  autoload :Client, 'halcyon/client'
+  autoload :Controller, 'halcyon/controller'
+  autoload :Exceptions, 'halcyon/exceptions'
+  autoload :Logging, 'halcyon/logging'
+  autoload :Runner, 'halcyon/runner'
   
-  class Server
-    module Auth
-      autoload :Basic, 'halcyon/server/auth/basic'
+  class << self
+    
+    attr_accessor :app
+    attr_accessor :logger
+    attr_accessor :config
+    attr_accessor :paths
+    
+    def version
+      VERSION.join('.')
+    end
+    
+    # The root directory of the current application.
+    # 
+    # Returns String:root_directory
+    def root
+      self.config[:root] || Dir.pwd rescue Dir.pwd
     end
+    
+    def configurable(attribute)
+      eval <<-"end;"
+        def #{attribute.to_s}
+          Halcyon.config[:#{attribute.to_s}]
+        end
+        def #{attribute.to_s}=(value)
+          value = value.to_mash if value.is_a?(Hash)
+          Halcyon.config[:#{attribute.to_s}] = value
+        end
+      end;
+    end
+    alias_method :configurable_attr, :configurable
+    
   end
   
+  # Creates <tt>Halcyon.db</tt> to alias <tt>Halcyon.config[:db]</tt>.
+  # Also creates the complementary assignment method, <tt>Halcyon.db=</tt>
+  # that aliases <tt>Halcyon.config[:db]=</tt>.
+  configurable_attr :db
+  
 end
 
-%w(halcyon/exceptions).each {|dep|require dep}
+# Include the klass#logger and klass.logger accessor methods into Object.
+Object.send(:include, Halcyon::Logging::Helpers)