decidim-bulletin_board 0.9.2 → 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

@@ -19,10 +19,10 @@ module Decidim
           # arguments used inside the graphql operation
           args = {
             message_id: message_id,
-            signed_data: sign_message(message_id, election_data)
+            signed_data: sign_message(message_id, message)
           }
 
-          response = client.query do
+          response = graphql.query do
             mutation do
               createElection(messageId: args[:message_id], signedData: args[:signed_data]) do
                 election do
@@ -43,6 +43,105 @@ module Decidim
         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

@@ -30,7 +30,7 @@ module Decidim
             signed_data: sign_message(message_id, {})
           }
 
-          response = client.query do
+          response = graphql.query do
             mutation do
               endVote(messageId: args[:message_id], signedData: args[:signed_data]) do
                 pendingMessage do

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

@@ -24,7 +24,7 @@ module Decidim
             unique_id: unique_election_id(election_id)
           }
 
-          response = client.query do
+          response = graphql.query do
             query do
               election(uniqueId: args[:unique_id]) do
                 status

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

@@ -30,7 +30,7 @@ module Decidim
             signed_data: sign_message(message_id, {})
           }
 
-          response = client.query do
+          response = graphql.query do
             mutation do
               publishResults(messageId: args[:message_id], signedData: args[:signed_data]) do
                 election do

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

@@ -30,7 +30,7 @@ module Decidim
             signed_data: sign_message(message_id, {})
           }
 
-          response = client.query do
+          response = graphql.query do
             mutation do
               startKeyCeremony(messageId: args[:message_id], signedData: args[:signed_data]) do
                 pendingMessage do

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

@@ -30,7 +30,7 @@ module Decidim
             signed_data: sign_message(message_id, {})
           }
 
-          response = client.query do
+          response = graphql.query do
             mutation do
               startTally(messageId: args[:message_id], signedData: args[:signed_data]) do
                 pendingMessage do

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

@@ -30,7 +30,7 @@ module Decidim
             signed_data: sign_message(message_id, {})
           }
 
-          response = client.query do
+          response = graphql.query do
             mutation do
               startVote(messageId: args[:message_id], signedData: args[:signed_data]) do
                 pendingMessage do

data/lib/decidim/bulletin_board/client.rb

@@ -1,39 +1,33 @@
 # frozen_string_literal: true
 
 require "decidim/bulletin_board/command"
+require "decidim/bulletin_board/graphql/factory"
+require "decidim/bulletin_board/settings"
+
+require "decidim/bulletin_board/authority/create_election"
+require "decidim/bulletin_board/authority/end_vote"
+require "decidim/bulletin_board/authority/get_election_status"
+require "decidim/bulletin_board/authority/start_key_ceremony"
+require "decidim/bulletin_board/authority/start_tally"
+require "decidim/bulletin_board/authority/start_vote"
+require "decidim/bulletin_board/authority/publish_results"
+require "decidim/bulletin_board/authority/get_election_results"
+require "decidim/bulletin_board/voter/cast_vote"
+require "decidim/bulletin_board/voter/get_pending_message_status"
 
 module Decidim
   module BulletinBoard
     # The Bulletin Board client
     class Client
-      def initialize
-        @server = BulletinBoard.server.presence
-        @api_key = BulletinBoard.api_key.presence
-        @scheme = BulletinBoard.scheme.presence
-        @authority_name = BulletinBoard.authority_name.presence
-        @number_of_trustees = BulletinBoard.number_of_trustees.presence
-        @identification_private_key = BulletinBoard.identification_private_key.presence
-        @private_key = identification_private_key_content if identification_private_key
+      def initialize(config = Decidim::BulletinBoard)
+        @settings = Settings.new(config)
+        @graphql = Graphql::Factory.client_for(settings)
       end
 
-      attr_reader :server, :scheme, :api_key, :number_of_trustees, :authority_name
-
-      delegate :authority_slug, to: Decidim::BulletinBoard::Command
-
-      def quorum
-        @scheme.dig(:parameters, :quorum) || number_of_trustees
-      end
-
-      def public_key
-        private_key&.export
-      end
-
-      def configured?
-        private_key && server && api_key
-      end
+      delegate :configured?, :server, :public_key, :authority_name, :number_of_trustees, :quorum, to: :settings
 
       def create_election(election_id, election_data)
-        create_election = Decidim::BulletinBoard::Authority::CreateElection.new(election_id, election_data)
+        create_election = configure Authority::CreateElection.new(election_id, election_data)
         yield create_election.message_id if block_given?
         create_election.on(:ok) { |election| return election }
         create_election.on(:error) { |error_message| raise StandardError, error_message }
@@ -41,7 +35,7 @@ module Decidim
       end
 
       def start_key_ceremony(election_id)
-        start_key_ceremony = Decidim::BulletinBoard::Authority::StartKeyCeremony.new(election_id)
+        start_key_ceremony = configure Authority::StartKeyCeremony.new(election_id)
         yield start_key_ceremony.message_id if block_given?
         start_key_ceremony.on(:ok) { |pending_message| return pending_message }
         start_key_ceremony.on(:error) { |error_message| raise StandardError, error_message }
@@ -49,7 +43,7 @@ module Decidim
       end
 
       def start_vote(election_id)
-        start_vote = Decidim::BulletinBoard::Authority::StartVote.new(election_id)
+        start_vote = configure Authority::StartVote.new(election_id)
         yield start_vote.message_id if block_given?
         start_vote.on(:ok) { |pending_message| return pending_message }
         start_vote.on(:error) { |error_message| raise StandardError, error_message }
@@ -57,7 +51,7 @@ module Decidim
       end
 
       def cast_vote(election_id, voter_id, encrypted_vote)
-        cast_vote = Decidim::BulletinBoard::Voter::CastVote.new(election_id, voter_id, encrypted_vote)
+        cast_vote = configure Voter::CastVote.new(election_id, voter_id, encrypted_vote)
         yield cast_vote.message_id if block_given?
         cast_vote.on(:ok) { |pending_message| return pending_message }
         cast_vote.on(:error) { |error_message| raise StandardError, error_message }
@@ -65,14 +59,14 @@ module Decidim
       end
 
       def get_pending_message_status(message_id)
-        get_pending_message_status = Decidim::BulletinBoard::Voter::GetPendingMessageStatus.new(message_id)
+        get_pending_message_status = configure Voter::GetPendingMessageStatus.new(message_id)
         get_pending_message_status.on(:ok) { |status| return status }
         get_pending_message_status.on(:error) { |error_message| raise StandardError, error_message }
         get_pending_message_status.call
       end
 
       def end_vote(election_id)
-        end_vote = Decidim::BulletinBoard::Authority::EndVote.new(election_id)
+        end_vote = configure Authority::EndVote.new(election_id)
         yield end_vote.message_id if block_given?
         end_vote.on(:ok) { |pending_message| return pending_message }
         end_vote.on(:error) { |error_message| raise StandardError, error_message }
@@ -80,29 +74,29 @@ module Decidim
       end
 
       def get_election_status(election_id)
-        get_election_status = Decidim::BulletinBoard::Authority::GetElectionStatus.new(election_id)
+        get_election_status = configure Authority::GetElectionStatus.new(election_id)
         get_election_status.on(:ok) { |status| return status }
         get_election_status.on(:error) { |error_message| raise StandardError, error_message }
         get_election_status.call
       end
 
       def start_tally(election_id)
-        start_tally = Decidim::BulletinBoard::Authority::StartTally.new(election_id)
+        start_tally = configure Authority::StartTally.new(election_id)
         yield start_tally.message_id if block_given?
         start_tally.on(:ok) { |pending_message| return pending_message }
         start_tally.on(:error) { |error_message| raise StandardError, error_message }
         start_tally.call
       end
 
-      def get_election_log_entries_by_types(election_id, types)
-        get_log_entries = Decidim::BulletinBoard::Authority::GetElectionLogEntriesByTypes.new(election_id, types)
-        get_log_entries.on(:ok) { |log_entries| return log_entries }
+      def get_election_results(election_id)
+        get_log_entries = configure Authority::GetElectionResults.new(election_id)
+        get_log_entries.on(:ok) { |result| return result }
         get_log_entries.on(:error) { |error_message| raise StandardError, error_message }
         get_log_entries.call
       end
 
       def publish_results(election_id)
-        publish_results = Decidim::BulletinBoard::Authority::PublishResults.new(election_id)
+        publish_results = configure Authority::PublishResults.new(election_id)
         yield publish_results.message_id if block_given?
         publish_results.on(:ok) { |status| return status }
         publish_results.on(:error) { |error_message| raise StandardError, error_message }
@@ -111,10 +105,11 @@ module Decidim
 
       private
 
-      attr_reader :identification_private_key, :private_key
+      attr_reader :settings, :graphql
 
-      def identification_private_key_content
-        @identification_private_key_content ||= JwkUtils.import_private_key(identification_private_key)
+      def configure(command)
+        command.configure(settings, graphql)
+        command
       end
     end
   end