decidim-verifications 0.8.0

data/config/locales/ru.yml

@@ -0,0 +1,5 @@
+ru:
+  activemodel:
+    attributes:
+      id_document_upload:
+        user: Участник

data/config/locales/uk.yml

@@ -0,0 +1,41 @@
+uk:
+  activemodel:
+    attributes:
+      id_document_information:
+        document_number: Номер документа (з літерою)
+        document_type: Тип документа
+      id_document_upload:
+        document_number: Номер документа (з літерою)
+        document_type: Тип вашого документа
+        user: Учасник
+        verification_attachment: Сканована копія вашого документа
+  decidim:
+    admin:
+      menu:
+        authorization_workflows: Перевірки
+    authorization_handlers:
+      help: Допомога
+      multistep: Багатокроковий
+      name: Ім'я
+      postal_letter:
+        explanation: Ми надішлемо вам поштовий лист із кодом, який вам потрібно ввести, щоб ми могли підтвердити вашу адресу
+    verifications:
+      postal_letter:
+        admin:
+          pending_authorizations:
+            index:
+              username: Ім'я учасника
+              verification_code: Код підтвердження
+          postages:
+            create:
+              error: Помилка позначення листа як відправленого
+              success: Лист успішно позначено як відправлений
+        authorizations:
+          create:
+            error: Виникла проблема з вашим запитом
+            success: Дякуємо! Ми надішлемо код підтвердження на вашу адресу
+          edit:
+            send: Підтвердити
+            title: Введіть код підтвердження, який ви отримали
+          new:
+            send: Надішліть мені листа

data/db/migrate/20171030133426_move_authorizations_to_new_api.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+#
+# Assumes to authorizations in the old format (as rectify form classes) will be
+# registered as the underscored class name using the new API. For example, a
+# previous
+#
+# ```
+# config.authorization_handlers = ["Decidim::ExampleCensusHandler"]
+# ```
+#
+# will now be
+#
+# ```
+# Decidim::Verifications.register_workflow(:example_census_handler) do |auth|
+#   auth.form = "Decidim::ExampleCensusHandler"
+# end
+# ```
+#
+class MoveAuthorizationsToNewApi < ActiveRecord::Migration[5.1]
+  class Organization < ApplicationRecord
+    self.table_name = :decidim_organizations
+  end
+
+  class Feature < ApplicationRecord
+    self.table_name = :decidim_features
+  end
+
+  def up
+    Organization.find_each do |organization|
+      migrated_authorizations = organization.available_authorizations.map do |authorization|
+        authorization.demodulize.underscore
+      end
+
+      organization.update!(available_authorizations: migrated_authorizations)
+    end
+
+    Feature.find_each do |feature|
+      feature.permissions.transform_values! do |value|
+        value["authorization_handler_name"].classify.demodulize.underscore
+      end
+
+      feature.save!
+    end
+  end
+
+  def down
+    Organization.find_each do |organization|
+      migrated_authorizations = organization.available_authorizations.map do |authorization|
+        Decidim::Verifications.find_workflow_manifest(authorization).form
+      end
+
+      organization.update!(available_authorizations: migrated_authorizations)
+    end
+
+    Feature.find_each do |feature|
+      feature.permissions.transform_values! do |value|
+        workflow = Decidim::Verifications.find_workflow_manifest(value)
+
+        workflow.form.underscore
+      end
+
+      feature.save!
+    end
+  end
+end

data/lib/decidim/verifications.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "decidim/verifications/engine"
+require "decidim/verifications/workflows"
+
+require "decidim/verifications/id_documents"
+require "decidim/verifications/postal_letter"
+require "decidim/verifications/dummy"
+
+module Decidim
+  def self.authorization_workflows
+    Decidim::Verifications.workflows
+  end
+
+  def self.authorization_engines
+    Decidim::Verifications.workflows.select(&:engine)
+  end
+
+  def self.authorization_admin_engines
+    Decidim::Verifications.workflows.select(&:admin_engine)
+  end
+
+  def self.authorization_handlers
+    Decidim::Verifications.workflows.select(&:form)
+  end
+end

data/lib/decidim/verifications/adapter.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    class InvalidVerificationRoute < StandardError
+      def new(route:)
+        msg = <<~MSG
+          You specified a direct handler but you're trying to use `#{route}`
+          which is only available for multi-step authorization workflows. Change
+          your workflow to define an engine with a `#{route}` route.
+        MSG
+
+        super(msg)
+      end
+    end
+
+    class UnregisteredVerificationManifest < StandardError
+    end
+
+    #
+    # Provides a unified interface for direct and deferred authorizations, so
+    # they can be used transparently
+    #
+    class Adapter
+      include Rails.application.routes.mounted_helpers
+
+      def self.from_collection(collection)
+        collection.map { |e| from_element(e) }
+      end
+
+      def self.from_element(element)
+        manifest = Verifications.find_workflow_manifest(element)
+
+        raise UnregisteredVerificationManifest unless manifest
+
+        new(manifest)
+      end
+
+      def initialize(manifest)
+        @manifest = manifest
+      end
+
+      delegate :key, :name, :fullname, :description, :type, to: :manifest
+
+      #
+      # Main entry point for the verification engine
+      #
+      def root_path(redirect_url: nil)
+        if manifest.type == "direct"
+          decidim_verifications.new_authorization_path(handler: name, redirect_url: redirect_url)
+        else
+          main_engine.send(:root_path, redirect_url: redirect_url)
+        end
+      end
+
+      #
+      # In the case of deferred authorizations, route to resume an authorization
+      # process. Otherwise it rises
+      #
+      def resume_authorization_path(redirect_url: nil)
+        if manifest.type == "direct"
+          raise InvalidDirectVerificationRoute.new(route: "edit_authorization_path")
+        end
+
+        main_engine.send(:edit_authorization_path, redirect_url: redirect_url)
+      end
+
+      #
+      # Administrational entry point for the verification engine
+      #
+      def admin_root_path
+        if manifest.type == "direct"
+          raise InvalidDirectVerificationROute.new(route: "admin_route_path")
+        end
+
+        public_send(:"decidim_admin_#{name}").send(:root_path)
+      end
+
+      private
+
+      attr_reader :manifest
+
+      def main_engine
+        send("decidim_#{manifest.name}")
+      end
+    end
+  end
+end

data/lib/decidim/verifications/dummy.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Decidim::Verifications.register_workflow(:dummy_authorization_handler) do |workflow|
+  workflow.form = "Decidim::DummyAuthorizationHandler"
+end

data/lib/decidim/verifications/engine.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    # Decidim's core Rails Engine.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::Verifications
+
+      routes do
+        authenticate(:user) do
+          resources :authorizations, only: [:new, :create, :index] do
+            collection do
+              get :first_login
+            end
+          end
+
+          Decidim.authorization_engines.each do |manifest|
+            mount manifest.engine, at: "/#{manifest.name}", as: "decidim_#{manifest.name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/verifications/id_documents.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "decidim/verifications/id_documents/admin"
+require "decidim/verifications/id_documents/engine"
+require "decidim/verifications/id_documents/admin_engine"
+require "decidim/verifications/id_documents/workflow"

data/lib/decidim/verifications/id_documents/admin.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    module IdDocuments
+      # This module contains all the domain logic associated to Decidim's
+      # identity documents authorization admin panel.
+      module Admin
+      end
+    end
+  end
+end

data/lib/decidim/verifications/id_documents/admin_engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    module IdDocuments
+      # This is an engine that performs an example user authorization.
+      class AdminEngine < ::Rails::Engine
+        isolate_namespace Decidim::Verifications::IdDocuments::Admin
+
+        routes do
+          resources :pending_authorizations, only: :index do
+            resource :confirmations, only: [:new, :create], as: :confirmation
+            resource :rejections, only: :create, as: :rejection
+          end
+
+          root to: "pending_authorizations#index"
+        end
+      end
+    end
+  end
+end

data/lib/decidim/verifications/id_documents/engine.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    module IdDocuments
+      # This is an engine that performs an example user authorization.
+      class Engine < ::Rails::Engine
+        isolate_namespace Decidim::Verifications::IdDocuments
+
+        routes do
+          resource :authorizations, only: [:new, :create, :edit, :update], as: :authorization
+
+          root to: "authorizations#new"
+        end
+      end
+    end
+  end
+end

data/lib/decidim/verifications/id_documents/workflow.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Decidim::Verifications.register_workflow(:id_documents) do |workflow|
+  workflow.engine = Decidim::Verifications::IdDocuments::Engine
+  workflow.admin_engine = Decidim::Verifications::IdDocuments::AdminEngine
+end

data/lib/decidim/verifications/postal_letter.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "decidim/verifications/postal_letter/admin"
+require "decidim/verifications/postal_letter/engine"
+require "decidim/verifications/postal_letter/admin_engine"
+require "decidim/verifications/postal_letter/workflow"

data/lib/decidim/verifications/postal_letter/admin.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    module PostalLetter
+      # This module contains all the domain logic associated to Decidim's
+      # postal letter authorization admin panel.
+      module Admin
+      end
+    end
+  end
+end

data/lib/decidim/verifications/postal_letter/admin_engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    module PostalLetter
+      # This is an engine that implements the administration interface for
+      # user authorization by postal letter code.
+      class AdminEngine < ::Rails::Engine
+        isolate_namespace Decidim::Verifications::PostalLetter::Admin
+
+        routes do
+          resources :pending_authorizations, only: :index do
+            resource :postages, only: :create, as: :postage
+          end
+
+          root to: "pending_authorizations#index"
+        end
+      end
+    end
+  end
+end

data/lib/decidim/verifications/postal_letter/engine.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    module PostalLetter
+      # This is an engine that performs an example user authorization.
+      class Engine < ::Rails::Engine
+        isolate_namespace Decidim::Verifications::PostalLetter
+
+        routes do
+          resource :authorizations, only: [:new, :create, :edit, :update], as: :authorization
+
+          root to: "authorizations#new"
+        end
+      end
+    end
+  end
+end

data/lib/decidim/verifications/postal_letter/workflow.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Decidim::Verifications.register_workflow(:postal_letter) do |workflow|
+  workflow.engine = Decidim::Verifications::PostalLetter::Engine
+  workflow.admin_engine = Decidim::Verifications::PostalLetter::AdminEngine
+end

data/lib/decidim/verifications/registry.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "decidim/verifications/workflow_manifest"
+
+module Decidim
+  module Verifications
+    #
+    # Takes care of holding and accessing verification methods.
+    #
+    class Registry
+      def register_workflow(name)
+        manifest = WorkflowManifest.new(name: name.to_s)
+        yield(manifest)
+        add_workflow(manifest)
+      end
+
+      def add_workflow(manifest)
+        manifest.validate!
+        workflow_collection.add(manifest)
+      end
+
+      def clear_workflows
+        workflow_collection.clear
+      end
+
+      def reset_workflows(*manifests)
+        clear_workflows
+
+        manifests.each do |manifest|
+          add_workflow(manifest)
+        end
+      end
+
+      def workflow_collection
+        @workflow_collection ||= Set.new
+      end
+    end
+  end
+end