passpartu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 864b7f8444aadbd01311482d1863c2c0438e11ac73db3bd041f39fc7f06e84b4
+  data.tar.gz: d59e1e169c073738cb8848d29db04ee01496dba9cfea4aa9b06b920ad0bb7ed0
+SHA512:
+  metadata.gz: cfa6bc3c9f6a45e7b9f77242629b1220e4047ba675af31c601450c0470ea222c76177c93c01911928850a3180d25c123b0d86c1f03f3c2f6e05114d18b4d5b17
+  data.tar.gz: 7504541590f2eae641150f526e5499ce15aa69c6ad9bec2713cf1cc169d45ed3ce002aeaa3de169c8f09ff86ac7b3d6c7b344a6675013c2da60281091720f6f4

data/README.md

@@ -0,0 +1,113 @@
+# Passpartu
+
+Passpartu makes policies great again (works awesome with Pundit).
+
+Instead of this:
+```ruby
+class PostPolicy < ApplicationPolicy
+  def update?
+    user.super_admin? || user.admin? || user.manager? || user.supervisor?
+  end
+end
+```
+
+just this:
+```ruby
+class PostPolicy < ApplicationPolicy
+  def update?
+    user.can?(:post, :update)
+  end
+end
+```
+## Usage
+Include `Passpartu` into your policy model.
+```ruby
+class User
+  include Passpartu
+end
+```
+NOTE: Your `User` model must respond to `role` method that returns a string or a symbol!
+
+Keep all your policies in one place.
+Create `./config/passpartu.yml` and start writing your policies.
+
+#### Example
+```yml
+# ./config/passpartu.yml
+
+admin:
+  post:
+    create: false
+    update: true
+    delete: true 
+  order:
+    create: true
+    edit: true
+    delete: true
+  product:
+    create: false
+    edit: true
+    delete: true  
+manager:
+  order:
+    create: true
+    edit: true
+    delete: false
+  product:
+    create: true
+    edit: true
+    delete: false
+
+```
+
+
+## Configuration
+
+You can configure Doorman by creating `./config/initializers/passpartu.rb`.
+
+#### Default configs are:
+
+```ruby
+Passpartu.configure do |config|
+  config.policy_file = './config/passpartu.yml'
+  config.raise_policy_missed_error = true
+end
+```
+### Raise policy missed errors
+By default Passpartu will raise an error if policy is missed in `passpartu.yml`. Set `config.raise_policy_missed_error = false` in order to return `false` in case when policy is not defined. This is a good approach to write only "positive" policies (only true) and automatically restricts everything that is not mentioned in `passpartu.yml`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'passpartu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install passpartu
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/OrestF/passpartu. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Doorman project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/OrestF/passpartu/blob/master/CODE_OF_CONDUCT.md).

data/lib/passpartu.rb

@@ -0,0 +1,49 @@
+require 'passpartu/version'
+require 'yaml'
+require 'byebug'
+require_relative 'passpartu/patcher'
+require_relative 'passpartu/verify'
+require_relative 'passpartu/validate_result'
+require_relative 'passpartu/user' # for testing only
+
+module Passpartu
+  class Error < StandardError; end
+
+  def self.included(policy_class)
+    Passpartu::Patcher.call(policy_class)
+  end
+
+  def self.policy
+    config.policy
+  end
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield(config)
+  end
+
+  class Config
+    attr_accessor :policy, :raise_policy_missed_error
+    attr_reader :policy_file
+
+    def initialize
+      @policy_file = './config/passpartu.yml'
+      @policy = YAML.load_file(policy_file)
+      @raise_policy_missed_error = true
+    end
+
+    def policy_file=(file = nil)
+      @policy_file = file || './config/passpartu.yml'
+      @policy = YAML.load_file(policy_file)
+    end
+  end
+
+  configure {}
+end
+
+initializer = './config/initializers/passpartu.rb'
+require initializer if File.exist?(initializer)

data/lib/passpartu/patcher.rb

@@ -0,0 +1,22 @@
+require 'byebug'
+
+module Passpartu
+  class Patcher
+    attr_reader :klass
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def self.call(klass)
+      new(klass).call
+    end
+
+    def call
+      klass.class_eval do
+        define_method('can?') do |*keys|
+          Passpartu::Verify.call(role, keys)
+        end
+      end
+    end
+  end
+end

data/lib/passpartu/user.rb

@@ -0,0 +1,19 @@
+# for testing only
+
+module Passpartu
+  class User
+    attr_reader :role
+
+    def initialize(role)
+      @role = role
+    end
+  end
+
+  class Person
+    attr_reader :role
+
+    def initialize(role)
+      @role = role
+    end
+  end
+end

data/lib/passpartu/validate_result.rb

@@ -0,0 +1,33 @@
+# require 'byebug'
+
+module Passpartu
+  class ValidateResult
+    class PolicyMissedError < StandardError; end
+
+    attr_reader :result
+    def initialize(result)
+      @result = result
+    end
+
+    def self.call(result)
+      new(result).call
+    end
+
+    def call
+      raise PolicyMissedError if raise_error?
+      return false unless boolean?
+
+      result
+    end
+
+    private
+
+    def boolean?
+      [TrueClass, FalseClass].include?(result.class)
+    end
+
+    def raise_error?
+      !boolean? && Passpartu.config.raise_policy_missed_error
+    end
+  end
+end

data/lib/passpartu/verify.rb

@@ -0,0 +1,19 @@
+# require 'byebug'
+
+module Passpartu
+  class Verify
+    attr_reader :role, :keys
+    def initialize(role, keys)
+      @role = role
+      @keys = keys.map(&:to_s)
+    end
+
+    def self.call(role, keys)
+      new(role, keys).call
+    end
+
+    def call
+      Passpartu::ValidateResult.call(Passpartu.policy.dig(role.to_s, *keys))
+    end
+  end
+end

data/lib/passpartu/version.rb

@@ -0,0 +1,3 @@
+module Passpartu
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: passpartu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OrestF
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Passpartu is a great tool to manage your policies. \n
+                          Keep all your policy rules in one file - doorman.yml. \n
+                          And ask user not about it's role, but about it's permissions
+email:
+- falchuko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/passpartu.rb
+- lib/passpartu/patcher.rb
+- lib/passpartu/user.rb
+- lib/passpartu/validate_result.rb
+- lib/passpartu/verify.rb
+- lib/passpartu/version.rb
+homepage: https://github.com/OrestF/passpartu
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Passpartu makes policies great again
+test_files: []