discretion 0.4.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b39ae6911fe8a0aa3da936ad083d93c346af721
+  data.tar.gz: 5e34a6059f263690d797e97455777ad7a01cc4ed
+SHA512:
+  metadata.gz: b50620eef4fe55b2117695f3aace6a6cb9311d277b7210cc4af07d043947af8b4dbb5b192bc60e505909a433cfce8c5167261c13c778ec7f99b3f70632d87d4e
+  data.tar.gz: 98118e6239097bad701fd7de80641eec0f3ebccb6f973bd556e40213fee71aba20b4b00e186f3747e493f883de20d63395517e3ab6693495263a5062ed30c5c3

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 codeclimbcoffee@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Abe Land
+
+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,196 @@
+# Discretion
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'discretion'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install discretion
+
+## Usage
+
+(Please note that currently (and for the foreseeable future), Discretion only works with ActiveRecord)
+
+
+### High Level Idea
+
+The idea is simple: we colocate the read and write policies with the model definitions themselves by defining `can_see?(viewer)` and optionally `can_write?(viewer)`. The semantics are straightforward: given a `viewer` (typically a `User` but can be anything you want -- more on this below), can that viewer see the record encapsulated by the model class?
+
+For example, let's say we have a web app for a large non-profit organization which has staff who have to raise money from donors. So we might have models like `Donor`, `Staff`, and `Donation`s. Below we will describe how we would set up authorization/privacy policies for these models using Discretion.
+
+### Opt-In
+
+Discretion uses an Opt-In strategy: you must tell discretion which models should use discretion. To do this, you use the `use_discretion` directive in your model definition. When you do this, you **must** then define a `can_see?(viewer)` method. It can have any visibility (private, protected, or public). So, continuing with our running example of a non-profit organization with `Donor`s, `Staff`, and `Donation`s, we might start with some basic privacy policies like this:
+
+```ruby
+class Staff < ApplicationRecord
+  use_discretion
+
+  ...
+  
+  private
+  
+  def can_see?(viewer)
+    # Only Staff of the organization can see Staff members.
+    viewer.is_a?(Staff)
+  end
+```
+
+```ruby
+class Donor < ApplicationRecord
+  use_discretion
+  
+  ...
+  
+  def can_see?(viewer)
+    # Only the Donor herself or Staff of the organization can see the Donor.
+    viewer == self || viewer.is_a?(Staff)
+  end
+```
+
+```ruby
+class Donation < ApplicationRecord
+  use_discretion
+  
+  belongs_to :donor
+  belongs_to :recipient, class_name: 'Staff', foreign_key: 'staff_id'
+  
+  ...
+  
+  def can_see?(viewer)
+    # Only the Donor for the donation or the Staff recipient of the donation can see the Donation.
+    viewer == donor || viewer == recipient
+  end
+end
+```
+
+### Write policies
+
+You can optionally distinguish write policies from read policies. If you don't, then Discretion will assume that if the current viewer `can_see?` the record, that it `can_write?` it as well. So we might edit our running example to only allow the recipient of a `Donation` to edit it (i.e. the recipient staff member recording donations):
+
+```ruby
+class Donation < ApplicationRecord
+  use_discretion
+  
+  belongs_to :donor
+  belongs_to :recipient, class_name: 'Staff', foreign_key: 'staff_id'
+  
+  ...
+  
+  def can_see?(viewer)
+    # Only the Donor for the donation or the Staff recipient of the donation can see the Donation.
+    viewer == donor || viewer == recipient
+  end
+  
+  def can_write?(viewer)
+    # Only the recipient can edit the donation.
+    viewer == recipient
+  end
+end
+```
+
+### Wait what's the `viewer` object though?
+
+You decide. Since `viewer` is given as an argument to `can_see?` and `can_write?`, it's really for you to help you write privacy/authorization policies without having to store the current viewer elsewhere. Discretion exposes two helper methods for setting and retrieving the current `viewer`, and there is no expectation about what kind of object it is. For example, if you set the `current_user` in your base `ApplicationController` class, you could do something like this:
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :set_discretion_current_user
+  
+  def current_user
+    # I use RequestStore instead of static variables as the latter could persist across requests depending on the server.
+    RequestStore[:current_user] ||= current_user_from_cookies
+  end
+
+  private
+  
+  def current_user_from_cookies
+    ... fetch user from session cookies ...
+  end
+  
+  def set_discretion_current_user
+    Discretion.set_current_viewer(current_user)
+  end
+```
+
+If you want to retrieve that anywhere later (you may never have to), you can do so by `Discretion.get_current_viewer`.
+
+### Middleware
+
+Discretion has a Railtie which adds a middleware which sets the `current_viewer` from [Clearance](https://github.com/thoughtbot/clearance) (I use Clearance). I **might** add functionality to detect the current user from other authentication frameworks in the future. In the meantime, you can add your own middleware to set the `current_viewer` in Discretion, looking something like this:
+
+```ruby
+module MyApp
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Discretion.set_current_viewer(current_user_from_some_other_source)
+      @app.call(env)
+    end
+  end
+end
+```
+
+Again, if you use [Clearance](https://github.com/thoughtbot/clearance), you shouldn't have to do anything and `current_viewer` will be set from the `env[:clearance].current_user` value (exposed by Clearance's middleware) in Discretion's middleware.
+
+### But what about roles and such?
+
+Discretion's scope is focused and limited to privacy/authorization. It's a **non-goal** of this project to handle enumeration of roles or permissions or ACLs on actual objects with respect to other objects. There are other gems which do this well. I personally like [Rolify](https://github.com/RolifyCommunity/rolify), and Rolify can be used with Discretion in very nifty ways. Continuing our non-profit organization example, we can use Rolify to create an `admin` role for Staff members, and allow admins of the organization as well as recipients of a donation to edit `Doantion`s:
+
+```ruby
+class Organization < ApplicationRecord
+  has_many :donations
+end
+
+...
+
+class Donation < ApplicationRecord
+  use_discretion
+  
+  belongs_to :organization
+  belongs_to :donor
+  belongs_to :recipient, class_name: 'Staff', foreign_key: 'staff_id'
+  
+  ...
+  
+  def can_see?(viewer)
+    # Only the Donor for the donation or the Staff recipient of the donation can see the Donation.
+    viewer == donor || viewer == recipient || viewer.has_role?(:admin, organization) # <- rolify in third disjunct
+  end
+  
+  def can_write?(viewer)
+    # Only the recipient can edit the donation.
+    viewer == recipient || viewer.has_role?(:admin, organization) # <- rolify in second disjunct
+  end
+end
+```
+
+### Querying for and writing records
+
+Discretion is totally opaque and should not require any changes in how you query for or write records. That is, you can just query for things normally using `find`, `where`, `limit`, etc. You can also `create`/`update`/`destroy`/`delete` records as you normally would, and Discretion will check your `can_see?` and `can_write?` policies for all of these actions.
+
+## 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/abeland/discretion.
+
+## 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 "discretion"
+
+# 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/discretion.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'discretion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'discretion'
+  spec.version       = Discretion::VERSION
+  spec.authors       = ['Abe Land']
+  spec.email         = ['codeclimbcoffee@gmail.com']
+
+  spec.summary       = 'A simple privacy/authorization framework for Rails projects.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/abeland/discretion'
+  spec.license       = 'MIT'
+
+  spec.add_dependency 'rails', '~>5'
+  spec.add_dependency 'request_store', '~>1.3'
+  spec.required_ruby_version = '>= 2.2.2'
+
+  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.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/discretion.rb

@@ -0,0 +1,11 @@
+require 'discretion/can'
+require 'discretion/current_viewer'
+require 'discretion/discreet_model'
+require 'discretion/errors'
+require 'discretion/helpers'
+require 'discretion/meta'
+require 'discretion/middleware'
+require 'discretion/railtie'
+require 'discretion/version'
+
+ActiveRecord::Base.send(:include, Discretion::Meta) if defined?(ActiveRecord)

data/lib/discretion/can.rb

@@ -0,0 +1,25 @@
+module Discretion
+  class << self
+    def can_see_record?(viewer, record)
+      return true unless record.is_a?(Discretion::DiscreetModel)
+
+      record.send(:can_see?, viewer)
+    end
+
+    def current_viewer_can_see_record?(record)
+      can_see_record?(Discretion.current_viewer, record)
+    end
+
+    def can_write_record?(viewer, record)
+      return true unless record.is_a?(Discretion::DiscreetModel)
+
+      record.respond_to?(:can_write?, true) ?
+        record.send(:can_write?, viewer) :
+        can_see_record?(viewer, record)
+    end
+
+    def current_viewer_can_write_record?(record)
+      can_write_record?(Discretion.current_viewer, record)
+    end
+  end
+end

data/lib/discretion/current_viewer.rb

@@ -0,0 +1,13 @@
+module Discretion
+  class << self
+    CURRENT_VIEWER_KEY = :__discretion_current_viewer
+
+    def current_viewer
+      RequestStore[CURRENT_VIEWER_KEY]
+    end
+
+    def set_current_viewer(current_viewer)
+      RequestStore[CURRENT_VIEWER_KEY] = current_viewer
+    end
+  end
+end

data/lib/discretion/discreet_model.rb

@@ -0,0 +1,15 @@
+module Discretion
+  module DiscreetModel
+    extend ActiveSupport::Concern
+
+    included do
+      after_initialize do |record|
+        raise Discretion::CannotSeeError unless Discretion.current_viewer_can_see_record?(record)
+      end
+
+      before_save do |record|
+        raise Discretion::CannotWriteError unless Discretion.current_viewer_can_write_record?(record)
+      end
+    end
+  end
+end

data/lib/discretion/errors.rb

@@ -0,0 +1,4 @@
+module Discretion
+  class CannotSeeError < StandardError; end
+  class CannotWriteError < StandardError; end
+end

data/lib/discretion/helpers.rb

@@ -0,0 +1,19 @@
+module Discretion
+  class << self
+    def in_console?
+      defined?(Rails::Console).present?
+    end
+
+    def in_test?
+      Rails.env.test?
+    end
+
+    def can_see_records?(viewer, *records)
+      records.all? { |record| Discretion.can_see_record?(viewer, record) }
+    end
+
+    def can_write_records?(viewer, *records)
+      records.all? { |record| Discretion.can_write_record?(viewer, record) }
+    end
+  end
+end

data/lib/discretion/meta.rb

@@ -0,0 +1,11 @@
+module Discretion
+  module Meta
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def use_discretion
+        include Discretion::DiscreetModel
+      end
+    end
+  end
+end

data/lib/discretion/middleware.rb

@@ -0,0 +1,15 @@
+module Discretion
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      # From Clearance
+      if env[:clearance]&.signed_in?
+        Discretion.set_current_viewer(env[:clearance].current_user)
+      end
+      @app.call(env)
+    end
+  end
+end

data/lib/discretion/railtie.rb

@@ -0,0 +1,12 @@
+module Discretion
+  class Railtie < ::Rails::Railtie
+    initializer 'discretion.insert_middleware' do |app|
+      if defined?(Clearance::RackSession)
+        app.config.middleware.insert_after(
+          Clearance::RackSession,
+          Discretion::Middleware,
+        )
+      end
+    end
+  end
+end

data/lib/discretion/version.rb

@@ -0,0 +1,3 @@
+module Discretion
+  VERSION = '0.4.0.pre.alpha'.freeze
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: discretion
+version: !ruby/object:Gem::Version
+  version: 0.4.0.pre.alpha
+platform: ruby
+authors:
+- Abe Land
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: A simple privacy/authorization framework for Rails projects.
+email:
+- codeclimbcoffee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- discretion.gemspec
+- lib/discretion.rb
+- lib/discretion/can.rb
+- lib/discretion/current_viewer.rb
+- lib/discretion/discreet_model.rb
+- lib/discretion/errors.rb
+- lib/discretion/helpers.rb
+- lib/discretion/meta.rb
+- lib/discretion/middleware.rb
+- lib/discretion/railtie.rb
+- lib/discretion/version.rb
+homepage: https://github.com/abeland/discretion
+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.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A simple privacy/authorization framework for Rails projects.
+test_files: []