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/mapper.rb,
lib/usps/imis/panels.rb,
lib/usps/imis/version.rb,
lib/usps/imis/requests.rb,
lib/usps/imis/panels/vsc.rb,
lib/usps/imis/properties.rb,
lib/usps/imis/command_line.rb,
lib/usps/imis/business_object.rb,
lib/usps/imis/errors/api_error.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/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, Mocks, Panels, Requests Classes: Api, BusinessObject, Config, Data, Error, Mapper, Properties, Query

Constant Summary collapse

VERSION =
'0.11.10'

Class Method Summary collapse

Class Method Details

.configurationObject Also known as: config

Accessor for configuration values

Returns:

  • The configuration object



40
41
42
# File 'lib/usps/imis.rb', line 40

def configuration
  @configuration ||= Config.new
end

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

Used to define a block of configuration settings

Yields:

Returns:

  • The updated configuration object



49
50
51
52
# File 'lib/usps/imis.rb', line 49

def configure
  yield(configuration) if block_given?
  configuration
end

.logger(*tags) ⇒ Object

Logger (with optional nested tags) to write to



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

def logger(*tags) = configuration.logger.tagged('iMIS', *tags)

.versionObject

Gem version



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

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