safety_patrol 0.5.0

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thomas Brewer
+
+MIT License
+
+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,91 @@
+# SafetyPatrol (BETA)
+Simple framework agnostic Authorization gem.  It was heavily (start the copiers) influenced by the Authority gem, but I wanted a core authorization gem that was not tied to a specific web framework. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'safety_patrol'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safety_patrol
+
+## Usage
+
+	#configure it
+	SafetyPatrol.configure |config|
+						#verb	 #adjective
+		config.abilities[:send] = :sendable
+
+		#the default abilities are:
+		#:create => :creatable
+		#:read   => :readable
+		#:update => :updatable
+		#:delete => :deletable
+	end
+
+	#define a User class and include the SafetyPatrol::UserAbilities module
+	class User
+		include SafetyPatrol::UserAbilities
+		attr_accessor :role
+		def admin?
+			role == 'admin'
+			# or whatever logic fits your apps needs
+		end
+	end
+
+
+	#define a class that you want to provide authorization logic for 
+	#and include SafetyPatrol::Abilities module and declare the authorizer class
+	class Article
+		include SafetyPatrol::Abilities
+		authorizer 'ArticleAuthorizer'
+	end
+
+	#define you authorizer class that contains the authorization logic
+	class ArticleAuthorizer
+
+		#define methods that follow the convention of adjective_by?(user, resource)
+
+		#these methods with receive the user and resource
+		def creatable_by?(user, article)
+			user.admin?
+		end
+	end
+
+	#check for a user's authorization
+	admin = User.new
+	admin.role = 'admin'
+
+	guest = User.new
+	guest.role = 'guest'
+
+	article = Article.new
+
+	guest.can_create?(article) # return false
+	admin.can_create?(article) # return true
+
+	article.creatable_by(admin) #return true
+	article.creatable_by(guest) #return false
+
+	#What everything boils down to is SafetyPatrol is just providing sugar on top of this:
+	authorizer = ArticleAuthorizer.new
+	authorizer.creatable_by?(admin, article) #return true
+
+
+##Todos
+1. Add more specs
+2. Repeat #1
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/safety_patrol.rb

@@ -0,0 +1,32 @@
+require "safety_patrol/version"
+require "safety_patrol/configuration"
+
+module SafetyPatrol
+  
+  	class << self
+
+    	def abilities
+    		configuration.abilities.freeze
+    	end
+
+    	def verbs 
+    		abilities.keys
+    	end
+
+    	def adjectives 
+    		abilities.values
+    	end
+
+    	attr_accessor :configuration
+
+    	def configure
+    		self.configuration ||= Configuration.new
+	   	 	yield(configuration) if block_given?
+	    	require 'safety_patrol/user_abilities'
+    		require 'safety_patrol/abilities'
+	    	configuration
+		end
+
+  	end
+
+end

data/lib/safety_patrol/abilities.rb

@@ -0,0 +1,36 @@
+module SafetyPatrol
+
+	module Abilities
+
+		def self.included(base)
+    		base.extend ClassMethods
+  		end
+
+		module ClassMethods
+
+			attr_accessor :_authorizer
+
+			def authorizer(object = nil)
+				if object.nil?
+					self._authorizer
+				else
+					self._authorizer = (object.is_a?(String)) ? Kernel.const_get(object).new : object.new
+				end
+			end		
+
+		end
+
+		SafetyPatrol.adjectives.each do |adjective|
+			define_method(("#{adjective}_by?").intern) do |user|
+				self.authorizer.send(("#{adjective}_by?").intern, user, self)
+			end
+		end		
+
+		def authorizer 
+			self.class.authorizer
+		end
+
+	end
+
+end
+

data/lib/safety_patrol/configuration.rb

@@ -0,0 +1,22 @@
+module SafetyPatrol
+
+	class Configuration
+
+		attr_accessor :abilities
+
+		def initialize
+			
+			@abilities = {
+				#verb		#adjective
+			    :create => :creatable,
+			    :read   => :readable,
+			    :update => :updatable,
+			    :delete => :deletable
+			}
+
+		end
+
+	end
+
+
+end

data/lib/safety_patrol/user_abilities.rb

@@ -0,0 +1,19 @@
+module SafetyPatrol
+
+	module UserAbilities
+
+		#define some method on the user for convenience
+		SafetyPatrol.verbs.each do |verb|
+		  class_eval <<-RUBY, __FILE__, __LINE__ + 1
+		    def can_#{verb}?(resource)
+		      resource.#{SafetyPatrol.abilities[verb]}_by?(self)
+		    end
+		  RUBY
+		end
+		
+	end
+
+end
+
+
+    

data/lib/safety_patrol/version.rb

@@ -0,0 +1,3 @@
+module SafetyPatrol
+  VERSION = "0.5.0"
+end

data/safety_patrol.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/safety_patrol/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Thomas Brewer"]
+  gem.email         = ["tom@21purple.com"]
+  gem.description   = %q{Simple framework agnostic Authorization gem}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "safety_patrol"
+  gem.require_paths = ["lib"]
+  gem.version       = SafetyPatrol::VERSION
+  gem.add_development_dependency('rspec')
+end

data/spec/safety_patrol/abilities_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+class ArticleAuthorizer
+
+	def creatable_by?(user, resource)
+		true
+	end
+
+end
+
+class Article
+	include SafetyPatrol::Abilities
+	authorizer 'ArticleAuthorizer'
+end
+
+describe SafetyPatrol::Abilities do
+
+	it "should define methods on a class based upon the abilities hash" do
+		article = Article.new
+		lambda {
+			article.creatable_by?
+		}.should_not raise_exception(NoMethodError)
+	end
+
+	it "should have an associated Authorizer" do
+		Article.authorizer.should be_instance_of(ArticleAuthorizer)
+	end
+
+	it "should receive a creatable_by? call and return true or false" do
+		article = Article.new
+		user = double("User")
+		article.creatable_by?(user).should eq(true)
+	end
+
+	describe ArticleAuthorizer do
+
+		it "should receive a creatable_by?" do
+			article = Article.new
+			article.authorizer.should_receive(:creatable_by?)
+			user = double("User")
+			article.creatable_by?(user)
+		end
+	end
+
+end

data/spec/safety_patrol/configuration_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+
+describe SafetyPatrol::Configuration do
+	
+	it "should all you to set abilities" do
+		configuration = SafetyPatrol::Configuration.new
+		configuration.abilities[:send] = 'sendable'
+		configuration.abilities[:send].should eq('sendable')
+	end
+
+end

data/spec/safety_patrol/user_abilities_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+class User
+	include SafetyPatrol::UserAbilities
+end
+
+class UserItemAuthorizer
+
+	def creatable_by?(user, resource)
+		true
+	end
+
+	def deletable_by?(user, resource)
+		false
+	end
+
+end
+
+class UserItem
+	include SafetyPatrol::Abilities
+	authorizer UserItemAuthorizer
+end
+
+describe SafetyPatrol::UserAbilities do
+
+	it "should define methods on a User class based upon the abilities hash" do
+		user = User.new
+		article  = double("article")
+		article.should_receive(:creatable_by?)
+		lambda {
+			user.can_create? article
+		}.should_not raise_exception(NoMethodError)
+	end
+
+	it "#can_create? should return true" do
+		user = User.new
+		user_item = UserItem.new
+		user.can_create?(user_item).should eq(true)
+	end
+
+	it "#can_delete? should return false" do
+		user = User.new
+		user_item = UserItem.new
+		user.can_delete?(user_item).should eq(false)
+	end
+
+end

data/spec/safety_patrol_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+
+describe SafetyPatrol do
+	
+	it "should present a configuration object via a block" do
+		configuration = nil
+		SafetyPatrol.configure do |config|
+			configuration = config			
+		end
+		configuration.should be_instance_of(SafetyPatrol::Configuration)
+	end
+
+
+	describe "Abilities" do
+
+		before do
+			SafetyPatrol.configure do |config|
+			end
+		end
+
+		it "should provide a list of ability verbs" do
+			SafetyPatrol.verbs.should eq([:create, :read, :update, :delete])
+		end
+
+		it "should provide a list of ability verbs" do
+			SafetyPatrol.adjectives.should eq([:creatable, :readable, :updatable, :deletable])
+		end
+
+	end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec'
+require 'safety_patrol'
+
+SafetyPatrol.configure
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: safety_patrol
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Brewer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70299455803640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299455803640
+description: Simple framework agnostic Authorization gem
+email:
+- tom@21purple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/safety_patrol.rb
+- lib/safety_patrol/abilities.rb
+- lib/safety_patrol/configuration.rb
+- lib/safety_patrol/user_abilities.rb
+- lib/safety_patrol/version.rb
+- safety_patrol.gemspec
+- spec/safety_patrol/abilities_spec.rb
+- spec/safety_patrol/configuration_spec.rb
+- spec/safety_patrol/user_abilities_spec.rb
+- spec/safety_patrol_spec.rb
+- spec/spec_helper.rb
+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: Simple framework agnostic Authorization gem
+test_files:
+- spec/safety_patrol/abilities_spec.rb
+- spec/safety_patrol/configuration_spec.rb
+- spec/safety_patrol/user_abilities_spec.rb
+- spec/safety_patrol_spec.rb
+- spec/spec_helper.rb