action-guard 0.0.1 → 0.0.2

data/README.md

@@ -12,26 +12,91 @@ following design principles in mind:
   'fullpath' to the authorization which is then matched against a set of 
   authorisation rules.
 
+# Documentation
+
+Documentation is work in progress. PLease this besides this readme, you
+can  read the
+[specs](https://github.com/rwestgeest/action-guard/tree/master/spec)
+and find the rdoc here:
+
+http://rubydoc.info/gems/action-guard
+
 # Installing
 
+        gem install action-guard 
+
+or put action-guard in your Gemfile and 
 
+        bundle install
 
-# Usage
+# Getting started
 
-Assuming a Rails application you specify an initializer with the
-following content
+Assuming a Rails application, you specify an initializer with the
+following content:
 
+        ActionGuard.load_from_file(File.join(Rails.root, 'config', 'authorization.rules'))
 
+and a file called authorization.rules in the config directory with
+something like:
 
         role :god , 0
         role :admin, 1
         role :worker, 2
 
         allow '/'
-        allow '/tracking', :at_least => :admin
+        allow '/tracking', :only_by => :admin
         allow '/maintenance', :at_least => :worker
         allow '/maintenance/[0-9]*/edit', :at_least => :admin
         allow '/maintenance/[0-9]*$', :at_least => :admin
 
+and some model with a string typed attribute called 'role', in an
+account or user model e.g.:
+
+        class Account
+          attr_reader :role
+        end
+
+then in your (Application) controller you can
+
+        class ApplicationController < ActionController::Base
+          prepend_before_filter :authorize_action
+
+          protected
+          def authorized?(fullpath)
+            ActionGuard.authorized?(current_account, fullpath)
+          end
+          helper_method :authorized?
+
+          private
+          def authorize_action
+            unless authorized?(request.fullpath)
+              flash[:alert] = I18n.t("not_authorized")
+              sign_out current_account if current_account
+              redirect_to new_account_session_path
+            end
+          end
+        end
+
+(In the example above, the path helpers, sign_out and current_account
+methods are from [Devise]i(https://github.com/plataformatec/devise))
+
+This is in essence all you need to get actionguard working. You could
+also hide non authorized linkes by adding an authorized_link_to method
+like so:
+
+      def authorized_link_to(what, path, options = {})
+        if (authorized?(path)) 
+          link_to(what, path, options)
+        end
+      end
+
+or overwrite link_to
+
+# Issues - bugs
+
+If you find any issues in the code please let me know through:
+
+https://github.com/rwestgeest/action-guard/issues
 
+also consult that list for known issues in ActionGuard
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/action-guard.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{action-guard}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rob Westgeest"]
+  s.date = %q{2011-06-27}
+  s.description = %q{authorisation module of actions based on url-paths for usage in Rails and possibly other ruby based web frameworks}
+  s.email = %q{rob.westgeest@qwan.it}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".gitignore",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "action-guard.gemspec",
+    "lib/action-guard.rb",
+    "lib/action-guard/base.rb",
+    "lib/action-guard/role.rb",
+    "lib/action-guard/rules.rb",
+    "lib/action-guard/syntax.rb",
+    "lib/action-guard/version.rb",
+    "script/authorization.rules",
+    "script/console",
+    "spec/action-guard_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rwestgeest/action-guard}
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Action guard-0.0.2}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ZenTest>, [">= 4.2.0"])
+      s.add_development_dependency(%q<rspec>, ["> 2.5.0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ZenTest>, [">= 4.2.0"])
+      s.add_dependency(%q<rspec>, ["> 2.5.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ZenTest>, [">= 4.2.0"])
+    s.add_dependency(%q<rspec>, ["> 2.5.0"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: action-guard
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Rob Westgeest
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-26 00:00:00 +02:00
+date: 2011-06-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -130,7 +130,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- action_guard.gemspec
+- action-guard.gemspec
 - lib/action-guard.rb
 - lib/action-guard/base.rb
 - lib/action-guard/role.rb
@@ -174,6 +174,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Action guard-0.0.1
+summary: Action guard-0.0.2
 test_files: []
 

data/action_guard.gemspec

@@ -1,24 +0,0 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "action_guard/version"
-
-Gem::Specification.new do |s|
-  s.name        = "action_guard"
-  s.version     = ActionGuard::Version::STRING
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Rob Westgeest"]
-  s.email       = "rob.westgeest@gmail.com"
-  s.homepage    = "http://github.com/actionguard"
-  s.summary     = "actionguard-#{ActionGuard::Version::STRING}"
-  s.description = "authorisation of actions based on url-paths"
-
-  s.rubygems_version   = "1.3.7"
-  s.rubyforge_project  = "actionguard"
-
-  s.files            = `git ls-files`.split("\n")
-  s.test_files       = `git ls-files -- {spec}/*`.split("\n")
-  s.extra_rdoc_files = [ "README.md" ]
-  s.rdoc_options     = ["--charset=UTF-8"]
-  s.require_path     = "lib"
-end
-