decidim-bulletin_board 0.8.0 → 0.10.0

data/lib/decidim/bulletin_board/authority/start_tally.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), "start_tally")
+        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), "start_tally")
-          signed_data = sign_message(message_id, {})
-
-          begin
-            response = client.query do
-              mutation do
-                startTally(messageId: message_id, signedData: signed_data) do
-                  pendingMessage 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
+              startTally(messageId: args[:message_id], signedData: args[:signed_data]) do
+                pendingMessage do
+                  status
                 end
+                error
               end
             end
+          end
 
-            return broadcast(:error, response.data.start_tally.error) if response.data.start_tally.error.present?
+          return broadcast(:error, response.data.start_tally.error) if response.data.start_tally.error.present?
 
-            broadcast(:ok, response.data.start_tally.pending_message)
-          rescue Graphlient::Errors::ServerError
-            broadcast(:error, "Sorry, something went wrong")
-          end
+          broadcast(:ok, response.data.start_tally.pending_message)
+        rescue Graphlient::Errors::ServerError
+          broadcast(:error, "Sorry, something went wrong")
         end
 
         private

data/lib/decidim/bulletin_board/authority/start_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 starting of the voting period.
+      class StartVote < 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_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
+              startVote(messageId: args[:message_id], signedData: args[:signed_data]) do
+                pendingMessage do
+                  status
+                end
+                error
+              end
+            end
+          end
+
+          return broadcast(:error, response.data.start_vote.error) if response.data.start_vote.error.present?
+
+          broadcast(:ok, response.data.start_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/client.rb

@@ -1,94 +1,103 @@
 # 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
-        return 0 if @scheme.dig(:parameters, :quorum).blank?
-
-        @scheme.dig(:parameters, :quorum)
-      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 }
         create_election.call
       end
 
-      def open_ballot_box(election_id)
-        open_ballot_box = Decidim::BulletinBoard::Authority::OpenBallotBox.new(election_id)
-        open_ballot_box.on(:ok) { |election| return election }
-        open_ballot_box.on(:error) { |error_message| raise StandardError, error_message }
-        open_ballot_box.call
-      end
-
-      def close_ballot_box(election_id)
-        close_ballot_box = Decidim::BulletinBoard::Authority::CloseBallotBox.new(election_id)
-        close_ballot_box.on(:ok) { |election| return election }
-        close_ballot_box.on(:error) { |error_message| raise StandardError, error_message }
-        close_ballot_box.call
+      def start_key_ceremony(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 }
+        start_key_ceremony.call
       end
 
-      def cast_vote_message_id(election_id, voter_id)
-        Decidim::BulletinBoard::Voter::CastVote.cast_vote_message_id(election_id, voter_id)
+      def start_vote(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 }
+        start_vote.call
       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 }
         cast_vote.call
       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 = 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 }
+        end_vote.call
+      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_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 }
         publish_results.call
@@ -96,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

data/lib/decidim/bulletin_board/command.rb

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
-require "decidim/bulletin_board/graphql/client"
-
 module Decidim
   module BulletinBoard
     # The base class for all commands.
     class Command
       include Wisper::Publisher
 
-      delegate :authority_slug, :private_key, :unique_election_id, :message_id, to: :class
+      attr_reader :settings, :graphql
 
-      def sign_message(message_id, message)
-        JWT.encode(complete_message(message_id, message), private_key.keypair, "RS256")
+      def configure(settings, graphql)
+        @settings = settings
+        @graphql = graphql
       end
 
-      def client
-        @client ||= BulletinBoard::Graphql::Client.client
+      def sign_message(message_id, message)
+        JWT.encode(complete_message(message_id, message), settings.private_key.keypair, "RS256")
       end
 
       def complete_message(message_id, message)
@@ -25,26 +24,12 @@ module Decidim
                       })
       end
 
-      class << self
-        def self.call(*args)
-          new(*args).call
-        end
-
-        def private_key
-          @private_key ||= JwkUtils.import_private_key(BulletinBoard.identification_private_key)
-        end
-
-        def authority_slug
-          @authority_slug ||= BulletinBoard.authority_name.parameterize
-        end
-
-        def unique_election_id(election_id)
-          Decidim::BulletinBoard::MessageIdentifier.unique_election_id(authority_slug, election_id)
-        end
+      def build_message_id(unique_election_id, type_subtype, voter_id = nil)
+        MessageIdentifier.format(unique_election_id, type_subtype, voter_id ? :voter : :authority, voter_id || settings.authority_slug)
+      end
 
-        def message_id(unique_election_id, type_subtype, voter_id = nil)
-          Decidim::BulletinBoard::MessageIdentifier.format(unique_election_id, type_subtype, voter_id ? :voter : :authority, voter_id || authority_slug)
-        end
+      def unique_election_id(election_id)
+        MessageIdentifier.unique_election_id(settings.authority_slug, election_id)
       end
     end
   end

data/lib/decidim/bulletin_board/graphql/bb_schema.json

@@ -114,47 +114,6 @@
           "enumValues": null,
           "possibleTypes": null
         },
-        {
-          "kind": "OBJECT",
-          "name": "CloseBallotBoxMutationPayload",
-          "description": "Autogenerated return type of CloseBallotBoxMutation",
-          "fields": [
-            {
-              "name": "election",
-              "description": null,
-              "args": [
-
-              ],
-              "type": {
-                "kind": "OBJECT",
-                "name": "Election",
-                "ofType": null
-              },
-              "isDeprecated": false,
-              "deprecationReason": null
-            },
-            {
-              "name": "error",
-              "description": null,
-              "args": [
-
-              ],
-              "type": {
-                "kind": "SCALAR",
-                "name": "String",
-                "ofType": null
-              },
-              "isDeprecated": false,
-              "deprecationReason": null
-            }
-          ],
-          "inputFields": null,
-          "interfaces": [
-
-          ],
-          "enumValues": null,
-          "possibleTypes": null
-        },
         {
           "kind": "OBJECT",
           "name": "CreateElectionMutationPayload",
@@ -250,6 +209,24 @@
                     "ofType": null
                   },
                   "defaultValue": null
+                },
+                {
+                  "name": "types",
+                  "description": null,
+                  "type": {
+                    "kind": "LIST",
+                    "name": null,
+                    "ofType": {
+                      "kind": "NON_NULL",
+                      "name": null,
+                      "ofType": {
+                        "kind": "SCALAR",
+                        "name": "String",
+                        "ofType": null
+                      }
+                    }
+                  },
+                  "defaultValue": null
                 }
               ],
               "type": {
@@ -301,7 +278,7 @@
                 "name": null,
                 "ofType": {
                   "kind": "SCALAR",
-                  "name": "String",
+                  "name": "JSON",
                   "ofType": null
                 }
               },
@@ -342,6 +319,47 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "OBJECT",
+          "name": "EndVoteMutationPayload",
+          "description": "Autogenerated return type of EndVoteMutation",
+          "fields": [
+            {
+              "name": "error",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "pendingMessage",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "OBJECT",
+                "name": "PendingMessage",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [
+
+          ],
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "SCALAR",
           "name": "ID",
@@ -417,6 +435,24 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "decodedData",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "JSON",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "election",
               "description": null,
@@ -611,7 +647,7 @@
           "description": null,
           "fields": [
             {
-              "name": "closeBallotBox",
+              "name": "createElection",
               "description": null,
               "args": [
                 {
@@ -645,14 +681,14 @@
               ],
               "type": {
                 "kind": "OBJECT",
-                "name": "CloseBallotBoxMutationPayload",
+                "name": "CreateElectionMutationPayload",
                 "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
-              "name": "createElection",
+              "name": "endVote",
               "description": null,
               "args": [
                 {
@@ -686,14 +722,14 @@
               ],
               "type": {
                 "kind": "OBJECT",
-                "name": "CreateElectionMutationPayload",
+                "name": "EndVoteMutationPayload",
                 "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
-              "name": "openBallotBox",
+              "name": "processKeyCeremonyStep",
               "description": null,
               "args": [
                 {
@@ -727,14 +763,14 @@
               ],
               "type": {
                 "kind": "OBJECT",
-                "name": "OpenBallotBoxMutationPayload",
+                "name": "ProcessKeyCeremonyStepMutationPayload",
                 "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
-              "name": "processKeyCeremonyStep",
+              "name": "processTallyStep",
               "description": null,
               "args": [
                 {
@@ -768,14 +804,14 @@
               ],
               "type": {
                 "kind": "OBJECT",
-                "name": "ProcessKeyCeremonyStepMutationPayload",
+                "name": "ProcessTallyStepMutationPayload",
                 "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
-              "name": "processTallyStep",
+              "name": "publishResults",
               "description": null,
               "args": [
                 {
@@ -809,14 +845,14 @@
               ],
               "type": {
                 "kind": "OBJECT",
-                "name": "ProcessTallyStepMutationPayload",
+                "name": "PublishResultsMutationPayload",
                 "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
-              "name": "publishResults",
+              "name": "startKeyCeremony",
               "description": null,
               "args": [
                 {
@@ -850,7 +886,7 @@
               ],
               "type": {
                 "kind": "OBJECT",
-                "name": "PublishResultsMutationPayload",
+                "name": "StartKeyCeremonyMutationPayload",
                 "ofType": null
               },
               "isDeprecated": false,
@@ -898,7 +934,7 @@
               "deprecationReason": null
             },
             {
-              "name": "vote",
+              "name": "startVote",
               "description": null,
               "args": [
                 {
@@ -932,48 +968,48 @@
               ],
               "type": {
                 "kind": "OBJECT",
-                "name": "VoteMutationPayload",
-                "ofType": null
-              },
-              "isDeprecated": false,
-              "deprecationReason": null
-            }
-          ],
-          "inputFields": null,
-          "interfaces": [
-
-          ],
-          "enumValues": null,
-          "possibleTypes": null
-        },
-        {
-          "kind": "OBJECT",
-          "name": "OpenBallotBoxMutationPayload",
-          "description": "Autogenerated return type of OpenBallotBoxMutation",
-          "fields": [
-            {
-              "name": "election",
-              "description": null,
-              "args": [
-
-              ],
-              "type": {
-                "kind": "OBJECT",
-                "name": "Election",
+                "name": "StartVoteMutationPayload",
                 "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
-              "name": "error",
+              "name": "vote",
               "description": null,
               "args": [
-
+                {
+                  "name": "messageId",
+                  "description": null,
+                  "type": {
+                    "kind": "NON_NULL",
+                    "name": null,
+                    "ofType": {
+                      "kind": "SCALAR",
+                      "name": "String",
+                      "ofType": null
+                    }
+                  },
+                  "defaultValue": null
+                },
+                {
+                  "name": "signedData",
+                  "description": null,
+                  "type": {
+                    "kind": "NON_NULL",
+                    "name": null,
+                    "ofType": {
+                      "kind": "SCALAR",
+                      "name": "String",
+                      "ofType": null
+                    }
+                  },
+                  "defaultValue": null
+                }
               ],
               "type": {
-                "kind": "SCALAR",
-                "name": "String",
+                "kind": "OBJECT",
+                "name": "VoteMutationPayload",
                 "ofType": null
               },
               "isDeprecated": false,
@@ -1415,6 +1451,47 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "OBJECT",
+          "name": "StartKeyCeremonyMutationPayload",
+          "description": "Autogenerated return type of StartKeyCeremonyMutation",
+          "fields": [
+            {
+              "name": "error",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "pendingMessage",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "OBJECT",
+                "name": "PendingMessage",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [
+
+          ],
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "OBJECT",
           "name": "StartTallyMutationPayload",
@@ -1456,6 +1533,47 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "OBJECT",
+          "name": "StartVoteMutationPayload",
+          "description": "Autogenerated return type of StartVoteMutation",
+          "fields": [
+            {
+              "name": "error",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "pendingMessage",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "OBJECT",
+                "name": "PendingMessage",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [
+
+          ],
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "SCALAR",
           "name": "String",