ofx_kit 0.1.0

data/lib/ofx_kit/tokenizer/ofx2.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OFX
+  module Tokenizer
+    # Tokenizer for OFX version 2 files, which use standard XML with an
+    # OFX processing instruction for header metadata.
+    class OFX2 < Base
+      private
+
+      def parse!
+        content = convert_to_utf8(@content)
+        doc     = Nokogiri::XML(content, &:nonet)
+
+        raise InvalidBodyError, "OFX2 body could not be parsed: #{doc.errors.first}" if doc.errors.any?
+
+        @headers = parse_headers(doc)
+        @body    = doc
+      end
+
+      def parse_headers(doc)
+        pi = doc.children.find { |node| node.processing_instruction? && node.name == 'OFX' }
+        return {} unless pi
+
+        pi.content.scan(/(\w+)="([^"]*)"/).each_with_object({}) do |(key, value), result|
+          result[key] = value == 'NONE' ? nil : value
+        end
+      end
+    end
+  end
+end

data/lib/ofx_kit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OFX
+  VERSION = '0.1.0'
+end

data/lib/ofx_kit.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'money'
+Money.rounding_mode  = BigDecimal::ROUND_HALF_UP
+Money.locale_backend = :currency
+require 'stringio'
+require 'time'
+
+require_relative 'ofx_kit/version'
+require_relative 'ofx_kit/errors'
+require_relative 'ofx_kit/configuration'
+require_relative 'ofx_kit/base/entity'
+require_relative 'ofx_kit/base/account'
+require_relative 'ofx_kit/base/statement'
+require_relative 'ofx_kit/base/document'
+require_relative 'ofx_kit/domain/bank_account'
+require_relative 'ofx_kit/domain/credit_card_account'
+require_relative 'ofx_kit/domain/transaction'
+require_relative 'ofx_kit/domain/transaction_collection'
+require_relative 'ofx_kit/domain/balance'
+require_relative 'ofx_kit/domain/bank_statement'
+require_relative 'ofx_kit/domain/credit_card_statement'
+require_relative 'ofx_kit/base/builder'
+require_relative 'ofx_kit/tokenizer/base'
+require_relative 'ofx_kit/tokenizer/ofx1'
+require_relative 'ofx_kit/tokenizer/ofx2'
+require_relative 'ofx_kit/parser'
+
+# Top-level namespace for the ofx_kit gem.
+# Provides module-level access to the shared {Configuration} instance and
+# a {.configure} block for customizing field mappings and XML tags.
+#
+# @example Configure custom field mappings
+#   OFX.configure do |config|
+#     config.transaction.map 'MYFIELD', to: :my_attribute
+#   end
+module OFX
+  class << self
+    # Parses an OFX file or IO object and returns a {Parser} instance.
+    # This is the primary entry point for the gem.
+    #
+    # @param resource [String, IO] file path or IO object containing OFX data
+    # @return [Parser]
+    #
+    # @example Parse a file path
+    #   ofx = OFX.new("statement.ofx")
+    #   ofx.account       #=> OFX::BankAccount
+    #   ofx.transactions  #=> OFX::TransactionCollection
+    #
+    # @example Parse an IO object
+    #   ofx = OFX.new(File.open("statement.ofx"))
+    #
+    # @example Block form
+    #   OFX.new("statement.ofx") do |ofx|
+    #     puts ofx.balance
+    #   end
+    def new(resource, &)
+      Parser.new(resource, &)
+    end
+
+    # Yields the current {Configuration} instance for customization.
+    # @yieldparam config [Configuration]
+    # @raise [ConfigurationError] if the block raises any error
+    def configure
+      yield config
+    rescue ConfigurationError
+      raise
+    rescue StandardError => e
+      raise ConfigurationError, e.message
+    end
+
+    # @return [Configuration] the shared configuration instance (lazy-initialized)
+    def config
+      @config ||= Configuration.new
+    end
+
+    # Resets the configuration to its default state.
+    # Useful in tests to restore default field mappings between examples.
+    def reset_config!
+      @config = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: ofx_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Geron
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.16'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Parses OFX 1.x and 2.x files into typed domain objects with a fluent
+  API and configurable field mappings.
+email: lucasf.geron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/generators/ofx/eject_generator.rb
+- lib/generators/ofx/templates/ofx_mappings.yml
+- lib/ofx_kit.rb
+- lib/ofx_kit/base/account.rb
+- lib/ofx_kit/base/builder.rb
+- lib/ofx_kit/base/document.rb
+- lib/ofx_kit/base/entity.rb
+- lib/ofx_kit/base/statement.rb
+- lib/ofx_kit/configuration.rb
+- lib/ofx_kit/configuration/core.rb
+- lib/ofx_kit/configuration/date_parser.rb
+- lib/ofx_kit/configuration/mapping_applicator.rb
+- lib/ofx_kit/configuration/section_proxy.rb
+- lib/ofx_kit/domain/balance.rb
+- lib/ofx_kit/domain/bank_account.rb
+- lib/ofx_kit/domain/bank_statement.rb
+- lib/ofx_kit/domain/credit_card_account.rb
+- lib/ofx_kit/domain/credit_card_statement.rb
+- lib/ofx_kit/domain/transaction.rb
+- lib/ofx_kit/domain/transaction_collection.rb
+- lib/ofx_kit/errors.rb
+- lib/ofx_kit/mappings/core_mappings.yml
+- lib/ofx_kit/mappings/field_mappings.yml
+- lib/ofx_kit/parser.rb
+- lib/ofx_kit/tokenizer/base.rb
+- lib/ofx_kit/tokenizer/ofx1.rb
+- lib/ofx_kit/tokenizer/ofx2.rb
+- lib/ofx_kit/version.rb
+homepage: https://github.com/lucasgeron/ofx_kit
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/lucasgeron/ofx_kit
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: OFX file parser for Ruby
+test_files: []