permission_management 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e912d6ff0b7c727c357020187264a8b37050247
+  data.tar.gz: 2031ab7c609389d9b2f2a1adf6f0b2237b2cc5ec
+SHA512:
+  metadata.gz: 8d2acec43907cf1cc0953f1544b0da04e5189909c4b694c265ef574fcb240c7102ddb581701c6c3b6372bccd38e590d29da418aba1e4a373646b64fbd1a78cdb
+  data.tar.gz: 933dd30bd345f9e79601a1e9c96281d61fd61edfb6da1e9226caa2aa2e560c551bd4f42cc8e2455106afe7299275a1e34a62fdfd681a232138df5fef745615cd

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in permission_management.gemspec
+
+gemspec
+
+platforms :ruby do
+  gem "nested_form", git: 'git://github.com/BenZhang/nested_form.git'  
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Zhang
+
+MIT License
+
+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,34 @@
+# PermissionManagement
+
+Permission Management is a Rails engine in order to simpliy permission mangement process. It is built on top of cancan gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'permission_management'
+
+And then execute:
+
+    $ bundle
+
+Then run
+
+    $ bundle exec rails g permission_management:install
+
+To install the relative files.
+
+## Usage
+
+Add the permission management link to your application. You can use this url helper.
+
+    permission_management_engine.permission_management_user_roles_path
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/permission_management/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/javascripts/permission_management/init.js

@@ -0,0 +1,25 @@
+$(function(){
+  PermissionManagement.switchPermissionFields();
+  $('#pm_role_role_type').change(PermissionManagement.switchPermissionFields);
+  $('.user-role-select-tag').change(function(){
+    $.ajax({
+      url: '/permission_management/user_roles/'+$(this).data('id'),
+      type: 'PUT',
+      data: {
+        role_id: $(this).val(), 
+        authenticity_token: $('meta[name=csrf-token]').attr('content')
+      },
+      dataType: 'script'
+    });
+  });
+});
+
+var PermissionManagement = {
+  switchPermissionFields: function(){
+    if($('#pm_role_role_type').val() == 'custom') {
+      $('#permission-fields').show();
+    } else {
+      $('#permission-fields').hide();
+    }
+  }
+}

data/app/controllers/permission_management/base_controller.rb

@@ -0,0 +1,15 @@
+class PermissionManagement::BaseController < ApplicationController
+  send(:before_filter, "authenticate_#{PermissionManagement.user_method}!")
+  before_filter :check_permission
+
+  def pm_current_user
+    instance_eval &PermissionManagement.current_user_method
+  end
+
+  private
+
+  def check_permission
+    raise CanCan::AccessDenied unless pm_current_user.pm_role_role_type == 'super_admin'
+  end
+
+end

data/app/controllers/permission_management/permissions_controller.rb

@@ -0,0 +1,23 @@
+class PermissionManagement::PermissionsController < PermissionManagement::BaseController
+
+  def new
+    
+  end
+
+  def create
+    
+  end
+
+  def edit
+    
+  end
+
+  def update
+    
+  end
+
+  def destroy
+    
+  end
+
+end

data/app/controllers/permission_management/roles_controller.rb

@@ -0,0 +1,39 @@
+class PermissionManagement::RolesController < PermissionManagement::BaseController
+
+  def index
+    @roles = PM::Role.all
+  end
+
+  def new
+    @role = PM::Role.new
+    PermissionManagement.permission_models.each{|model| @role.permissions.build :model_name => model.to_s, :action => :no_access }    
+  end
+
+  def create
+    @role = PM::Role.new params[:pm_role]
+    if @role.save
+      redirect_to permission_management_engine.permission_management_pm_roles_path
+    else
+      render action: :new
+    end
+  end
+
+  def edit
+    @role = PM::Role.find params[:id]
+  end
+
+  def update
+    @role = PM::Role.find params[:id]
+    @role.attributes = params[:pm_role]
+    if @role.save
+      redirect_to permission_management_engine.permission_management_pm_roles_path
+    else
+      render action: :edit
+    end
+  end
+
+  def destroy
+    
+  end
+
+end

data/app/controllers/permission_management/user_roles_controller.rb

@@ -0,0 +1,23 @@
+class PermissionManagement::UserRolesController < PermissionManagement::BaseController
+
+  def index
+    @targets = user_model.page(params[:page]).per(10)
+  end
+
+  def update
+    if pm_current_user.super_admin?
+      @target = user_model.find params[:id]
+      @target.pm_role_id = params[:role_id]
+      @target.save
+    else
+      render :js => 'alert("Sorry you do not have the permission!")'
+    end
+  end
+
+  private
+
+  def user_model
+    PermissionManagement.user_model.constantize 
+  end
+
+end

data/app/views/permission_management/roles/_form.haml

@@ -0,0 +1,17 @@
+= simple_nested_form_for [permission_management_engine, :permission_management, @role], :html => { :autocomplete => 'off' }, :defaults => { :input_html => { class: "form-control" }} do |f|
+  - if @role.errors.any?
+    #error_explanation
+      %h2= "#{pluralize(@role.errors.count, "error")} prohibited this role from being saved:"
+      %ul
+        - @role.errors.full_messages.each do |msg|
+          %li= msg
+  = f.input :name
+  = f.input :role_type, collection: PermissionManagement.role_types, prompt: false
+  #permission-fields
+    = f.simple_fields_for :permissions do |p|
+      .row
+        .col-sm-4= p.input :model_name, label: false
+        .col-sm-4= p.input :action, collection: PermissionManagement.action_types, label: false, prompt: false
+  .form-actions
+    = link_to 'Cancel', permission_management_engine.permission_management_pm_roles_path, class: 'btn btn-link pull-left'
+    = f.submit 'Submit', class: 'btn btn-primary', data: { disable_with: 'Please wait ...' }

data/app/views/permission_management/roles/edit.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/permission_management/roles/index.html.haml

@@ -0,0 +1,21 @@
+%table.table
+  %tr
+    %th Role
+    %th Role Type
+    %th
+  - @roles.each do |role|
+    %tr
+      %td= link_to role.name, permission_management_engine.edit_permission_management_pm_role_path(role), class: 'media'
+      %td= role.role_type
+      %td.actions
+        .btn-group
+          - if role.role_type != 'super_admin'
+            = link_to 'Edit', permission_management_engine.edit_permission_management_pm_role_path(role), class: 'btn btn-default'
+            %button.btn.btn-default.dropdown-toggle{"data-toggle" => "dropdown", type: "button"}
+              = fa_icon 'caret-down'
+              %span.sr-only Toggle Dropdown
+            %ul.dropdown-menu.pull-right
+              %li= link_to 'Delete', permission_management_engine.permission_management_pm_role_path(role), :method => :delete, :data => { :confirm => 'Are you sure?' }
+
+= link_to 'New role', permission_management_engine.new_permission_management_pm_role_path, class: 'btn btn-default'
+= link_to 'Back', permission_management_engine.permission_management_user_roles_path, class: 'btn btn-default'

data/app/views/permission_management/roles/new.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/permission_management/user_roles/index.html.haml

@@ -0,0 +1,14 @@
+%table.table
+  %tr
+    %th ID
+    %th User
+    %th Email
+    %th Permission
+    %th= link_to 'Roles', permission_management_engine.permission_management_pm_roles_path
+  - @targets.each do |target|
+    %tr
+      %td= target.id
+      %td= target
+      %td= target.email
+      %td{:id => "user-role-td-#{target.id}"}= target.pm_role_name
+      %td.actions= select_tag "pm_user_#{target.id}", options_from_collection_for_select(PM::Role.all, 'id', 'name', target.pm_role_id), :class => 'user-role-select-tag', :data => {:id => target.id}

data/app/views/permission_management/user_roles/update.js.erb

@@ -0,0 +1 @@
+$('#user-role-td-<%= @target.id %>').html('<%= @target.pm_role_name %>');

data/config/routes.rb

@@ -0,0 +1,7 @@
+PermissionManagement::Engine.routes.draw do
+  namespace :permission_management do
+    resources :user_roles
+    resources :pm_roles, controller: 'roles'
+    resources :permissions
+  end
+end

data/lib/generators/permission_management/install_generator.rb

@@ -0,0 +1,57 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module PermissionManagement
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_permission_management_migration
+        migration_template 'active_record/role_migration.rb', 'db/migrate/pm_create_roles'
+        copy_file 'active_record/permission.rb', 'app/models/pm/permission.rb'
+        copy_file 'active_record/role.rb', 'app/models/pm/role.rb'
+        if File.exists? File.join(destination_root, 'app', 'models', 'ability.rb')
+          insert_into_file 'app/models/ability.rb', ability_content, :after => 'user ||= User.new', :force => false
+        else
+          copy_file 'ability.rb', 'app/models/ability.rb'
+        end
+        inject_into_file 'config/routes.rb', "\n  mount PermissionManagement::Engine => '/'", { :after => /\.routes\.draw do\s*$/, :force => false }
+        if PermissionManagement.user_model != 'User'
+          insert_into_file 'app/controllers/application_controller.rb', "\n  load_and_authorize_resource\n", :after => 'protect_from_forgery', :force => false
+          current_ability = 
+<<RUBY
+  def current_ability
+    @current_ability ||= Ability.new(current_#{PermissionManagement.user_model.underscore})
+  end
+RUBY
+          insert_into_file 'app/controllers/application_controller.rb', current_ability, :after => 'load_and_authorize_resource', :force => false          
+        end
+      end
+
+      def self.next_migration_number(dirname)
+        Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      def ability_content
+<<RUBY
+
+    case user.pm_role_role_type
+    when 'super_admin'
+      can :manage, :all
+    when 'read_only'
+      can :read, :all
+    when 'no_access'
+
+    when 'custom'
+      user.pm_role.permissions.each do |permission|
+        unless permission.action == 'no_access'
+          can permission.action.to_sym, permission.model_name.constantize
+        end
+      end
+    end
+RUBY
+      end
+    end
+  end
+end

data/lib/generators/permission_management/templates/ability.rb

@@ -0,0 +1,8 @@
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    user ||= User.new
+    <%= ability_content -%>
+  end
+end

data/lib/generators/permission_management/templates/active_record/permission.rb

@@ -0,0 +1,7 @@
+class PM::Permission < ActiveRecord::Base
+  self.table_name = "pm_permissions"
+  
+  attr_accessible :action, :model_name
+
+  belongs_to :role
+end

data/lib/generators/permission_management/templates/active_record/role.rb

@@ -0,0 +1,11 @@
+class PM::Role < ActiveRecord::Base
+  self.table_name = "pm_roles"
+
+  attr_accessible :name, :role_type, :permissions_attributes
+
+  has_many :permissions, foreign_key: :pm_role_id, class_name: 'PM::Permission'
+  accepts_nested_attributes_for :permissions, allow_destroy: true
+
+  validates :role_type, presence: true, inclusion: { in: %w(super_admin read_only no_access custom)}
+  validates :name, presence: true
+end

data/lib/generators/permission_management/templates/active_record/role_migration.rb

@@ -0,0 +1,22 @@
+class PmCreateRoles < ActiveRecord::Migration
+  def change
+    create_table :pm_roles do |t|
+      t.string :name
+      t.string :role_type, limit: 50
+      t.timestamps
+    end
+    PM::Role.create! name: 'Full Access', role_type: 'super_admin'
+    PM::Role.create! name: 'Read Only', role_type: 'read_only'
+    PM::Role.create! name: 'No Access', role_type: 'no_access'
+    add_column :<%= PermissionManagement.user_method.pluralize %>, :pm_role_id, :integer
+    add_index :<%= PermissionManagement.user_method.pluralize %>, :pm_role_id
+
+    create_table :pm_permissions do |t|
+      t.integer :pm_role_id
+      t.string  :action
+      t.string  :model_name
+      t.timestamps
+    end
+    add_index :pm_permissions, :pm_role_id
+  end
+end

data/lib/generators/permission_management/templates/permission_management.rb

@@ -0,0 +1,5 @@
+PermissionManagement.setup do |config|
+  # config.user_model 'User'
+  # config.only_models :all
+  # config.except_models []  
+end

data/lib/permission_management.rb

@@ -0,0 +1,67 @@
+require "permission_management/version"
+require 'permission_management/engine'
+
+module PermissionManagement
+
+  DEFAULT_AUTHORIZE_USER_MODEL = 'User'
+  DEFAULT_USER_METHOD = Proc.new do
+    respond_to?("current_#{PermissionManagement.user_method}".to_sym) && send("current_#{PermissionManagement.user_method}".to_sym)
+  end
+
+  def self.setup
+    yield self
+  end
+
+  def self.user_model(arg = nil)
+    @user_model = arg if arg.present?
+    @user_model || DEFAULT_AUTHORIZE_USER_MODEL
+  end
+
+  def self.user_method
+    user_model.underscore
+  end
+
+  def self.permission_models
+    if only_models == :all
+      ActiveRecord::Base.descendants.select{|ar| !except_models.include?(ar.to_s) }  
+    else
+      ActiveRecord::Base.descendants.select{|ar| (only_models - except_models).include?(ar.to_s) }
+    end    
+  end
+
+  def self.only_models(arg = :all)
+    @only_models ||= arg
+  end
+
+  def self.except_models(arg = [])
+    return @except_models if @except_models
+    @except_models = arg + ['PM::Role', 'PM::Permission']
+    @except_models
+  end
+
+  def self.role_types
+    [['Full Access', :super_admin], ['Read Only', :read_only], ['No Access', :no_access], ['Custom', :custom]]
+  end
+
+  def self.action_types
+    [['No Access', :no_access], ['Admin (View, Create, Edit, Delete)', :manage], ['Observer (View Only)', :read]]
+  end
+
+  def self.current_user_method
+    DEFAULT_USER_METHOD
+  end
+
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :pm_role, class_name: 'PM::Role'
+      delegate :name, to: :pm_role, prefix: true, allow_nil: true
+      delegate :role_type, to: :pm_role, prefix: true, allow_nil: true
+    end
+
+    def super_admin?
+      pm_role_role_type == 'super_admin'
+    end
+  end
+end

data/lib/permission_management/engine.rb

@@ -0,0 +1,4 @@
+module PermissionManagement
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/permission_management/version.rb

@@ -0,0 +1,3 @@
+module PermissionManagement
+  VERSION = "0.0.2"
+end

data/permission_management.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'permission_management/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "permission_management"
+  spec.version       = PermissionManagement::VERSION
+  spec.authors       = ["Ben Zhang"]
+  spec.email         = ["bzbnhang@gmail.com"]
+  spec.summary       = %q{Permission management.}
+  spec.description   = %q{Inspired by Rackspace permission management system.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'nested_form'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: permission_management
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ben Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nested_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Inspired by Rackspace permission management system.
+email:
+- bzbnhang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/permission_management/init.js
+- app/controllers/permission_management/base_controller.rb
+- app/controllers/permission_management/permissions_controller.rb
+- app/controllers/permission_management/roles_controller.rb
+- app/controllers/permission_management/user_roles_controller.rb
+- app/views/permission_management/roles/_form.haml
+- app/views/permission_management/roles/edit.html.haml
+- app/views/permission_management/roles/index.html.haml
+- app/views/permission_management/roles/new.html.haml
+- app/views/permission_management/user_roles/index.html.haml
+- app/views/permission_management/user_roles/update.js.erb
+- config/routes.rb
+- lib/generators/permission_management/install_generator.rb
+- lib/generators/permission_management/templates/ability.rb
+- lib/generators/permission_management/templates/active_record/permission.rb
+- lib/generators/permission_management/templates/active_record/role.rb
+- lib/generators/permission_management/templates/active_record/role_migration.rb
+- lib/generators/permission_management/templates/permission_management.rb
+- lib/permission_management.rb
+- lib/permission_management/engine.rb
+- lib/permission_management/version.rb
+- permission_management.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Permission management.
+test_files: []