decidim-centers 0.1.1

data/README.md

@@ -0,0 +1,144 @@
+# Decidim::Centers
+
+[![Gem Version](https://img.shields.io/gem/v/decidim-centers.svg)](https://badge.fury.io/rb/decidim-centers)
+[![[CI] Lint](https://github.com/Platoniq/decidim-module-centers/actions/workflows/lint.yml/badge.svg)](https://github.com/Platoniq/decidim-module-centers/actions/workflows/lint.yml)
+[![[CI] Test](https://github.com/Platoniq/decidim-module-centers/actions/workflows/test.yml/badge.svg)](https://github.com/Platoniq/decidim-module-centers/actions/workflows/test.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6b1b656b229f9731a64b/maintainability)](https://codeclimate.com/github/Platoniq/decidim-module-centers/maintainability)
+[![codecov](https://codecov.io/gh/Platoniq/decidim-module-centers/branch/main/graph/badge.svg)](https://codecov.io/gh/Platoniq/decidim-module-centers)
+
+Manage your centers and scopes so the users can be authorized over them. As an admin you will be able
+to create centers and scopes (we use the model Decidim currently provides).
+
+When a user signs up in the platform two new fields will appear in the registration form.
+
+- **Center**: Where the user works. For example: "University of Granada"
+- **Scope**: The work scope in which the user works. For example: "Computer Science"
+
+![Registration form](examples/registration.png)
+
+Users can change the values anytime they want from the profile page.
+
+When they create the account or update their values, a `center` authorization will be created or updated
+with the value of the center and scope the user has selected.
+
+As an admin you will be able to configure the permissions of a component restricting the access to
+specific centers and scopes. When you select multiple centers or scopes they work as "or". When you specify
+both the center and the scope it will work as an "and" between them.
+
+![Permissions in the admin page](examples/permissions.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-centers", "~> 0.1.0"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Install (and run) migrations:
+
+```bash
+bundle exec rails decidim_centers:install:migrations
+bundle exec rails db:migrate
+```
+
+Depending on your Decidim version, choose the corresponding version to ensure compatibility:
+
+| Version | Compatible decidim versions |
+|---------|-----------------------------|
+| 0.1.x   | v0.27.x                     |
+
+## Configuration
+
+You can customize your installation using the environment variables below:
+
+| ENV                                  | Description                                               | Default | Example      |
+|--------------------------------------|-----------------------------------------------------------|---------|--------------|
+| DECIDIM_CENTERS_SCOPES_ENABLED       | Use scopes to categorize users too along with the centers | true    | false        |
+
+> **IMPORTANT**: Remember to activate the verification method `center` in the
+> Decidim `/system` admin page for your organization.
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+### Developing
+
+To start contributing to this project, first:
+
+- Install the basic dependencies (such as Ruby and PostgreSQL)
+- Clone this repository
+
+Decidim's main repository also provides a Docker configuration file if you
+prefer to use Docker instead of installing the dependencies locally on your
+machine.
+
+You can create the development app by running the following commands after
+cloning this project:
+
+```bash
+bundle
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake development_app
+```
+
+Note that the database user has to have rights to create and drop a database in
+order to create the dummy test app database.
+
+Then to test how the module works in Decidim, start the development server:
+
+```bash
+cd development_app
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rails s
+```
+
+In case you are using [rbenv](https://github.com/rbenv/rbenv) and have the
+[rbenv-vars](https://github.com/rbenv/rbenv-vars) plugin installed for it, you
+can add the environment variables to the root directory of the project in a file
+named `.rbenv-vars`. If these are defined for the environment, you can omit
+defining these in the commands shown above.
+
+#### Code Styling
+
+Please follow the code styling defined by the different linters that ensure we
+are all talking with the same language collaborating on the same project. This
+project is set to follow the same rules that Decidim itself follows.
+
+[Rubocop](https://rubocop.readthedocs.io/) linter is used for the Ruby language.
+
+You can run the code styling checks by running the following commands from the
+console:
+
+```bash
+bundle exec rubocop
+```
+
+To ease up following the style guide, you should install the plugin to your
+favorite editor, such as:
+
+- Atom - [linter-rubocop](https://atom.io/packages/linter-rubocop)
+- Sublime Text - [Sublime RuboCop](https://github.com/pderichs/sublime_rubocop)
+- Visual Studio Code - [Rubocop for Visual Studio Code](https://github.com/misogi/vscode-ruby-rubocop)
+
+### Testing
+
+To run the tests run the following in the gem development path:
+
+```bash
+bundle
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_app
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rspec
+```
+
+Note that the database user has to have rights to create and drop a database in
+order to create the dummy test app database.
+
+## License
+
+This engine is distributed under the [GNU AFFERO GENERAL PUBLIC LICENSE](LICENSE-AGPLv3.txt).

data/Rakefile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+def install_module(path)
+  Dir.chdir(path) do
+    system("bundle exec rake decidim_centers:install:migrations")
+    system("bundle exec rake db:migrate")
+  end
+end
+
+def seed_db(path)
+  Dir.chdir(path) do
+    system("bundle exec rake db:seed")
+  end
+end
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app" do
+  ENV["RAILS_ENV"] = "test"
+  install_module("spec/decidim_dummy_app")
+end
+
+desc "Generates a development app."
+task :development_app do
+  Bundler.with_original_env do
+    generate_decidim_app(
+      "development_app",
+      "--app_name",
+      "#{base_app_name}_development_app",
+      "--path",
+      "..",
+      "--recreate_db",
+      "--demo"
+    )
+  end
+
+  install_module("development_app")
+  seed_db("development_app")
+end

data/app/commands/concerns/decidim/centers/create_omniauth_registration_override.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Centers
+    module CreateOmniauthRegistrationOverride
+      extend ActiveSupport::Concern
+
+      include PublishCenterUpdateEvent
+
+      def call
+        verify_oauth_signature!
+
+        begin
+          if existing_identity
+            # :nocov:
+            user = existing_identity.user
+            verify_user_confirmed(user)
+
+            return broadcast(:ok, user)
+            # :nocov:
+          end
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            create_or_find_user
+            @identity = create_identity
+          end
+          trigger_omniauth_registration
+          publish_center_update_event
+
+          broadcast(:ok, @user)
+        rescue ActiveRecord::RecordInvalid => e
+          # :nocov:
+          broadcast(:error, e.record)
+          # :nocov:
+        end
+      end
+    end
+  end
+end

data/app/commands/concerns/decidim/centers/create_registration_override.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Centers
+    module CreateRegistrationOverride
+      extend ActiveSupport::Concern
+
+      include PublishCenterUpdateEvent
+
+      def call
+        if form.invalid?
+          # :nocov:
+          user = User.has_pending_invitations?(form.current_organization.id, form.email)
+          user.invite!(user.invited_by) if user
+          return broadcast(:invalid)
+          # :nocov:
+        end
+
+        create_user
+        publish_center_update_event
+
+        broadcast(:ok, @user)
+      rescue ActiveRecord::RecordInvalid
+        # :nocov:
+        broadcast(:invalid)
+        # :nocov:
+      end
+    end
+  end
+end

data/app/commands/concerns/decidim/centers/publish_center_update_event.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Centers
+    module PublishCenterUpdateEvent
+      extend ActiveSupport::Concern
+
+      def publish_center_update_event
+        ActiveSupport::Notifications.publish(
+          "decidim.centers.user.updated",
+          user_id: @user.id,
+          center_id: @form.center_id,
+          scope_id: @form.scope_id
+        )
+      end
+    end
+  end
+end

data/app/commands/concerns/decidim/centers/update_account_override.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Centers
+    module UpdateAccountOverride
+      extend ActiveSupport::Concern
+
+      include PublishCenterUpdateEvent
+
+      def call
+        return broadcast(:invalid) unless @form.valid?
+
+        update_personal_data
+        update_avatar
+        update_password
+
+        if @user.valid?
+          @user.save!
+          notify_followers
+          publish_center_update_event
+          broadcast(:ok, @user.unconfirmed_email.present?)
+        else
+          # :nocov:
+          [:avatar, :password, :password_confirmation].each do |key|
+            @form.errors.add key, @user.errors[key] if @user.errors.has_key? key
+          end
+          broadcast(:invalid)
+          # :nocov:
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/centers/admin/create_center.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Centers
+    module Admin
+      # This command is executed when the user creates a Center from the admin
+      # panel.
+      class CreateCenter < Decidim::Command
+        # Initializes a CreateCenter Command.
+        #
+        # form - The form from which to get the data.
+        # current_user - The user who performs the action.
+        def initialize(form, current_user)
+          @form = form
+          @current_user = current_user
+        end
+
+        # Creates the center if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            create_center!
+          end
+
+          broadcast(:ok, @center)
+        end
+
+        private
+
+        attr_reader :form, :current_user
+
+        def create_center!
+          attributes = {
+            organization: form.current_organization,
+            title: form.title
+          }
+
+          @center = Decidim.traceability.create!(
+            Center,
+            current_user,
+            attributes
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/centers/admin/destroy_center.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Centers
+    module Admin
+      # This command is executed when the user destroys a Center from the admin
+      # panel.
+      class DestroyCenter < Decidim::Command
+        # Initializes a DestroyCenter Command.
+        #
+        # center - The current instance of the center to be destroyed.
+        # current_user - The user who performs the action.
+        def initialize(center, current_user)
+          @center = center
+          @current_user = current_user
+        end
+
+        # Destroys the center if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          transaction do
+            destroy_center!
+          end
+
+          broadcast(:ok, center)
+        end
+
+        private
+
+        attr_reader :center, :current_user
+
+        def destroy_center!
+          attributes = {
+            deleted_at: Time.current
+          }
+
+          Decidim.traceability.update!(
+            center,
+            current_user,
+            attributes
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/centers/admin/update_center.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Centers
+    module Admin
+      # This command is executed when the user changes a Center from the admin
+      # panel.
+      class UpdateCenter < Decidim::Command
+        # Initializes a UpdateCenter Command.
+        #
+        # form - The form from which to get the data.
+        # center - The current instance of the center to be updated.
+        # current_user - The user who performs the action.
+        def initialize(form, center, current_user)
+          @form = form
+          @center = center
+          @current_user = current_user
+        end
+
+        # Updates the center if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            update_center!
+          end
+
+          broadcast(:ok, center)
+        end
+
+        private
+
+        attr_reader :form, :center, :current_user
+
+        def update_center!
+          Decidim.traceability.update!(
+            center,
+            current_user,
+            title: form.title
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/centers/create_or_update_center_user.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Centers
+    # This command is executed when a new relationship between user
+    # and center is created
+    class CreateOrUpdateCenterUser < Decidim::Command
+      # Initializes a CreateOrUpdateCenterUser Command.
+      #
+      # center - The center to be related with the user.
+      # user - The user to be related with the center.
+      def initialize(center, user)
+        @center = center
+        @user = user
+      end
+
+      # Creates or update the center user if valid.
+      #
+      # Broadcasts :ok if successful, :invalid otherwise.
+      def call
+        transaction do
+          delete_existing_center_user!
+          create_center_user!
+        rescue ActiveRecord::RecordInvalid
+          broadcast(:invalid)
+        end
+
+        broadcast(:ok, @center_user)
+      end
+
+      private
+
+      attr_reader :center, :user
+
+      def delete_existing_center_user!
+        CenterUser.where(user: user).destroy_all
+      end
+
+      def create_center_user!
+        @center_user = CenterUser.create!(center: center, user: user)
+      end
+    end
+  end
+end

data/app/commands/decidim/centers/create_or_update_scope_user.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Centers
+    # This command is executed when a new relationship between user
+    # and scope is created
+    class CreateOrUpdateScopeUser < Decidim::Command
+      # Initializes a CreateOrUpdateScopeUser Command.
+      #
+      # scope - The scope to be related with the user.
+      # user - The user to be related with the scope.
+      def initialize(scope, user)
+        @scope = scope
+        @user = user
+      end
+
+      # Creates or update the scope user if valid.
+      #
+      # Broadcasts :ok if successful, :invalid otherwise.
+      def call
+        transaction do
+          delete_existing_scope_user!
+          create_scope_user!
+        rescue ActiveRecord::RecordInvalid
+          broadcast(:invalid)
+        end
+
+        broadcast(:ok, @scope_user)
+      end
+
+      private
+
+      attr_reader :scope, :user
+
+      def delete_existing_scope_user!
+        ScopeUser.where(user: user).destroy_all
+      end
+
+      def create_scope_user!
+        @scope_user = ScopeUser.create!(scope: scope, user: user)
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/centers/admin/needs_select2_snippets.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Centers
+    module Admin
+      module NeedsSelect2Snippets
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :snippets
+        end
+
+        def snippets
+          @snippets ||= Decidim::Snippets.new
+
+          unless @snippets.any?(:select2)
+            @snippets.add(:select2, ActionController::Base.helpers.stylesheet_link_tag("https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/css/select2.min.css"))
+            @snippets.add(:select2, ActionController::Base.helpers.javascript_include_tag("https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/js/select2.min.js"))
+            @snippets.add(:head, @snippets.for(:select2))
+          end
+
+          unless @snippets.any?(:centers_admin_select2)
+            @snippets.add(:centers_admin_select2, ActionController::Base.helpers.javascript_pack_tag("decidim_centers_admin_select2"))
+            @snippets.add(:centers_admin_select2, ActionController::Base.helpers.stylesheet_pack_tag("decidim_centers_admin_select2"))
+            @snippets.add(:head, @snippets.for(:centers_admin_select2))
+          end
+
+          @snippets
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/centers/devise/omniauth_registrations_controller_override.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Centers
+    module Devise
+      module OmniauthRegistrationsControllerOverride
+        extend ActiveSupport::Concern
+
+        included do
+          alias_method :original_first_login_and_not_authorized?, :first_login_and_not_authorized?
+
+          def first_login_and_not_authorized?(user)
+            original_first_login_and_not_authorized?(user) && Decidim::Verifications.workflows.any? { |manifest| manifest.name != "center" }
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/centers/devise/sessions_controller_override.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Centers
+    module Devise
+      module SessionsControllerOverride
+        extend ActiveSupport::Concern
+
+        included do
+          alias_method :original_first_login_and_not_authorized?, :first_login_and_not_authorized?
+
+          def first_login_and_not_authorized?(user)
+            original_first_login_and_not_authorized?(user) && current_organization.available_authorizations.excluding("center").any?
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/centers/with_scopes_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Centers
+    module WithScopesHelper
+      extend ActiveSupport::Concern
+
+      included do
+        helper Decidim::ScopesHelper
+      end
+    end
+  end
+end

data/app/controllers/decidim/centers/admin/application_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Centers
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::ApplicationController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::ApplicationController
+        register_permissions(::Decidim::Centers::Admin::ApplicationController,
+                             ::Decidim::Centers::Admin::Permissions,
+                             ::Decidim::Admin::Permissions)
+
+        private
+
+        def permission_class_chain
+          ::Decidim.permissions_registry.chain_for(::Decidim::Centers::Admin::ApplicationController)
+        end
+      end
+    end
+  end
+end