role_based_security 0.5.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Artem Rufanov
+
+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

@@ -0,0 +1,47 @@
+RoleBasedSecurity
+===================
+
+RoleBasedSecurity is a gem that implements role based security for authlogic.
+
+* The gem supports ruby 1.9.x & rails 3.x
+* The gem allows to create role based security for authlogic
+* The gem allows ...
+
+This gem assumes that
+
+* You are using authlogic and application has current_user method
+* The name of the user model is User
+*
+
+Quick Start
+=======
+In your Gemfile:
+
+  gem "role_based_security", ">= 0.5.0"
+
+In your controller:
+
+  require_role "admin"
+
+In your user model:
+
+  has_many :user_roles, :dependent => :destroy
+
+If you wish:
+
+  -Use config/initiaizers to configure options for this gem
+  -Run ruby script/rails generate role_based_security to gen migration, models and etc.
+
+
+Installation
+=======
+
+* Type 'gem install --local role_based_security' with root account if you have installed RubyGems.
+
+
+Example
+=======
+
+Example goes here.
+
+Copyright (c) 2011 arufanov, released under the MIT license.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the role_based_security plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the role_based_security plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RoleBasedSecurity'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/changelog

@@ -0,0 +1,18 @@
+Introduction:
+To see the latest list of the change log please visit the Change Log page at www.majoron.com.
+
+Legend:
+Follow notation is used at change log, roadmap and known bugs. Each bug begins with a version,
+then follow category of the bug inside {}. It can be bug report, feature request and etc.
+Then follow component inside []. After follow bug number at bug tracking system between // signs.
+And then follow a short description of the bug.
+
+Example:
+For example bug: "1.0 { Feature Request } [ AntHill ] / 380 / STLport support required" means
+that bug was created for 1.0 version of the AntHill component, bug is feature request with
+380 number at bug tracking system. And bug requires STLPort support implementation.
+
+ Version 0.5
+ -----------
+0.5 { Bug Report } [ RoleBasedSecurity ] / X / Changelog, roadmap, knownbugs have been created
+0.5 { Bug Report } [ RoleBasedSecurity ] / X / Use include, extend instead of class_eval

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'role_based_security'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/knownbugs

@@ -0,0 +1,17 @@
+Introduction:
+To see the latest list of the known bugs please visit the Known bugs page at www.majoron.com.
+
+Legend:
+Follow notation is used at change log, roadmap and known bugs. Each bug begins with a version,
+then follow category of the bug inside {}. It can be bug report, feature request and etc.
+Then follow component inside []. After follow bug number at bug tracking system between // signs.
+And then follow a short description of the bug.
+
+Example:
+For example bug: "1.0 { Feature Request } [ AntHill ] / 380 / STLport support required" means
+that bug was created for 1.0 version of the AntHill component, bug is feature request with
+380 number at bug tracking system. And bug requires STLPort support implementation.
+
+ Version 0.5
+ -----------
+0.5 { Bug Report } [ AuxiliaryAddons ] / X / There isn't known bugs

data/lib/generators/role_based_security/USAGE

@@ -0,0 +1,4 @@
+Description:
+  The role_based_security generator creates an role and user role models
+  at app/models and roles and user roles migrations and db/migrate.
+

data/lib/generators/role_based_security/role_based_security_generator.rb

@@ -0,0 +1,15 @@
+module RoleBasedSecurity
+  module Generators
+    class RoleBasedSecurityGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_role_based_security
+        copy_file "role.rb", "app/models/role.rb"
+        copy_file "user_role.rb", "app/models/user_role.rb"
+        copy_file "20110510155623_create_roles.rb", "db/migrate/20110510155623_create_roles.rb"
+        copy_file "20110510155626_create_user_roles.rb", "db/migrate/20110510155626_create_user_roles.rb"
+      end
+    end
+  end
+end
+

data/lib/generators/role_based_security/templates/20110510155623_create_roles.rb

@@ -0,0 +1,18 @@
+class CreateRoles < ActiveRecord::Migration
+  def self.up
+    create_table :roles do |t|
+      t.column :name, :string, :limit => 128, :null => false
+      t.column :code, :string, :limit => 128, :null => false
+      t.column :about, :string, :limit => 128, :null => false
+      t.timestamps
+    end
+
+    # Create constraints
+    add_index :roles, :name, :unique
+    add_index :roles, :code, :unique
+  end
+
+  def self.down
+    drop_table :roles
+  end
+end

data/lib/generators/role_based_security/templates/20110510155626_create_user_roles.rb

@@ -0,0 +1,20 @@
+class CreateUserRoles < ActiveRecord::Migration
+  def self.up
+    create_table :user_roles do |t|
+      t.column :user_id, :integer, :null => false
+      t.column :role_id, :integer, :null => false
+      t.timestamps
+    end
+
+    # Add foreign keys
+    add_foreign_key :user_roles, :users, :column => "user_id"
+    add_foreign_key :user_roles, :roles, :column => "role_id"
+
+    # Create indexes
+    add_index :user_roles, [:user_id, :role_id], :unique
+  end
+
+  def self.down
+    drop_table :user_roles
+  end
+end

data/lib/generators/role_based_security/templates/role.rb

@@ -0,0 +1,14 @@
+class Role < ActiveRecord::Base
+  has_many :user_roles, :dependent => :destroy
+
+  validates_presence_of :name
+  validates_presence_of :code
+  validates_presence_of :about
+
+  validates_length_of :name, :within => 1..128
+  validates_length_of :code, :within => 1..128
+  validates_length_of :about, :within => 1..128
+
+  validates_uniqueness_of :name
+  validates_uniqueness_of :code
+end

data/lib/generators/role_based_security/templates/user_role.rb

@@ -0,0 +1,10 @@
+class UserRole < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :role
+
+  validates_presence_of :user_id
+  validates_presence_of :role_id
+
+  #validates_uniqueness_of [:muscle_user_id, :role_id]
+
+end

data/lib/role_based_security/controller_additions.rb

@@ -0,0 +1,80 @@
+#
+module RoleBasedSecurity
+  module ControllerAdditions
+    # ::Rails.logger.error("...")
+
+    # Hook to extend
+    def self.included(klass)
+      klass.send :class_inheritable_array, :role_requirements
+      klass.send :role_requirements=, []
+    end
+
+    module ClassMethods
+      # Add this to the top of your controller to require a role in order to access it.
+      # Example Usage:
+      #
+      #    require_role "contractor"
+      #    require_role "admin", :only => :destroy # don't allow contractors to destroy
+      #    require_role "admin", :only => :update, :unless => "current_<%= users_name %>.authorized_for_listing?(params[:id]) "
+      #
+      # Valid options
+      #
+      #  * :only - Only require the role for the given actions
+      #  * :except - Require the role for everything but
+      #  * :if - a Proc or a string to evaluate.  If it evaluates to true, the role is required.
+      #  * :unless - The inverse of :if
+      #
+      def require_role(roles, options = {})
+        options.assert_valid_keys(:if, :unless,
+          :for, :only,
+          :for_all_except, :except
+        )
+
+        # only declare that before filter once
+        unless (@before_filter_declared||=false)
+          @before_filter_declared=true
+          before_filter :check_roles
+        end
+
+        # convert to an array if it isn't already
+        roles = [roles] unless Array===roles
+
+        options[:only] ||= options[:for] if options[:for]
+        options[:except] ||= options[:for_all_except] if options[:for_all_except]
+
+        # convert any actions into symbols
+        for key in [:only, :except]
+          if options.has_key?(key)
+            options[key] = [options[key]] unless Array === options[key]
+            options[key] = options[key].compact.collect{|v| v.to_sym}
+          end
+        end
+
+        self.role_requirements||=[]
+        self.role_requirements << {:roles => roles, :options => options }
+      end
+    end
+
+    # Before filter to check roles
+    # current_user come from authlogic
+    # self.role_requirements = [{:roles=>["admin"], :options=>{}}]
+    def check_roles
+      return true if self.role_requirements.size() == 0
+      if !current_user.nil?
+        self.role_requirements.each do |role_requirement|
+          role_requirement[:roles].each do |role|
+            return true if current_user.has_role?(role)
+          end
+        end
+      end
+
+      #
+      # Set flash and redurn to main page
+      flash[:warning] = I18n.t ::RoleBasedSecurity.options[:locale_message_key],
+        :default => ::RoleBasedSecurity.options[:invalid_rights_message]
+      redirect_to(::RoleBasedSecurity.options[:home_path])
+      false
+    end
+
+  end
+end

data/lib/role_based_security/model_additions.rb

@@ -0,0 +1,21 @@
+#
+module RoleBasedSecurity
+  module ModelAdditions
+    # ::Rails.logger.error("...")
+
+    #
+    # Parameter role is a string rather than object, for example moderator or admin
+    def has_role?(role)
+      user_roles = UserRole.find :all, :conditions => ["user_id = ? ", self.id]
+      return false if user_roles.nil? || (user_roles.size() == 0)
+      user_roles.each do |user_role|
+        next if user_role.role.code != role
+        return true
+      end
+      false
+    end
+
+
+
+  end
+end

data/lib/role_based_security/view_additions.rb

@@ -0,0 +1,8 @@
+#
+module RoleBasedSecurity
+  module ViewAdditions
+    # ::Rails.logger.error("...")
+
+
+  end
+end

data/lib/role_based_security.rb

@@ -0,0 +1,37 @@
+# Include
+require 'rubygems'
+require 'active_support'
+require 'role_based_security/model_additions'
+require 'role_based_security/controller_additions'
+require 'role_based_security/view_additions'
+
+# = RoleBasedSecurity
+#
+module RoleBasedSecurity
+  # ::Rails.logger.error("...")
+
+  # default options that can be overridden on the global level
+  @@options = {
+      :home_path                => '/welcome',                                                    #
+      :locale_message_key       => 'labels.invalid_rights',                                       #
+      :invalid_rights_message   => 'Sorry, but you don\'t have access rights to visit this URL',  #
+  }
+  mattr_reader :options
+
+
+  def self.enable_activerecord
+    ActiveRecord::Base.send :include, RoleBasedSecurity::ModelAdditions
+  end
+
+  def self.enable_actionpack
+    ActionController::Base.send :include, RoleBasedSecurity::ControllerAdditions
+    ActionController::Base.send :extend, RoleBasedSecurity::ControllerAdditions::ClassMethods
+
+    ActionView::Base.send :include, RoleBasedSecurity::ViewAdditions
+  end
+end
+
+if defined? Rails
+  RoleBasedSecurity.enable_activerecord if defined? ActiveRecord
+  RoleBasedSecurity.enable_actionpack if defined? ActionController
+end

data/roadmap

@@ -0,0 +1,19 @@
+Introduction:
+To see the latest list of the roadmap please visit the Roadmap page at www.majoron.com.
+
+Legend:
+Follow notation is used at change log, roadmap and known bugs. Each bug begins with a version,
+then follow category of the bug inside {}. It can be bug report, feature request and etc.
+Then follow component inside []. After follow bug number at bug tracking system between // signs.
+And then follow a short description of the bug.
+
+Example:
+For example bug: "1.0 { Feature Request } [ AntHill ] / 380 / STLport support required" means
+that bug was created for 1.0 version of the AntHill component, bug is feature request with
+380 number at bug tracking system. And bug requires STLPort support implementation.
+
+ Version 0.5
+ -----------
+0.5 { Feature Request } [ RoleBasedSecurity ] / X / Add tests
+0.5 { Feature Request } [ RoleBasedSecurity ] / X / Add RailsTie
+

data/role_based_security.gemspec

@@ -0,0 +1,17 @@
+require 'date'
+Gem::Specification.new do |s|
+  s.name = %q{role_based_security}
+  s.version = "0.5.0"
+  s.date = Date.today.to_s
+  s.summary = %q{RoleBasedSecurity is a gem that implements role based security for authlogic.}
+  s.description = %q{RoleBasedSecurity is a gem that implements role based security for authlogic.}
+  s.author = %q{Artem Rufanov}
+  s.email = %q{developers@majoron.com}
+  s.homepage = %q{http://www.majoron.com/project/rbundle/role_based_security}
+  s.files = Dir.glob('**/*') - Dir.glob('distrib/**/*') - Dir.glob('lib/api/**/*') - Dir.glob('doc/*.xpr')
+  s.bindir = 'bin'
+  s.executables = Dir.glob('bin/*').collect {|f| File.basename(f)}
+  s.require_paths << 'doc' << 'examples' << 'lib' << 'test'
+  s.has_rdoc = true
+  s.required_ruby_version = '>= 1.8.7'
+end

data/spec/lib/role_based_security/controller_additions_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RoleBasedSecurity::ControllerAdditions do
+  it "should define controller additions" do
+    ::RoleBasedSecurity::ControllerAdditions.should be
+  end
+end

data/spec/lib/role_based_security/model_additions_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RoleBasedSecurity::ModelAdditions do
+  it "should define model additions" do
+    ::RoleBasedSecurity::ModelAdditions.should be
+  end
+end

data/spec/lib/role_based_security/view_additions_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RoleBasedSecurity::ViewAdditions do
+  it "should define view additions" do
+    ::RoleBasedSecurity::ViewAdditions.should be
+  end
+end

data/spec/lib/role_based_security_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RoleBasedSecurity do
+  it "should define rails" do
+    ::Rails::VERSION::MAJOR.should be
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+ENV["RAILS_ENV"] = "test"
+require 'rubygems'
+require 'rspec'
+require 'action_controller'
+require 'role_based_security'
+
+module Rails
+  module VERSION
+    MAJOR = 3
+  end
+end unless defined? Rails
+
+# RoleBasedSecurity.root = './'
+RAILS_ROOT = './' unless defined?(RAILS_ROOT)
+RAILS_ENV = 'test' unless defined?(RAILS_ENV)
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+

data/tasks/role_based_security_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :captcha_validateable do
+#   # Task goes here
+# end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: role_based_security
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Artem Rufanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-16 00:00:00.000000000Z
+dependencies: []
+description: RoleBasedSecurity is a gem that implements role based security for authlogic.
+email: developers@majoron.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- changelog
+- init.rb
+- install.rb
+- knownbugs
+- lib/generators/role_based_security/role_based_security_generator.rb
+- lib/generators/role_based_security/templates/20110510155623_create_roles.rb
+- lib/generators/role_based_security/templates/20110510155626_create_user_roles.rb
+- lib/generators/role_based_security/templates/role.rb
+- lib/generators/role_based_security/templates/user_role.rb
+- lib/generators/role_based_security/USAGE
+- lib/role_based_security/controller_additions.rb
+- lib/role_based_security/model_additions.rb
+- lib/role_based_security/view_additions.rb
+- lib/role_based_security.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- roadmap
+- role_based_security.gemspec
+- spec/lib/role_based_security/controller_additions_spec.rb
+- spec/lib/role_based_security/model_additions_spec.rb
+- spec/lib/role_based_security/view_additions_spec.rb
+- spec/lib/role_based_security_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/role_based_security_tasks.rake
+- uninstall.rb
+homepage: http://www.majoron.com/project/rbundle/role_based_security
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- doc
+- examples
+- lib
+- test
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: RoleBasedSecurity is a gem that implements role based security for authlogic.
+test_files: []