regulator 0.1.0

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+before_install: gem install bundler -v 1.10.5
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+  - jruby-19mode
+  - rbx-2
+env:
+  - RSPEC_VERSION="<2.99"
+  - RSPEC_VERSION="~>3.0
+  - CODECLIMATE_REPO_TOKEN=561cc65a0f136c90b4661c76c96e4ca0717d49a1336cb08d7a617f2cb7d4f6c6

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Regulator
+
+## 0.1.0 (2015-07-23)
+- initial release
+- pundit compatible
+- controller based policy namespacing

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, ethnicity, 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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in regulator.gemspec
+gem "rspec"
+gem "codeclimate-test-reporter", group: :test, require: nil
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Cory O'Daniel
+
+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,63 @@
+# Regulator
+[![Build Status](https://travis-ci.org/coryodaniel/regulator.svg)](https://travis-ci.org/coryodaniel/regulator)
+[![Code Climate](https://codeclimate.com/github/coryodaniel/regulator/badges/gpa.svg)](https://codeclimate.com/github/coryodaniel/regulator)
+[![Test Coverage](https://codeclimate.com/github/coryodaniel/regulator/badges/coverage.svg)](https://codeclimate.com/github/coryodaniel/regulator/coverage)
+
+Regulator is a clone of the [Pundit](https://github.com/elabs/pundit) gem and provides a pundit compatible DSL that has **controller namespaced** authorization polices instead of *model namespaced*.
+
+It uses Ruby classes and object oriented design patterns to build a simple, robust and scaleable authorization system.
+
+Existing pundit policies can be used, although they will have to be namespaced properly, or have the controller accessing set ```Controller.policy_class``` or ```Controller.policy_namespace```
+
+I built this because I believe authorization should be controller-based, not model based, but really enjoyed using the Pundit DSL and I was over [monkey-patching](https://gist.github.com/Systho/3d7632b5aa999cf88d87) pundit in all of my projects to make it work the way I want.
+
+Why not contribute to pundit? [It's](https://github.com/elabs/pundit/issues/12) [been](https://github.com/elabs/pundit/issues/178) an [on going](https://github.com/elabs/pundit/search?q=namespace&type=Issues&utf8=%E2%9C%93) 'issue' in pundit and it doesn't look [like it'll be reality.](https://github.com/elabs/pundit/pull/190#issuecomment-53052356)
+
+## TODOs
+  * [ ] generators
+    * [ ] activeadmin-regulator-adapter gem or generator
+  * [ ] documentation (Usage section below, mock pundits)
+    * [ ] Lotus examples
+    * [ ] Grape examples
+    * [ ] ROM examples
+    * [ ] Custom permissions examples
+    * [ ] RoleModel gem examples
+    * [ ] rolify gem examples
+  * [ ] contributing wiki
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'regulator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install regulator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contributors
+  * [Cory O'Daniel](http://linkedin.com/in/coryodaniel)
+
+  Thanks to Warren G for the inspiration, bro.
+
+  ![Regulator](https://upload.wikimedia.org/wikipedia/commons/a/ac/Nat_Powers_%26_Warren_G.jpg)

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  #t.rspec_path = 'bin/rspec'
+  t.rspec_opts = %w[--color]
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  #t.options = ['--any', '--extra', '--opts'] # optional
+end
+
+task :default => [:spec]

data/bin/console

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "regulator"
+
+# 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.
+class Project;end;
+class User;end;
+
+class ProjectPolicy < Struct.new(:user, :project);end;
+class LegacyProjectPolicy < Struct.new(:user, :project);end;
+
+class ApplicationController
+  def current_user
+    User.new
+  end
+end
+
+class ProjectsController < ApplicationController
+  include Regulator
+end
+
+module Api
+  class UserPolicy < Struct.new(:user, :record);end;
+
+  class BaseController < ApplicationController
+    include Regulator
+  end
+
+  module V2
+    class UserPolicy < Struct.new(:user, :record);end;
+    class ProjectsController < Api::BaseController
+      def self.policy_class
+        ProjectPolicy
+      end
+    end
+
+    class UsersController < Api::BaseController
+    end
+  end
+
+  class UsersController < Api::BaseController
+  end
+
+  class ProjectsController < Api::BaseController
+    def self.policy_class
+      LegacyProjectPolicy
+    end
+  end
+end
+
+ProjectsController.new.policy_namespace #=> nil
+Api::ProjectsController.new.policy_namespace #=> Api
+Api::V2::ProjectsController.new.policy_namespace #=> Api::V2
+
+ProjectsController.new.policy(Project) #=> ProjectPolicy
+Api::ProjectsController.new.policy(Project) #=> LegacyProjectPolicy
+Api::V2::ProjectsController.new.policy(Project) #=> ProjectPolicy
+
+Api::UsersController.new.policy(User) #=> Api::UserPolicy
+Api::V2::UsersController.new.policy(User) #=> Api::V2::UserPolicy
+
+require "pry"
+Pry.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/regulator/policy_finder.rb

@@ -0,0 +1,80 @@
+module Regulator
+  class PolicyFinder
+    attr_reader :object
+    attr_reader :controller
+
+    def initialize(object, controller = nil)
+      @object = object
+      @controller = controller
+    end
+
+    def scope
+      policy::Scope if policy
+    rescue NameError
+      nil
+    end
+
+    def policy
+      klass = find
+      klass = klass.constantize if klass.is_a?(String)
+      klass
+    rescue NameError
+      nil
+    end
+
+    def scope!
+      raise NotDefinedError, "unable to find policy scope of nil" if object.nil?
+      scope or raise NotDefinedError, "unable to find scope `#{find}::Scope` for `#{object.inspect}`"
+    end
+
+    def policy!
+      raise NotDefinedError, "unable to find policy of nil" if object.nil?
+      policy or raise NotDefinedError, "unable to find policy `#{find}` for `#{object.inspect}`"
+    end
+
+  private
+
+    def find
+      if object.nil?
+        nil
+      elsif controller.respond_to?(:policy_class)
+        controller.policy_class
+      elsif controller.class.respond_to?(:policy_class)
+        controller.class.policy_class
+      elsif object.respond_to?(:policy_class)
+        deprecation_warning("Model#policy_class", "User Controller#policy_class instead.")
+        object.policy_class
+      elsif object.class.respond_to?(:policy_class)
+        deprecation_warning("Model.policy_class", "User Controller.policy_class instead.")
+        object.class.policy_class
+      else
+        klass = if object.respond_to?(:model_name)
+          object.model_name
+        elsif object.class.respond_to?(:model_name)
+          object.class.model_name
+        elsif object.is_a?(Class)
+          object
+        elsif object.is_a?(Symbol)
+          object.to_s.camelize
+        elsif object.is_a?(Array)
+          object.join('/').camelize
+        else
+          object.class
+        end
+
+        policy_name = "#{klass}#{SUFFIX}"
+
+        if controller
+          "#{controller.policy_namespace}::#{policy_name}"
+        else
+          policy_name
+        end
+      end
+    end
+
+    def deprecation_warning(deprecated_method_name, message, caller_backtrace = nil)
+       message = "#{deprecated_method_name} is deprecated and will be removed from Regulator | #{message}"
+       Kernel.warn message
+    end
+  end
+end

data/lib/regulator/rspec.rb

@@ -0,0 +1,78 @@
+require "active_support/core_ext/array/conversions"
+
+module Regulator
+  module RSpec
+    module Matchers
+      extend ::RSpec::Matchers::DSL
+
+      matcher :permit do |user, record|
+        match_proc = lambda do |policy|
+          @violating_permissions = permissions.find_all { |permission| not policy.new(user, record).public_send(permission) }
+          @violating_permissions.empty?
+        end
+
+        match_when_negated_proc = lambda do |policy|
+          @violating_permissions = permissions.find_all { |permission| policy.new(user, record).public_send(permission) }
+          @violating_permissions.empty?
+        end
+
+        failure_message_proc = lambda do |policy|
+          was_were = @violating_permissions.count > 1 ? "were" : "was"
+          "Expected #{policy} to grant #{permissions.to_sentence} on #{record} but #{@violating_permissions.to_sentence} #{was_were} not granted"
+        end
+
+        failure_message_when_negated_proc = lambda do |policy|
+          was_were = @violating_permissions.count > 1 ? "were" : "was"
+          "Expected #{policy} not to grant #{permissions.to_sentence} on #{record} but #{@violating_permissions.to_sentence} #{was_were} granted"
+        end
+
+        if respond_to?(:match_when_negated)
+          match(&match_proc)
+          match_when_negated(&match_when_negated_proc)
+          failure_message(&failure_message_proc)
+          failure_message_when_negated(&failure_message_when_negated_proc)
+        else
+          match_for_should(&match_proc)
+          match_for_should_not(&match_when_negated_proc)
+          failure_message_for_should(&failure_message_proc)
+          failure_message_for_should_not(&failure_message_when_negated_proc)
+        end
+
+        def permissions
+          current_example = ::RSpec.respond_to?(:current_example) ? ::RSpec.current_example : example
+          current_example.metadata[:permissions]
+        end
+      end
+    end
+
+    module DSL
+      def permissions(*list, &block)
+        describe(list.to_sentence, :permissions => list, :caller => caller) { instance_eval(&block) }
+      end
+    end
+
+    module PolicyExampleGroup
+      include Regulator::RSpec::Matchers
+
+      def self.included(base)
+        base.metadata[:type] = :policy
+        base.extend Regulator::RSpec::DSL
+        super
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  if RSpec::Core::Version::STRING.split(".").first.to_i >= 3
+    config.include(Regulator::RSpec::PolicyExampleGroup, {
+      :type => :policy,
+      :file_path => /spec\/policies/,
+    })
+  else
+    config.include(Regulator::RSpec::PolicyExampleGroup, {
+      :type => :policy,
+      :example_group => { :file_path => /spec\/policies/ }
+    })
+  end
+end

data/lib/regulator/version.rb

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

data/lib/regulator.rb

@@ -0,0 +1,172 @@
+require "regulator/version"
+require "regulator/policy_finder"
+require "active_support/concern"
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/module/introspection"
+require "active_support/dependencies/autoload"
+
+module Regulator
+  SUFFIX = "Policy"
+
+  class Error < StandardError; end
+  class NotAuthorizedError < Error
+    attr_reader :query, :record, :policy
+
+    def initialize(options = {})
+      if options.is_a? String
+        message = options
+      else
+        @query  = options[:query]
+        @record = options[:record]
+        @policy = options[:policy]
+
+        message = options.fetch(:message) { "not allowed to #{query} this #{record.inspect}" }
+      end
+
+      super(message)
+    end
+  end
+  class AuthorizationNotPerformedError < Error; end
+  class PolicyScopingNotPerformedError < AuthorizationNotPerformedError; end
+  class NotDefinedError < Error; end
+
+  extend ActiveSupport::Concern
+
+  class << self
+    def authorize(user, record, query)
+      policy = policy!(user, record)
+
+      unless policy.public_send(query)
+        raise NotAuthorizedError.new(query: query, record: record, policy: policy)
+      end
+
+      true
+    end
+
+    def policy_scope(user, scope, controller = nil)
+      policy_scope = PolicyFinder.new(scope,controller).scope
+      policy_scope.new(user, scope).resolve if policy_scope
+    end
+
+    def policy_scope!(user, scope, controller = nil)
+      PolicyFinder.new(scope,controller).scope!.new(user, scope).resolve
+    end
+
+    def policy(user, record, controller = nil)
+      policy = PolicyFinder.new(record,controller).policy
+      policy.new(user, record) if policy
+    end
+
+    def policy!(user, record, controller = nil)
+      PolicyFinder.new(record,controller).policy!.new(user, record)
+    end
+  end
+
+  module Helper
+    def policy_scope(scope)
+      regulator_policy_scope(scope)
+    end
+  end
+
+  included do
+    def self.policy_namespace
+      ( self.parent != Object ? self.parent : nil )
+    end
+
+    def policy_namespace
+      @_policy_namespace ||= self.class.policy_namespace
+    end
+
+    helper Helper if respond_to?(:helper)
+    if respond_to?(:helper_method)
+      helper_method :policy
+      helper_method :regulator_policy_scope
+      helper_method :regulator_user
+    end
+    if respond_to?(:hide_action)
+      hide_action :policy_namespace
+      hide_action :policy
+      hide_action :policy_scope
+      hide_action :policies
+      hide_action :policy_scopes
+      hide_action :authorize
+      hide_action :verify_authorized
+      hide_action :verify_policy_scoped
+      hide_action :permitted_attributes
+      hide_action :regulator_user
+      hide_action :skip_authorization
+      hide_action :skip_policy_scope
+      hide_action :regulator_policy_authorized?
+      hide_action :regulator_policy_scoped?
+    end
+  end
+
+  def regulator_policy_authorized?
+    !!@_regulator_policy_authorized
+  end
+
+  def regulator_policy_scoped?
+    !!@_regulator_policy_scoped
+  end
+
+  def verify_authorized
+    raise AuthorizationNotPerformedError unless regulator_policy_authorized?
+  end
+
+  def verify_policy_scoped
+    raise PolicyScopingNotPerformedError unless regulator_policy_scoped?
+  end
+
+  def authorize(record, query=nil)
+    query ||= params[:action].to_s + "?"
+
+    @_regulator_policy_authorized = true
+
+    policy = policy(record)
+    unless policy.public_send(query)
+      raise NotAuthorizedError.new(query: query, record: record, policy: policy)
+    end
+
+    true
+  end
+
+  def skip_authorization
+    @_regulator_policy_authorized = true
+  end
+
+  def skip_policy_scope
+    @_regulator_policy_scoped = true
+  end
+
+  def policy_scope(scope)
+    @_regulator_policy_scoped = true
+    regulator_policy_scope(scope)
+  end
+
+  def policy(record)
+    policies[record] ||= Regulator.policy!(regulator_user, record, self)
+  end
+
+  def permitted_attributes(record)
+    name = record.class.to_s.demodulize.underscore
+    params.require(name).permit(*policy(record).permitted_attributes)
+  end
+
+  def policies
+    @_regulator_policies ||= {}
+  end
+
+  def policy_scopes
+    @_regulator_policy_scopes ||= {}
+  end
+
+  def regulator_user
+    current_user
+  end
+private
+
+  def regulator_policy_scope(scope)
+    policy_scopes[scope] ||= Regulator.policy_scope!(regulator_user, scope, self)
+  end
+end

data/regulator.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'regulator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "regulator"
+  spec.version       = Regulator::VERSION
+  spec.authors       = ["Cory O'Daniel"]
+  spec.email         = ["gems@coryodaniel.com"]
+
+  spec.summary       = %q{Minimal controller-based authorization for Rails}
+  spec.description   = %q{Minimal controller-based authorization for Rails}
+  spec.homepage      = "https://github.com/coryodaniel/regulator"
+  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"]
+
+  spec.add_dependency "activesupport", ">= 3.0.0"
+  spec.add_development_dependency "activemodel", ">= 3.0.0"
+  spec.add_development_dependency "actionpack", ">= 3.0.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", ">=2.0.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+end