know_it_all 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4550ab98d97e3e526452bbf3e1b7e8dd22bbe8ed
-  data.tar.gz: 707163abb17202e76a11f7fb7edf4b17438bd57d
+  metadata.gz: c46f9fbd69adcd8eadf7d3d031481dd83de48472
+  data.tar.gz: af4a0c6556ce92b9df6280f20c1a4714d7781f14
 SHA512:
-  metadata.gz: c4a86f9030e144126720a63363418073bd8837db9b2ab2e42426d25a7c459cf83b034bc6f62a44940680058ae990f559f5ea7991b35bf23b0acc50c71b308919
-  data.tar.gz: 3be9fcdaa02b1de4ddbcdc752e8f0639a0656c0c73edf9d5420302e0cde436a517429f6cd78d14af458ec1e32dca0ceefd97527373b1fac39dd23714526529f5
+  metadata.gz: f6945101bdd7bafbf8238bca9fabe2127dd3aabc05c04a6a2d36027df6a5336ee93a03a8db3f37f9531b01a1c2eb269e3297ab01f9b1131cc9c169e8c2820e22
+  data.tar.gz: a22ded0ff92288e55146880f9470271f8a0c319b1465778befded1fd95e4a2af97c525d516812deea444b92e770499483dc0a75a2b7026500ba30ebaa4696113

data/README.md

@@ -8,6 +8,27 @@ More of an architectural pattern for API-focused authorization than properly a d
 
 If your application needs to validate pre-requisites before performing certain actions, at the same time providing helpful error messages for the API's clients, all that while using regular magic-less Ruby and object oriented design patterns, KnowItAll is your friend.
 
+Table of Contents
+=================
+
+  * [KnowItAll](#knowitall)
+    * [Why?](#why)
+    * [Why not just Pundit?](#why-not-just-pundit)
+    * [Installation](#installation)
+    * [Usage](#usage)
+      * [Creating policies](#creating-policies)
+        * [Naming convention](#naming-convention)
+        * [Helper class](#helper-class)
+      * [Using policies](#using-policies)
+        * [What happens when not authorized](#what-happens-when-not-authorized)
+        * [Querying authorizations in the view](#querying-authorizations-in-the-view)
+        * [Avoiding conflicts in the controller](#avoiding-conflicts-in-the-controller)
+        * [Overrides](#overrides)
+    * [Enforcing authorization checks](#enforcing-authorization-checks)
+    * [Development](#development)
+    * [Contributing](#contributing)
+    * [License](#license)
+
 ## Why?
 
 The assumption made is that each action has its own requirements based on the current context. Some may be related to the current user's permissions in the system, others with the parameters sent, and others yet may even have nothing to do with any input received. Let's say you're building the API for a food delivery app. To be able to checkout, you need to validate the following requirements:
@@ -68,6 +89,10 @@ end
 
 That's exactly the architectural pattern encouraged by this gem. By including a small set of helpers, it makes it extremely simple to perform complex validations and provide helpful feedback through the API.
 
+## Why not just Pundit?
+
+Pundit is great! I've been using it for years and I love it, but its model-focused permissions and structural pattern makes it difficult and awkward to perform validations on scenarios that need multiple arguments and show appropriate error messages for the API's clients. Based on modifications I've made when using Pundit in some projects, I created this gem.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -125,7 +150,7 @@ Using `ActiveModel::Validations`:
 ```ruby
 module OrdersPolicies
   class Create
-    includes ActiveModel::Validations
+    include ActiveModel::Validations
 
     validates_presence_of :current_user, :address
     validate :address_in_range
@@ -208,7 +233,7 @@ end
 
 #### What happens when not authorized
 
-The `authorize` method raises a `KnowItAll::NotAuthorized` exception in case the authorization has failed, and contains the instance of the policy used to perform the validation:
+The `authorize!` method raises a `KnowItAll::NotAuthorized` exception in case the authorization has failed, and contains the instance of the policy used to perform the validation:
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -228,7 +253,7 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-Alternatively, you can use the bangless form of the authorization method (`authorize`), which doesn't raise an exception and return an array of errors:
+Alternatively, you can use the bangless form of the authorization method (`authorize`), which doesn't raise an exception and returns the errors in the policy:
 
 ```ruby
 class OrdersController < ApplicationController
@@ -277,7 +302,7 @@ Then use it in your views, passing the appropriate overrides (more about that he
 
 #### Avoiding conflicts in the controller
 
-It's possible that you're already using methods with the same names as the ones in the `KnowItAll` module: `authorize`, `authorized?`, `authorize!`, `policy`, `policy_class`, `policy_name`, `render_not_authorized` or `verify_authorized`. In that case, the solution is to include the module in another class, and use it as a collaborator. The only methods `KnowItAll` needs to find the correct policies are `controller_path` and `action_name`:
+It's possible that you're already using methods with the same names as the ones in the `KnowItAll` module: `authorize`, `authorize?`, `authorize!`, `policy`, `policy_class`, `policy_name`, `render_not_authorized` or `verify_authorized`. In that case, the solution is to include the module in another class, and use it as a collaborator. The only methods `KnowItAll` needs to find the correct policies are `controller_path` and `action_name`:
 
 ```ruby
 class Authorizer
@@ -370,7 +395,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/know_it_all. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrodrigues/know_it_all. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/know_it_all/base.rb

@@ -1,12 +1,15 @@
 module KnowItAll
   class Base
+    def self.validations
+      @validations ||= {}
+    end
+
     def self.assert(method_name, message)
-      @@validations ||= {}
-      @@validations[method_name] = message
+      validations[method_name] = message
     end
 
     def errors
-      @@validations.each
+      self.class.validations.each
         .select { |method_name, _| !self.send(method_name) }
         .map { |_, message| message }
     end

data/lib/know_it_all/version.rb

@@ -1,3 +1,3 @@
 module KnowItAll
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: know_it_all
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - mrodrigues
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -140,3 +140,4 @@ signing_key:
 specification_version: 4
 summary: OO authorization for APIs
 test_files: []
+has_rdoc: