flexible_permissions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e7958a77bb44a097cd42940e17ce51c95643829
+  data.tar.gz: 224b4e8da1d047c3d7e598bdfbbbfb341135399d
+SHA512:
+  metadata.gz: 674c7c6deeedf9251f212438c7b6c76347b55f1f3e554e9aa095db93ad542c613c3ccb6f8d8da91cf001e8d1c13b33501ca929cae0cb3f41beaa8e0a5fc09d04
+  data.tar.gz: 91cc301f74360440ee8cec2ef3084c1694380c6150f2fea2b000c3cfea1cbfa1c063980710273593fa77bce154a5836f9e25f0a84ecdd6aa0fb5bf79aaec66e5

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vasilakisfil@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Filippos Vasilakis
+
+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,177 @@
+# FlexiblePermissions
+
+*At the moment this gem is tied to ActiveRecord but it's easy to change that
+by overriding default permitted methods for fields and resource*
+
+For building APIs (and not only) I have been using [Pundit](https://github.com/elabs/pundit) gem for years.
+It's an awesome gem.
+However there is a tiny issue: Pundit has a black and white policy whereas in
+APIs usually you need a grayscale. The user might have access to a specific
+resource/action, but only in certain attributes of that resource.
+
+An explanation can be found in some parts of
+[this](http://slides.com/vasilakisfil/apis-on-ruby-and-rails#) presentation, [a pundig issue](https://github.com/elabs/pundit/issues/212#issuecomment-64049328)
+and [this blog post](http://slides.com/vasilakisfil/apis-on-ruby-and-rails#/).
+
+## So what this gem does?
+This gem allows you to specify in an easy way the following properties of a resource
+based on the user role:
+
+* default attributes of a resource
+* permitted attributes of a resource (superset of default attributes)
+* default associations of resource
+* permitted associations of resource
+
+You filter the associations based on the name of the association found.
+However the gem provides you an easy way to map any attributes/associations to
+the ones you have defined in your API/serializer.
+
+Note that this gem works perfectly well with [Pundit](https://github.com/elabs/pundit)
+but [Pundit](https://github.com/elabs/pundit) is not a requirement to use `flexible_permissions`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flexible_permissions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flexible_permissions
+
+## Usage
+
+So let's say that we have a `User` resource in our API that we want to allow
+different representations based on the current user role: Guest user,
+Regular user and Admin user.
+
+Here is how a pundit policy looks like:
+
+```ruby
+class UserPolicy < ApplicationPolicy
+  #allows only Admin and Regular roles, returns only Regular permissions
+  (given that the endpoint to create a user does not require authentication)
+  def create?
+    return Regular.new(record)
+  end
+
+  #allows all roles but with different permissions
+  def show?
+    return Guest.new(record) unless user
+    return Admin.new(record) if user.admin?
+    return Regular.new(record)
+  end
+
+  #allows only Admin and Regular roles, each with different permissions
+  def update?
+    raise Pundit::NotAuthorizedError unless user
+    return Admin.new(record) if user.admin?
+    return Regular.new(record)
+  end
+
+  #allows only Admin and Regular roles, each with different permissions
+  def destroy?
+    raise Pundit::NotAuthorizedError unless user
+    return Admin.new(record) if user.admin?
+    return Regular.new(record)
+  end
+
+  class Scope < Scope
+    def resolve
+      return Guest.new(record, User) unless user
+      return Admin.new(scope, User) if user.admin?
+      return Regular.new(scope, User)
+    end
+  end
+
+  #admin has access to everything, plus, some extra fields
+  class Admin < FlexiblePermissions::Base
+    class Fields < self::Fields
+      def permitted
+        super + [
+          :links, :following_state, :follower_state
+        ]
+      end
+    end
+
+    class Includes < self::Includes
+      #our API has `following` but our API exposes `followings`
+      def transformations
+        {following: :followings}
+      end
+    end
+  end
+
+  #we chop fields for regular user (but we still keep admins extra fields)
+  class Regular < Admin
+    class Fields < self::Fields
+      def permitted
+        super - [
+          :activated, :activated_at, :activation_digest, :admin,
+          :password_digest, :remember_digest, :reset_digest, :reset_sent_at,
+          :token, :updated_at,
+        ]
+      end
+    end
+  end
+
+  #and we chop even more for a guest
+  class Guest < Regular
+    class Fields < self::Fields
+      def permitted
+        super - [:following_state, :follower_state]
+      end
+    end
+  end
+end
+```
+
+For each role class you have 2 embedded classes:
+* `Fields` that sets up what fields (attributes) are allowed for this specific role
+* `Includes` that sets up what related resources (associations) are allowed for this specific role
+
+For each of those 2 classes, you can setup the final allowed attributes using the following methods:
+* `#permitted` speciffies the permitted attributes
+* `#defaults` specifies the defaults attributes (a subset of permitted attributes)
+* `#transformations` specifies any transformations from the db level to the API level
+
+If you have pundit, you can get the allowed attributes in your controller using the
+`authorize_with_permissions` method which uses underhood pundit's authorize method
+
+After that you get an object back that has the following methods:
+* `fields` returns the underrelying record
+* `includes` returns the underrelying record
+* `record` returns the underrelying record that you passed in to authorize
+* `collection` returns the underlying collection that you passed in to authorize
+
+Protip: `collection` is aliased to `record`.
+
+```ruby
+  def show
+    auth_user = authorize_with_permissions(@user)
+
+    render jsonapi: auth_user.record, serializer: Api::V1::UserSerializer,
+      fields: {user: auth_user.fields.concat(params[:fields])}
+  end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/vasilakisfil/flexible_permissions. 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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flexible_permissions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flexible_permissions"
+  spec.version       = FlexiblePermissions::VERSION
+  spec.authors       = ["Filippos Vasilakis"]
+  spec.email         = ["vasilakisfil@gmail.com"]
+
+  spec.summary       = %q{Removes black and white pundit policy and adds flexible permissions for attributes/associations per role class. Perfect for modern APIs.}
+  spec.description   = %q{Removes black and white pundit policy and adds flexible permissions for attributes/associations per role class. Perfect for modern APIs.}
+  spec.homepage      = "https://github.com/vasilakisfil/flexible-permissions"
+  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"
+end

data/lib/flexible_permissions.rb

@@ -0,0 +1,7 @@
+require "flexible_permissions/version"
+require "flexible_permissions/modules"
+require "flexible_permissions/base"
+
+if defined?(Pundit)
+  require "flexible_permissions/pundit"
+end

data/lib/flexible_permissions/base.rb

@@ -0,0 +1,19 @@
+module FlexiblePermissions
+  class Base
+    include RoleMethods
+
+    class Fields
+      include SparsedFieldMethods
+    end
+
+    class Includes
+      include SparsedIncludeMethods
+    end
+
+    #for AMS basically...
+    def expects_include_fields_in_fields
+      true
+    end
+  end
+end
+

data/lib/flexible_permissions/modules.rb

@@ -0,0 +1,96 @@
+module FlexiblePermissions
+  module RoleMethods
+    attr_reader :record, :model
+
+    def initialize(record, model = nil)
+      @record = record
+      @model = model || record.class
+    end
+
+    def fields(asked = nil)
+      self.class::Fields.new(asked, record, model).resolve.concat(
+        expects_include_fields_in_fields ? includes : []
+      )
+    end
+
+    def includes(asked = nil)
+      self.class::Includes.new(asked, record, model).resolve
+    end
+
+    def collection
+      record
+    end
+
+    def expects_include_fields_in_fields
+      false
+    end
+  end
+
+  module SparsedMethods
+    attr_reader :resolve, :model, :record, :asked
+    def initialize(asked, record, model)
+      @model = model
+      @asked = asked
+      @record = record
+    end
+
+    def resolve
+      return with_transformations(defaults) if asked.blank?
+
+      with_transformations(union(permitted, asked))
+    end
+
+    private
+      def with_transformations(attributes)
+        return attributes if transformations.blank?
+
+        attributes.map{|x|
+          transformations[x] ? transformations[x] : x
+        }.flatten
+      end
+
+      def transformations
+        {}
+      end
+
+      def permitted
+        []
+      end
+
+      def defaults
+        permitted
+      end
+
+      def union(permitted, asked = nil)
+        return permitted unless asked.is_a?(Array)
+
+        permitted.map(&:to_sym) & asked.map(&:to_sym)
+      end
+
+      def collection?
+        record.kind_of? ActiveRecord::Relation
+      end
+
+      def resource?
+        !collection?
+      end
+  end
+
+  module SparsedFieldMethods
+    include SparsedMethods
+
+    private
+      def permitted
+        model.attribute_names.map(&:to_sym)
+      end
+  end
+
+  module SparsedIncludeMethods
+    include SparsedMethods
+
+    private
+      def permitted
+        model.reflect_on_all_associations.map(&:name).map(&:to_sym)
+      end
+  end
+end

data/lib/flexible_permissions/pundit.rb

@@ -0,0 +1,18 @@
+module AuthorizeWithReturn
+  def authorize_with_permissions(record, query=nil)
+    query ||= params[:action].to_s + '?'
+    @_pundit_policy_authorized = true
+
+    policy = policy(record)
+    policy.public_send(query)
+  end
+
+  def included
+    super
+    hide_action :authorize
+  end
+end
+
+module Pundit
+  prepend AuthorizeWithReturn
+end

data/lib/flexible_permissions/version.rb

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: flexible_permissions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Filippos Vasilakis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-04 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'
+description: Removes black and white pundit policy and adds flexible permissions for
+  attributes/associations per role class. Perfect for modern APIs.
+email:
+- vasilakisfil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flexible_permissions.gemspec
+- lib/flexible_permissions.rb
+- lib/flexible_permissions/base.rb
+- lib/flexible_permissions/modules.rb
+- lib/flexible_permissions/pundit.rb
+- lib/flexible_permissions/version.rb
+homepage: https://github.com/vasilakisfil/flexible-permissions
+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: Removes black and white pundit policy and adds flexible permissions for attributes/associations
+  per role class. Perfect for modern APIs.
+test_files: []