pundit_helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eabe76151f5ab089cd71e22a1eaf07f5ac46e405
+  data.tar.gz: 65e3da497c6d5000e8b6e93153227b085519b0b7
+SHA512:
+  metadata.gz: 0f48e47729f0b5464cb4167077e20a686b0cb63cd50bb278b4a070085a743dda9f861b89e0ef5d95758fa29dbcf7cf4eb302f82d786b1b77bdd2e1eb47602625
+  data.tar.gz: a9934477a2f25f26ac1c186208de1238b91f4f01c77b267d2644632f2e7516aa7360af56897f095d72a0162bcb1b435edfeae08f8c37f93b875d4303d09b5d9c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brendon Murphy
+
+MIT License
+
+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,55 @@
+# PunditHelpers
+
+Authorization helpers for Pundit
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pundit_helpers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pundit_helpers
+
+## Usage
+
+In your base controller or controllers that need Pundit:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Pundit
+  include PunditHelpers
+end
+```
+
+The helpers currently add an `#authorized?` method that is useful
+for letting Pundit know that you have checked authorization so that the
+`verify_authorized` after filter doesn't raise an exception, and returns
+false for failures rather than raising.
+
+```ruby
+authorize(post, :show?) # Returns true or raises Pundit::NotAuthorized on failure
+authorized?(post, :show?) # Returns true or false
+```
+
+Also, this adds a `#can?` method ala CanCan.  Passing `can?` an action and record
+will return a boolean and is useful in views.  For example:
+
+```erb
+<% if can? :edit, @lesson %>
+  <a href="/posts/42/edit">edit</a>
+<% end %>
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/pundit_helpers/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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+task :default => [:spec]

data/lib/pundit_helpers/version.rb

@@ -0,0 +1,3 @@
+module PunditHelpers
+  VERSION = "0.0.1"
+end

data/lib/pundit_helpers.rb

@@ -0,0 +1,39 @@
+require "pundit_helpers/version"
+
+module PunditHelpers
+  # Pundit's core `#authorize` helper always raises
+  # an error, but also lets the controller know an authorization
+  # has been performed.  Sometimes it is preferrable to flag that an
+  # authorization check has been made, but return boolean rather than
+  # raise.  So this uses an exception rescue for flow control, which is
+  # not optimal but fits nicely with the current API and doesn't cause
+  # serious breakage
+  #
+  # @param [record] record - the record to check
+  # @param [string or symbol] query - the policy action to check for
+  #
+  # @return [Boolean]
+  def authorized?(record, query=nil)
+    begin
+      authorize(record, query)
+    rescue Pundit::NotAuthorizedError
+      false
+    end
+  end
+
+  # The current user permissions can be policy checked in views:
+  #
+  # <% if can? :edit, @lesson %>
+  #   <a href="/posts/42/edit">edit</a>
+  # <% end %>
+  #
+  # @param [string or symbol] query - the query to check
+  # @param [record] record - the record for policy lookup
+  #
+  # @return [Boolean]
+  def can?(query, record)
+    query  = "#{query}?"
+    policy = Pundit.policy!(current_user, record)
+    !! policy.public_send(query)
+  end
+end

data/pundit_helpers.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pundit_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pundit_helpers"
+  spec.version       = PunditHelpers::VERSION
+  spec.authors       = ["Brendon Murphy"]
+  spec.email         = ["xternal1+github@gmail.com"]
+  spec.summary       = %q{Authorization helpers for Pundit}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pundit", "~> 0.2.1"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+end

data/spec/pundit_helpers_spec.rb

@@ -0,0 +1,46 @@
+require "pundit"
+require "pundit_helpers"
+
+class Harness
+  include PunditHelpers
+
+  def current_user
+    :spec_current_user
+  end
+end
+
+describe PunditHelpers, "#authorized?" do
+  it "is true if #authorize returns true" do
+    harness = Harness.new
+    record = double
+    expect(harness).to receive(:authorize).with(record, :show?).and_return(true)
+    expect(harness.authorized?(record, :show?)).to be_true
+  end
+
+  it "is false if #authorize raises Pundit::NotAuthorizedError" do
+    harness = Harness.new
+    record = double
+    expect(harness).to receive(:authorize).with(record, :show?).and_raise(Pundit::NotAuthorizedError)
+    expect(harness.authorized?(record, :show?)).to be_false
+  end
+end
+
+describe PunditHelpers, "#can?" do
+  it "is true if the located policy permits the action" do
+    record  = double
+    policy  = double(:edit? => true)
+    harness = Harness.new
+
+    expect(Pundit).to receive(:policy!).with(:spec_current_user, record).and_return(policy)
+    expect(harness.can?(:edit, record)).to be_true
+  end
+
+  it "is false if the located policy denies the action" do
+    record  = double
+    policy  = double(:edit? => false)
+    harness = Harness.new
+
+    expect(Pundit).to receive(:policy!).with(:spec_current_user, record).and_return(policy)
+    expect(harness.can?(:edit, record)).to be_false
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: pundit_helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: 
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pundit_helpers.rb
+- lib/pundit_helpers/version.rb
+- pundit_helpers.gemspec
+- spec/pundit_helpers_spec.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/pundit_helpers_spec.rb