simple_access_control 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05b58bbac8fe078b96840194466c3a8fa6fa3986
+  data.tar.gz: 10705b5218f0f4a33f28b15d615ab43cd4713f30
+SHA512:
+  metadata.gz: 20cad57bd4e6e8995758a6129c70b75eafcdf253118aee813dd8c9aedb9e1332ecb6abd75cf39ddbc44c7fa2d7ca57d47881f2e4a7e122fcc960b0de4b0e716c
+  data.tar.gz: c587e42a6decf3e39472e6f607790fc51c1d10438822df0623d34f442c2fc3594ef095232a7e847149621432b01ddff435643aa6bd0cbb1b2ddc20510f178826

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Owain Lewis
+
+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,234 @@
+# SimpleAccessControl
+
+Ruby gem port of an old Ruby Plugin
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_access_control'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_access_control
+
+## Usage
+
+To test locally you can do
+
+1. git clone git@github.com:owainlewis/simple-access-control.git && cd simple-access-control
+2. rake test 
+3. rake install (to install the gem locally)
+
+Once installed locally you can put it into your Gemfile like this
+
+```
+source 'https://rubygems.org'
+
+gem 'simple_access_control'
+```
+
+To include the code add the following to ApplicationController.rb
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  include SimpleAccessControl
+
+  def current_user
+    # return the current user
+  end
+  helper_method :current_user
+
+  def logged_in?
+    # return boolean user logged in or not
+  end
+  helper_method :logged_in?
+
+  protect_from_forgery with: :exception
+end
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_access_control/fork )
+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 a new Pull Request
+
+# Full Information
+
+SimpleAccessControl is a streamlined, intuitive authorisation system. It derives heavily from
+acl_system2 and has made clear some problems which plagued me when first using it. Some
+fixes to acl_system2's design:
+
+      * a normal Rails syntax:
+            access_rule 'admin', :only => :index
+            access_rule '(moderator || admin)', :only => :new
+      * error handling for helper methods (permit? bombed when current_user == nil)
+      * one-line parser, easy to replace or alter
+      * proper before_filter usage, meaning access rules are parsed only when needed
+      * no overrideable default (which I found counter-intuitive in the end)
+
+Also, it has two methods, access_control and permit?, for those moving from acl_system2.
+
+But, let me stress, everyone likes a slightly different system, so this one may not be
+your style. I find it synchronises very well with the interface of Acts as Authenticated (even
+though I have modified it so much that it's now called Authenticated Cookie).
+
+INSTALLATION
+============
+
+Create the following migration:
+
+  create_table "roles", :force => true do |t|
+    t.column "title", :string
+  end
+  create_table "roles_users", :id => false, :force => true do |t|
+    t.column "role_id", :integer
+    t.column "user_id", :integer
+  end
+
+In your User model, you must have:
+
+  has_and_belongs_to_many :roles
+  
+In your Roles model, you must have:
+
+  has_and_belongs_to_many :users
+
+Your controllers must have the following two methods or variants of them:
+
+  # Returns a User object
+  def current_user
+    @current_user
+  end
+
+  # Returns true or false if a User object exists for this session
+  def logged_in?
+    @current_user.is_a? User
+  end
+
+
+SPECIAL NEEDS
+=============
+
+If you want to permit anonymous users without demanding that they are logged in, first you
+must ensure that logged_in? returns true in all cases, otherwise permission will be denied.
+The following approach should work:
+
+1. Create the 'guest' and 'user' roles, e.g.:
+
+  guest = Role.create(:title => 'guest')
+  user = Role.create(:title => 'user')
+
+2. In your registration/user creation area, ensure all real users have the 'user' role, e.g.:
+
+  @user = User.create(params[:user])
+  unless @user.roles.any? { |r| r.title == 'user' }
+    @user.roles << Role.find_by_title('user')
+  end
+  @user.save  
+
+[At this point you have two options: a real or virtual anonymous account]
+
+First Approach: Real Anonymous User
+
+  3a. Create an anonymous user, e.g.:
+
+    @anonymous = User.create(:login => 'anonymous', :password => '*', :activated => true)
+
+  4a. Add the role to the Anonymous user (in a migration or in script/console), e.g.:
+
+    anonymous.roles << Role.find_by_title('guest')
+    anonymous.save
+
+  5a. In your ApplicationController, set unauthenticated users as 'anonymous', e.g.:
+
+    before_filter :default_to_guest
+
+    def default_to_guest
+      self.current_user = User.find_by_login('anonymous', :include => :roles) unless logged_in?
+    end
+
+
+Second Approach: Virtual Anonymous User
+
+  3a. In your ApplicationController, create a virtual anonymous account if unauthenticated:
+
+    before_filter :default_to_virtual_guest
+    def default_to_virtual_guest
+      self.current_user = self.anonymous_user unless logged_in?
+    end
+
+    def anonymous_user
+      anonymous = User.new(:login => 'anonymous', :name => 'Guest')
+      anonymous.roles << Role.new(:title => 'guest')
+      anonymous.readonly!
+      anonymous
+    end
+
+
+USAGE
+=====
+
+The plugin is automatically hooked into ActionController::Base.
+
+In your controllers, add access rules like so:
+
+  access_rule 'admin', :only => :destroy
+  access_rule 'user || admin', :only => [:new, :create, :edit, :update]
+
+Note the use of Ruby-style operators. These strings are real conditionals and should be treated as
+such. Every grouping of non-operator characters will be considered a role title.
+
+In your views, you can use the following:
+
+```ruby
+  <% restrict_to 'admin || moderator' do %>
+    <%= link_to "Admin Area", admin_area_url %>
+  <% end %>
+```
+  
+AND
+
+```ruby
+  <%= link_to("Admin Area", admin_area_url) if has_permission?('admin || moderator') %>
+```
+
+There are also transitional methods which help you move from acl_system2 to this plugin -- I do this
+not to denegrate acl_system2 but because I did this for myself and decided to include it. The two
+systems are rather similar.
+
+Also, there are two callbacks, permission_granted and permission_denied, which may define in your
+controllers to customise their response. For example:
+
+```ruby
+
+  def permission_granted
+    logger.info("[authentication] Permission granted to %s at %s for %s" %
+      [(logged_in? ? current_user.login : 'guest'), Time.now, request.request_uri])
+  end
+  
+  def permission_denied
+    logger.info("[authentication] Permission denied to %s at %s for %s" %
+      [(logged_in? ? current_user.login : 'guest'), Time.now, request.request_uri])
+  end
+```
+
+That's it!
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_spec.rb"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_access_control"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_access_control.rb

@@ -0,0 +1,74 @@
+require "simple_access_control/version"
+require "simple_access_control/access_control_handler"
+
+module SimpleAccessControl
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    if base.respond_to?(:helper_method)
+      base.send :helper_method, :restrict_to
+      base.send :helper_method, :has_permission?
+      base.send :helper_method, :permit?
+    end
+  end
+
+  module ClassMethods
+
+    def access_control(ruleset = {})
+      ruleset.each do |actions, rule|
+        case actions
+        when :DEFAULT
+          access_rule rule
+        when Array, Symbol, String
+          access_rule rule, :only => actions
+        end
+      end
+    end
+
+    # This is the core of the filtering system and it couldn't be simpler:
+    #     access_rule '(admin || moderator)', :only => [:edit, :update]
+    def access_rule(rule, filter_options = {})
+      before_filter (filter_options||{}) { |c| c.send :permission_required, rule }
+    end
+  end
+
+  def permission_required(rule = nil)
+    if respond_to?(:logged_in?) && logged_in? && has_permission?(rule)
+      send(:permission_granted) if respond_to?(:permission_granted)
+      true
+    else
+      send(:permission_denied) if respond_to?(:permission_denied)
+      false
+    end
+  end
+
+  # For use in both controllers and views.
+  #
+  # Check if a role has permission?
+  #
+  #     has_permission?('role')
+  #     has_permission?('admin', other_user)
+  #
+  # @return Boolean
+  def has_permission?(rule, user = nil)
+    user ||= (send(:current_user) if respond_to?(:current_user)) || nil
+    access_controller.process(rule, user)
+  end
+
+  def permit?(rule, context = {})
+    has_permission?(rule, (context && context[:user] ? context[:user] : nil))
+  end
+
+  # Execute a code block ONLY if the user has access
+  #
+  #     restrict_to "admin | moderator" do
+  #       link_to "foo"
+  #     end
+  def restrict_to(rule, user = nil)
+    yield if block_given? && has_permission?(rule, user)
+  end
+
+  def access_controller #:nodoc:
+    @access_controller ||= AccessControlHandler.new
+  end
+end

data/lib/simple_access_control/access_control_handler.rb

@@ -0,0 +1,44 @@
+module SimpleAccessControl
+  class AccessControlHandler
+
+    # Is this is a simple or compound rule?
+    #
+    # @return Boolean
+    def simple_rule? string
+      string =~ /^([^()\|&!]+)$/
+    end
+
+    # Process a string rule and a user
+    #
+    def process(string, user)
+      return check('', user) if (string.nil? || string.empty?)
+      if simple_rule?(string)
+        check(string, user)
+      else
+        # This is awful!
+        instance_eval("!! (#{parse(string)})") # give it the going-over
+      end
+    end
+
+    # Parse a string and do some horrific ruby magic to instance eval it! : (
+    #
+    def parse(string)
+      string.gsub(/(\|+|\&+)/) { $1[0,1]*2 }.gsub(/([^()|&! ]+)/) { "check('#{$1}', user)" }
+    end
+
+    # Check if a role applies to a user
+    #
+    # check('admin', user)
+    #
+    # @return Boolean
+    def check(role, user)
+      if user.nil? || !user.respond_to?(:roles)
+        false
+      elsif (role.nil? || role.empty?)
+        true
+      else
+        user.roles.map{ |r| r.title.downcase }.include? role.downcase
+      end
+    end
+  end
+end

data/lib/simple_access_control/version.rb

@@ -0,0 +1,3 @@
+module SimpleAccessControl
+  VERSION = "0.1.0"
+end

data/simple_access_control.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_access_control/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_access_control"
+  spec.version       = SimpleAccessControl::VERSION
+  spec.authors       = ["Owain Lewis"]
+  spec.email         = ["owain@owainlewis.com"]
+
+  spec.summary       = %q{A simple gem for access control management}
+  spec.description   = %q{A simple ACL system for Ruby on Rails projects}
+  spec.homepage      = "https://testlodge.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+
+  end
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: simple_access_control
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owain Lewis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: A simple ACL system for Ruby on Rails projects
+email:
+- owain@owainlewis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_access_control.rb
+- lib/simple_access_control/access_control_handler.rb
+- lib/simple_access_control/version.rb
+- simple_access_control.gemspec
+homepage: https://testlodge.com
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A simple gem for access control management
+test_files: []