iq-acl 1.0.4 → 1.0.5

data/README.rdoc

@@ -6,12 +6,17 @@ This aim of this gem is to provide a series of classes to handle common ACL requ
   gem install iq-acl
   
 == Usage
+  # Create an instance of the basic class, supplying rights as a hash, note
+  # that asterisks are used as wildcards.
   auth = IQ::ACL::Basic.new({
     '*'                 => { 'terry' => 'r' },
     'projects'          => { 'jonny' => 'rw' },
     'projects/private'  => { 'billy' => 'rw', 'terry' => nil },
     'projects/public'   => { 'terry' => 'rw', '*' => 'r' }
   })
+  
+  # You could alternatively read rights from a YAML file
+  auth = IQ::ACL::Basic.new(YAML.load_file('rights.yml'))
 
   auth.authorize! 'guest', 'projects'         #=> raises IQ::ACL::AccessDeniedError
   auth.authorize! 'jonny', 'projects'         #=> 'rw'
@@ -26,11 +31,11 @@ This aim of this gem is to provide a series of classes to handle common ACL requ
   auth.authorize! 'billy', 'projects/public'  #=> 'r'
   auth.authorize! 'terry', 'projects/public'  #=> 'rw
 
-  # A block may be given to <tt>authorize!</tt> that should return true if
-  # the yielded rights are adequate for the user, for example the following
-  # will raise an IQ::ACL::AccessDeniedError as 'terry' does not have write access
-  # to the 'projects' path. If 'terry' had write access to the 'projects'
-  # path, the exception would not be thrown.
+A block may be given to <tt>authorize!</tt> that should return true if
+the yielded rights are adequate for the user, for example the following
+will raise an IQ::ACL::AccessDeniedError as 'terry' does not have write access
+to the 'projects' path. If 'terry' had write access to the 'projects'
+path, the exception would not be thrown.
 
   auth.authorize! 'terry', 'projects' do |rights|
     rights.include?('w')

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.0.5

data/iq-acl.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{iq-acl}
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jamie Hill, SonicIQ Ltd."]

data/lib/iq/acl.rb

@@ -1,17 +1,5 @@
 module IQ # :nodoc:
   module ACL # :nodoc:
-    def self.version
-      VERSION::STRING
-    end
-
-    module VERSION #:nodoc:
-      MAJOR = 1
-      MINOR = 0
-      TINY  = 1
-
-      STRING = [MAJOR, MINOR, TINY].join('.')
-    end
-    
     autoload :Basic, File.join(File.dirname(__FILE__), 'acl', 'basic')
     
     # This error is raised when a user does not have access to a supplied path.

data/lib/iq/acl/basic.rb

@@ -4,12 +4,17 @@
 # denote global rules.
 # 
 # @example
+#   # Create an instance of the basic class, supplying rights as a hash, note
+#   # that asterisks are used as wildcards.
 #   auth = IQ::ACL::Basic.new({
 #     '*'                 => { 'terry' => 'r' },
 #     'projects'          => { 'jonny' => 'rw' },
 #     'projects/private'  => { 'billy' => 'rw', 'terry' => nil },
 #     'projects/public'   => { 'terry' => 'rw', '*' => 'r' }
 #   })
+#   
+#   # You could alternatively read rights from a YAML file
+#   auth = IQ::ACL::Basic.new(YAML.load_file('rights.yml'))
 # 
 #   auth.authorize! 'guest', 'projects'         #=> raises IQ::ACL::AccessDeniedError
 #   auth.authorize! 'jonny', 'projects'         #=> 'rw'
@@ -24,13 +29,12 @@
 #   auth.authorize! 'billy', 'projects/public'  #=> 'r'
 #   auth.authorize! 'terry', 'projects/public'  #=> 'rw
 # 
-# A block may be given to authorize! that should return true if the yielded
-# rights are adequate for the user, for example the following will raise an
-# IQ::ACL::AccessDeniedError as 'terry' does not have write access to the
-# 'projects' path. If 'terry' had write access to the 'projects' path, the
-# exception would not be thrown.
+#   # A block may be given to authorize! that should return true if the yielded
+#   # rights are adequate for the user, for example the following will raise an
+#   # IQ::ACL::AccessDeniedError as 'terry' does not have write access to the
+#   # 'projects' path. If 'terry' had write access to the 'projects' path, the
+#   # exception would not be thrown.
 # 
-# @example
 #   auth.authorize! 'terry', 'projects' do |rights|
 #     rights.include?('w')
 #   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 4
-  version: 1.0.4
+  - 5
+  version: 1.0.5
 platform: ruby
 authors: 
 - Jamie Hill, SonicIQ Ltd.