lockdown 0.3.11 → 0.3.12

data/History.txt

@@ -1,3 +1,7 @@
+== 0.3.12 2008-05-02
+* Fixed: The timestamps were being set on created_by and updated_by.
+* Changed: The init.rb and lockdown_all interaction to better define where configurations should be placed.
+
 == 0.3.11 2008-05-01
 * Modified: Lockdown::System controller inspect to use "load" instead of "require".
 

data/app_generators/lockdown/templates/init.rb

@@ -55,6 +55,8 @@ Lockdown::System.configure do
   #  set_permission(:sessions, all_methods(:sessions))
   #  set_permission(:my_account, only_methods(:users, :edit, :update, :show))
   # 
+  # Define your permissions here:
+
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # Built-in user groups
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -67,6 +69,8 @@ Lockdown::System.configure do
   #  Restrict :my_account access to only authenticated users:
   #    set_protected_access :my_account
   #
+  # Define the built-in user groups here:
+
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # Define user groups
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -77,7 +81,7 @@ Lockdown::System.configure do
   #  :catalog_management is the name of the user group
   #  :category_management and :product_management refer to permission names
   #
-
-  # Add your configuration below:
+  # 
+  # Define your user groups here:
 
 end 

data/lib/lockdown/model.rb

@@ -7,8 +7,10 @@ module Lockdown
     module InstanceMethods
       def self.included(base)
         base.class_eval do
-          alias :create_without_stamps  :create
-          alias :update_without_stamps  :update
+          alias_method :create_without_stamps,  :create
+          alias_method :create,  :create_with_stamps
+          alias_method :update_without_stamps,  :update
+          alias_method :update,  :update_with_stamps
         end
       end
 
@@ -23,14 +25,12 @@ module Lockdown
         self[:updated_by] = profile_id if self.respond_to?(:updated_by) 
         create_without_stamps
       end
-      alias :create  :create_with_stamps
                   
       def update_with_stamps
         profile_id = current_profile_id || Profile::SYSTEM
         self[:updated_by] = profile_id if self.respond_to?(:updated_by)
         update_without_stamps
       end
-      alias :update  :update_with_stamps
     end # InstanceMethods
   end # Model
 end # Lockdown

data/lib/lockdown/version.rb

@@ -2,7 +2,7 @@ module Lockdown #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 11
+    TINY  = 12
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/lockdown.rb

@@ -72,7 +72,7 @@ module Lockdown
     include Lockdown::Helper
 
     def nil_lockdown_values
-      %w(user_id user_name user_profile_id access_rights).each do |val|
+      %w(expiry_time user_id user_name user_profile_id access_rights).each do |val|
         session[val] = nil if session[val]
       end
     end 

data/rails_generators/lockdown_all/lockdown_all_generator.rb

@@ -157,7 +157,7 @@ EOS
   end
 
 	def add_permissions(m)
-		perms = <<-PERMS
+perms = <<-PERMS
 
   set_permission :sessions_management, all_methods(:sessions)
 
@@ -169,16 +169,24 @@ EOS
 
   set_permission :my_account, only_methods(:users, :edit, :update, :show)
 
+PERMS
 
+		sentinel = '# Define your permissions here:'
+		m.gsub_file 'lib/lockdown/init.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+				"#{match}\n#{perms}"
+		end
+
+predefined_user_groups = <<-PUG
   set_public_access :sessions_management
 
   set_protected_access :my_account
-		PERMS
-
-		sentinel = '# Add your configuration below:'
+PUG
 
+		sentinel = '# Define the built-in user groups here:'
 		m.gsub_file 'lib/lockdown/init.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
-				"#{match}\n#{perms}"
+				"#{match}\n#{predefined_user_groups}"
 		end
+
+
 	end
 end

data/website/index.txt

@@ -1,18 +1,10 @@
-h1. lockdown
-
-h1. → 'lockdown'
+h1. <a href="http://lockdown.rubyforge.org">Lockdown</a>
 
 h3. Lockdown has not been officially released!  This page is a Work-In-Progress. 
 
 h2. What
 
-Lockdown is a authentication/authorization system for RubyOnRails and Merb designed for simplicity and extensibility.  All access rules are defined in lib/lockdown/init.rb.  With the included ORM support (ActiveRecord or DataMapper) and management screens you can add user defined rules to the system.
-
-If there is a "spec" directory, a test helper file will be included to provied some basic functionality for use with RSpec. This will show you how to create mock user objects and sign in as an adminstrator.
-
-Also included is functionality to auto-populate created_by and updated_by fields.
-
-Some model level access right functionality will also be added in the near future.
+Lockdown is a authentication/authorization system for RubyOnRails (ver 2.x). While Merb functionality is in place, it is not complete.  There will be a release solely focused on getting the Merb functionality up to par with Rails. 
 
 h2. Installing
 
@@ -26,13 +18,25 @@ $ lockdown .
 
 This will create a "lockdown" directory in the lib dir add two files: init.rb and session.rb.  Modify init.rb to set defaults and define the rules that apply to your system.
 
-If you want the full 'subsystem' (models, views, controllers, helpers):
+To help you with your new application, Lockdown comes with a generator called lockdown_all.
 
 <pre>
 $ cd <your_project_directory>
 $ ./script/generate lockdown_all
 </pre>
 
+This will install resources such as:
+<ul>
+  <li>Models</li>
+  <li>Controllers</li>
+  <li>Views</li>
+  <li>Helpers</li>
+  <li>Migrations</li>
+  <li>Routes</li>
+</ul>
+
+Please refer to the <a href="generator.html">generator page</a> for more detail.
+
 I recommend reading this page to get a feel for Lockdown's functionality.  
 
 h2. How it works
@@ -136,6 +140,50 @@ Lockdown::System.configure do
 end 
 </pre>
 
+h2. The internals
+
+All configuration of Lockdown (Permissions and User Groups) are done in lib/lockdown/init.rb.  The database functionality is merely an extension of the definitions to allow for the dynamic creation of User Groups.  Permissions can not be created via the administration screens.
+
+Lockdown doesn't have a concept of Roles. Instead, Lockdown users can be associated to one or many User Groups to allow for flexibility.  In addition, you can use the admin screens to add new User Groups to the database. 
+
+Here are the parts to Lockdown:
+<ul>
+ <li><strong>Profiles</strong><br/>
+    <p>The profile model contains all non-user information related to person.  Lockdown uses the profile record as the reference for updated_by and created_by.  This allows you to remove the user record completely when you want to revoke access, but you still retain the foreign key for history.<br/>Here are the fields you have to start with:</p>
+    <ul>
+      <li>first_name : string</li>
+      <li>last_name : string</li>
+      <li>email : string</li>
+    </ul>
+<br/>
+  </li>
+ <li><strong>Users</strong><br/>
+    <p>The user model contains all user information related to person.<br/>Here are the fields you have to start with:</p>
+    <ul>
+      <li>login : string</li>
+      <li>crypted_password : string</li>
+      <li>salt : string</li>
+      <li>profile_id : integer</li>
+    </ul>
+<br/>
+  </li>
+ <li><strong>User Groups</strong><br/>
+    <p>User Groups exist only to group Permissions.  All functionality for your site should be covered by the user groups you define in init.rb.  You can use the admin screen to create new user groups if the need arises. The database model only has one field:  </p>
+    <ul>
+      <li>name : string</li>
+    </ul>
+<br/>
+  </li>
+ <li><strong>Permissions</strong><br/>
+    <p>Permissions are the security building blocks of your system and are defined in init.rb.  A permission maps to controller(s)/action(s) in your system. Please refer back to the documenation in init.rb on how to create permissions.
+ As permissions relate to system functionality, they cannot be created via the admin screen.  The database model only has one field:  </p>
+    <ul>
+      <li>name : string</li>
+    </ul>
+  </li>
+</ul>
+  
+
 h2. Forum
 
 If you are having a problem understanding how to use Lockdown, please post your question on the lockdown group.  If it's documentation related, I will keep this page updated to help everyone. 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lockdown
 version: !ruby/object:Gem::Version 
-  version: 0.3.11
+  version: 0.3.12
 platform: ruby
 authors: 
 - Andrew Stone
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-01 00:00:00 -04:00
+date: 2008-05-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency