decidim-voca 0.0.6

data/README.md

@@ -0,0 +1,153 @@
+[![coverage](https://git.octree.ch/decidim/vocacity/tasks/badges/main/coverage.svg?job=coverage-024)](https://github.com/octree-gva/voca-tasks)
+
+[![release](https://git.octree.ch/decidim/vocacity/tasks/badges/main/release.svg)](https://github.com/octree-gva/voca-tasks)
+
+# Voca
+
+Create&Manage Decidim instances on-the-fly, deploy all its ecosystem.
+Voca focuses on Decidim, released on [APGL-3 open-source license](LICENSE.md) and all the ecosystem around the platform. As _Decidim is not a tool, but a framework for digital democratic participation, many tools gravitates around Decidim._
+
+# RPC private API for Decidim
+This gem add internal functionalities to Decidim in order to be managed remotly. We do mostly: 
+
+- Setup [gruf](https://github.com/bigcommerce/gruf) to run a gRPC server
+- Implement the [decidim.proto](https://raw.githubusercontent.com/octree-gva/voca-system/main/backend/contrib/rpc-protos/decidim/decidim.proto) spec
+- Add a middleware two dynamically set config data. 
+
+
+## RPC
+From the .proto file, two files are generated, lib/decidim/voca/rpc/decidim_pb.rb and lib/decidim/voca/rpc/decidim_services_pb.rb. These files describe the skeletton of the input and response we need to comply. 
+
+In the controller `Decidim::Voca::DecidimServiceController`, we bind its method to these services and execute Commands for each methods. 
+For example, a compile method is implemented this way: 
+
+```
+    ## Compile assets.
+    def compile_assets
+        `bundle exec rails assets:precompile`
+        ::Google::Protobuf::Empty.new
+    end
+```
+
+When the code to resolves a RPC methods take more than 2 lines, we do a Command to isolate the code in one class. This is the case for most of the code. You can find the in the [rpc directory](./app/rpc/decidim/voca/rpc).
+
+### Casting
+As RPC is a generic way to build APIs, we have to translate constants in appropriate string for the application. 
+
+For example, `SETTINGS_REGISTER_MODE_OPTION::SETTINGS_REGISTER_MODE_REGISTER_AND_LOGIN` is actually just `enable` for the user_register_mode Decidim settings. To do so, 
+we have an utility class `Decidim::Voca::Rpc::EnumCaster`.
+
+## Middleware
+We get inspiration on [this article](https://pawelurbanek.com/rails-dynamic-config) to setup a middleware that retrieve config values from redis and then inject it into the code. 
+
+For every query, we do a small step of getting data from our Redis store, 
+and inject the configuration object in Decidim. Like this:
+```
+ # ./lib/decidim/voca/middleware/dynamic_config_middleware.rb
+    if config_data["currency_unit"].present?
+        Decidim.currency_unit = config_data["currency_unit"]
+    end
+```
+
+This is particularly usefull as it allows us to include Decidim configurations in our `decidim.proto` file, and set the redis value when needed. 
+
+```
+# ./app/commands/decidim/voca/organization/update_locale_command.rb
+global_configuration = locale_settings.select do |key| 
+    "#{key}" == "currency_unit" || "#{key}" == "timezone"
+end.delete_if { |_k, v| v.blank? }
+unless global_configuration.empty?
+    redis_client = Redis.new(
+        url: ENV.fetch("REDIS_CONFIG_URL", "redis://127.0.0.1:6379/2"),
+    );
+    global_configuration.each do |key, value|
+        # Update the Redis hash values
+        redis_client.hset("config", "#{key}", "#{value}")
+    end
+    # Close the Redis connection
+    redis_client.quit  
+end
+```
+## Repositories
+
+| repo                                                     | info                                                                        | stable version |
+| -------------------------------------------------------- | --------------------------------------------------------------------------- | -------------- |
+| [voca-system](https://github.com/octree-gva/voca-system) | Install and manage decidim instances through a Dashboard                    | v0.1.0         |
+| [voca-tasks](https://github.com/octree-gva/voca-tasks)   | Gem embedded in our Decidim image. Manipulate and manage decidim instances. | v0.1.0         |
+| [voca-jps](https://github.com/octree-gva/voca-jps)       | Jelastic Manifest to deploy Decidim images                                  | v0.1.0         |
+| [voca-docker](https://github.com/octree-gva/voca-docker) | Build Decidim docker images for Voca                                        | v0.1.0         |
+| [voca-protos](https://github.com/octree-gva/voca-protos) | RPC prototypes for voca                                        | v0.1.0         |
+
+# Decidim::Voca
+
+This Gem allows configuring a Decidim instance with gRPC. This is a domain-specific gem, which is useful only if you host your own Voca system.
+
+## Readings before starting
+
+* [gruf, a RPC gem for rails](https://github.com/bigcommerce/gruf)
+* [GRPC for ruby](https://grpc.io/docs/languages/ruby/)
+* [proto3 Styleguide](https://developers.google.com/protocol-buffers/docs/style)
+
+## Repository structure
+
+### Generated client
+The client is generated with `bundle exec rails update_voca_proto`, and
+save the client and service in [`/lib/decidim/voca/rpc`](./lib/decidim/voca/rpc)
+
+### RPC Decidim Service
+The entry point for RPC Decidim Service is in [`/app/rpc/decidim/voca/decidim_service_controller.rb`](./app/rpc/decidim/voca/decidim_service_controller.rb).
+This controller have a method per registered message, and will call some concerns in the `/app/rpc/decidim/voca/rpc` folder.
+
+### Updating commands
+We use Rectify::Command in `/app/commmands/decidim/voca` for all update-related command.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-voca"
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+## Development
+
+We suppose you have docker installed in your environment.
+
+```sh
+docker-compose up -d
+docker-compose run --rm app bash -c "cd $RAILS_ROOT && rails db:migrate"
+```
+
+Your development app with the gem is ready on `http://localhost:3000`
+
+### Run tests
+
+`test_app` will create a `spec/dummy` app, and will run a local PostGres container.
+This command has to be done before executing tests.
+
+```sh
+bundle && bundle exec rails test_app
+```
+
+Once this command pass, execute:
+
+```sh
+bundle exec rspec spec
+```
+
+to run the unit tests.
+
+## Contributing
+
+See [Contributing](CONTRIBUTING.md).
+
+## License
+
+See [License](LICENSE.md).

data/Rakefile

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+def install_module(path)
+  Dir.chdir(path) do
+    # system("bundle exec rake decidim_voca:install:migrations")
+  end
+end
+
+def seed_db(path)
+  Dir.chdir(path) do
+    system("bundle exec rails db:seed")
+  end
+end
+
+desc "Prepare for testing"
+task :prepare_tests do
+  # Remove previous existing db, and recreate one.
+  disable_docker_compose = ENV.fetch("DISABLED_DOCKER_COMPOSE", "false") == "true"
+  unless disable_docker_compose
+    system("docker-compose -f docker-compose.yml down -v")
+    system("docker-compose -f docker-compose.yml up -d --remove-orphans")
+  end
+  ENV["RAILS_ENV"] = "test"
+  databaseYml = {
+    "test" => {
+      "adapter" => "postgresql",
+      "encoding" => "unicode",
+      "host" => ENV.fetch("DATABASE_HOST", "localhost"),
+      "port" => ENV.fetch("DATABASE_PORT", "5432").to_i,
+      "username" => ENV.fetch("DATABASE_USERNAME", "decidim"),
+      "password" => ENV.fetch("DATABASE_PASSWORD", "TEST-baeGhi4Ohtahcee5eejoaxaiwaezaiGo"),
+      "database" => "decidim_test"
+    }
+  }
+
+  config_file = File.expand_path("spec/dummy/config/database.yml", __dir__)
+  File.open(config_file, "w") { |f| YAML.dump(databaseYml, f) }
+  Dir.chdir("spec/dummy") do
+     system("bundle exec rails db:migrate")
+   end
+end
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  Bundler.with_original_env do
+    generate_decidim_app(
+      "spec/dummy",
+        "--app_name",
+        "decidim_test",
+        "--path",
+        "../..",
+        "--skip_spring",
+        "--demo",
+        "--force_ssl",
+        "false",
+        "--locales",
+        "en,fr,es"
+    )
+  end
+  install_module("spec/dummy")
+  Rake::Task["prepare_tests"].invoke
+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
+end
+
+desc "Update protos for voca"
+task :update_voca_proto do
+  %x(rm -rf ./lib/decidim/voca/rpc && mkdir -p ./lib/decidim/voca/rpc)
+  %x(curl -H 'Cache-Control: no-cache, no-store' -H 'Pragma: no-cache' https://raw.githubusercontent.com/octree-gva/voca-protos/main/clients/decidim-ruby-client.tar.gz | tar -xz -C ./lib/decidim/voca/rpc)
+  puts "✅ /lib/decidim/voca/rpc udpated"
+end

data/app/assets/images/decidim/voca/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm9.5 13.7H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zm0 3.68H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zM22.26 23H8a1 1 0 0 1 0-1.94h14.26a1 1 0 0 1 0 1.94z"/></svg>

data/app/commands/decidim/voca/organization/command.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Voca
+    module Organization
+      # maintains compatibility with v0.26 which uses Rectify
+      if defined? ::Decidim::Command
+        class Command < ::Decidim::Command
+        end
+      else
+        class Command < ::Rectify::Command
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/voca/organization/organization_command.rb

@@ -0,0 +1,17 @@
+module Decidim
+  module Voca
+    module Organization
+      class OrganizationCommand < ::Command
+        def organization
+          @organization ||= ::Decidim::Organization.first
+        end
+        def self.command_name
+          name.demodulize.camelize.stub(/_command/, "")
+        end
+        def command_name
+          self.command_name
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/voca/organization/update_color_command.rb

@@ -0,0 +1,35 @@
+module Decidim
+  module Voca
+    module Organization
+      class UpdateColorCommand < OrganizationCommand
+        attr_reader :color_settings
+        def initialize(color_settings)
+          @color_settings = with_defaults(color_settings.to_h.with_indifferent_access)
+        end
+
+        def call
+          organization.update!(
+            colors: (organization.colors || []).merge(color_settings.delete_if { |_k, v| v.blank? })
+            )
+          broadcast(:ok)
+        rescue e
+          Rails.logger.error(e)
+          broadcast(:fail)
+        end
+
+        private
+          def with_defaults(colors)
+            {
+              "alert": "#ec5840",
+              "primary": "#cb3c29",
+              "success": "#57d685",
+              "warning": "#ffae00",
+              "highlight": "#be6400",
+              "secondary": "#39747f",
+              "highlight-alternative": "#be6400"
+            }.merge(colors)
+          end
+      end
+    end
+  end
+end

data/app/commands/decidim/voca/organization/update_environment_command.rb

@@ -0,0 +1,23 @@
+module Decidim
+  module Voca
+    module Organization
+      class UpdateEnvironmentCommand < OrganizationCommand
+        attr_reader :config
+        def initialize(config)
+          @config =  config.to_h.with_indifferent_access
+        end
+
+        def call
+          redis = Redis.new(url: ENV["REDIS_CONFIG_URL"])
+          config.each do |key, value|
+            redis.hset("config",key,value)
+          end
+          broadcast(:ok)
+        rescue 
+          Rails.logger.error("ERROR")
+          broadcast(:fail)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/voca/organization/update_feature_command.rb

@@ -0,0 +1,32 @@
+module Decidim
+  module Voca
+    module Organization
+      class UpdateFeatureCommand < OrganizationCommand
+        attr_reader :feature_settings
+        def initialize(feature_settings)
+          @feature_settings = with_enums(
+            feature_settings.to_h.with_indifferent_access
+          )
+        end
+
+        def call
+          organization.update!(
+            feature_settings.delete_if { |_k, v| v.blank? }
+          )
+          broadcast(:ok)
+        rescue e
+          Rails.logger.error(e)
+          broadcast(:fail)
+        end
+
+        private
+          def with_enums(settings)
+            settings["machine_translation_display_priority"] = Decidim::Voca::Rpc::EnumCasting.machine_translation_display_priority.rpc_to_decidim(
+              settings["machine_translation_display_priority"]
+            )
+            settings
+          end
+      end
+    end
+  end
+end

data/app/commands/decidim/voca/organization/update_file_upload_command.rb

@@ -0,0 +1,45 @@
+module Decidim
+  module Voca
+    module Organization
+      class UpdateFileUploadCommand < OrganizationCommand
+        attr_reader :file_upload_settings
+        def initialize(file_upload_settings)
+          @file_upload_settings = with_defaults(
+            file_upload_settings.to_h.with_indifferent_access
+          )
+        end
+
+        def call
+          organization.update!(
+            file_upload_settings: file_upload_settings
+          )
+          broadcast(:ok)
+        rescue e
+          Rails.logger.error(e)
+          broadcast(:fail)
+        end
+
+        private
+          def with_defaults(settings)
+            uploads = ::Decidim::OrganizationSettings.for(
+              organization
+            ).upload
+            uploads.to_h.merge({
+              maximum_file_size: uploads.maximum_file_size.to_h.merge({
+                avatar: settings[:maximum_file_size_avatar].to_i,
+                default: settings[:maximum_file_size_default].to_i,
+              }.delete_if { |_k, v| v == 0.0}),
+              allowed_content_types: uploads.allowed_content_types.to_h.merge({
+                admin: settings[:allowed_content_types_admin],
+                default: settings[:allowed_content_types_default],
+              }.delete_if { |_k, v| v.blank?}),
+              allowed_file_extensions: uploads.allowed_file_extensions.to_h.merge({
+                admin: settings[:allowed_file_extensions_admin],
+                default: settings[:allowed_file_extensions_default],
+              }.delete_if { |_k, v| v.blank?}),
+            }.delete_if { |_k, v| v.blank?})
+          end
+      end
+    end
+  end
+end

data/app/commands/decidim/voca/organization/update_locale_command.rb

@@ -0,0 +1,53 @@
+module Decidim
+  module Voca
+    module Organization
+      class UpdateLocaleCommand < OrganizationCommand
+        attr_reader :locale_settings
+        def initialize(locale_settings)
+          @locale_settings = locale_settings.to_h
+        end
+
+        def call
+          # update languages
+          organization_configuration = locale_settings.select do |key| 
+            "#{key}" == "available_locales" || "#{key}" == "default_locale"
+          end.delete_if { |_k, v| v.blank? }
+          organization.update!(organization_configuration)
+          after_updating_languages
+          # update localization settings (currency, timezone)
+          global_configuration = locale_settings.select do |key| 
+            "#{key}" == "currency_unit" || "#{key}" == "timezone"
+          end.delete_if { |_k, v| v.blank? }
+          unless global_configuration.empty?
+            redis_client = Redis.new(
+              url: ENV.fetch("REDIS_CONFIG_URL", "redis://127.0.0.1:6379/2"),
+            );
+            global_configuration.each do |key, value|
+              # Update the Redis hash values
+              redis_client.hset("config", "#{key}", "#{value}")
+            end
+            # Close the Redis connection
+            redis_client.quit  
+          end
+          broadcast(:ok)
+        rescue StandardError => e
+          Rails.logger.error(e)
+          broadcast(:fail)
+        end
+
+        private
+          def after_updating_languages
+            # Rebuild locales
+            `bundle exec rails decidim:locales:sync_all`
+            # Rebuild search tree
+            `bundle exec rails decidim:locales:rebuild_search`
+            org = organization.reload
+            # Update user locales (they might not have a locale that is now supported)
+            ::Decidim::User.where.not(locale: org.available_locales).each do |user|
+              user.update(locale: org.default_locale)
+            end
+          end
+      end
+    end
+  end
+end

data/app/commands/decidim/voca/organization/update_naming_command.rb

@@ -0,0 +1,30 @@
+module Decidim
+  module Voca
+    module Organization
+      class UpdateNamingCommand < OrganizationCommand
+        attr_reader :naming_settings
+        def initialize(naming_settings)
+          @naming_settings = naming_settings.to_h
+        end
+
+        def call
+          organization.update!(naming_settings.delete_if { |_k, v| v.blank? })
+          broadcast(:ok)
+        rescue e
+          Rails.logger.error(e)
+          broadcast(:fail)
+        end
+
+        private
+
+          def update_host
+            # Todo call Voca system to update the redirection
+          end
+
+          def update_subdomain
+            # Todo call Voca system to update aliases
+          end
+      end
+    end
+  end
+end

data/app/commands/decidim/voca/organization/update_permission_command.rb

@@ -0,0 +1,31 @@
+module Decidim
+  module Voca
+    module Organization
+      class UpdatePermissionCommand < OrganizationCommand
+        attr_reader :permission_settings
+        def initialize(permission_settings)
+          @permission_settings = cast_permission_settings(permission_settings.to_h)
+        end
+
+        def call
+          organization.update!(permission_settings.delete_if { |_k, v| v.blank? })
+          broadcast(:ok)
+        rescue e
+          Rails.logger.error(e)
+          broadcast(:fail)
+        end
+
+        private
+
+          def cast_permission_settings(permission_settings)
+            # Convert enums
+            casting = ::Decidim::Voca::Rpc::EnumCasting.users_registration_mode
+            permission_settings[:users_registration_mode] = casting.rpc_to_decidim(
+              permission_settings[:users_registration_mode]
+            )
+            permission_settings
+          end
+      end
+    end
+  end
+end

data/app/commands/decidim/voca/organization/update_smtp_command.rb

@@ -0,0 +1,51 @@
+module Decidim
+  module Voca
+    module Organization
+      class UpdateSmtpCommand < OrganizationCommand
+        attr_reader :smtp_settings
+        def initialize(smtp_settings)
+          @smtp_settings = transform_settings(smtp_settings.to_h.with_indifferent_access)
+        end
+
+        def call
+          organization.update!(
+            smtp_settings: smtp_settings.delete_if { |_k, v| v.blank? }
+          )
+          broadcast(:ok)
+        rescue => e
+          Rails.logger.error(e)
+          broadcast(:fail)
+        end
+
+        private
+
+          def transform_settings(settings)
+            from_label = settings.delete("from_label")
+            from_email = settings.delete("from_email")
+            username = settings.delete("username")
+            settings["openssl_verify_mode"] = Decidim::Voca::Rpc::EnumCasting.smtp_openssl_verify_mode.rpc_to_decidim(
+              settings["openssl_verify_mode"]
+            )
+            settings["authentication"] = Decidim::Voca::Rpc::EnumCasting.smtp_authentication.rpc_to_decidim(
+              settings["authentication"]
+            )
+            settings["user_name"] = username unless username.blank?
+            if from_email.blank? && !from_label.blank?
+              active_mailer_config = Rails.configuration.action_mailer.smtp_settings || {}
+              current = organization.smtp_settings || {}
+              mail = Mail::Address.new(
+                current.fetch("from", active_mailer_config.fetch(:from, "example@decidim.org"))
+              )
+              mail.display_name = from_label
+              settings[:from] = mail.to_s
+            elsif !from_email.blank?
+              mail = Mail::Address.new(from_email)
+              mail.display_name = from_label unless from_label.nil?
+              settings[:from] = mail.to_s
+            end
+            settings
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Voca
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Components::BaseController
+      end
+    end
+  end
+end

data/app/controllers/decidim/voca/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Voca
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+    end
+  end
+end

data/app/jobs/decidim/voca/command_job.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rake"
+module Decidim
+  module Voca
+    class CommandJob < ApplicationJob
+      attr_reader :logger, :variables, :command_name
+      def perform(command_name, variables = {}, logger = Rails.logger)
+        @command_name = command_name
+        @variables = variables
+        @logger = logger
+        invoke!
+      end
+
+      private
+
+        def invoke!
+          raise ::Decidim::Voca::Error unless valid?
+          ::Rake::Task["voca:#{command_name}"].invoke(task_args)
+        end
+
+        def task_args
+          variables.reduce([]) do |acc, (key, value)|
+            acc << "#{key}=\"#{value}\""
+          end.join(" ") unless variables.empty?
+        end
+
+        def valid?
+          Rake::Task["voca:#{command_name}"]
+          true
+        rescue RuntimeError
+          false
+        end
+    end
+  end
+end