decidim-file_authorization_handler 0.27.1.5

data/db/migrate/20221207143742_add_extras_to_census_datum.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddExtrasToCensusDatum < ActiveRecord::Migration[6.0]
+  def change
+    add_column :decidim_file_authorization_handler_census_data, :extras, :jsonb
+  end
+end

data/lib/decidim/file_authorization_handler/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module FileAuthorizationHandler
+    # This module contains all the domain logic associated to Decidim's Census
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/file_authorization_handler/admin_engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module FileAuthorizationHandler
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::FileAuthorizationHandler::Admin
+
+      routes do
+        resource :censuses, only: [:show, :create, :destroy]
+      end
+
+      initializer "decidim_file_authorization.add_admin_menu" do
+        Decidim.menu :admin_menu do |menu|
+          menu.item I18n.t("decidim.file_authorization_handler.admin.menu.census"),
+                    decidim_file_authorization_handler_admin.censuses_path,
+                    icon_name: "spreadsheet",
+                    position: 7,
+                    active: :inclusive
+        end
+      end
+    end
+  end
+end

data/lib/decidim/file_authorization_handler/engine.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module FileAuthorizationHandler
+    # Census have no public app (see AdminEngine)
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::FileAuthorizationHandler
+
+      initializer "decidim_census.add_irregular_inflection" do |_app|
+        ActiveSupport::Inflector.inflections(:en) do |inflect|
+          inflect.irregular "census", "census"
+        end
+      end
+
+      initializer "decidim_census.add_authorization_handlers" do |_app|
+        Decidim::Verifications.register_workflow(:file_authorization_handler) do |workflow|
+          workflow.form = "FileAuthorizationHandler"
+        end
+      end
+    end
+  end
+end

data/lib/decidim/file_authorization_handler/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module FileAuthorizationHandler
+    DECIDIM_VERSION = "0.27.1"
+
+    # Uses the latest matching Decidim version for
+    # - major, minor and patch
+    # - the optional extra number is related to this module's patches
+    VERSION = "#{DECIDIM_VERSION}.5".freeze
+  end
+end

data/lib/decidim/file_authorization_handler.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "decidim/file_authorization_handler/admin"
+require "decidim/file_authorization_handler/engine"
+require "decidim/file_authorization_handler/admin_engine"
+
+module Decidim
+  # Base module for this engine.
+  module FileAuthorizationHandler
+  end
+end

data/spec/controllers/decidim/file_authorization_handler/admin/censuses_controller_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+RSpec.describe Decidim::FileAuthorizationHandler::Admin::CensusesController, type: :controller do
+  include Warden::Test::Helpers
+
+  routes { Decidim::FileAuthorizationHandler::AdminEngine.routes }
+
+  let(:organization) do
+    create :organization,
+           available_authorizations: ["file_authorization_handler"]
+  end
+
+  let(:user) do
+    create :user, :admin, :confirmed, organization:, admin: true
+  end
+
+  before do
+    controller.request.env["decidim.current_organization"] = organization
+  end
+
+  describe "GET #show" do
+    it "returns http success" do
+      sign_in user, scope: :user
+      get :show
+
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+  describe "POST #create" do
+    it "imports the csv data" do
+      sign_in user
+
+      # Don't know why don't prepend with `spec/fixtures` automatically
+      file = fixture_file_upload("spec/fixtures/files/data1.csv")
+      post :create, params: { file: }
+      expect(response).to have_http_status(:redirect)
+
+      expect(Decidim::FileAuthorizationHandler::CensusDatum.count).to be 3
+      expect(Decidim::FileAuthorizationHandler::CensusDatum.first.id_document).to eq encode_id_document("1111A")
+      expect(Decidim::FileAuthorizationHandler::CensusDatum.last.id_document).to eq encode_id_document("3333C")
+    end
+  end
+
+  describe "POST #delete_all" do
+    it "clear all census data" do
+      sign_in user
+
+      create_list :census_datum, 5, organization: organization
+      delete :destroy
+      expect(response).to have_http_status(:redirect)
+
+      expect(Decidim::FileAuthorizationHandler::CensusDatum.count).to be 0
+    end
+  end
+end

data/spec/factories/census_datum.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :census_datum, class: "Decidim::FileAuthorizationHandler::CensusDatum" do
+    id_document { "123456789A" }
+    birthdate { 20.years.ago }
+    organization
+    extras { nil }
+
+    trait :with_extras do
+      extras { { district: "123456789", postal_code: "ABCDEFGHIJK", segment_1: Random.hex } }
+    end
+  end
+end

data/spec/factories/factories.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"

data/spec/fixtures/files/data-with_extras.csv

@@ -0,0 +1,5 @@
+DNI,Data de naixement,district
+1111A,1/1/1981,17600
+2222B,2/2/1982,17481
+3333C,1/1/2000,17820
+4444D,1/1/2017,17003

data/spec/fixtures/files/data1.csv

@@ -0,0 +1,4 @@
+DNI,Data de naixement
+1111A,1/1/1981
+   2222-b  ,   2/2/1982  
+33 33 C,1/1/2017

data/spec/fixtures/files/with-errors.csv

@@ -0,0 +1,7 @@
+DNI,Data de naixement
+1111A,1/1/1981
+   2222B  ,   2/2/1982  
+,1/6/1989
+12323B,fecha-no-valida
+sasd
+3333A,3/3/1983

data/spec/helpers/decidim/file_authorization_handler/encoding_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module FileAuthorizationHandler
+    module EncodingHelper
+      def encode_id_document(id_document)
+        Digest::SHA256.hexdigest("#{id_document}-#{Rails.application.secrets.secret_key_base}")
+      end
+    end
+  end
+end

data/spec/jobs/decidim/file_authorization_handler/remove_duplicates_job_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Decidim::FileAuthorizationHandler::RemoveDuplicatesJob do
+  let(:org_1) { create :organization }
+  let(:org_2) { create :organization }
+
+  it "remove duplicates in the database" do
+    %w(AAA BBB AAA AAA).each do |doc|
+      create(:census_datum, id_document: doc, organization: org_1)
+      create(:census_datum, id_document: doc, organization: org_2)
+    end
+    expect(Decidim::FileAuthorizationHandler::CensusDatum.count).to be 8
+    described_class.new.perform org_1
+    expect(Decidim::FileAuthorizationHandler::CensusDatum.count).to be 6
+    described_class.new.perform org_2
+    expect(Decidim::FileAuthorizationHandler::CensusDatum.count).to be 4
+  end
+end

data/spec/models/decidim/file_authorization_handler/census_datum_spec.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+RSpec.describe Decidim::FileAuthorizationHandler::CensusDatum, type: :model do
+  let(:organization) { create :organization }
+
+  # rubocop: disable Lint/ConstantDefinitionInBlock
+  CensusDatum = Decidim::FileAuthorizationHandler::CensusDatum
+  # rubocop: enable Lint/ConstantDefinitionInBlock
+
+  describe "get census for a given identity document" do
+    it "returns the last inserted when duplicates" do
+      create(:census_datum, id_document: encode_id_document("AAA"))
+      last = create(:census_datum, id_document: encode_id_document("AAA"), organization:)
+      expect(CensusDatum.search_id_document(organization, "AAA")).to eq(last)
+    end
+
+    it "normalizes the document" do
+      census = create(:census_datum, id_document: encode_id_document("AAA"), organization:)
+      expect(CensusDatum.search_id_document(organization, "a-a-a")).to eq(census)
+    end
+  end
+
+  context "with #insert_all" do
+    it "inserts a collection of values" do
+      # rubocop: disable Rails/SkipsModelValidations
+      CensusDatum.insert_all(organization, [["1111A", "1990/12/1"], ["2222B", "1990/12/2"]])
+      expect(CensusDatum.count).to be 2
+      CensusDatum.insert_all(organization, [["1111A", "2001/12/1"], ["3333C", "1990/12/3"]])
+      # rubocop: enable Rails/SkipsModelValidations
+      expect(CensusDatum.count).to be 4
+    end
+
+    context "when values is empty" do
+      it "returns without crashing" do
+        # rubocop: disable Rails/SkipsModelValidations
+        CensusDatum.insert_all(organization, [])
+        # rubocop: enable Rails/SkipsModelValidations
+      end
+    end
+
+    context "when extra columns exist" do
+      it "inserts extra columns in the #extras column" do
+        # rubocop: disable Rails/SkipsModelValidations
+        CensusDatum.insert_all(organization, [
+                                 ["1111A", "2001/12/1", "001", "1234"],
+                                 ["3333C", "1990/12/3", "ABCD", "01-12/33"],
+                               ], %w(POSTAL_CODE DISTRICT))
+        # rubocop: enable Rails/SkipsModelValidations
+
+        inserts = CensusDatum.all
+        expect(inserts.size).to be 2
+        expect(inserts.first.extras).to eq({ "postal_code" => "001", "district" => "1234" })
+        expect(inserts.last.extras).to eq({ "postal_code" => "ABCD", "district" => "01-12/33" })
+      end
+    end
+  end
+
+  describe "normalization methods" do
+    it "normalizes and encodes the id document" do
+      expect(CensusDatum.normalize_and_encode_id_document("1234a"))
+        .to eq encode_id_document("1234A")
+      expect(CensusDatum.normalize_and_encode_id_document("   1234a  "))
+        .to eq encode_id_document("1234A")
+      expect(CensusDatum.normalize_and_encode_id_document(")($·$")).to eq ""
+      expect(CensusDatum.normalize_and_encode_id_document(nil)).to eq ""
+    end
+
+    it "normalizes dates" do
+      expect(CensusDatum.parse_date("20/3/1992")).to eq Date.strptime("1992/03/20", "%Y/%m/%d")
+      expect(CensusDatum.parse_date("1/20/1992")).to be_nil
+      expect(CensusDatum.parse_date("n/3/1992")).to be_nil
+    end
+  end
+end

data/spec/models/decidim/file_authorization_handler/csv_data_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Decidim::FileAuthorizationHandler::CsvData do
+  let(:file) { file_fixture("data1.csv") }
+  let(:data) { described_class.new(file) }
+
+  it "loads from files" do
+    expect(data.values.length).to be 3
+    expect(data.values[0]).to eq [encode_id_document("1111A"), Date.strptime("1981/01/01", "%Y/%m/%d")]
+    expect(data.values[1]).to eq [encode_id_document("2222B"), Date.strptime("1982/02/02", "%Y/%m/%d")]
+    expect(data.values[2]).to eq [encode_id_document("3333C"), Date.strptime("2017/01/01", "%Y/%m/%d")]
+  end
+
+  it "returns the zero errored rows when all are good" do
+    expect(data.errors.count).to be 0
+  end
+
+  context "when file has errors" do
+    let(:file) { file_fixture("with-errors.csv") }
+
+    it "returns the number of errored rows" do
+      expect(data.errors.count).to be 3
+    end
+  end
+
+  context "with extra columns" do
+    let(:file) { file_fixture("data-with_extras.csv") }
+
+    it "parses all columns from file" do
+      expect(data.values.length).to be 4
+      expect(data.headers).to eq ["DNI", "Data de naixement", "district"]
+      expect(data.errors.count).to be 0
+      expect(data.values[0]).to eq [encode_id_document("1111A"), Date.strptime("1981/01/01", "%Y/%m/%d"), "17600"]
+      expect(data.values[1]).to eq [encode_id_document("2222B"), Date.strptime("1982/02/02", "%Y/%m/%d"), "17481"]
+      expect(data.values[2]).to eq [encode_id_document("3333C"), Date.strptime("2000/01/01", "%Y/%m/%d"), "17820"]
+      expect(data.values[3]).to eq [encode_id_document("4444D"), Date.strptime("2017/01/01", "%Y/%m/%d"), "17003"]
+    end
+  end
+end

data/spec/models/decidim/file_authorization_handler/status_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Decidim::FileAuthorizationHandler::Status, type: :model do
+  let(:organization) { create :organization }
+
+  it "returns last import date" do
+    last = create :census_datum, organization: organization
+    status = Decidim::FileAuthorizationHandler::Status.new(organization)
+    expect(last.created_at.to_i).to eq status.last_import_at.to_i
+  end
+
+  it "retrieve the number of unique documents" do
+    %w(AAA BBB AAA AAA).each do |doc|
+      create(:census_datum, id_document: doc, organization:)
+    end
+    status = Decidim::FileAuthorizationHandler::Status.new(organization)
+    expect(status.count).to be 2
+  end
+end

data/spec/permissions/decidim/file_authorization_handler/admin/permissions_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Decidim::FileAuthorizationHandler::Admin::Permissions do
+  subject { described_class.new(user, permission_action, context).permissions.allowed? }
+
+  let(:dummy_component) { create :dummy_component }
+  let(:organization) { dummy_component.organization }
+  let(:user) { create :user, organization: }
+  let(:context) do
+    {
+      current_component: dummy_component,
+    }
+  end
+  let(:scope) { :admin }
+  let(:auth_subject) { Decidim::FileAuthorizationHandler::CensusDatum }
+  let(:action) do
+    { scope:, action: action_name, subject: auth_subject }
+  end
+  let(:permission_action) { Decidim::PermissionAction.new(**action) }
+
+  before do
+    organization.update!(available_authorizations: ["file_authorization_handler"])
+  end
+
+  context "when action is allowed" do
+    [:show, :create, :destroy].each do |action_name|
+      let(:action_name) { action_name }
+
+      context "##{action_name}" do
+        it { is_expected.to be true }
+      end
+    end
+  end
+
+  context "when action is NOT allowed" do
+    [:manage, :list, :update].each do |action_name|
+      let(:action_name) { action_name }
+
+      it_behaves_like "permission is not set"
+    end
+  end
+
+  context "when scope is not admin" do
+    let(:scope) { :public }
+    let(:action_name) { :show }
+
+    it_behaves_like "permission is not set"
+  end
+
+  context "when subject is not :authorize" do
+    let(:action_name) { :admin }
+    let(:auth_subject) { :foo }
+
+    it_behaves_like "permission is not set"
+  end
+end

data/spec/services/decidim/file_authorization_handler/file_authorization_handler_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+RSpec.describe FileAuthorizationHandler do
+  let(:organization) { create(:organization) }
+  let(:user) { create(:user, organization:) }
+  let(:dni) { "1234A" }
+  let(:encoded_dni) { encode_id_document(dni) }
+  let(:date) { Date.strptime("1990/11/21", "%Y/%m/%d") }
+  let(:handler) do
+    described_class.new(user:, id_document: dni, birthdate: date)
+                   .with_context(current_organization: organization)
+  end
+  let!(:unique_id) do
+    Digest::SHA256.hexdigest("#{handler.census_for_user&.id_document}-#{organization.id}-#{Rails.application.secrets.secret_key_base}")
+  end
+
+  context "without extras in CensusDatum" do
+    let(:census_datum) do
+      create(:census_datum, id_document: encoded_dni,
+                            birthdate: date,
+                            organization:)
+    end
+
+    it "validates against database" do
+      expect(handler.valid?).to be false
+      census_datum
+      expect(handler.valid?).to be true
+    end
+
+    it "normalizes the id document" do
+      census_datum
+      normalizer =
+        described_class.new(user:, id_document: "12-34-a", birthdate: date)
+                       .with_context(current_organization: organization)
+      expect(normalizer.valid?).to be true
+    end
+
+    it "generates birthdate metadata" do
+      census_datum
+      expect(handler.valid?).to be true
+      expect(handler.metadata).to eq(birthdate: "1990/11/21")
+    end
+
+    it "generates unique_id correctly" do
+      expect(unique_id).to eq(handler.unique_id)
+    end
+
+    it "works when no current_organization context is provided (but the user is)" do
+      census_datum
+      contextless_handler = described_class.new(user:,
+                                                id_document: dni,
+                                                birthdate: date)
+      expect(contextless_handler.valid?).to be true
+    end
+  end
+
+  context "with extras in CensusDatum" do
+    let(:date) { Date.strptime("2000/01/01", "%Y/%m/%d") }
+    let(:census_datum) do
+      create(:census_datum, :with_extras, id_document: encoded_dni,
+                                          birthdate: date,
+                                          organization:)
+    end
+
+    it "adds extras as metadata" do
+      census_datum
+      expect(handler.valid?).to be true
+      expect(handler.metadata).to eq({
+                                       birthdate: "2000/01/01",
+                                       district: census_datum.extras["district"],
+                                       postal_code: census_datum.extras["postal_code"],
+                                       segment_1: census_datum.extras["segment_1"],
+                                     })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] ||= "test"
+
+require "decidim/dev"
+require "decidim/admin"
+require "decidim/core"
+require "decidim/verifications"
+require "decidim/core/test"
+require "social-share-button"
+require "letter_opener_web"
+
+require "helpers/decidim/file_authorization_handler/encoding_helper"
+
+ENV["ENGINE_NAME"] = File.dirname(__dir__).split("/").last
+
+Decidim::Dev.dummy_app_path = File.expand_path(File.join(".", "spec", "decidim_dummy_app"))
+
+require "decidim/dev/test/base_spec_helper"
+
+RSpec.configure do |config|
+  config.include Decidim::FileAuthorizationHandler::EncodingHelper
+end