maybee 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Matthias Grosser
+
+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.md

@@ -0,0 +1,211 @@
+# maybee
+
+Simple Model-Based Authorization for Rails.
+
+## Install
+```
+gem install maybee
+```
+
+## Usage
+
+In maybee, subjects may do the things that objects allow them to do.
+
+To have an authorization subject, which will in most cases be your user model:
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_authorization_subject
+end
+```
+To have models that act as authorization objects, i.e. something that users may or may not use:
+
+```ruby
+class Car < ActiveRecord::Base
+  acts_as_authorization_object
+end
+```
+
+### Defining access rules
+
+Access rules are defined inside models using a simple DSL and may be named as you like. A named rule like
+
+```ruby
+class Car < ActiveRecord::Base
+  acts_as_authorization_object
+  
+  allows :to => :drive
+end
+```
+will have model instances respond `true` if asked
+
+```ruby
+car.allow?(:drive, user)
+ => true
+```
+
+Usually, you will want to restrict access based on some internal state of the model (the authorization object) or the user (the subject). This can be accomplished using the options `:if`, `:unless`, `:if_subject` and `:unless_subject`:
+
+```ruby
+allows :to => :drive, :if => :license_plate_valid?, :if_subject => :has_drivers_license?
+```
+
+With this declaration, the car would allow any (ruby) object to drive, if the car has a valid license plate and the ruby object responds to `#has_drivers_license?` with a true value. 
+
+In order to limit the access to instances of a certain class, you can include the desired subject class(es) in the rule declaration:
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_authorization_subject
+end
+
+# only some users are actual drivers
+class Driver < User
+  def drunk?
+    0 == self.drinks
+  end
+end
+
+class Car < ActiveRecord::Base
+  acts_as_authorization_object
+  
+  allows :drivers, :to => :drive, :unless_subject => :drunk?
+end
+```
+
+If you do not care for the subject class, you may also write
+
+```ruby
+allows_to :drive, :if => ...
+```
+
+which is the same as `allows :to => ...`
+
+Multiple access rights may be given in the same declaration:
+
+```ruby
+allows :drivers, :to => [:start, :drive], :if => ...
+```
+
+
+### Passing blocks
+
+It is also possible to pass a proc to any of the conditional options:
+
+```ruby
+allows :drivers, :to => :start, :if => lambda { |driver| gasoline_level > 0 }
+```
+
+Blocks passed to `:if` and `:unless` are evaluated inside the authorization object, while `:if_subject` and `:unless_subject` get evaluated inside the authorization subject (the user).
+
+
+### Dealing with nil
+
+In most cases, you will want to restrict authorizations to authorized subjects only. So maybee will refuse any access by default if the subject is `nil`. For the special case, where an access should also be granted if the subject is nil, use the `:allow_nil` option:
+
+```ruby
+class Image
+  allows :users, :to => :view, :if => :publicly_accessible?, :allow_nil => true
+  allows :users, :to => :view, :if_subject => lambda { |image| self.company_id == image.company_id }
+
+  def publicly_accessible?
+    # implementation, or a simple attribute
+  end
+end
+```
+
+This would allow anyone (including `nil`) to view an image if it is publicly accessible, and allow users to view the images belonging to the same company as the user.
+
+### Authorizing create, update and destroy on the model level (in an MVC way)
+
+There are three special accesses which limit creation, updating and destruction of records. By default, if a model is an authorization object, it will prevent new records from being created, and existing ones from being updated or destroyed. As models by default do not know about the application's `current_user`, maybee defines an `attr_accessor` on auth objects where the `authorization_subject` can be set by the controller.
+
+In the simplest form, the access to create, update and destroy would be granted regardless of the `authorization_subject`. This would be the default behaviour of ActiveRecord, where besides validations there is no restriction on these operations:
+
+```ruby
+allows_to :create, :update, :destroy, :allow_nil => true
+```
+
+Say you have models for users and roles, and you want normal users not to be able to assign roles, but only admins:
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_authorization_subject
+  
+  has_many :user_roles, :dependent => :destroy
+  has_many :roles, :through => :user_roles
+end
+
+
+class Role < ActiveRecord::Base
+end
+
+class UserRole < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :role
+  
+  acts_as_authorization_object
+  
+  allows :users, :to => [:create, :update, :destroy], :if_subject => :admin?
+end
+```
+
+Just adding a role to a user is no longer possible this way, as the association object `UserRole` requires an admin subject to be set in order to be created.
+
+```ruby
+user_role = user.user_roles.build
+user_role.save
+ => false
+user_role.authorization_subject = current_user # current_user is an admin
+user_role.save
+ => true
+```
+
+### Enforcing rules
+
+The idea behind maybee was to do things in an explicit way, so it doesn't do any magic in the background, but it provides your implementation with methods to determine whether an access is authorized or not.
+
+In a classic Rails application, the controller is responsible for restricting access to objects. However, more complex rules of what is allowed and what is not should not go into the controller code, but be placed inside the model itself. This is where maybee can be used.
+
+```ruby
+
+class ImagesController < ApplicationController
+  before_filter :find_image
+  
+  def show
+    render
+  end
+  
+  private
+  
+  def find_image
+    @image = Image.find_by_id(params[:id]) or return(not_found)
+    @image.allow?(:view, current_user) or return(forbidden)
+  end
+end
+```
+
+Instead of `allow?` you can always write `user.may?`
+
+```ruby
+current_user.may?(:view, @image)
+```
+
+### User feedback
+
+Usually, you want to give some feedback to the user when she attempted an access which was denied. Maybee provides two authorization query methods which set an error on the record every time an access was denied.
+
+```ruby
+@image.authorize?(:destroy, user)
+```
+sets an error on the image instance when the user is not allowed to destroy it.
+
+```ruby
+current_user.authorized_to?(:destroy, @image)
+```
+
+is equivalent.
+
+### Default authorization subject
+
+For more generic implementations the subject argument to `authorize?` and `allow?` can be left out. It will then default to the value of the `authorization_subject` accessor, which should be set before, for example in a `before_filter`.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Run all tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['test/cases/*_test.rb']
+  t.verbose = true
+end
+
+desc 'Generate documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Maybee'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/locales/de.yml

@@ -0,0 +1,12 @@
+de:
+
+  activerecord:
+    errors:
+      messages:
+        not_authorized: "Keine Berechtigung zum %{access} dieses Objekts vorhanden"
+        
+    authorizations:
+      'active_record/base':
+        create: Anlegen
+        update: Speichern
+        destroy: Löschen

data/lib/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+
+  activerecord:
+    errors:
+      messages:
+        not_authorized: "You are not authorized to %{access} this object"
+
+    authorizations:
+      'active_record/base':
+        create: create
+        update: update
+        destroy: destroy

data/lib/maybee/authorization.rb

@@ -0,0 +1,36 @@
+module Maybee
+
+  class Authorization
+    attr_reader :access, :subject_classes, :conditionals, :allow_nil
+    
+    def initialize(access, subject_classes, options)
+      raise ArgumentError, "Access name must be symbol" unless access.is_a?(Symbol)
+      @access = access
+      #raise ArgumentError, "Subject classes must be an array" unless subject_classes.is_a?(Array)
+      @subject_classes = subject_classes.empty? ? nil : subject_classes
+      options.assert_valid_keys(:if, :unless, :if_subject, :unless_subject, :allow_nil)
+      @allow_nil = options.delete(:allow_nil)
+      @conditionals = options.empty? ? nil : options      
+    end
+    
+    def granted?(object, subject)
+      return false if !@allow_nil && @subject_classes && @subject_classes.none? { |klass| subject.is_a?(klass) }
+      return true unless @conditionals
+      return true if @conditionals.all? do |clause, cond|
+        if :if_subject == clause || :unless_subject == clause
+          if @allow_nil && subject.nil?
+            next(true)
+          else
+            receiver, argument = subject, object
+          end
+        else
+          receiver, argument = object, subject
+        end
+        result = cond.is_a?(Proc) ? receiver.instance_exec(argument, &cond) : receiver.send(cond)
+        (:if_subject == clause || :if == clause) ? result : !result
+      end
+      false
+    end
+  end
+  
+end

data/lib/maybee/authorization_object.rb

@@ -0,0 +1,60 @@
+module Maybee
+
+  module AuthorizationObject
+  
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_attribute :authorizations
+      base.authorizations = {}
+      base.class_eval do
+        attr_accessor :authorization_subject
+        before_create { authorize?(:create) }
+        before_update { authorize?(:update) }
+        before_destroy { authorize?(:destroy) }
+      end
+    end
+  
+    module ClassMethods
+      def allows(*args)
+        options = args.extract_options!
+        accesses = Array(options.delete(:to))
+        raise ArgumentError, "No accesses given" if accesses.empty?
+        exclusive = options.delete(:exclusive)
+        subject_classes = args.map { |name| name.is_a?(Symbol) ? name.to_s.classify.constantize : name.constantize }
+        additional_authorizations = accesses.inject({}) { |hsh, access| hsh[access] = [Authorization.new(access, subject_classes, options)]; hsh }
+        self.authorizations = authorizations.merge(additional_authorizations) { |access, previous_auths, new_auths| exclusive ? new_auths : previous_auths + new_auths }
+      end
+      
+      def allows_to(*accesses)
+        options = accesses.extract_options!
+        allows options.merge(:to => accesses)
+      end
+    end
+    
+    def allow?(access, subject = authorization_subject)
+      authorizations = self.class.authorizations[access] or return(false)
+      authorizations.any? { |authorization| authorization.granted?(self, subject) }
+    end
+    
+    def authorize?(access, subject = authorization_subject)
+      errors.clear
+      return true if allow?(access, subject)
+      defaults = ([ActiveRecord::Base] + self.class.lookup_ancestors).map do |klass|
+        :"#{self.class.i18n_scope}.authorizations.#{klass.model_name.i18n_key}.#{access}"
+      end
+      key = defaults.shift
+      errors.add(:base, :not_authorized, :access => I18n.translate(key, :default => defaults))
+      false
+    end
+    
+    #def with_authorization_to(access, object = self)
+    #  if authorization_user && authorization_user.may?(access, object)
+    #    yield
+    #  else
+    #    false
+    #  end
+    #end
+    
+  end
+  
+end

data/lib/maybee/authorization_subject.rb

@@ -0,0 +1,15 @@
+module Maybee
+
+  module AuthorizationSubject
+    
+    def may?(access, object)
+      object.allow?(access, self)
+    end
+    
+    def authorized_to?(access, object)
+      object.authorize?(access, self)
+    end
+
+  end
+  
+end

data/lib/maybee/i18n.rb

@@ -0,0 +1,3 @@
+files = Dir[File.join(File.dirname(__FILE__), '../locales/*.yml')]
+I18n.load_path.concat(files)
+

data/lib/maybee/version.rb

@@ -0,0 +1,3 @@
+module Maybee
+  VERSION = '0.0.1'
+end

data/lib/maybee.rb

@@ -0,0 +1,37 @@
+require 'active_record'
+require 'active_support'
+require 'i18n'
+
+require 'maybee/version'
+require 'maybee/authorization'
+require 'maybee/authorization_object'
+require 'maybee/authorization_subject'
+require 'maybee/i18n'
+
+module Maybee
+
+  def self.included(base) # :nodoc:
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+  
+    #
+    #
+    #
+    def acts_as_authorization_object
+      include AuthorizationObject
+    end
+    
+    #
+    #
+    #
+    def acts_as_authorization_subject
+      include AuthorizationSubject
+    end    
+  end
+
+end
+
+ActiveRecord::Base.class_eval { include Maybee }
+

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: maybee
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthias Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2151917620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151917620
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2151916900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151916900
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2151916160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151916160
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2151915520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151915520
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2151914880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151914880
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2151914120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *2151914120
+description: A simple, yet flexible approach to model-based authorization
+email: mtgrosser@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/maybee/authorization.rb
+- lib/maybee/authorization_object.rb
+- lib/maybee/authorization_subject.rb
+- lib/maybee/i18n.rb
+- lib/maybee/version.rb
+- lib/maybee.rb
+- lib/locales/de.yml
+- lib/locales/en.yml
+- MIT-LICENSE
+- README.md
+- CHANGELOG
+- Rakefile
+homepage: http://rubygems.org/gems/maybee
+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.11
+signing_key: 
+specification_version: 3
+summary: Simple Model-Based Authorization for Rails
+test_files: []