checkpoint 0.2.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in checkpoint.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Readme.markdown

@@ -0,0 +1,93 @@
+#Simple authorisation for Rails
+
+##Installation
+
+Add the following to your gem file:
+
+```
+gem 'checkpoint'
+```
+and then run bundle install from your shell.
+
+## How to use
+
+By default all users get denied access to everything.
+
+To enable a user to access/use a resource you must specify an authorisation rule to grant access. This is done using the "authorise" (or "authorize" for americans) method in the application controller.
+
+So if for instance you wanted to grant access (to all users) to your posts index action you could do the following:
+
+```ruby
+#grant access your posts controller 'index' action to all users
+authorise "PostsController::index"
+
+#or  authorize "PostsController::index"
+
+```
+
+Noticed how the pattern above is in the format of "ControllerName::action"
+
+So if you wanted to grant action to your posts view action you could do the following:
+
+```ruby
+#grant access to your posts controller 'view' action to all users
+authorise "PostsController::view"
+```
+
+If you want to grant access to all actions in your post controller you can use a wildcard ('*') char and do the following
+
+```ruby
+#grant access to your posts controller actions to all users
+authorise "PostsController::*"
+```
+
+You can also do the same above by using a regular expression:
+
+```ruby
+#grant access to your posts controller actions to all users
+authorise /\APostsController::.*\Z/
+```
+
+If you want to be able to grant access to your view action to only users who have signed in, you can do this by passing a block that returns true if the user is logged in.
+
+```ruby
+#grant access your posts controller 'view' action to all users who have signed in
+authorise "PostsController::view" do
+  !current_user.nil?
+end
+```
+
+In the example above the block uses the bindings of the controller that is being called, so therefore it can access anything that that particular controller access e.g. your current params hash etc...
+
+Similarly you could grant access to everything to all admin users by doing the following:
+
+```ruby
+#grant access to everything to all admin users
+authorise "*" do
+  !current_user.nil? && current_user.admin?
+end
+```
+
+Finally by passing an array you can authorise a range of controller actions in one go:
+
+```ruby
+#grant access your posts controller 'create' and 'update' actions to all users who have signed in
+authorise ["PostsController::create", "PostsController::update"] do
+  !current_user.nil?
+end
+```
+
+## FAQ
+
+### How do I enable devise?
+
+```ruby
+authorise "Devise::*"
+
+```
+
+## License
+
+Checkpoint is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT

data/checkpoint.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "checkpoint/version"
+
+Gem::Specification.new do |s|
+  s.name        = "checkpoint"
+  s.version     = Checkpoint::VERSION
+  s.authors     = ["Leanbid LTD"]
+  s.email       = ["it@leanbid.com"]
+  s.homepage    = "https://github.com/leanbid/checkpoint"
+  s.summary     = "Simple rails authorisation"
+  #s.description = %q{TODO: Write a gem description}
+  s.license = "MIT"
+
+  s.rubyforge_project = "checkpoint"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/checkpoint.rb

@@ -0,0 +1,7 @@
+require "checkpoint/version"
+require "checkpoint/railtie"
+
+
+module Checkpoint
+  # Your code goes here...
+end

data/lib/checkpoint/railtie.rb

@@ -0,0 +1,76 @@
+require 'rails'
+
+class Checkpoint::Railtie < ::Rails::Railtie
+  config.before_initialize do
+    class ::ActionController::Base
+      
+      def self.authorise_controllers_blocks
+        if @authorise_controllers_blocks.nil?
+            @authorise_controllers_blocks = {}
+        end
+        @authorise_controllers_blocks
+      end
+  
+      def self.authorise(arg1, &block)
+        
+        if block.nil?
+          block = lambda {|c| true}
+        end
+      
+        to_regexp = lambda do |pattern|
+          if arg1.class.to_s == 'Regexp'
+            arg1
+          else
+            Regexp.new('\A' + pattern.to_s.gsub(/[^\*]/){|char| Regexp.quote(char)}.gsub(/\*/){|| ".*?"} + '\Z')
+          end
+        end
+        
+        patterns = []
+        if arg1.class.to_s == 'Array'
+          arg1.each {|pattern| patterns.push to_regexp.call(pattern) }
+        else
+          patterns.push to_regexp.call(arg1)
+        end
+        
+        authorise_controllers_blocks = ::ApplicationController.authorise_controllers_blocks
+        
+        patterns.each do |pattern|
+          if authorise_controllers_blocks [pattern].nil?
+            authorise_controllers_blocks[pattern] = []
+          end
+          authorise_controllers_blocks[pattern].push(block)
+        end
+      end
+      
+      #for our american friends
+      def self.authorize(arg1, &block)
+        authorise(arg1, &block)
+      end
+      
+      def authorised?
+        action = "#{self.class.to_s}::#{params[:action]}"
+        ::ApplicationController.authorise_controllers_blocks.each do |pattern, blocks|
+          if action.match pattern
+            blocks.each do |block|
+              if instance_eval(&block)
+                return true
+              end
+            end
+          end
+        end
+        false
+      end
+      
+      before_filter do |controller|
+        if !authorised?
+          logger.info "\n\n-----------------------------------------------"
+          logger.info " (401) Access Denied!"
+          logger.info " * see the above request for more info"
+          logger.info "-----------------------------------------------\n\n"
+          render :text => "Access Denied", :status => 401
+        end
+      end
+      
+    end
+  end
+end

data/lib/checkpoint/version.rb

@@ -0,0 +1,3 @@
+module Checkpoint
+  VERSION = "0.2.1"
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: checkpoint
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Leanbid LTD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-16 00:00:00.000000000Z
+dependencies: []
+description: 
+email:
+- it@leanbid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .Gemfile.swp
+- .Readme.markdown.swp
+- .checkpoint.gemspec.swp
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.markdown
+- checkpoint.gemspec
+- lib/checkpoint.rb
+- lib/checkpoint/railtie.rb
+- lib/checkpoint/version.rb
+homepage: https://github.com/leanbid/checkpoint
+licenses:
+- MIT
+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: checkpoint
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Simple rails authorisation
+test_files: []