module Eaco

Welcome to Eaco!

Eaco is a full-fledged authorization framework for Ruby that allows you to describe which actions are allowed on your resources, how to identify your users as having a particular privilege and which privileges are granted to a specific resource through the usage of ACLs.

Constants

DEFAULT_RULES: The location of the default rules file
VERSION: Current version

Public Class Methods

eval!(source, path) click to toggle source

Evaluates the given authorization rules source, orignally found on path.

@param source [String] {DSL} source code @param path [String] Source code origin, for better backtraces.

@return true

@raise [Error] if something goes wrong while evaluating the DSL.

@see DSL

# File lib/eaco.rb, line 75
  def self.eval!(source, path)
    DSL.send :eval, source, nil, path, 1

    true
  rescue => e
    raise Error, <<-EOF

=== EACO === Error while evaluating rules

#{e.message}

 +--------- -- -
 | #{e.backtrace.join("\n | ")}
 +-

=== EACO ===

    EOF
  end

parse_default_rules_file!() click to toggle source

Parses and evaluates the authorization rules from the {DEFAULT_RULES}.

The authorization rules define all the authorization framework behaviour through the {DSL}

@return (see .eval!)

# File lib/eaco.rb, line 40
def self.parse_default_rules_file!
  parse_rules! DEFAULT_RULES
end

parse_rules!(rules) click to toggle source

Parses the given rules file.

@param rules [Pathname]

@return (see .eval!)

@raise [Malformed] if the rules file does not exist.

# File lib/eaco.rb, line 53
def self.parse_rules!(rules)
  unless rules.exist?
    path = rules.realpath rescue rules.to_s
    raise Malformed, "Please create #{path} with Eaco authorization rules"
  end

  eval! rules.read, rules.realpath.to_s
end