easy_roles 0.1.0

data/Manifest

@@ -0,0 +1,5 @@
+Manifest
+README.rdoc
+Rakefile
+init.rb
+lib/easy_roles.rb

data/README.rdoc

@@ -0,0 +1,120 @@
+= Easy Roles
+
+Simple rails gem for basic role authorization with ruby on rails.
+
+== Install
+
+  gem install platform45-easy_roles --source http://gems.github.com
+  
+  or it can be installed as a rails plugin.
+  
+== Basic Setup
+
+Add the following to your enviroment.rb in the rails initializer block
+
+  config.gem 'platform45-easy_roles', :lib => 'easy_roles', :source => 'http://gems.github.com'
+
+Firstly you need to add a "roles" column to your users model, and set the default value to "--- []". Please note you can call this column anything you like, I like to use the name "roles".
+
+  t.string :roles, :default => "--- []"
+  
+Then you need to add "easy_roles :column_name" to your model.
+
+  class User < ActiveRecord::Base
+    easy_roles :roles
+  end
+  
+And thats it.
+
+== Usage
+
+Easy roles extends your model, and adds a few methods needed for basic role authorization.
+
+adding a role to a user
+  add_role 'role'
+  
+removing a role from a user
+  remove_role 'role'
+  
+check to see if a user has a certain role
+  has_role? 'role'
+  # or
+  is_role? # role being anything you like, for example 'is_admin?' or 'is_awesome?'
+  
+== Examples
+
+  @user = User.first
+  
+  @user.add_role 'admin'
+  
+  @user.is_admin?
+  => true
+  
+  @user.has_role? 'admin'
+  => true
+  
+  @user.is_awesome?
+  => false
+  
+  @user.add_role 'awesome'
+  
+  @user.is_awesome?
+  => true
+  
+  @user.remove_role 'admin'
+  
+  @user.is_admin?
+  => false
+  
+  etc etc
+
+== Protecting controllers
+
+There are many ways to implement views for specific roles, so I did not specifically supply one. Here's an example on what you could do:
+
+  class ApplicationController < ActionController::Base
+
+     def admin_required
+       unless current_user && current_user.is_admin?
+         flash[:error] = "Sorry, you don't have access to that."
+         redirect_to root_url and return false
+       end
+     end
+   
+  end
+
+Then in your AdminsController or any controller that you only want admins to view:
+
+  class AdminsController < ApplicationController
+     before_filter :admin_required
+  end
+  
+  class MarksController < ApplicationController
+     before_filter :admin_required, :only => :create, :update
+  end
+  
+check out http://blog.platform45.com/2009/10/06/howto-basic-roles-for-users for implementation!
+
+
+== License
+
+Copyright (c) 2009 Platform45
+
+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/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('easy_roles', '0.1.0') do |p|
+  p.description    = "Easy role authorization in rails"
+  p.url            = "http://github.com/platform45/easy_roles"
+  p.author         = "Platform45"
+  p.email          = "ryan@platform45.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/easy_roles.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easy_roles}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Platform45"]
+  s.date = %q{2009-10-07}
+  s.description = %q{Easy role authorization in rails}
+  s.email = %q{ryan@platform45.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/easy_roles.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "init.rb", "lib/easy_roles.rb", "easy_roles.gemspec"]
+  s.homepage = %q{http://github.com/platform45/easy_roles}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Easy_roles", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{easy_roles}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Easy role authorization in rails}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

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

data/lib/easy_roles.rb

@@ -0,0 +1,56 @@
+module EasyRoles
+  def self.included(base)
+    base.extend ClassMethods
+    
+    base.send :alias_method_chain, :method_missing, :roles
+  end
+  
+  module ClassMethods
+    def easy_roles(name)
+      serialize name.to_sym, Array
+      before_validation_on_create :make_default_roles
+      
+      class_eval <<-EOC
+        def has_role?(role)
+          #{name}.include?(role)
+        end
+
+        def add_role(role)
+          self.#{name} << role
+        end
+
+        def remove_role(role)
+          self.#{name}.delete(role)
+        end
+        
+        def clear_roles
+          self.#{name} = []
+        end
+        
+        def make_default_roles
+          clear_roles if roles.nil?
+        end
+        
+        private :make_default_roles
+      EOC
+    end
+  end
+  
+  def method_missing_with_roles(method_id, *args, &block)
+    match = method_id.to_s.match(/^is_(\w+)[?]$/)
+    if match && respond_to?('has_role?')
+      class_eval <<-EOC
+        def is_#{match[1]}?
+          send :has_role?, '#{match[1]}'
+        end
+      EOC
+      send "is_#{match[1]}?"
+    else
+      method_missing_without_roles(method_id, *args, &block)
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include EasyRoles
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: easy_roles
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Platform45
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-07 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Easy role authorization in rails
+email: ryan@platform45.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/easy_roles.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/easy_roles.rb
+- easy_roles.gemspec
+has_rdoc: true
+homepage: http://github.com/platform45/easy_roles
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Easy_roles
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: easy_roles
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Easy role authorization in rails
+test_files: []
+