active_entry 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22965fa52ab633ba26b494ec4d4e75d9b21d3a0daa4274b38a4369c7af1d8a90
-  data.tar.gz: 9e06a922ddf9421f6e5355498af672e125c87a476b92f622d506363083f4bd02
+  metadata.gz: ab6abb6cb8a8069912d414cd395c1b57ee8327152f60ff9808db387eae70d3e2
+  data.tar.gz: 48cf2369782b109f88208be35553075d253d78bd45151e5ca1c9e634143f8433
 SHA512:
-  metadata.gz: 047a796891e8faca672e58b0dba5fe1b1cf06494880abc40411ee4f58aa9d24bb47d275c33ded3184b0884fbe71f78de263d4c1e7383b879601b7fcd4c717d41
-  data.tar.gz: 5e08a364e44dd87a8b9dfcb8923f2675e95ce7d75cb30b7439aa57fb325df81236cc0cb8760beb32bfaee69d2c46ba9a30454b0e896d443ac27ef1c1b13aecd2
+  metadata.gz: f65b2eb50012c246c91c98df7ef238de33ff1469893e611a58eea569843d9ec45bfe79099afc1f94e2bfe898a20d9e70fdb0678b190fde9f63dcf5051590e248
+  data.tar.gz: 3f2b4ba32b292375292fa3e7c9c040de2cbb8d812f206b6c27e52fe7eb9da0013a5de6ae49c1052467fa07e5a83f73a4fc450b426963fbe74e14ef04ce231edf

data/README.md

@@ -1,6 +1,15 @@
-[<img src="active_entry_logo.png" alt="Active Entry Logo" width="250px"/>](https://github.com/TFM-Agency/active_entry)
-
-# Active Entry - Simple and flexible authentication and authorization [![Ruby](https://github.com/TFM-Agency/active_entry/actions/workflows/ci-rspec.yml/badge.svg)](https://github.com/TFM-Agency/active_entry/actions/workflows/ci-rspec.yml)
+<p align="center">
+  <a href="https://github.com/TFM-Agency/active_entry">
+    <img src="https://raw.githubusercontent.com/TFM-Agency/active_entry/main/active_entry_logo.svg" alt="Active Entry Logo" width="350px"/>
+  </a>
+</p>
+
+# Active Entry - Simple and flexible authentication and authorization
+[![Gem Version](https://badge.fury.io/rb/active_entry.svg)](https://badge.fury.io/rb/active_entry)
+[![Ruby](https://github.com/TFM-Agency/active_entry/actions/workflows/ci-rspec.yml/badge.svg)](https://github.com/TFM-Agency/active_entry/actions/workflows/ci-rspec.yml)
+![Coverage](https://raw.githubusercontent.com/TFM-Agency/active_entry/main/coverage/coverage_badge_total.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3db0f653be6bdfe0fdac/maintainability)](https://codeclimate.com/github/TFM-Agency/active_entry/maintainability)
+[![Documentation](https://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://rubydoc.info/github/TFM-Agency/active_entry/main)
 
 Active Entry is a simple and secure authentication and authorization system for your Rails application, which lets you to authenticate and authorize directly in your controllers.
 
@@ -75,8 +84,8 @@ Now you just have to catch this error and react accordingly. Rails has the conve
 class ApplicationController < ActionController::Base
   # ...
 
-  rescue_from ActiveEntry::NotAuthenticatedError, with: :not_authenticated
-  rescue_from ActiveEntry::NotAuthorizedError, with: :not_authorized
+  rescue_from ActiveEntry::NotAuthenticatedError, with: :not_authenticated unless Rails.env.test?
+  rescue_from ActiveEntry::NotAuthorizedError, with: :not_authorized unless Rails.env.test?
 
   private
 
@@ -134,6 +143,8 @@ The are some more helpers that check for more than one RESTful action:
  * `update_action?` - If something will be updated. Actions: `edit`, `update`
  * `destroy_action?` - If something will be destroyed. Action: `destroy`
  * `delete_action?` - Alias for `destroy_action?`. Action: `destroy`
+ * `collection_action?` - If the called action is a collection action. Actions: `index`, `new`, `create`
+ * `member_action?` - Everything that is not a collection action. Including non-RESTful actions.
 
 So you can for example do:
 
@@ -206,6 +217,60 @@ class ApplicationController < ActionController::Base
   end
 end
 ```
+## Testing authentication and authorization
+If you check for the Rails environment with `unless Rails.env.test?` in your `rescue_from` statement you can easily test your authentication and authorization in your tests.
+
+```ruby
+class ApplicationController < ActionController::Base
+  # ...
+  rescue_from ActiveEntry::NotAuthenticatedError, with: :not_authenticated unless Rails.env.test?
+  rescue_from ActiveEntry::NotAuthorizedError, with: :not_authorized unless Rails.env.test?
+  # ...
+end
+```
+
+Now you can catch `ActiveEntry::NotAuthenticatedError` / `ActiveEntry::NotAuthorizedError` in your test site like this:
+
+```ruby
+require "rails_helper"
+
+RSpec.describe "Users", type: :request do
+  describe "Authentication" do
+    context "#index" do
+      context "authenticated" do
+        it "as signed in user" do
+          sign_in_as user
+          expect{ get users_path }.to_not raise_error ActiveEntry::NotAuthenticatedError
+        end
+      end
+
+      context "not authenticated" do
+        it "as stranger" do
+          expect{ get users_path }.to raise_error ActiveEntry::NotAuthenticatedError
+        end
+      end
+    end
+  end
+
+  describe "Authorization" do
+    context "#index" do
+      context "authorized" do
+        it "as admin" do
+          sign_in_as admin
+          expect{ get users_path }.to_not raise_error ActiveEntry::NotAuthorizedError
+        end
+      end
+
+      context "not authenticated" do
+        it "as non-admin" do
+          sign_in_as user
+          expect{ get users_path }.to raise_error ActiveEntry::NotAuthorizedError
+        end
+      end
+    end
+  end
+end
+```
 
 ## Contributing
 Create pull requests on Github and help us to improve this Gem. There are some guidelines to follow:
@@ -215,4 +280,4 @@ Create pull requests on Github and help us to improve this Gem. There are some g
  * Document methods that aren't self-explaining (we are using [YARD](http://yardoc.org/))
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/active_entry/controller_methods.rb

@@ -3,6 +3,7 @@
 # Helper methods for your controller
 # to identify RESTful actions.
 module ActiveEntry
+  # @!visibility private
   def method_missing method_name, *args
     method_name_str = method_name.to_s
     
@@ -79,4 +80,20 @@ module ActiveEntry
     action_name == 'destroy'
   end
   alias delete_action? destroy_action?
+
+  # @return [Boolean]
+  #    True if called action
+  #    is index, new or create.
+  def collection_action?
+    action_name == 'index' ||
+    action_name == 'new' ||
+    action_name == 'create'
+  end
+  
+  # @return [Boolean]
+  #    True if called action
+  #    is not a collection action.
+  def member_action?
+    !collection_action?
+  end
 end

data/lib/active_entry/version.rb

@@ -1,3 +1,3 @@
 module ActiveEntry
-  VERSION = '1.2.3'
+  VERSION = '1.2.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_entry
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - TFM Agency GmbH
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails