ratify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cebc395d3d5455371bcf40a2b097824d2fbf140504ceb819c47bf14dd3073a9
+  data.tar.gz: 70546ffb22562b86524567219f50a838b9af387ce5f3d9a8c21848347fdf7e27
+SHA512:
+  metadata.gz: 9853b5ffeb4911df6ffa060e6c705b19f5fa201d0877991393e164e3645a815fe084a24ad54d886bb3399e8f84f38ebc63fe0170a8b6aa9d686c8e4f4deb0d75
+  data.tar.gz: 2e4c8c4d4923eab0a19934cfaf65c6c22b68e933f8cc2ba855bf2663257c79ffbac7638c5d0cddcb4a5fda77132288a062cff91ec1634b36d318e2901cefb8a0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-version
+/.ruby-gemset
+/.idea/

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ratify.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    ratify (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  ratify!
+  yard (~> 0.9.12)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Travis Haynes
+
+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,91 @@
+# Ratify
+
+An easy to use, zero-dependency authorization gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ratify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ratify
+
+## Usage
+
+Here's an example of how you can use Ratify for basic user permissions.
+
+```ruby
+class User
+  attr_accessor :admin
+
+  def initialize(admin: false)
+    @admin = admin
+  end
+  
+  def admin?
+    admin && true  
+  end
+end
+
+class Record
+  include Ratify
+ 
+  # Admins have full access to the records.
+  permit User, :create, :update, if: :admin?
+  
+  # Users can create new records.
+  permit User, :create
+  
+  # Users can update and destroy their own records.
+  permit User, :update, :destroy, if: -> (user) { self.user == user }
+
+  attr_accessor :user
+
+  def initialize(user)
+    @user = user  
+  end
+end
+
+admin = User.new(admin: true)
+user1 = User.new
+user2 = User.new
+record = Record.new(user: user1)
+
+record.permits?(admin, :create) # => true
+record.permits?(user1, :update) # => true
+record.permits?(user2, :destroy) # => false
+
+Record.permits?(admin, :create) # => true
+Record.permits?(user1, :create) # => true
+Record.permits?(user2, :create) # => true
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/hi5dev/ratify.
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://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/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ratify'
+require 'irb'
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/ratify.rb

@@ -0,0 +1,72 @@
+# Provides permissions to any object that it is included in.
+#
+# @example Basic usage
+#   class User
+#     attr_accessor :role
+#   end
+#
+#   class Record
+#     include Ratify
+#
+#     permit User, :create, if: -> { role == :admin }
+#   end
+#
+#   user = User.new
+#   Record.permit?(user, :create) # => false
+#
+#   user.role = :admin
+#   Record.permit?(user, :create) # => true
+module Ratify
+  autoload :Permission, 'ratify/permission'
+  autoload :VERSION, 'ratify/version'
+
+  # The methods in this module are added to the object's class methods when
+  # {Ratify} is included.
+  module ClassMethods
+    # All of the permissions for the object.
+    #
+    # @return [Array<Permission>] List of permissions.
+    def permissions
+      @permissions ||= []
+    end
+
+    # Creates a new permission for the object.
+    #
+    # @example Basic usage
+    #   include Ratify
+    #   permit User, :create, :read, :update, :destroy, if: :admin?
+    #
+    # @return [Array<Permission>] All of the permissions after they're updated.
+    def permit(object, *actions, **conditions)
+      permissions << Permission.new(object, *actions, **conditions)
+    end
+
+    # Checks if the given object is allowed to perform the requested action(s).
+    #
+    # @param [Object] object The object requesting the action(s).
+    # @param [*Symbol] actions The action(s) being requested.
+    # @param [Object] scope The scope of permissible object.
+    # @return [true | false] Whether or not the object is permitted.
+    def permits?(object, *actions, scope: nil)
+      permissions.any? { |m| m.permits?(object, *actions, scope: scope) }
+    end
+  end
+
+  # Called when the object is included in a class.
+  #
+  # @!visibility private
+  # @param [Class] klass The class {Ratify} is being included in.
+  # @return [void]
+  def self.included(klass)
+    klass.extend(Ratify::ClassMethods)
+  end
+
+  # Checks the permissions on an instance level.
+  #
+  # @param [Object] object The object requesting the action(s).
+  # @param [*Symbol] actions The actions being requested.
+  # @return [true | false] Whether or not the obejct is permitted.
+  def permits?(object, *actions)
+    self.class.permits?(object, *actions, scope: self)
+  end
+end

data/lib/ratify/permission.rb

@@ -0,0 +1,71 @@
+# @!visibility private
+class Permission
+  attr_reader :object, :actions, :conditions
+
+  # @param [Object] object
+  # @param [*Symbol] actions
+  # @param [**Hash] conditions
+  # @return [Permission] New instance of {Permission}.
+  def initialize(object, *actions, **conditions)
+    @object = object
+    @actions = actions
+    @conditions = conditions
+  end
+
+  # @param [Object] object
+  # @param [*Symbol] actions
+  # @param [Object] scope
+  # @return [true | false] Whether or not the object is permitted.
+  def permits?(object, *actions, scope: nil)
+    object_matches?(object) &&
+    action_matches?(actions) &&
+    conditions_match?(object, scope, actions)
+  end
+
+  private
+
+  # @param [Array<Symbol>] actions
+  # @return [true | false] If the given actions are all in the permission.
+  def action_matches?(actions)
+    actions.all? { |action| self.actions.include?(action) }
+  end
+
+  # @param [Symbol] name
+  # @param [Proc | Symbol | Object] condition
+  # @param [Object] object
+  # @param [Object] scope
+  # @param [Array<Symbol>] actions
+  # @return [true | false] Whether or not the condition matches the permission.
+  def condition_matches?(name, condition, object, scope, actions)
+    match = case condition
+    when Proc then scope.instance_exec(object, *actions, &condition)
+    when Symbol then scope.send(condition)
+    else scope.send(name) == condition
+    end
+
+    name == :unless ? !match : match && true
+  end
+
+  # @param [Object] object
+  # @param [Object] scope
+  # @param [Array<Symbol>] actions
+  # @return [true | false] Whether or not all of the conditions match.
+  def conditions_match?(object, scope, actions)
+    conditions.empty? || conditions.all? do |name, condition|
+      condition_matches?(name, condition, object, scope, actions)
+    end
+  end
+
+  # @return [Constant] The object as a constant.
+  def object_as_constant
+    return unless object.is_a?(String) || object.is_a?(Symbol)
+
+    Object.const_get(object) rescue nil
+  end
+
+  # @param [Object] object
+  # @return [true | false] Whether or not the object matches.
+  def object_matches?(object)
+    self.object === object || object_as_constant === object
+  end
+end

data/lib/ratify/version.rb

@@ -0,0 +1,4 @@
+module Ratify
+  # The gem's semantic version.
+  VERSION = '0.1.0'
+end

data/ratify.gemspec

@@ -0,0 +1,29 @@
+($: << File.expand_path('lib', __dir__)).uniq!
+
+require 'ratify/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ratify'
+  spec.version = Ratify::VERSION
+  spec.authors = ['Travis Haynes']
+  spec.email = ['travis@hi5dev.com']
+  spec.summary = 'Zero-dependency authorization gem.'
+  spec.license = 'MIT'
+
+  spec.bindir = 'exe'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(test)/})
+  end
+
+  spec.executables = spec.files.grep(%r{^#{spec.bindir}/}) do |file|
+    File.basename(file)
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'yard', '~> 0.9.12'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ratify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Travis Haynes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+description: 
+email:
+- travis@hi5dev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ratify.rb
+- lib/ratify/permission.rb
+- lib/ratify/version.rb
+- ratify.gemspec
+homepage: 
+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.3
+signing_key: 
+specification_version: 4
+summary: Zero-dependency authorization gem.
+test_files: []