2012-11-04 04:20:45 -05:00
|
|
|
require "pundit/version"
|
2012-11-19 04:57:17 -05:00
|
|
|
require "pundit/policy_finder"
|
2012-11-19 07:02:42 -05:00
|
|
|
require "active_support/concern"
|
|
|
|
require "active_support/core_ext/string/inflections"
|
|
|
|
require "active_support/core_ext/object/blank"
|
2014-05-21 22:09:17 -04:00
|
|
|
require "active_support/core_ext/module/introspection"
|
2014-04-23 00:02:03 -04:00
|
|
|
require "active_support/dependencies/autoload"
|
2012-11-04 04:20:45 -05:00
|
|
|
|
|
|
|
module Pundit
|
2014-02-25 21:54:22 -05:00
|
|
|
class NotAuthorizedError < StandardError
|
2015-02-25 14:30:08 -05:00
|
|
|
attr_reader :query, :record, :policy
|
|
|
|
|
|
|
|
def initialize(options = {})
|
|
|
|
@query = options[:query]
|
|
|
|
@record = options[:record]
|
|
|
|
@policy = options[:policy]
|
|
|
|
|
2015-03-27 05:22:30 -04:00
|
|
|
message = options.fetch(:message) { "not allowed to #{query} this #{record.inspect}" }
|
2015-02-25 14:30:08 -05:00
|
|
|
|
|
|
|
super(message)
|
|
|
|
end
|
2014-02-25 21:54:22 -05:00
|
|
|
end
|
2014-02-14 07:57:13 -05:00
|
|
|
class AuthorizationNotPerformedError < StandardError; end
|
2014-07-07 21:50:22 -04:00
|
|
|
class PolicyScopingNotPerformedError < AuthorizationNotPerformedError; end
|
2012-11-19 04:57:17 -05:00
|
|
|
class NotDefinedError < StandardError; end
|
|
|
|
|
|
|
|
extend ActiveSupport::Concern
|
|
|
|
|
|
|
|
class << self
|
2015-03-26 05:32:20 -04:00
|
|
|
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
|
|
|
|
|
2014-08-22 05:19:36 -04:00
|
|
|
def policy_scope(user, scope)
|
|
|
|
policy_scope = PolicyFinder.new(scope).scope
|
2013-11-05 12:26:38 -05:00
|
|
|
policy_scope.new(user, scope).resolve if policy_scope
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
|
|
|
|
2014-08-22 05:19:36 -04:00
|
|
|
def policy_scope!(user, scope)
|
|
|
|
PolicyFinder.new(scope).scope!.new(user, scope).resolve
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
|
|
|
|
2014-08-22 05:19:36 -04:00
|
|
|
def policy(user, record)
|
|
|
|
policy = PolicyFinder.new(record).policy
|
2013-11-05 12:26:38 -05:00
|
|
|
policy.new(user, record) if policy
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
|
|
|
|
2014-08-22 05:19:36 -04:00
|
|
|
def policy!(user, record)
|
|
|
|
PolicyFinder.new(record).policy!.new(user, record)
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-03-27 08:51:02 -04:00
|
|
|
module Helper
|
|
|
|
def policy_scope(scope)
|
|
|
|
pundit_policy_scope(scope)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-11-19 04:57:17 -05:00
|
|
|
included do
|
2015-03-27 08:51:02 -04:00
|
|
|
helper Helper if respond_to?(:helper)
|
2012-11-19 04:57:17 -05:00
|
|
|
if respond_to?(:helper_method)
|
|
|
|
helper_method :policy
|
2015-03-27 08:51:02 -04:00
|
|
|
helper_method :pundit_policy_scope
|
2013-07-13 18:50:39 -04:00
|
|
|
helper_method :pundit_user
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
2013-03-28 12:26:24 -04:00
|
|
|
if respond_to?(:hide_action)
|
2014-03-09 15:01:53 -04:00
|
|
|
hide_action :policy
|
2014-08-22 07:25:50 -04:00
|
|
|
hide_action :policy_scope
|
|
|
|
hide_action :policies
|
|
|
|
hide_action :policy_scopes
|
2013-03-28 12:26:24 -04:00
|
|
|
hide_action :authorize
|
|
|
|
hide_action :verify_authorized
|
2013-04-18 01:05:24 -04:00
|
|
|
hide_action :verify_policy_scoped
|
2015-03-27 05:14:09 -04:00
|
|
|
hide_action :permitted_attributes
|
2013-07-13 18:50:39 -04:00
|
|
|
hide_action :pundit_user
|
2013-03-28 12:26:24 -04:00
|
|
|
end
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
def verify_authorized
|
2014-08-26 11:57:27 -04:00
|
|
|
raise AuthorizationNotPerformedError unless @_pundit_policy_authorized
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
|
|
|
|
2013-04-18 01:05:24 -04:00
|
|
|
def verify_policy_scoped
|
2014-08-26 11:57:27 -04:00
|
|
|
raise PolicyScopingNotPerformedError unless @_pundit_policy_scoped
|
2013-04-18 01:05:24 -04:00
|
|
|
end
|
|
|
|
|
2012-11-19 04:57:17 -05:00
|
|
|
def authorize(record, query=nil)
|
|
|
|
query ||= params[:action].to_s + "?"
|
2015-02-25 14:30:08 -05:00
|
|
|
|
2014-08-26 11:57:27 -04:00
|
|
|
@_pundit_policy_authorized = true
|
2014-02-25 21:54:22 -05:00
|
|
|
|
|
|
|
policy = policy(record)
|
|
|
|
unless policy.public_send(query)
|
2015-02-25 14:30:08 -05:00
|
|
|
raise NotAuthorizedError.new(query: query, record: record, policy: policy)
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
2014-02-25 21:54:22 -05:00
|
|
|
|
2012-11-19 07:02:42 -05:00
|
|
|
true
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
|
|
|
|
2015-02-20 14:38:08 -05:00
|
|
|
def skip_authorization
|
|
|
|
@_pundit_policy_authorized = true
|
|
|
|
end
|
|
|
|
|
2012-11-19 04:57:17 -05:00
|
|
|
def policy_scope(scope)
|
2014-08-26 11:57:27 -04:00
|
|
|
@_pundit_policy_scoped = true
|
2015-03-27 08:51:02 -04:00
|
|
|
pundit_policy_scope(scope)
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
def policy(record)
|
2014-08-22 07:20:32 -04:00
|
|
|
policies[record] ||= Pundit.policy!(pundit_user, record)
|
2014-05-19 01:05:09 -04:00
|
|
|
end
|
|
|
|
|
2015-03-27 05:14:09 -04:00
|
|
|
def permitted_attributes(record)
|
|
|
|
name = record.class.to_s.demodulize.underscore
|
|
|
|
params.require(name).permit(policy(record).permitted_attributes)
|
|
|
|
end
|
|
|
|
|
2014-08-22 07:20:32 -04:00
|
|
|
def policies
|
2014-08-26 11:57:27 -04:00
|
|
|
@_pundit_policies ||= {}
|
2014-08-22 07:20:32 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def policy_scopes
|
2014-08-26 11:57:27 -04:00
|
|
|
@_pundit_policy_scopes ||= {}
|
2013-07-12 23:42:34 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def pundit_user
|
2013-07-13 10:24:13 -04:00
|
|
|
current_user
|
2012-11-19 04:57:17 -05:00
|
|
|
end
|
2015-03-27 08:51:02 -04:00
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def pundit_policy_scope(scope)
|
|
|
|
policy_scopes[scope] ||= Pundit.policy_scope!(pundit_user, scope)
|
|
|
|
end
|
2012-11-04 04:20:45 -05:00
|
|
|
end
|