acts_as_authoritah 1.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Unnikrishnan KP
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.rdoc

@@ -0,0 +1,25 @@
+= acts_as_authoritah
+
+In config/environment.rb add 
+require 'acts_as_authoritah'
+
+ActsAsAuthoritah::AccessRights::FileNotFound - if acl file is not found in the specified location
+
+include ActsAsAuthoritah in application.rb
+
+one file is mandatory - default.xls, or specify a :default =>
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Bang The Table. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+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

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/acts_as_authoritah.gemspec

@@ -0,0 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_authoritah}
+  s.version = "1.0.1"
+
+  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/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"])
+      
+end

data/lib/access_rights.rb

@@ -0,0 +1,88 @@
+module ActsAsAuthoritah
+  def deny_unauthorized_access
+    if File.exists?("#{Rails.public_path}/401.html") and !request.xhr?
+      render :file => "#{Rails.public_path}/401.html", :status => :unauthorized and return
+    else
+      render :text => "access denied", :status => :unauthorized and return 
+    end
+  end
+  
+  module AccessRights
+    ACL     = Hash.new
+    Default = Hash.new  
+    Urls    = {}
+    
+    def self.feature_list
+      Default.keys.collect(&:downcase)
+    end
+    
+    def self.urls(context)
+      h = {}
+      ACL[context].keys.collect(&:downcase).each do |feature|
+        h[feature] = access_url(feature)
+      end
+      h
+    end
+    
+    def self.access_url(feature)
+      Urls[feature.downcase]
+    end
+        
+    def self.contexts
+      ACL.keys.collect(&:downcase)
+    end
+    
+    def self.load_all_files(dir,default_file="default.xls")
+      Dir.xls_files(dir).each do |file|
+        acl_type = file.split(".").first
+        ACL[acl_type] = load(File.join(dir,file)) 
+      end
+      
+      (ACL[default_file.split(".").first] || {}).each_pair do |key,value|
+        Default[key] = value
+      end
+    end
+    
+    def self.load(file)
+      hash = {}
+      book = Spreadsheet.open file
+      sheet = book.worksheets.first
+      
+      urls_column_index = -1
+      
+      usertypes = []
+      
+      sheet.each do |row|
+        if row[0] == 'name'
+          k = 2
+          while true
+            usertype = row[k]
+            break unless usertype
+            
+            usertypes << usertype unless usertype.downcase == "url"
+            urls_column_index = k if usertype.downcase == "url"
+            
+            k += 1
+          end
+          usertypes = usertypes.collect(&:downcase)
+          next
+        end
+        
+        h = Hash.new
+        feature_name = row[0]
+        
+        next unless feature_name
+        feature_name.strip!
+        
+        Urls[feature_name] = row[urls_column_index] unless urls_column_index == -1
+        
+        usertypes.each_with_index do |key,i|
+          value = (row[i+2] and row[i+2].include?('x')) ? true : false
+          h[key]=value
+        end  
+        hash[feature_name] = h
+      end
+      return hash
+    end
+  end
+end

data/lib/acts_as_authoritah.rb

@@ -0,0 +1,19 @@
+require "active_record"
+require "spreadsheet"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "loader"
+require "handler"
+require "access_rights"
+require "custom_exceptions"
+
+$LOAD_PATH.shift
+
+Spreadsheet.client_encoding = 'UTF-8'
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend ActsAsAuthoritah::Loader
+  ActiveRecord::Base.send :include, ActsAsAuthoritah::Handler
+end
+

data/lib/custom_exceptions.rb

@@ -0,0 +1,8 @@
+module ActsAsAuthoritah
+  module AccessRights
+    class UnknownContext < RuntimeError; end
+    class AclFilesNotFound < RuntimeError; end
+    class AclFolderNotFound < RuntimeError; end
+    class RuleNotDefined < RuntimeError; end
+  end
+end

data/lib/handler.rb

@@ -0,0 +1,38 @@
+module ActsAsAuthoritah
+  module Handler
+    CAN_METHOD  = /^can_(.*)/
+    class_eval do
+      def handle_can_methods(feature_name,args)
+        acl = AccessRights::Default.clone
+        
+        if args.is_a?(Array) and !args.empty? and args.first[:context]
+          context = args.first[:context].to_s
+          raise ActsAsAuthoritah::AccessRights::UnknownContext unless AccessRights::contexts.include?(context)
+          acl.merge! AccessRights::ACL[context]
+        end
+        
+        raise ActsAsAuthoritah::AccessRights::RuleNotDefined unless acl.has_key?(feature_name)
+        
+        args.is_a?(Array) and !args.empty? ? acl[feature_name][usertype(args.first)] : acl[feature_name][usertype]
+      end  
+
+      def method_missing(method_name,*args)
+        r1 = /^can_/
+        method_name = method_name.to_s
+        
+        if method_name =~ CAN_METHOD 
+          method_name.chop! if method_name[-1].chr == "?"
+          handle_can_methods(method_name.gsub(r1,""),args)
+        else 
+          super(method_name.to_sym,*args)
+        end  
+      end  
+      
+      def respond_to?(method)
+        return true if method.to_s =~ CAN_METHOD
+        super
+      end
+      
+    end
+  end
+end

data/lib/loader.rb

@@ -0,0 +1,27 @@
+module ActsAsAuthoritah
+  module Loader
+    
+    def acts_as_authoritah(args={})
+      if File.exists?(args[:acl_folder]) and Dir.has_xls_files?(args[:acl_folder])
+        if args[:default]
+          AccessRights::load_all_files(args[:acl_folder],args[:default])
+        else
+          AccessRights::load_all_files(args[:acl_folder])
+        end
+      elsif !Dir.has_xls_files?(args[:acl_folder])
+        raise ActsAsAuthoritah::AccessRights::AclFilesNotFound
+      else
+        raise ActsAsAuthoritah::AccessRights::AclFolderNotFound
+      end
+    end
+    
+  end
+end
+
+def Dir.xls_files(dir)
+  Dir.entries(dir).reject{|f| File.directory?(f)}.select{|x| x.split(".").last.downcase == "xls"}
+end
+
+def Dir.has_xls_files?(dir)
+  !Dir.xls_files(dir).empty?
+end

data/test/acts_as_authoritah_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class ActsAsAuthoritahTest < Test::Unit::TestCase
+  def test_responds_to_all_can_methods
+    can_methods = ActsAsAuthoritah::AccessRights::feature_list.collect{|feature| 'can_' + feature + '?'}
+    assert_respond_to_all Factory.build(:anonymous_user),can_methods
+  end
+  
+  def test_should_not_respond_to_any_non_existing_methods
+    assert !Factory.build(:anonymous_user).respond_to?(:non_existant_method)
+  end
+  
+  def test_can_methods_should_function_as_per_the_access_rights_specified_in_spead_sheet
+    spreadsheet_hash = ActsAsAuthoritah::AccessRights::Default
+    
+    spreadsheet_hash.each_pair {|feature,hash|
+      can_method = 'can_' + feature + '?'
+      hash.keys.each do |usertype| 
+        assert_equal Factory.build(usertype + '_user').send(can_method),hash[usertype]
+      end
+    }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'test/unit'
+require 'factory_girl'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'activerecord_test_connector' 
+require 'acts_as_authoritah'
+
+ActiveRecordTestConnector.setup
+
+#load users factory
+require 'test/factories/users'
+
+class Test::Unit::TestCase
+  protected
+  def assert_respond_to_all object, methods
+    methods.each do |method|
+      [method.to_s, method.to_sym].each { |m| assert_respond_to object, m }
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_authoritah
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- BangTheTable
+- Unnikrishnan KP
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-10 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: role based access rights for a user specified via spreadsheet
+email: devteam@bangthetable.com, unni.tallman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+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/custom_exceptions.rb
+- test/acts_as_authoritah_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/bangthetable/acts_as_authoritah/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: role based access rights for a user specified via spreadsheet
+test_files: 
+- test/acts_as_authoritah_test.rb
+- test/test_helper.rb