kant 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0b65ae77365d3fb81725cb1dad2634d25b51640
-  data.tar.gz: dac368c947e0ab658ce42dbc0570214d218dbec5
+  metadata.gz: 4405afa9ea78fb2fcee60f09c4f31521626ae1b1
+  data.tar.gz: b337033ed3ecc3119602b260a0c9aff1c14013ed
 SHA512:
-  metadata.gz: 4a6684cc5fbbe9d9a90a8b14aa7c32b75dfc112eac379630c383646679f9cf0588e932057ad0eb585a2ea6ec7108287342cf73ca458aacad83cc8d82d3338628
-  data.tar.gz: bd2b8391077f3f7ec7b13b03375bf6e4310fe9f57ff3dc957a9be82785cfc2f786a575f35f216eefc0c27a61a3372496d9d2dfa728b063ed911cff30e8362caa
+  metadata.gz: 6fed5522437eab76c2d21f814ebbeeaa472acdc11605ae95ab109e756a3d31d1f52330d63577d0baa6506ca3b08a8da853458a39d9e20d555c1fe6ef2e850b31
+  data.tar.gz: 1440cbd44f47d426e31832e65eaa21a7cbf439042ea17328808273b9a5bc97fed20a46b4a6e9425195541ec1e0c549a3173ed2c52c5293f2e2484ccf4b05a4b8

data/README.md

@@ -1,4 +1,4 @@
-# Kant v0.0.3
+# Kant v0.0.4
 
 Kant is a tiny authorization library for your Ruby (especially Rails and/or
 ActiveRecord) projects.

data/lib/kant/policy_access.rb

@@ -37,12 +37,12 @@ module Kant
     #
     #   ability.accessible(:read, Content)
     #   # => a Content scope
-    def accessible(action, scope)
+    def accessible(action, scope, *rest)
       abilities = resolve_scope(scope)
       _scope_method = scope_method(abilities, action)
 
       if _scope_method
-        abilities.send(_scope_method, scope, user)
+        abilities.send(_scope_method, scope, user, *rest)
       else
         scope.none
       end

data/lib/kant/version.rb

@@ -1,3 +1,3 @@
 module Kant
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/kant/policy_access_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'kant/policy_access'
+require 'kant/access_denied'
 
 describe Kant::PolicyAccess do
   setup_models
@@ -99,6 +100,7 @@ describe Kant::PolicyAccess do
 
   describe "#accessible" do
     let(:user) { User.create!(email: 'foo@bar.com') }
+    let(:another_user) { User.create!(email: 'foo@baz.com') }
     subject(:policy_access) { Kant::PolicyAccess.new(user) }
 
     it "delegates to a Policy module" do
@@ -130,6 +132,94 @@ describe Kant::PolicyAccess do
 
       expect(policy_access.accessible(:read, Todo)).to eq(Todo.none)
     end
+
+    # The motivation here is that, when performing authorization for "index"
+    # actions, this often involves some context. For example, the user might be
+    # listing all the todos under a particular project (GET /projects/1/todos).
+    # In a lot of cases it might be possible to define an ActiveRecord or SQL
+    # query that describes what records the user can access regardless of
+    # context, but in some cases this might result in a very complicated query.
+    # (Unfortunately, the example below really doesn't really do the motivation
+    # justice.)
+    #
+    # Imagine instead that a user can normally only access their own User
+    # record (the check being `user == me`). However, when the user is part of
+    # a project they can also see other users in the company that the project
+    # is a part of. (For example, so that they can send a DM to a user.)
+    #
+    # - Company
+    #   - has many Projects
+    #     - has many Users
+    #
+    # Imagine what the query would look like to return all the users I can
+    # message...
+    #
+    #     def self.readable_for_messaging(users, me)
+    #       my_companies = Company.joins(:projects).merge(me.projects)
+    #       my_companies_projects = Project.joins(:company).merge(my_companies)
+    #       my_companies_users = User.joins(:projects).merge(my_companies_projects)
+    #       users.merge(my_companies_users)
+    #     end
+    #
+    # Some notes here:
+    #
+    # 1. This honestly isn't such a gross example, in production this logic can
+    #    get much, much worse.
+    # 2. Even so, you can see it gets pretty complicated.
+    # 3. In practice what we have to do after all this is query the resulting
+    #    scope for users in a particular company... which means more gross queries.
+    #
+    # Instead, by having extra params in the *able function, we can specify a
+    # context (typically this will probably match the shape of the endpoint, so
+    # if your endpoint is /companies/1/users then your *able function will
+    # probably take an extra `companies:` param).
+    #
+    #     def self.readable_for_messaging(users, me, company:)
+    #       my_companies = Company.joins(:projects).merge(me.projects)
+    #       if !my_companies.where(id: company.id).any?
+    #         fail Kant::AccessDenied, "no access"
+    #       end
+    #
+    #       users.joins(:projects).where(projects: { company_id: company.id })
+    #     end
+    it "passes along other params to the *able method" do
+      # module TodoPolicy
+      #   def self.readable_as_owner(todos, user, project:)
+      #     if project.owner_id == user.id
+      #       todos.where(project_id: project_id, completed: true)
+      #     else
+      #       fail Kant::AccessDenied, "user does not have access to this project"
+      #     end
+      #   end
+      # end
+      todo_policy = Class.new do
+        define_singleton_method(:readable_as_owner) do |todos, user, project:|
+          if project.owner_id == user.id
+            todos.where(project_id: project.id, completed: true)
+          else
+            fail Kant::AccessDenied, "user does not have access to this project"
+          end
+        end
+      end
+
+      stub_const("TodoPolicy", todo_policy)
+
+      my_project = Project.create!(owner: user)
+      another_project = Project.create!(owner: another_user)
+      my_complete_todo = Todo.create!(project: my_project, completed: true)
+      my_incomplete_todo = Todo.create!(project: my_project, completed: false)
+      another_complete_todo = Todo.create!(project: another_project, completed: true)
+
+      expect{
+        policy_access.accessible(:read_as_owner, Todo)
+      }.to raise_error(ArgumentError)
+
+      expect(policy_access.accessible(:read_as_owner, Todo, project: my_project)).to eq([my_complete_todo])
+
+      expect{
+        policy_access.accessible(:read_as_owner, Todo, project: another_project)
+      }.to raise_error(Kant::AccessDenied)
+    end
   end
 
   describe "the policies_module option in initializer" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kant
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mark Przepiora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler