cannie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4767806af908d3fbb42922daeb46aa9793c43f09
+  data.tar.gz: d1e4a3df2a8055cfa9e80645b63ceb62a66ea88c
+SHA512:
+  metadata.gz: 28cae6c32b9616c3d9af5983b0044cd1b34044b552f55856a680adc3560548d6b82e064ca6a9356ef09bbc37cf4672e81293a35ffd4152786435f77111700b3c
+  data.tar.gz: a03394d05eaea44c85b0e7d2572f911b24f10700c0d5fd3e78c578919af0ebffaa6114cb234100fb936ce67718f4193f6e78261a44f9979e65e310324861bc2c

data/.gitignore

@@ -0,0 +1,17 @@
+*.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,11 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.0'
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+end
+
+# Specify your gem's dependencies in cannie.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 hck
+
+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,94 @@
+# Cannie
+
+Cannie is a gem for authorization/permissions checking.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cannie'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cannie
+
+## Usage
+
+### Define permissions
+
+Permissions are defined in Permissions class, which could be generated by Rails generator:
+
+    rails g cannie:permissions
+
+Than you can define all the permissions you want inside ::initialize method of Permissions class:
+
+    class Permissions
+      include Cannie::Permissions
+
+      def initialize(user)
+        if user.admin?
+          allow :manage, on: :all
+        else
+          allow :read, on: Post
+          allow :read, on: Comment
+          allow :create, on: Comment
+
+          # allow delete comments, that were created only if user has posted those comments
+          allow :delete, on: Comment do |*comments|
+            comments.all?{|c| c.user_id == user.id}
+          end
+        end
+      end
+    end
+
+### Checking permissions
+
+To be sure that permissions checking is handled in each action of your controller, add `check_permissions` method call to your controllers:
+
+    class PostsController < ApplicationController
+      check_permissions
+
+      #...
+    end
+
+To skip checking permissions for controller, add `skip_check_permissions` method call:
+
+    class PagesController < ApplicationController
+      skip_check_permissions
+
+      #...
+    end
+
+Checking of permissions on per-action basis is done by calling `permit!` method inside of controller's actions:
+
+   class PostsController < ApplicationController
+     check_permissions
+
+     def index
+       @posts = Posts.all
+       permit! :read, on: posts # checks whether user able to read fetched posts
+     end
+   end
+
+### Handling of unpermitted access
+
+If user is not permitted for appropriate action, `Cannie::ActionForbidden` exception will be raised.
+It can be handled globally by using `rescue_from` inside ApplicationController:
+
+    class ApplicationController < ActionController::Base
+      rescue_from Cannie::ActionForbidden do |exception|
+        redirect_to root_path, alert: exception.message
+      end
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/cannie.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cannie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cannie"
+  spec.version       = Cannie::VERSION
+  spec.authors       = ["hck"]
+  spec.description   = %q{Cannie is a gem for authorization/permissions checking on per-controller/per-action basis.}
+  spec.summary       = %q{Simple gem for checking permissions on per-action basis}
+  spec.homepage      = "http://guthub.com/hck/cannie"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/cannie/version.rb

@@ -0,0 +1,3 @@
+module Cannie
+  VERSION = "0.0.1"
+end

data/lib/cannie.rb

@@ -0,0 +1,8 @@
+require 'cannie/exceptions'
+require 'cannie/rule'
+require 'cannie/permissions'
+require 'cannie/controller_extensions'
+require 'cannie/version'
+
+module Cannie
+end

data/spec/cannie/rule_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Cannie::Rule do
+  describe '#initialize' do
+    it 'stores passed actions' do
+      actions = %i(read create update delete)
+      rule = described_class.new *actions, Array
+      expect(rule.actions).to eq(actions)
+    end
+
+    it 'stores passed subject' do
+      rule = described_class.new :read, Array
+      expect(rule.subject).to eq(Array)
+    end
+
+    it 'scores passed block' do
+      rule = described_class.new(:read, Array){ |*attrs| attrs.all?{ |v| v % 2 == 0 } }
+      expect(rule.condition.call(2,4,8)).to be_true
+    end
+  end
+
+  describe '#permits?' do
+    let(:rule) do
+      described_class.new(:read, Array) do |*attrs|
+        attrs.all?{ |v| v % 2 == 0 }
+      end
+    end
+
+    it 'returns true if result of executing condition is true' do
+      expect(rule.permits?(2,4,8)).to be_true
+    end
+
+    it 'returns false if result of executing condition is false' do
+      expect(rule.permits?(1,4,8)).to be_false
+    end
+
+    it 'returns true for any subject if rule subject is :all' do
+      rule = described_class.new(:read, :all)
+      expect(rule.permits?(1,2,3)).to be_true
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: cannie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Cannie is a gem for authorization/permissions checking on per-controller/per-action
+  basis.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cannie.gemspec
+- lib/cannie.rb
+- lib/cannie/version.rb
+- spec/cannie/rule_spec.rb
+homepage: http://guthub.com/hck/cannie
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple gem for checking permissions on per-action basis
+test_files:
+- spec/cannie/rule_spec.rb