decidim-comparative_stats 1.0.1

data/lib/decidim/comparative_stats.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "decidim/comparative_stats/admin"
+require "decidim/comparative_stats/engine"
+require "decidim/comparative_stats/admin_engine"
+require "chartkick"
+
+module Decidim
+  # This namespace holds the logic of the `ComparativeStats` component. This component
+  # allows users to create comparative_stats in a participatory space.
+  module ComparativeStats
+    include ActiveSupport::Configurable
+
+    autoload :ApiFetcher, "decidim/comparative_stats/api_fetcher"
+    autoload :CachedHTTPAdapter, "decidim/comparative_stats/cached_http_adapter"
+
+    # Sets the expiration time for the statistic data.
+    config_accessor :stats_cache_expiration_time do
+      24.hours
+    end
+  end
+end

data/lib/decidim/comparative_stats/admin.rb

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

data/lib/decidim/comparative_stats/admin_engine.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ComparativeStats
+    # This is the engine that runs on the public interface of `ComparativeStats`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::ComparativeStats::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        # Add admin engine routes here
+        resources :endpoints
+        get "graphs/:graph", to: "graphs#show", as: :graphs, defaults: { graph: "global_stats" }
+        root to: "endpoints#index"
+      end
+
+      initializer "decidim_comparative_stats.admin_mount_routes" do
+        Decidim::Core::Engine.routes do
+          mount Decidim::ComparativeStats::AdminEngine, at: "/admin/comparative_stats", as: "decidim_admin_comparative_stats"
+        end
+      end
+
+      initializer "decidim_comparative_stats.add_cells_view_paths" do
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::ComparativeStats::Engine.root}/app/cells")
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::ComparativeStats::Engine.root}/app/views") # for partials
+      end
+
+      initializer "decidim_comparative_stats.admin_assets" do |app|
+        app.config.assets.precompile += %w(admin/comparative_stats_manifest.js admin/comparative_stats_manifest.css)
+      end
+
+      def load_seed
+        nil
+      end
+
+      initializer "decidim_comparative_stats.admin_menu" do
+        Decidim.menu :admin_menu do |menu|
+          menu.item I18n.t("menu.comparative_stats", scope: "decidim.admin"),
+                    decidim_admin_comparative_stats.endpoints_path,
+                    icon_name: "graph",
+                    position: 3.5,
+                    active: is_active_link?(decidim_admin_comparative_stats.endpoints_path, :inclusive) ||
+                            is_active_link?(decidim_admin_comparative_stats.graphs_path, :inclusive)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/comparative_stats/api_fetcher.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "graphlient"
+require "decidim/comparative_stats/version"
+
+module Decidim
+  module ComparativeStats
+    # Class used to fetch and validate Decidim API calls
+    class ApiFetcher
+      def initialize(endpoint)
+        @errors = []
+        @queries = {}
+        @endpoint = endpoint
+      end
+
+      attr_reader :errors, :endpoint
+
+      attr_writer :client
+
+      def client
+        @client ||= Graphlient::Client.new(endpoint,
+                                           http: CachedHTTPAdapter,
+                                           http_options: {
+                                             read_timeout: 20,
+                                             write_timeout: 30
+                                           })
+      end
+
+      # When creating name and version are fetched from the api
+      # Update action should allow the user to change the name but not the version
+      def name_and_version
+        @name_and_version ||= fetch_name_and_version.data.decidim
+      end
+
+      # Queries the GraphQL api using one of files in lib/decidim/comparative_stats/queries
+      def query(tag)
+        @queries[tag] ||= client.query versioned_query(tag)
+      rescue Faraday::Error
+        @errors << "Not a valid Decidim API URL"
+      rescue Graphlient::Errors::Error => e
+        @errors << e.message
+      end
+
+      # Checks if is a valid Decidim API URL
+      def valid?(min_version = MIN_API_VERSION)
+        response = fetch_name_and_version
+        return false unless response
+
+        if Gem::Version.new(min_version) > Gem::Version.new(response.data.decidim.version)
+          @errors << "Decidim version detect (#{response.data.decidim.version}) should be at least #{min_version}"
+          return false
+        end
+        true
+      end
+
+      # returns the last error
+      def error
+        @errors.last
+      end
+
+      private
+
+      def versioned_query(tag)
+        file = File.join(__dir__, "queries", "#{tag}.graphql")
+        raise NameError unless File.exist?(file)
+
+        unless tag == "name_and_version"
+          if Gem::Version.new(name_and_version.version) < Gem::Version.new("0.23")
+            alt_file = File.join(__dir__, "queries", "v022", "#{tag}.graphql")
+            file = alt_file if File.exist?(alt_file)
+          end
+        end
+        File.open(file).read
+      end
+
+      # Syntactic sugar to query graphql queries:
+      # i.e:
+      #      query "name_and_version" => fetch_name_and_version
+      def method_missing(name)
+        _, key = name.to_s.split("fetch_")
+        if key
+          query key
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        method_name.to_s.start_with?("fetch_") || super
+      end
+    end
+  end
+end

data/lib/decidim/comparative_stats/cached_http_adapter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "graphlient/adapters/http/http_adapter"
+
+module Decidim
+  module ComparativeStats
+    class CachedHTTPAdapter < Graphlient::Adapters::HTTP::FaradayAdapter
+      def execute(document:, operation_name: nil, variables: {}, context: {})
+        body = {}
+        # Strip uniq identifier generated by GraphQL class
+        body["query"] = document.to_query_string.gsub(/GraphQL__Client__OperationDefinition_[0-9 ]+/, "")
+        body["variables"] = variables if variables.any?
+
+        Rails.cache.fetch(
+          "graphlient/api_queries/#{url.hash}/#{body.to_json.hash}",
+          expires_in: Decidim::ComparativeStats.stats_cache_expiration_time
+        ) do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/decidim/comparative_stats/engine.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails"
+require "decidim/core"
+
+module Decidim
+  module ComparativeStats
+    # This is the engine that runs on the public interface of comparative_stats.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::ComparativeStats
+
+      routes do
+        # Add engine routes here
+        get "widgets/:graph", to: "widgets#show", as: :widget, defaults: { graph: "global_stats" }
+        root to: "widgets#show"
+      end
+
+      initializer "decidim_comparative_stats.mount_routes" do
+        Decidim::Core::Engine.routes do
+          mount Decidim::ComparativeStats::Engine, at: "/comparative_stats", as: "decidim_comparative_stats"
+        end
+      end
+
+      initializer "decidim_comparative_stats.add_cells_view_paths" do
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::ComparativeStats::Engine.root}/app/cells")
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::ComparativeStats::Engine.root}/app/views") # for partials
+      end
+
+      initializer "decidim_comparative_stats.assets" do |app|
+        app.config.assets.precompile += %w(comparative_stats_manifest.js comparative_stats_manifest.css)
+      end
+    end
+  end
+end

data/lib/decidim/comparative_stats/queries/global_events.graphql

@@ -0,0 +1,84 @@
+query {
+  assemblies {
+    id
+    slug
+    components (filter: {withGeolocationEnabled: true }) {
+      id
+      __typename
+      ...geolocatedMeetings
+      ...geolocatedProposals
+    }
+  }
+  participatoryProcesses {
+    id
+    slug
+    components (filter: {withGeolocationEnabled: true }) {
+      id
+      __typename
+      ...geolocatedMeetings
+      ...geolocatedProposals
+    }
+  }
+}
+
+fragment geolocatedMeetings on Meetings {
+  meetings {
+    edges {
+      node {
+        id
+        address
+        title {
+          translations {
+            text
+          }
+        }
+        description {
+          translations {
+            text
+          }
+        }
+        startTime
+        endTime
+        location {
+          translations {
+            text
+          }
+        }
+        locationHints {
+          translations {
+            text
+          }
+        }
+        coordinates {
+          latitude
+          longitude
+        }
+      }
+    }
+  }
+}
+
+fragment geolocatedProposals on Proposals {
+  proposals {
+    edges {
+      node {
+        id
+        address
+        title {
+          translations {
+            text
+          }
+        }
+        body {
+          translations {
+            text
+          }
+        }
+        coordinates {
+          latitude
+          longitude
+        }
+      }
+    }
+  }
+}

data/lib/decidim/comparative_stats/queries/global_history_metrics.graphql

@@ -0,0 +1,10 @@
+query {
+  metrics {
+    count
+    name
+    history {
+      key
+      value
+    }
+  }
+}

data/lib/decidim/comparative_stats/queries/global_metrics.graphql

@@ -0,0 +1,6 @@
+query {
+  metrics {
+    count
+    name
+  }
+}

data/lib/decidim/comparative_stats/queries/name_and_version.graphql

@@ -0,0 +1,6 @@
+query {
+  decidim {
+    applicationName
+    version
+  }
+}

data/lib/decidim/comparative_stats/queries/participatory_processes.graphql

@@ -0,0 +1,12 @@
+query {
+  participatoryProcesses {
+    id
+    title {
+      translations {
+        text
+      }
+    }
+    startDate
+    endDate
+  }
+}

data/lib/decidim/comparative_stats/queries/v022/global_events.graphql

@@ -0,0 +1,76 @@
+query {
+  assemblies {
+    id
+    slug
+    components (filter: {withGeolocationEnabled: true }) {
+      id
+      __typename
+      ...geolocatedMeetings
+      ...geolocatedProposals
+    }
+  }
+  participatoryProcesses {
+    id
+    slug
+    components (filter: {withGeolocationEnabled: true }) {
+      id
+      __typename
+      ...geolocatedMeetings
+      ...geolocatedProposals
+    }
+  }
+}
+
+fragment geolocatedMeetings on Meetings {
+  meetings {
+    edges {
+      node {
+        id
+        address
+        title {
+          translations {
+            text
+          }
+        }
+        description {
+          translations {
+            text
+          }
+        }
+        startTime
+        endTime
+        location {
+          translations {
+            text
+          }
+        }
+        locationHints {
+          translations {
+            text
+          }
+        }
+        coordinates {
+          latitude
+          longitude
+        }
+      }
+    }
+  }
+}
+
+fragment geolocatedProposals on Proposals {
+  proposals {
+    edges {
+      node {
+        id
+        address
+        title
+        body
+        coordinates {
+          latitude
+          longitude
+        }
+      }
+    }
+  }
+}

data/lib/decidim/comparative_stats/test/factories.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"
+
+FactoryBot.define do
+  factory :endpoint, class: "Decidim::ComparativeStats::Endpoint" do
+    endpoint { Faker::Internet.url }
+    name { Faker::Name.name }
+    api_version { Decidim::ComparativeStats::MIN_API_VERSION }
+    organization { create :organization }
+    active { true }
+  end
+end