Class: Authorization::AuthorizationRule

Inherits:
Object
  • Object
show all
Defined in:
lib/declarative_authorization/authorization.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(role, privileges = [], contexts = nil, join_operator = :or, options = {}) ⇒ AuthorizationRule

Returns a new instance of AuthorizationRule.



442
443
444
445
446
447
448
449
450
451
 
# File 'lib/declarative_authorization/authorization.rb', line 442

def initialize(role, privileges = [], contexts = nil, join_operator = :or,
      options = {})
  @role = role
  @privileges = Set.new(privileges)
  @contexts = Set.new((contexts && !contexts.is_a?(Array) ? [contexts] : contexts))
  @join_operator = join_operator
  @attributes = []
  @source_file = options[:source_file]
  @source_line = options[:source_line]
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



439
440
441
 
# File 'lib/declarative_authorization/authorization.rb', line 439

def attributes
  @attributes
end

#contexts ⇒ Object (readonly)

Returns the value of attribute contexts.



439
440
441
 
# File 'lib/declarative_authorization/authorization.rb', line 439

def contexts
  @contexts
end

#join_operator ⇒ Object (readonly)

Returns the value of attribute join_operator.



439
440
441
 
# File 'lib/declarative_authorization/authorization.rb', line 439

def join_operator
  @join_operator
end

#privileges ⇒ Object (readonly)

Returns the value of attribute privileges.



439
440
441
 
# File 'lib/declarative_authorization/authorization.rb', line 439

def privileges
  @privileges
end

#role ⇒ Object (readonly)

Returns the value of attribute role.



439
440
441
 
# File 'lib/declarative_authorization/authorization.rb', line 439

def role
  @role
end

#source_file ⇒ Object (readonly)

Returns the value of attribute source_file.



439
440
441
 
# File 'lib/declarative_authorization/authorization.rb', line 439

def source_file
  @source_file
end

#source_line ⇒ Object (readonly)

Returns the value of attribute source_line.



439
440
441
 
# File 'lib/declarative_authorization/authorization.rb', line 439

def source_line
  @source_line
end

Instance Method Details

#append_attribute(attribute) ⇒ Object 



463
464
465
 
# File 'lib/declarative_authorization/authorization.rb', line 463

def append_attribute(attribute)
  @attributes << attribute
end

#append_privileges(privs) ⇒ Object 



459
460
461
 
# File 'lib/declarative_authorization/authorization.rb', line 459

def append_privileges(privs)
  @privileges.merge(privs)
end

#initialize_copy(from) ⇒ Object 



453
454
455
456
457
 
# File 'lib/declarative_authorization/authorization.rb', line 453

def initialize_copy(from)
  @privileges = @privileges.clone
  @contexts = @contexts.clone
  @attributes = @attributes.collect {|attribute| attribute.clone }
end

#matches?(roles, privs, context = nil) ⇒ Boolean

Returns:

  • (Boolean) 


467
468
469
470
 
# File 'lib/declarative_authorization/authorization.rb', line 467

def matches?(roles, privs, context = nil)
  roles = Hash[[*roles].map { |r| [r, true] }] unless roles.is_a?(Hash)
  @contexts.include?(context) && roles.include?(@role) && privs.any? { |priv| @privileges.include?(priv) }
end

#obligations(attr_validator) ⇒ Object 



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/declarative_authorization/authorization.rb', line 483

def obligations(attr_validator)
  exceptions = []
  obligations = @attributes.collect do |attr|
    begin
      attr.obligation(attr_validator)
    rescue NotAuthorized => e
      exceptions << e
      nil
    end
  end

  if exceptions.length > 0 and (@join_operator == :and or exceptions.length == @attributes.length)
    raise NotAuthorized, "Missing authorization in collecting obligations: #{exceptions.map(&:to_s) * ", "}"
  end

  if @join_operator == :and and !obligations.empty?
    # cross product of OR'ed obligations in arrays
    arrayed_obligations = obligations.map {|obligation| obligation.is_a?(Hash) ? [obligation] : obligation}
    merged_obligations = arrayed_obligations.first
    arrayed_obligations[1..-1].each do |inner_obligations|
      previous_merged_obligations = merged_obligations
      merged_obligations = inner_obligations.collect do |inner_obligation|
        previous_merged_obligations.collect do |merged_obligation|
          merged_obligation.deep_merge(inner_obligation)
        end
      end.flatten
    end
    obligations = merged_obligations
  else
    obligations = obligations.flatten.compact
  end
  obligations.empty? ? [{}] : obligations
end

#to_long_s ⇒ Object 



517
518
519
 
# File 'lib/declarative_authorization/authorization.rb', line 517

def to_long_s
  attributes.collect {|attr| attr.to_long_s } * "; "
end

#validate?(attr_validator, skip_attribute = false) ⇒ Boolean

Returns:

  • (Boolean) 


472
473
474
475
476
477
478
479
480
481
 
# File 'lib/declarative_authorization/authorization.rb', line 472

def validate?(attr_validator, skip_attribute = false)
  skip_attribute or @attributes.empty? or
    @attributes.send(@join_operator == :and ? :all? : :any?) do |attr|
      begin
        attr.validate?(attr_validator)
      rescue NilAttributeValueError => e
        nil # Bumping up against a nil attribute value flunks the rule.
      end
    end
end