Module: ElectionBuddy

Defined in:

lib/election_buddy.rb,
lib/election_buddy/error.rb,
lib/election_buddy/client.rb,
lib/election_buddy/version.rb,
lib/election_buddy/resource.rb,
lib/election_buddy/configuration.rb,
lib/election_buddy/error_formatter.rb,
lib/election_buddy/entities/validation.rb,
lib/election_buddy/entities/importation.rb,
lib/election_buddy/entities/validation/result.rb,
lib/election_buddy/resources/voter_list_resource.rb,
lib/election_buddy/entities/validation/line_error.rb,
lib/election_buddy/entities/validation/list_error.rb,
lib/election_buddy/entities/validation/line_errors.rb,
lib/election_buddy/entities/validation/list_errors.rb

Overview

ElectionBuddy API client library

Examples:

Configure the client

ElectionBuddy.configure do |config|
  config.api_key = 'your-api-key'
end

Defined Under Namespace

Classes: Client, Configuration, Error, ErrorFormatter, Importation, Resource, Validation, VoterListResource

Constant Summary

VERSION =

Current version of ElectionBuddy gem

Examples:

Get current version

ElectionBuddy::VERSION #=> "0.4.0"

Returns:

• (String) —

  the current version of the gem

"0.4.0"

Class Attribute Summary

• .configuration ⇒ Configuration

  Current configuration.

Class Method Summary

• .configure {|config| ... } ⇒ Object

  Configures the ElectionBuddy client.

Class Attribute Details

.configuration ⇒ Configuration

Returns Current configuration.

Returns:

• (Configuration) —

  Current configuration

# File 'lib/election_buddy.rb', line 32

def configuration
  @configuration
end

Class Method Details

.configure {|config| ... } ⇒ Object

Configures the ElectionBuddy client

Yields:

• (config) —

  Configuration instance to be modified

Yield Parameters:

• config (Configuration) —

  The configuration instance

# File 'lib/election_buddy.rb', line 38

def configure
  self.configuration ||= Configuration.new
  yield(configuration)
end