darkhelmet-role_on 0.1.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,21 @@
+The MIT License
+
+Copyright (c) 2009 Daniel Huckstep
+
+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.md

@@ -0,0 +1,59 @@
+# role_on
+
+Really Simple Roles
+
+# Assumptions
+
+I assume you have a model called User for your user authentication stuff.
+
+# Usage
+
+    config.gem 'darkhelmet-role_on', :lib => 'role_on', :source => 'http://gems.github.com'
+
+Add
+
+    def store_location
+      session[:return_to] = request.request_uri
+    end
+
+    def redirect_back_or_default(default)
+      redirect_to(session[:return_to] || default)
+      session[:return_to] = nil
+    end
+
+    def access_denied
+      flash[:error] = 'You are not authorized to perform this action'
+      redirect_back_or_default '/'
+    end
+
+Or similar to you application controller, and setup store_location as an after_fitler, and all of them as helper methods
+
+    after_filter :store_location
+    helper_method :store_location, :redirect_back_or_default, :access_denied
+
+Include RoleOn in your application controller and User model
+
+    include RoleOn
+
+Generate model and migration
+
+    ./script/generate role_on
+
+Migrate
+
+    rake db:migrate
+
+Do your own thing for managing roles.
+
+Start locking down your controllers
+
+    role_on(:admin, :on => [:new,:create,:destroy])
+    role_on(:regular, :on => [:edit,:update])
+
+Can also use except
+
+    role_on(:admin, :except => [:index,:show])
+
+# License
+
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "role_on"
+    gem.summary = %Q{Really simple roles}
+    gem.email = "darkhelmet@darkhelmetlive.com"
+    gem.homepage = "http://github.com/darkhelmet/role_on"
+    gem.authors = ["Daniel Huckstep"]
+    # 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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "role_on #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/generators/role_on/role_on_generator.rb

@@ -0,0 +1,8 @@
+class RoleOnGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.template 'app/models/role.rb', 'app/models/role.rb'
+      m.migration_template 'db/migrate/migration.rb', 'db/migrate', :migration_file_name => 'setup_role_on'
+    end
+  end
+end

data/generators/role_on/templates/app/models/role.rb

@@ -0,0 +1,7 @@
+class Role < ActiveRecord::Base
+  has_and_belongs_to_many :users, :join_table => 'user_roles'
+
+  def self.[](role)
+    first(:conditions => ['name = ?', role.to_s ])
+  end
+end

data/generators/role_on/templates/db/migrate/migration.rb

@@ -0,0 +1,21 @@
+class SetupRoleOn < ActiveRecord::Migration
+  def self.up
+    create_table :roles, :force => true do |t|
+      t.string :name
+      t.timestamps
+    end
+
+    add_index :roles, ['name'], :name => 'index_roles_on_name'
+
+    create_table :user_roles, :id => false, :force => true do |t|
+      t.integer :role_id, :user_id
+    end
+
+    r = Role.create(:name => 'admin')
+  end
+
+  def self.down
+    drop_table :roles
+    drop_table :roles_users
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'role_on'

data/lib/role_on.rb

@@ -0,0 +1,38 @@
+module RoleOn
+  module RoleOnControllerMethods
+    def role_on(role, options = {})
+      before_filter do |c|
+        action = c.params[:action].intern
+        user_roles = c.current_user.roles.map(&:name).map(&:intern)
+        restricted_actions = if options.include?(:on)
+                               [options[:on]].flatten
+                             elsif options.include?(:except)
+                               c.class.action_methods.to_a.map(&:intern) - [options[:except]].flatten
+                             else
+                               c.class.action_methods.to_a.map(&:intern)
+                             end
+        if restricted_actions.include?(action) && !user_roles.include?(role)
+          c.send(:access_denied)
+          false
+        end
+        true
+      end
+    end
+  end
+
+  module RoleOnUserMethods
+    def has_role?(role)
+      return false if roles.nil?
+      roles.include?(Role[role])
+    end
+  end
+
+  def self.included(klass)
+    if User == klass
+      klass.send(:extend, RoleOnUserMethods)
+      klass.send(:has_and_belongs_to_many, :roles, :join_table => 'user_roles')
+    elsif ApplicationController == klass
+      klass.send(:extend, RoleOnControllerMethods)
+    end
+  end
+end

data/test/role_on_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class RoleOnTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'role_on'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: darkhelmet-role_on
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Daniel Huckstep
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: darkhelmet@darkhelmetlive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- generators/role_on/role_on_generator.rb
+- generators/role_on/templates/app/models/role.rb
+- generators/role_on/templates/db/migrate/migration.rb
+- init.rb
+- lib/role_on.rb
+- test/role_on_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/darkhelmet/role_on
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Really simple roles
+test_files: 
+- test/test_helper.rb
+- test/role_on_test.rb