action_authorization 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f28b1848154905407d532747347e5a0c33dadc028c5fe84f4d78fc3cf8a14ba
+  data.tar.gz: 8525ff6cc7f6b9891c27b567c031385cd6a56dc0365847b8b5b8a10214e3e964
+SHA512:
+  metadata.gz: 74efb7d0649a2a9d2474c3df0dd087e86469e3c5257f570a7d3cea093322a5e380c7ba3c5d9bd474b3d668b5014794624753d7f90ff321ac358752f429826f67
+  data.tar.gz: ce8d61ed43e321016c11780b3075434987d35dfeb780e6b79093b165b06e06b50dd84fb88d5a900f6461e362450287682069a028646268e029397eb5efb1eaa2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.travis.yml

@@ -0,0 +1,14 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=0ff5e542d77e2710a003d2ee7a11d4e5a50aaa08fe97ab009a72768885197905
+language: ruby
+rvm:
+  - 2.5.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake test
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rexport.gemspec
+gemspec
+
+group :test do
+  gem 'simplecov'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$})           { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$})   { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aaron Baldwin
+
+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,84 @@
+# ActionAuthorization
+
+A base policy class for authorizing controller actions with access to the current_user and object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_authorization'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_authorization
+
+## Requirements
+
+ActionAuthorization requires a **current_user** method that returns the currently logged in user.
+
+## Usage
+
+Include the ActionAuthorization module in your ApplicationController (or indvidual controller(s))
+
+```ruby
+class ApplicationController < ActionController::Base
+  include ActionAuthorization
+end
+```
+
+Create an authorization policy for a resource.
+
+``` ruby
+class DocumentPolicy
+  def show?
+    document.owner == user
+  end
+end
+```
+
+Call **authorize** method in controller action.
+
+```ruby
+class DocumentController < ApplicationController
+  def show
+    @document = authorize(Document.find(params[:id]))
+  end
+end
+```
+
+Pass a **policy_class** to authorize to override the default resource based policy.
+```ruby
+class DocumentController < ApplicationController
+  def show
+    @document = authorize(Document.find(params[:id]), policy_class: UserOwnerPolicy)
+  end
+end
+```
+
+Check if authorized before displaying a link in the view.
+
+```erb
+<%= link_to(@document.name, @document) if policy(@document).show? %>
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wwidea/action_authorization.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/action_authorization.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_authorization/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_authorization"
+  spec.version       = ActionAuthorization::VERSION
+  spec.authors       = ["Aaron Baldwin"]
+  spec.email         = ["baldwina@brightwayslearning.org"]
+
+  spec.summary       = %q{Rails controller object-level action authorization.}
+  spec.description   = %q{A base policy class for authorizing controller actions with access to the current_user and object.}
+  spec.homepage      = "https://github.com/wwidea/action_authorization"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency     "activesupport",  "~> 5.0"
+
+  spec.add_development_dependency "bundler",        "~> 1.14"
+  spec.add_development_dependency "rake",           "~> 12.1"
+  spec.add_development_dependency "minitest",       "~> 5.0"
+  spec.add_development_dependency "guard",          "~> 2.14"
+  spec.add_development_dependency "guard-minitest", "~> 2.4"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "action_authorization"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/action_authorization.rb

@@ -0,0 +1,30 @@
+require "action_authorization/version"
+require "action_authorization/base_policy"
+require "action_authorization/authorization_failure"
+require "active_support/core_ext/string/inflections"
+
+module ActionAuthorization
+  def self.included(base)
+    base.class_eval do
+      helper_method :policy
+    end
+  end
+
+  protected
+
+  def authorize(object, action: action_name, policy_class: nil)
+    if policy(object, policy_class).send("#{action}?")
+      object
+    else
+      raise ActionAuthorization::AuthorizationFailure
+    end
+  end
+
+  def policy(object, policy_class = nil)
+    (policy_class || policy_class_for(object)).new(current_user, object)
+  end
+
+  def policy_class_for(object)
+    "#{object.class.name}Policy".constantize
+  end
+end

data/lib/action_authorization/authorization_failure.rb

@@ -0,0 +1,4 @@
+module ActionAuthorization
+  class AuthorizationFailure < StandardError
+  end
+end

data/lib/action_authorization/base_policy.rb

@@ -0,0 +1,49 @@
+module ActionAuthorization
+  class BasePolicy
+    attr_accessor :user, :object
+
+    def initialize(user, object)
+      self.user = user
+      self.object = object
+    end
+
+    # create alias to object from subclass name
+    def self.inherited(klass)
+      klass.send(:alias_method, klass.name.gsub('Policy', '').underscore, :object)
+    end
+
+    def index?
+      authorized?
+    end
+
+    def show?
+      authorized?
+    end
+
+    def new?
+      create?
+    end
+
+    def create?
+      authorized?
+    end
+
+    def edit?
+      update?
+    end
+
+    def update?
+      authorized?
+    end
+
+    def destroy?
+      create?
+    end
+
+    private
+
+    def authorized?
+      false
+    end
+  end
+end

data/lib/action_authorization/version.rb

@@ -0,0 +1,3 @@
+module ActionAuthorization
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: action_authorization
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Aaron Baldwin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: A base policy class for authorizing controller actions with access to
+  the current_user and object.
+email:
+- baldwina@brightwayslearning.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_authorization.gemspec
+- bin/console
+- bin/setup
+- lib/action_authorization.rb
+- lib/action_authorization/authorization_failure.rb
+- lib/action_authorization/base_policy.rb
+- lib/action_authorization/version.rb
+homepage: https://github.com/wwidea/action_authorization
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Rails controller object-level action authorization.
+test_files: []