allow 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Arun Srinivasan
+
+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,72 @@
+# Allow
+
+A very small authorization library.
+
+It packs a surprising punch for being 26 lines of code.
+
+# Installation
+
+    gem install allow
+
+# Usage
+
+```ruby
+require 'allow'
+
+class User
+  include Allow::Actor          # Gives you a :can? method
+end
+
+class Post
+  attr_reader :author
+
+  def initialize(author)
+    @author = author
+  end
+end
+
+# You can call your permissions-checking class whatever you want,
+# just be sure to include Allow::Permissions.
+class Permissions
+  include Allow::Permissions    # Gives you :permitted?, though you won't
+                                # be using it directly very much.
+  def update_post(user, post)
+    user == post.author
+  end                           # Note: all permitter methods must accept at
+                                # least 1 argument - they will always receive
+                                # an `actor` argument. Everything else is up
+                                # to you.
+end
+
+# Tell Allow about your Permissions class
+Allow.permissions = Permissions.new
+
+# Create some objects
+author = User.new
+reader = User.new
+post   = Post.new(author)
+
+# User's have a :can? method:
+author.can?(:update_post, post)       # => true
+reader.can?(:update_post, post)       # => false
+
+# Alternatively (and equivalently):
+Allow.ed?(author, :update_post, post) # => true
+Allow.ed?(reader, :update_post, post) # => false
+
+# Both :can? and Allow.ed? accept an optional block that
+# only gets executed if the permitter method returns a truthy
+# value.
+
+blocks_called = []
+
+author.can?(:update_post, post) do
+  blocks_called << [:author_block] # this gets run
+end
+
+reader.can?(:update_post, post) do
+  blocks_called << [:reader_block] # this does NOT get run
+end
+
+blocks_called # => [:author_block]
+```

data/Rakefile

@@ -0,0 +1,38 @@
+$:.push("lib")
+require "allow"
+
+name = "allow"
+version = Allow::VERSION
+
+desc 'Run the tests'
+task :test do
+  require 'tst'
+  Tst.run 'test/*.rb',
+    :load_paths => ['lib'],
+    :reporter => Tst::Reporters::Pretty.new
+end
+
+namespace :gem do
+  desc 'Clean up generated files'
+  task :clean do
+    sh 'rm -rf pkg'
+  end
+
+  desc "Build the gem"
+  task :build => :clean do
+    sh "mkdir pkg"
+    sh "gem build #{name}.gemspec"
+    sh "mv #{name}-#{version}.gem pkg/"
+  end
+
+  desc "Release v#{version}"
+  task :release => :build do
+    sh "git commit --allow-empty -a -m 'Release #{version}'"
+    sh "git tag v#{version}"
+    sh "git push origin master"
+    sh "git push origin v#{version}"
+    sh "gem push pkg/#{name}-#{version}.gem"
+  end
+end
+
+task :default => :test

data/lib/allow.rb

@@ -0,0 +1,32 @@
+module Allow
+  VERSION = "0.0.1"
+
+  module Permissions
+    def permitted?(actor, verb, *objects)
+      return false unless respond_to?(verb)
+      !!send(verb, actor, *objects)
+    end
+  end
+
+  module Actor
+    def can?(verb, *objects, &block)
+      Allow.ed?(self, verb, *objects, &block)
+    end
+  end
+
+  class << self
+    attr_accessor :permissions
+  end
+
+  def self.reset!
+    @permissions = Class.new { include Permissions }.new
+  end
+
+  def self.ed?(actor, verb, *objects, &block)
+    permitted = permissions.permitted?(actor, verb, *objects)
+    block.call if permitted && block
+    permitted
+  end
+end
+
+Allow.reset!

data/test/actor.rb

@@ -0,0 +1,36 @@
+require 'allow'
+
+class User
+  include Allow::Actor
+end
+
+class Post
+  attr_reader :author
+  def initialize(author)
+    @author = author
+  end
+end
+
+class Permissions
+  include Allow::Permissions
+  def update_post(user, post)
+    user == post.author
+  end
+end
+
+tst "including Allow::Can gets you the :can? method" do
+  user = User.new
+  assert user.respond_to?(:can?)
+end
+
+tst "#can? does what you'd expect" do
+  author = User.new
+  reader = User.new
+  post = Post.new(author)
+  Allow.permissions = Permissions.new
+
+  assert_equal true, author.can?(:update_post, post)
+  assert_equal false, reader.can?(:update_post, post)
+
+  Allow.reset!
+end

data/test/allow.rb

@@ -0,0 +1,38 @@
+require 'allow'
+
+tst "Allow.ed? delegates to the permissions object :permitted? method" do
+  Allow.permissions = Class.new {
+    def permitted?(*args) "permitted? called with: #{args}" end
+  }.new
+
+  result = Allow.ed?(:actor, :verb, :object)
+  assert_equal 'permitted? called with: [:actor, :verb, :object]', result
+
+  Allow.reset!
+end
+
+#
+# Tests for when Allow.ed? is passed a block:
+#
+
+tst "Allow.ed? does NOT execute the block if permitted? => false" do
+  Allow.permissions = Class.new {
+    def permitted?(*args) false end
+  }.new
+
+  Allow.ed?(:actor, :verb, :object) { raise "This shouldn't get reached!!" }
+
+  Allow.reset!
+end
+
+tst "Allow.ed? executes the block if permitted? => true" do
+  Allow.permissions = Class.new {
+    def permitted?(*args) true end
+  }.new
+
+  assert_raises RegexpError do
+    Allow.ed?(:actor, :verb, :object) { raise RegexpError }
+  end
+
+  Allow.reset!
+end

data/test/permissions.rb

@@ -0,0 +1,44 @@
+require 'allow'
+
+class Permissions
+  include Allow::Permissions
+  def answer(s, o) 42 end
+  def number(s, o) 42 end
+  def string(s, o) 'a string' end
+  def nil(s, o) nil end
+end
+
+tst "#permitted? defaults to false" do
+  permissions = Permissions.new
+  permitted = permissions.permitted?(:actor, :verb, :object)
+  assert_equal false, permitted
+end
+
+tst "#permitted? coerces the result to a boolean" do
+  permissions = Permissions.new
+
+  assert_equal true, permissions.permitted?('', :number, '')
+  assert_equal true, permissions.permitted?('', :string, '')
+  assert_equal false, permissions.permitted?('', :nil, '')
+  assert_equal false, permissions.permitted?('', :undefined, '')
+end
+
+tst "#permitted? passes the actor and object(s) as args" do
+  permissions = Permissions.new
+
+  def permissions.do_something(*args)
+    args == [:actor, :object]
+  end
+
+  assert permissions.permitted?(:actor, :do_something, :object)
+end
+
+tst "#permitted? can pass multiple objects through" do
+  permissions = Permissions.new
+
+  def permissions.do_something(*args)
+    args == [:actor, :object1, :object2]
+  end
+
+  assert permissions.permitted?(:actor, :do_something, :object1, :object2)
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: allow
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Arun Srinivasan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tst
+  requirement: &70314285938480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70314285938480
+description: A very small authorization library.
+email: satchmorun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- Rakefile
+- lib/allow.rb
+- test/actor.rb
+- test/allow.rb
+- test/permissions.rb
+homepage: http://github.com/satchmorun/tst
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A very small authorization library.
+test_files:
+- test/actor.rb
+- test/allow.rb
+- test/permissions.rb