gate_police 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e08061a3539a5fb0e2fd045e346556d2eb554ff6
+  data.tar.gz: f2c8f366e6e45c870a9c38ce6c4e587d356c5e17
+SHA512:
+  metadata.gz: 00b9d4565138d046284f2c9312d279e00005e521cc1c327d0dda094ee2ee43f792f0f880a03fd66b09cf03e7b8247853e0a105cc67a923630a41a14513a86a67
+  data.tar.gz: 41103d4595b909b2ddec428d827300fd20a9589a56351309590c0d45d53b33893bfb6e8665260d6587fad45a2ac2db4278cd0540d57528c13d948e555ad08096

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gate_police.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 miio
+
+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,29 @@
+# GatePolice
+
+Permission for rails library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gate_police'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gate_police
+
+## Usage
+
+TODO
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/app/helpers/gate_police_helper.rb

@@ -0,0 +1,44 @@
+module GatePoliceHelper
+  # Check permission
+  #
+  # @note
+  #   You need define check user
+  #
+  #   @example
+  #     alias_method :permission_user, :current_user
+  #
+  # How to use
+  #
+  #   @example
+  #       class MaterialsController < InheritedResources::Base
+  #         before_filter do
+  #           require_permission :material, params[:id]
+  #         end
+  #       end
+  #
+  # @param  [Symbol]  model_sym   target model and handlers prefix
+  # @param  [Integer] object_id   target primary key
+  # @raise  [PermissionDenied]    raise for hasn't permissiona
+  def require_permission model_sym, object_id=nil
+    model_name = "#{model_sym.capitalize.to_s}"
+    class_name = "#{model_name}PermissionHandler"
+    permission = params[:action].to_sym
+    require "#{Rails.root}/app/permissions/application_permission_handler"
+    require "#{Rails.root}/app/permissions/#{model_sym.capitalize.to_s}_permission_handler"
+    handler = Module.const_get(class_name).new
+    handler.user = self.permission_user
+    handler.require_permission Module.const_get(model_name), permission, object_id, params
+  end
+
+  #
+  # Render for permission denied action
+  #
+  # @note
+  #   You need append ApplicationController
+  #     rescue_from GatePolice::PermissionDenied, with: :call_denied_action
+  #
+  # @param  [Exception] exception exception instance
+  def call_denied_action exception=nil
+    exception.handler.denied_action self
+  end
+end

data/gate_police.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gate_police/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["miio"]
+  gem.email         = ["info@miio.info"]
+  gem.description   = %q{Permission for rails library}
+  gem.summary       = %q{Permission for rails library}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gate_police"
+  gem.require_paths = ["lib"]
+  gem.version       = GatePolice::VERSION
+end

data/lib/gate_police.rb

@@ -0,0 +1,9 @@
+require "gate_police/version"
+require "gate_police/exceptions"
+require "gate_police/permission_handler"
+#
+# Copyright (c) 2013 miio <info@miio.info>
+#
+module GatePolice
+  require "gate_police/engine" if defined?(Rails)
+end

data/lib/gate_police/engine.rb

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

data/lib/gate_police/exceptions.rb

@@ -0,0 +1,13 @@
+module GatePolice 
+  # raise for hasn't permission for user
+  class PermissionDenied < StandardError
+    def initialize(handler)
+      super("Permission Denied")
+      @handler = handler
+    end
+
+    def handler
+      @handler
+    end
+  end
+end

data/lib/gate_police/permission_handler.rb

@@ -0,0 +1,88 @@
+module GatePolice
+  # Permission handling classes.
+  #
+  # Check permission for has_perm? method.
+  # Call from require_permission.
+  #
+  # How call you'r permission handler?
+  #
+  # @example
+  #
+  #   class MaterialsController < ApplicationController
+  #     require_permission :material
+  #   end
+  #
+  # call MaterialPermissionHandler.
+  #
+  # How to define permission logic.
+  #
+  # @example
+  #
+  #   class MaterialPermissionHandler < ApplicationPermissionHandler
+  #       CODE_NAMES = [
+  #          :show, :update, :delete
+  #       ]
+  #   end
+  #
+  # @note
+  #   CODE_NAMES is check target action. if need check permission. You need define action into CODE_NAMES.
+  #
+  # Permission logic need implements has_perm? method
+  #
+  # @example
+  #
+  #   class MaterialPermissionHandler < ApplicationPermissionHandler
+  #     CODE_NAMES = [
+  #       :show, :update, :delete, :edit
+  #     ]
+  #     def has_perm? user, code_name, obj, params
+  #       # Accept author.
+  #       return true if user == obj.user
+  #       case code_name
+  #       when :show
+  #         return true if obj and obj.scope == Material::SCOPE_PUBLIC
+  #         return true if obj.scope == Material::SCOPE_GROUP and ProjectMember.where(project_id: obj.project_id, user_id: user.id).first
+  #       when :edit, :update, :delete
+  #         # Reject guest
+  #         return false if user.nil?
+  #         # Accept project member if public or group
+  #         if obj and (obj.scope == Material::SCOPE_PUBLIC or obj.scope == Material::SCOPE_GROUP)
+  #           return true if obj and ProjectMember.where(project_id: obj.project_id, user_id: user.id).first
+  #         end
+  #       end
+  #       false
+  #     end
+  #   end
+  class PermissionHandler
+    # Check permission methos.
+    # @param [ActiveRecord::Base] model_class check target object class
+    # @param [Symbol] permission permission code_name
+    # @param [Integer] object_id check target object primary key
+    # @param [Hash] params requests
+    # @raise [PermissionDenied] raise for hasn't permission
+    def require_permission model_class, permission, object_id, params
+      return true unless self.class::CODE_NAMES.include? permission
+      primary_key = model_class.primary_key
+      obj = model_class.where(primary_key => object_id).first_or_initialize
+      raise PermissionDenied, self unless self.has_perm? self.user, permission, obj, params
+    end
+
+    # Render for PermissionDenied Error
+    # @param [ActionController] controller current controller instance
+    def denied_action controller
+      controller.respond_to do |format|
+        format.html { controller.render file: "#{Rails.root}/public/403", handlers: [:html], status: 403, layout: true }
+        format.json { controller.render json: { error: true, message: "Permission Denied" } }
+      end
+    end
+
+    def user
+      @user
+    end
+
+    def user= user
+      @user = user
+    end
+  end
+
+end

data/lib/gate_police/version.rb

@@ -0,0 +1,3 @@
+module GatePolice
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: gate_police
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- miio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-24 00:00:00.000000000 Z
+dependencies: []
+description: Permission for rails library
+email:
+- info@miio.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/helpers/gate_police_helper.rb
+- gate_police.gemspec
+- lib/gate_police.rb
+- lib/gate_police/engine.rb
+- lib/gate_police/exceptions.rb
+- lib/gate_police/permission_handler.rb
+- lib/gate_police/version.rb
+homepage: ''
+licenses: []
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Permission for rails library
+test_files: []