thecore_auth_commons 0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e94769e7d262d850b7c5531f9bebe433fe00dd934d9b593264605bd92c153d0d
+  data.tar.gz: e37f8a876f911fb9cf40723d5bda436125829de14fc85b91816e12dc56be2768
+SHA512:
+  metadata.gz: f28ae34cec6fbe45be080c1b1da3d2b346bafd5c4cc1bc2d33830351e94d0207d34e710768405ad97c36f3653c457d2d214fee32a451d93bd59054d97bd7fcf4
+  data.tar.gz: e6fea2a4ddcd36efaae3e0867ad2d673d9412e71df1fd1088ec1cb4161dcbc1d034d6b326baf43ac33e4f908d986d082e7bc934e124775a972ce65284046a2d8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# ThecoreAuth
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thecore_auth_commons'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install thecore_auth_commons
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ThecoreAuthCommons'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/models/ability.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    # Define abilities for the passed in user here. For example:
+    #
+    #   user ||= User.new # guest user (not logged in)
+    #   if user.admin?
+    #     can :manage, :all
+    #   else
+    #     can :read, :all
+    #   end
+    #
+    # The first argument to `can` is the action you are giving the user
+    # permission to do.
+    # If you pass :manage it will apply to every action. Other common actions
+    # here are :read, :create, :update and :destroy.
+    #
+    # The second argument is the resource the user can perform the action on.
+    # If you pass :all it will apply to every resource. Otherwise pass a Ruby
+    # class of the resource.
+    #
+    # The third argument is an optional hash of conditions to further filter the
+    # objects.
+    # For example, here the user can only update published articles.
+    #
+    #   can :update, Article, :published => true
+    #
+    # See the wiki for details:
+    # https://github.com/CanCanCommunity/cancancan/wiki/Defining-Abilities
+
+    # This will always be the first Ability, since the abilities are "last wins"
+    self.merge Abilities::ThecoreAuthCommons.new user
+    # Other Abilities
+    Abilities.constants(false).each do |ability|
+      unless ability.to_s == "ThecoreAuthCommons"
+        const = Abilities.const_get(ability) 
+        self.merge const.new(user) if const.is_a? Class
+      end
+    end
+    # Overrides from the database defined permissions
+    ::Permission.joins(roles: :users).where(users: {id: user.id}).order(:id).each do |permission|
+      # E.g. can :manage, :all
+      self.send(permission.predicate.name.to_sym, permission.action.name.to_sym, (permission.target.name.classify.constantize rescue permission.target.name.to_sym))
+    end
+  end
+end

data/app/models/action.rb

@@ -0,0 +1,3 @@
+class Action < ApplicationRecord
+    has_many :permissions, dependent: :destroy, inverse_of: :action
+end

data/app/models/permission.rb

@@ -0,0 +1,20 @@
+class Permission < ApplicationRecord
+    # REFERENCES
+    has_many :permission_roles, dependent: :destroy, inverse_of: :permission
+    has_many :roles, through: :permission_roles, inverse_of: :permissions
+    belongs_to :predicate, inverse_of: :permissions
+    belongs_to :action, inverse_of: :permissions
+    belongs_to :target, inverse_of: :permissions
+
+    # VALIDATIONS
+    validates :predicate_id, presence: true, uniqueness: {scope: [:action_id, :target_id]}
+    validates :action_id, presence: true
+    validates :target_id, presence: true
+
+    def display_name
+        p = (I18n.t "permissions.predicates.#{predicate.name}", default: predicate.name.titleize rescue nil)
+        a = (I18n.t "permissions.actions.#{action.name}", default: action.name.titleize rescue nil)
+        m = (I18n.t "activerecord.models.#{target.name}", default: target.name.titleize rescue nil)
+        [ p, a, m ].join(" ")
+    end
+end

data/app/models/permission_role.rb

@@ -0,0 +1,4 @@
+class PermissionRole < ApplicationRecord
+  belongs_to :role, inverse_of: :permission_roles
+  belongs_to :permission, inverse_of: :permission_roles
+end

data/app/models/predicate.rb

@@ -0,0 +1,3 @@
+class Predicate < ApplicationRecord
+    has_many :permissions, dependent: :destroy, inverse_of: :predicate
+end

data/app/models/role.rb

@@ -0,0 +1,13 @@
+class Role < ApplicationRecord
+    # VALIDATIONS
+    validates :name, presence: true, uniqueness: { case_sensitive: false }
+    # REFERENCES
+    has_many :role_users, dependent: :destroy, inverse_of: :role
+    has_many :users, through: :role_users, inverse_of: :roles
+    has_many :permission_roles, dependent: :destroy, inverse_of: :role
+    has_many :permissions, through: :permission_roles, inverse_of: :roles
+    
+    def display_name
+        (I18n.t name.parameterize.underscore, default: name.titleize rescue nil)
+    end
+end

data/app/models/role_user.rb

@@ -0,0 +1,4 @@
+class RoleUser < ApplicationRecord
+  belongs_to :user, inverse_of: :role_users
+  belongs_to :role, inverse_of: :role_users
+end

data/app/models/target.rb

@@ -0,0 +1,3 @@
+class Target < ApplicationRecord
+    has_many :permissions, dependent: :destroy, inverse_of: :target
+end

data/app/models/user.rb

@@ -0,0 +1,48 @@
+class User < ApplicationRecord
+  # Include default devise modules. Others available are:
+  # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
+  devise :database_authenticatable
+  devise :trackable
+  devise :validatable
+  # TODO: If it works, these must be added to another gem one which deal 
+  # more with sessions
+  # devise :database_authenticatable
+  # devise :rememberable
+  # devise :trackable
+  # devise :validatable
+  # devise :timeoutable, timeout_in: 30.minutes 
+  # REFERENCES
+  has_many :role_users, dependent: :destroy, inverse_of: :user
+  has_many :roles, through: :role_users, inverse_of: :users
+  # VALIDATIONS
+  validates :email, uniqueness: { case_sensitive: false }, presence: true, format: { with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i }
+  validates :password, presence: true, on: :create
+  validates :password_confirmation, presence: true, on: :create
+  validate :check_password_and_confirmation_equal
+  validates_each :admin do |record, attr, value|
+    # Don't want admin == false if the current user is the only admin
+    record.errors.add(attr, I18n.t("validation.errors.cannot_unadmin_last_admin")) if record.admin_changed? && record.admin_was == true && User.where(admin: true).count == 1
+  end
+  validates_each :locked do |record, attr, value|
+    # Don't want locked == true if the current user is the only admin
+    record.errors.add(attr, I18n.t("validation.errors.cannot_lock_last_admin")) if record.locked_changed? && record.locked_was == false && User.where(locked: false).count == 1
+  end
+  
+  def display_name
+    email
+  end
+  
+  def has_role? role
+    roles.include? role.to_s
+  end
+  
+  def authenticate password
+    self&.valid_password?(password) ? self : nil
+  end
+  
+  protected
+  
+  def check_password_and_confirmation_equal
+    errors.add(:password, I18n.t("validation.errors.password_and_confirm_must_be_the_same")) unless password == password_confirmation
+  end
+end

data/config/initializers/after_initialize_thecore_auth_commons.rb

@@ -0,0 +1,13 @@
+require 'thecore_auth_commons_actioncontroller_concerns'
+
+# App Config
+Rails.application.configure do
+    config.after_initialize do
+        # In development be sure to load all the namespaces
+        # in order to have working reflection and meta-programming.
+        if Rails.env.development?
+            Rails.configuration.eager_load_namespaces.each(&:eager_load!) if Rails.version.to_i == 5 #Rails 5
+            Zeitwerk::Loader.eager_load_all if Rails.version.to_i >= 6 #Rails 6
+        end
+    end
+end

data/config/initializers/devise.rb

@@ -0,0 +1,299 @@
+# frozen_string_literal: true
+
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+  # The secret key used by Devise. Devise uses this key to generate
+  # random tokens. Changing this key will render invalid all existing
+  # confirmation, reset password and unlock tokens in the database.
+  # Devise will use the `secret_key_base` as its `secret_key`
+  # by default. You can change it below and use your own secret key.
+  # config.secret_key = '3b97afd4baabfd5eb8c118ee25efe06017a8319dd5da4f39b287d20948ff844facb0b9c8daff13b7b437b92868aae71797686dcae3704e45e92d3b37094c9d3d'
+
+  # ==> Controller configuration
+  # Configure the parent class to the devise controllers.
+  # config.parent_controller = 'DeviseController'
+
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class
+  # with default "from" parameter.
+  config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Devise::Mailer'
+
+  # Configure the parent class responsible to send e-mails.
+  # config.parent_mailer = 'ActionMailer::Base'
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  # config.authentication_keys = [:email]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [:email]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [:email]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:database]` will
+  # enable it only for database authentication. The supported strategies are:
+  # :database      = Support basic authentication with authentication key + password
+  # config.http_authenticatable = false
+
+  # If 401 status code should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. 'Application' by default.
+  # config.http_authentication_realm = 'Application'
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # particular strategies by setting this option.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing skip: :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # By default, Devise cleans up the CSRF token on authentication to
+  # avoid CSRF token fixation attacks. This means that, when using AJAX
+  # requests for sign in and sign up, you need to get a new CSRF token
+  # from the server. You can disable this option at your own risk.
+  # config.clean_up_csrf_token_on_authentication = true
+
+  # When false, Devise will not attempt to reload routes on eager load.
+  # This can reduce the time taken to boot the app but if your application
+  # requires the Devise mappings to be loaded during boot time the application
+  # won't boot properly.
+  # config.reload_routes = true
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 11. If
+  # using other algorithms, it sets how many times you want the password to be hashed.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments. Note that, for bcrypt (the default
+  # algorithm), the cost increases exponentially with the number of stretches (e.g.
+  # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
+  config.stretches = Rails.env.test? ? 1 : 11
+
+  # Set up a pepper to generate the hashed password.
+  # config.pepper = 'ec0d64f5b4e32673fdc396433677d4f6b61aaf2ef6081b99b2cc8612f3c24556361eeea86ab2799772618f30e417c965491737a553b03d3e558db85256569971'
+
+  # Send a notification to the original email when the user's email is changed.
+  # config.send_email_changed_notification = false
+
+  # Send a notification email when the user's password is changed.
+  # config.send_password_change_notification = false
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming their account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming their account,
+  # access will be blocked just in the third day.
+  # You can also set it to nil, which will allow the user to access the website
+  # without confirming their account.
+  # Default is 0.days, meaning the user cannot access the website without
+  # confirming their account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # A period that the user is allowed to confirm their account before their
+  # token becomes invalid. For example, if set to 3.days, the user can confirm
+  # their account within 3 days after the mail was sent, but on the fourth day
+  # their account can't be confirmed with the token any more.
+  # Default is nil, meaning there is no restriction on how long a user can take
+  # before confirming their account.
+  # config.confirm_within = 3.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed, new email is stored in
+  # unconfirmed_email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [:email]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # Invalidates all the remember me tokens when the user signs out.
+  config.expire_all_remember_me_on_sign_out = true
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # secure: true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length.
+  config.password_length = 6..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  config.email_regexp = /\A[^@\s]+@[^@\s]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [:email]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # Warn on the last attempt before the account is locked.
+  # config.last_attempt_warning = true
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [:email]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # When set to false, does not sign a user in automatically after their password is
+  # reset. Defaults to true, so a user is signed in automatically after a reset.
+  # config.sign_in_after_reset_password = true
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another hashing or encryption algorithm besides bcrypt (default).
+  # You can use :sha1, :sha512 or algorithms from others authentication tools as
+  # :clearance_sha1, :authlogic_sha512 (then you should set stretches above to 20
+  # for default behavior) and :restful_authentication_sha1 (then you should set
+  # stretches to 10, and copy REST_AUTH_SITE_KEY to pepper).
+  #
+  # Require the `devise-encryptable` gem when using anything other than bcrypt
+  # config.encryptor = :sha512
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ['*/*', :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :delete
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(scope: :user).unshift :some_external_strategy
+  # end
+
+  # ==> Mountable engine configurations
+  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
+  # is mountable, there are some extra configurations to be taken into account.
+  # The following options are available, assuming the engine is mounted as:
+  #
+  #     mount MyEngine, at: '/my_engine'
+  #
+  # The router that invoked `devise_for`, in the example above, would be:
+  # config.router_name = :my_engine
+  #
+  # When using OmniAuth, Devise cannot automatically set OmniAuth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = '/my_engine/users/auth'
+
+  # ==> Turbolinks configuration
+  # If your app is using Turbolinks, Turbolinks::Controller needs to be included to make redirection work correctly:
+  #
+  # ActiveSupport.on_load(:devise_failure_app) do
+  #   include Turbolinks::Controller
+  # end
+
+  # ==> Configuration for :registerable
+
+  # When set to false, does not sign a user in automatically after their password is
+  # changed. Defaults to true, so a user is signed in automatically after changing a password.
+  # config.sign_in_after_change_password = true
+end

data/config/locales/en.activerecord.yml

@@ -0,0 +1,11 @@
+en:
+  activerecord:
+    models:
+      user:
+        one: User
+        other: Users
+    descriptions:
+      user: Section to manage users.
+      role: Section to manage Roles
+      permission: Section to manage Permissions
+    

data/config/locales/it.activerecord.yml

@@ -0,0 +1,36 @@
+it:
+  activerecord:
+    models:
+      user:
+        one: Utente
+        other: Utenti
+      role:
+        one: Ruolo
+        other: Ruoli
+      permission:
+        one: Permesso
+        other: Permessi
+    attributes:
+      user:
+        email: E-Mail
+        username: Nome Utente
+        code: Codice
+        roles: Ruoli
+        admin: Amministratore?
+        created_at: Data di Creazione
+        locked: Bloccato?
+        third_party: Ente Terzo?
+        password: Password
+        password_confirmation: Conferma Password
+      role:
+        users: Utenti
+        name: Nome
+        permissions: Permessi
+      permission:
+        predicate: Predicato
+        action: Azione
+        model: Modello
+    descriptions:
+      user: In questa sezione dell'applicazione potete cercare nella lista degli utenti in diversi modi usando i filtri o ordinare la lista secondo diversi campi.
+      role: In questa sezione si possono creare dei ruoli da usare nell'RBAC gestito dai file abilities, per definire le autorizzazioni CRUD e non solo.
+      permission: Il predicato definisce se è un permesso di poter fare o non fare, l'azione è il tipo definisce cosa si possa fare o non fare, mentre il modello definisce su chi.

data/config/locales/it.permissions.yml

@@ -0,0 +1,10 @@
+it:
+    permissions:
+        predicates:
+            can: Può
+            cannot: Non può
+        actions:
+            manage: Gestire
+            read: Leggere
+            update: Modificare
+            destroy: Eliminare

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  devise_for :users
+  # Look at https://altalogy.com/blog/rails-6-user-accounts-with-3-types-of-roles/
+  # For controller
+end

data/db/migrate/20200306143408_create_users.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class CreateUsers < ActiveRecord::Migration[6.0]
+  def self.up
+    create_table :users do |t|
+      ## Database authenticatable
+      t.string :email,              null: false, default: ""
+      t.string :encrypted_password, null: false, default: ""
+
+      ## Recoverable
+      # t.string   :reset_password_token
+      # t.datetime :reset_password_sent_at
+
+      ## Rememberable
+      # t.datetime :remember_created_at
+
+      # Trackable
+      t.integer  :sign_in_count, default: 0, null: false
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string   :current_sign_in_ip
+      t.string   :last_sign_in_ip
+
+      ## Confirmable
+      # t.string   :confirmation_token
+      # t.datetime :confirmed_at
+      # t.datetime :confirmation_sent_at
+      # t.string   :unconfirmed_email # Only if using reconfirmable
+
+      ## Lockable
+      # t.integer  :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
+      # t.string   :unlock_token # Only if unlock strategy is :email or :both
+      # t.datetime :locked_at
+
+
+      # Uncomment below if timestamps were not included in your original model.
+      t.timestamps null: false
+    end
+
+    add_index :users, :email,                unique: true
+    # add_index :users, :reset_password_token, unique: true
+    # add_index :users, :confirmation_token,   unique: true
+    # add_index :users, :unlock_token,         unique: true
+  end
+
+  def self.down
+    # By default, we don't want to make any assumption about how to roll back a migration when your
+    # model already existed. Please edit below which fields you would like to remove in this migration.
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/db/migrate/20200306151046_add_admin_field_to_user.rb

@@ -0,0 +1,5 @@
+class AddAdminFieldToUser < ActiveRecord::Migration[6.0]
+  def change
+    add_column :users, :admin, :boolean, null: false, default: false
+  end
+end

data/db/migrate/20200306151541_add_first_admin_user.rb

@@ -0,0 +1,60 @@
+class AddFirstAdminUser < ActiveRecord::Migration[6.0]
+  class User < ApplicationRecord
+    # Include default devise modules. Others available are:
+    # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
+    devise :database_authenticatable, :trackable, :validatable
+    # TODO: If it works, these must be added to another gem one which deal 
+    # more with sessions
+    # devise :database_authenticatable
+    # devise :rememberable
+    # devise :trackable
+    # devise :validatable
+    # devise :timeoutable, timeout_in: 30.minutes 
+    # REFERENCES
+    has_many :role_users, dependent: :destroy, inverse_of: :user
+    has_many :roles, through: :role_users, inverse_of: :users
+    # VALIDATIONS
+    validates :email, uniqueness: { case_sensitive: false }, presence: true, format: { with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i }
+    validates :password, presence: true, on: :create
+    validates :password_confirmation, presence: true, on: :create
+    validate :check_password_and_confirmation_equal
+    validates_each :admin do |record, attr, value|
+      # Don't want admin == false if the current user is the only admin
+      record.errors.add(attr, I18n.t("validation.errors.cannot_unadmin_last_admin")) if record.admin_changed? && record.admin_was == true && User.where(admin: true).count == 1
+    end
+  
+    def display_name
+      email
+    end
+  
+    def has_role? role
+      roles.include? role
+    end
+  
+    protected
+  
+    def check_password_and_confirmation_equal
+      errors.add(:password, I18n.t("validation.errors.password_and_confirm_must_be_the_same")) unless password == password_confirmation
+    end
+  end
+
+  def up
+    email = "admin@example.com"
+    User.reset_column_information
+    u=User.find_or_initialize_by(email: email)
+    psswd = SecureRandom.hex(5)
+    u.password = psswd
+    u.password_confirmation = psswd
+    u.admin = true
+    u.save!
+    puts "\nPlease find generated initial admin password in .passwords file."
+    File.open('.passwords', 'w') do |f|
+      f.write(psswd)
+    end
+  end
+
+  def down
+    email = "admin@example.com"
+    User.find_by(email: email).destroy
+  end
+end

data/db/migrate/20200306152740_create_roles.rb

@@ -0,0 +1,10 @@
+class CreateRoles < ActiveRecord::Migration[6.0]
+  def change
+    create_table :roles do |t|
+      t.string :name
+
+      t.timestamps
+    end
+    add_index :roles, :name
+  end
+end

data/db/migrate/20200306152816_create_role_users.rb

@@ -0,0 +1,10 @@
+class CreateRoleUsers < ActiveRecord::Migration[6.0]
+  def change
+    create_table :role_users do |t|
+      t.references :role, null: false, foreign_key: true
+      t.references :user, null: false, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200306153125_add_lock_version_to_user.rb

@@ -0,0 +1,5 @@
+class AddLockVersionToUser < ActiveRecord::Migration[6.0]
+  def change
+    add_column :users, :lock_version, :bigint
+  end
+end

data/db/migrate/20200306153136_add_lock_version_to_role.rb

@@ -0,0 +1,5 @@
+class AddLockVersionToRole < ActiveRecord::Migration[6.0]
+  def change
+    add_column :roles, :lock_version, :bigint
+  end
+end

data/db/migrate/20200516215346_add_locked_to_user.rb

@@ -0,0 +1,5 @@
+class AddLockedToUser < ActiveRecord::Migration[6.0]
+  def change
+    add_column :users, :locked, :boolean, null: false, default: false
+  end
+end

data/db/migrate/20200518082821_create_permissions.rb

@@ -0,0 +1,48 @@
+class CreatePermissions < ActiveRecord::Migration[6.0]
+  def change
+    @values = {
+      predicates: %i[can cannot],
+      actions: %i[manage create read update destroy],
+      targets: ApplicationRecord.subclasses.map {|d| d.to_s.underscore}.to_a.unshift(:all)
+    }
+
+    def create_and_fill table
+      create_table table do |t|
+        t.string :name
+        t.bigint :lock_version
+
+        t.timestamps
+      end
+      add_index table, :name, unique: true
+      model = table.to_s.classify.constantize
+      model.reset_column_information
+      model.upsert_all @values[table].map { |p| {name: p, created_at: Time.now, updated_at: Time.now} }, unique_by: [:name]
+    end
+
+    # Predicates
+    create_and_fill :predicates
+    
+    # Actions
+    create_and_fill :actions
+    
+    # Targets
+    create_and_fill :targets
+
+    create_table :permissions do |t|
+      t.references :predicate, null: false, foreign_key: true
+      t.references :action, null: false, foreign_key: true
+      t.references :target, null: false, foreign_key: true
+      t.bigint :lock_version
+
+      t.timestamps
+    end
+    # Association table
+    create_table :permission_roles do |t|
+      t.references :role, null: false, foreign_key: true
+      t.references :permission, null: false, foreign_key: true
+      t.bigint :lock_version
+
+      t.timestamps
+    end
+  end
+end

data/lib/abilities/thecore_auth_commons.rb

@@ -0,0 +1,20 @@
+module Abilities
+    class ThecoreAuthCommons
+        include CanCan::Ability
+        def initialize user
+            # Main abilities file for Thecore applications
+            if user.present?
+                # Users' abilities
+                # -
+                if user.admin?
+                    # Admins' abiities
+                    can :manage, :all # only allow admin users to access Rails Admin
+                    cannot :destroy, User do |u|
+                        # prevents killing himself
+                        u.id == user.id
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/tasks/thecore_auth_commons_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :thecore_auth_commons do
+#   # Task goes here
+# end

data/lib/thecore_auth_commons.rb

@@ -0,0 +1,10 @@
+require 'devise'
+require 'cancancan'
+require 'kaminari'
+require 'abilities/thecore_auth_commons'
+
+require "thecore_auth_commons/engine"
+
+module ThecoreAuthCommons
+  # Your code goes here...
+end

data/lib/thecore_auth_commons/engine.rb

@@ -0,0 +1,12 @@
+module ThecoreAuthCommons
+  class Engine < ::Rails::Engine
+    initializer 'thecore_auth_commons.add_to_migrations' do |app|
+      unless app.root.to_s.match root.to_s
+        # APPEND TO MAIN APP MIGRATIONS FROM THIS GEM
+        config.paths['db/migrate'].expanded.each do |expanded_path|
+          app.config.paths['db/migrate'] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/thecore_auth_commons/version.rb

@@ -0,0 +1,3 @@
+module ThecoreAuthCommons
+  VERSION = "#{`git describe --tags $(git rev-list --tags --max-count=1)`}"
+end

data/lib/thecore_auth_commons_actioncontroller_concerns.rb

@@ -0,0 +1,7 @@
+module ThecoreAuthCommonsActioncontrollerConcerns
+    extend ActiveSupport::Concern
+    
+    included do
+        include HttpAcceptLanguage::AutoLocale
+    end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: thecore_auth_commons
+version: !ruby/object:Gem::Version
+  version: '0'
+platform: ruby
+authors:
+- Gabriele Tassoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Provides common User and Role models to attach Authentication and Authorization
+  via your preferred gem.
+email:
+- gabriele.tassoni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/ability.rb
+- app/models/action.rb
+- app/models/permission.rb
+- app/models/permission_role.rb
+- app/models/predicate.rb
+- app/models/role.rb
+- app/models/role_user.rb
+- app/models/target.rb
+- app/models/user.rb
+- config/initializers/after_initialize_thecore_auth_commons.rb
+- config/initializers/devise.rb
+- config/locales/en.activerecord.yml
+- config/locales/it.activerecord.yml
+- config/locales/it.permissions.yml
+- config/routes.rb
+- db/migrate/20200306143408_create_users.rb
+- db/migrate/20200306151046_add_admin_field_to_user.rb
+- db/migrate/20200306151541_add_first_admin_user.rb
+- db/migrate/20200306152740_create_roles.rb
+- db/migrate/20200306152816_create_role_users.rb
+- db/migrate/20200306153125_add_lock_version_to_user.rb
+- db/migrate/20200306153136_add_lock_version_to_role.rb
+- db/migrate/20200516215346_add_locked_to_user.rb
+- db/migrate/20200518082821_create_permissions.rb
+- lib/abilities/thecore_auth_commons.rb
+- lib/tasks/thecore_auth_commons_tasks.rake
+- lib/thecore_auth_commons.rb
+- lib/thecore_auth_commons/engine.rb
+- lib/thecore_auth_commons/version.rb
+- lib/thecore_auth_commons_actioncontroller_concerns.rb
+homepage: https://github.com/gabrieletassoni/thecore_auth_commons
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Common Auth methods and models to be used in thecore components.
+test_files: []