decidim-comparative_stats 1.0.1

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      class ApplicationController < Decidim::Admin::ApplicationController
+        def permission_class_chain
+          [::Decidim::ComparativeStats::Admin::Permissions] + super
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/comparative_stats/admin/endpoints_controller.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    module Admin
+      class EndpointsController < ComparativeStats::Admin::ApplicationController
+        helper_method :organization_endpoints
+        layout "decidim/admin/comparative_stats"
+
+        def index
+          enforce_permission_to :index, :endpoint
+        end
+
+        def new
+          enforce_permission_to :create, :endpoint
+          @form = form(EndpointForm).instance
+        end
+
+        def edit
+          enforce_permission_to :update, :endpoint, endpoint: current_endpoint
+          @form = form(EndpointForm).from_model(current_endpoint, endpoint: current_endpoint)
+        end
+
+        def create
+          enforce_permission_to :create, :endpoint
+          @form = form(EndpointForm).from_params(params, api: api)
+          CreateEndpoint.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("endpoints.create.success", scope: "decidim.comparative_stats.admin")
+              redirect_to decidim_admin_comparative_stats.endpoints_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("endpoints.create.error", scope: "decidim.comparative_stats.admin")
+              render :new
+            end
+          end
+        end
+
+        def update
+          enforce_permission_to :update, :endpoint, endpoint: current_endpoint
+
+          form = form(EndpointForm).from_params(params, endpoint: current_endpoint, api: api)
+
+          UpdateEndpoint.call(current_endpoint, form, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("endpoints.update.success", scope: "decidim.comparative_stats.admin")
+              redirect_to decidim_admin_comparative_stats.endpoints_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("endpoints.update.error", scope: "decidim.comparative_stats.admin")
+              render :edit
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to :destroy, :endpoint, endpoint: current_endpoint
+
+          DestroyEndpoint.call(current_endpoint, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("endpoints.destroy.success", scope: "decidim.comparative_stats.admin")
+              redirect_to decidim_admin_comparative_stats.endpoints_path
+            end
+          end
+        end
+
+        def organization_endpoints
+          @organization_endpoints ||= Endpoint.where(organization: current_organization)
+        end
+
+        def api
+          @api ||= ApiFetcher.new(params[:endpoint][:endpoint])
+        end
+
+        def current_endpoint
+          @current_endpoint ||= Endpoint.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/comparative_stats/admin/graphs_controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    module Admin
+      class GraphsController < ComparativeStats::Admin::ApplicationController
+        helper ComparativeStats::ApplicationHelper
+        layout "decidim/admin/comparative_stats"
+
+        def show
+          enforce_permission_to :show, :graph
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/comparative_stats/widgets_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    class WidgetsController < Decidim::ApplicationController
+      helper ComparativeStats::ApplicationHelper
+      skip_before_action :verify_authenticity_token
+      after_action :allow_iframe, only: :show
+
+      helper_method :graphs_path
+
+      layout "decidim/comparative_stats/widget"
+
+      def show
+        is_valid = lookup_context.exists?(params[:graph], "decidim/comparative_stats/widgets", true)
+        render plain: "not found", status: :not_found unless is_valid
+      end
+
+      def allow_iframe
+        response.headers.delete "X-Frame-Options"
+      end
+
+      private
+
+      # Mock admin path for tabs.html.erb
+      def graphs_path(graph)
+        decidim_comparative_stats.widget_url graph
+      end
+    end
+  end
+end

data/app/forms/decidim/comparative_stats/admin/endpoint_form.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    module Admin
+      # A form object used to configure the endpoint.
+      #
+      class EndpointForm < Decidim::Form
+        mimic :endpoint
+
+        attribute :endpoint, String, presence: true
+        attribute :active, Boolean
+        attribute :name, String
+
+        validate :valid_api_version
+
+        def valid_api_version
+          unless context.api.valid?
+            errors.add :endpoint, :invalid
+            errors.add :endpoint, context.api.error if context.api.error
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/comparative_stats/application_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    # Custom helpers, scoped to the comparative_stats engine.
+    #
+    module ApplicationHelper
+      def embed_modal_for(url)
+        embed_code = String.new(content_tag(:iframe, "", src: url, frameborder: 0, width: "100%", height: "420", scrolling: "vertical"))
+        render partial: "decidim/comparative_stats/widgets/embed_modal", locals: { url: url, embed_code: embed_code }
+      end
+
+      def active_endpoints
+        Endpoint.active.where(organization: current_organization)
+      end
+
+      def available_graphs
+        [
+          :global_stats,
+          :global_stats_timeline,
+          :processes_timeline,
+          :spaces_geocoded_events
+        ]
+      end
+    end
+  end
+end

data/app/models/decidim/comparative_stats/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/comparative_stats/endpoint.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim::ComparativeStats
+  class Endpoint < ApplicationRecord
+    include Decidim::Traceable
+    include Decidim::Loggable
+
+    self.table_name = "decidim_comparative_stats_endpoints"
+
+    belongs_to :organization, foreign_key: :decidim_organization_id, class_name: "Decidim::Organization"
+
+    scope :active, -> { where(active: true) }
+
+    def api
+      @api ||= ApiFetcher.new endpoint
+    end
+
+    def self.log_presenter_class_for(_log)
+      Decidim::ComparativeStats::AdminLog::EndpointPresenter
+    end
+  end
+end

data/app/permissions/decidim/comparative_stats/admin/permissions.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          return permission_action unless user
+
+          return permission_action if permission_action.scope != :admin
+
+          return permission_action unless permission_action.subject.in? [:endpoint, :graph, :aggregated_maps]
+
+          case permission_action.action
+          when :index, :show, :create, :update, :destroy
+            permission_action.allow!
+          end
+
+          permission_action
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/comparative_stats/admin_log/endpoint_presenter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    module AdminLog
+      # This class holds the logic to present a `Decidim::ComparativeStats::Endpoint`
+      # for the `AdminLog` log.
+      #
+      # Usage should be automatic and you shouldn't need to call this class
+      # directly, but here's an example:
+      #
+      #    action_log = Decidim::ActionLog.last
+      #    view_helpers # => this comes from the views
+      #    EndpointPresenter.new(action_log, view_helpers).present
+      class EndpointPresenter < Decidim::Log::BasePresenter
+        private
+
+        def diff_fields_mapping
+          {
+            endpoint: :string,
+            name: :string,
+            api_version: :string,
+            active: :boolean
+          }
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.comparative_stats.endpoint"
+        end
+
+        def action_string
+          case action
+          when "create", "delete", "update"
+            "decidim.comparative_stats.admin_log.endpoint.#{action}"
+          else
+            super
+          end
+        end
+
+        def has_diff?
+          action == "delete" || super
+        end
+      end
+    end
+  end
+end

data/app/views/decidim/comparative_stats/admin/endpoints/_form.html.erb

@@ -0,0 +1,7 @@
+<div class="row column">
+  <%= form.text_field :endpoint, autofocus: true %>
+</div>
+
+<div class="row column">
+  <%= form.check_box :active %>
+</div>

data/app/views/decidim/comparative_stats/admin/endpoints/edit.html.erb

@@ -0,0 +1,16 @@
+<%= decidim_form_for(@form) do |f| %>
+  <div class="card">
+    <div class="card-divider">
+      <h2 class="card-title"><%= t ".title" %></h2>
+    </div>
+    <div class="card-section">
+      <%= render partial: "form", object: f %>
+      <div class="row column">
+        <%= f.text_field :name %>
+      </div>
+    </div>
+  </div>
+  <div class="button--double form-general-submit">
+    <%= f.submit t(".update") %>
+  </div>
+<% end %>

data/app/views/decidim/comparative_stats/admin/endpoints/index.html.erb

@@ -0,0 +1,66 @@
+<div class="card" id="translation_sets">
+  <div class="card-divider">
+    <h2 class="card-title flex--sbc">
+      <div>
+        <%= t ".title" %>
+      </div>
+
+      <div class="flex--cc flex-gap--1">
+        <div id="js-other-actions-wrapper">
+          <% if allowed_to? :create, :endpoint %>
+             <%= link_to t("endpoints.add", scope: "decidim.comparative_stats"), url_for(action: :new), class: "button tiny button--title new" %>
+          <% end %>
+        </div>
+      </div>
+    </h2>
+  </div>
+
+  <div class="card-section">
+    <div class="table-scroll">
+      <% if organization_endpoints.any? %>
+        <table class="table-list">
+          <thead>
+            <tr>
+              <th><%= t ".active" %></th>
+              <th><%= t ".endpoint" %></th>
+              <th><%= t ".name" %></th>
+              <th><%= t ".version" %></th>
+              <th></th>
+            </tr>
+          </thead>
+          <tbody>
+            <% organization_endpoints.each do |endpoint| %>
+              <tr data-id="<%= endpoint.id %>">
+                <td>
+                  <% if endpoint.active? %>
+                    <span class="icon-active"></span>
+                  <% end %>
+                </td>
+                <td>
+                  <%= endpoint.endpoint %><br>
+                </td>
+                <td>
+                  <%= endpoint.name %><br>
+                </td>
+                <td>
+                  <%= endpoint.api_version %><br>
+                </td>
+                <td class="table-list__actions">
+                  <% if allowed_to? :update, :endpoint, endpoint: endpoint %>
+                    <%= icon_link_to "pencil", edit_endpoint_path(endpoint), t("actions.edit", scope: "decidim.admin"), class: "action-icon--edit" %>
+                  <% end %>
+
+                  <% if allowed_to? :destroy, :endpoint, endpoint: endpoint %>
+                    <%= icon_link_to "circle-x", endpoint_path(endpoint), t("actions.destroy", scope: "decidim.admin"), class: "action-icon--remove", method: :delete, data: { confirm: t("actions.confirm_destroy", scope: "decidim.admin") } %>
+                  <% end %>
+                </td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      <% else %>
+      <%= t ".no_endpoints" %>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/decidim/comparative_stats/admin/endpoints/new.html.erb

@@ -0,0 +1,16 @@
+<%= decidim_form_for(@form) do |f| %>
+  <div class="card">
+    <div class="card-divider">
+      <h2 class="card-title"><%= t ".title" %></h2>
+    </div>
+    <div class="card-section">
+      <p>
+        <%= t(".subtitle") %>
+      </p>
+      <%= render partial: "form", object: f %>
+    </div>
+  </div>
+  <div class="button--double form-general-submit">
+    <%= f.submit t(".create") %>
+  </div>
+<% end %>

data/app/views/decidim/comparative_stats/admin/graphs/show.html.erb

@@ -0,0 +1,15 @@
+<div class="card" id="translation_sets">
+  <div class="card-divider">
+    <h2 class="card-title flex--sbc">
+      <div>
+        <%= t ".title" %>
+      </div>
+    </h2>
+  </div>
+</div>
+
+<% if active_endpoints.any? %>
+  <%= render partial: "decidim/comparative_stats/widgets/tabs" %>
+<% else %>
+  <%= t ".no_endpoints" %>
+<% end %>

data/app/views/decidim/comparative_stats/widgets/_all.html.erb

@@ -0,0 +1 @@
+<%= render partial: "tabs" %>