Contents

# frozen_string_literal: true

module Decidim
  module Verifications
    #
    # This class serves as a DSL to declaratively specify a verification method.
    #
    # To define a direct verification method, you need to specify the `form`
    # attribute as a `Rectify::Form` that will be valid if the authorization is
    # valid.
    #
    # To define a deferred verification method, you need specify the `engine`
    # attribute as a full `Rails::Engine` (and optionally another engine for the
    # admin side as the `admin_engine` attribute). The verification will succeed
    # once the engine creates a valid authorization for the method with the
    # `granted_at` column set in DB.
    #
    # Note that whereas direct methods can be used for "on the fly"
    # verification, deferred methods require the authorization status to be
    # persisted into DB. That's the reason why only direct methods can be used
    # for user impersonation, for example, since they require continuous "on the
    # fly" verification by the impersonating user.
    #
    class WorkflowManifest
      include ActiveModel::Model
      include Virtus.model

      attribute :engine, Rails::Engine
      attribute :admin_engine, Rails::Engine
      attribute :form, String

      validate :engine_or_form

      attribute :name, String
      validates :name, presence: true

      def engine_or_form
        engine || form
      end

      def type
        form ? "direct" : "multistep"
      end

      alias key name

      def fullname
        I18n.t("#{key}.name", scope: "decidim.authorization_handlers")
      end

      def description
        "#{fullname} (#{I18n.t(type, scope: "decidim.authorization_handlers")})"
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
decidim-verifications-0.8.4	lib/decidim/verifications/workflow_manifest.rb
decidim-verifications-0.8.3	lib/decidim/verifications/workflow_manifest.rb
decidim-verifications-0.8.2	lib/decidim/verifications/workflow_manifest.rb
decidim-verifications-0.8.1	lib/decidim/verifications/workflow_manifest.rb
decidim-verifications-0.8.0	lib/decidim/verifications/workflow_manifest.rb