porteiro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2796cb24e22ccb1603b16a55eb06b41f6fb6d061
+  data.tar.gz: 657fdc47611b5326edb73df3663f8e929545d5c4
+SHA512:
+  metadata.gz: 0cfb3c97c0590a2794d446a56d820615f41e2f0b63e9b79e19cec509472483dcb131b713b5cd5405452661d53ff6f756a7e8db97a4d7d849b405d070ba01be49
+  data.tar.gz: 62d2e6868c0d5c9684c8107ad8eea4c059936f7061dd1577d7a4489156ae9937a33b04cf004215e0422bcdb648f39840a67ad303e0ef052b4f70d4a852f6c931

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/.rspec

@@ -0,0 +1 @@
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in porteiro.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 bradwheel
+
+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 @@
+# Porteiro
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'porteiro'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install porteiro
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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,3 @@
+require "bundler/gem_tasks"
+
+

data/lib/porteiro/base.rb

@@ -0,0 +1,16 @@
+module Porteiro
+  class Base
+    
+    def initialize(user, params)
+      @user = user 
+      @params = params 
+    end
+    attr_reader :user, :params
+
+    def authorize_action!
+      controller_action = params.fetch(:action)
+      self.send("#{controller_action}?") ? true :  (raise NotAuthorizedError, "You aren't permitted to access this resource")
+    end
+
+  end
+end

data/lib/porteiro/policy_finder.rb

@@ -0,0 +1,38 @@
+module Porteiro
+  class PolicyFinder
+
+    attr_reader :user, :req_params, :klass
+
+    def initialize(user, req_params)
+      @user = user
+      @req_params = req_params
+      @klass = fetch_klass_from_params
+    end
+
+    def find!
+      begin 
+        return instantiate_policy_class
+      rescue NameError
+        raise PolicyUndefinedError, "You must define your default policy: #{Porteiro.default_policy}"
+      end
+    end
+
+    def fetch_klass_from_params
+      return String(req_params.fetch(:controller).classify) rescue nil
+    end
+
+    ##
+    # Finds policy and instantiates it. If policy doesn't exist, the default
+    # policy is instantiated. This removes the need to define every policy if
+    # you want to use method_missing in the default policy.
+    ##
+
+    def instantiate_policy_class
+      policy = "#{klass}Policy".constantize.new(user, req_params) rescue nil
+      return (Porteiro.default_policy.constantize.new(user, req_params)) unless policy 
+      return policy 
+    end
+
+  end
+end
+

data/lib/porteiro/version.rb

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

data/lib/porteiro.rb

@@ -0,0 +1,54 @@
+require "porteiro/version"
+require "porteiro/policy_finder"
+require "porteiro/base"
+require "active_support/concern"
+require "active_support/inflector"
+
+module Porteiro
+  extend ActiveSupport::Concern 
+
+  class NotAuthorizedError < StandardError;end
+  class PolicyUndefinedError < StandardError;end
+
+
+  class << self
+
+    ##
+    # ClassMethod to find policy with PolicyFinder using the current_user 
+    # and request params.
+    ##
+
+    def policy(user, req_params)
+      policy = PolicyFinder.new(user, req_params).find!
+      return policy
+    end
+
+    ##
+    # Configuration methods for setting default policy name
+    ## 
+
+    def default_policy
+      @default_policy ||= "ApplicationPolicy"
+    end
+    attr_writer :default_policy
+
+  end
+
+  ##
+  # Before action that can be called in the controller to check for authorization.
+  # If this is not called, no policy will be looked up.
+  ## 
+
+  def authorize_user_access!
+    policy.authorize_action!
+  end
+
+  def policy
+    @policy || Porteiro.policy(porteiro_user, params)
+  end
+
+  def porteiro_user
+    current_user
+  end
+
+end

data/porteiro.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'porteiro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "porteiro"
+  spec.version       = Porteiro::VERSION
+  spec.authors       = ["bradwheel"]
+  spec.email         = ["bradley.m.wheel@gmail.com"]
+  spec.description   = %q{Authorization for controllers modeled after Pundit.}
+  spec.summary       = %q{Authorization for controllers modeled after Pundit.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "activesupport", ">= 3.0.0"
+  spec.add_development_dependency "activerecord", ">= 3.0.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/porteiro_spec.rb

@@ -0,0 +1,109 @@
+require "spec_helper"
+
+describe Porteiro do 
+
+  let!(:current_user) {User.new}
+  let!(:controller) {ControllerClass.new(current_user)}
+
+
+  describe "#porteiro_user" do 
+
+    it "returns the current_user" do 
+      expect(controller.porteiro_user).to eq current_user
+    end
+
+  end
+
+  describe "#policy" do 
+
+    it "returns the instance of policy finder" do 
+      expect(controller.policy.user).to eq(Porteiro.policy(controller.porteiro_user, controller.params).user)
+      expect(controller.policy.params).to eq(Porteiro.policy(controller.porteiro_user, controller.params).params)
+    end
+
+  end
+
+  describe "#default_policy" do 
+
+    it "uses ApplicationPolicy as a default unless specified" do 
+      expect(Porteiro.default_policy).to eq "ApplicationPolicy"
+    end
+
+    it "uses the specified default policy if supplied" do 
+      Porteiro.default_policy=("SuppliedPolicy")
+      expect(Porteiro.default_policy).to eq "SuppliedPolicy"
+    end
+
+  end
+
+  describe Porteiro::PolicyFinder do 
+
+    it "finds the correct policy from controller params" do 
+      policy = Porteiro::PolicyFinder.new(controller.current_user, controller.params)
+      expect(policy.klass).to eq "Document"
+    end
+
+    context "when policy doesn't exist" do 
+
+      it "instantiates the default policy" do 
+        Porteiro.default_policy = "ApplicationPolicy"
+        policy = Porteiro::PolicyFinder.new(controller.current_user, controller.params).find!
+        expect(policy).to be_instance_of(ApplicationPolicy)
+      end
+
+    end
+
+    context "when policy does exist" do 
+
+      
+      before(:each) do 
+        class DocumentPolicy < ApplicationPolicy; end
+      end 
+
+      it "instantiates the correct policy" do 
+        policy = Porteiro::PolicyFinder.new(controller.current_user, controller.params).find!
+        expect(policy).to be_instance_of(DocumentPolicy)
+      end
+
+    end
+
+  end
+
+  describe "#authorize_user_access!" do 
+
+    context "when the action is permitted" do 
+
+      it "returns true" do 
+        expect(controller.authorize_user_access!).to be(true)
+      end
+
+    end
+
+    context "when the action is not permitted" do 
+
+      it "raises Porteiro::NotAuthorizedError" do 
+        controller.params[:action] = "edit"
+        expect {controller.authorize_user_access!}.to raise_error(Porteiro::NotAuthorizedError)
+      end
+
+    end
+
+  end
+
+
+  describe Porteiro::Base do 
+
+    it "initializes with a user and request params" do 
+      policy = Porteiro::Base.new(controller.current_user, controller.params)
+      expect(policy.user).to eq controller.current_user
+      expect(policy.params).to eq controller.params
+    end
+
+    it "#authorize_action!" do 
+      policy = Porteiro::PolicyFinder.new(controller.current_user, controller.params).find!
+      expect(policy.authorize_action!).to eq true
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require "porteiro"
+require "porteiro/base"
+require "pry"
+
+class User < Struct.new(:name); end
+
+class ControllerClass
+  include Porteiro 
+
+  attr_accessor :current_user
+
+  def initialize(user)
+    @current_user = user
+  end
+  
+  def params
+    @params ||= {controller: "document", action: "index"}
+  end 
+  
+end
+
+
+class ApplicationPolicy < Porteiro::Base
+
+  def index?
+    true
+  end
+
+  def show?
+    true
+  end
+
+  def edit?
+    false
+  end
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: porteiro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- bradwheel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Authorization for controllers modeled after Pundit.
+email:
+- bradley.m.wheel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/porteiro.rb
+- lib/porteiro/base.rb
+- lib/porteiro/policy_finder.rb
+- lib/porteiro/version.rb
+- porteiro.gemspec
+- spec/porteiro_spec.rb
+- spec/spec_helper.rb
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Authorization for controllers modeled after Pundit.
+test_files:
+- spec/porteiro_spec.rb
+- spec/spec_helper.rb