eaco 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9384ef5a98077f6557e1e69eb7f54fb0463d35d5
-  data.tar.gz: 5728d953f8b9aef185fc97a84ae1a236c35ae9eb
+  metadata.gz: 536f9a37ebe0f8c16425d643a8cb91c119d5f61c
+  data.tar.gz: 0e9c61eeddaca078398925b397e39795f7b8247b
 SHA512:
-  metadata.gz: 7f5c5de62937bef96163b634a895903cdc4fa76368ac7b1dc56765d395bb5445ca0c41e3ef9b49c6992b5dda264210ecb50b79613a574c31887ec7da83d35aec
-  data.tar.gz: 15d230d2416a2fd7a0ddaf5479433759d494d7a285944d38606f05630567a321f0baf4a787ecbd4a993ff155a9d1031a66c53fb97dbb9ba5876f9ba6b6801b47
+  metadata.gz: 9780bf31341fde6cce7a5046c83d667e2ec09b6595b3806a4ed3d42ca3d67264eaa13d44d61d6e0d65e3acf4911f899088986bf72cf01f5640e1b8d4d5e4c8d3
+  data.tar.gz: ee7f5cf26bce90db25812ae255409b0b938119678ff3a1f08b278eda2b53b5457c383835c4700f6e5a84d402b64368af01043ebff87515a70f946e52d002eacd

data/.yardopts

@@ -1 +1,6 @@
---protected --private --no-private --hide-void-return '{lib,features/support}/**/*.rb' - README.md LICENSE.txt
+--protected
+--private
+--no-private
+--hide-void-return
+--plugin cucumber
+'{lib,features}/**/*.rb' - README.md LICENSE.txt

data/README.md

@@ -11,10 +11,12 @@ framework for Ruby.
 
 ![Eaco e Telamone][eaco-e-telamone]
 
+*"Aeacus telemon by user Ravenous at en.wikipedia.org - Public domain through Wikimedia Commons - http://commons.wikimedia.org/wiki/File:Aeacus_telemon.jpg"*
+
 ## Design
 
-Eaco provides your context's Resources discretionary access by an Actor.
-Access to the Resource is determined using an ACL.
+Eaco provides your application's Resources discretionary access.
+Access to the Resource is determined matching an ACL against an Actor.
 
 Different Actors can have different levels of access to the same Resource,
 depending on their role as determined by the ACL.
@@ -22,24 +24,23 @@ depending on their role as determined by the ACL.
 To each role are granted a set of possible abilities, and access is verified
 by checking whether a given actor can perform a specific ability.
 
-Actors are described by their Designators, a pluggable mechanism to be
-implemented in your application.
-
-Each Actor has many designators that describe either its identity or its
-belonging to a group or occupying a position in a department.
+Actors are described by their Designators, a pluggable mechanism whose details
+are up to your application. For instance, an Actor can have many designators
+that describe either its identity or its belonging to a group or occupying a
+position in a department.
 
 Designators are Ruby classes that can embed any sort of custom behaviour that
 your application requires.
 
 ACLs are hashes with designators as keys and roles as values. Extracting
 authorized collections requires only an hash key lookup mechanism in your
-database. Adapters are provided for PG's jsonb and for CouchDB-Lucene.
+database. Adapters are provided for PG's +jsonb+ and for CouchDB-Lucene.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'eaco', github: 'ifad/eaco'
+    gem 'eaco'
 
 And then execute:
 
@@ -89,6 +90,7 @@ with an ACL [(rdoc)](http://www.rubydoc.info/github/ifad/eaco/master/Eaco/ACL):
 # An example ACL
 >> document = Document.first
 => #<Document id:42 name:"President's report for loans.docx" [...]>
+
 >> document.acl
 => #<Document::ACL {"user:10" => :owner, "group:reviewers" => :reader}>
 ```
@@ -99,6 +101,7 @@ and an Actor [(rdoc)](http://www.rubydoc.info/github/ifad/eaco/master/Eaco/Actor
 # An example Actor
 >> user = User.find(10)
 => #<User id:10 name:"Bob Fropp" group_ids:['employees'], tags:['english']>
+
 >> user.designators
 => #<Set{ #<Designator(User) value:10>, #<Designator(Group) value:"employees">, #<Designator(Tag) value:"english"> }
 ```
@@ -164,25 +167,27 @@ Grant reader access to a group:
 => true
 ```
 
-Obtain a collection of Resources accessible by a given Actor [(rdoc)](http://www.rubydoc.info/github/ifad/eaco/master/Eaco/Adapters):
+Obtain a collection of Resources accessible by a given Actor
+[(rdoc)](http://www.rubydoc.info/github/ifad/eaco/master/Eaco/Adapters):
 
 ```ruby
 >> Document.accessible_by(user)
 ```
 
 Check whether a controller action can be accessed by an user. Your
-`ApplicationController` must respond to `current_user` for this to work.
+Controller must respond to `current_user` for this to work.
 [(rdoc)](http://www.rubydoc.info/github/ifad/eaco/master/Eaco/Controller)
 
 ```ruby
 class DocumentsController < ApplicationController
   before_filter :find_document
 
-  authorize :edit, :update, [:document, :read]
+  authorize :show, [:document, :read]
+  authorize :edit, [:document, :edit]
 
   private
     def find_document
-      @document = Document.find(:id)
+      @document = Document.find(params[:id])
     end
 end
 ```
@@ -208,9 +213,9 @@ see `features/active_record.example.yml` for an example.
 
 Run `bundle` once. This will install the base bundle.
 
-Run `appraisal` once. This will install the supported Rails versions and pg.
+Run `appraisal` once. This will install the supported Rails versions and +pg+.
 
-Run `rake`. This will run the specs and cucumber features.
+Run `rake`. This will run the specs and cucumber features and report coverage.
 
 Specs are run against the supported rails versions in turn. If you want to
 focus on a single release, use `appraisal rails-X.Y rake`, where `X.Y` can be
@@ -228,4 +233,4 @@ focus on a single release, use `appraisal rails-X.Y rake`, where `X.Y` can be
 
 This software is Made in Italy :it: :smile:.
 
-[eaco-e-telamone]: http://upload.wikimedia.org/wikipedia/commons/7/70/Aeacus_telemon.jpg "Aeacus telemon by user Ravenous at en.wikipedia.org - Public domain through Wikimedia Commons - http://commons.wikimedia.org/wiki/File:Aeacus_telemon.jpg#mediaviewer/File:Aeacus_telemon.jpg"
+[eaco-e-telamone]: http://upload.wikimedia.org/wikipedia/commons/7/70/Aeacus_telemon.jpg

data/eaco.gemspec

@@ -17,12 +17,17 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  [
-    ["bundler", "~> 1.6"],
-    "rake", "byebug", "guard", "yard", "appraisal",
-    "rspec",  "guard-rspec", "yard-rspec",
-    "cucumber", "guard-cucumber", "coveralls",
-    "guard-shell"
-
-  ].each {|gem| spec.add_development_dependency *gem }
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "guard-cucumber"
+  spec.add_development_dependency "yard-cucumber"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "guard-shell"
 end

data/lib/eaco/adapters/active_record/compatibility/v40.rb

@@ -27,6 +27,8 @@ module Eaco
             adapter.class.parent::PostgreSQLColumn.instance_eval do
               include Column
             end
+
+            base.extend Scoped
           end
 
           ##

data/lib/eaco/version.rb

@@ -2,6 +2,6 @@ module Eaco
 
   # Current version
   #
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 
 end

data/spec/eaco/actor_spec.rb

@@ -4,10 +4,10 @@ require 'spec_helper'
 
 RSpec.describe Eaco::Actor do
 
-  pending '#designators'
+  #pending '#designators'
 
-  pending '#is_admin?'
+  #pending '#is_admin?'
 
-  pending '#can?'
+  #pending '#can?'
 
 end

data/spec/eaco/controller_spec.rb

@@ -5,8 +5,8 @@ require 'eaco/controller'
 
 RSpec.describe Eaco::Controller do
 
-  pending '.authorize'
+  #pending '.authorize'
 
-  pending '.permission_for'
+  #pending '.permission_for'
 
 end

data/spec/eaco/designator_spec.rb

@@ -4,22 +4,22 @@ require 'spec_helper'
 
 RSpec.describe Eaco::Designator do
 
-  pending '#make'
+  #pending '#make'
 
-  pending '#parse'
+  #pending '#parse'
 
-  pending '#resolve'
+  #pending '#resolve'
 
-  pending '#configure!'
+  #pending '#configure!'
 
-  pending '#harvest'
+  #pending '#harvest'
 
-  pending '#label'
+  #pending '#label'
 
-  pending '#id'
+  #pending '#id'
 
-  pending '#search'
+  #pending '#search'
 
-  pending '#new'
+  #pending '#new'
 
 end

data/spec/eaco/dsl/acl_spec.rb

@@ -4,6 +4,6 @@ require 'spec_helper'
 
 RSpec.describe Eaco::DSL::ACL do
 
-  pending '#new'
+  #pending '#new'
 
 end

data/spec/eaco/dsl/actor_spec.rb

@@ -4,12 +4,12 @@ require 'spec_helper'
 
 RSpec.describe Eaco::DSL::Actor do
 
-  pending '#new'
+  #pending '#new'
 
-  pending '#designators'
+  #pending '#designators'
 
-  pending '#admin_logic'
+  #pending '#admin_logic'
 
-  pending '.find_designator'
+  #pending '.find_designator'
 
 end

data/spec/eaco/dsl/resource_spec.rb

@@ -4,14 +4,14 @@ require 'spec_helper'
 
 RSpec.describe Eaco::DSL::Resource do
 
-  pending '#new'
+  #pending '#new'
 
-  pending '#permissions'
+  #pending '#permissions'
 
-  pending '#roles'
+  #pending '#roles'
 
-  pending '#roles_priority'
+  #pending '#roles_priority'
 
-  pending '#roles_with_labels'
+  #pending '#roles_with_labels'
 
 end

data/spec/eaco/error_spec.rb

@@ -4,6 +4,6 @@ require 'spec_helper'
 
 RSpec.describe Eaco::Error do
 
-  pending '#new'
+  #pending '#new'
 
 end

data/spec/eaco/resource_spec.rb

@@ -4,28 +4,28 @@ require 'spec_helper'
 
 RSpec.describe Eaco::Resource do
 
-  pending '.role?'
+  #pending '.role?'
 
-  pending '.allows?'
+  #pending '.allows?'
 
-  pending '.role_of'
+  #pending '.role_of'
 
-  pending '.permissions'
+  #pending '.permissions'
 
-  pending '.roles'
+  #pending '.roles'
 
-  pending '.roles_priority'
+  #pending '.roles_priority'
 
-  pending '.roles_with_labels'
+  #pending '.roles_with_labels'
 
-  pending '#allows?'
+  #pending '#allows?'
 
-  pending '#role_of'
+  #pending '#role_of'
 
-  pending '#grant'
+  #pending '#grant'
 
-  pending '#revoke'
+  #pending '#revoke'
 
-  pending '#batch_grant'
+  #pending '#batch_grant'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eaco
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Marcello Barnaba
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard-rspec
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: guard-cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-cucumber
+  name: yard-cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -199,6 +199,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".config/cucumber.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -273,10 +274,6 @@ files:
 - lib/eaco/version.rb
 - spec/eaco/acl_spec.rb
 - spec/eaco/actor_spec.rb
-- spec/eaco/adapters/active_record/postgres_jsonb_spec.rb
-- spec/eaco/adapters/active_record_spec.rb
-- spec/eaco/adapters/couchrest_model/couchdb_lucene_spec.rb
-- spec/eaco/adapters/couchrest_model_spec.rb
 - spec/eaco/controller_spec.rb
 - spec/eaco/designator_spec.rb
 - spec/eaco/dsl/acl_spec.rb
@@ -328,10 +325,6 @@ test_files:
 - features/support/env.rb
 - spec/eaco/acl_spec.rb
 - spec/eaco/actor_spec.rb
-- spec/eaco/adapters/active_record/postgres_jsonb_spec.rb
-- spec/eaco/adapters/active_record_spec.rb
-- spec/eaco/adapters/couchrest_model/couchdb_lucene_spec.rb
-- spec/eaco/adapters/couchrest_model_spec.rb
 - spec/eaco/controller_spec.rb
 - spec/eaco/designator_spec.rb
 - spec/eaco/dsl/acl_spec.rb

data/spec/eaco/adapters/active_record/postgres_jsonb_spec.rb

@@ -1,9 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'spec_helper'
-
-RSpec.describe Eaco::Adapters::ActiveRecord::PostgresJSONb do
-
-  pending '.accessible_by'
-
-end

data/spec/eaco/adapters/active_record_spec.rb

@@ -1,13 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'spec_helper'
-
-RSpec.describe Eaco::Adapters::ActiveRecord do
-
-  pending '.included'
-
-  pending '#acl'
-
-  pending '#acl='
-
-end

data/spec/eaco/adapters/couchrest_model/couchdb_lucene_spec.rb

@@ -1,9 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'spec_helper'
-
-RSpec.describe Eaco::Adapters::CouchrestModel::CouchDBLucene do
-
-  pending '.accessible_by'
-
-end

data/spec/eaco/adapters/couchrest_model_spec.rb

@@ -1,9 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'spec_helper'
-
-RSpec.describe Eaco::Adapters::CouchrestModel do
-
-  pending '.included'
-
-end