permitify 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09b2f7016c9a20bb934a496d04dd1579dc3e414e
+  data.tar.gz: 65b2a894614e2214a823bc795ebd995e5d013d04
+SHA512:
+  metadata.gz: 025155f7704abf00ba91541e78b15ecb4cfac6dd17d22cb2766cff3089ab6ab83d6af243e87e1d5f0b168fb2bc0d511087000f18f09ab9caf42d98ff560ae1ec
+  data.tar.gz: e77eb0cf875ff7326063394ea87ee7ecbe2cf1e782efa4cffb18abdc0c194967764af0c220d7b7fd79f7911701c4ee7cb642f955fce0a95abcea06153b562f57

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Wyatt Kirby
+
+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,41 @@
+# Permitify
+
+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/permitify`. 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 'permitify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install permitify
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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`. 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]/permitify.
+
+
+## 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,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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "permitify"
+
+# 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,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/permitify.rb

@@ -0,0 +1,19 @@
+require "permitify/version"
+require "permitify/configure"
+require "permitify/permission"
+require "permitify/resource"
+require "permitify/railtie"
+require "permitify/exceptions"
+require "permitify/utils"
+
+module Permitify
+  extend Configure
+
+  def permitify
+    include Permission
+  end
+
+  def permitify_resource
+    include Resource
+  end
+end

data/lib/permitify/configure.rb

@@ -0,0 +1,35 @@
+module Permitify
+  module Configure
+    @@permissions = {}
+    @@roles = []
+    @@permissions_file = "permissions.yml"
+
+    def configure
+      yield self if block_given?
+    end
+
+    def permissions
+      @@permissions
+    end
+
+    def permissions=(value)
+      @@permissions = value
+    end
+
+    def roles
+      @@roles
+    end
+
+    def roles=(value)
+      @@roles = value
+    end
+
+    def permissions_file
+      @@permissions_file
+    end
+
+    def permissions_file=(value)
+      @@permissions_file = value
+    end
+  end
+end

data/lib/permitify/exceptions.rb

@@ -0,0 +1,5 @@
+module Permitify
+  module Exceptions
+    class InvalidRoleException < StandardError; end
+  end
+end

data/lib/permitify/permission.rb

@@ -0,0 +1,60 @@
+module Permitify
+  module Permission
+    extend ActiveSupport::Concern
+
+    def has_permission?(permission, resource = nil)
+      applicable_roles = self.role_symbols(permission).select do |r|
+        self.has_role?(r, resource) || self.has_role?(r, resource.class)
+      end
+
+      Permitify::Utils.permissions_for_roles(applicable_roles).include?(permission)
+    end
+    alias :can? :has_permission?
+
+    def add_role(role_name, resource = nil)
+      Permitify::Utils.validate_role(role_name)
+      super
+    end
+
+    def role_symbols(permission)
+      self.roles.pluck(:name).map(&:to_sym)
+    end
+
+    def method_missing(method_sym, *args, &block)
+      if method_sym.to_s.match(/^(\w+)_for_permission$/)
+        self.class.define_dynamic_permission_scope(method_sym, $1)
+        send(method_sym, args.first)
+      else
+        super
+      end
+    end
+
+    class_methods do
+      def with_permission(permission, resource = nil)
+        role_names = Permitify::Utils.roles_for_permission(permission)
+        users = []
+
+        role_names.each do |role|
+          users_to_add = self.with_role(role, resource)
+          users = users_to_add if users.empty?
+          users = users_to_add.or(users) unless users.empty?
+        end
+
+        return users.distinct
+      end
+      alias :with_permissions :with_permission
+
+      def define_dynamic_permission_scope(method_sym, class_sym)
+        class_eval do
+          define_method(method_sym) do |permission|
+            klass = class_sym.to_s.classify.constantize rescue nil
+
+            if klass.present? && klass.respond_to?(:with_permission)
+              klass.with_permission(permission, self)
+            end
+          end unless method_defined?(method_sym)
+        end
+      end
+    end
+  end
+end

data/lib/permitify/railtie.rb

@@ -0,0 +1,28 @@
+require 'permitify'
+require 'rails'
+
+module Permitify
+  class Railtie < Rails::Railtie
+    initializer 'permitify.initialize' do
+
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :extend, Permitify
+      end
+
+      config.before_initialize do
+        roles = YAML.load_file(Rails.root.join('config/', Permitify.permissions_file))["roles"]
+
+        if roles.present?
+          # Convert Permission Strings to Symbols
+          permissions = roles.inject({}) do |result, (role, perms)|
+            result[role] = perms.map(&:to_sym)
+            result
+          end
+
+          Permitify.roles = roles.keys.map(&:to_sym)
+          Permitify.permissions = permissions.with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/lib/permitify/resource.rb

@@ -0,0 +1,19 @@
+module Permitify
+  module Resource
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def with_permission(permission, user = nil)
+        role_names = Permitify::Utils.roles_for_permission(permission)
+        self.with_role(role_names, user)
+      end
+      alias :with_permissions :with_permission
+
+      def without_permission(permission, user = nil)
+        role_names = Permitify::Utils.roles_for_permission(permission)
+        self.without_role(role_names, user)
+      end
+      alias :without_permissions :without_permission
+    end
+  end
+end

data/lib/permitify/utils.rb

@@ -0,0 +1,20 @@
+module Permitify
+  class Utils
+    def self.roles_for_permission(permissions)
+      permissions = Array.wrap(permissions)
+      Permitify.permissions.select {|r, p| (p & permissions).present? }.keys
+    end
+
+    def self.permissions_for_roles(roles)
+      Array.wrap(roles).map do |role|
+        Permitify.permissions[role]
+      end.flatten
+    end
+
+    def self.validate_role(role)
+      unless Permitify.roles.include?(role)
+        raise Exceptions::InvalidRoleException.new "Invalid Role: #{role}"
+      end
+    end
+  end
+end

data/lib/permitify/version.rb

@@ -0,0 +1,3 @@
+module Permitify
+  VERSION = "1.0.0"
+end

data/permitify.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'permitify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "permitify"
+  spec.version       = Permitify::VERSION
+  spec.authors       = ["Wyatt Kirby"]
+  spec.email         = ["wyatt@apsis.io"]
+
+  spec.summary       = %q{A ruby gem for adding permissions to rolify.}
+  spec.homepage      = "http://apsis.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: permitify
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Wyatt Kirby
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: 
+email:
+- wyatt@apsis.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/permitify.rb
+- lib/permitify/configure.rb
+- lib/permitify/exceptions.rb
+- lib/permitify/permission.rb
+- lib/permitify/railtie.rb
+- lib/permitify/resource.rb
+- lib/permitify/utils.rb
+- lib/permitify/version.rb
+- permitify.gemspec
+homepage: http://apsis.io
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby gem for adding permissions to rolify.
+test_files: []