decidim-bulletin_board 0.13.0 → 0.16.0

data/decidim-bulletin_board.gemspec

@@ -10,19 +10,22 @@ 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")
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   s.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`
+      .split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+      .concat(["app/assets/javascripts/decidim/bulletin_board/decidim-bulletin_board.js"])
   end
   s.bindir = "exe"
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency "mimemagic", "~> 0.3.7"
   s.add_dependency "rails", ">= 5.0.0"
 
   s.add_dependency "byebug", "~> 11.0"

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

@@ -14,6 +14,7 @@ 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"
+require "decidim/bulletin_board/test/reset_test_database"
 
 module Decidim
   module BulletinBoard
@@ -101,11 +102,20 @@ 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
 
+      if Rails.env.test?
+        def reset_test_database
+          reset_test_database = configure Test::ResetTestDatabase.new
+          reset_test_database.on(:ok) { |result| return result }
+          reset_test_database.on(:error) { |error_message| raise StandardError, error_message }
+          reset_test_database.call
+        end
+      end
+
       private
 
       attr_reader :settings, :graphql

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,
@@ -370,6 +398,16 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "SCALAR",
+          "name": "Int",
+          "description": "Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.",
+          "fields": null,
+          "inputFields": null,
+          "interfaces": null,
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "SCALAR",
           "name": "JSON",
@@ -442,13 +480,9 @@
 
               ],
               "type": {
-                "kind": "NON_NULL",
-                "name": null,
-                "ofType": {
-                  "kind": "SCALAR",
-                  "name": "JSON",
-                  "ofType": null
-                }
+                "kind": "SCALAR",
+                "name": "JSON",
+                "ofType": null
               },
               "isDeprecated": false,
               "deprecationReason": null
@@ -851,6 +885,20 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "resetTestDatabase",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "OBJECT",
+                "name": "ResetTestDatabaseMutationPayload",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "startKeyCeremony",
               "description": null,
@@ -1232,28 +1280,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,
@@ -1451,6 +1499,37 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "OBJECT",
+          "name": "ResetTestDatabaseMutationPayload",
+          "description": "Autogenerated return type of ResetTestDatabaseMutation",
+          "fields": [
+            {
+              "name": "timestamp",
+              "description": null,
+              "args": [
+
+              ],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "Int",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [
+
+          ],
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "OBJECT",
           "name": "StartKeyCeremonyMutationPayload",

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/test/reset_test_database.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module BulletinBoard
+    module Test
+      # This command uses the GraphQL client to clear the database in test mode.
+      class ResetTestDatabase < Decidim::BulletinBoard::Command
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid and the mutation operation is successful.
+        # - :error if query operation was not successful.
+        #
+        # Returns nothing.
+        def call
+          graphql.query do
+            mutation do
+              resetTestDatabase do
+                timestamp
+              end
+            end
+          end
+
+          broadcast(:ok)
+        rescue Graphlient::Errors::ServerError
+          broadcast(:error, "Sorry, something went wrong")
+        end
+      end
+    end
+  end
+end

data/lib/decidim/bulletin_board/version.rb

@@ -2,6 +2,6 @@
 
 module Decidim
   module BulletinBoard
-    VERSION = "0.13.0"
+    VERSION = "0.16.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-bulletin_board
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.16.0
 platform: ruby
 authors:
 - David Morcillo
@@ -11,8 +11,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -154,8 +168,6 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -163,7 +175,6 @@ files:
 - 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 +189,18 @@ 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/test/reset_test_database.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: {}