pragma-policy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3558b9e18dec8f44921f49f1390ac27ec81d0633
+  data.tar.gz: ae90ff0b36bbd2ba93c66af2f33f540727517140
+SHA512:
+  metadata.gz: e3dfe25ea37762ef45e30d474a5176d38f558d528f0352b3cc342a4f18c1508e9c8fe8f6605b67082ef5a8fa06f352bad19a6df420b8d42b2f5d8aa2acfdbeac
+  data.tar.gz: 3d15e2cceb67dc0236f0d9204d3938f0e248946688d07346e4f19bb572ae68b2767987fd1c34a8210659e681f1ee2e29d748164d57a46b487f813cf546d1f6bd

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,84 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'bin/*'
+   - 'db/**/*'
+   - 'vendor/bundle/**/*'
+   - 'spec/spec_helper.rb'
+   - 'spec/rails_helper.rb'
+   - 'spec/support/**/*'
+   - 'config/**/*'
+   - '**/Rakefile'
+   - '**/Gemfile'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/requests/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  AllowURI: true
+
+Style/FirstParameterIndentation:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Style/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alessandro Desantis
+
+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,182 @@
+# Pragma::Policy
+
+[![Build Status](https://img.shields.io/travis/pragmarb/pragma-policy.svg?maxAge=3600&style=flat-square)](https://travis-ci.org/pragmarb/pragma-policy)
+[![Dependency Status](https://img.shields.io/gemnasium/pragmarb/pragma-policy.svg?maxAge=3600&style=flat-square)](https://gemnasium.com/github.com/pragmarb/pragma-policy)
+[![Code Climate](https://img.shields.io/codeclimate/github/pragmarb/pragma-policy.svg?maxAge=3600&style=flat-square)](https://codeclimate.com/github/pragmarb/pragma-policy)
+[![Coveralls](https://img.shields.io/coveralls/pragmarb/pragma-policy.svg?maxAge=3600&style=flat-square)](https://coveralls.io/github/pragmarb/pragma-policy)
+
+Policies provide fine-grained access control for your API resources.
+
+They are built on top of [Reform](https://github.com/apotonick/reform).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pragma-policy'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install pragma-policy
+```
+
+## Usage
+
+To create a policy, simply inherit from `Pragma::Policy::Base`:
+
+```ruby
+module API
+  module V1
+    module Post
+      class Policy < Pragma::Policy::Base
+      end
+    end
+  end
+end
+```
+
+By default, the policy does not return any objects and forbids all operations.
+
+You can start customizing your policy by defining a scope and operation predicates:
+
+```ruby
+module API
+  module V1
+    module Post
+      class Policy < Pragma::Policy::Base
+        def self.accessible_by(user:, scope:)
+          scope.where('published = ? OR author_id = ?', true, user.id)
+        end
+
+        def show?
+          resource.published? || resource.author_id == user.id
+        end
+
+        def update?
+          resource.author_id == user.id
+        end
+
+        def destroy?
+          resource.author_id == user.id
+        end
+      end
+    end
+  end
+end
+```
+
+You are ready to use your policy!
+
+### Retrieving records
+
+To retrieve all the records accessible by a user, use the `.accessible_by` class method:
+
+```ruby
+posts = API::V1::Post::Policy.accessible_by(user: user, scope: Post.all)
+```
+
+### Authorizing operations
+
+To authorize an operation, first instantiate the policy, then use the predicate methods:
+
+```ruby
+policy = API::V1::Post::Policy.new(user: user, resource: post)
+fail 'You cannot update this post!' unless policy.update?
+```
+
+Since raising when the operation is forbidden is so common, we provide bang methods a shorthand
+syntax. `Pragma::Policy::ForbiddenError` is raised if the predicate method returns `false`:
+
+```ruby
+policy = API::V1::Post::Policy.new(user: user, resource: post)
+policy.update! # raises if the user cannot update the post
+```
+
+### Attribute-level authorization
+
+In some cases, you'll want to prevent a user from updating a certain attribute. You can do that with
+the `#authorize_attr` method:
+
+```ruby
+module API
+  module V1
+    module Post
+      class Policy < Pragma::Policy::Base
+        def update?
+          # admins can do whatever they want
+          return true if user.admin?
+
+          (
+            resource.author_id == user.id &&
+            # regular users cannot change the 'featured' attribute
+            authorize_attr(:featured)
+          )
+        end
+      end
+    end
+  end
+end
+```
+
+You can also allow specific values for an enumerated attribute:
+
+```ruby
+module API
+  module V1
+    module Post
+      class Policy < Pragma::Policy::Base
+        def update?
+          # admins can do whatever they want
+          return true if user.admin?
+
+          (
+            resource.author_id == user.id &&
+            # regular users can only set status to 'draft' or 'published'
+            authorize_attr(:status, only: ['draft', 'published'])
+          )
+        end
+      end
+    end
+  end
+end
+```
+
+Or you can invert the condition and specify the forbidden attributes:
+
+```ruby
+module API
+  module V1
+    module Post
+      class Policy < Pragma::Policy::Base
+        def update?
+          # admins can do whatever they want
+          return true if user.admin?
+
+          (
+            resource.author_id == user.id &&
+            # regular users cannot set the status to 'rejected'
+            authorize_attr(:status, except: ['rejected'])
+          )
+        end
+      end
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pragmarb/pragma-policy.
+
+## 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 "pragma/policy"
+
+# 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/lib/pragma/policy.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'pragma/policy/version'
+require 'pragma/policy/base'
+require 'pragma/policy/attribute_authorizer'
+
+module Pragma
+  # Fine-grained access control for your API resources.
+  #
+  # @author Alessandro Desantis
+  module Policy
+  end
+end

data/lib/pragma/policy/attribute_authorizer.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+module Pragma
+  module Policy
+    # The attribute authorizer provides attribute-level authorization for resource updates.
+    #
+    # It allows you to specify whether a resource attribute can be changed and, if you want, what
+    # values should be allowed.
+    #
+    # If you want, you can subclass this base authorizer to avoid repeating code.
+    #
+    # @author Alessandro Desantis
+    class AttributeAuthorizer
+      # @!attribute [r] resource
+      #   @return [ActiveRecord::Base|Reform::Form] the resource being authorized
+      #
+      # @!attribute [r] attribute
+      #   @return [Symbol] the attribute being authorized
+      attr_reader :resource, :attribute
+
+      # Initializes the authorizer.
+      #
+      # @param resource [ActiveRecord::Base|Reform::Form] the resource being authorized
+      # @param attribute [Symbol] the attribute being authorized
+      #
+      # @raise [UnknownEngineError] if the resource is not based on Reform or ActiveRecord
+      def initialize(resource:, attribute:)
+        @resource = resource
+        @attribute = attribute
+
+        validate_resource
+      end
+
+      # Returns the old value of the attribute (if any).
+      #
+      # For Reform, this retrieves the current value of the attribute from the model. For
+      # ActiveRecord, uses the +<attribute>_was+ method.
+      #
+      # @return [Object|NilClass]
+      def old_value
+        case resource_engine
+        when :reform
+          resource.model.send(attribute)
+        when :active_record
+          resource.send("#{attribute}_was")
+        end
+      end
+
+      # Returns the new (i.e. current) value of the attribute.
+      #
+      # Simply sends the attribute name to the resource.
+      #
+      # @return [Object]
+      def new_value
+        resource.send(attribute)
+      end
+
+      # Returns whether the attribute has changed, by comparing the new and the old value.
+      #
+      # @return [Boolean]
+      def changed?
+        old_value != new_value
+      end
+
+      # Returns the engine used for the resource being authorized (Reform or ActiveRecord).
+      #
+      # @return [Symbol] +:reform+ or +:active_record+
+      #
+      # @raise [UnknownEngineError] if the engine cannot be detected
+      def resource_engine
+        if defined?(Reform::Form) && resource.is_a?(Reform::Form)
+          :reform
+        elsif defined?(ActiveRecord::Base) && resource.is_a?(ActiveRecord::Base)
+          :active_record
+        else
+          fail UnknownEngineError(resource: resource, attribute: attribute)
+        end
+      end
+
+      # Ensures that the attribute was changed according to the provided options.
+      #
+      # When neither +only+ nor +except+ are passed, simply ensures that the attribute was not
+      # changed.
+      #
+      # When +only+ is passed and is not empty, ensures that the value is part of the given array.
+      #
+      # When +except+ is passed and not empty, also ensures that the value is NOT part of the given
+      # array.
+      #
+      # @param options [Hash] a hash of options
+      #
+      # @option options [Array<String>] :only an optional list of allowed values
+      # @option options [Array<String>] :except an optional list of forbidden values
+      #
+      # @return [Boolean] whether the attribute has an authorized value
+      def authorize(options = {})
+        options[:only] = ([options[:only]] || []).flatten.map(&:to_s).reject(&:empty?)
+        options[:except] = ([options[:except]] || []).flatten.map(&:to_s).reject(&:empty?)
+
+        if options[:only].any? && options[:except].any?
+          fail(
+            ArgumentError,
+            'The :only and :except options cannot be used at the same time.'
+          )
+        end
+
+        return true unless changed?
+
+        if options[:only].any?
+          options[:only].include?(new_value.to_s)
+        elsif options[:except].any?
+          !options[:except].include?(new_value.to_s)
+        end || false
+      end
+
+      private
+
+      def validate_resource
+        resource_engine
+      end
+
+      # This error when the engine behind a resource cannot be detected for attribute authorization.
+      #
+      # @author Alessanro Desantis
+      class UnknownEngineError < StandardError
+        MESSAGE = 'Attribute authorization only works with Reform forms and ActiveRecord models.'
+
+        # @!attribute [r] resource
+        #   @return [Object] the resource
+        attr_reader :resource
+
+        # Initializes the error.
+        #
+        # @param resource [Object] the resource
+        def initialize(resource:)
+          @resource = resource
+
+          super MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/pragma/policy/base.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+module Pragma
+  module Policy
+    # This is the base policy class that all your resource-specific policies should inherit from.
+    #
+    # A policy provides predicate methods for determining whether a user can perform a specific
+    # action on a resource.
+    #
+    # @author Alessandro Desantis
+    #
+    # @abstract Subclass and implement action methods to create a policy.
+    class Base
+      # @!attribute [r] user
+      #   @return [Object] the user operating on the resource
+      #
+      # @!attribute [r] resource
+      #   @return [Object] the resource being operated on
+      attr_reader :user, :resource
+
+      # Returns the records accessible by the given user.
+      #
+      # @param user [Object] the user accessing the records
+      # @param relation [Object] the relation to use as a base
+      #
+      # @return [Object]
+      #
+      # @abstract Override to implement retrieving the accessible records
+      def self.accessible_by(user, relation:) # rubocop:disable Lint/UnusedMethodArgument
+        fail NotImplementedError
+      end
+
+      # Initializes the policy.
+      #
+      # @param user [Object] the user operating on the resource
+      # @param resource [Object] the resource being operated on
+      def initialize(user:, resource:)
+        @user = user
+        @resource = resource
+      end
+
+      # Returns whether the policy responds to the provided missing method.
+      #
+      # Supports bang forms of predicates (+create!+, +update!+ etc.).
+      #
+      # @param method_name [String] the method name
+      # @param include_private [Boolean] whether to consider private methods
+      #
+      # @return [Boolean]
+      def respond_to_missing?(method_name, include_private = false)
+        return super unless method_name[-1] == '!'
+        respond_to?("#{method_name[0..-2]}?", include_private) || super
+      end
+
+      # Provides bang form of predicates (+create!+, +update!+ etc.).
+      #
+      # @param method_name [String] the method name
+      # @param *args [Array<Object>] the method arguments
+      #
+      # @return [Object]
+      def method_missing(method_name, *args, &block)
+        return super unless method_name[-1] == '!'
+        authorize method_name[0..-2], *args
+      end
+
+      # Authorizes the user to perform the given action. If not authorized, raises a
+      # {ForbiddenError}.
+      #
+      # @param action [Symbol] the action to authorize
+      #
+      # @raise [ArgumentError] if the action is not defined in this policy
+      # @raise [ForbiddenError] if the user is not authorized to perform the action
+      def authorize(action)
+        unless respond_to?("#{action}?")
+          fail(
+            ArgumentError,
+            "'#{action}' is not a valid action for this policy."
+          )
+        end
+
+        return if send("#{action}?")
+
+        fail(
+          ForbiddenError,
+          user: user,
+          action: action,
+          resource: resource
+        )
+      end
+
+      protected
+
+      # Authorizes a resource attribute.
+      #
+      # @param attribute [Symbol] the name of the attribute
+      # @param options [Hash] options (see {AttributeAuthorizer#authorize} for allowed options)
+      #
+      # @return [Boolean] whether the attribute's value is allowed
+      def authorize_attr(attribute, options = {})
+        AttributeAuthorizer.new(
+          resource: resource,
+          attribute: attribute
+        ).authorize(options)
+      end
+    end
+
+    # This error is raised when a user attempts to perform an unauthorized operation on a
+    # resource.
+    #
+    # @author Alessandro Desantis
+    class ForbiddenError < StandardError
+      MESSAGE = "User is not authorized to perform the '%{action}' action on this resource."
+
+      # @!attribtue [r] user
+      #   @return [Object] the user operating on the resource
+      #
+      # @!attribute [r] action
+      #   @return [Symbol] the attempted action
+      #
+      # @!attribute [r] resource
+      #   @return [Object] the resource being operated on
+      attr_reader :user, :action, :resource
+
+      # Initializes the error.
+      #
+      # @param user [Object] the user operating on the resource
+      # @param action [Symbol] the attempted action
+      # @param resource [Object] the resource being operated on
+      def initialize(user:, action:, resource:)
+        @user = user
+        @action = action.to_sym
+        @resource = resource
+
+        super MESSAGE.gsub('%{action}', action.to_s)
+      end
+    end
+  end
+end

data/lib/pragma/policy/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Pragma
+  module Policy
+    VERSION = '0.1.0'
+  end
+end

data/pragma-policy.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pragma/policy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pragma-policy"
+  spec.version       = Pragma::Policy::VERSION
+  spec.authors       = ["Alessandro Desantis"]
+  spec.email         = ["desa.alessandro@gmail.com"]
+
+  spec.summary       = 'Fine-grained access control for your API resources.'
+  spec.homepage      = "https://github.com/pragmarb/pragma-policy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: pragma-policy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: 
+email:
+- desa.alessandro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pragma/policy.rb
+- lib/pragma/policy/attribute_authorizer.rb
+- lib/pragma/policy/base.rb
+- lib/pragma/policy/version.rb
+- pragma-policy.gemspec
+homepage: https://github.com/pragmarb/pragma-policy
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Fine-grained access control for your API resources.
+test_files: []