pundit-resources 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84095ef1d7eddc023bc1c00e4501b4068e86386e
+  data.tar.gz: 557410b3f7c007a2905702fb2a9c4d5c15331e16
+SHA512:
+  metadata.gz: e4ba2f3c7e00b6cc852858920804acd20ec77bdc3a23a772412ec05c2077c4d9926e64e49ad41b6f8fa4858e0c5f5465fa355fcbe4ccf8c02772783122c99083
+  data.tar.gz: 8c37cec27ae036fb6de09bda7ed756d5e1ea27eb58cc2f67c0dd84303b463507393d6da399bd2978bd8f6f195d39b4425a1e8a454de1f54d5442310a6fdc1743

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+gem_graph.png
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+!spec/dummy/tmp/.keep
+spec/examples.txt

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Dependencies for dummy application
+gem 'sqlite3'
+gem 'jsonapi-resources', github: 'cerebris/jsonapi-resources'
+gem 'pundit'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Toggle Professional Services, LLC
+
+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,67 @@
+# Pundit::Resources
+
+Pundit::Resources is a gem that makes [JSONAPI::Resources](jsonapi-resources) use [Pundit][pundit] authorization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pundit-resources'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install pundit-resources
+```
+
+## Usage
+
+Include `Pundit::ResourceController` in the resource controllers that should use Pundit.
+
+You also need to define a `current_user` method on the controller.
+The result of this method will be passed as the user parameter to the Pundit policies.
+
+```ruby
+class ApplicationController < JSONAPI::ResourceController
+  include Pundit::ResourceController
+
+  protected
+
+  def current_user
+    User.find(params[:id])
+  end
+end
+```
+
+Also, include `Pundit::Resource` in the resources that should use Pundit:
+
+```ruby
+class ApplicationResource < JSONAPI::Resource
+  include Pundit::Resource
+end
+```
+
+Pundit::Resources does not use the `show?` action on Pundit policies.
+Instead, it checks to see if the given resource is included in the Scope for that policy.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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][rubygems].
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[jsonapi-resources]: https://github.com/cerebris/jsonapi-resources
+[pundit]: https://github.com/elabs/pundit
+[rubygems]: https://rubygems.org

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 "pundit/resources"
+
+# 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/pundit/resource.rb

@@ -0,0 +1,84 @@
+require "active_support/concern"
+
+module Pundit
+  module Resource
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :authorize_create_or_update
+      before_remove :authorize_destroy
+    end
+
+    module ClassMethods
+      def records(options = {})
+        warn_if_show_defined
+
+        context = options[:context]
+        Pundit.policy_scope!(context[:current_user], _model_class)
+      end
+
+      private
+
+      def warn_if_show_defined
+        policy_class = Pundit::PolicyFinder.new(_model_class.new).policy!
+        if policy_class.method_defined?(:show?)
+          puts "WARN: pundit-resources does not use the show? action."
+          puts "      #{policy_class::Scope} will be used instead."
+        end
+      end
+    end
+
+    protected
+
+    def current_user
+      context&.[](:current_user)
+    end
+
+    def policy
+      Pundit.policy!(current_user, _model)
+    end
+
+    def authorize_create_or_update
+      action = _model.new_record? ? :create : :update
+      not_authorized!(action) unless policy.public_send(:"#{action}?")
+    end
+
+    def authorize_destroy
+      not_authorized! :destroy unless policy.destroy?
+    end
+
+    def records_for(association_name, options={})
+      association_reflection = _model.class.reflect_on_association(association_name)
+
+      if association_reflection.macro == :has_many
+        records = _model.public_send(association_name)
+        policy_scope = Pundit.policy_scope!(
+          context[:current_user],
+          association_reflection.class_name.constantize
+        )
+        records.merge(policy_scope)
+      elsif [:has_one, :belongs_to].include?(association_reflection.macro)
+        record = _model.public_send(association_name)
+
+        # Don't rely on policy.show? being defined since it isn't used for
+        # show actions directly and should always have the same behaviour.
+        if record && show?(Pundit.policy!(context[:current_user], record))
+          record
+        else
+          nil
+        end
+      end
+    end
+
+    private
+
+    def not_authorized!(action)
+      options = { query: action, record: _model, policy: policy }
+      raise Pundit::NotAuthorizedError, options
+    end
+
+    def show?(policy)
+      policy.scope.where(id: policy.record.id).exists?
+    end
+  end
+end

data/lib/pundit/resource_controller.rb

@@ -0,0 +1,39 @@
+module Pundit
+  module ResourceController
+    extend ActiveSupport::Concern
+
+    included do
+      include ActionController::Rescue
+
+      JSONAPI.configure do |config|
+        error = Pundit::NotAuthorizedError
+        unless config.exception_class_whitelist.include? error
+          config.exception_class_whitelist << error
+        end
+      end
+
+      rescue_from Pundit::NotAuthorizedError, with: :reject_forbidden_request
+    end
+
+    protected
+
+    def reject_forbidden_request(error)
+      type = error.record.class.name.underscore.humanize(capitalize: false)
+      error = JSONAPI::Error.new(
+        code: JSONAPI::FORBIDDEN,
+        status: :forbidden,
+        title: "#{params[:action].capitalize} Forbidden",
+        detail: "You don't have permission to #{params[:action]} this #{type}.",
+      )
+
+      render json: { errors: [error] }, status: 403
+    end
+
+    def context
+      { current_user: current_user }
+    end
+
+    def current_user
+    end
+  end
+end

data/lib/pundit/resources.rb

@@ -0,0 +1,3 @@
+require "pundit/resources/version"
+require "pundit/resource"
+require "pundit/resource_controller"

data/lib/pundit/resources/version.rb

@@ -0,0 +1,5 @@
+module Pundit
+  module Resources
+    VERSION = "1.0.0"
+  end
+end

data/pundit-resources.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pundit/resources/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pundit-resources"
+  spec.version       = Pundit::Resources::VERSION
+  spec.authors       = ["Ross Penman", "Sean Devine"]
+  spec.email         = ["ross@pen.mn", "barelyknown@icloud.com"]
+
+  spec.summary       = %q{Integrate JSONAPI::Resources with Pundit}
+  spec.homepage      = "https://github.com/togglepro/pundit-resources"
+  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"
+  spec.add_dependency "jsonapi-resources"
+  spec.add_dependency "pundit"
+  spec.add_dependency "rails", ">= 5.0.0.rc1", "< 5.1"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails", '>= 3.5.0.beta3', '< 4.0.0'
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: pundit-resources
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ross Penman
+- Sean Devine
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.rc1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.rc1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0.beta3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0.beta3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: 
+email:
+- ross@pen.mn
+- barelyknown@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pundit/resource.rb
+- lib/pundit/resource_controller.rb
+- lib/pundit/resources.rb
+- lib/pundit/resources/version.rb
+- pundit-resources.gemspec
+homepage: https://github.com/togglepro/pundit-resources
+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.1
+signing_key: 
+specification_version: 4
+summary: Integrate JSONAPI::Resources with Pundit
+test_files: []