Authorizr 0.1.1

data/README.rdoc

@@ -0,0 +1,85 @@
+== Authorizr
+A General purpose authorization framework.
+
+Now sporting:
+
+- Controller level, block based authorization of resources and actions
+- Out of the box whitelist approach
+- Easy debugging of authorization actions with logger output
+
+== Implementing:
+
+Simply add one line to your application controller to authorize all requests for all controllers:
+
+app/controllers/application_controller.rb:
+
+    class ApplicationController < ActionController::Base
+      protect_from_forgery
+      authorize_all
+    end
+
+
+Then in your controllers define an authorize block.  Simply return true if the user is authorized to view the resoure and false if not.  The block takes one parameter, the environment.
+
+=== Examples:
+
+app/controllers/posts_controller.rb:
+
+  #Example 1, deny everything always
+  authorize do |env|
+    false
+  end
+
+  #Example 2, approve everything always
+  authorize do |env|
+    true
+  end
+
+  #Example 3, approve index, show, create, new actions for everyone
+  # =>        and edit, update, destroy actions for the owner
+  authorize do |env|
+    case env[:action]
+    when :index, :show, :create, :new
+      true
+    when :edit, :update, :destroy
+      post = Post.find env[:params][:id]
+      post.owner == current_user
+    else
+      false
+    end
+  end
+
+  #Example 4 [Advanced], Example 3 rewritten to use preloaded resource with user hook in place
+  authorize do |env|
+    case env[:action]
+    when :index, :show, :create, :new
+      true
+    when :edit, :update, :destroy
+      env[:resource].user == env[:user]
+    else
+      false
+    end
+  end
+
+Full detail on the environment passed into the authorize block:
+
+    env = {
+        :user => current_user,                  #nil unless ApplicationController responds to current_user
+        :action => self.action_name,            #
+        :controller => self,                    #
+        :params => params,                      #
+        :resource => resource,                  # RESTful actions will attempt to fill this with your resource
+        :model => model                         #
+    }
+
+
+== License
+This code is released under The MIT License (MIT)
+Copyright (c) 2011 Robert L Carpenter
+
+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/lib/authorizr/controller.rb

@@ -0,0 +1,143 @@
+
+module Authorizr
+  module Controller
+    module ClassMethods
+      def authorize_all
+        before_filter :authorize!
+      end
+
+      #a hook for other object to authorize from outside the request object
+      def manually_authorize params={}
+        params[:user]     ||= nil
+        params[:resource] ||= nil
+        params[:action]   ||= nil
+
+        auth_block = @@authorization_blocks[self.to_s]
+        if auth_block.nil?
+          authorized = false
+        else
+          authorized = auth_block.call({
+                         :user => params[:user],
+                         :resource => params[:resource],
+                         :action => params[:action],
+                         :params => {},
+                         :model => params[:resource].class
+                       })
+         end
+      end
+
+      #these methods will be called from the Class level, not the instance level
+      def authorize &block
+        @@authorization_blocks[self.to_s] = block unless block.nil?
+      end
+
+      def unauthorized &block
+        @@failure_blocks[self.to_s] = block unless block.nil?
+      end
+
+      #build maintain a catalog of the auth/unauth blocks provided by the child controllers
+      def create_authblock_catalog
+        @@authorization_blocks = {}
+        @@failure_blocks = {}
+      end
+
+      mattr_reader :authorization_blocks
+      mattr_reader :failure_blocks
+    end
+
+    def self.included to
+      to.extend ClassMethods
+      to.create_authblock_catalog
+    end
+
+
+    #the before-filter that gets called on every action
+    def authorize!
+      authorized = call_auth_block
+
+      logit authorized
+      return true if authorized
+      call_failure_block
+    end
+
+    def call_auth_block
+      auth_block = self.class.authorization_blocks[self.class.to_s]
+      return false if auth_block.nil?
+
+      params = request.parameters || nil
+
+      model, resource = build_resource params
+
+      auth_block.call({
+        :user => current_user,
+        :action => self.action_name,
+        :controller => self,
+        :params => params,
+        :resource => resource,
+        :model => model
+      })
+    end
+
+    def call_failure_block
+      failure_block = self.class.failure_blocks[self.class.to_s]
+
+      if failure_block.nil?
+        render_error and return false
+      else
+        abort_action = failure_block.call({:controller => self})
+
+        if !abort_action
+          # if a render has been declared by the abort action, don't call the default error render error
+          render_error unless performed?
+          return false
+        else
+          abort_action
+        end
+      end
+    end
+
+    def logit authorized
+      if Rails.env == 'development'
+        if authorized
+          Rails.logger.warn "\033[32mGRANT:\033[0m #{self.controller_name} #{self.action_name}"
+        else
+          Rails.logger.warn "\033[31mDENY:\033[0m #{self.controller_name} #{self.action_name}"
+        end
+      end
+    end
+
+    #override in application
+    def current_user
+      nil
+    end
+
+    #attempt to sort out a model from the url and controller name
+    def build_resource parameters
+      return [nil, nil] if parameters.nil? || parameters[:id].nil?
+      model_name = self.controller_name.classify
+
+      begin
+        model = Module.const_get model_name
+        if model.respond_to? :find
+          resource = model.find parameters[:id]
+        else
+          model = nil
+        end
+      rescue ActiveRecord::RecordNotFound
+        Rails.logger.warn "\033[31m Record not found.  Model:#{model_name} ID:#{parameters[:id]}"
+        model = resource = nil
+      rescue NameError
+        Rails.logger.warn "\033[31m Name Error.  Model:#{model_name} ID:#{parameters[:id]}"
+        model = resource = nil
+      end
+
+      [model, resource]
+    end
+
+    def render_error
+      render :text => '404'
+    end
+  end
+end
+
+ActionController::Base.send :include, Authorizr::Controller

data/lib/authorizr/engine.rb

@@ -0,0 +1,8 @@
+require "authorizr"
+require "rails"
+
+module Authorizr
+  class Engine < Rails::Engine
+    engine_name :authorizr
+  end
+end

data/lib/authorizr/model.rb

@@ -0,0 +1,57 @@
+
+module Authorizr
+  module Model
+    module ClassMethods
+      # Attempts to find the controller class for this model using railsy style
+      # Override this method if you use nonstandard controller names...
+      def controller
+        guess = ActiveSupport::Inflector.pluralize(self.name) + 'Controller'
+        begin
+          troller = Object.const_get guess
+        rescue NameError
+          nil
+        end
+      end
+
+      def authorize params={}
+        params[:user] ||= nil
+        params[:resource] ||= nil
+        params[:action] ||= nil
+
+        troller = self.controller
+        if troller.respond_to? :manually_authorize
+          troller.manually_authorize params
+        else
+          raise NoMethodError, "#{troller.name} does not respond to :manually_authorize"
+        end
+      end
+
+      def permissable
+        self.class_eval do
+          include Authorizr::Model::Permissable
+        end #block
+      end #def permissable
+
+    end #ClassMethods
+
+    #methods included in models which declare themselves to be permissable
+    module Permissable
+      def can? action, object
+        if object.respond_to?(:authorize)
+          object.authorize :user => self, :resource => nil, :action => action
+        elsif object.class.respond_to?(:authorize)
+          object.class.authorize :user => self, :resource => object, :action => action
+        else
+          false
+        end
+      end
+    end
+
+    def self.included to
+      to.extend ClassMethods
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, Authorizr::Model

data/lib/authorizr.rb

@@ -0,0 +1,6 @@
+require 'authorizr/engine'
+require 'authorizr/controller'
+require 'authorizr/model'
+
+module Authorizr
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: Authorizr
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Robert Carpenter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: Authorizr
+  requirement: &70346914310720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70346914310720
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: &70346914310240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70346914310240
+description: ! 'Authorizr: A simple controller-centric authorization framework.'
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- lib/authorizr.rb
+- lib/authorizr/controller.rb
+- lib/authorizr/engine.rb
+- lib/authorizr/model.rb
+- README.rdoc
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Authentication and Authorization
+test_files: []