four_eyes 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 144c62f42d4650a3ef5a4894cbcb0e2ac728e78e
-  data.tar.gz: 338ed6f1367d8104d38ad10657cd9ad18609013e
+  metadata.gz: 50fdcf432e727f3c0b6f2a78ce41868b5988aad4
+  data.tar.gz: 15663bb4f542714eadb56fa44c19e5b05bca28dc
 SHA512:
-  metadata.gz: 0012d1d26e754304085e751c0497d03e2762f140f6a1320b681b8aa9f030e653192b1c2acded7059fbe80538518b8af989e7a609945581041bb70217ea1f316d
-  data.tar.gz: 582281c8a1cb15469682a5546ddca7ea27bc2fc98c0d84d447386658b01743ef0bce8bbb9e1fefb9e7ae676ecac989cd711fdaa3e9e826c290d014552f0cd68e
+  metadata.gz: 5053d22ef3d8fa86cd48b2ff9ba935598f1a649fa9a64f0bb398c2b4c9323dafdcf4152df52e9d6200f7575a111e262cdbeeac8b87097d94d1f58ff230522855
+  data.tar.gz: 7407011253cbf4f0f9d5b4161677ac46600682884941c25a45d265705fc148f4f4296ba0dd9f076911b0853dd6025621e0767c6ad57406c6af2349c83ff73fca

data/README.md

@@ -20,9 +20,9 @@ responsible for performing the validation check to see if the resource is indeed
 the system state may change before authorization to a state that renders the action invalid. In such a scenario, the action 
 would need to be cancelled and created again.
 
-A listing of all pending actions can be availed and depending on any authorization mechanisim that you have implemented, a user can then access a pending 
+A listing of all pending actions can be availed and depending on any authorization mechanism that you have implemented, a user can then access a pending 
 action and authorize it.
-
+       
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -66,12 +66,12 @@ To add maker checker functionality, add the following before_filter to the contr
   
    Once that is done, in the create, update or delete action you would call the following
    
-       maker_create([User resource performaing the action],
+       maker_create([User resource performing the action],
                          [ID of resource performing the action],
                          [Class name of the resource being worked on],
                          [Parameters of oject/resource in JSON format])  
    
-   For exeample, in a system where the users are called Administrators, and the resource we are trying to create via
+   For example, in a system where the users are called Administrators, and the resource we are trying to create via
    maker checker is a Student, the call to create a student via maker-checker would look like this.
    
    
@@ -96,7 +96,26 @@ To add maker checker functionality, add the following before_filter to the contr
                      student.to_json)
      end
      
-   where in the example above, the call has the following format
+   Minimal vies have been provided for viewing pending and authorized actions. You will probably want to override these
+   and style them accordingly to your application. 
+   
+   Please note four_ayes is agnostic for the type of authorization system you are using. Right now the only check that is performed is 
+   ensuring that the maker of an action cannot be the same person to authorize an action. You can extend this to your own authorization
+   system. For example using CanCan you can have something like this for a certain role:
+   
+   
+   
+       class AdminAbility
+         include CanCan::Ability
+         
+         def initialize(admin)
+           admin ||= Administrator.new
+           if admin.role? :Manager
+             can :authorize, FourEyes::Action, object_resource_class_name: %w(Student Teacher)
+             can :cancel, FourEyes::Action
+           end
+         end
+       end 
 
 ## TODO - Write spec tests.
 

data/lib/four_eyes/version.rb

@@ -1,3 +1,3 @@
 module FourEyes
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: four_eyes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dennis Ondeng