Module: InfaktApiClient

Defined in:

lib/infakt_api_client.rb,
lib/infakt_api_client/user.rb,
lib/infakt_api_client/client.rb,
lib/infakt_api_client/engine.rb,
lib/infakt_api_client/version.rb,
lib/infakt_api_client/configuration.rb,
lib/generators/infakt_api_client/install_generator.rb

Overview

Module for interacting with the inFakt.pl API

See Also:

• https://www.infakt.pl/developers/

Defined Under Namespace

Modules: Generators Classes: Client, Configuration, ConfigurationError, Engine, Error, User

Constant Summary

VERSION =

"0.1.1"

Class Attribute Summary

• .configuration ⇒ Configuration

  Current configuration instance.

Class Method Summary

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

  Configures the client through a block.

Class Attribute Details

.configuration ⇒ Configuration

Returns Current configuration instance.

Returns:

• (Configuration) —

  Current configuration instance

# File 'lib/infakt_api_client.rb', line 26

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

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

Configures the client through a block

Yields:

• (config) —

  Configuration instance

Raises:

• (ConfigurationError) —

  if no block is given

# File 'lib/infakt_api_client.rb', line 33

def configure
  yield(configuration)
rescue LocalJumpError
  raise ConfigurationError, "Configuration block is required"
end