decidim-bulletin_board 0.12.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 884946225d9b21a4731921b949627e4f1219dd70b1682335c2b16368a8d64634
-  data.tar.gz: ce69b5a1d8c5dba5f3d07d618849be1379dfd3eff2026e617527b98cdfdfd8e5
+  metadata.gz: 07057d8bf5262dbf5929110c87e970abc2d0de0eeaec11174220b83a85f7eb6e
+  data.tar.gz: d721f9561b10f02e7c2291a473a3ff592d6eae6e7767f5032e7c1fcb13e9c570
 SHA512:
-  metadata.gz: d57eac5e421419bddd04193648a9c3755bede99ab110d5c02773fefaa0f8470fff4407643df7b025253ed5e525603a291f54f9adea3d2cf8a7f125bf8720aab4
-  data.tar.gz: c50607ce3bbd367919049fdaa23e02e97798125a14c03bfc08b02d2f884f85f27efb4109610f2515fc396c6c859dfba915af77edd0a2dd7cc97039b98f4a8117
+  metadata.gz: 0faec0781d970b589bb18e0f47f82cbeb9212c6c5c3ffd3b1c28768e71ff0385f4490aae97567299f65dbb326efcb3d57c8926a3efc73953fd6073b35612c523
+  data.tar.gz: d3fdd20acb00f422c1382bf6a081f611c0bc8eac1a5c5e1507b8468b44f7e0de7f2c2c187a10ba16f6214eb7a070f87daf467eec01bce86c58b8ce1b85e1958a

data/.gitignore

@@ -17,5 +17,5 @@
 # byebug history
 .byebug_history
 
-# compiled dev JS client
-/app/assets/javascripts/decidim/bulletin_board/decidim-bulletin_board.dev.js
+# artifacts
+/app/assets/javascripts/decidim/bulletin_board/decidim-bulletin_board.js

data/Gemfile

@@ -6,5 +6,5 @@ source "https://rubygems.org"
 gemspec
 
 gem "rubocop", "~> 0.92.0"
-gem "rubocop-faker"
-gem "rubocop-rspec", "~> 1.21"
+gem "rubocop-faker", "~> 1.1.0"
+gem "rubocop-rspec", "~> 1.44.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decidim-bulletin_board (0.12.0)
+    decidim-bulletin_board (0.15.1)
       byebug (~> 11.0)
       graphlient (~> 0.4.0)
       jwt (~> 2.2.2)
@@ -96,7 +96,7 @@ GEM
       faraday (>= 1.0)
       faraday_middleware
       graphql-client
-    graphql (1.12.5)
+    graphql (1.12.6)
     graphql-client (0.16.0)
       activesupport (>= 3.0)
       graphql (~> 1.8)
@@ -115,16 +115,12 @@ GEM
     mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.5.0)
-    minitest (5.14.3)
+    minitest (5.14.4)
     multipart-post (2.1.1)
-    nio4r (2.5.5)
-    nokogiri (1.11.1)
+    nio4r (2.5.7)
+    nokogiri (1.11.2)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
-    nokogiri (1.11.1-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.11.1-x86_64-linux)
-      racc (~> 1.4)
     parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
@@ -227,8 +223,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.7)
   rubocop (~> 0.92.0)
-  rubocop-faker
-  rubocop-rspec (~> 1.21)
+  rubocop-faker (~> 1.1.0)
+  rubocop-rspec (~> 1.44.1)
   webmock (~> 3.6)
   wisper-rspec (~> 1.1.0)
 

data/decidim-bulletin_board.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
 
   s.summary = ""
   s.description = ""
-  s.homepage = "https://github.com"
+  s.homepage = "https://github.com/decidim/decidim-bulletin-board"
   s.license = "AGPL-3.0"
   s.required_ruby_version = Gem::Requirement.new(">= 2.6.6")
 

data/lib/decidim/bulletin_board.rb

@@ -8,6 +8,7 @@ require "graphlient"
 require "wisper"
 
 require "decidim/bulletin_board/client"
+require "decidim/bulletin_board/file_client"
 require "decidim/bulletin_board/engine"
 require "decidim/bulletin_board/jwk_utils"
 require "decidim/bulletin_board/message_identifier"

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

@@ -69,16 +69,16 @@ module Decidim
 
         def bulletin_board
           {
-            name: "bulletin-board",
-            pretty_name: "Bulletin Board",
+            slug: "bulletin-board",
+            name: "Bulletin Board",
             public_key: settings.bulletin_board_public_key
           }
         end
 
         def authority
           {
-            name: settings.authority_slug,
-            pretty_name: settings.authority_name,
+            slug: settings.authority_slug,
+            name: settings.authority_name,
             public_key: settings.authority_public_key
           }
         end
@@ -86,22 +86,22 @@ module Decidim
         def trustees
           election_data[:trustees].map do |trustee|
             {
-              name: trustee[:slug],
-              pretty_name: trustee[:name],
+              slug: trustee[:name].parameterize,
+              name: trustee[:name],
               public_key: trustee[:public_key]
             }
           end
         end
 
         def contests
-          election_data[:questions].map do |question|
+          election_data[:questions].each_with_index.map do |question, index|
             {
               "@type": "CandidateContest",
               object_id: question[:slug],
-              sequence_order: question[:weight],
+              sequence_order: index,
               vote_variation: question[:max_selections] == 1 ? "one_of_m" : "n_of_m",
               name: default_text(question[:title]),
-              number_elected: question[:answers].count,
+              number_elected: question[:max_selections],
               ballot_title: text(question[:title]),
               ballot_subtitle: text(question[:description]),
               ballot_selections: contest_answers(question)
@@ -110,10 +110,10 @@ module Decidim
         end
 
         def contest_answers(question)
-          question[:answers].map do |answer|
+          question[:answers].each_with_index.map do |answer, index|
             {
               object_id: "#{question[:slug]}_#{answer[:slug]}",
-              sequence_order: answer[:weight],
+              sequence_order: index,
               candidate_id: answer[:slug]
             }
           end

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

@@ -33,7 +33,7 @@ module Decidim
           response = graphql.query do
             mutation do
               publishResults(messageId: args[:message_id], signedData: args[:signed_data]) do
-                election do
+                pendingMessage do
                   status
                 end
                 error
@@ -43,7 +43,7 @@ module Decidim
 
           return broadcast(:error, response.data.publish_results.error) if response.data.publish_results.error.present?
 
-          broadcast(:ok, response.data.publish_results.election)
+          broadcast(:ok, response.data.publish_results.pending_message)
         rescue Graphlient::Errors::ServerError
           broadcast(:error, "Sorry, something went wrong")
         end

data/lib/decidim/bulletin_board/client.rb

@@ -101,7 +101,7 @@ module Decidim
       def publish_results(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(:ok) { |pending_message| return pending_message }
         publish_results.on(:error) { |error_message| raise StandardError, error_message }
         publish_results.call
       end

data/lib/decidim/bulletin_board/file_client.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module BulletinBoard
+    # Client to store GraphQL requests to a CSV file instead of sending them to the BulletinBoard
+    # It is intended to be used for load testing
+    class FileClient < Decidim::BulletinBoard::Client
+      def initialize(file_path, config = Decidim::BulletinBoard)
+        @settings = Settings.new(config)
+        @graphql = Graphql::Factory.client_for_file(settings, file_path)
+      end
+    end
+  end
+end

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

@@ -310,6 +310,34 @@
               },
               "isDeprecated": false,
               "deprecationReason": null
+            },
+            {
+              "name": "verifiableResultsHash",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "verifiableResultsUrl",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
             }
           ],
           "inputFields": null,
@@ -442,13 +470,9 @@
 
               ],
               "type": {
-                "kind": "NON_NULL",
-                "name": null,
-                "ofType": {
-                  "kind": "SCALAR",
-                  "name": "JSON",
-                  "ofType": null
-                }
+                "kind": "SCALAR",
+                "name": "JSON",
+                "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null
@@ -1232,28 +1256,28 @@
           "description": "Autogenerated return type of PublishResultsMutation",
           "fields": [
             {
-              "name": "election",
+              "name": "error",
               "description": null,
               "args": [
 
               ],
               "type": {
-                "kind": "OBJECT",
-                "name": "Election",
+                "kind": "SCALAR",
+                "name": "String",
                 "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null
             },
             {
-              "name": "error",
+              "name": "pendingMessage",
               "description": null,
               "args": [
 
               ],
               "type": {
-                "kind": "SCALAR",
-                "name": "String",
+                "kind": "OBJECT",
+                "name": "PendingMessage",
                 "ofType": null
               },
               "isDeprecated": false,

data/lib/decidim/bulletin_board/graphql/factory.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "decidim/bulletin_board/graphql/file_adapter"
+
 module Decidim
   module BulletinBoard
     module Graphql
@@ -12,6 +14,15 @@ module Decidim
                                    "Authorization" => settings.authority_api_key
                                  })
         end
+
+        def self.client_for_file(settings, file_path)
+          Graphlient::Client.new(file_path,
+                                 schema_path: File.join(__dir__, "bb_schema.json"),
+                                 http: FileAdapter,
+                                 headers: {
+                                   "Authorization" => settings.authority_api_key
+                                 })
+        end
       end
     end
   end

data/lib/decidim/bulletin_board/graphql/file_adapter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Decidim
+  module BulletinBoard
+    module Graphql
+      class FileAdapter
+        attr_reader :file_name
+
+        def initialize(file_name, _options = {}, &_block)
+          @file_name = file_name
+        end
+
+        def execute(document:, operation_name: nil, variables: {}, context: {})
+          body = {}
+          body["query"] = document.to_query_string
+          body["variables"] = variables if variables.any?
+          body["operationName"] = operation_name if operation_name
+
+          CSV.open(file_name, "a+", col_sep: ";") do |csv|
+            csv << [JSON.generate(body), context[:headers]["Authorization"]]
+          end
+
+          { "data" => { "vote" => {} } }
+        end
+      end
+    end
+  end
+end

data/lib/decidim/bulletin_board/message_identifier.rb

@@ -60,6 +60,10 @@ module Decidim
         @message_id
       end
 
+      def unique_trustee_id(authority_slug, trustee_name)
+        "#{authority_slug}.#{trustee_name}"
+      end
+
       class << self
         def format(unique_election_id, type_subtype, author_type, author_id)
           "#{unique_election_id}.#{type_subtype}+#{INVERTED_AUTHOR_TYPE[author_type]}.#{author_id}"

data/lib/decidim/bulletin_board/version.rb

@@ -2,6 +2,6 @@
 
 module Decidim
   module BulletinBoard
-    VERSION = "0.12.0"
+    VERSION = "0.15.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-bulletin_board
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.15.1
 platform: ruby
 authors:
 - David Morcillo
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-19 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -154,16 +154,12 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - app/assets/config/manifest.js
-- app/assets/javascripts/decidim/bulletin_board/decidim-bulletin_board.js
 - bin/console
-- bin/release
 - bin/setup
 - decidim-bulletin_board.gemspec
 - lib/decidim/bulletin_board.rb
@@ -178,15 +174,17 @@ files:
 - lib/decidim/bulletin_board/client.rb
 - lib/decidim/bulletin_board/command.rb
 - lib/decidim/bulletin_board/engine.rb
+- lib/decidim/bulletin_board/file_client.rb
 - lib/decidim/bulletin_board/graphql/bb_schema.json
 - lib/decidim/bulletin_board/graphql/factory.rb
+- lib/decidim/bulletin_board/graphql/file_adapter.rb
 - lib/decidim/bulletin_board/jwk_utils.rb
 - lib/decidim/bulletin_board/message_identifier.rb
 - lib/decidim/bulletin_board/settings.rb
 - lib/decidim/bulletin_board/version.rb
 - lib/decidim/bulletin_board/voter/cast_vote.rb
 - lib/decidim/bulletin_board/voter/get_pending_message_status.rb
-homepage: https://github.com
+homepage: https://github.com/decidim/decidim-bulletin-board
 licenses:
 - AGPL-3.0
 metadata: {}

data/CHANGELOG.md

@@ -1,222 +0,0 @@
-# Changelog
-
-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.12.0] - 2021-02-19
-
-### Added
-
-- The `Voter` returns the ballot hash after encrpyting the plain vote and before auditing or casting it
-
-### Changed
-
-- The `create_election` command now expects objects representing the parts public keys.
-
-## [0.11.0] - 2021-02-18
-
-### Changed
-
-- Changed the name of some settings\* to improve the readability of the code:
-  - BB settings: `bulletin_board_server`\* and `bulletin_board_public_key`\*.
-  - Authority settings: `authority_api_key`\*, `authority_name` and `authority_private_key`\*.
-  - Elections settings: `scheme_name`, `number_of_trustees` and `quorum`.
-- `KeyCeremonyComponent` and `TallyComponent` now accepts a `trusteeWrapperAdapter` object.
-- The `processMessage` method from the `TrusteeWrapperAdapter` now accepts a `messageType` instead of a `messageIdentifier`.
-
-### Removed
-
-- The `TrusteeWrapper` for the "dummy" voting scheme has been removed from the project.
-
-### Added
-
-- The `TrusteeWrapperAdapter` abstract class can be used to implement any voting scheme wrapper adapter.
-
-## [0.10.1] - 2021-02-15
-
-### Fixed
-
-- The `TallyComponent` now uses the `key_ceremony` messages as well.
-
-## [0.10.0] - 2021-02-12
-
-## Added
-
-- A command to get decoded election results.
-- The (Bulletin Board) server public key is now included in the gem configuration.
-- The option to `audit` a vote.
-
-## Changed
-
-- The `get_election_log_entries_by_type` command got renamed to `get_election_results`.
-- The `create_election` command now receives all the information needed in a simple hash and builds the message to add to the election log. It only needs seven main keys: `trustees`, `default_locale`, `title`, `start_date`, `end_date`, `questions` and `answers`.
-- The `scheme` setting was replaced by the `scheme_name` and `quorum` settings.
-
-## [0.9.2] - 2021-02-02
-
-## [0.9.1] - 2021-02-02
-
-## Added
-
-- The `VoteComponent` has been added. It will be used as a glue code between the vote and the UI.
-- The ruby client now includes the `get_election_log_entries_by_types` method to get the election log entries filtered by type.
-
-## [0.9.0] - 2021-02-01
-
-## Changed
-
-- The `open_ballot_box` and `close_ballot_box` are now called `start_vote` and `end_vote` and return a pending message.
-- All the client operations yield the `message_id` before sending the request to the Bulletin Board.
-
-## Added
-
-- `start_key_ceremony` method to the `Decidim::BulletinBoard::Client`.
-- The `IdentificationKeys` class has been added to the JS library.
-- The `TallyComponent` has been added. It will be used as a glue code between the tally and the UI.
-
-## [0.8.2] - 2021-01-28
-
-## Changed
-
-- `encrypt` in `VoterWrapperDummy` has a TimeOut of 500ms.
-
-## [0.8.0] - 2021-01-27
-
-## Changed
-
-- `getPendingMessage` can get queried by `messageId` and by `id`.
-- `get_status` renamed to `get_election_status` in the `Decidim::BulletinBoard::Client`.
-
-## Added
-
-- `getPendingMessageStatus` method to the `Decidim::BulletinBoard::Client`.
-- `waitForPendingMessageToBeProcessed` method to the Voter class.
-- The `KeyCeremonyComponent` has been added. It will be used as a glue code between the key ceremony process and the UI.
-
-## [0.7.0] - 2021-01-26
-
-## Changed
-
-- The `Trustee` class now uses the `Election` class to interact with the log entries.
-- The `Trustee` class handles everything now when performing both the key ceremony and the tally process.
-- The `Trustee` class now includes a `setupKeyCeremony` generator function that must be called before starting the key ceremony process.
-- `checkRestoreNeeded` method has been renamed to `needsToBeRestored` for both the `Trustee` and the `TrusteeWrapper`.
-
-## Added
-
-- `start_tally` method to the `Decidim::BulletinBoard::Client`.
-- `publish_results` method to the `Decidim::BulletinBoard::Client`.
-- `Election` class in the JS package to handle the election state. An instance of this class will be used by the key ceremony and the trustee to check anything related to log entries.
-- The `Trustee` class now has a `teardown` method that is called automatically to clean a few things. It can be called early to avoid memory leaks if needed.
-- The `EventManager` class now handles the `events` stream and exports some useful constants.
-
-## Removed
-
-- The `KeyCeremony` class has been removed.
-- The `Trustee` backup method has been removed because it doesn't belong to the public API anymore.
-
-## [0.6.1] - 2021-01-12
-
-### Changed
-
-- Production file now is called `decidim-bulletin_board.js` and development file is called `decidim-bulletin_board.dev.js`.
-
-### Removed
-
-- The GraphQL client doesn't use subscriptions anymore.
-
-## [0.6.0] - 2021-01-12
-
-### Changed
-
-- Updated the app schema definition with the partial log entries list retrieval
-- Gem is an engine, the js assets can be imported in Decidim.
-
-## [0.5.3] - 2020-12-20
-
-### Fixed
-
-- Fix the schema definition folder when used inside an app
-
-## [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
-
-### Fixed
-
-- Uses the correct private key in the `sign_data` method.
-
-## [0.3.0] - 2020-12-10
-
-### Added
-
-- `Decidim::BulletinBoard::Authority` namespace that includes commands and forms to get the status of an election.
-
-### Changed
-
-- `Decidim::BulletinBoard::Client` now includes a `get_status` method to get the election status using the `Authority` namespace.
-
-### Fixed
-
-- `Decidim::BulletinBoard::Voter::CastVote` command uses the `encrypted_vote` as a `String` and not as a `Hash`.
-
-## [0.2.0] - 2020-12-08
-
-### Added
-
-- `Decidim::BulletinBoard::Voter` namespace that includes commands and forms to perform the cast vote action.
-
-### Changed
-
-- `Decidim::BulletinBoard::Client` now includes a `cast_vote` method to cast a vote using the `Voter` namespace.
-
-## [0.1.0] - 2020-12-07
-
-### Added
-
-- `Decidim::BulletinBoard::Client` class totally configurable using `ActiveSupport::Configurable`
-- The client now includes a `setup_election` method that creates the election in the bulletin board.
-
-[unreleased]: https://github.com/decidim/decidim-bulletin-board/compare/v0.3.0...HEAD
-[0.3.0]: https://github.com/decidim/decidim-bulletin-board/compare/v0.2.0...v0.3.0
-[0.2.0]: https://github.com/decidim/decidim-bulletin-board/compare/v0.1.0...v0.2.0
-[0.1.0]: https://github.com/decidim/decidim-bulletin-board/releases/tag/v0.1.0