Module: OFX

Defined in:

lib/ofx_kit.rb,
lib/ofx_kit/errors.rb,
lib/ofx_kit/parser.rb,
lib/ofx_kit/version.rb,
lib/ofx_kit/base/entity.rb,
lib/ofx_kit/base/account.rb,
lib/ofx_kit/base/builder.rb,
lib/ofx_kit/base/document.rb,
lib/ofx_kit/base/statement.rb,
lib/ofx_kit/domain/balance.rb,
lib/ofx_kit/tokenizer/base.rb,
lib/ofx_kit/tokenizer/ofx1.rb,
lib/ofx_kit/tokenizer/ofx2.rb,
lib/ofx_kit/configuration/core.rb,
lib/ofx_kit/domain/transaction.rb,
lib/ofx_kit/domain/bank_account.rb,
lib/ofx_kit/domain/bank_statement.rb,
lib/ofx_kit/configuration/date_parser.rb,
lib/ofx_kit/domain/credit_card_account.rb,
lib/ofx_kit/configuration/section_proxy.rb,
lib/ofx_kit/domain/credit_card_statement.rb,
lib/ofx_kit/domain/transaction_collection.rb,
lib/ofx_kit/configuration/mapping_applicator.rb

Overview

Top-level namespace for the ofx_kit gem. Provides module-level access to the shared Configuration instance and a OFX.configure block for customizing field mappings and XML tags.

Examples:

Configure custom field mappings

OFX.configure do |config|
  config.transaction.map 'MYFIELD', to: :my_attribute
end

Defined Under Namespace

Modules: Base, Tokenizer Classes: Balance, BankAccount, BankStatement, Configuration, ConfigurationError, CreditCardAccount, CreditCardStatement, EncodingError, Error, InvalidBodyError, InvalidHeaderError, MultipleStatementsError, ParseError, Parser, Transaction, TransactionCollection, UnsupportedVersionError

Constant Summary

VERSION =

'0.1.0'

Class Method Summary

• .config ⇒ Configuration

  The shared configuration instance (lazy-initialized).

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

  Yields the current Configuration instance for customization.

• .new(resource) ⇒ Parser

  Parses an OFX file or IO object and returns a Parser instance.

• .reset_config! ⇒ Object

  Resets the configuration to its default state.

Class Method Details

.config ⇒ Configuration

Returns the shared configuration instance (lazy-initialized).

Returns:

• (Configuration) —

  the shared configuration instance (lazy-initialized)

# File 'lib/ofx_kit.rb', line 74

def config
  @config ||= Configuration.new
end

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

Yields the current Configuration instance for customization.

Yield Parameters:

• config (Configuration)

Raises:

• (ConfigurationError) —

  if the block raises any error

# File 'lib/ofx_kit.rb', line 65

def configure
  yield config
rescue ConfigurationError
  raise
rescue StandardError => e
  raise ConfigurationError, e.message
end

.new(resource) ⇒ Parser

Parses an OFX file or IO object and returns a Parser instance. This is the primary entry point for the gem.

Examples:

Parse a file path

ofx = OFX.new("statement.ofx")
ofx.account       #=> OFX::BankAccount
ofx.transactions  #=> OFX::TransactionCollection

Parse an IO object

ofx = OFX.new(File.open("statement.ofx"))

Block form

OFX.new("statement.ofx") do |ofx|
  puts ofx.balance
end

Parameters:

• resource (String, IO) —

  file path or IO object containing OFX data

Returns:

• (Parser)

# File 'lib/ofx_kit.rb', line 58

def new(resource, &)
  Parser.new(resource, &)
end

.reset_config! ⇒ Object

Resets the configuration to its default state. Useful in tests to restore default field mappings between examples.

# File 'lib/ofx_kit.rb', line 80

def reset_config!
  @config = nil
end