ofx_br 0.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7762b34050e1cb1c3cd7191d88bdbff23902c771a4e76e50ec960ead46464bb7
+  data.tar.gz: 4fb5f842f6592c125a07007dc7e33aefb7ec6b72a37c0c9d270f374d3f16e424
+SHA512:
+  metadata.gz: ec56cc287b9b1c4accc141a97ffbb7f10c649cb4a29ee4b5234ef77aee52d413ee65177b26d20d33a5c468610bf2a4734aff9cedcaee881efc12bbfb3dab800e
+  data.tar.gz: ebc5b4d3243f90de88678b0cd696e47fd9c01e160ad529946936b1276ca55f9d892e60b0b11122ab3a7e972dabe9c8234fba0c0b5641509defcc9aecf7d3ba73

data/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "08:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: nokogiri
+    versions:
+    - 1.11.1
+    - 1.11.2

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+*.gem
+pkg
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3
+  - 2.2
+  - 2.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    ofx (0.3.2)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.1)
+    coderay (1.1.2)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    mini_portile2 (2.5.3)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    racc (1.5.2)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ofx!
+  pry-byebug
+  rake
+  rspec (~> 3.10)
+
+BUNDLED WITH
+   1.16.4

data/README.rdoc

@@ -0,0 +1,51 @@
+= OFX
+
+{<img src="https://badge.fury.io/rb/ofx.png" alt="Gem Version" />}[http://badge.fury.io/rb/ofx]
+{<img src="https://travis-ci.org/annacruz/ofx.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/annacruz/ofx]
+
+A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports both OFX 1.0.2 and 2.1.1.
+
+Works on both ruby 1.9 and 2.0.
+
+== Usage
+
+  require "ofx"
+
+  OFX("file.ofx") do
+    p account
+    p account.balance
+    p account.transactions
+  end
+
+Invalid files will raise an OFX::UnsupportedFileError.
+
+== Creator
+
+* Nando Vieira - http://simplesideias.com.br
+
+== Maintainer
+
+* Anna Cruz - http://anna-cruz.com
+
+== License
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/ofx_br/account.rb

@@ -0,0 +1,11 @@
+module OFX
+  class Account < Foundation
+    attr_accessor :balance
+    attr_accessor :bank_id
+    attr_accessor :currency
+    attr_accessor :id
+    attr_accessor :transactions
+    attr_accessor :type
+    attr_accessor :available_balance
+  end
+end

data/lib/ofx_br/balance.rb

@@ -0,0 +1,7 @@
+module OFX
+  class Balance < Foundation
+    attr_accessor :amount
+    attr_accessor :amount_in_pennies
+    attr_accessor :posted_at
+  end
+end

data/lib/ofx_br/errors.rb

@@ -0,0 +1,3 @@
+module OFX
+  class UnsupportedFileError < StandardError; end
+end

data/lib/ofx_br/foundation.rb

@@ -0,0 +1,9 @@
+module OFX
+  class Foundation
+    def initialize(attrs)
+      attrs.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/ofx_br/parser/ofx102.rb

@@ -0,0 +1,201 @@
+module OFX
+  module Parser
+    class OFX102
+      VERSION = '1.0.2'
+
+      ACCOUNT_TYPES = {
+        'CHECKING' => :checking,
+        'SAVINGS' => :savings,
+        'CREDITLINE' => :creditline,
+        'MONEYMRKT' => :moneymrkt
+      }
+
+      TRANSACTION_TYPES = %w[
+        ATM CASH CHECK CREDIT DEBIT DEP DIRECTDEBIT DIRECTDEP DIV
+        FEE INT OTHER PAYMENT POS REPEATPMT SRVCHG XFER
+      ].each_with_object({}) { |tran_type, hash| hash[tran_type] = tran_type.downcase.to_sym; }
+
+      SEVERITY = {
+        'INFO' => :info,
+        'WARN' => :warn,
+        'ERROR' => :error
+      }
+
+      attr_reader :headers, :body, :html, :date_start, :date_end
+
+      def initialize(options = {})
+        @headers = options[:headers]
+        @body = options[:body]
+        @html = Nokogiri::HTML.parse(body)
+
+        @date_start ||= build_date(@html.search('banktranlist > dtstart').inner_text)
+        @date_end ||= build_date(@html.search('banktranlist > dtend').inner_text)
+      end
+
+      def statements
+        @statements ||= html.search('stmttrnrs, ccstmttrnrs').collect { |node| build_statement(node) }
+      end
+
+      def accounts
+        @accounts ||= html.search('stmttrnrs, ccstmttrnrs').collect { |node| build_account(node) }
+      end
+
+      # DEPRECATED: kept for legacy support
+      def account
+        @account ||= build_account(html.search('stmttrnrs, ccstmttrnrs').first)
+      end
+
+      def sign_on
+        @sign_on ||= build_sign_on
+      end
+
+      def self.parse_headers(header_text)
+        # Change single CR's to LF's to avoid issues with some banks
+        header_text.gsub!(/\r(?!\n)/, "\n")
+
+        # Parse headers. When value is NONE, convert it to nil.
+        headers = header_text.to_enum(:each_line).each_with_object({}) do |line, memo|
+          _, key, value = *line.match(/^(.*?):(.*?)\s*(\r?\n)*$/)
+
+          unless key.nil?
+            memo[key] = value == 'NONE' ? nil : value
+          end
+        end
+
+        return headers unless headers.empty?
+      end
+
+      private
+
+      def build_statement(node)
+        stmrs_node = node.search('stmtrs, ccstmtrs')
+        account = build_account(node)
+        OFX::Statement.new(
+          currency: stmrs_node.search('curdef').inner_text,
+          account: account,
+          transactions: account.transactions,
+          balance: account.balance,
+          available_balance: account.available_balance
+        )
+      end
+
+      def build_account(node)
+        OFX::Account.new({
+                           bank_id: node.search('bankacctfrom > bankid').inner_text,
+                           id: node.search('bankacctfrom > acctid, ccacctfrom > acctid').inner_text,
+                           type: ACCOUNT_TYPES[node.search('bankacctfrom > accttype').inner_text.to_s.upcase],
+                           transactions: build_transactions(node),
+                           balance: build_balance(node),
+                           available_balance: build_available_balance(node),
+                           currency: node.search('stmtrs > curdef, ccstmtrs > curdef').inner_text
+                         })
+      end
+
+      def build_status(node)
+        OFX::Status.new({
+                          code: node.search('code').inner_text.to_i,
+                          severity: SEVERITY[node.search('severity').inner_text],
+                          message: node.search('message').inner_text
+                        })
+      end
+
+      def build_sign_on
+        OFX::SignOn.new({
+                          language: html.search('signonmsgsrsv1 > sonrs > language').inner_text,
+                          fi_id: html.search('signonmsgsrsv1 > sonrs > fi > fid').inner_text,
+                          fi_name: html.search('signonmsgsrsv1 > sonrs > fi > org').inner_text,
+                          status: build_status(html.search('signonmsgsrsv1 > sonrs > status'))
+                        })
+      end
+
+      def build_transactions(node)
+        node.search('banktranlist > stmttrn').collect do |element|
+          build_transaction(element)
+        end
+      end
+
+      def build_transaction(element)
+        occurred_at = begin
+          build_date(element.search('dtuser').inner_text)
+        rescue StandardError
+          nil
+        end
+
+        OFX::Transaction.new({
+                               amount: build_amount(element),
+                               amount_in_pennies: (build_amount(element) * 100).to_i,
+                               fit_id: element.search('fitid').inner_text,
+                               memo: element.search('memo').inner_text,
+                               name: element.search('name').inner_text,
+                               payee: element.search('payee').inner_text,
+                               check_number: element.search('checknum').inner_text,
+                               ref_number: element.search('refnum').inner_text,
+                               posted_at: build_date(element.search('dtposted').inner_text),
+                               occurred_at: occurred_at,
+                               type: build_type(element),
+                               sic: element.search('sic').inner_text
+                             })
+      end
+
+      def build_type(element)
+        TRANSACTION_TYPES[element.search('trntype').inner_text.to_s.upcase]
+      end
+
+      def build_amount(element)
+        to_decimal(element.search('trnamt').inner_text)
+      end
+
+      # Input format is `YYYYMMDDHHMMSS.XXX[gmt offset[:tz name]]`
+      def build_date(date)
+        tz_pattern = /(?:\[([+-]?\d{1,4}):\S{3}\])?\z/
+
+        # Timezone offset handling
+        date.sub!(tz_pattern, '')
+        offset = Regexp.last_match(1)
+
+        if offset
+          # Offset padding
+          _, hours, mins = *offset.match(/\A([+-]?\d{1,2})(\d{0,2})?\z/)
+          offset = format('%+03d%02d', hours.to_i, mins.to_i)
+        else
+          offset = '+0000'
+        end
+
+        date << " #{offset}"
+
+        Time.parse(date)
+      end
+
+      def build_balance(node)
+        amount = to_decimal(node.search('ledgerbal > balamt').inner_text)
+        posted_at = begin
+          build_date(node.search('ledgerbal > dtasof').inner_text)
+        rescue StandardError
+          nil
+        end
+
+        OFX::Balance.new({
+                           amount: amount,
+                           amount_in_pennies: (amount * 100).to_i,
+                           posted_at: posted_at
+                         })
+      end
+
+      def build_available_balance(node)
+        if node.search('availbal').size > 0
+          amount = to_decimal(node.search('availbal > balamt').inner_text)
+
+          OFX::Balance.new({
+                             amount: amount,
+                             amount_in_pennies: (amount * 100).to_i,
+                             posted_at: build_date(node.search('availbal > dtasof').inner_text)
+                           })
+        end
+      end
+
+      def to_decimal(amount)
+        BigDecimal(amount.to_s.gsub(',', '.'))
+      end
+    end
+  end
+end

data/lib/ofx_br/parser/ofx103.rb

@@ -0,0 +1,7 @@
+module OFX
+  module Parser
+    class OFX103 < OFX102
+      VERSION = "1.0.3"
+    end
+  end
+end

data/lib/ofx_br/parser/ofx211.rb

@@ -0,0 +1,40 @@
+module OFX
+  module Parser
+    class OFX211 < OFX102
+      VERSION = "2.1.1"
+
+      def self.parse_headers(header_text)
+        doc = Nokogiri::XML(header_text)
+
+        # Nokogiri can't search for processing instructions, so we
+        # need to do this manually.
+        doc.children.each do |e|
+          if e.type == Nokogiri::XML::Node::PI_NODE && e.name == "OFX"
+            # Getting the attributes from the element doesn't seem to
+            # work either.
+            return extract_headers(e.text)
+          end
+        end
+
+        nil
+      end
+
+      private
+      def self.extract_headers(text)
+        headers = {}
+        text.split(/\s+/).each do |attr_text|
+          match = /(.+)="(.+)"/.match(attr_text)
+          next unless match
+          k, v = match[1], match[2]
+          headers[k] = v
+        end
+        headers
+      end
+
+      def self.strip_quotes(s)
+        return unless s
+        s.sub(/^"(.*)"$/, '\1')
+      end
+    end
+  end
+end

data/lib/ofx_br/parser.rb

@@ -0,0 +1,72 @@
+module OFX
+  module Parser
+    class Base
+      attr_reader :headers
+      attr_reader :body
+      attr_reader :content
+      attr_reader :parser
+
+      def initialize(resource)
+        resource = open_resource(resource)
+        resource.rewind
+        begin
+          @content = convert_to_utf8(resource.read)
+          @headers, @body = prepare(content)
+        rescue
+          raise OFX::UnsupportedFileError
+        end
+
+        case headers["VERSION"]
+        when /102/ then
+          @parser = OFX102.new(:headers => headers, :body => body)
+        when /103/ then
+          @parser = OFX103.new(:headers => headers, :body => body)
+        when /200|202|211|220/ then
+          @parser = OFX211.new(:headers => headers, :body => body)
+        else
+          raise OFX::UnsupportedFileError
+        end
+      end
+
+      def open_resource(resource)
+        if resource.respond_to?(:read)
+          resource
+        else
+          open(resource)
+        end
+      rescue
+        StringIO.new(resource)
+      end
+
+      private
+      def prepare(content)
+        # split headers & body
+        header_text, body = content.dup.split(/<OFX>/, 2)
+
+        raise OFX::UnsupportedFileError unless body
+
+        # Header format is different between versions. Give each
+        # parser a chance to parse the headers.
+        headers = nil
+
+        OFX::Parser.constants.grep(/OFX/).each do |name|
+          headers = OFX::Parser.const_get(name).parse_headers(header_text)
+          break if headers
+        end
+
+        # Replace body tags to parse it with Nokogiri
+        body.gsub!(/>\s+</m, "><")
+        body.gsub!(/\s+</m, "<")
+        body.gsub!(/>\s+/m, ">")
+        body.gsub!(/<(\w+?)>([^<]+)/m, '<\1>\2</\1>')
+
+        [headers, body]
+      end
+
+      def convert_to_utf8(string)
+        return string if Kconv.isutf8(string)
+        string.encode("UTF-8", "ISO-8859-1")
+      end
+    end
+  end
+end

data/lib/ofx_br/sign_on.rb

@@ -0,0 +1,8 @@
+module OFX
+  class SignOn < Foundation
+    attr_accessor :language
+    attr_accessor :fi_id
+    attr_accessor :fi_name
+    attr_accessor :status
+  end
+end

data/lib/ofx_br/statement.rb

@@ -0,0 +1,5 @@
+module OFX
+  class Statement < Foundation
+    attr_accessor :account, :available_balance, :balance, :currency, :transactions
+  end
+end

data/lib/ofx_br/status.rb

@@ -0,0 +1,12 @@
+module OFX
+  # Error Reporting Aggregate
+  class Status < Foundation
+    attr_accessor :code     # Error code
+    attr_accessor :severity # Severity of the error
+    attr_accessor :message  # Textual explanation
+
+    def success?
+      code == 0
+    end
+  end
+end

data/lib/ofx_br/transaction.rb

@@ -0,0 +1,16 @@
+module OFX
+  class Transaction < Foundation
+    attr_accessor :amount
+    attr_accessor :amount_in_pennies
+    attr_accessor :check_number
+    attr_accessor :fit_id
+    attr_accessor :memo
+    attr_accessor :name
+    attr_accessor :payee
+    attr_accessor :posted_at
+    attr_accessor :occurred_at
+    attr_accessor :ref_number
+    attr_accessor :type
+    attr_accessor :sic
+  end
+end

data/lib/ofx_br/version.rb

@@ -0,0 +1,8 @@
+module OFX
+  module Version
+    MAJOR = 0
+    MINOR = 3
+    PATCH = 3
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/lib/ofx_br.rb

@@ -0,0 +1,33 @@
+require 'open-uri'
+require 'nokogiri'
+require 'bigdecimal'
+
+require 'kconv'
+
+require 'ofx_br/errors'
+require 'ofx_br/parser'
+require 'ofx_br/parser/ofx102'
+require 'ofx_br/parser/ofx103'
+require 'ofx_br/parser/ofx211'
+require 'ofx_br/foundation'
+require 'ofx_br/balance'
+require 'ofx_br/account'
+require 'ofx_br/sign_on'
+require 'ofx_br/status'
+require 'ofx_br/statement'
+require 'ofx_br/transaction'
+require 'ofx_br/version'
+
+def OFX(resource, &block)
+  parser = OFX::Parser::Base.new(resource).parser
+
+  if block_given?
+    if block.arity == 1
+      yield parser
+    else
+      parser.instance_eval(&block)
+    end
+  end
+
+  parser
+end

data/ofx_br.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path('lib', __dir__)
+require 'ofx_br/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ofx_br'
+  s.version     = OFX::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nando Vieira', 'Anna Cruz']
+  s.email       = ['fnando.vieira@gmail.com', 'anna.cruz@gmail.com']
+  s.homepage    = 'http://rubygems.org/gems/ofx'
+  s.summary     = 'A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports OFX 102, 200 and 211.'
+  s.description = <<~TXT
+        A simple OFX (Open Financial Exchange) parser built on top of Nokogiri.
+        Currently supports OFX 102, 200 and 211.
+    #{'    '}
+        Usage:
+    #{'    '}
+          OFX("sample.ofx") do |ofx|
+            p ofx
+          end
+  TXT
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'nokogiri'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.10'
+end