decidim-bulletin_board 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32b8c4fc3efdcc66c1d25c784627d955c52c2a3343fd0d1c6863ae89082e6a91
-  data.tar.gz: da628db5ef6520f1958691654a91105cc0eda053ee58a25cfd4f5b4f927d791c
+  metadata.gz: a3d1e27c207aed87322d6be72c10f4cdec8abcad317b1b0f500911d1a1a2db6e
+  data.tar.gz: d60a4887bb883c3f4da0f0100cf1b8e19e37bf14c26326288c5d4b63ff417f1e
 SHA512:
-  metadata.gz: 846a287aa3d3b31fd177ae29eaa9ff3b2de65b5f9507ed85c30f6c8cba45e1cfbf6f72a4bb3cb4b870f07af2ccf86f18bbfa782e247f2d3934794ff776297b96
-  data.tar.gz: c28b71b323024e6f92846b6bcb345bf07712a6ed2970ba17684fcb8b970785aea3230f2d039d8dbf10e5ca9c07a6945b57b980c78a9ca192a33a23f4151ec943
+  metadata.gz: c69fc5b2a6a410969c72936d030bf8d87184b1a52d2145da348d4b5288cabf51df7edd877317f42555781481b0fe7107da3df89033ef53915dc4ec38db9f2977
+  data.tar.gz: 83383e33224e36288e9d25d645a71624375274104a80e59eb1b082ad7cfcd679c283fadcb8d4ab0e6f973821a161006d837c92f73817bf0ab900fa90cef1744d

data/Gemfile.lock

@@ -1,15 +1,19 @@
 PATH
   remote: .
   specs:
-    decidim-bulletin_board (0.1.0)
+    decidim-bulletin_board (0.2.0)
+      activemodel (~> 5.0, >= 5.0.0.1)
       activesupport (~> 5.0, >= 5.0.0.1)
       byebug (~> 11.0)
       graphlient (~> 0.4.0)
       jwt
+      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)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
@@ -91,6 +95,8 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    wisper (2.0.1)
+    wisper-rspec (1.1.0)
 
 PLATFORMS
   ruby
@@ -103,6 +109,7 @@ DEPENDENCIES
   rubocop-faker
   rubocop-rspec (~> 1.21)
   webmock (~> 3.6)
+  wisper-rspec (~> 1.1.0)
 
 BUNDLED WITH
    2.1.4

data/decidim-bulletin_board.gemspec

@@ -23,12 +23,15 @@ 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 "byebug", "~> 11.0"
   s.add_dependency "graphlient", "~> 0.4.0"
   s.add_dependency "jwt"
+  s.add_dependency "wisper", "~> 2.0.0"
 
   s.add_development_dependency "rake", "~> 13.0"
   s.add_development_dependency "rspec", "~> 3.7"
   s.add_development_dependency "webmock", "~> 3.6"
+  s.add_development_dependency "wisper-rspec", "~> 1.1.0"
 end

data/lib/decidim/bulletin_board.rb

@@ -2,10 +2,13 @@
 
 require "decidim/bulletin_board/version"
 require "graphlient"
+require "wisper"
+require "active_model"
 require "decidim/bulletin_board/jwk_utils"
 require "decidim/bulletin_board/client"
 require "decidim/bulletin_board/graphql/client"
 require "decidim/bulletin_board/create_election"
+require "decidim/bulletin_board/voter"
 require "active_support/configurable"
 require "jwt"
 

data/lib/decidim/bulletin_board/client.rb

@@ -34,11 +34,23 @@ module Decidim
         private_key && server && api_key
       end
 
+      def sign_data(data)
+        JWT.encode(data, identification_private_key.keypair, "RS256")
+      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)
       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)
+        cast_vote.on(:ok) { |pending_message| return pending_message }
+        cast_vote.on(:error) { |error_message| raise StandardError, error_message }
+        cast_vote.call
+      end
+
       private
 
       attr_reader :identification_private_key, :private_key

data/lib/decidim/bulletin_board/version.rb

@@ -2,6 +2,6 @@
 
 module Decidim
   module BulletinBoard
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/decidim/bulletin_board/voter.rb

@@ -0,0 +1,4 @@
+# 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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Decidim
+  module BulletinBoard
+    module Voter
+      # This command uses the GraphQL client to cast the vote.
+      class CastVote
+        include Wisper::Publisher
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid and the mutation operation is successful.
+        # - :error if the form wasn't valid or the mutation operation was not successful.
+        #
+        # 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
+          }
+
+          begin
+            response = client.query do
+              mutation do
+                vote(messageId: args[:message_id], signedData: args[:signed_data]) do
+                  pendingMessage do
+                    status
+                  end
+                  error
+                end
+              end
+            end
+
+            return broadcast(:error, response.data.vote.error) if response.data.vote.error.present?
+
+            broadcast(:ok, response.data.vote.pending_message)
+          rescue Graphlient::Errors::FaradayServerError
+            broadcast(:error, "something went wrong")
+          end
+        end
+
+        private
+
+        attr_reader :form
+
+        def client
+          @client ||= BulletinBoard::Graphql::Client.client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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 `message_id`.
+        def signed_data
+          @signed_data ||= bulletin_board_client.sign_data(encrypted_vote.merge(message_id: message_id))
+        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
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-bulletin_board
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Morcillo
@@ -9,8 +9,28 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2020-12-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +93,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +149,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: wisper-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: ''
 email:
 - david@codegram.com
@@ -142,6 +190,9 @@ files:
 - lib/decidim/bulletin_board/graphql/client.rb
 - lib/decidim/bulletin_board/jwk_utils.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