radiant-rbac_base-extension 1.3.0

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+---
+en:
+  rbac base: Rbac Base

data/config/routes.rb

@@ -0,0 +1,8 @@
+ActionController::Routing::Routes.draw do |map|
+  map.namespace :admin do |admin|
+    admin.resources :roles#, :member => {:users => :get, :remove_user => :delete, :add_user => :post}
+    admin.role_user '/roles/:role_id/users/:id', :controller => 'roles', :action => 'remove_user', :conditions => {:method => :delete}
+    admin.role_user '/roles/:role_id/users/:id', :controller => 'roles', :action => 'add_user', :conditions => {:method => :post}
+    admin.role_users '/roles/:role_id/users', :controller => 'roles', :action => 'users', :conditions => {:method => :get}
+  end
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/db/migrate/001_create_roles.rb

@@ -0,0 +1,11 @@
+class CreateRoles < ActiveRecord::Migration
+  def self.up
+    create_table :roles do |t|
+      t.column :role_name, :string, :limit => 64, :default => "New Role"
+    end
+  end
+
+  def self.down
+    drop_table :roles
+  end
+end

data/db/migrate/002_create_role_users.rb

@@ -0,0 +1,16 @@
+class CreateRoleUsers < ActiveRecord::Migration
+  def self.up
+    create_table :roles_users, :id => false do |t|
+      t.column :role_id, :integer, :null => false
+      t.column :user_id, :integer, :null => false
+    end
+    add_index :roles_users, :role_id
+    add_index :roles_users, :user_id
+  end
+
+  def self.down
+    remove_index :roles_users, :user_id
+    remove_index :roles_users, :role_id
+    drop_table :roles_users
+  end
+end

data/db/migrate/003_setup_standard_roles.rb

@@ -0,0 +1,29 @@
+class SetupStandardRoles < ActiveRecord::Migration
+  def self.up
+    User.send :has_and_belongs_to_many, :roles
+    self.setup_admins
+    self.setup_designers
+  end
+  def self.down
+    say("Removing all Roles.")
+    Role.find(:all, :conditions => ["role_name = ? OR role_name = ?",'Admin','Designer']).map(&:destroy)
+  end
+  
+  def self.setup_admins
+    admin_users = User.find_all_by_admin(true)
+    admin_role = Role.create!(:role_name => 'Admin')
+    admin_users.each do |user|
+      say("Adding #{user.login} to the #{admin_role.role_name} role.")
+      user.roles << admin_role
+    end
+  end
+  
+  def self.setup_designers
+    designer_users = User.find_all_by_designer(true)
+    designer_role = Role.create!(:role_name => 'Designer')
+    designer_users.each do |user|
+      say("Adding #{user.name} to the #{designer_role.role_name} role.")
+      user.roles << designer_role
+    end
+  end
+end

data/db/migrate/004_alter_roles.rb

@@ -0,0 +1,10 @@
+class AlterRoles < ActiveRecord::Migration
+  def self.up
+    add_column :roles, :description, :string
+    add_column :roles, :allow_empty, :boolean, :default => true
+  end
+  def self.down
+    remove_column :roles, :allow_empty
+    remove_column :roles, :description
+  end
+end

data/db/migrate/005_add_standard_role_details.rb

@@ -0,0 +1,20 @@
+class AddStandardRoleDetails < ActiveRecord::Migration
+  def self.up
+    Role.find(:all).each do |role|
+      if role.role_name == 'Admin'
+        say("Adding Admin description.")
+        role.update_attributes({:allow_empty => false,
+          :description => %{Users in the Admin role, by default, have access to all features of the system.}})
+      elsif role.role_name == 'Designer'
+        say("Adding Designer description.")
+        role.update_attributes({:allow_empty => true,
+          :description => %{Users in the Designer role, by default, have access to all features of the system except user management.}})
+      else
+        role.update_attribute(:allow_empty, true)
+      end
+    end
+  end
+  def self.down
+    # no need
+  end
+end

data/db/migrate/006_add_user_info.rb

@@ -0,0 +1,10 @@
+class AddUserInfo < ActiveRecord::Migration
+  def self.up
+    add_column :roles, :created_by_id, :integer
+    add_column :roles, :updated_by_id, :integer
+  end
+  def self.down
+    remove_column :roles, :updated_by_id
+    remove_column :roles, :created_by_id    
+  end
+end

data/db/migrate/20100705182511_rename_role_developer_to_designer.rb

@@ -0,0 +1,13 @@
+class RenameRoleDeveloperToDesigner < ActiveRecord::Migration
+  def self.up
+    if role = Role.find_by_role_name('Developer')
+      role.update_attribute(:role_name, 'Designer')
+    end
+  end
+
+  def self.down
+    if role = Role.find_by_role_name('Designer')
+      role.update_attribute(:role_name, 'Developer')
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step}
+ 
+Cucumber::Rails::World.class_eval do
+  include Dataset
+  datasets_directory "#{RADIANT_ROOT}/spec/datasets"
+  Dataset::Resolver.default = Dataset::DirectoryResolver.new("#{RADIANT_ROOT}/spec/datasets", File.dirname(__FILE__) + '/../../spec/datasets', File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  # dataset :rbac_base
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+def path_to(page_name)
+  case page_name
+  
+  when /the homepage/i
+    root_path
+  
+  when /login/i
+    login_path
+  # Add more page name => path mappings here
+  
+  else
+    raise "Can't find mapping from \"#{page_name}\" to a path."
+  end
+end

data/lib/rbac_support.rb

@@ -0,0 +1,19 @@
+module RbacSupport
+  
+  all_roles = Role.find(:all)
+  
+  all_roles.each do | possible_role |
+    define_method("#{possible_role.role_name.underscore}?") do 
+      if @my_roles == nil
+        @my_roles = Hash.new
+        roles.each do | role |
+          @my_roles["#{role.role_name.underscore}"] = true
+        end
+      end
+      if Radiant::Config['roles.admin.sees_everything'] == 'true' && possible_role.role_name.downcase != 'admin'
+        return true if admin?
+      end
+      @my_roles["#{possible_role.role_name.underscore}"] #|| self[:admin] == true
+    end
+  end
+end

data/lib/tasks/rbac_base_extension_tasks.rake

@@ -0,0 +1,55 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :rbac_base do
+      
+      desc "Runs the migration of the Rbac Base extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          RbacBaseExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          RbacBaseExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Copies public assets of the Rbac Base to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from RbacBaseExtension"
+        Dir[RbacBaseExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(RbacBaseExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless RbacBaseExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from RbacBaseExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join RbacBaseExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        end
+      end  
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = RbacBaseExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end

data/public/javascripts/rbac/admin/role_details.js

@@ -0,0 +1,162 @@
+function RoleManager() {
+	var role_id = "";
+	var available = null;
+	var taken = null;
+	var drag_refs = new Object();
+}
+
+var spinners = {
+	show: function(){
+		$('busy_taken', 'busy_available').invoke('show');
+	},
+	hide: function(){
+		$('busy_taken', 'busy_available').invoke('hide');
+	}
+}
+
+RoleManager.prototype.updateDraggables = function() {
+	try {
+		if(this.drag_refs == undefined || this.drag_refs == NULL) {
+			this.drag_refs = new Object();
+		}
+		
+		this.available.each(function(e) { 
+			var my_draggable = new Draggable("user_" + e[0], {constraint: 'vertical', revert: true} ); 
+			manager.drag_refs["user_" + e[0]] = my_draggable;
+		});
+		this.taken.each(function(e) {
+			var my_draggable = new Draggable("user_" + e[0], {constraint: 'vertical', revert: true} );
+			manager.drag_refs["user_" + e[0]] = my_draggable;
+		});
+	} catch(e) {
+		alert("An exception occured while making the users draggable: " + e.description);
+	}
+}
+
+RoleManager.prototype.updateData = function(data) {
+	data.available.each(function(e) { 
+		new Insertion.Bottom('available_users', "<li class='user' id='user_" + e[0] + "' value='" + e[0] + "'>" + e[1] + "</li>"); 
+	});
+	
+	data.taken.each(function(e) {
+		new Insertion.Bottom('taken_users', "<li class='user' id='user_" + e[0] + "' value='" + e[0] + "'>" + e[1] + "</li>");
+	});
+	
+	this.available = data.available;
+	this.taken = data.taken;
+}
+
+RoleManager.prototype.addUser = function(element) {
+  user_id = element.readAttribute("value");
+	new Ajax.Request("/admin/roles/"+role_id+"/users/"+user_id, {
+	  method: 'post',
+		onCreate: function(){
+			spinners.show();
+		},
+		onSuccess: function(transport) {
+			var response = transport.responseText.evalJSON();
+			var _id = "user_" + response.user_id;
+			if(response.status == "Ok") {
+				var element = $(_id)
+				var _value = response.user_id
+				var _text = element.innerHTML;
+				
+				element.toggle();
+				manager.drag_refs[_id].destroy();
+				element.remove();
+				new Insertion.Bottom('taken_users', "<li class='user' id='" + _id + 
+					"' value='" + _value + "'>" + _text + "</li>");
+				manager.drag_refs[_id] = new Draggable(_id);
+			} else {
+				alert("There was a problem adding the user to this role.");
+				manager.drag_refs[_id].destroy();
+				manager.drag_refs[_id] = new Draggable(_id);
+			}
+			spinners.hide();
+		},
+		onFailure: function(transport) {
+			alert("There was a problem adding the user to this role.");
+			spinners.hide();
+		}
+	});
+}
+
+RoleManager.prototype.removeUser = function(element) {
+  user_id = element.readAttribute("value");
+	new Ajax.Request("/admin/roles/"+role_id+"/users/"+user_id, {
+	  method: 'delete',
+		onCreate: function() {
+			spinners.show();
+		},
+		onSuccess: function(transport) {
+			var response = transport.responseText.evalJSON();
+			var _id = "user_" + response.user_id;
+			if(response.status == "Ok") {
+				var element = $(_id)
+				var _value = response.user_id
+				var _text = element.innerHTML;
+				
+				element.toggle();
+				manager.drag_refs[_id].destroy();
+				element.remove();
+				new Insertion.Bottom('available_users', "<li class='user' id='" + _id + 
+					"' value='" + _value + "'>" + _text + "</li>");
+				manager.drag_refs[_id] = new Draggable(_id);
+			} else {
+				alert("There was a problem removing the user from this role.");
+				manager.drag_refs[_id].destroy();
+				manager.drag_refs[_id] = new Draggable(_id);
+			}
+			spinners.hide();
+		},
+		onFailure: function(transport) {
+			alert("There was a problem removing the user from this role.");
+			spinners.hide();
+		}
+	})
+}
+
+RoleManager.prototype.loadData = function(role_id) {
+	new Ajax.Request('/admin/roles/'+role_id+'/users', { 
+	    method: 'get',
+	    contentType: 'application/javascript',
+			onCreate: function(){
+				spinners.show();
+			},
+			onFailure: function(transport) {
+				alert('There was a problem with the script');
+				spinners.hide();
+			},
+			onSuccess: function(transport) {
+			try {
+				var val = transport.responseText.evalJSON();
+				manager.updateData(val);
+				new PeriodicalExecuter(function(pe) { manager.updateDraggables(); pe.stop(); }, 0.1);
+				Droppables.add('available_users', { 
+					accept: "user",
+					hoverclass: "hover",
+					onDrop: function(element) {
+						manager.removeUser(element);
+					} 
+				});
+				Droppables.add('taken_users', {
+					accept: "user",
+					hoverclass: "hover",
+					onDrop: function(element) {
+						manager.addUser(element);
+					}
+				});
+				spinners.hide();
+			} catch(e) {
+				alert("Exception occured in json code: " + e);
+				spinners.hide();
+			}
+		}
+	});
+}
+
+var manager = new RoleManager();
+
+Event.observe(window, 'load', function() {
+	manager.loadData(role_id);
+});

data/public/stylesheets/rbac/rbac.css

@@ -0,0 +1,20 @@
+.UserList {
+	background: #fff;
+	color: #000;
+	list-style: none;
+	margin: 0 0 1em;
+	min-height: 1em;
+	padding: 10px 0;
+}
+	.UserList.hover {
+		background: #efe;
+	}
+	.UserList li {
+		line-height: 1.2em;
+		list-style: none;
+		margin: 0;
+		padding: 2px 2px 2px 25px;
+	}
+	.rbac_busy_marker {
+	  position: absolute;
+	}

data/radiant-rbac_base-extension.gemspec

@@ -0,0 +1,91 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{radiant-rbac_base-extension}
+  s.version = "1.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jim Gay"]
+  s.date = %q{2010-07-05}
+  s.description = %q{Flexible user role management for Radiant.}
+  s.email = %q{jim@saturnflyer.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "HELP_developer.md",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/admin/roles_controller.rb",
+     "app/helpers/admin/alterations_helper.rb",
+     "app/helpers/admin/roles_helper.rb",
+     "app/models/role.rb",
+     "app/models/role_action_observer.rb",
+     "app/models/role_user.rb",
+     "app/views/admin/roles/_add_role_form.html.haml",
+     "app/views/admin/roles/index.html.haml",
+     "app/views/admin/roles/show.html.haml",
+     "app/views/admin/users/preferences.html.haml",
+     "config/locales/en.yml",
+     "config/routes.rb",
+     "cucumber.yml",
+     "db/migrate/001_create_roles.rb",
+     "db/migrate/002_create_role_users.rb",
+     "db/migrate/003_setup_standard_roles.rb",
+     "db/migrate/004_alter_roles.rb",
+     "db/migrate/005_add_standard_role_details.rb",
+     "db/migrate/006_add_user_info.rb",
+     "db/migrate/20100705182511_rename_role_developer_to_designer.rb",
+     "features/support/env.rb",
+     "features/support/paths.rb",
+     "lib/rbac_support.rb",
+     "lib/tasks/rbac_base_extension_tasks.rake",
+     "public/javascripts/rbac/admin/role_details.js",
+     "public/stylesheets/rbac/rbac.css",
+     "radiant-rbac_base-extension.gemspec",
+     "rbac_base_extension.rb",
+     "spec/controllers/admin/roles_controller_spec.rb",
+     "spec/controllers/admin/roles_routing_spec.rb",
+     "spec/helpers/admin/roles_helper_spec.rb",
+     "spec/models/role_spec.rb",
+     "spec/models/user_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/views/admin/roles/index_spec.rb",
+     "spec/views/admin/roles/show_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/saturnflyer/radiant-rbac_base-extension}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{RBAC Base Extension for Radiant CMS}
+  s.test_files = [
+    "spec/controllers/admin/roles_controller_spec.rb",
+     "spec/controllers/admin/roles_routing_spec.rb",
+     "spec/helpers/admin/roles_helper_spec.rb",
+     "spec/models/role_spec.rb",
+     "spec/models/user_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/views/admin/roles/index_spec.rb",
+     "spec/views/admin/roles/show_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<radiant>, [">= 0.9"])
+    else
+      s.add_dependency(%q<radiant>, [">= 0.9"])
+    end
+  else
+    s.add_dependency(%q<radiant>, [">= 0.9"])
+  end
+end
+