fat_model_auth 3.0.0 → 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd46f66b0c3c0944de66eef838846681673ede771bc05da2aec7839ff7abf906
+  data.tar.gz: 636e991ce6505513fe7707c092b6c340bc167c9393ab7b2663dd31f946d0a3b5
+SHA512:
+  metadata.gz: 7543fc723da9599c19b098b22cbd63e524d0897355122e537d19c31c0e0f2df272ff83aa6995bf36a91dc46f29365a0b757369908915959ee3036c523c9b2d2d
+  data.tar.gz: ffafe0bd236e7586f063c2c009e062927b614c59ab83d7e31cc4ed413f7a2bb5a22ff7a6718a8f8c3da55ababc27fecf83fd1127d7cac141895bc87ca07bc86d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Brent
+
+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,232 @@
+[![CI](https://github.com/brentgreeff/fat_model_auth/actions/workflows/ci.yml/badge.svg)](https://github.com/brentgreeff/fat_model_auth/actions/workflows/ci.yml)
+
+- [Example app - view installation diff](https://github.com/brentgreeff/basic_rails_5_api/commit/6f0cedff4077c1609d32567bfb889fc8fa908db7)
+
+# FatModelAuth
+
+Wikipedia defines Authorization as:
+
+> “the function of specifying access rights to resources”
+
+Fat Model Auth allows the resources themselves to define these rights.
+
+## Install
+
+Add to Gemfile
+
+    $ gem fat_model_auth
+
+## Fat Model Auth is a simple, clean authorization system for Rails
+
+How simple?
+
+## ArticlesController
+
+```
+before_action :load_article
+
+def edit
+end
+
+def update
+end
+
+private
+
+def load_article
+  Article.find(params[:id])
+end
+```
+
+We want to ensure only the Article's author can view the edit page or update the article.
+
+### Add a before filter to the articles_controller:
+
+`before_action :auth_required, only: [:edit, :update]`
+
+Since this is the article controller, the resource in question is the @article.
+
+auth_required must be called after the resource is already loaded.
+
+Like this:
+
+```
+before_action :load_article, only: [:edit, :update]
+before_action :auth_required, only: [:edit, :update]
+```
+
+auth_required will infer the name of the resource from the controller. In the case of articles_controller, it will look for an @article instance variable.
+
+Try and view the articles#edit page from a browser, or event better: re-run the spec.
+
+You should get an exception:
+
+`undefined method 'allows' for #<Article:0x204a8d8>`
+
+This means the gem is working correctly.
+
+fat_model_auth has generated a call to the @article model:
+
+`@article.allows(current_user).to_edit?`
+
+You need to define a `current_user` method in the application_controller, so that the current user is passed in for evaluation.
+
+If `current_user` is `nil`, the controller will always return access_denied.
+
+
+## In the Article Model
+
+* Add the following:
+
+```
+allows :edit, :update,
+  if: -> (article, user) { article.author == user }
+```
+
+The article model now supports the allows instance method, with 2 chains:
+
+`@article.allows(current_user).to_edit?`
+
+- called from the #edit action when using the auth_required before_action.
+
+`@article.allows(current_user).to_update?`
+
+- called on the update action.
+
+### Access Denied is 404
+
+Trying to access a resource without permission returns 404.
+
+By returning 403 (Forbidden) you might be revealing potentially sensitive information.
+
+404 = that doesn't exist.
+
+403 = Yes that does exist, but you need to try harder to get access to it.
+
+
+### New & Create
+
+When dealing with the #new & #create actions we need a slightly different approach.
+
+Quite often we will build the new object in the action.
+
+```
+def create
+  @article = current_user.articles.build(params[:article])
+  return if access_denied?
+end
+```
+
+When you call access_denied? fat_model_auth will ask the @article if access is allowed.
+
+The following call is generated for you:
+
+`@article.allows(current_user).to_create?`
+
+
+### What if you need different rules for different actions?
+
+```
+allows :edit,
+  if: -> (article, user) { article.author.can_edit? }
+
+allows :update,
+  if: -> (article, user) { article.allows_updating? }
+
+allows :delete,
+  unless: -> (article, user) { user.can_delete?(article) }
+```
+
+Both if: and unless: symbols are supported.
+
+
+### What if you are loading an @article in the StoriesController
+
+We need to tell the controller which object will act as the authority.
+
+      class StoriesController < ApplicationController
+        def override_authority
+          @article
+        end
+      end
+
+
+## View (templates)
+
+Control which links, buttons or controls are displayed to a user:
+
+`<%= link_to('EDIT', edit_article_path(article)) if allowed_to? edit: article -%>`
+
+
+Control which blocks of html are accessible:
+
+```
+<% if allowed_to? edit_or_destroy: article -%>
+  <funky>html</funky>
+<% end %>
+```
+
+
+## Test First
+
+Before adding unit tests, its best to start with a request_spec or another kind of integration test which is focussed on user interaction.
+
+If the integration test covers the logic in the model then that might be sufficient.
+
+## Request specs
+```
+login_as no_good_user
+
+get "/articles/#{article.to_param}/edit"
+
+expect( response ).to have_http_status(404)
+```
+
+If you are using a mock user, you can stub the response
+
+```
+let(:yes) { FatModelAuth::CannedGateKeeper.allows(:edit) }
+
+it "allows"
+  expect(article).to receive(:allows).and_return(yes)
+end
+```
+
+or
+
+```
+let(:no) { FatModelAuth::CannedGateKeeper.denies(:edit) }
+
+it "does not allow"
+  expect(article).to receive(:allows).and_returns(no)
+end
+```
+
+## Model specs
+
+### EDIT
+
+`expect( article.allows( peon ).to_edit? ).to be false`
+
+`expect( article.allows( admin ).to_edit? ).to be true`
+
+### UPDATE
+
+`expect( article.allows( peon ).to_update? ).to be false`
+
+`expect( article.allows( admin ).to_update? ).to be true`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/brentgreeff/fat_model_auth.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/fat_model_auth/canned_gate_keeper.rb

@@ -1,40 +1,44 @@
+# frozen_string_literal: true
+
 module FatModelAuth
   class CannedGateKeeper
-    
-    def self.allows(method)
-      self.new(method => true)
+    def self.allows(action)
+      new(action => true)
     end
-    
-    def self.denies(method)
-      self.new(method => false)
+
+    def self.denies(action)
+      new(action => false)
     end
-    
+
     def self.build(params)
-      self.new(params)
+      new(params)
     end
-    
-    def allows(user)
-      self
-    end
-    
+
     def initialize(params)
       @map = {}
       add_rules(params)
     end
-    
-    def add_rules(params)
-      for param in params
-        response = param.pop
-        @map["to_#{param.pop}?".to_sym] = lambda { response }
-      end
+
+    def allows(_user)
+      self
     end
-    
-    def method_missing(method, *args)
-      unless @map.has_key? method
-        raise NoMethodError, "undefined method allows(user).#{method} for #{self.class}"
-      end
-      
+
+    def method_missing(method, *_args)
+      raise NoMethodError, "undefined method allows(user).#{method} for #{self.class}" unless @map.key?(method)
+
       @map[method].call
     end
+
+    def respond_to_missing?(method, include_private = false)
+      @map.key?(method) || super
+    end
+
+    private
+
+    def add_rules(params)
+      params.each do |action, response|
+        @map[:"to_#{action}?"] = -> { response }
+      end
+    end
   end
 end

data/lib/fat_model_auth/controller_helpers.rb

@@ -1,20 +1,19 @@
+# frozen_string_literal: true
+
 module FatModelAuth
-  class AuthException < Exception; end
-  
+  class AuthException < StandardError; end
+
   module ControllerHelpers
     protected
-    
+
     def auth_required
-      authority = get_authority
-      
-      access_granted = authority.allows(current_user).send "to_#{params[:action]}?"
+      access_granted = authority.allows(current_user).send("to_#{params[:action]}?")
       respond_with_404_page unless access_granted
     end
-    
+
     def access_denied?
-      authority = get_authority
-      
-      access_granted = authority.allows(current_user).send "to_#{params[:action]}?"
+      access_granted = authority.allows(current_user).send("to_#{params[:action]}?")
+
       if access_granted
         false
       else
@@ -22,24 +21,29 @@ module FatModelAuth
         true
       end
     end
-    
+
     private
-    
-    def get_authority
-      if self.respond_to? :override_authority
-        authority = override_authority
-        raise FatModelAuth::AuthException, "override_authority defined but nil" if authority.nil?
+
+    def authority
+      if respond_to?(:override_authority, true)
+        result = override_authority
+        raise FatModelAuth::AuthException, 'override_authority defined but nil' if result.nil?
+
       else
-        authority_name = params[:controller].singularize
-        authority = instance_variable_get("@#{authority_name}")
-        raise FatModelAuth::AuthException, "#{authority_name} is nil" if authority.nil?
+        authority_name = controller_name.singularize
+        result = instance_variable_get("@#{authority_name}")
+        raise FatModelAuth::AuthException, "#{authority_name} is nil" if result.nil?
+
       end
-      
-      return authority
+      result
     end
-    
+
     def respond_with_404_page
-      render "#{Rails.root}/public/404.html", :status => 404
+      if defined?(Rails) && Rails.respond_to?(:application) && Rails.application
+        render file: Rails.public_path.join('404.html'), status: :not_found, layout: false
+      else
+        head :not_found
+      end
     end
   end
 end

data/lib/fat_model_auth/gate_keeper.rb

@@ -1,33 +1,56 @@
+# frozen_string_literal: true
+
 module FatModelAuth
   class GateKeeper
-    
     def initialize(params)
       @map = {}
       add_rules(params)
     end
-    
+
     def add_rules(params)
-      auth_condition = params.pop[:if]
-      methods = params
-      
-      for method in methods
-        @map["to_#{method}?".to_sym] = auth_condition
+      *methods, options = params
+      unless options.is_a?(Hash) && (options[:if] || options[:unless])
+        raise ArgumentError, 'allows requires an :if or :unless condition'
+      end
+
+      auth_condition = options[:if] || negate(options[:unless])
+
+      methods.each do |method|
+        key = :"to_#{method}?"
+        raise ArgumentError, "rule for :#{method} is already defined" if @map.key?(key)
+
+        @map[key] = auth_condition
       end
     end
-    
+
     def check(model, user)
-      @model = model
-      @user = user
-      self
+      Checker.new(@map, model, user)
+    end
+
+    private
+
+    def negate(predicate)
+      proc { |*args| !predicate.call(*args) }
     end
-    
-    def method_missing(method, *args)
-      unless @map.has_key? method
-        raise NoMethodError, "undefined method allows(user).#{method} for #{@model.inspect}"
+
+    class Checker
+      def initialize(map, model, user)
+        @map = map
+        @model = model
+        @user = user
+      end
+
+      def method_missing(method, *_args)
+        raise NoMethodError, "undefined method allows(user).#{method} for #{@model.inspect}" unless @map.key?(method)
+
+        return false if @user.nil?
+
+        @map[method].call(@model, @user)
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        @map.key?(method) || super
       end
-      return false if @user.nil?
-      
-      @map[method].call(@model, @user)
     end
   end
 end

data/lib/fat_model_auth/model_helpers.rb

@@ -1,18 +1,16 @@
+# frozen_string_literal: true
+
 module FatModelAuth
   module ModelHelpers
     def allows(*params)
-      if self.respond_to? :gate_keeper
-        class_eval do
-          self.gate_keeper.add_rules(params)
-        end
+      if respond_to?(:gate_keeper) && gate_keeper
+        gate_keeper.add_rules(params)
       else
-        class_eval do
-          cattr_accessor :gate_keeper
-          self.gate_keeper = FatModelAuth::GateKeeper.new(params)
-          
-          define_method "allows" do |user|
-            self.gate_keeper.check(self, user)
-          end
+        class_attribute :gate_keeper
+        self.gate_keeper = FatModelAuth::GateKeeper.new(params)
+
+        define_method :allows do |user|
+          self.class.gate_keeper.check(self, user)
         end
       end
     end

data/lib/fat_model_auth/railtie.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module FatModelAuth
+  class Railtie < Rails::Railtie
+    initializer 'fat_model_auth.initialize' do |_app|
+      ActiveSupport.on_load :action_controller do
+        include FatModelAuth::ControllerHelpers
+      end
+
+      ActiveSupport.on_load :active_record do
+        extend FatModelAuth::ModelHelpers
+      end
+
+      ActiveSupport.on_load :action_view do
+        include FatModelAuth::ViewHelpers
+      end
+    end
+  end
+end

data/lib/fat_model_auth/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FatModelAuth
+  VERSION = '5.0.0'
+end

data/lib/fat_model_auth/view_helpers.rb

@@ -1,18 +1,14 @@
+# frozen_string_literal: true
+
 module FatModelAuth
   module ViewHelpers
     def allowed_to?(options)
-      authority = options.values.first
-      
-      get_actions(options).each do |action|
-        return true if authority.allows(current_user).send "to_#{action}?"
+      actions, authority = options.first
+      raise FatModelAuth::AuthException, "#{authority.inspect} is nil" if authority.nil?
+
+      actions.to_s.split('_or_').any? do |action|
+        authority.allows(current_user).send("to_#{action}?")
       end
-      return false
-    end
-    
-    private
-    
-    def get_actions(options)
-      return options.keys.first.to_s.split('_or_')
     end
   end
 end

data/lib/fat_model_auth.rb

@@ -1,9 +1,18 @@
-require 'fat_model_auth/canned_gate_keeper'
-require 'fat_model_auth/controller_helpers'
-require 'fat_model_auth/gate_keeper'
-require 'fat_model_auth/model_helpers'
-require 'fat_model_auth/view_helpers'
-
-ActionController::Base.send(:include, FatModelAuth::ControllerHelpers)
-ActiveRecord::Base.send(:extend, FatModelAuth::ModelHelpers)
-ActionView::Base.send(:include, FatModelAuth::ViewHelpers)
+# frozen_string_literal: true
+
+require 'action_pack'
+require 'active_support'
+
+require 'fat_model_auth/version'
+
+require 'fat_model_auth/railtie' if defined?(Rails)
+
+module FatModelAuth
+  extend ActiveSupport::Autoload
+
+  autoload :ControllerHelpers, 'fat_model_auth/controller_helpers'
+  autoload :ModelHelpers,      'fat_model_auth/model_helpers'
+  autoload :ViewHelpers,       'fat_model_auth/view_helpers'
+  autoload :GateKeeper,        'fat_model_auth/gate_keeper'
+  autoload :CannedGateKeeper,  'fat_model_auth/canned_gate_keeper'
+end

metadata

@@ -1,79 +1,210 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: fat_model_auth
-version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: false
-  segments: 
-  - 3
-  - 0
-  - 0
-  version: 3.0.0
+version: !ruby/object:Gem::Version
+  version: 5.0.0
 platform: ruby
-authors: 
+authors:
 - Brent Greeff
-autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-30 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
-description: Clean resource based Authorisation plugin for Rails.
-email: email@brentgreeff.com
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Models define access rules via a DSL. Controllers call auth_required.
+  Access denied returns 404.
+email:
+- email@brentgreeff.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- MIT-LICENSE
-- README.rdoc
-files: 
-- MIT-LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
 - lib/fat_model_auth.rb
 - lib/fat_model_auth/canned_gate_keeper.rb
 - lib/fat_model_auth/controller_helpers.rb
 - lib/fat_model_auth/gate_keeper.rb
 - lib/fat_model_auth/model_helpers.rb
+- lib/fat_model_auth/railtie.rb
+- lib/fat_model_auth/version.rb
 - lib/fat_model_auth/view_helpers.rb
-- test/fat_model_auth_test.rb
-- test/test_helper.rb
-has_rdoc: true
-homepage: http://github.com/brentgreeff/fat_model_auth
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+homepage: https://github.com/brentgreeff/fat_model_auth
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/brentgreeff/fat_model_auth
+  source_code_uri: https://github.com/brentgreeff/fat_model_auth
+  changelog_uri: https://github.com/brentgreeff/fat_model_auth/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
-summary: Clean resource based Authorisation plugin for Rails.
+rubygems_version: 3.6.9
+specification_version: 4
+summary: 'Resource-level Rails authorization: models declare rules, controllers enforce
+  them.'
 test_files: []
-

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 [Brent Greeff]
-
-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,172 +0,0 @@
-= Fat Model Auth
-
-Wikipedia defines Authorization as 'the function of specifying access rights to resources'.
-Fat Model Auth allows the resources themselves to define these rights.
-
-== Fat Model Auth is a simple, clean authorization system for Rails
-
-* How simple?
-
-== Controller
-
-* Imagine you have a controller for Articles:
-      
-      before_filter :load_article
-      
-      def edit
-      end
-      
-      def update
-        # Update shazam
-      end
-      
-      private
-      
-      def load_article
-        Article.find(params[:id])
-      end
-
-* We want to ensure only the Articles Author can view the edit page or update
-* an Article.
-
-* Just Add a before filter:
-
-      before_filter :auth_required, :only => [:edit, :update]
-
-* Add it AFTER you load the article
-
-Go ahead and try and view the article
-
-* We are missing something:
-
-      undefined method 'allows' for #<Article:0x204a8d8>
-
-== Model
-
-* Just add the following to your Article model:
-
-      allows :edit, :update,
-        :if => proc {|article, user| article.author == user}
-
-* Need different rules for different actions:
-
-      allows :edit,
-        :if => proc {|article, user| article.author.name.eql? 'Jeff'}
-      
-      allows :update,
-        :if => proc {|article, user| article.allows_updating?}
-
-
-Control which functions are displayed to a user
-
-== View
-
-      <%= link_to('EDIT', edit_article_path(article)) if allowed_to? :edit => article -%>
-
-* What about groups of controls:
-
-      <% if allowed_to? :edit_or_destroy => article -%>
-        <funky>html</funky> 
-      <% end %>
-      
-
-Thats it.
-
-== Test First
-
-The rules that define access control, are defined in the model.
-If you are testing first, start with a unit test:
-
-* EDIT
-
-      assert @article.allows(@article.author).to_edit?
-      
-      deny @article.allows(@someone_else).to_edit?
-
-* UPDATE
-
-      assert @article.allows(@jeff).to_update?
-      
-      deny @article.allows(@sammy).to_update?
-
-These magic methods are created when you define 'allows' on your model.
-
-When you say 'auth_required' in a before filter:
-The plugin looks for an object based on the name of the controller:
-
-So if you put the before filter in the 'articles_controller'
-and you call the 'edit' action,
-
-it generates the following call:
-
-      @article.allows(current_user).to_edit?
-
-
-What happens if I am editing articles but I am not in the articles_controller?
-
-* Just add this to the controller
-      
-      class RestlessController < ApplicationController
-        def override_authority
-          @article
-        end
-      end
-
-== Remember
-
-1. A nil current_user will always return access_denied.
-
-== Access Denied is 404
-
-Thats right deal with it or fork it.
-
-Trying to access a resource without permission returns 404
-In other words:
-
-      "Say What?"
-
-== New & Create and complex conditons
-
-If you have complex conditions or when creating a new object
-it may not have the information you need in a before filter.
-
-You can always get the same result by being explicit in the method:
-      
-      # Articles controller
-      
-      def create
-        @article = current_user.articles.build(params[:article])
-        return if access_denied?
-      end
-
-== Testing my controllers
-
-      login_as @no_good_user
-      get :edit, :id => @article.id
-      
-      assert_response :not_found
-      assert_template 'public/404'
-
-If you are using mock user, you may want to stub the response
-
-@article.expects(:allows).returns(FatModelAuth::CannedGateKeeper.allows(:edit))
-
-or
-
-@article.expects(:allows).returns(FatModelAuth::CannedGateKeeper.denies(:edit))
-
-
-== Testing my views
-
-Who does that?
-
-step 1. Install should_pricot
-      
-      login_as @no_good_user
-      get :edit, :id => @article.id
-      
-      element('#power_user a[@href="/create/havok"]').should_be_missing
-
-
-
-Copyright (c) 2009 [Brent Greeff], released under the MIT license

data/Rakefile

@@ -1,23 +0,0 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the fat_model_auth plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the fat_model_auth plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'FatModelAuth'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-2.0.0

data/test/fat_model_auth_test.rb

@@ -1,8 +0,0 @@
-require 'test_helper'
-
-class FatModelAuthTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
-  end
-end

data/test/test_helper.rb

@@ -1,3 +0,0 @@
-require 'rubygems'
-require 'active_support'
-require 'active_support/test_case'