active_entry 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15c793e52a2f7f0b43f1752bb61303f2fae758c763264fe3e73561ca3c272b8b
-  data.tar.gz: 49ba592be85bb9f3f1642d748e4cbc235b4f49461dca4483773fb1de85252028
+  metadata.gz: f0d907b6dc39fa89d8c98128341eb2bd0804328b623ab473e5f6e8b3c9b6db0b
+  data.tar.gz: 4c105a1fedb63bc5ed4415e58184bb3b879744bd6656e477952c07ad898f15c3
 SHA512:
-  metadata.gz: 1e009ca5bbd3b9c2d4153f96cf4dd864dd83196c317c276a7d2a71bde273325c6a59f2340e28ca6cadc83c4430da0fefa1f07846ffdd0d9e42409c2b91eab73e
-  data.tar.gz: 9e62985d0726b6323126b3929d7a3b9ad2d1d6d51e8488da8a6f7061b8c2d9efb94f284b260d69d344f0a8f140afa5b1428a4fb9c20d632a037542ca1d28da34
+  metadata.gz: 85ce65d93de8ec106d94c4e00b38d68ee80cfe3c51cb9700284d8ae1f25247ee8b7c4c0ccdb43e595a1e49176525c79117b2ffa5f54f3a144f7586ebc081f9f9
+  data.tar.gz: ff50acbb6a52138618186aa2ec9d17a28807fff5bd66237c426f26db700e969c81b1113abb3dea695ee6479f46a537459d0c8b337f75abb7bd483514b7500ddc

data/README.md

@@ -1,8 +1,74 @@
-[<img src="active_entry_logo.png" alt="Active Entry Logo" width="250px"/>](https://github.com/TFM-Agency/active_entry)
+<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.
+Active Entry is a secure way to check for authentication and authorization before an action is performed. It's currently only compatible with Rails. But in later versions will ActiveEntry be Framework independent.
+
+Active Entry works like many other Authorization Systems like [Pundit](https://github.com/varvet/pundit) or [Action Policy](https://github.com/palkan/action_policy) with **Policies**. However in Active Entry it's all about the method calling the auth mechanism. For every method that needs authentication or authorization, a decision maker method counterpart has to be created in the policy of the class.
+
+## Example
+
+Let's say we have an Users controller in our application:
+
+```ruby
+# app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  include ActiveEntry::ControllerConcern   # Glue for the controller and Active Entry
+
+  def index
+    pass!   # The auth happens here
+    load_users
+  end
+end
+```
+
+We have to create the UsersPolicy in order for Active Entry to know who is authenticated and authorized and who not.
+
+```ruby
+# app/policies/users_policy.rb
+module UsersPolicy
+  class Authentication < ActiveEntry::Base::Authentication
+    def index?
+      Current.user_signed_in?  # Only signed in users are considered to be authenticated.
+    end
+  end
+
+  class Authorization < ActiveEntry::Base::Authorization
+    def index?
+      Current.user.admin?  # Only admins are authorized to perform this action
+    end
+  end
+end
+```
+
+Now every time somebody calls the `users#index` endpoint, he or she has to be signed in and an admin. Otherwise `ActiveEntry::NotAuthenticatedError` or `ActiveEntry::NotAuthorizedError` are raised.
+You can catch them easily in your controller by using Rails' `rescue_from`.
+
+```ruby
+class ApplicationController < ActionController::Base
+  rescue_from ActiveEntry::NotAuthenticatedError, with: :not_authenticated
+  rescue_from ActiveEntry::NotAuthorizedError, with: :not_authorized
+
+  def not_authenticated
+    flash[:danger] = "Not authenticated. Please sign in."
+    redirect_to sign_in_path
+  end
+
+  def not_authorized
+    flash[:danger] = "Not authorized."
+    redirect_to root_path
+  end
+end
+```
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -11,50 +77,112 @@ Add this line to your application's Gemfile:
 gem 'active_entry'
 ```
 
-And then execute:
+Or install it without bundler:
 ```bash
+$ gem install active_entry
+```
+
+Run Bundle:
+```shell
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install active_entry
+And then install Active Entry:
+```shell
+$ rails g active_entry:install
 ```
 
+This will generate `app/policies/application_policy.rb`.
+
 ## Usage
-With Active Entry authentication and authorization is done in your Rails controllers. To enable authentication and authorization in one of your controllers, just add a before action for `authenticate!` and `authorize!` and the user has to authenticate and authorize on every call.
-You probably want to control authentication and authorization for every controller action you have in your app. To enable this, just add the before action to the `ApplicationController`.
+Active Entry works with Policies. You can generate policies the following way:
+
+Let's consider the example from above.
+We have an UsersController and we want a policy for that:
+
+```shell
+$ rails g policy Users
+```
+
+This generates a policy called `UsersPolicy` and is located in `app/policies/users_policy.rb`.
+
+The above generator call would generate something like this, but with a few comments to help you get started:
+
+```ruby
+module UsersPolicy
+  class Authentication < ActiveEntry::Base::Authentication
+  end
+
+  class Authorization < ActiveEntry::Base::Authorization
+  end
+end
+```
+
+### Verify authentication and authorization
+You probably want to control authentication and authorization for every controller action you have in your app. As a safeguard to ensure, that auth is performed in every request and the auth call is not forgotten in development, add the `verify_authentication!` and `verify_authorization!` to your `ApplicationController`:
 
 ```ruby
 class ApplicationController < ActionController::Base
-  before_action :authenticate!, :authorize!
+  verify_authentication!
+  verify_authorization!
   # ...
 end
 ```
+This ensures, that you perform auth in all your controllers and raises errors if not.
 
-If you try to open a page, you will get an `ActiveEntry::AuthenticationNotPerformedError` or `ActiveEntry::AuthorizationNotPerformedError`. This means that you have to instruct Active Entry when a user is authenticated/authorized and when not.
-You can do this by defining the methods `authenticated?` and `authorized?` in your controller.
+### Perform authentication and authorization
+in order to do the actual authentication and authorization, you have to use `authenticate!` and `authorize!` or `pass!` as in your actions.
 
 ```ruby
-class DashboardController < ApplicationController
-  # Actions ...
+class UsersController < ApplicationController
+  def authentication_only_action
+    authenticate!
+  end
 
-  private
+  def authorization_only_action
+    authorize!
+  end
 
-  def authenticated?
-    return true if user_signed_in?
+  def both_authentication_and_authorization_action
+    pass!
   end
+end
+```
 
-  def authorized?
-    return true if current_user.admin?
-  end 
+If you try to open a page, Active Entry will raise `ActiveEntry::DecisionMakerMethodNotDefinedError`. This means we have to define the decision makers in our policy.
+
+```ruby
+module UsersPolicy
+  class Authentication < ApplicationPolicy::Authentication
+    def authentication_only_action?
+      success   # == true | Everybody is allowed
+    end
+
+    def both_authentication_and_authorization_action?
+      success
+    end
+  end
+
+  class Authorization < ApplicationPolicy::Authorization
+    def authorization_only_action?
+      success
+    end
+
+    def both_authentication_and_authorization_action?
+      success
+    end
+  end
 end
 ```
 
-Active Entry expects boolean return values from `authenticated?` and `authorized?`. `true` signals successful authentication/authorization, everything else not.
+Every decision maker ends with an `?`. The name has to be the same as the name of the controller action. So `index` is going to be `index?`.
 
-If the user is signed in, he is authenticated and authorized if he is an admin, otherwise an `ActiveEntry::NotAuthenticatedError` or `ActiveEntry::NotAuthorizedError` will be raised.
-Now you just have to catch this error and react accordingly. Rails has the convinient `rescue_from` for that.
+In order for Active Entry to not raise an auth error, the decision makers have to return `true`. In our above example we used `success`, which simply returns `true`.
+
+**Note:** It has to be an explicit `true` and not just a truthy value. A string or object return value would raise an auth error.
+
+### Rescuing from errors
+Catch the errors in your controllers to redirect the user or show them a message.
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -79,38 +207,70 @@ end
 
 In this example above, the user will be redirected with a flash message. But you can do whatever you want. For example logging.
 
-Active Entry also has a few helper methods which help you to distinguish between RESTful controller actions.
+### Authenticate/authorize outside the action
+You can authenticate and authorize outside the action:
+
+```ruby
+class UsersController < ApplicationController
+  authenticate_now!
+  authorize_now!
+  # pass_now!  # Does both, authentication and authorization
+end
+```
 
-The following methods are available:
+Access control on class level will ensure that every action performs it.
 
- * `read_action?` - If the called action just read. Actions: `index`, `show`
- * `write_action?` - If the called action writes something. Actions: `new`, `create`, `edit`, `update`, `destroy`
- * `change_action?` - If something will be updated or destroyed. Actions: `edit`, `update`, `destroy`
- * `create_action?` - If something will be created. Actions: `new`, `create`
- * `update_action?` - If something will be updated. Actions: `edit`, `update`
- * `destroy_action?` - If something will be destroyed. Action: `destroy`
+**Note:** Don't use the class methods if the controller is inherited in other controllers. Best, don't use them at all and use the methods in the actions conciously.
 
-So you can for example do:
+## Variables
+You can pass variables to the decision maker.
 
 ```ruby
-def authorized?
-  return true if read_action?    # Everybody is authorized to call read actions
-
-  if write_action?
-    return true if admin_signed_in?		# Just admins are allowed to call write actions
+class UsersController < ApplicationController
+  def show
+    @user = User.find params[:id]
+    pass! user: @user
   end
 end
 ```
 
-This is pretty much everything you have to do for basic authentication or authorization!
+You can now access the user object as instance variable in your decision maker.
 
-## Pass a custom error hash
-You can pass an error hash to the exception and use this in your rescue method:
+```ruby
+module Users
+  class Authentication < ApplicationPolicy::Authentication
+    def show?
+      @user  # == <User:Instance>
+    end
+  end
+
+  class Authorization < ApplicationPolicy::Authorization
+    def show?
+      @user  # == <User:Instance>
+    end
+  end
+end
+```
+
+## Custom error data
+If you write something into `@error` in our decision maker, you can access it in your rescue methods in the controller:
 
 ```ruby
+module UsersPolicy
+  class Authentication < ApplicationPolicy::Authentication
+    def show?
+      @error = { code: 100 }
+    end
+  end
+
+  class Authorization < ApplicationPolicy::Authorization
+    def show?
+      @error = { code: 100 }
+    end
+  end
+end
+
 class ApplicationController < ActionController::Base
-  before_action :authenticate!, :authorize!
-	
   # ...
 
   rescue_from ActiveEntry::NotAuthenticatedError, with: :not_authenticated
@@ -118,59 +278,134 @@ class ApplicationController < ActionController::Base
 
   private
 
-  def not_authenticated(exception)
+  def not_authenticated exception
     flash[:danger] = "You are not authenticated! Code: #{exception.error[:code]}"
     redirect_to root_path
   end
 
-  def not_authorized(exception)
+  def not_authorized exception
     flash[:danger] = "You are not authorized to call this action! Code: #{exception.error[:code]}"
     redirect_to root_path
   end
+end
+```
 
-  def authenticated?(error)
-    error[:code] = "ERROR"
+But you can pass in whatever you want into your error hash.
 
-    return true if user_signed_in?
-  end
-	
-  def authorized?(error)
-    error[:code] = "ERROR"
+## Testing
+You can easily test your policies in RSpec. Let's start with the generator:
 
-    return true if read_action?    # Everybody is authorized to call read actions
+```shell
+$ rails g rspec:policy Users
+```
 
-    if write_action?
-      return true if admin_signed_in?		# Just admins are allowed to call write actions
-    end
-  end
+This will generate a spec for the `UsersPolicy` located in `spec/policies/users_policy_spec.rb`
+
+```ruby
+require "rails_helper"
+
+RSpec.describe UsersPolicy, type: :policy do
+  pending "add some examples to (or delete) #{__FILE__}"
 end
 ```
 
-## Known Issues
-The authentication/authorization is done in a before action. These Rails controller before callbacks are done in defined order. If you set an instance variable which is needed in the `authenticated?` or `authorized?` method, you have to call the before action after the other method again.
-
-For example if you set `@user` in your controller in the `set_user` before action and you want to use the variable in `authorized?` action, you have to add the `authenticate!` or `authorize!` method after the `set_user` again, otherwise `@user` won't be available in `authenticate!` or `authorized?` yet.
+Now you can easily test every decision maker with the `be_authenticated_for` and `be_authorized_for` matchers.
 
 ```ruby
-class UsersController < ApplicationController
-  before_action :set_user
-  before_action :authenticate!, :authorize!
+require "rails_helper"
+
+RSpec.describe UsersPolicy, type: :policy do
+  describe UsersPolicy::Authentication do
+    subject { UsersPolicy::Authentication }
+
+    context "anonymous" do
+      it { is_expected.to_not be_authenticated_for :index }
+      it { is_expected.to be_authenticated_for :new }
+      it { is_expected.to be_authenticated_for :create }
+      it { is_expected.to_not be_authenticated_for :edit }
+      it { is_expected.to_not be_authenticated_for :update }
+      it { is_expected.to_not be_authenticated_for :destroy }
+      it { is_expected.to_not be_authenticated_for :restore }
+    end
 
-  def show
+    context "signed in" do
+      before { Current.user = build :user }
+      
+      it { is_expected.to be_authenticated_for :index }
+      it { is_expected.to be_authenticated_for :new }
+      it { is_expected.to be_authenticated_for :create }
+      it { is_expected.to be_authenticated_for :edit }
+      it { is_expected.to be_authenticated_for :update }
+      it { is_expected.to be_authenticated_for :destroy }
+      it { is_expected.to be_authenticated_for :restore }
+    end
   end
 
-  private
+  describe UsersPolicy::Authorization do
+    subject { UsersPolicy::Authorization }
+
+    let(:user) { build :user }
+    
+    context "anonymous" do
+      it { is_expected.to be_authorized_for :index }
+      it { is_expected.to be_authorized_for :new }
+      it { is_expected.to be_authorized_for :create }
+      it { is_expected.to be_authorized_for :show, user: user }
+      it { is_expected.to_not be_authorized_for :edit, user: user }
+      it { is_expected.to_not be_authorized_for :update, user: user }
+      it { is_expected.to_not be_authorized_for :destroy, user: user }
+      it { is_expected.to_not be_authorized_for :restore, user: user }
+    end
+
+    context "if @user is Current.user" do
+      before { Current.user = user }
+      
+      it { is_expected.to be_authorized_for :show, user: user }
+      it { is_expected.to be_authorized_for :edit, user: user }
+      it { is_expected.to be_authorized_for :update, user: user }
+      it { is_expected.to be_authorized_for :destroy, user: user }
+      it { is_expected.to be_authorized_for :restore, user: user }
+    end
+
+    context "if @user is not Current.user" do
+      before { Current.user = build :user }
 
-  def authenticated?
-    return true if user_signed_in?
+      it { is_expected.to be_authorized_for :show, user: user }
+      it { is_expected.to_not be_authorized_for :edit, user: user }
+      it { is_expected.to_not be_authorized_for :update, user: user }
+      it { is_expected.to_not be_authorized_for :destroy, user: user }
+      it { is_expected.to_not be_authorized_for :restore, user: user }
+    end
   end
+end
+```
+
+## Differences to Action Policy
+[Action Policy](https://github.com/palkan/action_policy) is an awesome gem which works pretty similar to Active Entry. But there are some differences:
 
-  def authorized?
-    return true if current_user == @user
+### Action Policy expects a performing subject and a target object
+```ruby
+class PostPolicy < ApplicationPolicy
+  def update?
+    # `user` is a performing subject,
+    # `record` is a target object (post we want to update)
+    user.admin? || (user.id == record.user_id)
   end
 end
 ```
 
+In Active Entry you can pass in anything you want into the decision maker, which is accessible as instance variables. See Variables.
+
+One strategy is not better than the other. It's just our preference.
+
+### Policies in Action Policy are for Resources/Models
+If you have a `Post` model, you have a `PostPolicy` in Action Policy. In Active Entry you create policies for controllers. So if you have a `PostsController`, you have a `PostsPolicy`.
+We like to build access control logic around controller endpoints.
+
+### Action Policy performs only authorization
+Active Entry does technically also not provide authentication mechanisms. It's just that you place your authentication logic in an authentication decision maker.
+We like both authentication and authorization logic in the same place but seperated hence `UsersPolicy::Authentication` and `UsersPolicy::Authorization`.
+
 ## Contributing
 Create pull requests on Github and help us to improve this Gem. There are some guidelines to follow:
 
@@ -179,4 +414,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/app/controllers/concerns/active_entry/concern.rb

@@ -0,0 +1,57 @@
+require "active_support/concern"
+
+module ActiveEntry
+  module ControllerConcern
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Methods .authenticate_now!, .authorize_now!, and .pass_now!
+      [:authenticate, :authorize, :pass].each do |method_name|
+        define_method "#{method_name}_now!" do
+          before_action do
+            args = {}
+            instance_variables.collect{ |v| v.to_s.remove("@").to_sym }.each do |name|
+              value = instance_variable_get ["@", name].join
+              next if value.nil?
+              args[name] = value
+            end
+            send "#{method_name}!", **args
+          end
+        end
+      end
+
+      def verify_authentication!
+        after_action do
+          raise AuthenticationNotPerformedError.new(self.class, action_name) unless @__authentication_done
+        end
+      end
+
+      def verify_authorization!
+        after_action do
+          raise AuthorizationNotPerformedError.new(self.class, action_name) unless @__authorization_done
+        end
+      end
+    end
+
+    def pass! **args
+      authenticate! **args
+      authorize! **args
+    end
+    
+    def authenticate! **args
+      policy_class::Authentication.pass! action_name, **args unless @__authentication_done
+      @__authentication_done = true
+    end
+
+    def authorize! **args
+      policy_class::Authorization.pass! action_name, **args unless @__authorization_done
+      @__authorization_done = true
+    end
+
+    private
+
+    def policy_class
+      PolicyFinder.policy_for self.class.name.remove("Controller")
+    end
+  end
+end

data/app/helpers/active_entry/view_helper.rb

@@ -0,0 +1,20 @@
+module ActiveEntry
+  module ViewHelper
+    def authorized_for? controller_name, action, **args
+      controller_name = controller_name.to_s.camelize.remove "Controller"
+      policy = ActiveEntry::PolicyFinder.policy_for controller_name
+      policy::Authorization.pass? action, **args
+    end
+
+    def link_to_if_authorized name = nil, options = nil, html_options = nil, &block
+      url = url_for options
+      method = options&.is_a?(Hash) && options[:method] ? options[:method].to_s.upcase : "GET"
+
+      recognized_path = Rails.application.routes.recognize_path(url, method: method)
+
+      authorized = authorized_for? recognized_path[:controller], recognized_path[:action]
+      
+      link_to name, options, html_options, &block if authorized
+    end
+  end
+end

data/lib/active_entry.rb

@@ -1,54 +1,13 @@
 require "active_entry/version"
+require "active_entry/generators"
 require "active_entry/errors"
-require "active_entry/controller_methods"
-require "active_entry/railtie" if defined? Rails::Railtie
+require "active_entry/base"
+require "active_entry/policy_finder"
 
-module ActiveEntry
-  # Authenticates the user
-  def authenticate!
-    # Raise an error if the #authenticate? action isn't defined.
-    #
-    # This ensures that you actually do authentication in your controller.
-    raise ActiveEntry::AuthenticationNotPerformedError unless defined?(authenticated?)
-    
-    error = {}
-    is_authenticated = nil
-
-    if method(:authenticated?).arity > 0
-      is_authenticated = authenticated?(error)
-    else
-      is_authenticated = authenticated?
-    end
-    
-    # If the authenticated? method returns not true
-    # it raises the ActiveEntry::NotAuthenticatedError.
-    #
-    # Use the .rescue_from method from ActionController::Base
-    # to catch the exception and show the user a proper error message.
-    raise ActiveEntry::NotAuthenticatedError.new(error) unless is_authenticated == true
-  end
-  
-  # Authorizes the user.
-  def authorize!
-    # Raise an error if the #authorize? action isn't defined.
-    #
-    # This ensures that you actually do authorization in your controller. 
-    raise ActiveEntry::AuthorizationNotPerformedError unless defined?(authorized?)
-    
-    error = {}
-    is_authorized = nil
+require_relative "../app/controllers/concerns/active_entry/concern" if defined?(ActionController::Base)
+require 'active_entry/railtie' if defined?(Rails)
 
-    if method(:authorized?).arity > 0
-      is_authorized = authorized?(error)
-    else
-      is_authorized = authorized?
-    end
+require "active_support/inflector"
 
-    # If the authorized? method does not return true
-    # it raises the ActiveEntry::NotAuthorizedError
-    #
-    # Use the .rescue_from method from ActionController::Base
-    # to catch the exception and show the user a proper error message.
-    raise ActiveEntry::NotAuthorizedError.new(error) unless is_authorized == true
-  end
+module ActiveEntry
 end

data/lib/active_entry/base.rb

@@ -0,0 +1,66 @@
+module ActiveEntry
+  class Base
+    class Authentication < Base
+      AUTH_ERROR = NotAuthenticatedError
+      
+      def self.pass! method_name, **args
+        new(method_name, **args).pass!
+      end
+
+      def self.pass? method_name, **args
+        new(method_name, **args).pass?
+      end
+    end
+
+    class Authorization < Base
+      AUTH_ERROR = NotAuthorizedError
+      
+      def self.pass! method_name, **args
+        new(method_name, **args).pass!
+      end
+
+      def self.pass? method_name, **args
+        new(method_name, **args).pass?
+      end
+    end
+
+    def initialize method_name, **args
+      @_method_name_to_entrify = method_name
+      @_args = args
+      @_args.each { |name, value| instance_variable_set ["@", name].join, value }
+    end
+
+    class << self
+      def pass! method_name, **args
+        Authentication.pass! method_name, **args
+        Authorization.pass! method_name, **args
+      end
+
+      def pass? method_name, **args
+        Authentication.pass? method_name, **args
+        Authorization.pass? method_name, **args
+      end
+    end
+
+
+    def pass!
+      pass? or raise self.class::AUTH_ERROR.new(@error, @_method_name_to_entrify, @_args)
+    end
+
+    def pass?
+      decision_maker_method.call == true
+    end
+
+    def success
+      true
+    end
+
+    private
+
+    def decision_maker_method
+      decision_maker_method_name = [@_method_name_to_entrify, "?"].join
+      raise DecisionMakerMethodNotDefinedError.new(self.class, decision_maker_method_name) unless respond_to?(decision_maker_method_name)
+      method decision_maker_method_name
+    end
+  end
+end

data/lib/active_entry/errors.rb

@@ -1,66 +1,65 @@
-# @author Tobias Feistmantl
 module ActiveEntry
-  # Generic authorization error.
-  # Other, more specific, errors inherit from this one.
-  #
-  # @raise [AuthorizationError]
-  #    if something generic is happening.
-  class AuthorizationError < StandardError
+  class Error < StandardError
   end
 
-  # Error for controllers in which authorization isn't handled.
-  #
-  # @raise [AuthorizationNotPerformedError]
-  #    if the #authorized? method isn't defined
-  #    in the controller class.
-  class AuthorizationNotPerformedError < AuthorizationError
+  class AuthError < Error
+    attr_reader :error, :method, :arguments
+
+    def initialize error, method, arguments
+      @error = error
+      @method = method 
+      @arguments = arguments
+      @message = "Not authenticated/authorized for method ##{@method}"
+
+      super @message
+    end
   end
 
-  # Error if user unauthorized.
-  #
-  # @raise [NotAuthorizedError]
-  #    if authorized? isn't returning true.
-  #
-  # @note
-  #    Should always be called at the end
-  #    of the #authorize! method.
-  class NotAuthorizedError < AuthorizationError
-    attr_reader :error
+  class NotAuthenticatedError < AuthError
+  end
 
-    def initialize(error={})
-      @error = error
+  class NotAuthorizedError < AuthError
+  end
+
+  class NotPerformedError < Error
+    attr_reader :class_name, :method
+
+    def initialize class_name, method
+      @class_name = class_name
+      @method = method
+      @message = "Auth not performed for #{@class_name}##{@method}."
+      
+      super @message
     end
   end
 
+  class AuthenticationNotPerformedError < NotPerformedError
+  end
 
-  # Base class for authentication errors.
-  #
-  # @raise [AuthenticationError]
-  #    if something generic happens.
-  class AuthenticationError < StandardError
+  class AuthorizationNotPerformedError < NotPerformedError
   end
 
-  # Error for controllers in which authentication isn't handled.
-  #
-  # @raise [AuthenticationNotPerformedError]
-  #    if the #authenticated? method isn't defined
-  #    in the controller class.
-  class AuthenticationNotPerformedError < AuthenticationError
+  class NotDefinedError < Error
+    attr_reader :policy_name, :class_name
+
+    def initialize policy_name, class_name
+      @policy_name = policy_name
+      @class_name = class_name
+      @message = "Policy #{policy_name} for class #{@class_name} not defined."
+
+      super @message
+    end
   end
 
-  # Error if user not authenticated
-  #
-  # @raise [NotAuthenticatedError]
-  #    if authenticated? isn't returning true.
-  #
-  # @note
-  #    Should always be called at the end
-  #    of the #authenticate! method.
-  class NotAuthenticatedError < AuthenticationError
-    attr_reader :error
+  class DecisionMakerMethodNotDefinedError < Error
+    attr_reader :policy_name, :decision_maker_method_name
 
-    def initialize(error={})
-      @error = error
+    def initialize policy_name, decision_maker_method_name
+      @policy_name = policy_name
+      @decision_maker_method_name = decision_maker_method_name
+      @message = "Decision maker #{policy_name}##{decision_maker_method_name} is not defined."
+
+      super @message
     end
   end
 end

data/lib/active_entry/generators.rb

@@ -0,0 +1,4 @@
+module ActiveEntry
+  module Generators
+  end
+end

data/lib/active_entry/policy_finder.rb

@@ -0,0 +1,25 @@
+module ActiveEntry
+  class PolicyFinder
+    attr_reader :class_name
+
+    def initialize class_name
+      @class_name = class_name
+    end
+
+    class << self
+      def policy_for class_name
+        new(class_name).policy
+      end
+    end
+
+    def policy
+      policy_class_name.safe_constantize or raise NotDefinedError.new(policy_class_name, @class_name)
+    end
+
+    private
+
+    def policy_class_name
+      [@class_name, "Policy"].join
+    end
+  end
+end

data/lib/active_entry/railtie.rb

@@ -1,9 +1,9 @@
+require_relative '../../app/helpers/active_entry/view_helper'
+
 module ActiveEntry
-  class Railtie < ::Rails::Railtie
-    initializer 'active_entry.include_in_action_controller' do
-      ActiveSupport.on_load :action_controller do
-        ::ActionController::Base.include(ActiveEntry)
-      end
+  class Railtie < Rails::Railtie
+    initializer "active_entry.view_helper" do
+      ActiveSupport.on_load(:action_view) { include ActiveEntry::ViewHelper }
     end
   end
-end
+end

data/lib/active_entry/rspec.rb

@@ -0,0 +1,56 @@
+module ActiveEntry
+  module Rspec
+    module Matchers
+      extend ::RSpec::Matchers::DSL
+
+      matcher :be_authenticated_for do |action, **args|
+        match do |policy|
+          policy.pass? action, **args
+        end
+
+        description do
+          "be authenticated for #{action}"
+        end
+
+        failure_message do |policy|
+          "expected that #{policy} passes authentication for #{action}"
+        end
+      end
+
+      matcher :be_authorized_for do |action, **args|
+        match do |policy|
+          policy.pass? action, **args
+        end
+
+        description do
+          "be authorized for #{action}"
+        end
+
+        failure_message do |policy|
+          "expected that #{policy} passes authorization for #{action}"
+        end
+      end
+    end
+
+    module DSL
+    end
+
+    module PolicyExampleGroup
+      include ActiveEntry::Rspec::Matchers
+
+      def self.included(base)
+        base.metadata[:type] = :policy
+        base.extend ActiveEntry::Rspec::DSL
+        super
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(
+    ActiveEntry::Rspec::PolicyExampleGroup,
+    type: :policy,
+    file_path: %r{spec/policies}
+  )
+end

data/lib/active_entry/version.rb

@@ -1,3 +1,3 @@
 module ActiveEntry
-  VERSION = '1.0.1'
+  VERSION = '2.0.0'
 end

data/lib/generators/active_entry/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs Active Entry. Generates an ApplicationPolicy.
+
+Example:
+    bin/rails generate active_entry:install
+
+    This will create:
+        app/policies/application_policy.rb

data/lib/generators/active_entry/install/install_generator.rb

@@ -0,0 +1,9 @@
+module ActiveEntry
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def create_application_policy
+      template "application_policy.rb", File.join("app/policies/application_policy.rb"), skip: true
+    end
+  end
+end

data/lib/generators/active_entry/install/templates/application_policy.rb

@@ -0,0 +1,7 @@
+module ApplicationPolicy
+  class Authentication < ActiveEntry::Base::Authentication
+  end
+
+  class Authorization < ActiveEntry::Base::Authorization
+  end
+end

data/lib/generators/policy/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a new policy class for authentication/authorization.
+
+Example:
+    bin/rails generate policy Users
+
+    This will create:
+        app/policies/users_policy.rb

data/lib/generators/policy/policy_generator.rb

@@ -0,0 +1,7 @@
+class PolicyGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def create_policy
+    template "policy.rb", File.join("app/policies", class_path, "#{file_name}_policy.rb")
+  end
+end

data/lib/generators/policy/templates/policy.rb

@@ -0,0 +1,53 @@
+module <%= class_name %>Policy
+  class Authentication < ApplicationPolicy::Authentication
+    # It's all about decision makers. In your decision makers you tell
+    # Active Entry when and if somebody is authenticated/authorized.
+    #
+    # You can declare decision makers for any method you want.
+    # Just use the same name as your action and add a ? at the end.
+
+    # def index?
+    # end
+
+    # def new?
+    # end
+
+    # def create?
+    # end
+
+    # def show?
+    # end
+
+    # def edit?
+    # end
+
+    # def update?
+    # end
+
+    # def destroy?
+    # end
+  end
+
+  class Authorization < ApplicationPolicy::Authorization
+    # def index?
+    # end
+
+    # def new?
+    # end
+
+    # def create?
+    # end
+
+    # def show?
+    # end
+
+    # def edit?
+    # end
+
+    # def update?
+    # end
+
+    # def destroy?
+    # end
+  end
+end

data/lib/generators/rspec/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a new policy spec to test authentication/authorization.
+
+Example:
+    bin/rails generate rspec:policy Users
+
+    This will create:
+        spec/policies/users_policy_spec.rb

data/lib/generators/rspec/policy_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class PolicyGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_policy_spec
+        template "policy_spec.rb", File.join("spec/policies", class_path, "#{file_name}_policy_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/policy_spec.rb

@@ -0,0 +1,5 @@
+require "<%= File.exists?('spec/rails_helper.rb') ? 'rails_helper' : 'spec_helper' %>"
+
+RSpec.describe <%= class_name %>Policy, type: :policy do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_entry
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - TFM Agency GmbH
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -67,8 +67,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: An easy and flexible access control system. No need for policies, abilities,
-  etc. Do authentication and authorization directly in your controller.
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy and flexible access control system. Authentication and authorization
+  before a method/action is executed.
 email:
 - hello@tfm.agency
 executables: []
@@ -78,11 +92,25 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/concerns/active_entry/concern.rb
+- app/helpers/active_entry/view_helper.rb
 - lib/active_entry.rb
-- lib/active_entry/controller_methods.rb
+- lib/active_entry/base.rb
 - lib/active_entry/errors.rb
+- lib/active_entry/generators.rb
+- lib/active_entry/policy_finder.rb
 - lib/active_entry/railtie.rb
+- lib/active_entry/rspec.rb
 - lib/active_entry/version.rb
+- lib/generators/active_entry/install/USAGE
+- lib/generators/active_entry/install/install_generator.rb
+- lib/generators/active_entry/install/templates/application_policy.rb
+- lib/generators/policy/USAGE
+- lib/generators/policy/policy_generator.rb
+- lib/generators/policy/templates/policy.rb
+- lib/generators/rspec/USAGE
+- lib/generators/rspec/policy_generator.rb
+- lib/generators/rspec/templates/policy_spec.rb
 - lib/tasks/active_entry_tasks.rake
 homepage: https://github.com/TFM-Agency/active_entry
 licenses:

data/lib/active_entry/controller_methods.rb

@@ -1,83 +0,0 @@
-# @author Tobias Feistmantl
-#
-# Helper methods for your controller
-# to identify RESTful actions.
-module ActiveEntry
-  # @return [Boolean]
-  #    True if the called action
-  #    is a only-read action.
-  def read_action?
-    action_name == 'index' ||
-    action_name == 'show'
-  end
-
-  # @return [Boolean]
-  #    True if the called action
-  #    is a write action.
-  def write_action?
-    action_name == 'new' ||
-    action_name == 'create' ||
-    action_name == 'edit' ||
-    action_name == 'update' ||
-    action_name == 'destroy'
-  end
-
-  # @return [Boolean]
-  #    True if the called action
-  #    is a change action.
-  def change_action?
-    action_name == 'edit' ||
-    action_name == 'update' ||
-    action_name == 'destroy'
-  end
-
-  # @return [Boolean]
-  #    True if the called action
-  #    is the index action.
-  def index_action?
-    action_name == 'index'
-  end
-
-  # @return [Boolean]
-  #    True if the called action
-  #    is the show action.
-  def show_action?
-    action_name == 'show'
-  end
-
-  # @note
-  #    Also true for the pseudo
-  #    update action `new`.
-  #
-  # @note
-  #    Only true for create methods
-  #    such as new and create.
-  #
-  # @return [Boolean]
-  #    True if the called action
-  #    is a create action.
-  def create_action?
-    action_name == 'new' ||
-    action_name == 'create'
-  end
-
-  # @note
-  #    Also true for the pseudo
-  #    update action `edit`.
-  #
-  # @return [Boolean]
-  #    True if the called action
-  #    is a update action.
-  def update_action?
-    action_name == 'edit' ||
-    action_name == 'update'
-  end
-
-  # @return [Boolean]
-  #    True if it's a destroy action.
-  def destroy_action?
-    action_name == 'destroy'
-  end
-
-  alias delete_action? destroy_action?
-end