decidim-bulletin_board 0.3.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 834f029e86c9fad845c573cc2c72e6294767de95193f985e7d6d79997e616b30
-  data.tar.gz: 44c6711314e297ca4b876b6ef535f0443acfe66e1c5dfda93bc7307a1529dc69
+  metadata.gz: 14ab42b976ab2c16370b405c995cc97045680383a53b72005d8b2306b488a79b
+  data.tar.gz: 3dcad6e5e2a5b6a97bd430e31cba7b32b101533f418a709b3d010e43827be6f7
 SHA512:
-  metadata.gz: 2ac8ef1bee39287b22c036c4f2abfd69c7e7922884295b44a87696be2be68e56e9392646774bcfe8f6ccf5b3c7fdcf0164a2f95499bdb7165598316b6b46d4cf
-  data.tar.gz: ff16f63812d6cb53fbb2126ce2bbd9debf5aec15f8f5728d0ed74a7f715d1f657401a21011b198646c4e02e7988af22e56f61b3cc50d69fc6aa810661a145036
+  metadata.gz: 34ad882ded057af2c4935c10e1f3ef524bb0037627a22893a58b27c1ac29d1106b70626510cf6bb86bc4338bc7f8bc86860699b83def828e486f297d3e9b4561
+  data.tar.gz: 3cd06a69f5a15c24441c0ecdf257638acda1d17487a6a1835f47fc20a6e020951bb5ae40b146db83b495d59e05901a31483226b37f4fd902e86c4b70d872f598

data/CHANGELOG.md

@@ -5,7 +5,42 @@ 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.2] - 2020-12-20
+
+### Fixed
+
+- Include the schema definition within the gem to avoid extra trips to the server
+
+## [0.5.1] - 2020-12-19
+
+### Fixed
+
+- Include the missing `close_ballot_box` method from the 0.4.0 release.
+- Fixes for the client methods
+
+## [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` methods from the 0.4.0 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.3)
+      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.1.0)
+      activesupport (= 6.1.0)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
@@ -87,9 +88,8 @@ GEM
       rubocop-ast (>= 0.7.1)
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.8)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     webmock (3.10.0)
       addressable (>= 2.3.6)
@@ -97,9 +97,11 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
     wisper (2.0.1)
     wisper-rspec (1.1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   decidim-bulletin_board!
@@ -112,4 +114,4 @@ DEPENDENCIES
   wisper-rspec (~> 1.1.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.0

data/decidim-bulletin_board.gemspec

@@ -23,11 +23,11 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "activemodel", "~> 5.0", ">= 5.0.0.1"
-  s.add_dependency "activesupport", "~> 5.0", ">= 5.0.0.1"
+  s.add_dependency "activemodel", ">= 5.0.0"
+  s.add_dependency "activesupport", ">= 5.0.0"
   s.add_dependency "byebug", "~> 11.0"
   s.add_dependency "graphlient", "~> 0.4.0"
-  s.add_dependency "jwt"
+  s.add_dependency "jwt", "~> 2.2.2"
   s.add_dependency "wisper", "~> 2.0.0"
 
   s.add_development_dependency "rake", "~> 13.0"

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/create_election"
+require "decidim/bulletin_board/authority"
 require "decidim/bulletin_board/voter"
-require "decidim/bulletin_board/authority/get_election_status"
-require "active_support/configurable"
-require "jwt"
 
 module Decidim
   # This module holds all the logic for the Bulletin Board Ruby Client to connect

data/lib/decidim/bulletin_board/authority.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module BulletinBoard
+    module Authority
+      # This class handles the creation of an election.
+      class CreateElection < Decidim::BulletinBoard::Command
+        def initialize(election_id, election_data)
+          @election_id = election_id
+          @election_data = election_data
+        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
+                end
+              end
+            end
+
+            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 :election_data, :election_id
+      end
+    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,36 @@ 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 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 setup_election(election_data)
-        message_id = "#{election_data[:election_id]}.create_election+a.#{authority_slug}"
-        Decidim::BulletinBoard::CreateElection.call(election_data, message_id)
+      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
       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