Module: Usps::Imis

Defined in:

lib/usps/imis.rb,
lib/usps/imis/api.rb,
lib/usps/imis/data.rb,
lib/usps/imis/error.rb,
lib/usps/imis/mocks.rb,
lib/usps/imis/query.rb,
lib/usps/imis/config.rb,
lib/usps/imis/logger.rb,
lib/usps/imis/mapper.rb,
lib/usps/imis/panels.rb,
lib/usps/imis/version.rb,
lib/usps/imis/requests.rb,
lib/usps/imis/base_data.rb,
lib/usps/imis/panels/vsc.rb,
lib/usps/imis/party_data.rb,
lib/usps/imis/properties.rb,
lib/usps/imis/command_line.rb,
lib/usps/imis/logger_helpers.rb,
lib/usps/imis/business_object.rb,
lib/usps/imis/errors/api_error.rb,
lib/usps/imis/logger_formatter.rb,
lib/usps/imis/panels/education.rb,
lib/usps/imis/panels/base_panel.rb,
lib/usps/imis/errors/config_error.rb,
lib/usps/imis/errors/mapper_error.rb,
lib/usps/imis/errors/response_error.rb,
lib/usps/imis/mocks/business_object.rb,
lib/usps/imis/command_line/interface.rb,
lib/usps/imis/errors/locked_id_error.rb,
lib/usps/imis/errors/not_found_error.rb,
lib/usps/imis/command_line/performers.rb,
lib/usps/imis/errors/missing_id_error.rb,
lib/usps/imis/errors/command_line_error.rb,
lib/usps/imis/command_line/options_parser.rb,
lib/usps/imis/errors/panel_unimplemented_error.rb,
lib/usps/imis/errors/unexpected_property_type_error.rb

Overview

API wrapper for interacting with iMIS

Defined Under Namespace

Modules: CommandLine, Errors, LoggerHelpers, Mocks, Panels, Requests Classes: Api, BaseData, BusinessObject, Config, Data, Error, Logger, LoggerFormatter, Mapper, PartyData, Properties, Query

Constant Summary

VERSION =

'0.11.25'

Class Method Summary

• .configuration ⇒ Object (also: config)

  Accessor for configuration values.

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

  Used to define a block of configuration settings.

• .logger ⇒ Object

  Logger (with optional nested tags) to write to.

• .version ⇒ Object

  Gem version.

Class Method Details

.configuration ⇒ Object Also known as: config

Accessor for configuration values

Returns:

• The configuration object

# File 'lib/usps/imis.rb', line 38

def configuration
  @configuration ||= Config.new
end

.configure {|configuration| ... } ⇒ Object

Used to define a block of configuration settings

Yields:

• (configuration)

Returns:

• The updated configuration object

# File 'lib/usps/imis.rb', line 47

def configure
  yield(configuration) if block_given?
  configuration
end

.logger ⇒ Object

Logger (with optional nested tags) to write to

# File 'lib/usps/imis.rb', line 54

def logger(*) = configuration.logger.tagged(*)

.version ⇒ Object

Gem version

# File 'lib/usps/imis.rb', line 58

def version = Gem::Version.new(VERSION)