authoraise 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c413ae8e74f7d4f2d61548b8d18381805f8e20f4
+  data.tar.gz: a4fdd291b24a7a163908c2fd1c175c87169c4515
+SHA512:
+  metadata.gz: 61092df57488c5df6f74dd84ae22a74e30c485b7d3569cb3d6460c648f758791338df5c41f921c4a6d372879da7509d2d15adf92e54f21929824e5d54fb88863
+  data.tar.gz: bed1f0f0adcd85f44e01967532351bc9e9f56f8ff47edaabe1cfffaeec680e302867ca6a40d7cd3502d5b0bf12cd2258014f152b92bd0b57bdd5e0e6e2e6060c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Maxim Chernyak
+
+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,90 @@
+# Authoraise
+
+So your authorization logic is getting complex, and eventually you start forgetting to pass in all the options that are used to check access. When that happens, your boolean expressions return false, causing false negatives. This tool solves the problem by raising helpful error messages, but also allows you to ignore the issue where it's intended to be that way. No more false negatives!
+
+## Usage
+
+Follow these examples to see what happens when sometimes you forget to pass the keys needed for a certain authorization check.
+
+~~~ruby
+require 'authoraise'
+
+# Authorization policy can be defined as follows...
+policy = Authoraise::Policy.new
+policy.allow { |user| user == 'sammy' }
+policy.allow { |post| post == 'happy_post' }
+
+# ...and used as follows.
+policy.authorize(user: 'sammy', post: 'happy_post') # => true
+policy.authorize(user: 'bob',   post: 'happy_post') # => true
+policy.authorize(user: 'bob',   post: 'sad_post')   # => false
+policy.authorize(user: 'sammy')                     # => true
+
+# Another way is to both define and run a policy using this block form.
+include Authoraise
+authorize(user: 'sammy', post: 'article') do |policy|
+  policy.allow { |user| user == 'sammy' }
+end
+# => true
+
+# Oops, in this example I forgot to pass the post, but user also didn't match.
+authorize(user: 'bob') do |policy|
+  policy.allow { |user| user == 'sammy' }
+  policy.allow { |post| post == 'foo' }
+end
+# => Authoraise::Error: Inconclusive authorization, missing keys: [:post]
+
+# Forgot to pass the post object, but user was actually enough.
+authorize(user: 'sammy') do |policy|
+  policy.allow { |user| user == 'sammy' }
+  policy.allow { |post| post == 'foo' }
+end
+# => true
+
+# Didn't forget to pass anything, but it didn't match, so this is a legit fail.
+authorize(user: 'bob', post: 'foo') do |policy|
+  policy.allow { |user| user == 'sammy' }
+  policy.allow { |post| post == 'bar' }
+end
+# => false
+
+# Let's see what happens in strict mode.
+Authoraise.strict_mode = true
+
+# In stict mode any missing key raises an error, even if other checks passed.
+authorize(user: 'sammy') do |policy|
+  policy.allow { |user| user == 'sammy' }
+  policy.allow { |post| post.published? }
+end
+# => Authoraise::Error: Inconclusive authorization, missing keys: [:post]
+~~~
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'authoraise'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install authoraise
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/authoraise/fork )
+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 a new Pull Request

data/Rakefile

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

data/authoraise.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'authoraise/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "authoraise"
+  spec.version       = Authoraise::VERSION
+  spec.authors       = ["Maxim Chernyak"]
+  spec.email         = ["max@bitsonnet.com"]
+
+  spec.summary       = %q{Authorize without false negatives.}
+  spec.homepage      = "https://github.com/maxim/authoraise"
+  spec.license       = "MIT"
+
+  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.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "authoraise"
+
+include Authoraise
+
+require "pry"
+Pry.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/authoraise.rb

@@ -0,0 +1,84 @@
+require 'authoraise/version'
+require 'set'
+
+module Authoraise
+  Error = Class.new(RuntimeError)
+
+  class << self; attr_accessor :strict_mode end
+
+  def authorize(options = {})
+    policy = Policy.new(options)
+    yield(policy)
+    policy.authorize
+  end
+
+  class Check
+    attr_reader :required_keys
+
+    def initialize(required_keys, procedure)
+      @required_keys = required_keys.to_set
+      @procedure = procedure
+    end
+
+    def call(options)
+      given_keys = options.keys.to_set
+
+      if required_keys.subset?(given_keys)
+        @procedure.call(*required_keys.map{|k| options[k]})
+      else
+        raise Error, "Check failed, missing keys: #{missing_keys(given_keys)}"
+      end
+    end
+
+    def missing_keys(given_keys)
+      (required_keys - given_keys.to_set).to_a
+    end
+  end
+
+  class Policy
+    def initialize(options = {})
+      @options = options
+      @checks = []
+      @mode = :any
+    end
+
+    def allow(&procedure)
+      @checks <<
+        Check.new(procedure.parameters.map(&:last), procedure)
+    end
+
+    def authorize
+      raise Error, 'Policy is empty' if @checks.empty?
+      given_keys = @options.keys.to_set
+      assert_all_keys_match(given_keys) if Authoraise.strict_mode
+      missing_keys = Set.new
+
+      @checks.each do |check|
+        if check.required_keys.subset?(given_keys)
+          return true if check.(@options)
+        else
+          missing_keys += check.missing_keys(given_keys)
+        end
+      end
+
+      if missing_keys.empty?
+        return false
+      else
+        raise Error,
+          "Inconclusive authorization, missing keys: #{missing_keys.to_a}"
+      end
+    end
+
+    private
+
+    def assert_all_keys_match(given_keys)
+      missing_keys = @checks.inject(Set.new) do |set, check|
+        set + check.missing_keys(given_keys)
+      end.to_a
+
+      if !missing_keys.empty?
+        raise Error, "Strict mode found missing keys: #{missing_keys}"
+      end
+    end
+  end
+end

data/lib/authoraise/version.rb

@@ -0,0 +1,3 @@
+module Authoraise
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: authoraise
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maxim Chernyak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: 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'
+description: 
+email:
+- max@bitsonnet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- authoraise.gemspec
+- bin/console
+- bin/setup
+- lib/authoraise.rb
+- lib/authoraise/version.rb
+homepage: https://github.com/maxim/authoraise
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Authorize without false negatives.
+test_files: []
+has_rdoc: