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.


418
419
420
421
422
423
424
425
426
427
# File 'lib/declarative_authorization/authorization.rb', line 418

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

#attributesObject (readonly)

Returns the value of attribute attributes


415
416
417
# File 'lib/declarative_authorization/authorization.rb', line 415

def attributes
  @attributes
end

#contextsObject (readonly)

Returns the value of attribute contexts


415
416
417
# File 'lib/declarative_authorization/authorization.rb', line 415

def contexts
  @contexts
end

#join_operatorObject (readonly)

Returns the value of attribute join_operator


415
416
417
# File 'lib/declarative_authorization/authorization.rb', line 415

def join_operator
  @join_operator
end

#privilegesObject (readonly)

Returns the value of attribute privileges


415
416
417
# File 'lib/declarative_authorization/authorization.rb', line 415

def privileges
  @privileges
end

#roleObject (readonly)

Returns the value of attribute role


415
416
417
# File 'lib/declarative_authorization/authorization.rb', line 415

def role
  @role
end

#source_fileObject (readonly)

Returns the value of attribute source_file


415
416
417
# File 'lib/declarative_authorization/authorization.rb', line 415

def source_file
  @source_file
end

#source_lineObject (readonly)

Returns the value of attribute source_line


415
416
417
# File 'lib/declarative_authorization/authorization.rb', line 415

def source_line
  @source_line
end

Instance Method Details

#append_attribute(attribute) ⇒ Object


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

def append_attribute (attribute)
  @attributes << attribute
end

#append_privileges(privs) ⇒ Object


435
436
437
# File 'lib/declarative_authorization/authorization.rb', line 435

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

#initialize_copy(from) ⇒ Object


429
430
431
432
433
# File 'lib/declarative_authorization/authorization.rb', line 429

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)

443
444
445
446
447
# File 'lib/declarative_authorization/authorization.rb', line 443

def matches? (roles, privs, context = nil)
  roles = [roles] unless roles.is_a?(Array)
  @contexts.include?(context) and roles.include?(@role) and 
    not (@privileges & privs).empty?
end

#obligations(attr_validator) ⇒ Object


460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
# File 'lib/declarative_authorization/authorization.rb', line 460

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_sObject


494
495
496
# File 'lib/declarative_authorization/authorization.rb', line 494

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

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

Returns:

  • (Boolean)

449
450
451
452
453
454
455
456
457
458
# File 'lib/declarative_authorization/authorization.rb', line 449

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