decidim-verifications 0.8.0

data/app/presenters/decidim/verifications/postal_letter/authorization_presenter.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    module PostalLetter
+      #
+      # Decorator for postal letter authorizations.
+      #
+      class AuthorizationPresenter < SimpleDelegator
+        def self.for_collection(authorizations)
+          authorizations.map { |authorization| new(authorization) }
+        end
+
+        #
+        # The address where the verification code will be sent
+        #
+        def verification_address
+          verification_metadata["address"]
+        end
+
+        #
+        # The verification code to be sent. It's kept in a different metadata
+        # key according to whether it has already been sent or not
+        #
+        def verification_code
+          if letter_sent?
+            verification_metadata["verification_code"]
+          else
+            verification_metadata["pending_verification_code"]
+          end
+        end
+
+        #
+        # Whether the letter with the verification code has already been sent or
+        # not
+        #
+        def letter_sent?
+          verification_metadata["verification_code"].present?
+        end
+
+        #
+        # Formatted time when the postal letter was sent. Or an informational
+        # string if not yet sent
+        #
+        def letter_sent_at
+          unless letter_sent?
+            return I18n.t("pending_authorizations.index.not_yet_sent",
+                          scope: "decidim.verifications.postal_letter.admin")
+          end
+
+          I18n.l(
+            Time.zone.parse(verification_metadata["letter_sent_at"]),
+            format: :short
+          )
+        end
+      end
+    end
+  end
+end

data/app/queries/decidim/verifications/authorizations.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    # Finds authorizations by different criteria
+    class Authorizations < Rectify::Query
+      # Initializes the class.
+      #
+      # @param name [String] The name of an authorization method
+      # @param user [User] A user to find authorizations for
+      # @param granted [Boolean] Whether the authorization is granted or not
+      def initialize(user: nil, name: nil, granted: nil)
+        @user = user
+        @name = name
+        @granted = granted
+      end
+
+      # Finds the Authorizations for the given method
+      #
+      # Returns an ActiveRecord::Relation.
+      def query
+        scope = Decidim::Authorization.where(nil)
+
+        scope = scope.where(name: name) unless name.nil?
+        scope = scope.where(user: user) unless user.nil?
+
+        if granted == true
+          scope = scope.where.not(granted_at: nil)
+        elsif granted == false
+          scope = scope.where(granted_at: nil)
+        end
+
+        scope
+      end
+
+      private
+
+      attr_reader :user, :name, :granted
+    end
+  end
+end

data/app/services/decidim/authorization_handler.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This is the base class for authorization handlers, all implementations
+  # should inherit from it.
+  # Each AuthorizationHandler is a form that will be used to check if the
+  # authorization is valid or not. When it is valid a new authorization will
+  # be created for the user.
+  #
+  # Feel free to use validations to assert fields against a remote API,
+  # local database, or whatever.
+  #
+  # It also sets two default attributes, `user` and `handler_name`.
+  class AuthorizationHandler < Form
+    # The user that is trying to authorize, it's initialized with the
+    # `current_user` from the controller.
+    attribute :user, Decidim::User
+
+    # The String name of the handler, should not be modified since it's used to
+    # infer the class name of the authorization handler.
+    attribute :handler_name, String
+
+    # A unique ID to be implemented by the authorization handler that ensures
+    # no duplicates are created. This uniqueness check will be skipped if
+    # unique_id returns nil.
+    def unique_id
+      nil
+    end
+
+    # THe attributes of the handler that should be exposed as form input when
+    # rendering the handler in a form.
+    #
+    # Returns an Array of Strings.
+    def form_attributes
+      attributes.except(:id, :user).keys
+    end
+
+    # The String partial path so Rails can render the handler as a form. This
+    # is useful if you want to have a custom view to render the form instead of
+    # the default view.
+    #
+    # Example:
+    #
+    #   A handler named Decidim::CensusHandler would look for its partial in:
+    #   decidim/census/form
+    #
+    # Returns a String.
+    def to_partial_path
+      handler_name.sub!(/_handler$/, "") + "/form"
+    end
+
+    # Any data that the developer would like to inject to the `metadata` field
+    # of an authorization when it's created. Can be useful if some of the
+    # params the user sent with the authorization form want to be persisted for
+    # future use.
+    #
+    # Returns a Hash.
+    def metadata
+      {}
+    end
+
+    #
+    # Any data to be injected in the `verification_metadata` field of an
+    # authorization when it's created. This data will be used for multi-step
+    # verificaton workflows in order to confirm the authorization.
+    #
+    # Returns a Hash.
+    def verification_metadata
+      {}
+    end
+
+    #
+    # An optional attachment to help out with verification.
+    #
+    def verification_attachment
+      nil
+    end
+
+    # A serialized version of the handler's name.
+    #
+    # Returns a String.
+    def self.handler_name
+      name.demodulize.underscore
+    end
+
+    # Same as the class method but accessible from the instance.
+    #
+    # Returns a String.
+    def handler_name
+      self.class.handler_name
+    end
+
+    # Finds a handler class from a String. This is necessary when processing
+    # the form data. It will only look for valid handlers that have also been
+    # configured in `Decidim.authorization_handlers`.
+    #
+    # name - The String name of the class to find, usually in the same shape as
+    # the one returned by `handler_name`.
+    # params - An optional Hash with params to initialize the handler.
+    #
+    # Returns an AuthorizationHandler descendant.
+    # Returns nil when no handlers could be found.
+    def self.handler_for(name, params = {})
+      return unless name
+
+      manifest = Decidim.authorization_handlers.find { |m| m.name == name }
+      return unless manifest
+
+      manifest.form.constantize.from_params(params || {})
+    end
+  end
+end

data/app/services/decidim/dummy_authorization_handler.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  # An example implementation of an AuthorizationHandler to be used in tests.
+  class DummyAuthorizationHandler < AuthorizationHandler
+    attribute :document_number, String
+    attribute :postal_code, String
+    attribute :birthday, Date
+
+    validates :document_number, presence: true
+    validate :valid_document_number
+
+    def metadata
+      super.merge(document_number: document_number)
+    end
+
+    def unique_id
+      document_number
+    end
+
+    private
+
+    def valid_document_number
+      errors.add(:document_number, :invalid) unless document_number.to_s.end_with?("X")
+    end
+  end
+end

data/app/uploaders/decidim/verifications/attachment_uploader.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    # This class deals with uploading identity documents.
+    class AttachmentUploader < ImageUploader
+      version :thumbnail do
+        process resize_to_limit: [90, nil]
+      end
+
+      version :big do
+        process resize_to_limit: [600, nil]
+      end
+    end
+  end
+end

data/app/views/decidim/verifications/authorizations/first_login.html.erb

@@ -0,0 +1,22 @@
+<main class="wrapper">
+  <div class="row collapse">
+    <div class="row collapse">
+      <div class="columns large-8 large-centered text-center">
+        <h1 class="heading1 page-title"><%= t(".title") %></h1>
+        <p class="heading5"><%= t(".verify_with_these_options") %></p>
+      </div>
+    </div>
+    <div class="row">
+      <div class="columns medium-7 large-5 medium-centered">
+        <div class="card">
+          <div class="card__content">
+            <% unauthorized_methods.each do |unauthorized_method| %>
+              <%= link_to t(".actions.#{unauthorized_method.key}"), unauthorized_method.root_path, class: "button expanded" %>
+            <% end %>
+            <p class="text-center skip"><%= t("decidim.verifications.authorizations.skip_verification", link: link_to(t("decidim.verifications.authorizations.start_exploring"), cta_button_path).html_safe).html_safe %>.</p>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</main>

data/app/views/decidim/verifications/authorizations/index.html.erb

@@ -0,0 +1,78 @@
+<div class="row column authorizations-list">
+  <section class="section">
+    <% if @granted_authorizations.any? %>
+      <div class="card card--list">
+        <% @granted_authorizations.each do |authorization| %>
+          <div class="card--list__item">
+            <div class="card--list__text">
+              <%= icon "lock-unlocked", class: "card--list__icon" %>
+              <div>
+                <h5 class="card--list__heading">
+                  <%= t("#{authorization.name}.name", scope: "decidim.authorization_handlers") %>
+                </h5>
+                <span class="text-small">
+                  <%= t("granted_at", scope: "decidim.authorization_handlers", timestamp: l(authorization.granted_at, format: :long)) %>
+                </span>
+              </div>
+            </div>
+          </div>
+        <% end %>
+      </div>
+    <% end %>
+
+    <% if @pending_authorizations.any? %>
+      <div class="card card--list">
+        <% @pending_authorizations.each do |authorization| %>
+          <% authorization_method = Decidim::Verifications::Adapter.from_element(authorization.name) %>
+          <%= link_to authorization_method.resume_authorization_path do %>
+            <div class="card--list__item">
+              <div class="card--list__text">
+                <%= icon "reload", class: "card--list__icon" %>
+                <div>
+                  <h5 class="card--list__heading">
+                    <%= t("#{authorization.name}.name", scope: "decidim.authorization_handlers") %>
+                  </h5>
+                  <span class="text-small">
+                    <%= t("started_at", scope: "decidim.authorization_handlers", timestamp: l(authorization.updated_at, format: :long)) %>
+                  </span>
+                </div>
+              </div>
+              <div class="card--list__data">
+                <span class="card--list__data__icon">
+                  <%= icon "chevron-right" %>
+                </span>
+              </div>
+            </div>
+          <% end %>
+        <% end %>
+      </div>
+    <% end %>
+
+    <% if unauthorized_methods.any? %>
+      <div class="card card--list">
+        <% unauthorized_methods.each do |unauthorized_method| %>
+          <%= link_to unauthorized_method.root_path do %>
+            <div class="card--list__item">
+              <div class="card--list__text">
+                <%= icon "lock-locked", class: "card--list__icon" %>
+                <div>
+                  <h5 class="card--list__heading">
+                    <%= t("#{unauthorized_method.key}.name", scope: "decidim.authorization_handlers") %>
+                  </h5>
+                  <span class="text-small">
+                    <%= t("#{unauthorized_method.key}.explanation", scope: "decidim.authorization_handlers") %>
+                  </span>
+                </div>
+              </div>
+              <div class="card--list__data">
+                <span class="card--list__data__icon">
+                  <%= icon "chevron-right" %>
+                </span>
+              </div>
+            </div>
+          <% end %>
+        <% end %>
+      </div>
+    <% end %>
+  </section>
+</div>

data/app/views/decidim/verifications/authorizations/new.html.erb

@@ -0,0 +1,33 @@
+<main class="wrapper">
+  <div class="row collapse">
+    <div class="row collapse">
+      <div class="columns large-8 large-centered text-center page-title">
+        <h1><%= t(".authorize_with", authorizer: t("#{params[:handler]}.name", scope: "decidim.authorization_handlers")) %></h1>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="columns large-6 medium-centered">
+        <div class="card">
+          <div class="card__content">
+            <%= authorization_form_for(handler, url: authorizations_path(redirect_url: params[:redirect_url])) do |form| %>
+              <%= form.error_for(:base) %>
+
+              <% if lookup_context.exists?(handler.to_partial_path, [], true) %>
+                <%= render partial: handler.to_partial_path, locals: { handler: handler, form: form } %>
+              <% else %>
+                <%= form.all_fields %>
+                <div class="actions">
+                  <%= form.submit t(".authorize"), class: "button expanded" %>
+                </div>
+              <% end %>
+            <% end %>
+            <p class="text-center skip">
+              <%= t("decidim.verifications.authorizations.skip_verification", link: link_to(t("decidim.verifications.authorizations.start_exploring"), cta_button_path).html_safe).html_safe %>.
+            </p>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</main>

data/app/views/decidim/verifications/id_documents/admin/confirmations/new.html.erb

@@ -0,0 +1,26 @@
+<%= decidim_form_for(@form, url: pending_authorization_confirmation_path(@pending_authorization),
+                            html: { class: "form" }) do |form| %>
+  <div class="card">
+    <div class="card-divider">
+      <h2 class="card-title">
+        <%= t(".introduce_user_data") %>
+        <%= link_to t(".reject"), pending_authorization_rejection_path(@pending_authorization), method: :post, class: "button alert tiny button--title destroy" %>
+      </h2>
+    </div>
+
+    <div class="card-section">
+      <div class="row column">
+        <%= image_tag @pending_authorization.verification_attachment.url(:big), class: "thumbnail" %>
+      </div>
+
+      <div class="row column">
+        <%= form.select :document_type, @form.document_types_for_select, prompt: true, selected: nil %>
+        <%= form.text_field :document_number, value: nil %>
+      </div>
+    </div>
+  </div>
+
+  <div class="button--double form-general-submit">
+    <%= form.submit t(".verify") %>
+  </div>
+<% end %>

data/app/views/decidim/verifications/id_documents/admin/pending_authorizations/index.html.erb

@@ -0,0 +1,32 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title">
+      <%= t(".title") %>
+    </h2>
+  </div>
+  <div class="card-section">
+    <table class="table-list">
+      <thead>
+        <tr>
+          <th><%= t("activemodel.attributes.id") %></th>
+          <th><%= t("activemodel.attributes.id_document_upload.verification_attachment") %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <% @pending_authorizations.each do |authorization| %>
+            <td>
+              <%= link_to t(".verification_number", n: authorization.id),
+                          new_pending_authorization_confirmation_path(authorization.id) %>
+            </td>
+            <td>
+              <%= link_to new_pending_authorization_confirmation_path(authorization.id) do %>
+                <%= image_tag authorization.verification_attachment.url(:thumbnail), class: "thumbnail-list" %>
+              <% end %>
+            </td>
+          <% end %>
+        </tr>
+      </tbody>
+    </table>
+  </div>
+</div>