electionbuddy-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4d7bab3a1ccbb73ba611b3f24efe2cb30f46f8971fbdfcc9f7199d4cd90a5d1
-  data.tar.gz: f7ad3cf9058cf3e87e8b270223b593e8a3a3703a34d0a72f8441ac6a6a1111e1
+  metadata.gz: 609fbcd8ec13547ffc65048afb495236d9eecbe0a787bea74bee39315b3e92c1
+  data.tar.gz: 35682f5a36ea65fe229f9239cf14335b132e6ef94e7befc79d9e601338262e81
 SHA512:
-  metadata.gz: fd1e47298c9ede0a03d6e2ff07be9118d7f41ccfacb1acf1635d55e06ddd63ea7309fa965fac97a5dc2ea1b8e20d0eed20714af0761390197d2389661456a734
-  data.tar.gz: 61e1aac0c642c65f791f4b1f93f7602cc3e34c4c94f3a5d4875e223b483703dc56521a5961199d5675123d5c93b16110107d64a89eed38c93d133c7c221f3ca0
+  metadata.gz: 7cbf3bc35b59210fcf1a8a0e906dafa5112ea801568edc5aee762019edc3dcdc49936087e7c58613657b3d732af42400ea735da644f717e38d89a2e1eb8b074b
+  data.tar.gz: 7fadf9a933f95c94b949dbec9533bf6c775cc25c16252e30f80d3895ab7c49408e29d01518e034d9d71148e6e258634ce01df6f7d4710625d21cfee4ff9ba431

data/.rubocop.yml

@@ -6,3 +6,13 @@ Style/StringLiterals:
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/electionbuddy-ruby.rb'
+
+Metrics/MethodLength:
+  Max: 15

data/CHANGELOG.md

@@ -1,5 +1,35 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## [Unreleased]
 
 ## [0.1.0] - 2024-10-29
 
 - Initial release
+
+## [0.2.0] - 2024-11-07
+
+### Added
+
+- Faraday as a runtime dependency
+- Debug as a development dependency
+- API call framework: resource-oriented design to structure and support API calls
+- Ability to validate the voter list of a given vote
+
+### Changed
+
+- Update README.md with usage instructions
+- Update .rubocop.yml with new rules
+
+### Fixed
+
+- Fix console startup issue caused by incorrect code reference
+
+[unreleased]: https://github.com/electionbuddy/electionbuddy-ruby/compare/v0.2.0...HEAD
+[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

@@ -1,24 +1,60 @@
-# Electionbuddy::Ruby
+# ElectionBuddy Ruby
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/electionbuddy/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Ruby client for interacting with the ElectionBuddy API.
+You can find the API documentation [here](https://api.electionbuddy.com).
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+Install the gem and add it to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    bundle add electionbuddy-ruby
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    gem install electionbuddy-ruby
+
+Alternatively, add the gem to the Gemfile:
+
+```ruby
+gem 'electionbuddy-ruby'
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Ensure you have an API key from Electionbuddy, and initialize the client as follows:
+
+```ruby
+client = ElectionBuddy::Client.new('your-api-key')
+```
+
+### Voter List Validation
+
+To validate a voter list, use the `voter_list.validate(vote_id)` method:
+
+```ruby
+validation = client.voter_list.validate(1)
+
+if validation.done?
+  puts "Validation completed successfully! Identifier: #{validation.identifier}"
+  # "Validation completed successfully! Identifier: ae0a1724-9791-4bb2-8331-6d4e55a9b7c8"
+else
+  puts "Validation failed: #{validation.error}"
+  # "Validation failed: Vote: not found"
+end
+```
+
+### Possible Errors
+
+The following errors may be raised by the API:
+
+- **400**: Malformed request.
+- **401**: Invalid authentication credentials.
+- **403**: Unauthorized.
+- **404**: Resource not found.
+- **429**: Your request exceeded the API rate limit.
+- **500**: We were unable to perform the request due to server-side problems.
+
+Each error will raise an `Error` exception with a message detailing the status code and the error message returned by the API.
 
 ## Development
 
@@ -28,7 +64,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/electionbuddy-ruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/electionbuddy/electionbuddy-ruby.
 
 ## License
 

data/lib/election_buddy/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ElectionBuddy
+  class Client
+    BASE_URL = "https://secure.electionbuddy.com/api/v2"
+
+    def initialize(api_key, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+      @stubs = stubs
+    end
+
+    def voter_list
+      VoterListResource.new(connection)
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.headers["authorization"] = @api_key
+        conn.request :json
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter @adapter, @stubs
+      end
+    end
+  end
+end

data/lib/election_buddy/entities/validation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ElectionBuddy
+  class Validation
+    def initialize(response)
+      @response = response
+    end
+
+    def identifier
+      @response["validation_identifier"] || "Not available"
+    end
+
+    def done?
+      @response["error"].nil?
+    end
+
+    def error
+      return nil if done?
+
+      ErrorFormatter.format(@response["error"])
+    end
+  end
+end

data/lib/election_buddy/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ElectionBuddy
+  class Error < StandardError
+  end
+end

data/lib/election_buddy/error_formatter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ElectionBuddy
+  class ErrorFormatter
+    def self.format(error_hash)
+      return if error_hash.nil? || error_hash.empty?
+
+      error_hash.map do |key, value|
+        formatted_key = key.gsub("_", " ").split.map(&:capitalize).join(" ")
+        formatted_value = value.is_a?(Array) ? value.join(", ") : value
+        "#{formatted_key}: #{formatted_value}"
+      end.join(", ")
+    end
+  end
+end

data/lib/election_buddy/resource.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ElectionBuddy
+  class Resource
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get_request(url, params = {}, headers = {}, &block)
+      handle_response(@connection.get(url, params, headers, &block))
+    end
+
+    def post_request(url, body = {}, headers = {}, &block)
+      handle_response(@connection.post(url, body, headers, &block))
+    end
+
+    private
+
+    def handle_response(response)
+      return response.body if response.success? || response.status == 422
+
+      raise_error(response.status, ErrorFormatter.format(response.body))
+    end
+
+    def raise_error(status, formatted_error)
+      base_message = error_messages(status)
+      message = if formatted_error
+                  "Error #{status}: #{base_message} - #{formatted_error}."
+                else
+                  "Error #{status}: #{base_message}."
+                end
+
+      raise Error, message
+    end
+
+    def error_messages(status)
+      messages = {
+        400 => "Malformed request",
+        401 => "Invalid authentication credentials",
+        403 => "Unauthorized",
+        404 => "Resource not found",
+        429 => "Your request exceeded the API rate limit",
+        500 => "We were unable to perform the request due to server-side problems"
+      }
+      messages.fetch(status, "Unexpected status code.")
+    end
+  end
+end

data/lib/election_buddy/resources/voter_list_resource.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ElectionBuddy
+  class VoterListResource < Resource
+    def validate(vote_id)
+      response = post_request("/api/v2/votes/voters/validations", vote_id: vote_id.to_i)
+
+      Validation.new(response)
+    end
+  end
+end

data/lib/election_buddy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ElectionBuddy
+  VERSION = "0.2.0"
+end

data/lib/election_buddy.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/middleware"
+require "json"
+
+require "election_buddy/version"
+require "election_buddy/client"
+require "election_buddy/error"
+require "election_buddy/resource"
+require "election_buddy/resources/voter_list_resource"
+require "election_buddy/entities/validation"
+require "election_buddy/error_formatter"
+
+module ElectionBuddy
+end

data/lib/electionbuddy-ruby.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "election_buddy"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: electionbuddy-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alberto Rocha
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-29 00:00:00.000000000 Z
-dependencies: []
+date: 2024-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
 description: This gem provides a Ruby SDK for easy interaction with the ElectionBuddy
   API
 email:
@@ -25,8 +39,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/electionbuddy/ruby.rb
-- lib/electionbuddy/ruby/version.rb
+- lib/election_buddy.rb
+- lib/election_buddy/client.rb
+- lib/election_buddy/entities/validation.rb
+- lib/election_buddy/error.rb
+- lib/election_buddy/error_formatter.rb
+- lib/election_buddy/resource.rb
+- lib/election_buddy/resources/voter_list_resource.rb
+- lib/election_buddy/version.rb
+- lib/electionbuddy-ruby.rb
 - sig/electionbuddy/ruby.rbs
 homepage: https://github.com/electionbuddy/electionbuddy-ruby
 licenses:

data/lib/electionbuddy/ruby/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Electionbuddy
-  module Ruby
-    VERSION = "0.1.0"
-  end
-end

data/lib/electionbuddy/ruby.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "ruby/version"
-
-module Electionbuddy
-  module Ruby
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end