umpire 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e96abcc48d489a4c4728288b851f08de6d3e313
+  data.tar.gz: b59784ad56555853627596ab056058cebb1722c5
+SHA512:
+  metadata.gz: 326c327dc437578ecf8906c3d351948b096aeb2506c0ad57ba1aa51a764056f008ba52cf91c0c35b7ce4a06f4e98142502c17973bf75627d103d64143e7e3708
+  data.tar.gz: 34706cbe90b7865f9296eb1ac4f494c6c4f420f3d1574d32d0057543da9d44412333ce4b6c5e7a1a80e1b0ce1ab83461e754146de7965478829c2343b6b7e5d9

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anthony Karasavov
+
+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,89 @@
+# Umpire
+
+Umpire is a very lightweight authorization lib that uses policy classes to define rules
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'umpire'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install umpire
+
+## Usage
+
+Umpire consists of a base policy class that you need to extend and a helper that you can use in your app.
+Because it's doesn't depend on rails, you need to include the Umpire helper in your `ApplicationHelper`
+and your `ApplicationController` or whatever other class you might need to use it in:
+
+    include Umpire::AuthHelper
+
+I use that in a rails lib, so by default the lib uses a `current_user` method to get the subject from,
+but if you don't have it - no worries, you can still pas a subject on your own.
+
+Let's make a simple Policy class and use it in a rails view:
+
+```ruby
+class SchoolPolicy < Umpire::Policy
+  # the only method you need to overwrite
+  # return all the allowed actions here
+  # @subject is the subject (current_user) by default
+  # and the object is @object - in this exapmle it could be a
+  def rules
+    allowed = [:go_to_school]
+    allowed << :take_cs_201  @subject.has_taken(:cs_101)
+    allowed
+  end
+end
+```
+
+You can now use the policy class with the helper like this:
+```erb
+<%= render partial: 'modules/cs_201' if can? :take_cs_201, using: SchoolPolicy %>
+```
+
+This will check call `has_taken(:cs_101)` on the result of `current_user`
+
+Other usage examples:
+
+```ruby
+# with subject
+can? User.find(1), :drive, car, using: HighwayCode
+
+# without subject (assumes current_user if available)
+can? :drive, car, using: HighwayCode
+
+# multiple policies
+can? :park, car, using: [HighwayCode, ParkingRules]
+
+# without object
+can? :cook_spaghetti, using: [KitchenPolicy]
+
+# multiple actions
+can? [:order, :drink], beer, using: BarPolicy
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies.
+Then, run `bundle exec rake rspec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/muxcmux/umpire.
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "umpire"
+
+# 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/lib/umpire.rb

@@ -0,0 +1,9 @@
+module Umpire
+  class NoRulesFound < StandardError
+  end
+end
+
+require "umpire/version"
+require "umpire/policy_missing_error"
+require "umpire/auth_helper"
+require "umpire/policy"

data/lib/umpire/auth_helper.rb

@@ -0,0 +1,47 @@
+module Umpire
+  module AuthHelper
+    # Usage:
+    #
+    # with subject
+    # can? user, :drive, car, using: HighwayCode
+    #
+    # without subject (assumes current_user if available)
+    # can? :drive, car, using: HighwayCode
+    #
+    # multiple policies
+    # can? :park, car, using: [HighwayCode, ParkingRules]
+    #
+    # without object
+    # can? :cook_spaghetti, using: [KitchenPolicy]
+    #
+    # multiple actions
+    # can? [:order, :drink], beer, using: BarPolicy
+    #
+    def can? *args
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      policies = *options[:using]
+      raise PolicyMissingError.new if policies.empty?
+    
+      first_argument = args.shift
+      if first_argument.is_a?(Symbol) || first_argument.is_a?(Array)
+        subject = defined?(current_user) ? current_user : {}
+        actions = first_argument
+      else
+        subject = first_argument
+        actions = args.shift
+      end
+    
+      next_argument = args.shift
+      object = next_argument.is_a?(Hash) ? nil : next_argument
+    
+      policies.each do |policy|
+        return false unless policy.allows?(subject).to(actions, object)
+      end
+    
+      true
+    end
+    
+  
+  end
+
+end

data/lib/umpire/policy.rb

@@ -0,0 +1,41 @@
+# A very basic policy class. Extend other policies with this
+# by providing a rules method which returns the valid actions
+# based on the subject and object
+#
+# Usage
+#
+# with a single action:
+# DrivingPolicy.allows?(driver).to(:drive, car)
+#
+# with multiple actions
+# MemberPolicy.allows?(member).to([:join, :leave], club)
+#
+# without object
+# SchoolPolicy.allows?(student).to(:cheat_on_exam)
+#
+module Umpire
+  class Policy
+  
+    include AuthHelper
+
+    def initialize subject
+      @subject = subject
+    end
+
+    def self.allows? subject
+      new subject
+    end
+
+    def to actions, object = nil
+      @object = object
+      @actions = *actions
+      @actions.all? { |a| rules.include?(a) }
+    end
+  
+    # overwrite me
+    def rules
+      raise NoRulesFound.new("Please implement `rules` in your policy object")
+    end
+  end
+
+end

data/lib/umpire/policy_missing_error.rb

@@ -0,0 +1,7 @@
+module Umpire
+  class PolicyMissingError < StandardError
+    def message
+      "Policy class needs to be supplied: { using: SomePolicy }"
+    end
+  end
+end

data/lib/umpire/version.rb

@@ -0,0 +1,3 @@
+module Umpire
+  VERSION = "0.4.0"
+end

data/umpire.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'umpire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "umpire"
+  spec.version       = Umpire::VERSION
+  spec.authors       = ["Anthony Karasavov"]
+  spec.email         = ["storm.bg@gmail.com"]
+
+  spec.summary       = %q{Lightweight ruby authorization library based on policies}
+  spec.description   = %q{Plain old ruby objects with a helper for use in your apps}
+  spec.homepage      = "https://github.com/muxcmux/umpire"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |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", "~> 3.3"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: umpire
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Anthony Karasavov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-08 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: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Plain old ruby objects with a helper for use in your apps
+email:
+- storm.bg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/umpire.rb
+- lib/umpire/auth_helper.rb
+- lib/umpire/policy.rb
+- lib/umpire/policy_missing_error.rb
+- lib/umpire/version.rb
+- umpire.gemspec
+homepage: https://github.com/muxcmux/umpire
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Lightweight ruby authorization library based on policies
+test_files: []