restrictable 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 969f8567c8227e78dc650f40a293e7a54ebb39c7
-  data.tar.gz: 27fb0fc8542cf77db1fa2527bdc338135cb853ef
+  metadata.gz: 4c8208242de6b87d41a20b85f107913548642805
+  data.tar.gz: 265842a4d9ecb1026a058cc3e0c4df78d897a293
 SHA512:
-  metadata.gz: 83cb0b8e79b2ddbb4df8d49c182681b52dfbc464ed7e76f1ffce89c455d8a87379744781d2b918abcc1a5f4153cd01821b83387effad1ece6ad16c9684593556
-  data.tar.gz: 8a47780c6654d3e6a2bd2ee47f512a2deb41e343f81b3eccec8572301ab19f15504f5dda4e41fca6809dac626dca95365df739958370a3cdec115a44b62201ab
+  metadata.gz: 2156e01bdfd9c5a2c7c926288be8777a92ac352bcdd0138c193a87fa0e730a22e1ca9f6fc38778880425ba9d9a4e4d5fe4c186fda9963f442cd9ab25d39ab0fd
+  data.tar.gz: c2db2735d82afffc8e96c4b064b57e7e203ac35ba3efdb25b1687bc9fabbcbd138b7a1ef89b007db20949c25a153b4df0ecafc48fc477261adf15b2e3fd9a381

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    restrictable (0.1.2)
+    restrictable (0.1.3)
       activesupport (~> 5.0)
       railties (~> 5.0)
 

data/README.md

@@ -1,5 +1,7 @@
 # Restrictable
 
+[![Gem Version](https://badge.fury.io/rb/restrictable.svg)](https://badge.fury.io/rb/restrictable)
+
 Manage authorization restrictions on Ruby on Rails with [Devise](https://github.com/plataformatec/devise).
 Ideal for controlling actions of 2 or 3 types of users.
 
@@ -53,7 +55,7 @@ end
 And now you can take advantage of the simple controller methods:
 
 ```ruby
-class BuyOrdersController < ApplicationController
+class PostsController < ApplicationController
   only_allow :admin, to: :destroy
   prevent :guest, to: [:create, :update]
 
@@ -70,7 +72,55 @@ end
 
 ## Advanced Usage
 
-TODO: Add the complete usage method overrides and configurations.
+Additionally you can match your implementation with `Restrictable` simply overriding controller methods. You can do this on the `ApplicationController` level or in your Controller.
+
+#### Example of use:
+
+```ruby
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+  before_action :authenticate_user!
+
+  # `on_forbidden_action` is called when a user role doesn't have 
+  # permission to access the controller method.
+  def on_forbidden_action
+    head :forbidden
+  end
+
+  # `should_prevent?(role)` is used to check when a role should be
+  # prevented.
+  # Called by the `prevent` helper and should return a boolean value.
+  def should_prevent?(role)
+    current_user.role == role
+  end
+
+  # `should_only_allow?(role)` is used to check when a role should be
+  # allowed.
+  # Called by the `only_allow` helper and should return a boolean value.
+  def should_only_allow?(role)
+    current_user.role != role
+  end
+end
+```
+
+For example, if we want to implement `Restrictable` on an application that already have implemented users roles with the model `Seller` with devise and the attribute `responsability`. Our controller will be something like this:
+
+```ruby
+class SellersController < ApplicationController
+  only_allow :national_seller, to: :delete
+  prevent :local_seller, to: :new, :update
+
+  def should_prevent?(role)
+    @seller.responsability == role
+  end
+
+  def should_only_allow?(role)
+    @seller.responsability != role
+  end
+
+  # ...
+end
+```
 
 ## Development
 
@@ -80,7 +130,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Roadmap
 
-TODO: Add a roadmap.
+- [x] Controller helpers
+- [x] Controller override methods
+- [ ] View helpers
+- [ ] Review flexibility on implementation
 
 ## Contributing
 

data/lib/restrictable/version.rb

@@ -1,3 +1,3 @@
 module Restrictable
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/restrictable.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Simple authorization gem for Ruby on Rails.}
   spec.description   = %q{Manage authorization restrictions on Ruby on Rails. Ideal for controlling actions of 2 or 3 types of users.}
-  spec.homepage      = ""
+  spec.homepage      = "http://github.com/rejonpardenilla/restrictable"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restrictable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Daniel Rejon Pardenilla
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-04 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,7 +102,7 @@ files:
 - lib/restrictable/railtie.rb
 - lib/restrictable/version.rb
 - restrictable.gemspec
-homepage: ''
+homepage: http://github.com/rejonpardenilla/restrictable
 licenses:
 - MIT
 metadata: