acts_as_authoritah 1.0.5 → 2.0.0

data/.gitignore

@@ -1,5 +1,17 @@
-*.sw?
-.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
 coverage
-rdoc
+doc/
+lib/bundler/man
 pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_authoritah.gemspec
+gemspec
+gem 'spreadsheet'
+

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2009 Unnikrishnan KP
+Copyright (c) 2012 Unnikrishnan KP
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# ActsAsAuthoritah
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_authoritah'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_authoritah
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,56 +1,2 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "acts_as_authoritah"
-    gem.summary = %Q{role based access rights for a user specified via spreadsheet}
-    gem.description = %Q{TODO: longer description of your gem}
-    gem.email = "unni@bangthetable.com"
-    gem.homepage = "https://github.com/bangthetable/acts_as_authoritah/"
-    gem.authors = ["Unnikrishnan KP"]
-    gem.add_development_dependency "thoughtbot-shoulda"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "acts_as_authoritah #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/acts_as_authoritah.gemspec

@@ -1,48 +1,19 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/acts_as_authoritah/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = %q{acts_as_authoritah}
-  s.version = "1.0.5"
+Gem::Specification.new do |gem|
+  gem.authors       = ["Unnikrishnan KP"]
+  gem.email         = ["unni.tallman@gmail.com"]
+  gem.description   = %q{Define user capabilities in your app}
+  gem.summary       = %q{Define user capabilities in your app}
+  gem.homepage      = ""
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["BangTheTable","Unnikrishnan KP"]
-  s.date = %q{2010-08-10}
-  s.description = %q{role based access rights for a user specified via spreadsheet}
-  s.email = %q{devteam@bangthetable.com, unni.tallman@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "acts_as_authoritah.gemspec",
-     "lib/acts_as_authoritah.rb",
-     "lib/loader.rb",
-     "lib/handler.rb",
-     "lib/access_rights.rb",
-     "lib/access_control.rb",
-     "lib/custom_exceptions.rb",
-     "test/acts_as_authoritah_test.rb",
-     "test/test_helper.rb"
-  ]
-  s.homepage = %q{https://github.com/bangthetable/acts_as_authoritah/}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{role based access rights for a user specified via spreadsheet}
-  s.test_files = [
-    "test/acts_as_authoritah_test.rb",
-     "test/test_helper.rb"
-  ]
-
-  s.add_dependency(%q<spreadsheet>, [">= 0"])
-      
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "acts_as_authoritah"
+  gem.require_paths = ["lib"]
+  gem.version       = ActsAsAuthoritah::VERSION
 end

data/lib/acts_as_authoritah.rb

@@ -1,22 +1,21 @@
-require "active_record"
-require "active_support"
-require "spreadsheet"
+require "acts_as_authoritah/version"
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+module ActsAsAuthoritah
+  module Matchers
+  end
+end
 
-require "loader"
-require "handler"
-require "access_rights"
-require "access_control"
-require "custom_exceptions"
+require "acts_as_authoritah/core"
 
-$LOAD_PATH.shift
+require "acts_as_authoritah/access_rule"
+require "acts_as_authoritah/access_control_list"
+require "acts_as_authoritah/identifier_parser"
 
+require 'spreadsheet'
 Spreadsheet.client_encoding = 'UTF-8'
 
-
-if defined?(ActiveRecord::Base)
-  ActiveRecord::Base.extend ActsAsAuthoritah::Loader
-  ActiveRecord::Base.send :include, ActsAsAuthoritah::Handler
-end
-
+require "acts_as_authoritah/spreadsheets/access_rights_mapper"
+require "acts_as_authoritah/spreadsheets/spreadsheet_wrapper"
+require "acts_as_authoritah/spreadsheets/spreadsheet_reader"
+require "acts_as_authoritah/spreadsheets/spreadsheet_header_parser"
+require "acts_as_authoritah/spreadsheets/spreadsheet_row_parser"

data/lib/acts_as_authoritah/access_control_list.rb

@@ -0,0 +1,32 @@
+require "acts_as_authoritah/matchers/direct_matcher.rb"
+require "acts_as_authoritah/matchers/controller_matcher.rb"
+require "acts_as_authoritah/matchers/scope_matcher.rb"
+
+
+class ActsAsAuthoritah::AccessControlList
+  include ActsAsAuthoritah::Matchers
+  
+  attr_reader :store
+  
+  def initialize(access_rules)
+    @store = {}
+    access_rules.each do |access_rule|
+      @store.merge! access_rule.to_rule
+    end
+    
+    @matchers = [DirectMatcher, ControllerMatcher, ScopeMatcher]
+  end
+  
+  def match(identifier)
+    @matchers.each do |matcher|
+      access_rights = matcher.new(@store).match(identifier)
+      return access_rights unless access_rights.nil?
+    end
+    nil
+  end
+  
+  def match_identifier(identifier)
+    match(identifier) || {}
+  end
+  
+end

data/lib/acts_as_authoritah/access_rule.rb

@@ -0,0 +1,31 @@
+class ActsAsAuthoritah::AccessRule
+  attr_reader :scope, :controller, :action, :access_rights
+  
+  def initialize(scope, controller, action, access_rights)
+    @scope = scope
+    @controller = controller
+    @action = action
+    @access_rights = access_rights
+  end
+  
+  def action?
+    @action && @action != ""
+  end
+  
+  def controller?
+    @controller && @controller != ""
+  end
+  
+  def scope?
+    @scope && @scope != ""
+  end
+  
+  def to_rule
+    key = []
+    key << @scope if scope?
+    key << "#{@controller}Controller" if controller?
+    key = key.join('::')
+    key += "##{action}" if action?
+    { key => access_rights }
+  end
+end

data/lib/acts_as_authoritah/core.rb

@@ -0,0 +1,37 @@
+module ActsAsAuthoritah
+  module Core
+     def self.included(base)
+       base.send :include, ActsAsAuthoritah::Core::InstanceMethods
+       base.extend ActsAsAuthoritah::Core::ClassMethods
+     end
+  end
+end
+
+
+module ActsAsAuthoritah
+  module Core
+     module InstanceMethods
+       def can?(identifier, options={})
+         klass = self.class
+         klass.send(:default_acl).match_identifier(identifier)[self.usertype(options)] ||= klass.send(:whitelist)
+       end
+     end
+     
+     module ClassMethods
+       def acts_as_authoritah(path, options={})
+         rules = ActsAsAuthoritah::SpreadsheetWrapper.new(path).to_access_rules
+         @@whitelist = options[:whitelist] ||= false
+         @@default_acl = ActsAsAuthoritah::AccessControlList.new(rules)
+       end
+       
+       def default_acl
+         @@default_acl ||= ActsAsAuthoritah::AccessControlList.new(rules)
+       end
+       
+       def whitelist
+         !@@whitelist
+       end
+     end
+  end
+end
+

data/lib/acts_as_authoritah/identifier_parser.rb

@@ -0,0 +1,28 @@
+class ActsAsAuthoritah::IdentifierParser
+  attr_reader :action, :controller, :scopes
+  
+  def initialize(identifier)
+    @identifier    = identifier
+  end
+  
+  def action
+    return nil if @identifier.nil?
+    return nil unless @identifier.include?("#")
+    return nil if @identifier.split('').last == '#'
+    @identifier.split("#").last
+  end
+  
+  def controller
+    return nil if @identifier.nil?
+    return nil if @identifier == ""
+    return @identifier.split('#').first
+  end
+  
+  def scopes
+    return [] if @identifier.nil?
+    return [] if @identifier == ""
+    arr = @identifier.split('::')
+    arr.length > 1 ? arr[0..-2] : []
+  end
+  
+end

data/lib/acts_as_authoritah/matchers/controller_matcher.rb

@@ -0,0 +1,10 @@
+class ActsAsAuthoritah::Matchers::ControllerMatcher 
+  def initialize(store)
+    @store = store
+  end
+  
+  def match(identifier)
+    controller = ActsAsAuthoritah::IdentifierParser.new(identifier).controller
+    @store[controller]
+  end
+end

data/lib/acts_as_authoritah/matchers/direct_matcher.rb

@@ -0,0 +1,9 @@
+class ActsAsAuthoritah::Matchers::DirectMatcher
+  def initialize(store)
+    @store = store
+  end  
+
+  def match(identifier)
+    @store[identifier]
+  end
+end

data/lib/acts_as_authoritah/matchers/scope_matcher.rb

@@ -0,0 +1,15 @@
+class ActsAsAuthoritah::Matchers::ScopeMatcher 
+  def initialize(store)
+    @store = store
+  end
+  
+  def match(identifier)
+    scopes = ActsAsAuthoritah::IdentifierParser.new(identifier).scopes
+    scopes.length.times do |i|
+      key = scopes[0..scopes.length-(i+1)].join("::")
+      val = @store[key]
+      return val if val
+    end
+    nil
+  end
+end

data/lib/acts_as_authoritah/spreadsheets/access_rights_mapper.rb

@@ -0,0 +1,14 @@
+class ActsAsAuthoritah::AccessRightsMapper
+  def initialize(roles, access_rights)
+    @roles = roles
+    @access_rights = access_rights
+  end
+  
+  def map
+    h = {}
+    @roles.each_with_index do |role, i|
+      h[role] = @access_rights[i]
+    end
+    h
+  end
+end

data/lib/acts_as_authoritah/spreadsheets/spreadsheet_header_parser.rb

@@ -0,0 +1,9 @@
+class ActsAsAuthoritah::SpreadsheetHeaderParser
+  def initialize(header_row)
+    @header_row = header_row
+  end
+  
+  def roles
+    @header_row[4..-1]
+  end
+end

data/lib/acts_as_authoritah/spreadsheets/spreadsheet_reader.rb

@@ -0,0 +1,37 @@
+class ActsAsAuthoritah::SpreadsheetReader
+  def initialize(path)
+    if File.exists?(path)
+      @book  = Spreadsheet.open path
+      @sheet = @book.worksheets.first
+    else
+      @error = "File not found"
+    end
+  end
+  
+  def valid?
+    @error.nil?
+  end
+  
+  def valid_rows
+    i = 0
+    rows = []
+    @sheet.each{|row|
+      i = i + 1
+      next if i == 1
+      row = row.to_a
+      rows << row unless row.compact.empty?
+    }
+    rows
+  end
+  
+  def header
+    i = 0
+    rows = []
+    @sheet.each{|row|
+      i = i + 1
+      break if i > 1
+      rows << row.to_a
+    }
+    rows.first
+  end
+end