parlement 0.1

data/vendor/plugins/engines/lib/ruby_extensions.rb

@@ -0,0 +1,127 @@
+#--
+# Copyright (c) 2005 James Adam
+#
+# 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 OR COPYRIGHT HOLDERS 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.
+#++
+
+#--
+# Add these methods to the top-level module so that they are available in all
+# modules, etc
+#++
+class ::Module
+  # Defines a constant within a module/class ONLY if that constant does
+  # not already exist.
+  #
+  # This can be used to implement defaults in plugins/engines/libraries, e.g.
+  # if a plugin module exists:
+  #   module MyPlugin
+  #     default_constant :MyDefault, "the_default_value"
+  #   end
+  #
+  # then developers can override this default by defining that constant at
+  # some point *before* the module/plugin gets loaded (such as environment.rb)
+  def default_constant(name, value)
+    if !(name.is_a?(String) or name.is_a?(Symbol))
+      raise "Cannot use a #{name.class.name} ['#{name}'] object as a constant name"
+    end
+    if !self.const_defined?(name)
+      self.class_eval("#{name} = #{value.inspect}")
+    end
+  end
+  
+  # A mechanism for defining configuration of Modules. With this
+  # mechanism, default values for configuration can be provided within shareable
+  # code, and the end user can customise the configuration without having to
+  # provide all values.
+  #
+  # Example:
+  #
+  #  module MyModule
+  #    config :param_one, "some value"
+  #    config :param_two, 12345
+  #  end
+  #
+  # Those values can now be accessed by the following method
+  #
+  #   MyModule.config :param_one  
+  #     => "some value"
+  #   MyModule.config :param_two  
+  #     => 12345
+  #
+  # ... or, if you have overrriden the method 'config'
+  #
+  #   MyModule::CONFIG[:param_one]  
+  #     => "some value"
+  #   MyModule::CONFIG[:param_two]  
+  #     => 12345
+  #
+  # Once a value is stored in the configuration, it will not be altered
+  # by subsequent assignments, unless a special flag is given:
+  #
+  #   (later on in your code, most likely in another file)
+  #   module MyModule
+  #     config :param_one, "another value"
+  #     config :param_two, 98765, :force
+  #   end
+  #
+  # The configuration is now:
+  #
+  #   MyModule.config :param_one  
+  #     => "some value" # not changed
+  #   MyModule.config :param_two  
+  #     => 98765
+  #
+  def config(*args)
+    
+    raise "config expects at least one argument" if args.empty?
+    
+    # extract the arguments
+    if args[0].is_a?(Hash)
+      # we can't override when using hash'd arguments since
+      # if > 1 hash keys are given, it's impossible to tell which
+      # one is the name of the option, and which is the override flag.
+      args[0].each { |key, value| _handle_config(key, value)}
+    else
+      _handle_config(*args)
+    end
+  end
+  
+  private
+    # Actually set the config values
+    def _handle_config(name, value=nil, override=false)
+      if !self.const_defined?("CONFIG")
+        self.class_eval("CONFIG = {}")
+      end
+    
+      if value != nil
+        if override or self::CONFIG[name] == nil
+          self::CONFIG[name] = value 
+        end
+      else
+        # if we pass an array of config keys to config(),
+        # get the array of values back
+        if name.is_a? Array
+          name.map { |c| self::CONFIG[c] }
+        else
+          self::CONFIG[name]
+        end
+      end      
+    end
+end

data/vendor/plugins/engines/lib/testing_extensions.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+
+module Test
+  module Unit
+    class TestCase  
+      # Create a fixtures file based on the template file 
+      # (<fixture_path>/templates/<fixture_template_name>.yml), and create a suitable
+      # fixture file in the fixture_path directory to be loaded into the table given by
+      # table_name.
+      def self.set_fixtures_table(fixture_file_name, table_name)
+        # presume that the template files are in fixture_path + "/templates"
+        template_file = File.join(fixture_path, "templates", fixture_file_name.to_s + ".yml")
+        destination_file = File.join(fixture_path, table_name.to_s + ".yml")
+        if !File.exists?(template_file)
+          raise "Cannot find fixture template file '#{template_file}'!"
+        end
+        # Copy the file across, unless the destination is identical.
+        begin
+          unless File.exist?(destination_file) && FileUtils.identical?(template_file, destination_file)
+            FileUtils.cp(template_file, destination_file)
+          end
+        rescue Exception => e
+          raise "Couldn't create fixture file: " + e
+        end
+      end
+      
+      # Returns any object from the given fixtures
+      def fixture_object(fixture_name, object_name)
+        send(fixture_name.to_sym, object_name)
+      end
+    end
+  end
+end

data/vendor/plugins/engines/test/ruby_extensions_test.rb

@@ -0,0 +1,94 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + '/../../../../config/environment')
+require 'test_help'
+
+class EnginesTest < Test::Unit::TestCase
+
+  def setup
+    # create the module to be used for config testing
+    eval "module TestModule end"
+  end  
+
+  def teardown
+    # remove the TestModule constant from our scope
+    self.class.class_eval { remove_const :TestModule }
+  end
+
+
+  #
+  # Module.config
+  #
+
+  def test_config_no_arguments
+    assert_raise(RuntimeError) { TestModule.config }
+  end
+  
+  def test_config_array_arguments
+    TestModule.config :monkey, 123
+    assert_equal(123, TestModule.config(:monkey))
+  end
+  
+  def test_config_hash_arguments
+    TestModule.config :monkey => 123, :donkey => 456
+    assert_equal(123, TestModule.config(:monkey))
+    assert_equal(456, TestModule.config(:donkey))
+  end
+  
+  def test_config_cant_overwrite_existing_config_values
+    TestModule.config :monkey, 123
+    assert_equal(123, TestModule.config(:monkey))
+    TestModule.config :monkey, 456
+    assert_equal(123, TestModule.config(:monkey))
+    
+    # in this case, the resulting Hash only has {:baboon => "goodbye!"} - that's Ruby, users beware.
+    TestModule.config :baboon => "hello", :baboon => "goodbye!"
+    assert_equal("goodbye!", TestModule.config(:baboon))    
+  end
+  
+  def test_config_force_new_value
+    TestModule.config :monkey, 123
+    assert_equal(123, TestModule.config(:monkey))
+    TestModule.config :monkey, 456, :force
+    assert_equal(456, TestModule.config(:monkey))    
+  end
+  
+  # this test is somewhat redundant, but it might be an idea to havbe it explictly anyway
+  def test_config_get_values
+    TestModule.config :monkey, 123
+    assert_equal(123, TestModule.config(:monkey))
+  end
+  
+  def test_config_get_multiple_values
+    TestModule.config :monkey, 123
+    TestModule.config :donkey, 456
+    assert_equal([123, 456], TestModule.config([:monkey, :donkey]))
+  end
+  
+  
+  #
+  # Module.default_constant
+  #
+  
+  def test_default_constant_set
+    TestModule.default_constant :Monkey, 123
+    assert_equal(123, TestModule::Monkey)
+    TestModule.default_constant "Hello", 456
+    assert_equal(456, TestModule::Hello)
+  end
+
+  def test_default_constant_cannot_set_again
+    TestModule.default_constant :Monkey, 789
+    assert_equal(789, TestModule::Monkey)
+    TestModule.default_constant :Monkey, 456
+    assert_equal(789, TestModule::Monkey)
+  end
+
+  def test_default_constant_bad_arguments
+    # constant names must be Captialized
+    assert_raise(NameError) { TestModule.default_constant :lowercase_name, 123 }
+    
+    # constant names should be given as Strings or Symbols
+    assert_raise(RuntimeError) { TestModule.default_constant 123, 456 }
+    assert_raise(RuntimeError) { TestModule.default_constant Object.new, 456 }
+  end
+end

data/vendor/plugins/login_engine/README

@@ -0,0 +1,258 @@
+= Before we start
+
+This is a Rails Engine version of the Salted Login Generator, a most excellent login system which is sufficient for most simple cases. For the most part, this code has not been altered from its generator form, with the following notable exceptions
+
+* Localization has been removed.
+* The 'welcome' page has been changed to the 'home' page
+* A few new functions have been thrown in
+* It's... uh.... a Rails Engine now ;-)
+
+However, what I'm trying to say is that 99.9999% of the credit for this should go to Tobias Luetke (xal) and the folks that worked on the original Salted Login generator code. I've just wrapped it into something runnable with the Rails Engine system.
+
+Please also bear in mind that this is a work in progress, and things like testing are wildly up in the air... but they will fall into place very soon. And now, on with the show.
+
+
+= Installation
+
+Installing the Login Engine is fairly simple, but there are a few configuration steps that you'll need to take to get everything running smoothly. Listed below are the changes to your application you will need to make.
+
+=== Setup your Rails application
+
+Edit your <tt>database.yml</tt>, most importantly! You might also want to move <tt>public/index.html</tt> out of the way, and set up some default routes in <tt>config/routes.rb</tt>.
+
+=== Add configuration and start engine
+
+Add the following to the bottom of environment.rb:
+
+  module LoginEngine
+    config :salt, "your-salt-here"
+  end
+
+  Engines.start :login
+  
+You'll probably want to change the Salt value to something unique. You can also override any of the configuration values defined at the top of lib/user_system.rb in a similar way. Note that you don't need to start the engine with <tt>Engines.start :login_engine</tt> - instead, <tt>:login</tt> (or any name) is sufficient if the engine is a directory named <some-name>_engine.
+
+
+=== Add the filters
+
+Next, edit your <tt>app/controllers/application.rb</tt> file. The beginning of your <tt>ApplicationController</tt> should look something like this:
+
+  require 'login_engine'
+
+  class ApplicationController < ActionController::Base
+    include LoginEngine
+    helper :user
+    model :user
+    
+    before_filter :login_required
+
+If you don't want ALL actions to require a login, you need to read further below to learn how to restrict only certain actions. 
+
+Add the following to your ApplicationHelper:
+
+  module ApplicationHelper
+    include LoginEngine
+  end
+
+This ensures that the methods to work with users in your views are available
+
+=== Set up ActionMailer
+
+If you want to disable email functions within the Login Engine, simple set the :use_email_notification config flag to false in your environment.rb file:
+
+  module LoginEngine
+    
+    #  ... other options...
+    config :use_email_notification, false
+
+  end
+
+You should note that retrieving forgotten passwords automatically isn't possible when the email functions are disabled. Instead, the user is presented with a message instructing them to contact the system administrator
+
+If you wish you use email notifications and account creation verification, you must properly configure ActionMailer for your mail settings. For example, you could add the following in config/environments/development.rb (for a .Mac account, and with your own username and password, obviously):
+
+ActionMailer::Base.server_settings = {
+  :address => "smtp.mac.com",
+  :port => 25,
+  :domain => "smtp.mac.com",
+  :user_name => "<your user name here>",
+  :password => "<your password here>",
+  :authentication => :login
+}
+
+You'll need to configure it properly so that email can be sent. One of the easiest ways to test your configuration is to temporarily reraise exceptions from the signup method (so that you get the actual mailer exception string). In the rescue statement, put a single "raise" statement in. Once you've debugged any setting problems, remove that statement to get the proper flash error handling back.
+
+
+=== Create the DB schema
+
+After you have done the modifications the the ApplicationController and its helper, you can import the user model into the database. An ActiveRecord schema.rb file is provided in login_engine/db/schema.rb. You should check that this file isn't going to interfere with anything in your application. You can set the table name used by adding
+
+  module LoginEngine
+    
+    #  ... other options...
+    config :user_table, "your_table_name"
+
+  end
+
+To the LoginEngine configuration in <tt>environment.rb</tt>. Then run from the root of your project:
+
+  rake import_login_engine_schema
+
+to import the schema into your database.
+
+
+== Include stylesheets
+
+If you want the default stylesheet, add the following line to your layout:
+
+  <%= engine_stylesheet 'login_engine' %>
+  
+... somewhere in the <head> section of your HTML layout file.
+
+
+
+= How to use the Login Engine 
+
+Now you can go around and happily add "before_filter :login_required" to the controllers which you would like to protect. 
+
+After integrating the login system with your rails application navigate to your new controller's signup method. There you can create a new account. After you are done you should have a look at your DB. Your freshly created user will be there but the password will be a sha1 hashed 40 digit mess. I find this should be the minimum of security which every page offering login & password should give its customers. Now you can move to one of those  controllers which you protected with the before_filter :login_required snippet. You will automatically be re-directed to your freshly created login controller and you are asked for a password. After entering valid account data you will be taken back to the controller which you requested earlier. Simple huh?
+
+=== Protection using <tt>before_filter</tt>
+
+Adding the line <tt>before_filter :login_required</tt> to your <tt>app/controllers/application.rb</tt> file will protect *all* of your applications methods, in every controller. If you only want to control access to specific controllers, remove this line from <tt>application.rb</tt> and add it to the controllers that you want to secure.
+
+Within individual controllers you can restrict which methods the filter runs on in the usual way:
+
+       before_filter :login_required, :only => [:myaccount, :changepassword]
+       before_filter :login_required, :except => [:index]
+
+=== Protection using <tt>protect?()</tt>
+
+Alternatively, you can leave the <tt>before_filter</tt> in the global <tt>application.rb</tt> file, and control which actions are restricted in individual controllers by defining a <tt>protect?()</tt> method in that controller.
+
+For instance, in the <tt>UserController</tt> we want to allow everyone access to the 'login', 'signup' and 'forgot_password' methods (otherwise noone would be able to access our site!). So a <tt>protect?()</tt> method is defined in <tt>user_controller.rb</tt> as follows:
+
+  def protect?(action)
+    if ['login', 'signup', 'forgot_password'].include?(action)
+      return false
+    else
+      return true
+    end
+  end
+
+Of course, you can override this Engine behaviour in your application - see below.
+
+== Configuration
+
+TODO: document the configuration options in the LoginEngine
+
+== Overriding controllers and views
+
+The standard home page is almost certainly not what you want to present to your users. Because this login system is a Rails Engine, overriding the default behaviour couldn't be simpler. To change the RHTML template shown for the <tt>home</tt> action, simple create a new file in <tt>RAILS_ROOT/app/views/user/home.rhtml</tt> (you'll probably need to create the directory <tt>user</tt> at the same time). This new view file will be used instead of the one provided in the Login Engine. Easy!
+
+
+== Tips & Tricks
+
+How do I...
+
+  ... access the user who is currently logged in
+
+  A: You can get the user object from the session using session[:user]
+     Example: 
+       Welcome <%= session[:user].name %>
+
+    You can also use the 'current_user' method provided by UserHelper:
+    Example:
+      Welcome <%= current_user.name %>
+
+
+  ... restrict access to only a few methods? 
+  
+  A: Use before_filters build in scoping. 
+     Example: 
+       before_filter :login_required, :only => [:myaccount, :changepassword]
+       before_filter :login_required, :except => [:index]
+     
+  ... check if a user is logged-in in my views?
+  
+  A: session[:user] will tell you. Here is an example helper which you can use to make this more pretty:
+     Example: 
+       def user?
+         !session[:user].nil?
+       end
+
+  ... return a user to the page they came from before logging in?
+
+  A: The user will be send back to the last url which called the method "store_location"
+     Example:
+       User was at /articles/show/1, wants to log in.
+       in articles_controller.rb, add store_location to the show function and
+       send the user to the login form. 
+       After he logs in he will be send back to /articles/show/1
+
+You can find more help at http://wiki.rubyonrails.com/rails/show/SaltedLoginGenerator
+
+== Troubleshooting
+
+One of the more common problems people have seen is that after verifying an account by following the emailed URL, they are unable to login via the normal login method since the verified field is not properly set in the user model's row in the DB.
+
+The most common cause of this problem is that the DB and session get out of sync. In particular, it always happens for me after recreating the DB if I have run the server previously. To fix the problem, remove the /tmp/ruby* session files (from wherever they are for your installation) while the server is stopped, and then restart. This usually is the cause of the problem.
+
+
+
+= Database Schema Details
+
+You need a database table corresponding to the User model. This is provided as a Rails Schema file, but the schema is presented below for information. Note the table type for MySQL. Whatever DB you use, it must support transactions. If it does not, the functional tests will not work properly, nor will the application in the face of failures during certain DB creates and updates.
+
+  mysql syntax:
+  CREATE TABLE users (
+    id INTEGER UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+    login VARCHAR(80) NOT NULL,
+    salted_password VARCHAR(40) NOT NULL,
+    email VARCHAR(60) NOT NULL,
+    firstname VARCHAR(40),
+    lastname VARCHAR(40),
+    salt CHAR(40) NOT NULL,
+    verified INT default 0,
+    role VARCHAR(40) default NULL,
+    security_token CHAR(40) default NULL,
+    token_expiry DATETIME default NULL,
+    deleted INT default 0,
+    delete_after DATETIME default NULL
+  ) TYPE=InnoDB DEFAULT CHARSET=utf8;
+
+  postgres:
+  CREATE TABLE "users" (
+    id SERIAL PRIMARY KEY
+    login VARCHAR(80) NOT NULL,
+    salted_password VARCHAR(40) NOT NULL,
+    email VARCHAR(60) NOT NULL,
+    firstname VARCHAR(40),
+    lastname VARCHAR(40),
+    salt CHAR(40) NOT NULL,
+    verified INT default 0,
+    role VARCHAR(40) default NULL,
+    security_token CHAR(40) default NULL,
+    token_expiry TIMESTAMP default NULL,
+    deleted INT default 0,
+    delete_after TIMESTAMP default NULL
+  ) WITH OIDS;
+
+  sqlite:
+  CREATE TABLE 'users' (
+    id INTEGER PRIMARY KEY,
+    login VARCHAR(80) NOT NULL,
+    salted_password VARCHAR(40) NOT NULL,
+    email VARCHAR(60) NOT NULL,
+    firstname VARCHAR(40),
+    lastname VARCHAR(40),
+    salt CHAR(40) NOT NULL,
+    verified INT default 0,
+    role VARCHAR(40) default NULL,
+    security_token CHAR(40) default NULL,
+    token_expiry DATETIME default NULL,
+    deleted INT default 0,
+    delete_after DATETIME default NULL
+  );
+
+Of course your user model can have any amount of extra fields. This is just a starting point.