vinyl 0.0.1 → 0.0.3

data/README.md

@@ -5,25 +5,35 @@ _by: Federico Saravia Barrantes [@fsaravia](https://github.com/fsaravia) and Lau
 
 ## Introduction
 
-"Vinyl" is a simple gem that allows developer to define different access levels for a resource and a serie of local and global validators to gain access to those levels.
-It works by analizing a series of validators defined by you and returning a number representing the access level a particular request is able to reach.
+"Vinyl" is a simple gem that allows developers to define different access levels for a resource and a series of local and global validators to gain access to those levels.
+It works by analyzing a series of validators defined by you and returning a number representing the access level a particular request is able to reach.
 
 ## What is it useful for?
 
-This gem is useful when you need to control the output depending on who wants to access to a resource.
+This gem is useful when you need to control the output of a process depending on who wants to access to a resource.
 
 For example: user A wants to get user B's profile.
 
-1. If A == B, A have full access to data
-2. If A is friend of B, A can see private data but not config data
-3. If A is not friend of B, A only can see public data
+1. If A == B, then A has full access to data
+2. If A is friend of B, than A can see private data but not config data
+3. If A is not friend of B, then A only can see public data
+
+In this example we have 3 different levels of access to B's information.
+
+## Install
+
+```
+  gem install vinyl
+
+```
 
-In the example we have 3 different levels of access to B information.
 
 ## Basic Config
 
 ```ruby
-  Vinyl::configure do |config|
+  require 'vinyl'
+
+  Vinyl.configure do |config|
     config.api_acl_mode = Vinyl::Configuration::STRATEGY_DESCENDING
     config.force_access_control = true 
     config.warn_on_missing_validators = true 
@@ -41,7 +51,7 @@ Deny access if no validators are given for a route/method combination and no glo
 
 __:warn_on_missing_validators true/false__
 
-Display a warning on STDOUT when calling a missing validator
+Display a warning on STDOUT when calling a non-existent validator (Missing validators output always default to false)
 
 
 ## Defining Rules
@@ -68,13 +78,26 @@ Vinyl.when_route '/profiles.json',
   :get_access_level => 2, 
   :if_pass => ['is_admin']
 ```
+You can define your routes using a string, they may include wildcards or you can also use regular expressions:
 
+__Example:__
+```ruby
+Vinyl.when_route '/profiles*', 
+  :with_method => 'GET', 
+  :get_access_level => 1, 
+  :if_pass => ['is_user']
+
+Vinyl.when_route /^\/profiles\/(\d+)\.(.+)/, 
+  :with_method => 'GET', 
+  :get_access_level => 1, 
+  :if_pass => ['is_user']
+```
 
 ## Defining validators
 
-There are two kind of validators: global and normal validators. All validators you define must return true or false.
+There are two kinds of validators: global and normal validators. All validators you define must return true or false.
 
-Global validators will be applied to all rules defined. You can add a global validator using add_global_validator method:
+Global validators will be applied to every rule. You can add a global validator using add_global_validator method:
 
 ```ruby
 Vinyl.add_global_validator("name_of_global_validator", lambda {
@@ -119,7 +142,7 @@ Vinyl.reset_variables
 ```
 ## Getting Access Level
 
-At this point you had defined your rules, validators and variables. Now you are ready to get call access level.
+At this point you had defined your rules, validators and variables. Now you are ready to check for the access level.
 
 ```ruby
 access_level = Vinyl.check_level('/call/route','call_method')

data/lib/vinyl/base.rb

@@ -13,12 +13,12 @@ module Vinyl
   end
 
   def self.check_level(route,method)
-    required_route = Vinyl::acl_routes_collection[route]
-    required_route = Hash.new if required_route.nil?
-    validators_to_call = required_route[method]
-    if (validators_to_call.nil? || validators_to_call.empty?) then
-      if (global_validators.empty?) then
-        return Vinyl.config.force_access_control ? 0 : 1
+    method_routes = Vinyl.acl_routes_collection[method]
+    return Vinyl.access_level_with_no_validators if method_routes.nil? || method_routes.empty?
+    validators_to_call = method_routes[route]
+    if validators_to_call.nil? || validators_to_call.empty?
+      if global_validators.empty?
+        return Vinyl.access_level_with_no_validators
       else
         validators_to_call = {1 => []} #No access level defined but global validators must be called
       end
@@ -37,6 +37,10 @@ module Vinyl
     return highest_level
   end
 
+  def self.access_level_with_no_validators
+    return Vinyl.config.force_access_control ? 0 : 1
+  end
+
   class Configuration
 
     attr_accessor :api_acl_mode, :force_access_control, :warn_on_missing_validators

data/lib/vinyl/rule.rb

@@ -37,11 +37,14 @@ module Vinyl
         puts e.backtrace
       end
       pattern = generate_pattern(route)
-      @@acl_routes_collection[pattern] ||= Hash.new
-      @@acl_routes_collection[pattern][method] ||= Hash.new
-      @@acl_routes_collection[pattern][method][access_level] = validators
+      @@acl_routes_collection[method] ||= RegExpHash.new
+      @@acl_routes_collection[method][pattern] ||= Hash.new
+      @@acl_routes_collection[method][pattern][access_level] = validators
     end
 
+    #The ideas for this method were extracted from Sinatra's source
+    #https://github.com/sinatra/sinatra/blob/master/lib/sinatra/base.rb
+    #Copyright (c) 2007, 2008, 2009, 2010, 2011 Blake Mizerany
     def self.generate_pattern(path)
       if path.respond_to? :to_str
         ignore = ""
@@ -85,4 +88,4 @@ module Vinyl
   end
 
   class InvalidAclRule < StandardError; end
-end
+end

data/lib/vinyl/version.rb

@@ -1,4 +1,4 @@
 module Vinyl
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end
   

data/tests/rules_spec.rb

@@ -16,17 +16,17 @@ describe Vinyl::Rule do
     Vinyl::when_route 'test', :with_method => 'POST', :get_access_level => 3, 
       :if_pass => []
     
-    Vinyl.acl_routes_collection['test'].should_not be_empty  
+    Vinyl.acl_routes_collection['POST'].should_not be_empty  
     Vinyl.acl_routes_collection.length.should == 1
-    Vinyl.acl_routes_collection['test'].should include("POST")
-    Vinyl.acl_routes_collection['test']['POST'].length.should == 3
+    Vinyl.acl_routes_collection['POST']['test'].should be_instance_of(Hash)
+    Vinyl.acl_routes_collection['POST']['test'].length.should == 3
   end
 
   it "should add a route with a non-existent validator" do
     Vinyl::when_route 'test', :with_method => 'GET', :get_access_level => 1, 
       :if_pass => ['fake_validator']
-    Vinyl.acl_routes_collection['test'].should include("GET")
-    Vinyl.acl_routes_collection['test']['GET'].length.should == 1
+    Vinyl.acl_routes_collection['GET']['test'].should be_instance_of(Hash)
+    Vinyl.acl_routes_collection['GET']['test'].length.should == 1
     Vinyl.execute('fake_validator').should be_false
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vinyl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2012-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec