decidim-centers 0.1.1

data/lib/decidim/centers/engine.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "rails"
+require "decidim/core"
+require "deface"
+
+module Decidim
+  module Centers
+    # This is the engine that runs on the public interface of centers.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::Centers
+
+      routes do
+        # Add engine routes here
+        # resources :centers
+        # root to: "centers#index"
+      end
+
+      config.to_prepare do
+        # commands
+        Decidim::CreateOmniauthRegistration.prepend(Decidim::Centers::CreateOmniauthRegistrationOverride)
+        Decidim::CreateRegistration.prepend(Decidim::Centers::CreateRegistrationOverride)
+        Decidim::UpdateAccount.prepend(Decidim::Centers::UpdateAccountOverride)
+        # forms
+        Decidim::RegistrationForm.include(Decidim::Centers::AccountFormOverride)
+        Decidim::OmniauthRegistrationForm.include(Decidim::Centers::AccountFormOverride)
+        Decidim::AccountForm.include(Decidim::Centers::AccountFormOverride)
+        # models
+        Decidim::User.include(Decidim::Centers::UserOverride)
+        Decidim::RegistrationForm.include(Centers::AccountFormOverride)
+        Decidim::OmniauthRegistrationForm.include(Centers::AccountFormOverride)
+        Decidim::AccountForm.include(Centers::AccountFormOverride)
+        Decidim::CreateOmniauthRegistration.prepend(Centers::CreateOmniauthRegistrationOverride)
+        Decidim::CreateRegistration.prepend(Centers::CreateRegistrationOverride)
+        Decidim::UpdateAccount.prepend(Centers::UpdateAccountOverride)
+      end
+
+      initializer "decidim_centers.sync" do
+        ActiveSupport::Notifications.subscribe "decidim.centers.user.updated" do |_name, data|
+          Decidim::Centers::SyncCenterUserJob.perform_later(data)
+        end
+      end
+
+      initializer "decidim_centers.overrides", after: "decidim.action_controller" do
+        config.to_prepare do
+          Decidim::Admin::ResourcePermissionsController.include(Decidim::Centers::Admin::NeedsSelect2Snippets)
+          Decidim::Devise::SessionsController.include(Decidim::Centers::Devise::SessionsControllerOverride)
+          Decidim::Devise::OmniauthRegistrationsController.include(Decidim::Centers::Devise::OmniauthRegistrationsControllerOverride)
+          Decidim::Devise::OmniauthRegistrationsController.include(Decidim::Centers::WithScopesHelper)
+          Decidim::Devise::RegistrationsController.include(Decidim::Centers::WithScopesHelper)
+        end
+      end
+
+      initializer "decidim_centers.sync" do
+        ActiveSupport::Notifications.subscribe "decidim.centers.user.updated" do |_name, data|
+          Decidim::Centers::SyncCenterUserJob.perform_now(data)
+          Decidim::Centers::SyncScopeUserJob.perform_now(data) if Decidim::Centers.scopes_enabled
+          Decidim::Centers::AutoVerificationJob.perform_later(data[:user_id])
+        end
+      end
+
+      initializer "decidim_centers.authorizations" do
+        Decidim::Verifications.register_workflow(:center) do |workflow|
+          workflow.form = "Decidim::Centers::Verifications::Center"
+          workflow.action_authorizer = "Decidim::Centers::Verifications::CenterActionAuthorizer"
+
+          workflow.options do |options|
+            options.attribute :centers, type: :string
+            options.attribute :scopes, type: :string if Decidim::Centers.scopes_enabled
+          end
+        end
+      end
+
+      initializer "decidim_centers.webpacker.assets_path" do
+        Decidim.register_assets_path File.expand_path("app/packs", root)
+      end
+    end
+  end
+end

data/lib/decidim/centers/test/factories.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"
+
+FactoryBot.define do
+  factory :center, class: "Decidim::Centers::Center" do
+    organization { create :organization }
+    title { generate_localized_title }
+    deleted_at { nil }
+
+    trait :deleted do
+      deleted_at { Time.current }
+    end
+  end
+
+  factory :center_user, class: "Decidim::Centers::CenterUser" do
+    user { create :user }
+    center { create :center, organization: user.organization }
+  end
+
+  factory :scope_user, class: "Decidim::Centers::ScopeUser" do
+    user { create :user }
+    scope { create :scope, organization: user.organization }
+  end
+end

data/lib/decidim/centers/test/shared_contexts.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+def check_center_authorization(authorization, user, center, scope = nil)
+  expect(authorization.name).to eq("center")
+  expect(authorization.user).to eq(user)
+  expect(authorization.metadata["centers"]).to include(center.id)
+  expect(authorization.metadata["scopes"]).to include(scope.id) if scope
+end
+
+shared_examples_for "no authorization is created" do
+  it "does not create an authorization" do
+    expect { subject.perform_now(params) }.not_to change(Decidim::Authorization, :count)
+  end
+end
+
+shared_context "with scopes disabled" do
+  let(:scope) { nil }
+
+  before do
+    allow(Decidim::Centers).to receive(:scopes_enabled).and_return(false)
+  end
+end

data/lib/decidim/centers/verifications/center_action_authorizer.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Centers
+    module Verifications
+      class CenterActionAuthorizer < Decidim::Verifications::DefaultActionAuthorizer
+        def authorize
+          return [:missing, { action: :authorize }] if authorization.blank?
+
+          status_code = :unauthorized
+          return [status_code, { fields: { centers: "..." } }] if authorization_centers.blank?
+          return [:ok, {}] if belongs_to_center? && belongs_to_scope?
+
+          [status_code, {}]
+        end
+
+        private
+
+        def options_centers
+          options["centers"]&.split(",") || []
+        end
+
+        def options_scopes
+          return [] unless Decidim::Centers.scopes_enabled
+
+          options["scopes"]&.split(",") || []
+        end
+
+        def authorization_centers
+          authorization.metadata["centers"] || []
+        end
+
+        def authorization_scopes
+          authorization.metadata["scopes"] || []
+        end
+
+        def belongs_to_center?
+          options_centers.empty? || options_centers.detect { |center| authorization_centers.include? center.to_i }
+        end
+
+        def belongs_to_scope?
+          return true unless Decidim::Centers.scopes_enabled
+
+          options_scopes.empty? || options_scopes.detect { |scope| authorization_scopes.include? scope.to_i }
+        end
+      end
+    end
+  end
+end

data/lib/decidim/centers/verifications.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "verifications/center_action_authorizer"
+
+module Decidim
+  module Centers
+    # This namespace holds the logic to verify users with their centers data.
+    module Verifications
+    end
+  end
+end

data/lib/decidim/centers/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This holds the decidim-centers version.
+  module Centers
+    VERSION = "0.1.1"
+    DECIDIM_VERSION = "0.27.4"
+    COMPAT_DECIDIM_VERSION = [">= 0.27.0", "< 0.28"].freeze
+  end
+end

data/lib/decidim/centers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "decidim/centers/admin"
+require "decidim/centers/engine"
+require "decidim/centers/admin_engine"
+require "decidim/centers/verifications"
+
+module Decidim
+  # This namespace holds the logic of the `Centers` module. This module
+  # allows users to create centers in a participatory space.
+  module Centers
+    include ActiveSupport::Configurable
+
+    # if false, it won't ask the user for the scope
+    config_accessor :scopes_enabled do
+      Decidim::Env.new("DECIDIM_CENTERS_SCOPES_ENABLED", true).default_or_present_if_exists
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: decidim-centers
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Francisco Bolívar
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: decidim-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: Manage your centers and scopes so the users can be authorized over them.
+email:
+- francisco.bolivar@nazaries.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE-AGPLv3.txt
+- README.md
+- Rakefile
+- app/commands/concerns/decidim/centers/create_omniauth_registration_override.rb
+- app/commands/concerns/decidim/centers/create_registration_override.rb
+- app/commands/concerns/decidim/centers/publish_center_update_event.rb
+- app/commands/concerns/decidim/centers/update_account_override.rb
+- app/commands/decidim/centers/admin/create_center.rb
+- app/commands/decidim/centers/admin/destroy_center.rb
+- app/commands/decidim/centers/admin/update_center.rb
+- app/commands/decidim/centers/create_or_update_center_user.rb
+- app/commands/decidim/centers/create_or_update_scope_user.rb
+- app/controllers/concerns/decidim/centers/admin/needs_select2_snippets.rb
+- app/controllers/concerns/decidim/centers/devise/omniauth_registrations_controller_override.rb
+- app/controllers/concerns/decidim/centers/devise/sessions_controller_override.rb
+- app/controllers/concerns/decidim/centers/with_scopes_helper.rb
+- app/controllers/decidim/centers/admin/application_controller.rb
+- app/controllers/decidim/centers/admin/centers_controller.rb
+- app/controllers/decidim/centers/admin/scopes_controller.rb
+- app/forms/concerns/decidim/centers/account_form_override.rb
+- app/forms/decidim/centers/admin/center_form.rb
+- app/forms/decidim/centers/verifications/center.rb
+- app/helpers/decidim/centers/application_helper.rb
+- app/jobs/decidim/centers/auto_verification_job.rb
+- app/jobs/decidim/centers/sync_center_user_job.rb
+- app/jobs/decidim/centers/sync_scope_user_job.rb
+- app/models/concerns/decidim/centers/unique_by_user.rb
+- app/models/concerns/decidim/centers/user_override.rb
+- app/models/decidim/centers/application_record.rb
+- app/models/decidim/centers/center.rb
+- app/models/decidim/centers/center_user.rb
+- app/models/decidim/centers/scope_user.rb
+- app/overrides/decidim/account/show/centers.html.erb.deface
+- app/overrides/decidim/devise/omniauth_registrations/new/centers.html.erb.deface
+- app/overrides/decidim/devise/registrations/new/centers.html.erb.deface
+- app/packs/entrypoints/decidim_centers_admin_select2.js
+- app/packs/src/decidim/centers/admin/resource_permissions_select2.js
+- app/packs/stylesheets/vendor/select2_foundation_theme.scss
+- app/permissions/decidim/centers/admin/permissions.rb
+- app/presenters/decidim/centers/admin_log/center_presenter.rb
+- app/views/decidim/centers/_profile_form.html.erb
+- app/views/decidim/centers/_registration_form.html.erb
+- app/views/decidim/centers/admin/centers/_form.html.erb
+- app/views/decidim/centers/admin/centers/edit.html.erb
+- app/views/decidim/centers/admin/centers/index.html.erb
+- app/views/decidim/centers/admin/centers/new.html.erb
+- config/assets.rb
+- config/i18n-tasks.yml
+- config/locales/en.yml
+- db/migrate/20231129114029_create_decidim_centers_centers.rb
+- db/migrate/20231130125631_create_decidim_centers_center_users.rb
+- db/migrate/20231205153627_create_decidim_centers_scope_users.rb
+- lib/decidim/centers.rb
+- lib/decidim/centers/admin.rb
+- lib/decidim/centers/admin_engine.rb
+- lib/decidim/centers/engine.rb
+- lib/decidim/centers/test/factories.rb
+- lib/decidim/centers/test/shared_contexts.rb
+- lib/decidim/centers/verifications.rb
+- lib/decidim/centers/verifications/center_action_authorizer.rb
+- lib/decidim/centers/version.rb
+homepage: https://github.com/decidim/decidim-module-centers
+licenses:
+- AGPL-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A decidim module to categorize users with centers and scopes
+test_files: []