critic 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d45e116551e704334c5a3c1ddd1d021edbc19fc6
+  data.tar.gz: a881f09af89ed7e572cd3d89724d13b6b62ef180
+SHA512:
+  metadata.gz: 9df1a366cdae643e0ff01bc896146257c94335a4893e29ff7a30ab922b6e486c20be280de5b1e0d5718bcf4a6bfb43ce29140cc4fd6096e31a1935151ffc23f5
+  data.tar.gz: 9be579f0737285e880be3e5ca4976c3ecca7f7deaeb8ef1ff99e4b7b26796e1fceb29bf2ec4402e3966c051007291d32ec45d313e1e2b2bf5a7dfebec1ea9c38

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  Exclude:
+    - 'spec/**/*'
+Metrics/LineLength:
+  Max: 120
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+Metrics/AbcSize:
+  Max: 75
+Metrics/MethodLength:
+  Max: 50
+Metrics/ClassLength:
+  Max: 300
+Metrics/ModuleLength:
+  Max: 300
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
+Style/TrailingCommaInArguments:
+  Enabled: false
+  #EnforcedStyleForMultiline: consistent_comma # this is very broke
+Style/StructInheritance:
+  Enabled: false
+Style/AccessorMethodName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+sudo: false
+cache:
+  - bundler
+rvm:
+  - 2.3.0
+  - 2.2.4
+  - 2.1.8
+script: 
+  - bundle exec rubocop -D
+  - bundle exec rake spec
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in critic.gemspec
+gemspec
+
+gem 'activesupport', '~> 3.2.22', require: false
+gem 'rubocop', '~> 0.40', require: false
+
+group :test do
+  gem 'pry-nav'
+end

data/README.md

@@ -0,0 +1,36 @@
+# Critic
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/critic`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'critic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install critic
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/critic.
+

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'critic'
+
+# 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

data/bin/setup

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

data/critic.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'critic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'critic'
+  spec.version       = Critic::VERSION
+  spec.authors       = ['Josh Lane']
+  spec.email         = ['me@joshualane.com']
+
+  spec.summary       = 'Resource authorization'
+  spec.description   = 'Resource authorization via PORO'
+  spec.homepage      = 'http://lanej.io/critic'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'activesupport', '> 3.0', '< 5.0'
+end

data/lib/critic.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'critic/version'
+require 'active_support/concern'
+require 'active_support/callbacks'
+require 'active_support/version'
+require 'active_support/core_ext/string/inflections'
+
+# Namespace
+module Critic; end
+
+Critic::AuthorizationDenied  = Class.new(StandardError)
+Critic::AuthorizationMissing = Class.new(StandardError)
+
+require 'critic/policy'
+require 'critic/authorization'
+require 'critic/controller'

data/lib/critic/authorization.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+class Critic::Authorization
+  attr_reader :policy, :action
+  attr_accessor :messages, :granted, :result
+
+  def initialize(policy, action)
+    @policy = policy
+    @action = action
+
+    @granted, @result = nil
+    @messages = []
+  end
+
+  def granted?
+    true == @granted
+  end
+
+  def denied?
+    false == @granted
+  end
+end

data/lib/critic/controller.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+module Critic::Controller
+  extend ActiveSupport::Concern
+
+  included do
+    if respond_to?(:hide_action)
+      hide_action(:authorize)
+      hide_action(:authorize_scope)
+    end
+  end
+
+  def authorize(resource, action=default_action, policy: policy(resource), with: nil)
+    authorizing!
+
+    args = [with] if !with.is_a?(Array) && !with.nil?
+
+    @authorization = policy.authorize(action, critic, resource, args)
+
+    authorization_failed! if @authorization.denied?
+
+    @authorization.result
+  end
+
+  def authorized?(resource, *args, **options)
+    authorize(resource, *args, **options)
+  rescue Critic::AuthorizationDenied
+    false
+  end
+
+  def authorize_scope(scope, *args, action: nil, policy: policy(scope))
+    authorization_action = action || policy.scope
+
+    authorize(scope, authorization_action, *args, policy: policy)
+  end
+
+  protected
+
+  attr_reader :authorization
+
+  def authorization_failed!
+    raise Critic::AuthorizationDenied, authorization.messages
+  end
+
+  def authorization_missing!
+    raise Critic::AuthorizationMissing
+  end
+
+  def verify_authorized
+    unless true == @_authorizing
+      authorization_missing!
+    else
+      true
+    end
+  end
+
+  def authorizing!
+    @_authorizing = true
+  end
+
+  def policy(object)
+    Critic::Policy.for(object)
+  end
+
+  def critic
+    (defined?(consumer) && consumer) || current_user
+  end
+
+  private
+
+  def default_action
+    defined?(params) && params[:action]
+  end
+end

data/lib/critic/policy.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+module Critic::Policy
+  extend ActiveSupport::Concern
+
+  def self.policies
+    @_policies ||= Hash.new { |h, k| h[k.to_s] = nil }
+  end
+
+  # @fixme do we really wish to demodulize ?
+  def self.resource_class_for(object)
+    if object.respond_to?(:model_name)
+      # used for pulling class out of ActiveRecord::Relation objects
+      object.model_name
+    elsif object.is_a?(Class)
+      object.to_s.demodulize
+    else
+      object.class.to_s.demodulize
+    end
+  end
+
+  def self.for(resource)
+    resource_class = resource_class_for(resource)
+
+    policies.fetch(resource_class) { "#{resource_class}Policy".constantize }
+  end
+
+  included do
+    include ActiveSupport::Callbacks
+
+    if ActiveSupport::VERSION::MAJOR < 4
+      define_callbacks :authorize, terminator: 'authorization.result == false || result == false'
+    else
+      define_callbacks :authorize, terminator: ->(target, result) { target.authorization.result == false || false == result }
+    end
+  end
+
+  # Policy entry points
+  module ClassMethods
+    def authorize(action, subject, resource, args=nil)
+      new(subject, resource).authorize(action, *args)
+    end
+
+    def scope(action = nil)
+      action.nil? ? (@scope || :index) : (@scope = action)
+    end
+
+    def before_authorize(*args, **options, &block)
+      set_callback(:authorize, :before, *args, **options, &block)
+    end
+
+    def after_authorize(*args, **options, &block)
+      set_callback(:authorize, :after, *args, **options, &block)
+    end
+
+    def around_authorize(*args, **options, &block)
+      set_callback(:authorize, :around, *args, **options, &block)
+    end
+  end
+
+  attr_reader :subject, :resource, :errors
+  attr_accessor :authorization
+
+  def initialize(subject, resource)
+    @subject = subject
+    @resource = resource
+    @errors = []
+  end
+
+  def failure_message(action)
+    "#{subject} is not authorized to #{action} #{resource}"
+  end
+
+  def authorize(action, *args)
+    self.authorization = Critic::Authorization.new(self, action)
+
+    result = false
+
+    begin
+      run_callbacks(:authorize) { result = public_send(action, *args) }
+    rescue Critic::AuthorizationDenied
+      authorization.granted = false
+    ensure
+      authorization.result = result if authorization.result.nil?
+    end
+
+    case authorization.result
+    when Critic::Authorization
+      # user has accessed authorization directly
+    when String
+      authorization.granted = false
+      authorization.messages << result
+    when nil, false
+      authorization.granted = false
+      authorization.messages << failure_message(action)
+    else
+      authorization.granted = true
+    end
+
+    authorization
+  end
+end

data/lib/critic/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Critic
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: critic
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Josh Lane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Resource authorization via PORO
+email:
+- me@joshualane.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- critic.gemspec
+- lib/critic.rb
+- lib/critic/authorization.rb
+- lib/critic/controller.rb
+- lib/critic/policy.rb
+- lib/critic/version.rb
+homepage: http://lanej.io/critic
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Resource authorization
+test_files: []