id_please 0.3.1 → 0.3.3

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+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.

data/README.rdoc

@@ -1,6 +1,38 @@
 = id_please
 
-Description goes here.
+ID Please is an authorization system for any system using ActiveRecord. It is a role-based solution, but is meant to be fairly robust, support assigning roles to users and groups, with unlimited levels of nesting of users and groups. While documentation is scant, all methods should be tested as of now.
+
+== Implementation
+
+The current set of models, and the method to include:
+
+User and Groups can be the subject of a role by assigning them.. Each role has a name, and can refer to an object, or be global. 
+
+One specified name for roles is privileged (by default "Member"). If a subject is assigned to be a "Member" of another group, then when the subject is checked for whether it has a role, it checks both itself and all parent groups for whether it passes.
+
+User: acts_as_authorization_subject
+Group: acts_as_authorization_group
+Assignment: acts_as_authorization_assignment
+Role: acts_as_authorization_role
+Object (can have roles): acts_as_authorization_object
+
+
+By default, users can belong to groups, and those groups can have groups as well. This makes the checking db-query intensive (n+1 queries, where n is the number of level of parent groups for the current user). While these queries are quick, you can disable groups (and group nesting), to cut down on this. (currently not fully tested, use at own risk.)
+
+
+== Areas for improvement
+
+* Better documentation
+* Fast query of infinite level groups via optional cache table
+* Testing to see whether or not non-standard names work.
+* Using memoization to lower number of queries.
+* Using a config file to enable easier setup of all models
+* Building in permissions support
+
+== Thanks to
+
+A great deal of thanks must be given to acl9, and oleg dashevskii, which provided a lot of the initial inspiration for this and some of the code.
+
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.3

data/id_please.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{id_please}
-  s.version = "0.3.1"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Stuart"]
-  s.date = %q{2010-01-29}
+  s.date = %q{2010-02-17}
   s.description = %q{Access control gem}
   s.email = %q{tastyhat@jamesstuart.org}
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
     ".document",
      ".gitignore",
      "LICENSE",
+     "MIT-LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",