lockdown 0.5.9 → 0.5.10

data/website/index.txt

@@ -4,255 +4,17 @@ h2. What
 
 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. Consolidation of information
+h2. New Home
 
 Maintaining this page, the wiki at GitHub, the Google Group and no issue tracker is not an ideal setup.  So, everything is moving to "stonean.com":http://stonean.com where I'm giving "Redmine":http://redmine.org a shot a running everything for me. I'll be posting release announcements to the news feed for each project and keeping the docs up-to-date.  Hopefully this will be better for everyone.
 
-Thanks for your interest in Lockdown,<br/>
--andy
-
-h2. Installing
-
-<pre>
-$ sudo gem install lockdown
-$ cd <your_project_directory>
-$ lockdown .
-</pre>
-
-This will create a "lockdown" directory in the lib dir add two files: init.rb and session.rb.  
-Modify init.rb to set configuration options and define the permissions and user groups that apply to your system.
-
-<strong> Please keep the following in mind:</strong>
-<ul>
-<li><strong>All Permissions are defined in init.rb, they cannot be defined via the administration screens.</strong></li>
-<li><strong>All User Groups should be defined in init.rb. The administration screens can be used to create user groups, but doing so should be reserved for the unexpected. Creating User Groups via the administration screens will only add more work for you if you want to run tests using those groups.</strong></li>
-<li><strong>Lockdown will sync up the rules (Permissions and User Groups) defined in init.rb with your database.  You can turn off this feature.</strong></li>
-</ul>
-
-To help you with your new application, Lockdown comes with a generator called lockdown that has various options for you to pick which templates you desire.
-
-<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.
-
-h2. How it works
-
-When Lockdown is installed, it adds the following line to your environment.rb (init.rb for Merb):
-<pre>
-  require "lockdown/init"
-</pre>
-This is the default init.rb included with Lockdown:
-<pre syntax="ruby">
-require "lockdown"
-require File.join(File.dirname(__FILE__), "session")
-
-Lockdown::System.configure do
-
-  #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  # Configuration Options
-  #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  # Options with defaults:
-  #
-  # Set timeout to 1 hour:
-  #       options[:session_timeout] = (60 * 60)
-  #
-  # Set system to logout if unauthorized access is attempted:
-  #       options[:logout_on_access_violation] = false
-  #
-  # Set redirect to path on unauthorized access attempt:
-  #       options[:access_denied_path] = "/"
-  #
-  # Set redirect to path on successful login:
-  #       options[:successful_login_path] = "/"
-  #
-  # Set the system to sync the Permissions and UserGroups defined here
-  # with the database. 
-  #       options[:sync_init_rb_with_db] = true
-  #
-  #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  # Define permissions
-  #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  #
-  # set_permission(:product_management, all_methods(:products))
-  #
-  # :product_management is the name of the permission which is later
-  # referenced by the set_user_group method
-  #
-  # :all_methods(:products) will return an array of all controller actions
-  # for the products controller
-  #
-  # if products is your standard RESTful resource you'll get:
-  #   ["products/index , "products/show",
-  #    "products/new", "products/edit",
-  #    "products/create", "products/update",
-  #    "products/destroy"]
-  #
-  # You can pass multiple parameters to concat permissions such as:
-  #      
-  #	  set_permission(:security_management,all_methods(:users),
-  #                                       all_methods(:user_groups),
-  #                                       all_methods(:permissions) )
-  #
-  # In addition to all_methods(:controller) there are:
-  #
-  #       only_methods(:controller, :only_method_1, :only_method_2)
-  #
-  #       all_except_methods(:controller, :except_method_1, :except_method_2)
-  #
-  # Some other sample permissions:
-  # 
-  #  set_permission(:sessions, all_methods(:sessions))
-  #  set_permission(:my_account, only_methods(:users, :edit, :update, :show))
-  # 
-  # Define your permissions here:
-
-  #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  # Built-in user groups
-  #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  #  You can assign the above permission to one of the built-in user groups
-  #  by using the following:
-  # 
-  #  To allow public access on the permissions :sessions and :home:
-  #    set_public_access :sessions, :home
-  #     
-  #  Restrict :my_account access to only authenticated users:
-  #    set_protected_access :my_account
-  #
-  # Define the built-in user groups here:
-
-  #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  # Define user groups
-  #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  #
-  #  set_user_group(:catalog_management, :category_management, 
-  #                                      :product_management) 
-  #
-  #  :catalog_management is the name of the user group
-  #  :category_management and :product_management refer to permission names
-  #
-  # 
-  # Define your user groups here:
-
-end 
-</pre>
-
-As you can see, the first line requires lockdown.  This will load the Lockdown system which consists of various parts:
-<ul>
-  <li>
-    Controller<br/>
-    <p>The controller functionality will add before filters to test each request agains the defined access_rights for the current user.  If the current request is not in the access_rights list, access right is denied.</p>
-  </li>  
-  <li>
-    Model<br/>
-    <p>The model functionality will automatically set the updated_by/created_by fields of your model to the current_profile_id.</p>
-  </li>  
-  <li>
-    View<br/>
-    <p>The view functionality intercepts the link_to method (aliases it).  If the current user does not have rights to the link, the link will not show.<br/>There is also a link_to_or_show method (same params as link_to) that will print out just the name of the link (no anchor tag) if the current user does not have access. </p>
-  </li>
-</ul>
+h2. Quick links
 
-When referring to access rights: if you have a standard REST users controller, the access rights would be:
-<pre>
-  users/index
-  users/show
-  users/edit
-  users/update
-  users/new
-  users/create
-  users/destroy (delete for Merb)
-</pre>
+"Wiki":http://stonean.com/wiki/lockdown
 
+"Forum":http://stonean.com/projects/lockdown/boards
 
-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. User groups are nothing more than a grouping mechanism for Permissions to ease management.
-
-Here are the parts to Lockdown:
-
-<div style="text-align:center">
-!model.jpg!
-</div>
-
-<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. Roadmap to 1.0
-
-<strong>**this is tentative and the feature order may change</strong>
-
-<ul>
-  <li><strong>0.5.0: </strong>More generators to ease installation into existing projects</li>
-  <li><strong>0.6.0: </strong>Password reset/reminder, Registration page template generators</li>
-  <li><strong>0.7.0: </strong>OpenId support</li>
-  <li><strong>0.8.0: </strong>RSpec tests and helper methods for your application</li>
-  <li><strong>0.9.0: </strong>Merb Support</li>
-  <li><strong>1.0.0: </strong>Model level security</li>
-</ul>
-
-h2. Github
-
-The Clone URL: git://github.com/stonean/lockdown.git
-
-Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/.
-
-I'm new to git and this whole opensource project admin gig, so please be patient with my stumbling around.
-
-h2. Contact
-
-Please use the "forum":http://stonean.com/projects/lockdown/boards to ask questions and the "issue tracker":http://stonean.com/projects/lockdown/issues to report problems or submit a pull request.
-
-h2. License
-
-This code is free to use under the terms of the MIT license.
-
-Copyright (c) 2008 Andrew Stone
+Thanks for your interest in Lockdown,<br/>
+-andy
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lockdown
 version: !ruby/object:Gem::Version 
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors: 
 - Andrew Stone
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-19 00:00:00 -04:00
+date: 2008-06-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.4
     version: 
-description: Authorization/Authentication system for RubyOnRails and Merb
+description: Authorization/Authentication system for RubyOnRails
 email: 
 - andrew.n.stone@gmail.com
 executables: 
@@ -34,7 +34,6 @@ extra_rdoc_files:
 - Manifest.txt
 - PostInstall.txt
 - README.txt
-- website/generator.txt
 - website/index.txt
 files: 
 - History.txt
@@ -52,6 +51,7 @@ files:
 - config/hoe.rb
 - config/requirements.rb
 - lib/lockdown.rb
+- lib/lockdown/classy-inheritance.rb
 - lib/lockdown/controller.rb
 - lib/lockdown/controller_inspector.rb
 - lib/lockdown/helper.rb
@@ -107,8 +107,6 @@ files:
 - test/test_lockdown_all_generator.rb
 - test/test_lockdown_generator.rb
 - test/test_lockdown_models_generator.rb
-- website/generator.html
-- website/generator.txt
 - website/index.html
 - website/index.txt
 - website/javascripts/rounded_corners_lite.inc.js
@@ -144,7 +142,7 @@ rubyforge_project: lockdown
 rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
-summary: Authorization/Authentication system for RubyOnRails and Merb
+summary: Authorization/Authentication system for RubyOnRails
 test_files: 
 - test/test_generator_helper.rb
 - test/test_helper.rb

data/website/generator.html

@@ -1,264 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <title>
-      Lockdown
-  </title>
-  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
-<style>
-
-</style>
-  <script type="text/javascript">
-    window.onload = function() {
-      settings = {
-          tl: { radius: 10 },
-          tr: { radius: 10 },
-          bl: { radius: 10 },
-          br: { radius: 10 },
-          antiAlias: true,
-          autoPad: true,
-          validTags: ["div"]
-      }
-      var versionBox = new curvyCorners(settings, document.getElementById("version"));
-      versionBox.applyCornersToAll();
-    }
-  </script>
-</head>
-<body>
-<div id="main">
-
-    <h1>Lockdown</h1>
-    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/lockdown"; return false'>
-      <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/lockdown" class="numbers">0.5.9</a>
-    </div>
-    <h2>What</h2>
-
-
-	<p>This page will describe how to get started with a new application.</p>
-
-
-	<p>There are now generator options to give you more control over which templates you want to mix-in to your application:</p>
-
-
-<ul>
-<li>&#8212;all
-<p> Install all Lockdown templates </p>
-</li> 
-<li>&#8212;models
-<p> Install only models and migrations (skip migrations by&#8212;no_migrations) </p>
-</li> 
-<li>&#8212;management
-<p> Install  management functionality.  Which is&#8212;all minus&#8212;login. All models (migrations) included.</p>
-</li> 
-<li>&#8212;login
-<p>Install login functionality.  Which is&#8212;all minus&#8212;management. All models (migrations) included.</p>
-</li> 
-<li>&#8212;no_migrations
-<p>Skip migrations installation</p>
-</li> 
-</ul>
-
-	<h2>Creating a new application</h2>
-
-
-<pre>
-$ rails demo_app
-&lt;snip output&gt;
-$ cd demo_app
-$ lockdown .
-------------------------------------------------------------
-Installing Lockdown
-      create  lib/lockdown
-      create  lib/lockdown/session.rb
-      create  lib/lockdown/init.rb
-------------------------------------------------------------
-
-------------------------------------------------------------
-Modified config/environment.rb by adding:
-    require "lockdown/init" 
-------------------------------------------------------------
-
-------------------------------------------------------------
-You are now locked down.  To open up access to your application 
-please modify lib/lockdown/init.rb.  This is where you'll 
-add permissions and create user groups.
-
-To modify the contents of your session and to add access 
-methods, modify lib/lockdown/session.rb.
-
-If you want to know more, please visit:
-
-http://lockdown.rubyforge.org
-
-If you have any suggestions, comments or issues 
-please visit the Lockdown Google group:
-
-http://groups.google.com/group/stonean_lockdown?hl=en
-------------------------------------------------------------
-</pre>
-
-	<p>Now it&#8217;s time to get the template&#8230;</p>
-
-
-<pre>
-$ ./script/generate lockdown --all
-      exists  app/helpers
-      exists  app/models
-      exists  app/views
-      create  app/views/users
-      create  app/views/user_groups
-      create  app/views/permissions
-      create  app/views/sessions
-      exists  app/controllers
-      create  app/controllers/permissions_controller.rb
-      create  app/controllers/users_controller.rb
-      create  app/controllers/user_groups_controller.rb
-      create  app/controllers/sessions_controller.rb
-      create  app/models/permission.rb
-      create  app/models/user.rb
-      create  app/models/user_group.rb
-      create  app/models/profile.rb
-       route  map.resources :permissions
-       route  map.resources :user_groups
-       route  map.resources :users
-       route  map.resources :sessions
-      create  app/helpers/permissions_helper.rb
-      create  app/helpers/users_helper.rb
-      create  app/helpers/user_groups_helper.rb
-      create  app/views/users/_data.html.erb
-      create  app/views/users/_form.html.erb
-      create  app/views/users/index.html.erb
-      create  app/views/users/show.html.erb
-      create  app/views/users/edit.html.erb
-      create  app/views/users/new.html.erb
-      create  app/views/users/_password.html.erb
-      create  app/views/user_groups/_data.html.erb
-      create  app/views/user_groups/_form.html.erb
-      create  app/views/user_groups/index.html.erb
-      create  app/views/user_groups/show.html.erb
-      create  app/views/user_groups/edit.html.erb
-      create  app/views/user_groups/new.html.erb
-      create  app/views/permissions/_data.html.erb
-      create  app/views/permissions/index.html.erb
-      create  app/views/permissions/show.html.erb
-      create  app/views/sessions/new.html.erb
-      create  db/migrate
-      create  db/migrate/001_create_profiles.rb
-      exists  db/migrate
-      create  db/migrate/002_create_users.rb
-      exists  db/migrate
-      create  db/migrate/003_create_user_groups.rb
-      exists  db/migrate
-      create  db/migrate/004_create_permissions.rb
-      exists  db/migrate
-      create  db/migrate/005_create_admin_user_and_user_group.rb
-</pre>
-
-	<p>Run your migrations:</p>
-
-
-<pre>
-$ rake db:migrate --trace
-</pre>
-
-	<p>Remove index.html</p>
-
-
-<pre>
-$ rm public/index.html
-</pre>
-
-	<p>Start the app and then open up your browser to http://localhost:3000</p>
-
-
-<pre>
-$ ./script/server
-</pre>
-
-	<p>You&#8217;ll see that the &#8220;lockdown&#8212;all&#8221; generator has added a default route to the login page.</p>
-
-
-	<p>Login using the basic admin account with credentials: admin/password</p>
-
-
-	<p>After you login (you&#8217;ll still be on the login page), go one of the following pages:</p>
-
-
-	<p>http://localhost:3000/users</p>
-
-
-	<p>http://localhost:3000/user_groups</p>
-
-
-	<p>There is a permissiosn page also available, but you don&#8217;t have any with the basic install.  And since permissions cannot be created via the admin screens, this doesn&#8217;t have much value for you now.</p>
-
-
-	<p>http://localhost:3000/permissions</p>
-
-
-	<h2>Permissions</h2>
-
-
-	<p>Alright, so there&#8217;s not a lot to see on these basic screens but that&#8217;s only because there&#8217;s isn&#8217;t a lot to the system at the moment.</p>
-
-
-	<p>Now it&#8217;s time to look at lib/lockdown/init.rb.  Open it in your favorite editor.</p>
-
-
-	<p>There&#8217;s some documentation with examples that will hopefully server for more than a reminder.  Please read that documentation before continuing here.</p>
-
-
-	<p>...</p>
-
-
-	<p>I guess that wasn&#8217;t sufficient? If you don&#8217;t understand how to use init.rb, please post a question on the forum and I&#8217;ll address the issue there and then update init.rb.</p>
-
-
-	<p>For simplicity sake, I would like the documentation for init.rb contained within that file.</p>
-
-
-	<h2>Github</h2>
-
-
-	<p>The Clone <span class="caps">URL</span>: git://github.com/stonean/lockdown.git</p>
-
-
-	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a>.</p>
-
-
-	<p>I&#8217;m new to git and this whole opensource project admin gig, so please be patient with my stumbling around.</p>
-
-
-	<h2>Contact</h2>
-
-
-	<p>Please use the <a href="http://stonean.com/projects/lockdown/boards">forum</a> to ask questions and the <a href="http://stonean.com/projects/lockdown/issues">issue tracker</a> to report problems or submit a pull request.</p>
-
-
-	<h2>License</h2>
-
-
-	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
-
-
-	<p>Copyright&#169; 2008 Andrew Stone</p>
-    <p class="coda">
-      11th June 2008<br/>
-      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
-    </p>
-</div>
-<script type="text/javascript">
-  var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
-  document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
-</script>
-<script type="text/javascript">
-  var pageTracker = _gat._getTracker("UA-4189092-1");
-  pageTracker._initData();
-  pageTracker._trackPageview();
-</script>
-</body>
-</html>