decidim-bulletin_board 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a143d34d670d822c82a6f08abaa0f90faf4e9312875cba0a9117faa09679e5f
-  data.tar.gz: 27b4d187001dd0aa3ed497bb6c4d21138b794075e91faace0eae5fa8c2738d50
+  metadata.gz: e07fa810de254d60c03c695aa6708e8813cf1f71a4df80fb7c0086ea57da74de
+  data.tar.gz: fd6bfc7b6afc49fac85f6b8d34d27a6c39cf37d679e2a7faf702a05bc7ec52d4
 SHA512:
-  metadata.gz: aebd18c91bc774fc539fc87940fb5da309217e3850770e3b0e4f751d35222295e43eca3f1f0d8702730ffed582f2676f192e4142d2f092b9185f162ff12b9644
-  data.tar.gz: a458ac71cc856888dff79c2c5e2504e14cd2ef9191a74025fca344e9598ee691740cb29481932ddb9bc71467e6504a1457349ca4c47bc11f5f96d41027b10c33
+  metadata.gz: 98aaac12e64a4aafcd67d8058518cf36b389ef2bca2cddffc23f03944ed7194b2d38568e77a76e910a0289974e5e1a4f539b513fcebc935fb1e69b6ca332bb68
+  data.tar.gz: 73c0f19adfa8c2365491c4d9a46387fecb7d01098695e734e3653c1f43944e40aa5c07168ba86877394029ac16feb85ccdd0aa2b25ca02f54ec837588a82a4de

data/CHANGELOG.md

@@ -5,7 +5,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.5.0] - 2020-12-19
+
+### Changed
+
+- Renamed `setup_election` to `create_election` and moved `election_id` from the `election_data` to a separate argument.
+
+### Fixed
+
+- Include the missing `open_ballot_box` and `close_ballot_box` methods from the previous release.
+- Added missing namespace on the seed task
+
+## [0.4.0] - 2020-12-18
+
+### Added
+
+- `content_hash` field for the `LogEntry` records with the hash of the `content` field, if included in the message.
+- `Command` base class for all the classes representing GraphQL queries or mutations sent to the Bulletin Board.
+- `open_ballot_box` and `close_ballot_box` methods to the `Decidim::BulletinBoard::Client`.
+
+### Changed
+
+- New format for the messages: `iat`, `message_id` and Bulletin Board fields in the root message, and `content` for the Voting Scheme messages.
+- Improved consistency between methods included by `Decidim::BulletinBoard::Client`.
 
 ## [0.3.1] - 2020-12-10
 

data/Gemfile.lock

@@ -1,24 +1,25 @@
 PATH
   remote: .
   specs:
-    decidim-bulletin_board (0.3.1)
-      activemodel (~> 5.0, >= 5.0.0.1)
-      activesupport (~> 5.0, >= 5.0.0.1)
+    decidim-bulletin_board (0.5.0)
+      activemodel (>= 5.0.0)
+      activesupport (>= 5.0.0)
       byebug (~> 11.0)
       graphlient (~> 0.4.0)
-      jwt
+      jwt (~> 2.2.2)
       wisper (~> 2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.4.4)
-      activesupport (= 5.2.4.4)
-    activesupport (5.2.4.4)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
@@ -88,7 +89,7 @@ GEM
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.8)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     webmock (3.10.0)
@@ -97,6 +98,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
     wisper (2.0.1)
     wisper-rspec (1.1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/lib/decidim/bulletin_board.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
+require "active_model"
+require "active_support/configurable"
 require "decidim/bulletin_board/version"
+require "jwt"
 require "graphlient"
 require "wisper"
-require "active_model"
+
 require "decidim/bulletin_board/jwk_utils"
 require "decidim/bulletin_board/message_identifier"
+
 require "decidim/bulletin_board/client"
-require "decidim/bulletin_board/graphql/client"
-require "decidim/bulletin_board/voter"
 require "decidim/bulletin_board/authority"
-require "active_support/configurable"
-require "jwt"
+require "decidim/bulletin_board/voter"
 
 module Decidim
   # This module holds all the logic for the Bulletin Board Ruby Client to connect

data/lib/decidim/bulletin_board/authority.rb

@@ -2,3 +2,5 @@
 
 require "decidim/bulletin_board/authority/create_election"
 require "decidim/bulletin_board/authority/get_election_status"
+require "decidim/bulletin_board/authority/open_ballot_box"
+require "decidim/bulletin_board/authority/close_ballot_box"

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Decidim
+  module BulletinBoard
+    module Authority
+      # This command uses the GraphQL client to request the closing of the ballot box.
+      class CloseBallotBox < Decidim::BulletinBoard::Command
+        # Public: Initializes the command.
+        #
+        # election_id - 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
+          message_id = message_id(unique_election_id(election_id), "close_ballot_box")
+          signed_data = sign_message(message_id, {})
+
+          begin
+            response = client.query do
+              mutation do
+                closeBallotBox(messageId: message_id, signedData: signed_data) do
+                  election do
+                    status
+                  end
+                  error
+                end
+              end
+            end
+
+            return broadcast(:error, response.data.close_ballot_box.error) if response.data.close_ballot_box.error.present?
+
+            broadcast(:ok, response.data.close_ballot_box.election)
+          rescue Graphlient::Errors::ServerError
+            broadcast(:error, "Sorry, something went wrong")
+          end
+        end
+
+        private
+
+        attr_reader :election_id
+      end
+    end
+  end
+end

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

@@ -4,49 +4,39 @@ module Decidim
   module BulletinBoard
     module Authority
       # This class handles the creation of an election.
-      class CreateElection
-        def initialize(election_data, message_id)
-          @client = BulletinBoard::Graphql::Client.client
+      class CreateElection < Decidim::BulletinBoard::Command
+        def initialize(election_id, election_data)
+          @election_id = election_id
           @election_data = election_data
-          @message_id = message_id
-          @private_key = private_key
-        end
-
-        def self.call(election_data, message_id)
-          new(election_data, message_id).call
         end
 
         def call
-          args = {
-            message_id: message_id,
-            signed_data: encode_data(election_data)
-          }
-
-          response = client.query do
-            mutation do
-              createElection(messageId: args[:message_id], signedData: args[:signed_data]) do
-                election do
-                  status
+          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
                 end
-                error
               end
             end
-          end
 
-          response.data.create_election
+            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
         end
 
         private
 
-        attr_reader :client, :election_data, :message_id
-
-        def private_key
-          @private_key ||= JwkUtils.import_private_key(BulletinBoard.identification_private_key)
-        end
-
-        def encode_data(election_data)
-          JWT.encode(election_data, private_key.keypair, "RS256")
-        end
+        attr_reader :election_data, :election_id
       end
     end
   end

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

@@ -4,11 +4,10 @@ module Decidim
   module BulletinBoard
     module Authority
       # This command uses the GraphQL client to get the status of the election.
-      class GetElectionStatus
-        include Wisper::Publisher
+      class GetElectionStatus < Decidim::BulletinBoard::Command
         # Public: Initializes the command.
         #
-        # election - The election to receive the status from.
+        # election_id - The local election identifier
         def initialize(election_id)
           @election_id = election_id
         end
@@ -20,14 +19,12 @@ module Decidim
         #
         # Returns nothing.
         def call
-          args = {
-            unique_id: election_id
-          }
+          unique_id = unique_election_id(election_id)
 
           begin
             response = client.query do
               query do
-                election(uniqueId: args[:unique_id]) do
+                election(uniqueId: unique_id) do
                   status
                 end
               end
@@ -42,10 +39,6 @@ module Decidim
         private
 
         attr_reader :election_id
-
-        def client
-          @client ||= BulletinBoard::Graphql::Client.client
-        end
       end
     end
   end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Decidim
+  module BulletinBoard
+    module Authority
+      # This command uses the GraphQL client to request the opening of the ballot box.
+      class OpenBallotBox < Decidim::BulletinBoard::Command
+        # Public: Initializes the command.
+        #
+        # election_id - 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
+          message_id = message_id(unique_election_id(election_id), "open_ballot_box")
+          signed_data = sign_message(message_id, {})
+
+          begin
+            response = client.query do
+              mutation do
+                openBallotBox(messageId: message_id, signedData: signed_data) do
+                  election do
+                    status
+                  end
+                  error
+                end
+              end
+            end
+
+            return broadcast(:error, response.data.open_ballot_box.error) if response.data.open_ballot_box.error.present?
+
+            broadcast(:ok, response.data.open_ballot_box.election)
+          rescue Graphlient::Errors::ServerError
+            broadcast(:error, "Sorry, something went wrong")
+          end
+        end
+
+        private
+
+        attr_reader :election_id
+      end
+    end
+  end
+end

data/lib/decidim/bulletin_board/client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "decidim/bulletin_board/command"
+
 module Decidim
   module BulletinBoard
     # The Bulletin Board client
@@ -34,26 +36,29 @@ module Decidim
         private_key && server && api_key
       end
 
-      def sign_data(data)
-        JWT.encode(data, private_key.keypair, "RS256")
+      def create_election(election_id, election_data)
+        create_election = Decidim::BulletinBoard::Authority::CreateElection.new(election_id, election_data)
+        create_election.on(:ok) { |election| return election }
+        create_election.on(:error) { |error_message| raise StandardError, error_message }
+        create_election.call
       end
 
-      def setup_election(election_data)
-        message_id = "#{election_data[:election_id]}.create_election+a.#{authority_slug}"
-        Decidim::BulletinBoard::Authority::CreateElection.call(election_data, message_id)
+      def open_ballot_box(election_id)
+        open_ballot_box = Decidim::BulletinBoard::Election::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 cast_vote(election_data, voter_data, encrypted_vote)
-        form = Decidim::BulletinBoard::Voter::VoteForm.new(self, election_data, voter_data, encrypted_vote)
-        cast_vote = Decidim::BulletinBoard::Voter::CastVote.new(form)
+      def cast_vote(election_id, voter_id, encrypted_vote)
+        cast_vote = Decidim::BulletinBoard::Voter::CastVote.new(election_id, voter_id, encrypted_vote)
         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_status(election_id)
-        unique_election_id = "#{authority_slug}.#{election_id}"
-        get_status = Decidim::BulletinBoard::Authority::GetElectionStatus.new(unique_election_id)
+        get_status = Decidim::BulletinBoard::Authority::GetElectionStatus.new(election_id)
         get_status.on(:ok) { |status| return status }
         get_status.on(:error) { |error_message| raise StandardError, error_message }
         get_status.call

data/lib/decidim/bulletin_board/command.rb

@@ -0,0 +1,51 @@
+# 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, to: :class
+
+      def unique_election_id(election_id)
+        Decidim::BulletinBoard::MessageIdentifier.unique_election_id(authority_slug, election_id)
+      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 sign_message(message_id, message)
+        JWT.encode(complete_message(message_id, message), private_key.keypair, "RS256")
+      end
+
+      def client
+        @client ||= BulletinBoard::Graphql::Client.client
+      end
+
+      def complete_message(message_id, message)
+        message.merge({
+                        iat: Time.now.to_i,
+                        message_id: message_id
+                      })
+      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
+      end
+    end
+  end
+end

data/lib/decidim/bulletin_board/version.rb

@@ -2,6 +2,6 @@
 
 module Decidim
   module BulletinBoard
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/decidim/bulletin_board/voter.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
 require "decidim/bulletin_board/voter/cast_vote"
-require "decidim/bulletin_board/voter/vote_form"

data/lib/decidim/bulletin_board/voter/cast_vote.rb

@@ -4,13 +4,14 @@ module Decidim
   module BulletinBoard
     module Voter
       # This command uses the GraphQL client to cast the vote.
-      class CastVote
-        include Wisper::Publisher
+      class CastVote < Decidim::BulletinBoard::Command
         # Public: Initializes the command.
         #
         # form - A form object with the params.
-        def initialize(form)
-          @form = form
+        def initialize(election_id, voter_id, encrypted_vote)
+          @election_id = election_id
+          @voter_id = voter_id
+          @encrypted_vote = encrypted_vote
         end
 
         # Executes the command. Broadcasts these events:
@@ -20,17 +21,13 @@ module Decidim
         #
         # Returns nothing.
         def call
-          return broadcast(:error, form.errors.full_messages.join(". ")) unless form.valid?
-
-          args = {
-            message_id: form.message_id,
-            signed_data: form.signed_data
-          }
+          message_id = message_id(unique_election_id(election_id), "vote.cast", voter_id)
+          signed_data = sign_message(message_id, { content: encrypted_vote })
 
           begin
             response = client.query do
               mutation do
-                vote(messageId: args[:message_id], signedData: args[:signed_data]) do
+                vote(messageId: message_id, signedData: signed_data) do
                   pendingMessage do
                     status
                   end
@@ -49,11 +46,7 @@ module Decidim
 
         private
 
-        attr_reader :form
-
-        def client
-          @client ||= BulletinBoard::Graphql::Client.client
-        end
+        attr_reader :election_id, :voter_id, :encrypted_vote
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-bulletin_board
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - David Morcillo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -175,16 +175,18 @@ files:
 - decidim-bulletin_board.gemspec
 - lib/decidim/bulletin_board.rb
 - lib/decidim/bulletin_board/authority.rb
+- lib/decidim/bulletin_board/authority/close_ballot_box.rb
 - lib/decidim/bulletin_board/authority/create_election.rb
 - lib/decidim/bulletin_board/authority/get_election_status.rb
+- lib/decidim/bulletin_board/authority/open_ballot_box.rb
 - lib/decidim/bulletin_board/client.rb
+- lib/decidim/bulletin_board/command.rb
 - lib/decidim/bulletin_board/graphql/client.rb
 - lib/decidim/bulletin_board/jwk_utils.rb
 - lib/decidim/bulletin_board/message_identifier.rb
 - lib/decidim/bulletin_board/version.rb
 - lib/decidim/bulletin_board/voter.rb
 - lib/decidim/bulletin_board/voter/cast_vote.rb
-- lib/decidim/bulletin_board/voter/vote_form.rb
 homepage: https://github.com
 licenses:
 - AGPL-3.0

data/lib/decidim/bulletin_board/voter/vote_form.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module Decidim
-  module BulletinBoard
-    module Voter
-      # A form object to handle some data transformation and validation to cast a vote.
-      class VoteForm
-        include ActiveModel::Validations
-
-        validates :election_data, :voter_data, :encrypted_vote, presence: true
-        validate :election_id_present
-        validate :voter_id_present
-
-        # Public: initialize the form
-        #
-        # bulletin_board_data - An instance of the bulletin board client
-        # election_data - A Hash including the necessary data from the election.
-        # voter_data - A Hash including the necessary data from the voter.
-        # encrypted_vote - A Hash including the encrypted vote to cast
-        def initialize(bulletin_board_client, election_data, voter_data, encrypted_vote)
-          @bulletin_board_client = bulletin_board_client
-          @election_data = election_data
-          @voter_data = voter_data
-          @encrypted_vote = encrypted_vote
-        end
-
-        # Public: returns a message identifier for the cast vote operation.
-        def message_id
-          @message_id ||= "#{election_id}.vote.cast+v.#{voter_id}"
-        end
-
-        # Public: uses the bulletin board client to sign the encrypted vote merged with the metadata
-        def signed_data
-          @signed_data ||= bulletin_board_client.sign_data(message)
-        end
-
-        private
-
-        attr_reader :bulletin_board_client, :election_data, :voter_data, :encrypted_vote
-
-        def election_id_present
-          errors.add(:election_data, "doesn't include the election id") unless election_id.present?
-        end
-
-        def election_id
-          return if election_data.blank?
-
-          election_data[:election_id]
-        end
-
-        def voter_id_present
-          errors.add(:voter_data, "doesn't include the voter id") unless voter_id.present?
-        end
-
-        def voter_id
-          return if voter_data.blank?
-
-          voter_data[:voter_id]
-        end
-
-        def message
-          {
-            iat: Time.now.to_i,
-            message_id: message_id,
-            content: encrypted_vote
-          }
-        end
-      end
-    end
-  end
-end