minican 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea52e4d136e6fc32c74452ad561ea64e6d832a84
+  data.tar.gz: 961382bb4426291699b14e0074a8aaf2f417377e
+SHA512:
+  metadata.gz: cc3f9fd5ee74bad3261013c7b4540a73c10f379f16c6e70c00c5437cda5d5c4547195da9ac09500acf708e1e30d47803bbcf748a6ad1e582193761a7583e6c4b
+  data.tar.gz: 94e5140f784369993a333bd3c2e93d31630ca426177dfe93b2933aacf2050c7d89e0f9142328fb207dd859843eb1c211acd6e3e26cf898ada9c5824942c3e1d6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Blake Williams
+
+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 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/lib/minican.rb

@@ -0,0 +1,7 @@
+require 'minican/helpers'
+require 'minican/access_denied'
+require 'minican/controller_additions'
+require 'minican/policy'
+
+module Minican
+end

data/lib/minican/access_denied.rb

@@ -0,0 +1,17 @@
+module Minican
+  class AccessDenied < StandardError
+
+    # This is raised when a policy fails in a controller via 
+    # {Minican::ControllerAdditions}
+    #
+    # @param [policy] The policy that authorized it
+    def initialize(policy)
+      @policy = policy
+    end
+
+    # Human readable error message
+    def to_s
+      "You are not authorized to access this page"
+    end
+  end
+end

data/lib/minican/controller_additions.rb

@@ -0,0 +1,58 @@
+module Minican
+  module ControllerAdditions
+    include Minican::Helpers
+
+    private
+
+    # Controller helper method to verify call method on 
+    # policy. Raises {Minican::AccessDenied} if the policy
+    # method fails
+    #
+    # @param method [Symbol] method to be called on the policy
+    # @param object [Object] The object to apply the policy to
+    # @param user [User] The user object to pass to the method
+    # 
+    # @visibility public
+    def authorize!(method, object, user = current_user)
+      policy = policy_for(object)
+
+      if policy.cannot?(method, current_user)
+        raise Minican::AccessDenied.new(policy)
+      end
+    end
+
+    # Helper method available in controllers and views
+    # that returns the value of the policy method
+    # 
+    # @param (see #authorize!)
+    # @return (Boolean)
+    #
+    # @visibility public
+    def can?(method, object, user = current_user)
+      policy = policy_for(object)
+      policy.can?(method, user)
+    end
+
+    # Helper method available in controllers and views
+    # that returns the negated value of the policy method
+    #
+    # @param (see #can?)
+    # @return (see #can?)
+    #
+    # @visibility public
+    def cannot?(method, object, user = current_user)
+      !can?(method, object, user)
+    end
+
+    def self.included(base)
+      base.helper_method :can?
+      base.helper_method :cannot?
+    end
+  end
+end
+
+if defined? ActionController::Base
+  ActionController::Base.class_eval do
+    include Minican::ControllerAdditions
+  end
+end

data/lib/minican/helpers.rb

@@ -0,0 +1,33 @@
+module Minican
+  module Helpers
+
+    private
+
+    # Returns a new policy for passed in object
+    #
+    # @param [object] The object to create a policy for
+    #
+    # @visibility public
+    def policy_for(object)
+      policy_class(object).new(object)
+    end
+
+    # Returns a policy class based on the object
+    # passed in. If object is a class, it will 
+    # return itself, if it's an instance it will 
+    # return a class based on its name.
+    #
+    # @param [object] The object to classify
+    #
+    # @visibility public
+    def policy_class(object)
+      if object.class == Class
+        class_name = object
+      else
+        class_name = object.class
+      end
+
+      "#{class_name.to_s}Policy".constantize
+    end
+  end
+end

data/lib/minican/policy.rb

@@ -0,0 +1,49 @@
+module Minican
+  class Policy
+    include Minican::Helpers
+
+    # Creates a new instance of policy with object
+    # that is accessible via {object} or after the
+    # name of the policy class
+    #
+    # @param [object] The object the policy tests against
+    def initialize(object)
+      instance_variable_set(instance_name, object)
+    end
+
+    # Convenience method to call predicate method
+    # and return the value
+    #
+    # @param [method] Method to call
+    # @param [user] User to send to the method
+    #
+    # @return [Boolean]
+    def can?(method, user)
+      self.send("#{method}?", user)
+    end
+
+    # Convenience method to call predicate method
+    # and return the negated value
+    #
+    # @param [method] Method to call
+    # @param [user] User to send to the method
+    #
+    # @return [Boolean]
+    def cannot?(method, user)
+      !can?(method, user)
+    end
+
+    # Conveneince method to get the current object
+    # without having to get the class name
+    def object
+      instance_variable_get(instance_name)
+    end
+
+    private
+
+    def instance_name
+      class_name = self.class.to_s.gsub(/Policy$/, '')
+      "@#{class_name.underscore}"
+    end
+  end
+end

data/lib/minican/version.rb

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

data/lib/tasks/minican_tasks.rake

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: minican
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Blake Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+description: Miniature authorization for Rails.
+email:
+- blake@blakewilliams.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/minican/access_denied.rb
+- lib/minican/controller_additions.rb
+- lib/minican/helpers.rb
+- lib/minican/policy.rb
+- lib/minican/version.rb
+- lib/minican.rb
+- lib/tasks/minican_tasks.rake
+- MIT-LICENSE
+- Rakefile
+homepage: http://github.com/BlakeWilliams/Minican
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Miniature authorization for Rails.
+test_files: []
+has_rdoc: