ya_acl 0.0.6 → 0.0.7

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - jruby

data/README.rdoc

@@ -1,54 +1,57 @@
 == ya_acl
 
-Ya_Acl - реализация списка прав доступа (ACL).
+{<img src="https://secure.travis-ci.org/kaize/ya_acl.png" alt="Build Status" />}[http://travis-ci.org/kaize/ya_acl]
 
-Ya_Acl представляет собой самостоятельный объект посредством которого производятся все проверки.
-Это значит что он не привязан к фреймворкам и это руководство предлагает только один из возможных путей использования этого компонента.
+Ya_Acl - access control list (ACL) implementation for your Ruby application.
 
-=== Установка
+Ya_Acl provides a standalone object through which all checks are made.
+This means it is not tied to any framework. Note that this guide will show you only one possible way to use this component.
+
+=== Installation
 
     gem install ya_acl
 
-=== Основные понятия
+=== Keywords
 
-Ресурс - объект, доступ к которому контролируется.
-Привилегия - действие совершаемое над ресурсом.
-Роль - объект, который может запрашивать доступ к ресурсу.
+Resource - object to restrict access to.
+Privilege - action on the resource.
+Role - object, which can request for an access to a resource.
 
-Роль(роли) запрашивает доступ к привилегии ресурса.
-Например ресурс "пользователь" может иметь привилегию "создать".
+Role(s) request for an access to the resource privileges.
+For example, resource "user" can have a privilege "create".
 
-=== Начальные условия
+=== Initial conditions
 
-- По умолчанию все запрещено. И по ходу можно только выставлять разрешения, но не запреты.
-- Все ресурсы должны быть добавлены в acl (в противном случае получите исключение).
+- By default, everything is forbidden. Further you will only be able to grant access to a particular resource, not restrict it.
+- All resources must be added to the acl (otherwise you will get an exception).
 
-=== Основные возможности
+=== Key features
 
-Assert - динамические проверки, например, является ли залогиненый пользователь владельцем этого объекта.
-Проверки могут ставиться на конкретные роли для текущей привилегии, а не просто "на привилегию".
-Владение несколькими ролями. Если хотя бы одной из ролей пользователя разрешен доступ к привилегии ресурса, то доступ открыт.
-Роль с глобальным доступом ко всем ресурсам. Передается аргументом в метод билдера "resources".
-Наследование ролей для ресурсов. То есть мы можем определить роли которым автоматически станут доступны все привилегии ресурса.
+Asserts - runtime checks, e.g. "whether logged in user is the owner of this object".
+Checks can be assigned to specific roles of the current privilege, not just "on the privilege".
+Owning multiple roles. If at least one of the user roles has access to the resource privilege,
+access granted. Role with global access to all resources. Passed as an argument to the `Builder::resources`
+method. Roles inheritance. That is, we could define a role that will automatically get all resource privileges.
 
-=== Порядок выполнения проверок на доступность к привилегии ресурса
+=== Access check algorithm
 
-1. Если ни одна из переданных ролей не имеет доступа к привилегии ресурса, то доступ запрещается.
-2. Для каждой роли, имеющий доступ к привилегии, проверяются проверки предназначенные для этой роли. Если хотя бы для одной роли прошли все проверки, то доступ разрешается.
+1. If none of the passed roles have access to resource privilege - access denied.
+2. If any, for each role we run asserts. If at least one role passed these checks - access granted.
 
 === Workflow
 
-В начале необходимо проинициализировать объект acl.
-Для этого необходимо создать файл (структура ниже) который будет загружаться при старте приложения. Хотя в development среде вы можете захотеть подгружать его при каждом запросе для удобства разработки.
+First, initialize acl object by creating the config file
+(you could use the structure sample below). It should be loaded while your application starts.
+Although, in development environment, you may want it to be loaded before each request.
 
     YaAcl::Builder.build do
-      roles do # Роли
+      roles do # Roles
         role :admin
         role :editor
         role :operator
       end
 
-      asserts do # Проверки
+      asserts do # Checks
         assert :assert_name, [:current_user_id, :another_user_id] do
           current_user_id == another_user_id
         end
@@ -58,19 +61,19 @@ Assert - динамические проверки, например, являе
         end
       end
 
-      resources :admin do # Ресурсы и роль которой доступно все
-        resource 'UserController', [:editor] do # Ресурс и роли которым доступны все привилегии данного ресурса
-          privilege :index, [:operator] # доступно для :admin, :editor, :operator
-          privilege :edit # доступно для :admin, :editor
+      resources :admin do # Resources and role with admin privileges
+        resource 'UserController', [:editor] do # Resource and roles, which have access to the all privileges of a given resource
+          privilege :index, [:operator] # allowed for :admin, :editor, :operator
+          privilege :edit # allowed for :admin, :editor
           privilege :new do
-            assert :assert_name, [:editor] # Эта проверка будет вызвана только для роли :editor
-            assert :another_assert_name # Эта проверка будет вызвана для ролей :admin, :editor
+            assert :assert_name, [:editor] # This check will be called for role :editor
+            assert :another_assert_name # This check will be called for :admin and :editor roles
           end
         end
       end
     end
 
-После этого будет доступен объект acl через YaAcl::Acl.instance.
+After that, acl object becomes accessible via YaAcl::Acl.instance.
 
     acl = YaAcl::Acl.instance
 
@@ -80,5 +83,5 @@ Assert - динамические проверки, например, являе
     acl.allow?('UserController', :new, [:admin], :current_user_id => 1, :another_user_id => 1) # true
     acl.allow?('UserController', :new, [:editor], :current_user_id => 1, :another_user_id => 2) # false
 
-    acl#check - возвращает объект результата YaAcl::Result
-    acl#check! - возвращает true или бросает исключение
+    acl#check - returns YaAcl::Result object
+    acl#check! - returns true or throws an exception

data/Rakefile

@@ -1,2 +1,6 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+task :test => :spec

data/lib/ya_acl.rb

@@ -1,6 +1,11 @@
-require 'ya_acl/acl'
-require 'ya_acl/builder'
-require 'ya_acl/role'
-require 'ya_acl/resource'
-require 'ya_acl/assert'
-require 'ya_acl/result'
+module YaAcl
+  autoload :Acl, 'ya_acl/acl'
+  autoload :Role, 'ya_acl/role'
+  autoload :Resource, 'ya_acl/resource'
+  autoload :Assert, 'ya_acl/assert'
+  autoload :Result, 'ya_acl/result'
+  autoload :Builder, 'ya_acl/builder'
+
+  class AccessDeniedError < RuntimeError ; end
+  class AssertAccessDeniedError < AccessDeniedError ; end
+end

data/lib/ya_acl/acl.rb

@@ -1,8 +1,4 @@
 module YaAcl
-
-  class AccessDeniedError < StandardError ; end
-  class AssertAccessDeniedError < AccessDeniedError ; end
-
   class Acl
 
     attr_reader :roles, :resources, :asserts
@@ -113,7 +109,7 @@ module YaAcl
     def check!(resource_name, privilege_name, roles = [], params = {})
       result = check(resource_name, privilege_name, roles, params)
       return true if result.status
-      
+
       message = "Access denied for '#{resource_name}', privilege '#{privilege_name}'"
       if result.assert
         raise AssertAccessDeniedError, message + ", role '#{result.role}' and assert '#{result.assert.name}'"
@@ -122,4 +118,4 @@ module YaAcl
       end
     end
   end
-end
+end

data/lib/ya_acl/builder.rb

@@ -3,28 +3,27 @@ module YaAcl
     attr_accessor :acl
 
     def self.build &block
-      builder = new
-      builder.instance_eval &block
-      builder.acl.freeze
+      builder = new block
       Acl.instance = builder.acl
     end
 
-    def initialize
+    def initialize block
       self.acl = Acl.new
+      instance_eval &block
     end
 
     def roles(&block)
       instance_eval &block
     end
 
-    def role(name, options = {})
-      acl.add_role Role.new(name, options)
-    end
-
     def asserts(&block)
       instance_eval &block
     end
 
+    def role(name, options = {})
+      acl.add_role Role.new(name, options)
+    end
+
     def assert(name, param_names, &block)
       acl.add_assert Assert.new(name, param_names, &block)
     end
@@ -55,10 +54,9 @@ module YaAcl
 
         asserts = {}
         if block_given?
-          proxy = PrivilegeAssertProxy.new(asserts_block, all_allow_roles)
-          asserts = proxy.asserts
+          asserts = PrivilegeAssertProxy.build asserts_block, all_allow_roles
         end
-        
+
         all_allow_roles.each do |role|
           if asserts[role]
             asserts[role].each do |assert|
@@ -73,7 +71,12 @@ module YaAcl
 
     class PrivilegeAssertProxy
       attr_reader :asserts
-      
+
+      def self.build(block, all_allow_roles)
+        builder = new block, all_allow_roles
+        builder.asserts
+      end
+
       def initialize(block, all_allow_roles)
         @all_allow_roles = all_allow_roles
         @asserts = {}
@@ -89,4 +92,4 @@ module YaAcl
       end
     end
   end
-end
+end

data/lib/ya_acl/resource.rb

@@ -1,9 +1,9 @@
 module YaAcl
   class Resource
     attr_reader :name
-    
+
     def initialize(name)
       @name = name.to_sym
     end
   end
-end
+end

data/lib/ya_acl/version.rb

@@ -1,3 +1,3 @@
 module YaAcl
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/ya_acl/acl_spec.rb

@@ -15,7 +15,7 @@ describe YaAcl::Acl do
     assert = YaAcl::Assert.new :assert, [:object_user_id, :user_id] do
       object_user_id == user_id
     end
-    
+
     @acl.add_assert assert
   end
 
@@ -53,4 +53,4 @@ describe YaAcl::Acl do
     @acl.allow?(:name, :empty, [:guest, :admin]).should be_true
     @acl.allow?(:name, :index, [:guest, :admin], :var => false).should be_true
   end
-end
+end

data/spec/ya_acl/builder_spec.rb

@@ -7,7 +7,7 @@ describe YaAcl::Builder do
         role :admin, :name => 'Administrator'
       end
     end
-    
+
     acl.role(:admin).should_not be_nil
   end
 
@@ -143,4 +143,4 @@ describe YaAcl::Builder do
     acl.allow?(:name, :update, [:operator], :first => 1, :second => 1).should be_true
     acl.allow?(:name, :update, [:operator], :first => 3, :second => 3).should be_false
   end
-end
+end

data/ya_acl.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Mokevnin Kirill"]
   s.email       = ["mokevnin@gmail.com"]
-  s.homepage    = "http://github.com/mokevnin/ya_acl"
+  s.homepage    = "http://github.com/kaize/ya_acl"
   s.summary     = %q{Yet Another ACL}
   s.description = %q{Yet Another ACL}
 
@@ -19,4 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-end
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "rake"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ya_acl
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000 Z
-dependencies: []
+date: 2012-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Yet Another ACL
 email:
 - mokevnin@gmail.com
@@ -19,6 +51,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -35,9 +68,8 @@ files:
 - spec/ya_acl/acl_spec.rb
 - spec/ya_acl/builder_spec.rb
 - spec/ya_acl/role_spec.rb
-- spec/ya_acl_spec.rb
 - ya_acl.gemspec
-homepage: http://github.com/mokevnin/ya_acl
+homepage: http://github.com/kaize/ya_acl
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -49,16 +81,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -834640367938296051
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -834640367938296051
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Yet Another ACL
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/ya_acl/acl_spec.rb
+- spec/ya_acl/builder_spec.rb
+- spec/ya_acl/role_spec.rb

data/spec/ya_acl_spec.rb

@@ -1,7 +0,0 @@
-require "ya_acl"
-
-describe YaAcl do
-  before do
-    @acl = YaAcl::Acl.new
-  end
-end