authentasaurus 0.7.3 → 0.8.3

data/rdoc/css/panel.css

@@ -0,0 +1,383 @@
+/* Panel (begin) */
+    .panel
+    {
+        position: absolute;
+        width: 100%;
+        height: 100%;
+        top: 0;
+        left: 0;
+        background: #FFF;
+        z-index: 2;
+        font-family: "Helvetica Neue", "Arial", sans-serif;
+        //zoom: 1;
+    }
+    
+    .panel_tree .results, 
+    .panel_results .tree 
+    {
+        display: none;
+    }
+    
+    /* Header with search box (begin) */
+        .panel .header
+        {
+            width: 100%;
+            height: 29px;
+            border-bottom: 1px solid #666;
+            position: relative;
+            left: 0; top: 0;
+            background: #e8e8e8;
+        }
+
+        .panel .header div
+        {
+            margin: 0 7px;
+        }
+        .panel .header table
+        {
+            height: 29px;
+            width: 100%;
+        }
+
+        .panel .header table td
+        {
+            vertical-align: middle;
+            text-align: middle;
+        }
+
+        .panel .header label
+        {
+            position: absolute;
+            font-size: 12px;
+            line-height: 29px;
+            margin-left: 3px;
+            color: #999;
+            cursor: text;
+        }
+
+        .panel .header table input
+        {
+            width: 100%;
+            box-sizing: border-box;
+            -moz-box-sizing: border-box;
+            -webkit-box-sizing: border-box;
+            display: inline-block;
+            -webkit-appearance: searchfield;
+            height: 22px;
+            //height: auto;
+        }
+        
+    /* Header with search box (end) */
+    
+        
+    /* Results (begin) */
+        .panel .result
+        {
+            position: absolute;
+            top: 30px;
+            bottom: 0;
+            left: 0;
+            width: 100%;
+            //height: expression((this.parentNode.offsetHeight - 31));
+            overflow-y: scroll;
+            overflow-x: hidden;
+            -overflow-y: hidden;
+            background: #EDF3FE url(../i/results_bg.png);
+            z-index: 2;
+            //zoom:1;
+        }
+
+        .panel .result ul
+        {
+            font-size: 0.8em;
+            width: 100%;
+            background: #EDF3FE url(../i/results_bg.png);
+            //zoom:1;
+        }
+
+        .panel .result ul li
+        {
+            height: 46px;
+            -height: 50px;
+            //display: inline;
+            //width: 100%;
+            //zoom: 1;
+            overflow: hidden;
+            padding: 4px 10px 0 10px;
+            cursor: pointer;
+        }
+
+        .panel .result ul li h1
+        {
+            font-size: 13px;
+            font-weight: normal;
+            color: #333;
+            margin-bottom: 2px;
+            white-space: nowrap;
+        }
+
+        .panel .result ul li p
+        {
+            font-size: 11px;
+            color: #333;
+            margin-bottom: 2px;
+            white-space: nowrap;
+        }
+
+        .panel .result ul li h1 i,
+        .panel .result ul li p.snippet
+        {
+            color: #999;
+        }
+
+        .panel .result ul li b
+        {
+            color: #000;
+        }
+
+        .panel .result ul li.current
+        {
+            background: #3875D7;
+        }
+
+        .panel .result ul li.current h1,
+        .panel .result ul li.current p
+        {
+            color: #DDD;
+        }
+
+        .panel .result ul li.current h1 i,
+        .panel .result ul li.current p.snippet
+        {
+            color: #AAA;
+        }
+
+        .panel .result ul li.current b
+        {
+            color: #FFF;
+        }
+
+
+        .panel .result ul li:hover,
+        .panel .result ul li.selected
+        {
+            background: #d0d0d0;
+        }
+
+        .panel .result ul li.current:hover
+        {
+            background: #2965C0;
+        }      
+        
+        .panel .result ul li .badge
+        {
+            margin-right: 0.4em;
+            margin-left: -0.2em;
+            padding: 0 0.2em;
+            color: #000;
+        }
+        
+        .panel .result ul li .badge_1
+        {
+            background: #ACDBF4;
+        }
+        
+        .panel .result ul li.current .badge_1
+        {
+            background: #97BFD7;
+        }
+        
+        .panel .result ul li .badge_2
+        {
+            background: #ACF3C3;
+        }
+        
+        .panel .result ul li.current .badge_2
+        {
+            background: #98D7AC;
+        }
+        
+        .panel .result ul li .badge_3
+        {
+            background: #E0F3AC;
+        }
+        
+        .panel .result ul li.current .badge_3
+        {
+            background: #C4D798;
+        }
+        
+        .panel .result ul li .badge_4
+        {
+            background: #D7CA98;
+        }
+        
+        .panel .result ul li.current .badge_4
+        {
+            background: #A6B0AC;
+        }
+        
+        .panel .result ul li .badge_5
+        {
+            background: #F3C8AC;
+        }
+        
+        .panel .result ul li.current .badge_5
+        {
+            background: #D7B198;
+        }
+        
+        .panel .result ul li .badge_6
+        {
+            background: #F3ACC3;
+        }
+        
+        .panel .result ul li.current .badge_6
+        {
+            background: #D798AB;
+        }
+        
+    /* Results (end) */
+    
+    /* Tree (begin) */ /**/
+        .panel .tree 
+        {
+            position: absolute;
+            top: 30px;
+            bottom: 0;
+            left: 0;
+            width: 100%;
+            //zoom: 1;
+            //height: expression((this.parentNode.offsetHeight - 31));
+            overflow-y: scroll;
+            overflow-x: hidden;
+            -overflow-y: hidden;
+            background: #EDF3FE url(../i/tree_bg.png);
+            z-index: 30;
+        }
+        
+        .panel .tree ul
+        {
+            background: #EDF3FE url(../i/tree_bg.png);
+        }          
+        
+        .panel .tree li
+        {
+            cursor: pointer;
+            overflow: hidden;
+            //height: 23px;
+            //display: inline;
+            //zoom: 1;
+            //width: 100%;
+        }
+        
+        
+        .panel .tree li .content
+        {
+            padding-left: 18px;
+            padding-top: 5px;
+            height: 18px;
+            overflow: hidden;
+            position: relative;
+        }
+        
+        .panel .tree li .icon
+        {
+            width: 10px;
+            height: 9px;
+            background: url(../i/arrows.png);
+            background-position: 0 -9px;
+            position: absolute;
+            left: 1px;
+            top: 8px;
+            cursor: default;
+        }
+        
+        .panel .tree li.closed .icon
+        {
+            background-position: 0 0;
+        }
+        
+        .panel .tree ul li h1
+        {
+            font-size: 13px;
+            font-weight: normal;
+            color: #000;
+            margin-bottom: 2px;
+            white-space: nowrap;
+        }
+
+        .panel .tree ul li p
+        {
+            font-size: 11px;
+            color: #666;
+            margin-bottom: 2px;
+            white-space: nowrap;
+        }
+        
+        .panel .tree ul li h1 i
+        {
+            color: #999;
+            font-style: normal;
+        }
+        
+        .panel .tree ul li.empty
+        {
+            cursor: text;
+        }   
+        
+        .panel .tree ul li.empty h1,
+        .panel .tree ul li.empty p
+        {
+            color: #666;
+            font-style: italic;
+        }
+        
+        .panel .tree ul li.current
+        {
+            background: #3875D7;
+        }
+        
+        .panel .tree ul li.current .icon
+        {
+            background-position: -10px -9px;
+        }
+        
+        .panel .tree ul li.current.closed .icon
+        {
+            background-position: -10px 0;
+        }
+
+        .panel .tree ul li.current h1
+        {
+            color: #FFF;
+        }
+
+        .panel .tree ul li.current p
+        {
+            color: #CCC;
+        }
+
+        .panel .tree ul li.current.empty h1,
+        .panel .tree ul li.current.empty p
+        {
+            color: #999;
+        }
+        
+        .panel .tree ul li:hover
+        {
+            background: #d0d0d0;
+        }
+
+        .panel .tree ul li.current:hover
+        {
+            background: #2965C0;
+        }
+        
+        .panel .tree .stopper
+        {
+            display: none;
+        }
+    /* Tree (end) */ /**/
+    
+/* Panel (end) */

data/rdoc/css/reset.css

@@ -0,0 +1,53 @@
+/* http://meyerweb.com/eric/tools/css/reset/ */
+/* v1.0 | 20080212 */
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	outline: 0;
+	font-size: 100%;
+	vertical-align: baseline;
+	background: transparent;
+}
+body {
+	line-height: 1;
+}
+ol, ul {
+	list-style: none;
+}
+blockquote, q {
+	quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+	content: '';
+	content: none;
+}
+
+/* remember to define focus styles! */
+:focus {
+	outline: 0;
+}
+
+/* remember to highlight inserts somehow! */
+ins {
+	text-decoration: none;
+}
+del {
+	text-decoration: line-through;
+}
+
+/* tables still need 'cellspacing="0"' in the markup */
+table {
+	border-collapse: collapse;
+	border-spacing: 0;
+}

data/rdoc/files/README_rdoc.html

@@ -0,0 +1,366 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>README.rdoc</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
+    <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
+    <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
+</head>
+
+<body>     
+    <div class="banner">
+        <h1>
+            README.rdoc
+        </h1>
+        <ul class="files">
+            <li>README.rdoc</li>
+            <li>Last modified: Tue Sep 28 23:34:58 +0300 2010</li>
+        </ul>
+    </div>
+
+    <div id="bodyContent">
+        <div id="content">
+    
+    <div class="description">
+        <h2><a href="../classes/Authentasaurus.html">Authentasaurus</a></h2>
+<p>
+<a href="../classes/Authentasaurus.html">Authentasaurus</a> is a dynamic
+group/permission based authentication and authorization engine plugin, its
+simple to use and easy to setup.
+</p>
+<p>
+Most helpers are inspired by Devise.
+</p>
+<h2>Installation</h2>
+<p>
+To start using <a href="../classes/Authentasaurus.html">Authentasaurus</a>
+follow these simple steps :
+</p>
+<ol>
+<li>install authentasaurus gem by running the following command
+
+<pre>
+ gem install authentasaurus
+</pre>
+</li>
+<li>add authentasaurus to your application environment; in
+config/environment.rb
+
+<pre>
+ config.gem &quot;authentasaurus&quot;
+</pre>
+</li>
+<li>generate authentasaurus configuration and tasks in your application
+
+<pre>
+ script/generate authentasaurus
+</pre>
+</li>
+<li>setup your migrations using the migration helpers
+
+<pre>
+ in the migration up method just use
+   authentasaurus_tables
+ in the migration down method
+   authentasaurus_drop_tables
+</pre>
+</li>
+<li>migrate your database and setup your default data
+
+<pre>
+ rake authentasaurus:setup_defaults
+</pre>
+</li>
+<li>add your routes
+
+<pre>
+ map.authentasaurus_routes :authorizable, :validatable, :invitable
+</pre>
+</li>
+</ol>
+<p>
+that&#8217;s the most basic and quick setup, you can now test your
+application by running script/server in your project root directory and
+going to <a
+href="http://localhost:3000/sessions/sign-in">localhost:3000/sessions/sign-in</a>
+</p>
+<p>
+<a href="../classes/Authentasaurus.html">Authentasaurus</a> is modular, you
+can install modules as you need them (the previous setup contains all
+modules), refer to the documentation for more information.
+</p>
+<h2>Under the hood</h2>
+<p>
+<a href="../classes/Authentasaurus.html">Authentasaurus</a> takes advantage
+of rails&#8217; before_filter; it checks for the appropriate permissions
+before every action that requires a login, a write or read permission.
+</p>
+<p>
+At login, authentasaurus would load the user&#8217;s group permissions into
+a session hash and then attempts to read that hash when it meets a require
+helper on a controller.
+</p>
+<h3><a href="../classes/Authentasaurus.html">Authentasaurus</a> uses the following terms:</h3>
+<table>
+<tr><td valign="top"><tt>Area</tt>:</td><td>An area is in plain english the controller&#8217;s name, so if you have a
+controller named &#8220;PostsController&#8221;, the corresponding area name
+would be &#8220;posts&#8221; (just as you type it in the generator command)
+
+</td></tr>
+<tr><td valign="top"><tt>Group</tt>:</td><td>A group is as the name suggests, each group contains a number of users, and
+each user inherits the group permissions, also note that at any given time,
+the user can only belong to one group
+
+</td></tr>
+<tr><td valign="top"><tt>Permission</tt>:</td><td>A permission is one of two, either read or write, but take care, read or
+write is only a naming, and though it doesn&#8217;t make sense, you could
+treat a read permission as a write permission and vice versa, but as i said
+it makes no sense !
+
+</td></tr>
+</table>
+<h2>Generators</h2>
+<p>
+There are two generators in <a
+href="../classes/Authentasaurus.html">Authentasaurus</a>, the default
+generator
+</p>
+<pre>
+  authentasaurus
+</pre>
+<p>
+and the views generator
+</p>
+<pre>
+  authentasaurus_views
+</pre>
+<p>
+The default generator generates configurations and tasks needed by <a
+href="../classes/Authentasaurus.html">Authentasaurus</a>, while the views
+generator generates the views used by <a
+href="../classes/Authentasaurus.html">Authentasaurus</a> in your
+application, this is useful for customizing authentasaurus and is totally
+optional.
+</p>
+<p>
+<a href="../classes/Authentasaurus.html">Authentasaurus</a> views generator
+takes the name of the user controller, by default it&#8217;s users
+</p>
+<pre>
+  script/generate authentasaurus_views users
+</pre>
+<p>
+You can also use namespaces:
+</p>
+<pre>
+  script/generate authentasaurus_views admin/users
+</pre>
+<p>
+Also you can use some options with the <a
+href="../classes/Authentasaurus.html">Authentasaurus</a> views generator to
+add the modules you need:
+</p>
+<table>
+<tr><td valign="top"><tt>--authorizable</tt>:</td><td>generates the views necessary for authorization (groups, areas and
+permissions)
+
+</td></tr>
+<tr><td valign="top"><tt>--invitable</tt>:</td><td>generates the views necessary for invitable users
+
+</td></tr>
+<tr><td valign="top"><tt>--validatable</tt>:</td><td>generates the views necessary for validatable users
+
+</td></tr>
+</table>
+<p>
+You can use a combination of those options like the following example:
+</p>
+<pre>
+  script/generate authentasaurus_views users --authorizable --invitable --validatable
+</pre>
+<h2>Controller Authorization Helpers</h2>
+<p>
+There are four main authorization helpers in <a
+href="../classes/Authentasaurus.html">Authentasaurus</a> for use on
+controllers:
+</p>
+<table>
+<tr><td valign="top"><tt>require_login</tt>:</td><td>requires the user to login before accessing the actions specified
+
+<p>
+<b>ex:</b> Tells <a
+href="../classes/Authentasaurus.html">Authentasaurus</a> that the action
+destroy requires login and that <a
+href="../classes/Authentasaurus.html">Authentasaurus</a> shouldn&#8217;t
+store the request in the session (typically for logout actions)
+</p>
+<ul>
+<li>:skip_request - skips saving the original request (to redirect to after
+login)
+
+</li>
+<li>:user_model - if defined, authentasaurus will use that model instead of the
+default &#8220;User&#8220;
+
+</li>
+<li>:if - specifies a method, proc or string to call to determine if the
+authorization should occur
+
+</li>
+<li>:unless - specifies a method, proc or string to call to determine if the
+authorization should not occur
+
+<p>
+require_login :destroy, :skip_request => true
+</p>
+</li>
+</ul>
+</td></tr>
+<tr><td valign="top"><tt>require_write</tt>:</td><td>requires the user to have a write permission to that area to access the
+actions specified
+
+<p>
+<b>ex:</b> Tells <a
+href="../classes/Authentasaurus.html">Authentasaurus</a> that the actions
+create_user and delete_user requires login and write permission.
+</p>
+<ul>
+<li>:skip_request - skips saving the original request (to redirect to after
+login)
+
+</li>
+<li>:user_model - if defined, authentasaurus will use that model instead of the
+default &#8220;User&#8220;
+
+</li>
+<li>:if - specifies a method, proc or string to call to determine if the
+authorization should occur
+
+</li>
+<li>:unless - specifies a method, proc or string to call to determine if the
+authorization should not occur
+
+<p>
+require_write :create_user, :delete_user
+</p>
+</li>
+</ul>
+</td></tr>
+<tr><td valign="top"><tt>require_read</tt>:</td><td>requires the user to have a read permission to that area to access the
+actions specified
+
+<p>
+<b>ex:</b> Tells <a
+href="../classes/Authentasaurus.html">Authentasaurus</a> that the action
+show_user requires login and read permission.
+</p>
+<ul>
+<li>:skip_request - skips saving the original request (to redirect to after
+login)
+
+</li>
+<li>:user_model - if defined, authentasaurus will use that model instead of the
+default &#8220;User&#8220;
+
+</li>
+<li>:if - specifies a method, proc or string to call to determine if the
+authorization should occur
+
+</li>
+<li>:unless - specifies a method, proc or string to call to determine if the
+authorization should not occur
+
+<p>
+require_read :show_user, :if api_key.nil?
+</p>
+</li>
+</ul>
+</td></tr>
+</table>
+<p>
+You can use any of those class methods on you controllers to restrict
+access levels like so:
+</p>
+<pre>
+  class PostsController &lt; ApplicationController
+    require_login :index
+    require_read :show
+    require_write :new, :create, :edit, :update, :destroy
+
+    def index
+      # your code here
+    end
+
+    def show
+      # your code here
+    end
+
+    def new
+      # your code here
+    end
+
+    def create
+      # your code here
+    end
+
+    def edit
+      # your code here
+    end
+
+    def update
+      # your code here
+    end
+
+    def destroy
+      # your code here
+    end
+  end
+</pre>
+<p>
+In addition there is also the has? helper which is available in both
+Controllers and Views
+</p>
+<table>
+<tr><td valign="top"><tt>has?(permission, area=nil)</tt>:</td><td>Checks if the current user has the appropriate permissions for the area
+specified
+
+<p>
+<b>ex</b>: has?(:write) or has?(:read, :users)
+</p>
+</td></tr>
+</table>
+<p>
+Copyright &#169; 2010 Mash, Ltd., released under the MIT license
+</p>
+
+    </div>
+    
+
+    
+
+    
+    
+
+    
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</div>
+    </div>
+  </body>
+</html>