ratify 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cebc395d3d5455371bcf40a2b097824d2fbf140504ceb819c47bf14dd3073a9
-  data.tar.gz: 70546ffb22562b86524567219f50a838b9af387ce5f3d9a8c21848347fdf7e27
+  metadata.gz: 6125cbd00b941e2729093dc320915ecccc5e884b2ec81e71e3c4c1ff2c1b179e
+  data.tar.gz: df8189df02387d8290f636255acb95307dbec7bb7e8709b30daa10c4801327eb
 SHA512:
-  metadata.gz: 9853b5ffeb4911df6ffa060e6c705b19f5fa201d0877991393e164e3645a815fe084a24ad54d886bb3399e8f84f38ebc63fe0170a8b6aa9d686c8e4f4deb0d75
-  data.tar.gz: 2e4c8c4d4923eab0a19934cfaf65c6c22b68e933f8cc2ba855bf2663257c79ffbac7638c5d0cddcb4a5fda77132288a062cff91ec1634b36d318e2901cefb8a0
+  metadata.gz: 3dbcf2a8831078a41e74c4473c2cf81c70c0f01ab568483fdee4cd977c4eb81a4b4b2a4b64013fac6470efeeb0a996d9ffc9777d578807f0e0e74e0e77fbf712
+  data.tar.gz: 293148aeef71b3da92207141d9abf61e945062b317a2d11c31bb7cc9c383613e1284478122e9e5f10aaf2d7aba980daf4c03f5d3bb16bf747248e73ea127fbeb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ratify (0.1.0)
+    ratify (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,73 +1,69 @@
 # Ratify
 
-An easy to use, zero-dependency authorization gem.
+Ratify is a very fast, easy to use, zero-dependency Ruby authorization gem.
+Simply include the `Ratify` module in your class to give it permissions. You 
+can check the permissions on a class or instance level with the `permit?` 
+method.
 
-## Installation
+Ratify makes as few assumptions about your authorization stragegy as possible.
+It knows only that you have one object that needs permission to be accessed  
+by another object. You can optionally provide a list of actions and/or 
+conditions as well.
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'ratify'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ratify
-
-## Usage
-
-Here's an example of how you can use Ratify for basic user permissions.
+Here's a very simple user-authorization example:
 
 ```ruby
 class User
   attr_accessor :admin
-
-  def initialize(admin: false)
-    @admin = admin
-  end
-  
-  def admin?
-    admin && true  
-  end
 end
 
 class Record
   include Ratify
- 
-  # Admins have full access to the records.
-  permit User, :create, :update, if: :admin?
   
-  # Users can create new records.
-  permit User, :create
+  attr_accessor :published, :user
+  
+  # Admins have full access to any record.
+  permit :User, :full_access, if: -> (user) { user.admin }
+  
+  # Users have full access to their own records.
+  permit :User, :full_access, if: -> (user) { self.user == user }
+  
+  # Signed in users can create new records.
+  permit :User, :create
   
-  # Users can update and destroy their own records.
-  permit User, :update, :destroy, if: -> (user) { self.user == user }
+  # Signed out users can read published records.
+  permit nil, :read, if: :published
+end
+```
 
-  attr_accessor :user
+The permissions can be read at a class-level:
 
-  def initialize(user)
-    @user = user  
-  end
-end
+```ruby
+Record.permit?(current_user, :create)
+```
 
-admin = User.new(admin: true)
-user1 = User.new
-user2 = User.new
-record = Record.new(user: user1)
+or on an instance-level:
 
-record.permits?(admin, :create) # => true
-record.permits?(user1, :update) # => true
-record.permits?(user2, :destroy) # => false
+```ruby
+record.permit?(current_user, :update)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
 
-Record.permits?(admin, :create) # => true
-Record.permits?(user1, :create) # => true
-Record.permits?(user2, :create) # => true
+```ruby
+gem 'ratify'
 ```
 
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ratify
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then,

data/lib/ratify/permission.rb

@@ -27,6 +27,8 @@ class Permission
   # @param [Array<Symbol>] actions
   # @return [true | false] If the given actions are all in the permission.
   def action_matches?(actions)
+    self.actions.include?(:full_access) ||
+
     actions.all? { |action| self.actions.include?(action) }
   end
 

data/lib/ratify/version.rb

@@ -1,4 +1,4 @@
 module Ratify
   # The gem's semantic version.
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ratify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Travis Haynes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler