asserter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 314aba4c8680198293c6f038d9c9aedec8b409a6
+  data.tar.gz: b6b7a13e36b3d7ac633bb3c1af28954eb62aca19
+SHA512:
+  metadata.gz: 9bd2443af1b3f3dc489c244c88e5709a5c03e7cae4dd17f55c260522f2fd22ce25a9f8fd4b418a80e7f4517683c362272e09692496932ed4805795aefef6a276
+  data.tar.gz: 043fff7e93088cbb9dd263d9ca47505f45d2143a1f41384f846156e9c5b7d4c525f152a1c59d22544b30f3a96517c9a3f632ceb1d02625e99718419c753898b4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.14.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Loic Kartono
+
+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,79 @@
+# Asserter
+
+Lightweight permissions asserter for Ruby applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asserter', git: 'https://github.com/wamland-team/asserter'
+```
+
+Use Bundler to install the dependency:
+
+    $ bundle install
+
+## Usage
+
+Asserter is intended to be a lightweight and flexible way to grant permissions to
+a given subject (a.k.a model/class). It imposes very few requirements on your application.
+
+To get started add a `permissions` method to your class. This method must returns an array of permissions associated with that
+subject. Once you have this method, include the `Asserter::Model` module in
+your class to add the `permits?` method.
+
+An example implementation is:
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  include Asserter::Model
+
+  def permissions
+    permissions.flat_map { |p| p[:name] }
+  end
+end
+```
+
+With this in place, a `Subject` can have a permission check performed, for
+example:
+
+```ruby
+class PartnersController < ApplicationController
+  def index
+    fail('Not allowed') unless current_user.permits?('wamadmin.partners.*.index')
+  end
+
+  def current_user
+    @current_user ||= User.find(session[:user_id])
+  end
+end
+```
+
+## Permission
+
+A permission is made of one or more colon-separated parts that
+describe the action being permitted. Each part of the permission can be
+either a wildcard (`*`), or a "term" of characters `a-z A-Z 0-9 _ -`
+
+A wildcard in any position will match a single term in that position. A wildcard
+in the last position will match any number of terms in the action string.
+
+| permission            | action                   | result |
+|-----------------------|--------------------------|--------|
+| `wamadmin`            | `wamadmin`               | permit |
+| `wamadmin`            | `gamelles`               | deny   |
+| `wamadmin.users.show` | `wamadmin.users.show`    | permit |
+| `wamadmin.users.show` | `wamadmin.users.create`  | deny   |
+| `*.users.index`       | `wamadmin.users.index`   | permit |
+| `wamadmin.users.*`    | `wamadmin.users.destroy` | permit |
+| `wamadmin.*`          | `wamadmin.users.update`  | permit |
+| `*.create`            | `wamadmin.users.create`  | deny   |
+| `*`                   | `wamadmin.users.create`  | permit |
+| `wamadmin.users.*`    | `wamadmin.login`         | deny   |
+| `wamadmin.*.*`        | `wamadmin.login`         | deny   |
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wamland-team/asserter.

data/Rakefile

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

data/asserter.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asserter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'asserter'
+  spec.version       = Asserter::VERSION
+  spec.authors       = ['Loic Kartono']
+  spec.email         = ['kartono.loic@gmail.com']
+  spec.summary       = 'Lightweight permissions asserter for Ruby applications'
+  spec.description   = 'Lightweight permissions asserter for Ruby and Rails applications'
+  spec.homepage      = 'https://github.com/wamland-team/asserter'
+  spec.license       = 'MIT'
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.47.1'
+end

data/bin/console

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

@@ -0,0 +1,8 @@
+require 'asserter/version'
+
+module Asserter
+  # Your code goes here...
+end
+
+require 'asserter/permission'
+require 'asserter/model'

data/lib/asserter/model.rb

@@ -0,0 +1,15 @@
+module Asserter
+  module Model
+    # Valid an action against an
+    # ActiveRecord object permissions.
+    #
+    # ==== Parameters
+    # * <tt>action</tt> - Action to validate.
+    #
+    # ==== Returns
+    # * <tt>Boolean</tt> - True if granted, false otherwise.
+    def permit?(action)
+      permissions.map { |p| Permission.new(p) }.any? { |p| p.permit?(action) }
+    end
+  end
+end

data/lib/asserter/permission.rb

@@ -0,0 +1,37 @@
+module Asserter
+  class Permission
+    # Initialize a new permission.
+    #
+    # ==== Parameters
+    # * <tt>permission</tt> - Permission
+    #
+    # ==== Returns
+    # * <tt>Asserter::Permission</tt> - New instance.
+    def initialize(permission)
+      @permission_terms = permission.split('.')
+    end
+
+    # Validate a permission against an action.
+    # Check each terms of a given permission against
+    # each terms of a given action and compare them.
+    #
+    # If one of the permission's terms contains a
+    # wildcard (*), we don't compare it and skip
+    # to the next iteration.
+    #
+    # ==== Parameters
+    # * <tt>action</tt> - Action to validate.
+    #
+    # ==== Returns
+    # * <tt>Boolean</tt> - True if permission by pass action.
+    def permit?(action)
+      action_terms = action.split('.', @permission_terms.length)
+      return false if action_terms.length != @permission_terms.length
+
+      @permission_terms.zip(action_terms).each do |p_term, a_term|
+        next if p_term == '*'
+        return false if p_term != a_term
+      end
+    end
+  end
+end

data/lib/asserter/version.rb

@@ -0,0 +1,3 @@
+module Asserter
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: asserter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Loic Kartono
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-09 00:00:00.000000000 Z
+dependencies:
+- !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: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+description: Lightweight permissions asserter for Ruby and Rails applications
+email:
+- kartono.loic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- asserter.gemspec
+- bin/console
+- bin/setup
+- lib/asserter.rb
+- lib/asserter/model.rb
+- lib/asserter/permission.rb
+- lib/asserter/version.rb
+homepage: https://github.com/wamland-team/asserter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Lightweight permissions asserter for Ruby applications
+test_files: []