ofx_kit 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b023f7e1d7c5381113d3743b0aba99ab79a0a297081df3d5943f02d55a9390b
-  data.tar.gz: '0898db82c3556619deab40d7caad84b72e518db65e2e1933422387f313fe4ae3'
+  metadata.gz: 131031f6d262d168634bd74678d9c7c8aa2820a1ef87c6cd1077b6d06106404d
+  data.tar.gz: b5018a6676ec15d0f28f5640d1fdc5048efacc92f350be689ee53264e230027a
 SHA512:
-  metadata.gz: ff60df963fdd5084ddfc5a2ee7a66633f2f6d9f55fa7d50416aeac92393c14617ed6978c87e4bbe9c3efb1a071abf487a3790dbdc71e29bcf460fb2b425e0efd
-  data.tar.gz: 34995498f62d7cdbedb8e1d395d81568af47876edfe4c51890f862a05b898226ee9d27cd967003dae7fb67d060cf99d5d56958ee12c948e188afde57198592cf
+  metadata.gz: 3e548553b82237b1c56e193dc85f3bb5463abdf2d0082074b1731cb73dfdf435c1677e410aa9ad1a1e8a1bc37d68fe0d128c633948733e6d7fd72e3400edb97d
+  data.tar.gz: c37a45193aee74dedb292442965de84e79223eb672496b29cd079f09bfbdaadafefadd71d9ffbc116b089cf28c1b2706b6183b29fef746f3ca862cc1f322a255

data/README.md

@@ -1,6 +1,8 @@
 # OFX Kit
 
-[![Gem Version](https://badge.fury.io/rb/ofx_kit.svg)](https://badge.fury.io/rb/ofx_kit) [![Downloads](https://img.shields.io/gem/dt/ofx_kit?label=Downloads)](https://rubygems.org/gems/ofx_kit)
+[![GitHub Repo](https://img.shields.io/badge/OFX%20Kit-blue?label=github&logo=github)](https://github.com/lucasgeron/ofx_kit)
+[![Gem Version](https://img.shields.io/gem/v/ofx_kit?logo=rubygems&logoColor=%23e9573f&label=rubygems)](https://rubygems.org/gems/ofx_kit) 
+[![Gem Total Downloads](https://img.shields.io/gem/dt/ofx_kit?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2MDAiIGhlaWdodD0iNjAwIiB2aWV3Qm94PSIwIDAgMjQgMjQiPjxwYXRoIGQ9Ik0xMiAzdjEwbDQtNGgtM1YzaC0ydjZIOGw0IDRWM3pNNSAyMGgxNHYtMkg1djJ6IiBmaWxsPSIjZmZmIi8%2BPC9zdmc%2B&logoColor=white)](https://rubygems.org/gems/ofx_kit)
 
 
 A Ruby gem for parsing OFX (Open Financial Exchange) files. Supports OFX 1.x (SGML) and OFX 2.x (XML), bank statements and credit card statements, with a fluent API and configurable field mappings.
@@ -10,7 +12,7 @@ A Ruby gem for parsing OFX (Open Financial Exchange) files. Supports OFX 1.x (SG
 Add to your Gemfile:
 
 ```ruby
-gem 'ofx_kit', '~> 1.0'
+gem 'ofx_kit', '~> 1.0', '>= 1.0.2'
 ```
 
 ## Usage
@@ -126,18 +128,28 @@ ofx.balance   # => OFX::MultipleStatementsError (use `balances`)
 
 ## Configuration
 
+### Rails setup
+
+Generate a pre-filled initializer with all options commented out:
+
+```bash
+rails generate ofx_kit:install
+```
+
+This creates `config/initializers/ofx_kit.rb`. Uncomment and adjust whatever you need — everything else stays at its default.
+
 ### Field mappings
 
-Use `map` to add new attributes or rename built-in ones:
+Use `map` inside an `OFX.configure` block to add custom attributes or rename built-in ones:
 
 ```ruby
 OFX.configure do |config|
-  # New field: your bank emits a tag the gem doesn't know about by default
+  # Add a bank-specific tag the gem doesn't know about by default
   config.bank_account.map "AGENCIA",      to: "branch_code"
   config.transaction.map  "HISPAYEEMEMO", to: "extended_memo"
 
-  # Rename a built-in field to a name that fits your domain
-  config.transaction.map "FITID", to: "uid"   # default is fit_id
+  # Rename a built-in field to match your domain
+  config.transaction.map "FITID", to: "uid"        # default is fit_id
   config.transaction.map "NAME",  to: "payee_name"
 end
 
@@ -149,64 +161,21 @@ ofx.transactions.first.uid            # => "20240115001"
 ```
 
 > **Protected core fields** — `CURDEF`, `TRNAMT`, `DTPOSTED`, `DTUSER`, `BALAMT`, `DTASOF`
-> are used internally to build Money objects and parse dates. They cannot be renamed;
+> are used internally to build Money objects and parse dates. They cannot be remapped;
 > attempting to do so raises `OFX::ConfigurationError`.
 
-### Loading mappings from a YAML file
-
-For larger configurations or Rails apps, a YAML file is cleaner than inline `map` calls.
-
-**Rails** — eject the template with:
-
-```bash
-rails generate ofx:eject
-```
-
-This creates `config/initializers/ofx_mappings.yml`, which the gem detects and loads
-automatically on boot — no `OFX.configure` call needed.
-
-**Standalone** — point `load_mappings` at any YAML file:
-
-```ruby
-OFX.configure do |config|
-  config.load_mappings("config/ofx_mappings.yml")
-end
-```
-
-The file must have a `FIELDS:` top-level key:
-
-```yaml
-FIELDS:
-  STMTTRN:
-    HISPAYEEMEMO: extended_memo   # → transaction.extended_memo (new field)
-    FITID: uid                    # → transaction.uid  (default was fit_id)
-  BANKACCTFROM:
-    AGENCIA: branch_code          # → account.branch_code (new field)
-```
-
 ### Silencing warnings
 
-`transactions` and `balances` aggregate across all statements in a multi-statement file and emit a warning. To silence them:
+`transactions` and `balances` emit a warning when aggregating across multiple statements in the same file. To silence them:
 
 ```ruby
-OFX.config.multi_statement_warnings = false
-```
-
-### Currency
-
-The OFX specification requires `CURDEF` in every statement (`STMTRS` / `CCSTMTRS`). If the tag is absent, the gem raises `OFX::Errors::InvalidBodyError` rather than silently assuming a currency.
-
-### Rails
-
-**Behavioral options** — create a standard initializer:
-
-```ruby
-# config/initializers/ofx.rb
 OFX.configure do |config|
-  config.multi_statement_warnings = false  # silence aggregation warnings
+  config.multi_statement_warnings = false
 end
 ```
 
+This option is already included (commented out) in the initializer generated by `ofx_kit:install`.
+
 ## Contributing
 
 1. Fork the repository and create a feature branch.

data/lib/generators/ofx_kit/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module OfxKit # :nodoc:
+  module Generators # :nodoc:
+    # Generates an OFX Kit initializer with all configuration options
+    # pre-written and commented, ready to uncomment and customize.
+    #
+    # === Example
+    #
+    #   rails generate ofx_kit:install
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Creates an OFX Kit initializer at config/initializers/ofx_kit.rb'
+
+      def copy_initializer
+        copy_file 'ofx_kit.rb', 'config/initializers/ofx_kit.rb'
+      end
+    end
+  end
+end

data/lib/generators/ofx_kit/templates/ofx_kit.rb

@@ -0,0 +1,40 @@
+# config/initializers/ofx_kit.rb
+
+OFX.configure do |config|
+  # ---------------------------------------------------------------------------
+  # Field Mappings
+  # ---------------------------------------------------------------------------
+  # Map OFX XML tags to Ruby attribute names on domain objects.
+  # Uncomment any line to override its default, or add new lines for custom tags.
+  #
+  # Protected core fields cannot be remapped (raises OFX::Error::InvalidConfiguration):
+  #   CURDEF, TRNAMT, DTPOSTED, DTUSER, BALAMT, DTASOF
+  #
+  # Default transaction fields (STMTTRN):
+  # config.transaction.map "FITID",    to: "fit_id"
+  # config.transaction.map "TRNTYPE",  to: "type"
+  # config.transaction.map "NAME",     to: "name"
+  # config.transaction.map "MEMO",     to: "memo"
+  # config.transaction.map "PAYEE",    to: "payee"
+  # config.transaction.map "CHECKNUM", to: "check_number"
+  # config.transaction.map "REFNUM",   to: "ref_number"
+  # config.transaction.map "SIC",      to: "sic"
+  # config.transaction.map "HISPAYEEMEMO", to: "extended_memo"  # custom field example
+  #
+  # Default bank account fields (BANKACCTFROM):
+  # config.bank_account.map "BANKID",   to: "bank_id"
+  # config.bank_account.map "ACCTID",   to: "account_id"
+  # config.bank_account.map "ACCTTYPE", to: "account_type"
+  # config.bank_account.map "BRANCHID", to: "branch_id"
+  # config.bank_account.map "AGENCIA",  to: "branch_code"  # custom field example
+  #
+  # Default credit card account fields (CCACCTFROM):
+  # config.credit_card_account.map "ACCTID", to: "account_id"
+
+  # ---------------------------------------------------------------------------
+  # Behavioral Options
+  # ---------------------------------------------------------------------------
+  # `transactions` and `balances` emit a warning when aggregating across
+  # multiple statements in the same file. Silence them:
+  # config.multi_statement_warnings = false
+end

data/lib/ofx_kit/bank_statement.rb

@@ -3,6 +3,14 @@
 module OFX
   # Represents a complete bank statement parsed from an OFX file,
   # aggregating the account, its transactions, and the closing balance.
+  #
+  # === Example
+  #
+  #   stmt = OFX.new("bank.ofx").statements.first
+  #   stmt.account              #=> #<OFX::BankAccount ...>
+  #   stmt.balance              #=> #<OFX::Balance ...>
+  #   stmt.transactions         #=> #<OFX::TransactionCollection ...>
+  #   stmt.bank_statement?      #=> true
   class BankStatement < Base::Statement
     # Always +true+.
     def bank_statement? = true

data/lib/ofx_kit/configuration/core.rb

@@ -6,23 +6,20 @@ module OFX
   ##
   # Manages XML-to-Ruby field mappings used during OFX document parsing.
   #
-  # Mappings are split into two layers:
-  # - *Core* (+core_mappings.yml+): OFX-standard fields whose Ruby attribute names are
-  #   referenced by name inside Base::Builder. These cannot be overridden.
-  # - *User* (+field_mappings.yml+): convenience mappings that can be added to or replaced
-  #   at runtime via #load_mappings or the OFX.configure block.
+  # Mappings are resolved in three layers (last wins):
+  # - *Core* (+core_mappings.yml+): OFX-standard fields referenced by name inside
+  #   Base::Builder. These cannot be overridden.
+  # - *Default* (+field_mappings.yml+): built-in convenience mappings (e.g. FITID → fit_id).
+  #   They can be renamed via the OFX.configure block.
+  # - *User*: explicit mappings added at runtime via the OFX.configure block.
   class Configuration
     ##
     # Absolute path to the built-in core OFX field mappings (read-only).
     CORE_MAPPINGS_PATH = File.join(__dir__, '..', 'mappings', 'core_mappings.yml')
-    ##
-    # Absolute path to the built-in user-layer field mappings.
-    MAPPINGS_PATH      = File.join(__dir__, '..', 'mappings', 'field_mappings.yml')
 
     ##
-    # Conventional path for user mappings in a Rails application.
-    # Auto-loaded on boot when present. Ejected via +rails generate ofx_kit:eject+.
-    RAILS_MAPPINGS_PATH = 'config/initializers/ofx_mappings.yml'
+    # Absolute path to the built-in default field mappings.
+    MAPPINGS_PATH = File.join(__dir__, '..', 'mappings', 'field_mappings.yml')
 
     ##
     # Controls whether a warning is emitted when OFX::Parser#transactions or
@@ -37,21 +34,19 @@ module OFX
     end
 
     ##
-    # Creates a new Configuration instance.
-    # +auto_load_path+ is the path to a YAML mappings file loaded automatically on
-    # initialization. Defaults to RAILS_MAPPINGS_PATH expanded from the working directory.
-    def initialize(auto_load_path: File.expand_path(RAILS_MAPPINGS_PATH))
+    # Creates a new Configuration instance with the built-in field mappings loaded.
+    def initialize
       @multi_statement_warnings = true
 
       core = YAML.safe_load_file(CORE_MAPPINGS_PATH)
-      @sections = core.fetch('SECTIONS', {})
-      @core_fields = core.fetch('FIELDS', {})
+      @sections       = core.fetch('SECTIONS', {})
+      @core_fields    = core.fetch('FIELDS', {})
       @section_to_tag = @sections.invert
 
-      user = YAML.safe_load_file(MAPPINGS_PATH)
-      @user_fields = user.fetch('FIELDS', {})
+      defaults = YAML.safe_load_file(MAPPINGS_PATH)
+      @default_fields = defaults.fetch('FIELDS', {})
 
-      load_mappings(auto_load_path) if File.exist?(auto_load_path)
+      @user_fields = {}
     end
 
     ##
@@ -88,70 +83,14 @@ module OFX
     ##
     # Returns the merged Hash of XML tag to Ruby attribute mappings for the given
     # +section_name+ (String or Symbol).
-    # Core mappings take precedence; user mappings extend them.
+    # Resolution order: core → default → user (user wins).
     def xml_mappings_for(section_name)
       tag = xml_tag_for(section_name)
       return {} unless tag
 
-      (@core_fields[tag] || {}).merge(@user_fields[tag] || {})
-    end
-
-    ##
-    # Merges additional field mappings from a YAML file at +path+ (String)
-    # into the user-layer configuration.
-    # The file must have a top-level +FIELDS+ key. Core OFX fields cannot be overridden.
-    #
-    # Raises Errors::ConfigurationError if the file is missing, malformed, references
-    # unknown sections, or attempts to override a core field mapping.
-    #
-    # === Example: Load a custom mappings file
-    #
-    #   OFX.configure do |config|
-    #     config.load_mappings 'config/my_ofx_mappings.yml'
-    #   end
-    #
-    # === Example: Expected YAML format
-    #
-    #   # config/my_ofx_mappings.yml
-    #   FIELDS:
-    #     STMTTRN:
-    #       MYFIELD: my_attribute
-    def load_mappings(path)
-      raise Errors::ConfigurationError, "Mappings file not found: #{path}" unless File.exist?(path)
-
-      raw = YAML.safe_load_file(path)
-      raise Errors::ConfigurationError, 'Invalid mappings file: expected a Hash' unless raw.is_a?(Hash)
-
-      fields = raw.fetch('FIELDS') do
-        raise Errors::ConfigurationError, "Invalid mappings file: missing top-level 'FIELDS' key"
-      end
-
-      fields.each { |tag, mappings| merge_user_section(tag, mappings) }
-    end
-
-    private
-
-    def merge_user_section(xml_tag, mappings)
-      unless @sections.key?(xml_tag.to_s)
-        raise Errors::ConfigurationError, "Unknown section '#{xml_tag}'. Valid sections: #{@sections.keys.join(', ')}"
-      end
-
-      unless mappings.is_a?(Hash)
-        raise Errors::ConfigurationError, "Mapping value for '#{xml_tag}' must be a Hash, got #{mappings.class}"
-      end
-
-      mappings.each_key { |k| assert_not_core!(xml_tag, k) }
-
-      @user_fields[xml_tag.to_s] ||= {}
-      @user_fields[xml_tag.to_s].merge!(mappings)
-    end
-
-    def assert_not_core!(xml_tag, xml_key)
-      core_attr = @core_fields.dig(xml_tag.to_s, xml_key.to_s)
-      return unless core_attr
-
-      raise Errors::ConfigurationError,
-            "Cannot override core mapping '#{xml_tag}.#{xml_key}' (reserved as '#{core_attr}')"
+      (@core_fields[tag] || {})
+        .merge(@default_fields[tag] || {})
+        .merge(@user_fields[tag] || {})
     end
   end
 end

data/lib/ofx_kit/configuration/mapping_applicator.rb

@@ -23,7 +23,7 @@ module OFX
       def currency_for(node, section)
         xml_tag = OFX.config.xml_mappings_for(section).key('currency')
         value = xml_tag && text_at(node, xml_tag)
-        raise Errors::InvalidBodyError, 'Missing required CURDEF tag' if value.nil? || value.empty?
+        raise OFX::Error::InvalidBody, 'Missing required CURDEF tag' if value.nil? || value.empty?
 
         value
       end

data/lib/ofx_kit/configuration/section_proxy.rb

@@ -16,7 +16,7 @@ module OFX
       # Maps +xml_key+ (the OFX XML element name, String) to a Ruby attribute name
       # via the +to+ keyword (String or Symbol) for this section.
       #
-      # Raises Errors::ConfigurationError if +xml_key+ is a core-protected field.
+      # Raises ConfigurationError if +xml_key+ is a core-protected field or has already been mapped.
       #
       # === Example: Map a custom bank-specific field
       #
@@ -27,11 +27,17 @@ module OFX
       def map(xml_key, to:)
         core_attr = @core_fields.dig(@xml_tag.to_s, xml_key.to_s)
         if core_attr
-          raise OFX::Errors::ConfigurationError,
+          raise OFX::Error::InvalidConfiguration,
                 "Cannot override core mapping '#{@xml_tag}.#{xml_key}' (reserved as '#{core_attr}')"
         end
 
         @user_fields[@xml_tag] ||= {}
+
+        if @user_fields[@xml_tag].key?(xml_key)
+          raise OFX::Error::InvalidConfiguration,
+                "Duplicate mapping for '#{@xml_tag}.#{xml_key}' — already mapped to '#{@user_fields[@xml_tag][xml_key]}'"
+        end
+
         @user_fields[@xml_tag][xml_key] = to
       end
     end

data/lib/ofx_kit/credit_card_account.rb

@@ -2,6 +2,14 @@
 
 module OFX
   # Represents a credit card account parsed from an OFX statement.
+  #
+  # === Example
+  #
+  #   account = OFX.new("credit_card.ofx").account
+  #   account.account_id   #=> "4111111111111111"
+  #   account.currency     #=> "USD"
+  #   account.balance      #=> #<OFX::Balance ...>
+  #   account.transactions #=> #<OFX::TransactionCollection ...>
   class CreditCardAccount < Base::Account
     # Credit card account number (String).
     attr_accessor :account_id

data/lib/ofx_kit/credit_card_statement.rb

@@ -3,6 +3,14 @@
 module OFX
   # Represents a complete credit card statement parsed from an OFX file,
   # aggregating the account, its transactions, and the closing balance.
+  #
+  # === Example
+  #
+  #   stmt = OFX.new("credit_card.ofx").statements.first
+  #   stmt.account                  #=> #<OFX::CreditCardAccount ...>
+  #   stmt.balance                  #=> #<OFX::Balance ...>
+  #   stmt.transactions             #=> #<OFX::TransactionCollection ...>
+  #   stmt.credit_card_statement?   #=> true
   class CreditCardStatement < Base::Statement
     # Always +true+.
     def credit_card_statement? = true

data/lib/ofx_kit/errors/error.rb

@@ -1,11 +1,6 @@
 # frozen_string_literal: true
 
 module OFX
-  # Namespace for all gem-specific exception classes.
-  # All errors inherit from Errors::Error, so callers can rescue the entire hierarchy
-  # with <tt>rescue OFX::Errors::Error</tt>.
-  module Errors
-    # Base error class for all OFX-related exceptions.
-    class Error < StandardError; end
-  end
+  # Base class for all OFX Kit exceptions. Rescue from this to catch any gem error.
+  class Error < StandardError; end
 end

data/lib/ofx_kit/errors/invalid_body.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OFX
+  class Error
+    # Raised when the file body is malformed or missing required fields (e.g. CURDEF).
+    class InvalidBody < Parse; end
+  end
+end

data/lib/ofx_kit/errors/invalid_configuration.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OFX
+  class Error
+    # Raised when +OFX.configure+ receives an invalid argument.
+    class InvalidConfiguration < Error; end
+  end
+end

data/lib/ofx_kit/errors/invalid_header.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OFX
+  class Error
+    # Raised when the file header is malformed or missing required fields.
+    class InvalidHeader < Parse; end
+  end
+end

data/lib/ofx_kit/errors/multiple_statements.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module OFX
+  class Error
+    # Raised when a singular helper (e.g. +#account+, +#balance+) is called
+    # on a file that contains multiple statements. Use +#accounts+ or +#balances+ instead.
+    class MultipleStatements < Error; end
+  end
+end

data/lib/ofx_kit/errors/parse.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OFX
+  class Error
+    # Raised when the OFX header or body cannot be parsed.
+    class Parse < Error; end
+  end
+end

data/lib/ofx_kit/errors/unsupported_encoding.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OFX
+  class Error
+    # Raised when the file encoding cannot be handled.
+    class UnsupportedEncoding < Error; end
+  end
+end

data/lib/ofx_kit/errors/unsupported_version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OFX
+  class Error
+    # Raised when the OFX version declared in the header is not supported.
+    class UnsupportedVersion < Error
+      attr_reader :version
+
+      def initialize(version)
+        @version = version
+        super("Unsupported OFX version: #{version}")
+      end
+    end
+  end
+end

data/lib/ofx_kit/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'errors/error'
+require_relative 'errors/parse'
+require_relative 'errors/invalid_header'
+require_relative 'errors/invalid_body'
+require_relative 'errors/unsupported_version'
+require_relative 'errors/unsupported_encoding'
+require_relative 'errors/invalid_configuration'
+require_relative 'errors/multiple_statements'

data/lib/ofx_kit/parser.rb

@@ -47,7 +47,7 @@ module OFX
     ##
     # Returns the account for files containing a single statement
     # (BankAccount, CreditCardAccount, or +nil+).
-    # Raises Errors::MultipleStatementsError if the file contains more than one statement.
+    # Raises Error::MultipleStatements if the file contains more than one statement.
     #
     # === Example
     #
@@ -57,7 +57,7 @@ module OFX
     #   ofx.account.bank_id       #=> "021000021"   # BankAccount only
     def account
       if statements.length > 1
-        raise Errors::MultipleStatementsError, 'File contains multiple statements. Use `accounts` to get all accounts.'
+        raise Error::MultipleStatements, 'File contains multiple statements. Use `accounts` to get all accounts.'
       end
 
       statements.first&.account
@@ -98,7 +98,7 @@ module OFX
 
     ##
     # Returns the balance for files containing a single statement (Balance or +nil+).
-    # Raises Errors::MultipleStatementsError if the file contains more than one statement.
+    # Raises Error::MultipleStatements if the file contains more than one statement.
     #
     # === Example
     #
@@ -108,7 +108,7 @@ module OFX
     #   ofx.balance.posted_at      #=> 2024-01-31 00:00:00 +0000
     def balance
       if statements.length > 1
-        raise Errors::MultipleStatementsError, 'File contains multiple statements. Use `balances` to get all balances.'
+        raise Error::MultipleStatements, 'File contains multiple statements. Use `balances` to get all balances.'
       end
 
       statements.first&.balance

data/lib/ofx_kit/tokenizer/ofx1.rb

@@ -14,7 +14,7 @@ module OFX
         content = convert_to_utf8(@content)
         parts   = content.split(/<OFX>/i, 2)
 
-        raise Errors::InvalidHeaderError, 'Missing <OFX> tag in OFX file' if parts.size < 2
+        raise OFX::Error::InvalidHeader, 'Missing <OFX> tag in OFX file' if parts.size < 2
 
         @headers = parse_headers(parts[0])
         @body    = parse_body("<OFX>#{parts[1]}")
@@ -35,7 +35,7 @@ module OFX
       def parse_body(raw)
         normalized = normalize_sgml(raw)
         doc = Nokogiri::XML(normalized, &:nonet)
-        raise Errors::InvalidBodyError, "OFX body could not be parsed: #{doc.errors.first}" if doc.errors.any?
+        raise OFX::Error::InvalidBody, "OFX body could not be parsed: #{doc.errors.first}" if doc.errors.any?
 
         doc
       end

data/lib/ofx_kit/tokenizer/ofx2.rb

@@ -11,7 +11,7 @@ module OFX
         content = convert_to_utf8(@content)
         doc     = Nokogiri::XML(content, &:nonet)
 
-        raise Errors::InvalidBodyError, "OFX2 body could not be parsed: #{doc.errors.first}" if doc.errors.any?
+        raise OFX::Error::InvalidBody, "OFX2 body could not be parsed: #{doc.errors.first}" if doc.errors.any?
 
         @headers = parse_headers(doc)
         @body    = doc

data/lib/ofx_kit/version.rb

@@ -2,5 +2,5 @@
 
 module OFX
   # Current gem version (String).
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/lib/ofx_kit.rb

@@ -8,14 +8,7 @@ require 'stringio'
 require 'time'
 
 require_relative 'ofx_kit/version'
-require_relative 'ofx_kit/errors/error'
-require_relative 'ofx_kit/errors/parse_error'
-require_relative 'ofx_kit/errors/invalid_header_error'
-require_relative 'ofx_kit/errors/invalid_body_error'
-require_relative 'ofx_kit/errors/unsupported_version_error'
-require_relative 'ofx_kit/errors/encoding_error'
-require_relative 'ofx_kit/errors/configuration_error'
-require_relative 'ofx_kit/errors/multiple_statements_error'
+require_relative 'ofx_kit/errors'
 require_relative 'ofx_kit/configuration/core'
 require_relative 'ofx_kit/configuration/section_proxy'
 require_relative 'ofx_kit/configuration/date_parser'
@@ -78,13 +71,13 @@ module OFX
     #
     # :yields: config
     #
-    # Raises Errors::ConfigurationError if the block raises any error.
+    # Raises OFX::Error::InvalidConfiguration if the block raises any error.
     def configure
       yield config
-    rescue Errors::ConfigurationError
+    rescue Error::InvalidConfiguration
       raise
     rescue StandardError => e
-      raise Errors::ConfigurationError, e.message
+      raise Error::InvalidConfiguration, e.message
     end
 
     ##

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ofx_kit
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Lucas Geron
@@ -65,20 +65,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 7.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 7.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -116,8 +102,8 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/generators/ofx_kit/eject_generator.rb
-- lib/generators/ofx_kit/templates/ofx_mappings.yml
+- lib/generators/ofx_kit/install_generator.rb
+- lib/generators/ofx_kit/templates/ofx_kit.rb
 - lib/ofx_kit.rb
 - lib/ofx_kit/balance.rb
 - lib/ofx_kit/bank_account.rb
@@ -133,14 +119,15 @@ files:
 - lib/ofx_kit/configuration/section_proxy.rb
 - lib/ofx_kit/credit_card_account.rb
 - lib/ofx_kit/credit_card_statement.rb
-- lib/ofx_kit/errors/configuration_error.rb
-- lib/ofx_kit/errors/encoding_error.rb
+- lib/ofx_kit/errors.rb
 - lib/ofx_kit/errors/error.rb
-- lib/ofx_kit/errors/invalid_body_error.rb
-- lib/ofx_kit/errors/invalid_header_error.rb
-- lib/ofx_kit/errors/multiple_statements_error.rb
-- lib/ofx_kit/errors/parse_error.rb
-- lib/ofx_kit/errors/unsupported_version_error.rb
+- lib/ofx_kit/errors/invalid_body.rb
+- lib/ofx_kit/errors/invalid_configuration.rb
+- lib/ofx_kit/errors/invalid_header.rb
+- lib/ofx_kit/errors/multiple_statements.rb
+- lib/ofx_kit/errors/parse.rb
+- lib/ofx_kit/errors/unsupported_encoding.rb
+- lib/ofx_kit/errors/unsupported_version.rb
 - lib/ofx_kit/mappings/core_mappings.yml
 - lib/ofx_kit/mappings/field_mappings.yml
 - lib/ofx_kit/parser.rb
@@ -150,6 +137,7 @@ files:
 - lib/ofx_kit/transaction.rb
 - lib/ofx_kit/transaction_collection.rb
 - lib/ofx_kit/version.rb
+homepage: https://github.com/lucasgeron/ofx_kit
 licenses:
 - MIT
 metadata:

data/lib/generators/ofx_kit/eject_generator.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-
-module OFX
-  # Namespace for Rails generator classes provided by the ofx_kit gem.
-  module Generators
-    # Ejects OFX field mappings into the Rails application so they can be customized.
-    #
-    # Creates +config/initializers/ofx_mappings.yml+ with the gem's default field
-    # mappings. The file is auto-detected and loaded by the OFX gem on boot —
-    # no initializer or +OFX.configure+ call is needed.
-    #
-    # === Example
-    #
-    #   rails generate ofx_kit:eject
-    class EjectGenerator < Rails::Generators::Base
-      source_root File.expand_path('templates', __dir__)
-
-      desc 'Ejects OFX field mappings into config/initializers/ofx_mappings.yml'
-
-      def eject_mappings
-        copy_file 'ofx_mappings.yml', 'config/initializers/ofx_mappings.yml'
-      end
-    end
-  end
-end

data/lib/generators/ofx_kit/templates/ofx_mappings.yml

@@ -1,33 +0,0 @@
-# config/initializers/ofx_mappings.yml
-#
-# Each value is the Ruby attribute name exposed on the domain object.
-# Example: changing FITID from "fit_id" to "uid" means
-#   transaction.fit_id  →  transaction.uid
-#
-# Bank-specific XML tags not listed below can also be captured.
-# Simply add them to the relevant section:
-#
-#   STMTTRN:
-#     HISPAYEEMEMO: "extended_memo"    # → transaction.extended_memo
-#   BANKACCTFROM:
-#     AGENCIA: "branch_code"           # → account.branch_code
-#
-FIELDS:
-  STMTTRN:
-    FITID:    "fit_id"
-    TRNTYPE:  "type"
-    NAME:     "name"
-    MEMO:     "memo"
-    PAYEE:    "payee"
-    CHECKNUM: "check_number"
-    REFNUM:   "ref_number"
-    SIC:      "sic"
-
-  BANKACCTFROM:
-    BANKID:   "bank_id"
-    ACCTID:   "account_id"
-    ACCTTYPE: "account_type"
-    BRANCHID: "branch_id"
-
-  CCACCTFROM:
-    ACCTID: "account_id"

data/lib/ofx_kit/errors/configuration_error.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  module Errors
-    # Raised when the library configuration is invalid or inconsistent.
-    class ConfigurationError < Error; end
-  end
-end

data/lib/ofx_kit/errors/encoding_error.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  module Errors
-    # Raised when a character encoding error occurs while reading the OFX file.
-    class EncodingError < Error; end
-  end
-end

data/lib/ofx_kit/errors/invalid_body_error.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  module Errors
-    # Raised when the OFX file body cannot be parsed into a valid document.
-    class InvalidBodyError < ParseError; end
-  end
-end

data/lib/ofx_kit/errors/invalid_header_error.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  module Errors
-    # Raised when the OFX file header is malformed or missing.
-    class InvalidHeaderError < ParseError; end
-  end
-end

data/lib/ofx_kit/errors/multiple_statements_error.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  module Errors
-    # Raised when an operation requires a single statement but multiple were found.
-    class MultipleStatementsError < Error; end
-  end
-end

data/lib/ofx_kit/errors/parse_error.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  module Errors
-    # Raised when the OFX file cannot be parsed.
-    class ParseError < Error; end
-  end
-end

data/lib/ofx_kit/errors/unsupported_version_error.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  module Errors
-    ##
-    # Raised when the OFX version declared in the file is not supported.
-    class UnsupportedVersionError < Error
-      ##
-      # The unsupported version string found in the file (String).
-      attr_reader :version
-
-      ##
-      # Creates a new error for the given unsupported +version+ string.
-      def initialize(version)
-        @version = version
-        super("Unsupported OFX version: #{version}")
-      end
-    end
-  end
-end