electionbuddy-ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05e63dbc220f5455343b5a43e4a2fa3754c377f7cb56aceb133acddf3a09fe84
-  data.tar.gz: 57afed7e7acaaf77e7ba70a7afae1d1efd56e058d403bf5eed9904d7e546d1d2
+  metadata.gz: 64c0f48e8da4cd5811d86506d945b853e4e284afd8a8041878d680bf46117d4d
+  data.tar.gz: b635df1e9e3f7f013c769818e2722f6224de5cea279bd5ad36364a80c6d9d15b
 SHA512:
-  metadata.gz: 39d9ac1b3891a72787f0c2a80603d2e824e769109c04f977f9a7ef810bd78a34c0dd4403356d7658b67db80462297e59f8040df8f9ee10e4f96658c6f65f8b7c
-  data.tar.gz: b6f5c57a45c8075f25c515efeddf23825db14d8c694bf4fa9b6f70b919501d66bd4dffa9639cc940a0a809a8d0739febdd83f06b378e0247591fc9e844ab95fc
+  metadata.gz: b0dc2ca445cb784a1d72b27c6bcd4a5f0221ea50ca87e577dd301e0603189a11623eb85f9d794005350486efd82ce62bdb40d1492afe5ef536cde58a39fdb060
+  data.tar.gz: 4438b38fefa9ebaf8d22d7b57bc71272042bf89eda5dfe459fe29d647fd1c7d0d6141e31c5befe25e7267c5010cf5fad67b7f8ab729ef067b155b68ceed07fea

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2024-11-20
+
+### Added
+
+- Ability to import voters to a vote
+- Automated gem release using GitHub Actions
+
 ## [0.3.0] - 2024-11-18
 
 ### Added
@@ -47,7 +54,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[unreleased]: https://github.com/electionbuddy/electionbuddy-ruby/compare/v0.3.0...HEAD
+[unreleased]: https://github.com/electionbuddy/electionbuddy-ruby/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/electionbuddy/electionbuddy-ruby/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/electionbuddy/electionbuddy-ruby/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/electionbuddy/electionbuddy-ruby/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/electionbuddy/electionbuddy-ruby/releases/tag/v0.1.0

data/README.md

@@ -49,6 +49,27 @@ Alternatively, you can still pass the API key directly during initialization. If
 client = ElectionBuddy::Client.new(api_key: 'your-api-key')
 ```
 
+### Voter List Importation
+
+To import a voter list for an election, use the `voter_list.import(vote_id, voters, append_mode: false)` method:
+
+```ruby
+voters = [
+  { email: 'voter1@example.com', label: 'Voter One' },
+  { email: 'voter2@example.com', label: 'Voter Two' }
+]
+
+import = client.voter_list.import(1, voters, append_mode: false)
+
+if import.done?
+  puts "Import completed successfully! Identifier: #{import.identifier}"
+else
+  puts "Import failed: #{import.error}"
+end
+```
+
+The `append_mode` parameter determines whether the voters should be appended to the existing list (`true`) or replace the existing list (`false`). The default value is `false`.
+
 ### Voter List Validation
 
 To validate a voter list, use the `voter_list.validate(vote_id)` method:

data/lib/election_buddy/entities/importation.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ElectionBuddy
+  # Represents an importation operation for voter lists
+  #
+  # @example
+  #   importation = Importation.new(response)
+  #   if importation.done?
+  #     puts "Import successful: #{importation.identifier}"
+  #   else
+  #     puts "Import failed: #{importation.error}"
+  #   end
+  #
+  class Importation
+    # @param response [Hash] The API response containing importation details
+    def initialize(response)
+      @response = response
+    end
+
+    # Returns the identifier for this importation
+    #
+    # @return [String] The importation identifier or "Not Available"
+    def identifier
+      @response["importation_identifier"] || "Not Available"
+    end
+
+    # Checks if the importation completed successfully
+    #
+    # @return [Boolean] true if importation was successful, false otherwise
+    def done?
+      @response["error"].nil?
+    end
+
+    # Returns the error message if importation failed
+    #
+    # @return [String, nil] The formatted error message or nil if importation was successful
+    def error
+      return nil if done?
+
+      ErrorFormatter.format(@response["error"])
+    end
+  end
+end

data/lib/election_buddy/resources/voter_list_resource.rb

@@ -9,6 +9,18 @@ module ElectionBuddy
   #   result = resource.get_validation_result(validation.identifier)
   #
   class VoterListResource < Resource
+    # Imports voters for a given vote
+    #
+    # @param vote_id [Integer] The ID of the vote to import voters for
+    # @param voters [Array<Hash>] Array of voter data to import
+    # @param append_mode [Boolean] Whether to append voters to existing list (default: false)
+    # @return [Importation] The importation response
+    def import(vote_id, voters, append_mode: false)
+      response = post_request("/api/v2/votes/voters/importations", vote_id: vote_id.to_i, voters: voters, append_mode: append_mode)
+
+      Importation.new(response)
+    end
+
     # Initiates a validation for a given vote
     #
     # @param vote_id [Integer] The ID of the vote to validate

data/lib/election_buddy/version.rb

@@ -6,6 +6,6 @@ module ElectionBuddy
   # @api public
   # @return [String] the current version of the gem
   # @example Get current version
-  #   ElectionBuddy::VERSION #=> "0.3.0"
-  VERSION = "0.3.0"
+  #   ElectionBuddy::VERSION #=> "0.4.0"
+  VERSION = "0.4.0"
 end

data/lib/election_buddy.rb

@@ -10,6 +10,7 @@ require "election_buddy/error"
 require "election_buddy/resource"
 require "election_buddy/resources/voter_list_resource"
 require "election_buddy/entities/validation"
+require "election_buddy/entities/importation"
 require "election_buddy/error_formatter"
 require "election_buddy/configuration"
 require "election_buddy/entities/validation/result"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: electionbuddy-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alberto Rocha
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-18 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -43,6 +43,7 @@ files:
 - lib/election_buddy.rb
 - lib/election_buddy/client.rb
 - lib/election_buddy/configuration.rb
+- lib/election_buddy/entities/importation.rb
 - lib/election_buddy/entities/validation.rb
 - lib/election_buddy/entities/validation/line_error.rb
 - lib/election_buddy/entities/validation/line_errors.rb
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for the ElectionBuddy API.