crewd_policies 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6801f11573ca176ae1286e76e831686a20293bc
+  data.tar.gz: 338f36c0cd2de727c70739e63ce29d45b27e6a43
+SHA512:
+  metadata.gz: aaa121814498240b46bbe2733f0d8e7e2ca51bba3713d980c11530e612bca9fff79742775623793eb30f474b7c083d42461fca7aa0a3d5fde89fe569f26f8811
+  data.tar.gz: 572eedaa8be5c3185fa04534e4b3984dfbac68d87d209b999a4d9fa0ea93261cb982258e3d2e468c8dfbacfa8f4817bea57c8b164e5a669dbd430a26395b873b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.iml
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at gary@buzzware.com.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gary McGhee
+
+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,300 @@
+# CrewdPolicies
+
+CrewdPolicies enables conventional Pundit (https://github.com/elabs/pundit) policies to be written using an opinionated pattern based on declarative Create, Read, Execute (optional), Write and Destroy (CREWD) permissions for each resource. Conventional pundit create?, show?, update? and destroy? permissions are automatically derived from these, as well as permitted_attributes/strong parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crewd_policies'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crewd_policies
+
+## Usage
+
+The happy path that CREWD policies enables is as follows :
+
+ 1) include CrewdPolicies::Model into your models
+ 	
+ ```ruby	
+ class Person < ActiveRecord::Base
+   include CrewdPolicies::Model
+ end
+ ```
+ 
+ 
+ 2) declare constant arrays of field names, grouped to suit your application 
+ 
+ ```ruby
+ USER_EDITABLE_FIELDS = [:name,:address]
+ ADMIN_FIELDS = [:roles]
+ ALL_FIELDS = ADMIN_FIELDS + USER_EDITABLE_FIELDS
+ ```
+ 		
+ 
+ 3) declare permissions using *allow()* and your constant arrays in your model
+	
+ ```ruby
+ class Customer < ActiveRecord::Base
+   include CrewdPolicies::Model
+ 		
+   PUBLIC_FIELDS = [:name]
+   USER_EDITABLE_FIELDS = [:name,:address]
+   ADMIN_FIELDS = [:roles]
+   ALL_FIELDS = ADMIN_FIELDS + USER_EDITABLE_FIELDS
+ 		 		
+   allow :sales, :create => :this
+   allow :sales, :read => ALL_FIELDS
+   allow :sales, :write => USER_EDITABLE_FIELDS
+ 		
+   allow :admin, :write => ALL_FIELDS
+   allow :admin, :destroy => :this 		
+ end
+ ```
+ 
+ 4) include CrewdPolicies::Policy into your ApplicationPolicy or individual model policies. You will also need the Scope inner class defined on your application and/or individual model policies :  
+ 	
+ ```ruby
+ class ApplicationPolicy < Struct.new(:identity, :subject)
+  include CrewdPolicies::Policy
+			
+  class Scope < Struct.new(:identity, :scope)
+    def resolve
+      scope.where(...your criteria...)
+    end
+  end		
+end 	
+ 	 	
+class CustomerPolicy < Struct.new(:identity, :subject)	
+end
+```
+		
+5) your User or Identity model must have a has_role?(aRole) method
+ 
+ You now have a valid pundit policy that can be used like any other.
+ 
+ **Parameters**
+ 
+ `aRole`: a single string or symbol; or an array of strings and/or symbols
+ `aAbilities`: a hash where -
+  - `keys` are a single string or symbol; or an array of strings and/or symbols 
+  - `values` are true, or a single string or symbol; or an array of strings and/or symbols
+ 
+### Allow Syntax
+
+The allow method is declared as :
+ 
+```ruby
+def allow(aRole, aAbilities)
+end
+```
+
+It is used on the model class as follows :
+
+```ruby
+allow <role>, <abilities> => <fields>
+```
+ 
+Typical examples :
+
+```ruby
+allow :sales, :index => true		# sales role can create any record in scope
+allow [:finance, :marketing], [:create,:destroy,:index] => true
+allow :sales, :read => :name
+allow :sales, :read => [:address,:phone]
+allow :reception, [:read,:write] => [:address,:phone]
+```
+ 
+### Allow Conditions
+ 
+An allow statement can be made conditional by adding an :if or :unless key.
+The value should be a symbol matching the name of a method with no parameters on the policy.
+ 
+For example, we want users to be able to edit their own password :
+
+on model :
+
+```ruby
+allow :user, write: :password, if: :is_self?
+```
+
+on policy :
+
+```ruby
+def is_self?
+	record and !record.is_a?(Class) and record.id==identity.id
+end
+```
+  
+Note that without the if condition, any user would be able to write any user's password.
+
+### Required allow declarations for a full CRUD policy in Rails
+
+In order to implement a policy that allows full CRUD on a resource in a Rails application, you will need to write allow declarations for each of the following abilities :
+
+| CREWD policy method | Example  																			| Probably also needed
+| :---          | :---    																			| :---
+| create?				| allow :user, create: true											| allow :user, :write => %w(name address)
+| read?					| allow :user, read: %w(name address)						| 
+| write?					| allow :user, write: %w(name address password)	|
+| destroy?				| allow :user, destroy: true										|
+| index?					| allow :user, index: true											| allow :user, :read => %w(name address)
+
+Note that for normal Rails CRUD requirements, fields are only declared for read and write, while true is only given for create, destroy and index. Your own abilities may be declared and queried with either true or an array of fields with no special requirements.
+   
+The above CREWD policy methods are then aliased to provide typical Rails policy methods as follows 
+
+| Rails policy method | CREWD policy method 	| 
+| :---                |     :---        	|
+| create?   					| create?								 	|
+| show?   					| read?								 	|
+| update?   					| write?								 	|
+| edit?   					| write?								 	|
+| index?   					| index?								 	|
+| delete?   					| destroy?								 	|
+| destroy?   					| destroy?								 	|
+
+Other Pundit conventional Rails methods are also provided :
+
+* the following permitted attributes for "strong parameters" :  
+	* permitted_attributes (equivalent to permitted_attributes_for_write) 
+	* permitted_attributes_for_write 
+	* permitted_attributes_for_read 
+	* permitted_attributes_for_create 
+	* permitted_attributes_for_update 
+	* permitted_attributes_for_edit 
+	* permitted_attributes_for_show 
+	* permitted_attributes_for_index 
+
+This should meet the access control needs for the vast majority of Rails projects.  
+  
+### Controller Examples
+
+```ruby
+def index	
+  @posts = authorize policy_scope!(Post)
+  # use per post @attributes = @post.attributes.slice permitted_attributes(@post)
+end
+
+def show	
+  @post = authorize policy_scope!(Post).find(params[:id])	
+  @attributes = @post.attributes.slice permitted_attributes(@post)
+end
+
+def create
+  pars = params.require(:post).permit policy!(Post).permitted_attributes
+  @post = authorize policy_scope!(Post).create!(pars)	
+end
+
+def update
+  @post = authorize policy_scope!(Post).find(params[:id])
+  pars = params.require(:post).permit policy!(Post).permitted_attributes
+  @post.update_attributes(pars)
+  @post.save!
+end
+
+def destroy
+  @post = authorize policy_scope!(Post).find(params[:id])
+  @post.destroy!
+end
+```
+ 
+## Core Assumptions
+
+CREWD Policies builds policies based on the core assumption that by declaring the following permissions, a complete permissions system can be derived by code for 90+% of models down to the field level : 
+
+	- scope for the resource 
+	- create for the resource 
+	- readable fields
+	- writeable fields  
+	- delete for a record
+	- normal Rails model validations for validating field values
+
+Expanding on the above :
+
+1. The relevant policy scope should be used as a normal practice for all operations, unless there is a good reason. Rails scopes limit access for select, update and delete queries; and set default values for insert queries. The other permissions assume the proper scope has been applied.
+
+1. create? permission requires : 
+	1. a resource level permission (ie. "Can this role create customers at all?")
+	1. field level _write_ permissions (ie. "When creating customers, what fields can be provided by this role?"
+	1. field values that pass the normal Rails model validations - this is left to the user and out of the scope of this gem.
+	
+1. read? permission requires :
+	1. at least 1 readable field
+	
+1. write? permission requires :
+	1. at least 1 writeable field
+	1. field values that pass the normal Rails model validations - this is left to the user and out of the scope of this gem.
+
+1. destroy? permission requires :
+	1. a record level permission (ie. "Can this role destroy this customer?")
+
+## User/Identity Model Assumptions
+
+1. *User or Identity Model* : Traditional Rails applications have a User model which maps to a database table of users. An emerging architecture pattern uses JSON Web Tokens (http://jwt.io) to represent an identity managed by an external provider. Applications then will typically need an additional model eg. `Person` for attaching persisted data to that provided by the identity token. I have had success creating an `Identity` model; not backed by the database but created in memory by decoding the JWT. It then has methods for loading a `Person` model if required. This is how we intend to do things in future, and so the property name I am using here is `identity`, but I also use an alias of user pointing referring to it.
+
+2. `identity.has_role?(aRole)` : In order to interrogate the roles assigned the `identity` has, the method `has_role?(aRole)` must be implemented to receive a role string or symbol, and return true or false. 
+
+## Why Pundit::NotAuthorizedError is misleading
+
+`Pundit` defines this error, and raises it when the authorize method rejects a query. Unfortunately, in this case, Pundit users could easily assume they should return the HTTP status `401 Unauthorized`, but this would be against the definition for this status code.
+ 
+ > "The request has not been applied because it lacks valid authentication credentials for the target resource" - https://httpstatuses.com/401
+ 
+Failing pundit checks rarely has anything to do with a lack of credentials, the failure is more likely a case of 
+  
+ > "The server understood the request but refuses to authorize it." - https://httpstatuses.com/403
+
+It gets even worse if you follow a pattern in your client of forcing a logout of the user when they receive a 401, which makes sense when 401 is used correctly. The result is that attempting anything not allowed by a policy causes the user to be logged out, when they should simply be shown an alert and given the opportunity to correct the error or do something else while maintaining their session.
+
+Pundit does have this in the README https://github.com/elabs/pundit#rescuing-a-denied-authorization-in-rails, but it is easily missed and naming mismatch is still likely to trip up new users.
+
+https://github.com/elabs/pundit/issues/412
+
+As an initial mitigation, crewd-policies provides the `CrewdPolicies::ForbiddenError` exception and the `forbidden!` method.
+
+## Development
+
+After checking out the repo, to install dependencies run:
+
+    bin/setup
+
+Then, run tests with:
+
+    rake spec
+
+For an  interactive prompt that will allow you to experiment, you can also run
+
+    bin/console
+
+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
+
+`rake release` will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+To experiment with this gem with interactive prompt, run
+
+     bin/console
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/crewd_policies. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "crewd_policies"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/crewd_policies.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crewd_policies/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crewd_policies"
+  spec.version       = CrewdPolicies::VERSION
+  spec.authors       = ["Gary McGhee"]
+  spec.email         = ["gary@buzzware.com.au"]
+
+  spec.summary       = %q{A happy path for writing DRY Pundit policies}
+  spec.description   = %q{CrewdPolicies enables conventional Pundit (https://github.com/elabs/pundit) policies to be written using an opinionated pattern based on declarative Create, Read, Execute (optional), Write and Destroy (CREWD) permissions for each resource. Conventional pundit create?, show?, update? and destroy? permissions are automatically derived from these, as well as permitted_attributes/strong parameters.}
+  spec.homepage      = "https://github.com/buzzware/crewd_policies"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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"]
+
+  spec.add_runtime_dependency "pundit", '~> 1.1', '>= 1.1.0'
+  spec.add_runtime_dependency "standard_exceptions", "~> 0.1.4"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activerecord", "~> 4.2"
+  spec.add_development_dependency "activesupport", "~> 4.2"
+end

data/lib/crewd_policies.rb

@@ -0,0 +1,9 @@
+require "crewd_policies/version"
+require "crewd_policies/model"
+require "crewd_policies/policy"
+require "crewd_policies/base_policy"
+require "crewd_policies/jsonapi_resources"
+
+module CrewdPolicies
+  # Your code goes here...
+end

data/lib/crewd_policies/base_policy.rb

@@ -0,0 +1,42 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/string/inflections'
+require 'pundit'
+
+module CrewdPolicies
+	# optional
+	class BasePolicy
+		include Policy
+
+		attr_reader :identity, :record
+
+		def initialize(identity, record)
+	     @identity = identity
+	     @record = record
+		end
+
+		def model_class
+	    @policy_class ||= self.class.name.sub(/Policy$/,'').safe_constantize  # record ? record.class
+	   end
+
+		def scope
+	     Pundit.policy_scope!(identity, model_class)
+	   end
+
+		class Scope
+	     attr_reader :identity, :scope
+
+	    def initialize(identity, scope)
+	      @identity = identity
+	      @scope = scope
+	    end
+
+	    def model_class
+	      @policy_class ||= (self.class.name.sub(/Policy::Scope$/,'').safe_constantize or @scope)
+	    end
+
+			def resolve
+				scope
+			end
+		end
+	end
+end

data/lib/crewd_policies/jsonapi_resources.rb

@@ -0,0 +1,39 @@
+# This is for use with https://github.com/cerebris/jsonapi-resources
+# It was developed with https://github.com/venuu/jsonapi-authorization but it may not be required because it doesn't seem to deal with attributes, just scope and record permissions?
+# eg.
+# class BaseResource < JSONAPI::Resource
+#   include JSONAPI::Authorization::PunditScopedResource
+#   include CrewdPolicies::JSONAPIResource
+#   abstract
+# end
+
+module CrewdPolicies
+	module JSONAPIResource
+
+		def self.included(aClass)
+	    aClass.send :extend, ClassMethods
+	  end
+
+		module ClassMethods
+
+			def inherited(subclass)
+				super
+				attrs = ::Pundit.policy!(nil,subclass._model_class).all_attributes.map(&:to_sym)
+				attrs -= [:id]
+				subclass.send(:attributes, *attrs) unless attrs.empty?
+      end
+
+			def updatable_fields(context)
+				::Pundit.policy!(context[:user],_model).permitted_attributes_for_update.map(&:to_sym)
+		  end
+
+		  def self.creatable_fields(context)
+			  ::Pundit.policy!(context[:user],_model).permitted_attributes_for_create.map(&:to_sym)
+		  end
+		end
+
+		def fetchable_fields
+		  ::Pundit.policy!(context[:user],_model).permitted_attributes_for_read.map(&:to_sym)
+		end
+	end
+end

data/lib/crewd_policies/model.rb

@@ -0,0 +1,52 @@
+# these methods should actually work on any object with any abilities
+
+module CrewdPolicies::Model
+
+	def self.included(aClass)
+		aClass.cattr_accessor :roles_rules
+    aClass.roles_rules = {}   # [:sales] => [
+															#               {ability: 'read', fields: [:name,:address]}
+															#               {ability: 'destroy', allowed: true}
+															#             ]
+    aClass.send :extend, ClassMethods
+  end
+
+	module ClassMethods
+
+		# supports different formats : allow <role>, <abilities> => <attributes>
+		#
+		# allow :sales, :write => [:name,:address]   ie. sales can write the name and address fields
+		def allow(aRole,aAbilities)
+			if aRole.is_a? Array
+				aRole.each {|r| allow(r,aAbilities.dup) }
+				return
+			end
+			raise "aRole must be a string or a symbol" unless aRole.is_a?(String) or aRole.is_a?(Symbol)
+			aRole = aRole.to_s
+			raise "aAbilities must be a Hash" unless aAbilities.is_a? Hash # eg. :write => [:name,:address]
+
+			role_rules = (self.roles_rules[aRole] ||= [])
+			conditions = {}
+			conditions[:if] = aAbilities.delete(:if) if aAbilities.include?(:if)
+			conditions[:unless] = aAbilities.delete(:unless) if aAbilities.include?(:unless)
+			aAbilities.each do |abilities, fields|
+				abilities = [abilities] unless abilities.is_a?(Array)
+				fields = [fields] unless fields==true or fields.is_a?(Array)
+				abilities = abilities.map{|a| a.to_s}                       # now an array of strings
+				fields = fields.map{|a| a.to_s}.sort unless fields==true    # now an array of strings or true
+				next if fields==[]
+				abilities.each do |a|
+					role_rules << (rule = {})
+					rule[:ability] = a
+					rule[:conditions] = conditions unless conditions.empty?
+					if fields==true  # special "field" value to mean the record or class
+						rule[:allowed] = true
+					else
+						raise "create, destroy and index must have true as a value, not an array of fields" if a=='create' or a=='destroy' or a=='index'
+						rule[:fields] = fields
+					end
+				end
+			end
+		end
+	end
+end

data/lib/crewd_policies/policy.rb

@@ -0,0 +1,233 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/string/inflections'
+require 'standard_exceptions'
+
+module CrewdPolicies
+	module Policy
+
+		include ::StandardExceptions::Methods
+
+		public
+
+	  attr_reader :identity, :record
+
+		# typical pundit/rails methods
+
+		def create?   # resource level
+			inner_query_ability(:create)
+		end
+
+		def index?
+			inner_query_ability(:index)
+		end
+
+		def show?
+			inner_query_ability(:read)
+		end
+
+		def new?
+			inner_query_ability(:create)
+		end
+
+		def update?
+			inner_query_ability(:write)
+		end
+
+		def edit?
+			inner_query_ability(:write)
+		end
+
+		def destroy?
+			inner_query_ability(:destroy)
+		end
+
+		%w(write read create update edit show index).each do |m|
+			define_method "permitted_attributes_for_#{m}" do
+				allowed_attributes(m)
+			end
+		end
+
+		def all_attributes
+			result = []
+			record_class.roles_rules.each do |role,rules|
+				rules.each do |rule|
+					result |= rule[:fields] if rule[:fields]
+				end
+			end
+			result.sort
+		end
+
+		def permitted_attributes
+			inner_query_fields('write')
+		end
+
+		# CREWD permission methods
+
+		def read?
+			inner_query_ability(:read)
+		end
+
+		def write?
+			inner_query_ability(:write)
+		end
+
+		# utility methods
+
+		def scope
+			Pundit.policy_scope!(user, record_class)
+		end
+
+		def unauthorized!(aMessage=nil)
+			raise Pundit::NotAuthorizedError,(aMessage || "must be logged in")
+		end
+
+		def forbidden!(aMessage=nil)
+			raise ForbiddenError,(aMessage || "That operation was not allowed")
+		end
+
+		def record_class
+			record.is_a?(Class) ? record : record.class
+		end
+
+		def allowed?(aAbility,aFields=nil)
+			if aFields
+				pf = allowed_fields(aAbility)
+				if aFields.is_a? Array
+					aFields = aFields.map(&:to_s)
+					return (aFields - pf).empty?
+				else
+					aFields = aFields.to_s
+					return pf.include? aFields
+				end
+			else
+				inner_query_resource(aAbility)
+			end
+		end
+
+		# fields may be attributes or associations
+		def allowed_fields(aAbility)
+			inner_query_fields(aAbility)
+		end
+
+	  def allowed_attributes(aAbility)
+		  result = allowed_fields(aAbility)
+		  cls = record_class
+			result.delete_if { |f| cls.reflections.has_key? f } if cls.respond_to? :reflections
+			result
+		end
+
+		def allowed_associations(aAbility=nil)
+		  result = allowed_fields(aAbility)
+		  cls = record_class
+			result.delete_if { |f| !cls.reflections.has_key? f }
+			result
+		end
+
+		protected   # internal methods below here
+
+		def coalesce_field_ability(aAbility)
+			aAbility = aAbility.to_s
+			case aAbility
+				when 'write','read' then aAbility
+				when 'create','update','edit' then 'write'
+				when 'show','index' then 'read'
+				else
+					aAbility
+			end
+		end
+
+
+		# what fields does the identity have this ability for ?
+	  def inner_query_fields(aAbility)
+		  internal_server_error! "roles_rules not found on #{record_class.name}, make sure it has \"include CrewdPolicies::Model\"" unless ra = record_class.roles_rules rescue nil
+		  unauthorized! "identity not given" if !identity
+		  internal_server_error! "identity must implement has_role?" if !identity.responds_to? :has_role?
+
+		  ability = coalesce_field_ability(aAbility)
+
+		  # for each role in roles_rules, if identity.has_role?(role) && any conditions pass then merge in fields
+			result = []
+		  ra.each do |role,rules|
+				next unless identity.has_role? role
+				rules.each do |rule| #ab, fields|
+					next unless rule[:ability]==ability
+					next unless eval_conditions rule
+					result |= rule[:fields]
+				end
+			end
+		  result.sort!
+		  result
+	  end
+
+		# does the identity have this ability on this record?
+		def inner_query_resource(aAbility)
+			internal_server_error! "aAbility must be a string or a symbol" unless aAbility.is_a?(String) or aAbility.is_a?(Symbol)
+			internal_server_error! "roles_rules not found on #{record_class.name}, make sure it has \"include CrewdPolicies::Model\"" unless ra = record_class.roles_rules rescue nil
+			unauthorized! "identity not given" if !identity
+	    internal_server_error! "identity must implement has_role?" if !identity.respond_to? :has_role?
+
+			aAbility = aAbility.to_s
+
+		  ra.each do |role,rules|
+				next unless identity.has_role? role
+				rules.each do |rule|
+					next unless eval_conditions rule
+					next unless rule[:ability]==aAbility
+					return true if rule[:allowed]==true or rule[:fields].is_a?(Array) && !rule[:fields].empty?
+				end
+		  end
+			false
+		end
+
+		def eval_conditions(aRule)
+			return true unless conds = aRule[:conditions]
+			if_cond = conds[:if]
+			unless_cond = conds[:unless]
+
+			if_cond = if if_cond.is_a? Symbol
+				send(if_cond)
+			elsif if_cond.is_a? Proc
+				if_cond.call()
+			elsif if_cond==nil
+				true
+			else
+				if_cond
+			end
+
+			unless_cond = if unless_cond.is_a? Symbol
+				send(unless_cond)
+			elsif unless_cond.is_a? Proc
+				unless_cond.call()
+			elsif unless_cond==nil
+				false
+			else
+				unless_cond
+			end
+
+			!!if_cond and !unless_cond
+		end
+
+		# does the identity have this ability on the record/resource at all?
+		def inner_query_ability(aAbility)
+			raise "aAbility must be a string or a symbol" unless aAbility.is_a?(String) or aAbility.is_a?(Symbol)
+			aAbility = aAbility.to_s
+
+			case aAbility
+				when 'write','read','update','show','edit'
+					inner_query_fields(aAbility).length > 0
+				when 'create','destroy','index'
+					inner_query_resource(aAbility)
+				else
+					raise 'this ability is unknown'
+			end
+		end
+	end
+
+	class ForbiddenError < ::StandardExceptions::Http::Forbidden
+		attr_accessor :query, :record, :policy
+  end
+
+	::Pundit::NotAuthorizedError.class_eval do
+		include ::StandardExceptions::ExceptionInterface
+	end
+end

data/lib/crewd_policies/version.rb

@@ -0,0 +1,3 @@
+module CrewdPolicies
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: crewd_policies
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Gary McGhee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: standard_exceptions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: CrewdPolicies enables conventional Pundit (https://github.com/elabs/pundit)
+  policies to be written using an opinionated pattern based on declarative Create,
+  Read, Execute (optional), Write and Destroy (CREWD) permissions for each resource.
+  Conventional pundit create?, show?, update? and destroy? permissions are automatically
+  derived from these, as well as permitted_attributes/strong parameters.
+email:
+- gary@buzzware.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crewd_policies.gemspec
+- lib/crewd_policies.rb
+- lib/crewd_policies/base_policy.rb
+- lib/crewd_policies/jsonapi_resources.rb
+- lib/crewd_policies/model.rb
+- lib/crewd_policies/policy.rb
+- lib/crewd_policies/version.rb
+homepage: https://github.com/buzzware/crewd_policies
+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.8
+signing_key: 
+specification_version: 4
+summary: A happy path for writing DRY Pundit policies
+test_files: []