picnic 0.5.0

data/CHANGELOG.txt

@@ -0,0 +1,3 @@
+=== 0.5.0 :: 2007-12-20
+
+* First public release.

data/LICENSE.txt

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Manifest.txt

@@ -0,0 +1,28 @@
+CHANGELOG.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/picnic.rb
+lib/picnic/authentication.rb
+lib/picnic/cli.rb
+lib/picnic/conf.rb
+lib/picnic/controllers.rb
+lib/picnic/postambles.rb
+lib/picnic/service_control.rb
+lib/picnic/utils.rb
+lib/picnic/version.rb
+setup.rb
+test/picnic_test.rb
+test/test_helper.rb
+vendor/camping-1.5.180/CHANGELOG
+vendor/camping-1.5.180/COPYING
+vendor/camping-1.5.180/README
+vendor/camping-1.5.180/Rakefile
+vendor/camping-1.5.180/lib/camping-unabridged.rb
+vendor/camping-1.5.180/lib/camping.rb
+vendor/camping-1.5.180/lib/camping/db.rb
+vendor/camping-1.5.180/lib/camping/fastcgi.rb
+vendor/camping-1.5.180/lib/camping/reloader.rb
+vendor/camping-1.5.180/lib/camping/session.rb
+vendor/camping-1.5.180/lib/camping/webrick.rb

data/README.txt

@@ -0,0 +1,31 @@
+= Picnic
+
+<b>Picnic makes it easy(ier) to distribute and run Camping-based applications as 
+well-behaved stand-alone Linux servers (although it works on Windows too).</b>
+
+*Author*::    Matt Zukowski (matt at roughest dot net)
+*Copyright*:: Copyright (c) 2007 Urbacon Ltd.
+*License*::   GNU Lesser General Public License Version 3
+*Homepage*::  http://camping-picnic.googlecode.com
+
+For detailed information and usage examples, please see Picnic's Google Code page at:
+<b>http://camping-picnic.googlecode.com</b>
+
+For info on the Camping microframework, see: 
+http://code.whytheluckystiff.net/camping and
+http://camping.rubyforge.org/files/README.html
+
+== License
+
+picnic is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published 
+by the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+Reststop is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'picnic', 'version')
+
+AUTHOR = "Matt Zukowski"
+EMAIL = "matt@roughest.net"
+DESCRIPTION = "Camping for sissies"
+GEM_NAME = "picnic"
+RUBYFORGE_PROJECT = "picnic"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+
+
+NAME = "picnic"
+REV = nil
+#REV = `svn info`[/Revision: (\d+)/, 1] rescue nil
+VERS = ENV['VERSION'] || (Picnic::VERSION::STRING + (REV ? ".#{REV}" : ""))
+                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "picnic #{VERS} documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  #p.extra_deps     - An array of rubygem dependencies.
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+  
+  # we now package camping-1.5.0.180 in the vendor directory
+  #p.extra_deps = ['camping']
+end

data/lib/picnic.rb

@@ -0,0 +1,122 @@
+$: << File.dirname(File.expand_path(__FILE__))
+$: << File.dirname(File.expand_path(__FILE__))+"/../vendor/camping-1.5.180/lib"
+
+require 'camping'
+require 'camping/db'
+require 'camping/session'
+
+require 'active_support' unless Object.const_defined?(:ActiveSupport)
+
+require 'picnic/utils'
+require 'picnic/conf'
+require 'picnic/postambles'
+require 'picnic/controllers'
+
+
+class Module
+  
+  # Adds Picnic functionality to a Camping-enabled module.
+  #
+  # Example:
+  #
+  #   Camping.goes :Blog
+  #   Blog.picnic!
+  #
+  # Your <tt>Blog</tt> Camping app now has Picnic functionality.
+  def picnic!
+    include Picnic
+    
+    puts "Adding Picnic functionality to #{self} from #{File.dirname(File.expand_path(__FILE__))}..."
+    self.module_eval do
+      # Initialize your application's logger. 
+      # This is automatically done for you when you call #picnic!
+      # The logger is initialized based on your <tt>:log</tt> configuration.
+      # See <tt>config.example.yml</tt> for info on configuring the logger.
+      def init_logger
+        puts "Initializing #{self} logger..."
+        $LOG = self::Utils::Logger.new(self::Conf.log[:file])
+        $LOG.level = "#{self}::Utils::Logger::#{self::Conf.log[:level]}".constantize
+      end
+      module_function :init_logger
+      
+      # Initialize your application's database logger. 
+      # If enabled, all SQL queries going through ActiveRecord will be logged here.
+      def init_db_logger
+        begin
+          if self::Conf.db_log
+            log_file = self::Conf.db_log[:file] || "#{self.to_s.downcase}_db.log"
+            self::Models::Base.logger = Logger.new(log_file)
+            self::Models::Base.logger.level = "#{self}::Utils::Logger::#{self::Conf.db_log[:level] || 'DEBUG'}".constantize
+          end
+        rescue Errno::EACCES => e
+          $LOG.warn "Can't write to database log file at '#{log_file}': #{e}"
+        end
+      end
+      module_function :init_db_logger
+      
+      # Enable authentication for your app.
+      #
+      # For example:
+      #
+      #   Camping.goes :Blog
+      #   Blog.picnic!
+      #
+      #   $CONF[:authentication] ||= {:username => 'admin', :password => 'picnic'}
+      #   Blog.authenticate_using :basic if Blog::Conf[:authentication]
+      #
+      # Note that in the above example we use the authentication configuration from
+      # your app's conf file. We specify default credentials for when your
+      # conf file doesn't define them.
+      #
+      # Currently only HTTP Basic authentication is available. See Picnic::Authentication
+      # for more info.
+      def authenticate_using(mod)
+        require 'picnic/authentication'
+        mod = "#{self}::Authentication::#{mod.to_s.camelize}".constantize unless mod.kind_of? Module
+        
+        $LOG.info("Enabling authentication for all requests using #{mod.inspect}.")
+        
+        module_eval do
+          include mod
+        end
+      end
+      module_function :authenticate_using
+    
+      # Launches the web server to run your Picnic app.
+      # This method will continue to run as long as your server is running.
+      def start_picnic
+          require 'picnic/postambles'
+          self.extend self::Postambles
+          
+          if $PID_FILE && !(self::Conf.server.to_s == 'mongrel' || self::Conf.server.to_s == 'webrick')
+            $LOG.warn("Unable to create a pid file. You must use mongrel or webrick for this feature.")
+          end
+          
+          puts "\nStarting with configuration: #{$CONF.to_yaml}"
+          puts
+        
+        #  begin
+            raise NoMethodError if self::Conf.server.nil?
+            send(self::Conf.server)
+        #  rescue NoMethodError => e
+        #    # FIXME: this rescue can sometime report the incorrect error messages due to other underlying problems
+        #    #         raising a NoMethodError
+        #    if Fluxr::Conf.server
+        #      raise e, "The server setting '#{Fluxr::Conf.server}' in your config.yml file is invalid."
+        #    else
+        #      raise e, "You must have a 'server' setting in your config.yml file. Please see the Fluxr documentation."
+        #    end
+        #  end
+      end
+      module_function :start_picnic
+      
+      c = File.dirname(File.expand_path(__FILE__))+'/picnic/controllers.rb'
+      p = IO.read(c).gsub("Picnic", self.to_s)
+      eval p, TOPLEVEL_BINDING
+      
+    end
+    
+    self::Conf.load(self)
+    init_logger
+  end
+end

data/lib/picnic/authentication.rb

@@ -0,0 +1,80 @@
+module Picnic #:nodoc:
+  # These modules (currently only one module, but more in the future) provide authentication
+  # for your Camping app. 
+  #
+  # This code is based on Camping::BasicAuth written by Manfred Stienstra 
+  # (see http://www.fngtps.com/2006/05/basic-authentication-for-camping).
+  #
+  # ----
+  #
+  # Picnic::Authentication::Basic can be mixed into a camping application to get Basic Authentication 
+  # support in the application. The module defines a <tt>service</tt> method that only continues 
+  # the request chain when proper credentials are given.
+  # 
+  # == Getting Started
+  #
+  # To activate Basic Authentication for your application:
+  #
+  # 1. Picnic-fy your Camping app (e.g: <tt>Camping.goes :your_app; YourApp.picnic!</tt>)
+  # 2. Call <tt>authenticate_using <module></tt> (e.g: <tt>YourApp.authenticate_using :basic</tt>)
+  # 3. Define an <tt>authenticate</tt> method on your application module that takes a hash.
+  #    The hash contains credentials like <tt>:username</tt>, <tt>:password</tt>, and <tt>:hostname</tt>,
+  #    although future authentication modules may submit other credentials.
+  #    The <tt>authenticate</tt> method should return true when the credentials are valid.
+  #    Examples:
+  #
+  #      module Blog
+  #        def authenticate(credentials)
+  #          credentials[:username] == 'admin' &&
+  #            credentials[:password] == 'flapper30'
+  #        end
+  #        module_function :authenticate
+  #      end
+  #
+  #    or
+  #
+  #      module Wiki
+  #        def authenticate(credentials)
+  #          u = credentials[:username]
+  #          p = credentials[:password]
+  #          Models::User.find_by_username_and_password u, p
+  #        end
+  #        module_function :authenticate
+  #      end
+  #
+  # 4. <tt>service</tt> sets <tt>@credentials</tt> to the credentials of the person who logged in.
+  module Authentication
+    module Basic
+      require 'base64'
+      
+      # Reads the username and password from the headers and returns them.
+      def read_credentials
+        if d = %w{REDIRECT_X_HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION HTTP_AUTHORIZATION}.inject([]) \
+          { |d,h| env.has_key?(h) ? env[h].to_s.split : d }
+          u,p = ::Base64.decode64(d[1]).split(':')[0..1] if d[0] == 'Basic'
+          return {:username => u, :password => p}
+        end
+      end
+      
+      # The <tt>service</tt> method, when mixed into your application module, wraps around the
+      # <tt>service</tt> method defined by Camping. It halts execution of the controllers when
+      # your <tt>authenticate</tt> method returns false. See the module documentation how to
+      # define your own <tt>authenticate</tt> method.
+      def service(*a)
+        @credentials = read_credentials || {}
+        app = self.class.name.gsub(/^(\w+)::.+$/, '\1')
+        if Kernel.const_get(app).authenticate(@credentials)
+          s = super(*a)
+        else
+          @status = 401
+          @headers['Content-type'] = @headers['Content-type'] || 'text/plain'
+          @headers['Status'] = 'Unauthorized'
+          @headers['WWW-Authenticate'] = "Basic realm=\"#{app}\""
+          @body = 'Unauthorized'
+          s = self
+        end
+        s
+      end
+    end
+  end
+end