decidim-bulletin_board 0.8.0 → 0.10.0

data/bin/release

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+cd ../decidim-bulletin_board-app && \
+npm run release && \
+git add . && \
+git commit --amend && \
+cd ../decidim-bulletin_board-ruby && \
+bundle exec rake release

data/lib/decidim/bulletin_board.rb

@@ -7,14 +7,11 @@ require "jwt"
 require "graphlient"
 require "wisper"
 
+require "decidim/bulletin_board/client"
 require "decidim/bulletin_board/engine"
 require "decidim/bulletin_board/jwk_utils"
 require "decidim/bulletin_board/message_identifier"
 
-require "decidim/bulletin_board/client"
-require "decidim/bulletin_board/authority"
-require "decidim/bulletin_board/voter"
-
 module Decidim
   # This module holds all the logic for the Bulletin Board Ruby Client to connect
   # a Decidim instance with a Bulletin Board server
@@ -27,26 +24,25 @@ module Decidim
     # The BulletinBoard server (String)
     config_accessor :server
 
+    # The public key (JSON) of the Bulletin Board server
+    config_accessor :server_public_key
+
     # The api key generated by the Bulletin Board for the Decidim authority (String)
     config_accessor :api_key
 
-    # The scheme: scheme name and scheme parameters, e.g. quorum for Electionguard
-    # Example:
-    # {
-    #   name: "Dummy",
-    #   parameters: {
-    #     quorum: 2
-    #   }
-    # }
-    config_accessor :scheme
-
     # The authority name (String)
     config_accessor :authority_name
 
-    # The number of trustees for an election (Int). Must be higher than the schemes' quorum
-    config_accessor :number_of_trustees
-
     # The identification private key (JSON) for your Decidim instance
     config_accessor :identification_private_key
+
+    # The voting scheme name
+    config_accessor :scheme_name
+
+    # The number of trustees for an election (Int). Must be higher than the quorum
+    config_accessor :number_of_trustees
+
+    # The quorum needed to start the tally
+    config_accessor :quorum
   end
 end

data/lib/decidim/bulletin_board/authority/create_election.rb

@@ -10,33 +10,138 @@ module Decidim
           @election_data = election_data
         end
 
+        # Returns the message_id related to the operation
+        def message_id
+          @message_id ||= build_message_id(unique_election_id(election_id), "create_election")
+        end
+
         def call
-          message_id = message_id(unique_election_id(election_id), "create_election")
-          signed_data = sign_message(message_id, election_data)
-
-          begin
-            response = client.query do
-              mutation do
-                createElection(messageId: message_id, signedData: signed_data) do
-                  election do
-                    status
-                  end
-                  error
+          # arguments used inside the graphql operation
+          args = {
+            message_id: message_id,
+            signed_data: sign_message(message_id, message)
+          }
+
+          response = graphql.query do
+            mutation do
+              createElection(messageId: args[:message_id], signedData: args[:signed_data]) do
+                election do
+                  status
                 end
+                error
               end
             end
+          end
 
-            return broadcast(:error, response.data.create_election.error) if response.data.create_election.error.present?
+          return broadcast(:error, response.data.create_election.error) if response.data.create_election.error.present?
 
-            broadcast(:ok, response.data.create_election.election)
-          rescue Graphlient::Errors::ServerError
-            broadcast(:error, "Sorry, something went wrong")
-          end
+          broadcast(:ok, response.data.create_election.election)
+        rescue Graphlient::Errors::ServerError
+          broadcast(:error, "Sorry, something went wrong")
         end
 
         private
 
         attr_reader :election_data, :election_id
+
+        def message
+          {
+            scheme: scheme,
+            bulletin_board: bulletin_board,
+            authority: authority,
+            trustees: trustees,
+            description: {
+              name: text(election_data[:title]),
+              start_date: election_data[:start_date].iso8601,
+              end_date: election_data[:end_date].iso8601,
+              candidates: candidates,
+              contests: contests
+            }
+          }
+        end
+
+        def scheme
+          {
+            name: settings.scheme_name,
+            quorum: settings.quorum
+          }
+        end
+
+        def bulletin_board
+          {
+            name: "Bulletin Board",
+            slug: "bulletin-board",
+            public_key: settings.server_public_key
+          }
+        end
+
+        def authority
+          {
+            name: settings.authority_name,
+            slug: settings.authority_slug,
+            public_key: settings.public_key
+          }
+        end
+
+        def trustees
+          election_data[:trustees].map do |trustee|
+            {
+              name: trustee[:name],
+              slug: trustee[:slug],
+              public_key: trustee[:public_key]
+            }
+          end
+        end
+
+        def contests
+          election_data[:questions].map do |question|
+            {
+              "@type": "CandidateContest",
+              object_id: question[:slug],
+              sequence_order: question[:weight],
+              vote_variation: question[:max_selections] == 1 ? "one_of_m" : "n_of_m",
+              name: default_text(question[:title]),
+              number_elected: question[:answers].count,
+              votes_allowed: 1,
+              ballot_title: text(question[:title]),
+              ballot_subtitle: text(question[:description]),
+              ballot_selections: contest_answers(question)
+            }
+          end
+        end
+
+        def contest_answers(question)
+          question[:answers].map do |answer|
+            {
+              object_id: "#{question[:slug]}_#{answer[:slug]}",
+              sequence_order: answer[:weight],
+              candidate_id: answer[:slug]
+            }
+          end
+        end
+
+        def candidates
+          election_data[:answers].map do |answer|
+            {
+              object_id: answer[:slug],
+              ballot_name: text(answer[:title])
+            }
+          end
+        end
+
+        def default_text(field)
+          field[default_locale]
+        end
+
+        def text(field)
+          {
+            text: field.map { |locale, value| { language: locale.to_s, value: value } }
+          }
+        end
+
+        def default_locale
+          @default_locale ||= election_data[:default_locale].to_sym
+        end
       end
     end
   end

data/lib/decidim/bulletin_board/authority/end_vote.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Decidim
+  module BulletinBoard
+    module Authority
+      # This command uses the GraphQL client to request the ending of the voting period.
+      class EndVote < Decidim::BulletinBoard::Command
+        # Public: Initializes the command.
+        #
+        # election_id - The local election identifier
+        def initialize(election_id)
+          @election_id = election_id
+        end
+
+        # Returns the message_id related to the operation
+        def message_id
+          @message_id ||= build_message_id(unique_election_id(election_id), "end_vote")
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid and the query operation is successful.
+        # - :error if query operation was not successful.
+        #
+        # Returns nothing.
+        def call
+          # arguments used inside the graphql operation
+          args = {
+            message_id: message_id,
+            signed_data: sign_message(message_id, {})
+          }
+
+          response = graphql.query do
+            mutation do
+              endVote(messageId: args[:message_id], signedData: args[:signed_data]) do
+                pendingMessage do
+                  status
+                end
+                error
+              end
+            end
+          end
+
+          return broadcast(:error, response.data.end_vote.error) if response.data.end_vote.error.present?
+
+          broadcast(:ok, response.data.end_vote.pending_message)
+        rescue Graphlient::Errors::FaradayServerError
+          broadcast(:error, "Sorry, something went wrong")
+        end
+
+        private
+
+        attr_reader :election_id
+      end
+    end
+  end
+end

data/lib/decidim/bulletin_board/authority/get_election_results.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Decidim
+  module BulletinBoard
+    module Authority
+      # This command uses the GraphQL client to get the results of an election.
+      class GetElectionResults < Decidim::BulletinBoard::Command
+        # Public: Initializes the command.
+        #
+        # election_id [String] - The local election identifier
+        def initialize(election_id)
+          @election_id = election_id
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid and the query operation is successful.
+        # - :error if query operation was not successful.
+        #
+        # Returns nothing.
+        def call
+          # arguments used inside the graphql operation
+          # unique_id [String] as election identifier
+          # types [Array of Strings] to filter election log entries by their type
+          args = {
+            unique_id: unique_election_id(election_id),
+            types: ["end_tally"]
+          }
+
+          response = graphql.query do
+            query do
+              election(uniqueId: args[:unique_id]) do
+                logEntries(types: args[:types]) do
+                  signedData
+                end
+              end
+            end
+          end
+
+          return broadcast(:error, "There aren't any log entries with type: 'end_tally' for this election.") if response.data.election.log_entries.empty?
+
+          @signed_data = response.data.election.log_entries.first.signed_data
+
+          broadcast(:ok, decoded_data["results"])
+        rescue Graphlient::Errors::ServerError
+          broadcast(:error, "Sorry, something went wrong")
+        end
+
+        private
+
+        attr_reader :election_id, :types, :signed_data
+
+        def decoded_data
+          @decoded_data ||= begin
+            JWT.decode(signed_data, settings.server_public_key_rsa, true, algorithm: "RS256").first
+          rescue JWT::VerificationError, JWT::DecodeError, JWT::InvalidIatError, JWT::InvalidPayload => e
+            { error: e.message }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/bulletin_board/authority/get_election_status.rb

@@ -19,21 +19,22 @@ module Decidim
         #
         # Returns nothing.
         def call
-          unique_id = unique_election_id(election_id)
+          # arguments used inside the graphql operation
+          args = {
+            unique_id: unique_election_id(election_id)
+          }
 
-          begin
-            response = client.query do
-              query do
-                election(uniqueId: unique_id) do
-                  status
-                end
+          response = graphql.query do
+            query do
+              election(uniqueId: args[:unique_id]) do
+                status
               end
             end
-
-            broadcast(:ok, response.data.election.status)
-          rescue Graphlient::Errors::ServerError
-            broadcast(:error, "Sorry, something went wrong")
           end
+
+          broadcast(:ok, response.data.election.status)
+        rescue Graphlient::Errors::ServerError
+          broadcast(:error, "Sorry, something went wrong")
         end
 
         private

data/lib/decidim/bulletin_board/authority/publish_results.rb

@@ -12,6 +12,11 @@ module Decidim
           @election_id = election_id
         end
 
+        # Returns the message_id related to the operation
+        def message_id
+          @message_id ||= build_message_id(unique_election_id(election_id), "publish_results")
+        end
+
         # Executes the command. Broadcasts these events:
         #
         # - :ok when everything is valid and the query operation is successful.
@@ -19,27 +24,28 @@ module Decidim
         #
         # Returns nothing.
         def call
-          message_id = message_id(unique_election_id(election_id), "publish_results")
-          signed_data = sign_message(message_id, {})
-
-          begin
-            response = client.query do
-              mutation do
-                publishResults(messageId: message_id, signedData: signed_data) do
-                  election do
-                    status
-                  end
-                  error
+          # arguments used inside the graphql operation
+          args = {
+            message_id: message_id,
+            signed_data: sign_message(message_id, {})
+          }
+
+          response = graphql.query do
+            mutation do
+              publishResults(messageId: args[:message_id], signedData: args[:signed_data]) do
+                election do
+                  status
                 end
+                error
               end
             end
+          end
 
-            return broadcast(:error, response.data.publish_results.error) if response.data.publish_results.error.present?
+          return broadcast(:error, response.data.publish_results.error) if response.data.publish_results.error.present?
 
-            broadcast(:ok, response.data.publish_results.election)
-          rescue Graphlient::Errors::ServerError
-            broadcast(:error, "Sorry, something went wrong")
-          end
+          broadcast(:ok, response.data.publish_results.election)
+        rescue Graphlient::Errors::ServerError
+          broadcast(:error, "Sorry, something went wrong")
         end
 
         private

data/lib/decidim/bulletin_board/authority/start_key_ceremony.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Decidim
+  module BulletinBoard
+    module Authority
+      # This command uses the GraphQL client to request the starting of the key ceremony.
+      class StartKeyCeremony < Decidim::BulletinBoard::Command
+        # Public: Initializes the command.
+        #
+        # election_id - The local election identifier
+        def initialize(election_id)
+          @election_id = election_id
+        end
+
+        # Returns the message_id related to the operation
+        def message_id
+          @message_id ||= build_message_id(unique_election_id(election_id), "start_key_ceremony")
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid and the query operation is successful.
+        # - :error if query operation was not successful.
+        #
+        # Returns nothing.
+        def call
+          # arguments used inside the graphql operation
+          args = {
+            message_id: message_id,
+            signed_data: sign_message(message_id, {})
+          }
+
+          response = graphql.query do
+            mutation do
+              startKeyCeremony(messageId: args[:message_id], signedData: args[:signed_data]) do
+                pendingMessage do
+                  status
+                end
+                error
+              end
+            end
+          end
+
+          return broadcast(:error, response.data.start_key_ceremony.error) if response.data.start_key_ceremony.error.present?
+
+          broadcast(:ok, response.data.start_key_ceremony.pending_message)
+        rescue Graphlient::Errors::FaradayServerError
+          broadcast(:error, "Sorry, something went wrong")
+        end
+
+        private
+
+        attr_reader :election_id
+      end
+    end
+  end
+end