aurora 0.0.1 → 0.1.10

data/Rakefile

@@ -1,4 +1,150 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "lib")))
+
+%w(rubygems rake rake/clean rake/packagetask rake/gempackagetask rake/rdoctask rake/contrib/rubyforgepublisher fileutils pp).each{|dep|require dep}
+
+include FileUtils
+
+require 'lib/aurora'
+
+project = {
+  :name => "aurora",
+  :version => Aurora.version,
+  :author => "Matt Todd",
+  :email => "chiology@gmail.com",
+  :description => "A Simple Authentication Server",
+  :homepath => 'http://aurora.rubyforge.org',
+  :bin_files => %w(aurora),
+  :rdoc_files => %w(lib),
+  :rdoc_opts => %w[
+    --all
+    --quiet
+    --op rdoc
+    --line-numbers
+    --inline-source
+    --title "Aurora\ Documentation"
+    --exclude "^(_darcs|test|pkg|.svn)/"
+  ],
+  :dependencies => {
+    'halcyon' => '>=0.3.28'
+  },
+  :requirements => '',
+  :ruby_version_required => '>=1.8.6'
+}
+
+BASEDIR = File.expand_path(File.dirname(__FILE__))
+
+spec = Gem::Specification.new do |s|
+  s.name = project[:name]
+  s.version = project[:version]
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = project[:rdoc_files]
+  s.rdoc_options += project[:rdoc_opts]
+  s.summary = project[:description]
+  s.description = project[:description]
+  s.author = project[:author]
+  s.email = project[:email]
+  s.homepage = project[:homepath]
+  s.executables = project[:bin_files]
+  s.bindir = "bin"
+  s.require_path = "lib"
+  project[:dependencies].each{|dep|
+    s.add_dependency(dep[0], dep[1])
+  }
+  s.requirements << project[:requirements]
+  s.required_ruby_version = project[:ruby_version_required]
+  s.files = (project[:rdoc_files] + %w[Rakefile] + Dir["{test,lib}/**/*"]).uniq
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_zip = true
+  p.need_tar = true
+end
+
+desc "Package and Install aurora"
+task :install do
+  name = "#{project[:name]}-#{project[:version]}.gem"
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{name}}
+end
+
+desc "Uninstall the aurora gem"
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{project[:name]}}
+end
+
+namespace 'spec' do
+  desc "generate spec"
+  task :gen do
+    sh "bacon -rlib/aurora -rtest/spec_helper test/**/* -s > test/SPEC"
+  end
+  
+  desc "run rspec"
+  task :run do
+    sh "bacon -r~/lib/bacon/output -rlib/aurora -rtest/spec_helper test/**/* -o CTestUnit"
+  end
+  
+  desc "run rspec verbosely"
+  task :verb do
+    sh "bacon -r~/lib/bacon/output -rlib/aurora -rtest/spec_helper test/**/* -o CSpecDox"
+  end
+end
+
+desc "Do predistribution stuff"
+task :predist => [:chmod, :changelog, :manifest, :rdoc]
+
+def manifest
+  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"
+task :chmod do
+  Dir["bin/*"].each { |binary| File.chmod(0775, binary) }
+  Dir["test/cgi/test*"].each { |binary| File.chmod(0775, binary) }
+end
+
+desc "Generate a MANIFEST"
+task :manifest do
+  manifest
+end
+
+desc "Generate a CHANGELOG"
+task :changelog do
+  sh "svn log > CHANGELOG"
+end
+
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' << 'Aurora Documentation' <<
+    '--charset' << 'utf-8'
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include 'README'
+  rdoc.rdoc_files.include('lib/aurora.rb')
+  rdoc.rdoc_files.include('lib/aurora/*.rb')
+  rdoc.rdoc_files.include('lib/aurora/*/*.rb')
+end
+
+task :pushsite => [:rdoc] do
+  sh "rsync -avz doc/ mtodd@aurora.rubyforge.org:/var/www/gforge-projects/aurora/doc/"
+  sh "rsync -avz site/ mtodd@aurora.rubyforge.org:/var/www/gforge-projects/aurora/"
+end
+
+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/aurora

@@ -0,0 +1,250 @@
+#!/usr/bin/env ruby -KU
+#--
+#  Created by Matt Todd on 2008-01-13.
+#  Copyright (c) 2007. All rights reserved.
+#++
+
+$:.unshift(File.join(File.dirname(__FILE__),'lib'))
+
+#--
+# dependencies
+#++
+
+%w(rubygems halcyon/server aurora/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 << "Aurora Simple Authentication Server\n"
+  opts.banner << "http://aurora.rubyforge.org/\n"
+  opts.banner << "\n"
+  opts.banner << "Usage: aurora [-c config/file.yml] [options] appname\n"
+  opts.banner << "\n"
+  opts.banner << "Put -c or --config first otherwise it will overwrite higher precedence options."
+  
+  opts.separator ""
+  opts.separator "Ruby 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.separator ""
+  opts.separator "Config file:"
+  
+  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 => e
+        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.separator ""
+  opts.separator "Options:"
+  
+  opts.on("-b", "--background", "process in the background (daemonize)") {$daemonize = true}
+  
+  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.separator ""
+  
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+  
+  opts.on_tail("-v", "--version", "Show version") do
+    puts "Aurora v#{Aurora.version}"
+    exit
+  end
+  
+  begin
+    opts.parse! ARGV
+  rescue OptionParser::InvalidOption => e
+    abort "You used an unsupported option. Try: aurora -h"
+  end
+end
+
+abort "Aurora needs an authenticating app to run. Try: aurora -h" if ARGV.empty? 
+options[:app] = ARGV.shift
+
+#--
+# load app
+#++
+
+begin
+  # go ahead and try to require since it could be a gem
+  require options[:app]
+rescue
+  if !File.exists?("#{options[:app]}.rb")
+    abort "Aurora did not find the app #{options[:app]}. Check your path and try again."
+  end
+end
+
+begin
+  appname = 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 #{appname}. Please ensure your server is so named."
+end
+
+#--
+# prepare server
+#++
+begin
+  server = Rack::Handler.const_get(options[:server].capitalize)
+rescue NameError
+  servers = {
+    'cgi'     => 'CGI',
+    'fastcgi' => 'FastCGI',
+    'lsws'    => 'LSWS',
+    'mongrel' => 'Mongrel',
+    'webrick' => 'WEBrick'
+  }
+  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
+
+#--
+# daemonization
+#++
+
+if $daemonize
+  fork do
+    require 'daemons'
+    Daemonize.daemonize
+    
+    #--
+    # 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 => options[:port]
+  end
+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 => options[:port] unless $daemonize

data/lib/aurora.rb

@@ -1,5 +1,40 @@
+#!/usr/bin/env ruby
+#--
+#  Created by Matt Todd on 2007-12-14.
+#  Copyright (c) 2007. All rights reserved.
+#++
+
 $:.unshift File.dirname(__FILE__)
 
+#--
+# module
+#++
+
 module Aurora
-  #
+  VERSION = [0,1,10]
+  def self.version
+    VERSION.join('.')
+  end
+  
+  # = Introduction
+  # 
+  # Aurora is a simple authentication server. Built on Halcyon, it 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 Aurora was simply to be
+  # lightweight, fast, simple to implement and use, and able to be extended.
+  # 
+  # == Usage
+  # 
+  # For documentation on using Aurora, check out the Aurora::Server and
+  # Aurora::Client classes which contain much more usage documentation.
+  def introduction
+    abort "READ THE DAMNED RDOCS!"
+  end
+  
+  autoload :Server, 'aurora/server'
+  autoload :Client, 'aurora/client'
+  
 end

data/lib/aurora/client.rb

@@ -1,22 +1,71 @@
-$:.unshift File.dirname(__FILE__)
-
+#!/usr/bin/env ruby
 #--
-# Created by Matt Todd on 2007-11-10.
-# Copyright (c) 2007 The HUB, Clayton State University. All rights reserved.
+#  Created by Matt Todd on 2008-01-11.
+#  Copyright (c) 2008. All rights reserved.
 #++
 
+$:.unshift File.dirname(File.join('..', __FILE__))
+$:.unshift File.dirname(__FILE__)
+
 #--
-# Dependencies
+# dependencies
 #++
 
-require 'rubygems'
-require 'uri'
-require 'json'
-require 'digest/md5'
+%w(rubygems halcyon/client).each {|dep|require dep}
 
 #--
-# Module
+# module
 #++
 
-require 'client/base'
-require 'client/token'
+module Aurora
+  
+  # = Aurora Client
+  # 
+  # The Aurora Client makes interfacing with the Aurora server very simple and
+  # easy, hiding away most of the communication details while still allowing
+  # for a great deal of control in creating requests for the server.
+  class Client < Halcyon::Client::Base
+    
+    attr_accessor :app
+    
+    def self.version
+      VERSION.join('.')
+    end
+    
+    # Initialies the Aurora client, expecting the Aurora server to connect to
+    # and the application to represent itself as to query permissions and such
+    # against. The App ID can also be used to configure default permissions for
+    # newly created user accounts (from fresh LDAP auths, for instance).
+    def initialize(uri, app)
+      @app = app
+      super uri
+    end
+    
+    # Performs an authentication action against the current Aurora server.
+    # 
+    # Expects a Hash with either a <tt>:username</tt> and <tt>:password</tt>
+    # pair or a single <tt>:token</tt> option. The server authentication
+    # method is called accordingly.
+    def authenticate(options = {})
+      user, pass = options[:username], options[:password]
+      token = options[:token]
+      if user && pass
+        post("/user/auth/#{user}", :password => pass)[:body] rescue false
+      elsif token
+        get("/token/auth/#{token}") rescue false 
+      else
+        false
+      end
+    end
+    
+    def permit?(user, permission)
+      get("/user/#{user}/#{@app}/permit/#{permission}")[:body]
+    end
+    
+    def permit!(user, permission, value)
+      post("/user/#{user}/#{@app}/permit/#{permission}", :value => value)[:body]
+    end
+    
+  end
+  
+end