ofx 0.2.9 → 0.3.0

data/Gemfile.lock

@@ -1,29 +1,41 @@
 PATH
   remote: .
   specs:
-    ofx (0.2.8)
+    ofx (0.2.9)
       nokogiri
 
 GEM
   remote: http://rubygems.org/
   specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.2)
     diff-lcs (1.1.2)
-    nokogiri (1.4.3.1)
-    rspec (2.0.0)
-      rspec-core (= 2.0.0)
-      rspec-expectations (= 2.0.0)
-      rspec-mocks (= 2.0.0)
-    rspec-core (2.0.0)
-    rspec-expectations (2.0.0)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0)
-      rspec-core (= 2.0.0)
-      rspec-expectations (= 2.0.0)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    nokogiri (1.4.4)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  nokogiri
   ofx!
-  rspec (>= 2.0.0)
+  rspec (~> 2.0)
+  ruby-debug19

data/lib/ofx.rb

@@ -1,5 +1,6 @@
 require "open-uri"
 require "nokogiri"
+require "bigdecimal"
 
 require "iconv"
 require "kconv"
@@ -7,6 +8,7 @@ require "kconv"
 require "ofx/errors"
 require "ofx/parser"
 require "ofx/parser/ofx102"
+require "ofx/parser/ofx211"
 require "ofx/foundation"
 require "ofx/balance"
 require "ofx/account"

data/lib/ofx/parser.rb

@@ -7,9 +7,9 @@ module OFX
       attr_reader :parser
 
       def initialize(resource)
-          resource = open_resource(resource)
-          resource.rewind
-          @content = convert_to_utf8(resource.read)
+        resource = open_resource(resource)
+        resource.rewind
+        @content = convert_to_utf8(resource.read)
 
         begin
           @headers, @body = prepare(content)
@@ -17,10 +17,11 @@ module OFX
           raise OFX::UnsupportedFileError
         end
 
-
-        case @headers["VERSION"]
-        when "102" then
-          @parser = OFX::Parser::OFX102.new(:headers => headers, :body => body)
+        case headers["VERSION"]
+        when /102/ then
+          @parser = OFX102.new(:headers => headers, :body => body)
+        when /200|211/ then
+          @parser = OFX211.new(:headers => headers, :body => body)
         else
           raise OFX::UnsupportedFileError
         end
@@ -28,37 +29,34 @@ module OFX
 
       def open_resource(resource)
         if resource.respond_to?(:read)
-          return resource
+          resource
         else
-          begin
-            return open(resource)
-          rescue
-            return StringIO.new(resource)
-          end
+          open(resource)
         end
+      rescue Exception
+        StringIO.new(resource)
       end
 
       private
       def prepare(content)
-        # Split headers & body
-        headers, body = content.dup.split(/<OFX>/, 2)
-
-        # Change single CR's to LF's to avoid issues with some banks
-        headers.gsub!(/\r(?!\n)/, "\n")
+        # split headers & body
+        header_text, body = content.dup.split(/<OFX>/, 2)
 
         raise OFX::UnsupportedFileError unless body
 
-        # Parse headers. When value is NONE, convert it to nil.
-        headers = headers.to_enum(:each_line).inject({}) do |memo, line|
-          _, key, value = *line.match(/^(.*?):(.*?)(\r?\n)*$/)
-          memo[key] = value == "NONE" ? nil : value
-          memo
+        # 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!(/>\s+</m, "><")
+        body.gsub!(/\s+</m, "<")
+        body.gsub!(/>\s+/m, ">")
         body.gsub!(/<(\w+?)>([^<]+)/m, '<\1>\2</\1>')
 
         [headers, body]
@@ -66,8 +64,8 @@ module OFX
 
       def convert_to_utf8(string)
         return string if Kconv.isutf8(string)
-        Iconv.conv('UTF-8', 'LATIN1//IGNORE', string)
+        Iconv.conv("UTF-8", "LATIN1//IGNORE", string)
       end
     end
   end
-end
+end

data/lib/ofx/parser/ofx102.rb

@@ -1,5 +1,3 @@
-require "bigdecimal"
-
 module OFX
   module Parser
     class OFX102
@@ -33,6 +31,24 @@ module OFX
         @account ||= build_account
       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).inject({}) do |memo, line|
+          _, key, value = *line.match(/^(.*?):(.*?)\s*(\r?\n)*$/)
+
+          unless key.nil?
+            memo[key] = value == "NONE" ? nil : value
+          end
+
+          memo
+        end
+
+        return headers unless headers.empty?
+      end
+
       private
       def build_account
         OFX::Account.new({
@@ -57,6 +73,7 @@ module OFX
           :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,

data/lib/ofx/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/transaction.rb

@@ -5,9 +5,10 @@ module OFX
     attr_accessor :check_number
     attr_accessor :fit_id
     attr_accessor :memo
+    attr_accessor :name
     attr_accessor :payee
     attr_accessor :posted_at
     attr_accessor :ref_number
     attr_accessor :type
   end
-end
+end

data/lib/ofx/version.rb

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

data/ofx.gemspec

@@ -9,10 +9,10 @@ Gem::Specification.new do |s|
   s.authors     = ["Nando Vieira"]
   s.email       = ["fnando.vieira@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 1.0.2."
+  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 1.0.2.
+Currently supports OFX 102, 200 and 211.
 
 Usage:
 
@@ -27,5 +27,6 @@ TXT
   s.require_paths = ["lib"]
 
   s.add_dependency "nokogiri"
-  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "ruby-debug19"
 end

data/spec/fixtures/invalid_version.ofx

@@ -2,7 +2,7 @@
 
 OFXHEADER:100
 DATA:OFXSGML
-VERSION:200
+VERSION:300
 SECURITY:NONE
 ENCODING:USASCII
 CHARSET:1252

data/spec/fixtures/sample.ofx

@@ -71,6 +71,7 @@ NEWFILEUID:NONE
 						<TRNAMT>-126.13
 						<FITID>200910131
 						<CHECKNUM>0001511
+						<NAME>Pagto conta telefone</NAME>
 						<MEMO>TITULO COBRANCA-IB
 					</STMTTRN><STMTTRN>
 						<TRNTYPE>DEBIT

data/spec/fixtures/v211.ofx

@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="US-ASCII"?>
+
+<!-- This example is taken from the 2.1.1 specification, pages 610-612 -->
+<?OFX OFXHEADER="200" VERSION="211" SECURITY="NONE" OLDFILEUID="NONE" NEWFILEUID="NONE"?>
+<OFX> 
+  <SIGNONMSGSRSV1>
+    <SONRS> 
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY> 
+      </STATUS>
+      <DTSERVER>20050831165153.000[-8:PST]</DTSERVER>
+      <LANGUAGE>ENG</LANGUAGE> 
+    </SONRS>
+  </SIGNONMSGSRSV1> 
+  <BANKMSGSRSV1>
+    <STMTTRNRS> 
+      <TRNUID>0</TRNUID> 
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY> 
+      </STATUS>
+      <STMTRS> 
+        <CURDEF>USD</CURDEF> 
+        <BANKACCTFROM>
+          <BANKID>000000123</BANKID> 
+          <ACCTID>123456</ACCTID> 
+          <ACCTTYPE>CHECKING</ACCTTYPE>
+        </BANKACCTFROM> 
+        <BANKTRANLIST>
+          <DTSTART>20040801</DTSTART> 
+          <DTEND>20050831165153.000[-8:PST]</DTEND> 
+          <STMTTRN>
+            <TRNTYPE>POS</TRNTYPE> 
+            <DTPOSTED>20050824080000</DTPOSTED> 
+            <TRNAMT>-80</TRNAMT> 
+            <FITID>219378</FITID> 
+            <NAME>FrogKick Scuba Gear</NAME>
+          </STMTTRN> 
+        </BANKTRANLIST>
+        <LEDGERBAL> 
+          <BALAMT>2156.56</BALAMT> 
+          <DTASOF>20050831165153</DTASOF>
+        </LEDGERBAL> 
+      </STMTRS>
+    </STMTTRNRS> 
+  </BANKMSGSRSV1>
+  <CREDITCARDMSGSRSV1> 
+    <CCSTMTTRNRS>
+      <TRNUID>0</TRNUID> 
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY> 
+      </STATUS>
+      <CCSTMTRS> 
+        <CURDEF>USD</CURDEF> 
+        <CCACCTFROM>
+          <ACCTID>123412341234</ACCTID> 
+        </CCACCTFROM>
+        <BANKTRANLIST> 
+          <DTSTART>20050801</DTSTART> 
+          <DTEND>20050831165153.000[-8:PST]</DTEND> 
+          <STMTTRN>
+            <TRNTYPE>INT</TRNTYPE> 
+            <DTPOSTED>20050811080000</DTPOSTED> 
+            <TRNAMT>-23.00</TRNAMT> 
+            <FITID>219867</FITID> 
+            <NAME>Interest Charge</NAME>
+          </STMTTRN> 
+          <STMTTRN>
+            <TRNTYPE>CREDIT</TRNTYPE> 
+            <DTPOSTED>20050811080000</DTPOSTED> 
+            <TRNAMT>350.00</TRNAMT> 
+            <FITID>219868</FITID>
+            <NAME>Payment - Thank You</NAME> 
+          </STMTTRN>
+        </BANKTRANLIST> 
+        <LEDGERBAL>
+          <BALAMT>-562.00</BALAMT> 
+          <DTASOF>20050831165153</DTASOF>
+        </LEDGERBAL> 
+      </CCSTMTRS>
+    </CCSTMTTRNRS> 
+  </CREDITCARDMSGSRSV1>
+</OFX>

data/spec/ofx/ofx102_spec.rb

@@ -13,7 +13,12 @@ describe OFX::Parser::OFX102 do
   it "should set headers" do
     @parser.headers.should == @ofx.headers
   end
-  
+
+  it "should trim trailing whitespace from headers" do
+    headers = OFX::Parser::OFX102.parse_headers("VERSION:102   ")
+    headers["VERSION"].should == "102"
+  end
+
   it "should set body" do
     @parser.body.should == @ofx.body
   end
@@ -21,4 +26,4 @@ describe OFX::Parser::OFX102 do
   it "should set account" do
     @parser.account.should be_a_kind_of(OFX::Account)
   end
-end
+end

data/spec/ofx/ofx211_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe OFX::Parser::OFX211 do
+  before do
+    @ofx = OFX::Parser::Base.new("spec/fixtures/v211.ofx")
+    @parser = @ofx.parser
+  end
+  
+  it "should have a version" do
+    OFX::Parser::OFX211::VERSION.should == "2.1.1"
+  end
+  
+  it "should set headers" do
+    @parser.headers.should == @ofx.headers
+  end
+  
+  it "should set body" do
+    @parser.body.should == @ofx.body
+  end
+  
+  it "should set account" do
+    @parser.account.should be_a_kind_of(OFX::Account)
+  end
+
+  context "transactions" do
+    before do
+      @transactions = @parser.account.transactions
+    end
+
+    # Test file contains only three transactions. Let's just check
+    # them all.
+    context "first" do
+      before do
+        @t = @transactions[0]
+      end
+
+      it "should contain the correct values" do
+        @t.amount.should == -80
+        @t.fit_id.should == "219378"
+        @t.memo.should be_empty
+        @t.posted_at.should == Time.parse("2005-08-24 08:00:00")
+        @t.name.should == "FrogKick Scuba Gear"
+      end
+    end
+
+    context "second" do
+      before do
+        @t = @transactions[1]
+      end
+      
+      it "should contain the correct values" do
+        @t.amount.should == -23
+        @t.fit_id.should == "219867"
+        @t.memo.should be_empty
+        @t.posted_at.should == Time.parse("2005-08-11 08:00:00")
+        @t.name.should == "Interest Charge"
+      end
+    end
+    
+    context "third" do
+      before do
+        @t = @transactions[2]
+      end
+      
+      it "should contain the correct values" do
+        @t.amount.should == 350
+        @t.fit_id.should == "219868"
+        @t.memo.should be_empty
+        @t.posted_at.should == Time.parse("2005-08-11 08:00:00")
+        @t.name.should == "Payment - Thank You"
+      end
+    end
+  end
+end
+

data/spec/ofx/transaction_spec.rb

@@ -105,6 +105,16 @@ describe OFX::Transaction do
     end
   end
 
+  context "with name" do
+    before do
+      @transaction = @account.transactions[3]
+    end
+
+    it "should set name" do
+      @transaction.name.should == "Pagto conta telefone"
+    end
+  end
+
   context "with other types" do
 
     before do
@@ -132,7 +142,5 @@ describe OFX::Transaction do
       @transaction = @account.transactions[0]
       @transaction.type.should == :check
     end
-
   end
-
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 9
-  version: 0.2.9
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nando Vieira
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 00:00:00 -02:00
+date: 2011-01-25 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,18 +36,30 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 2
         - 0
-        - 0
-        version: 2.0.0
+        version: "2.0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: |
   A simple OFX (Open Financial Exchange) parser built on top of Nokogiri.
-  Currently supports OFX 1.0.2.
+  Currently supports OFX 102, 200 and 211.
   
   Usage:
   
@@ -76,6 +88,7 @@ files:
 - lib/ofx/foundation.rb
 - lib/ofx/parser.rb
 - lib/ofx/parser/ofx102.rb
+- lib/ofx/parser/ofx211.rb
 - lib/ofx/transaction.rb
 - lib/ofx/version.rb
 - ofx.gemspec
@@ -84,8 +97,10 @@ files:
 - spec/fixtures/invalid_version.ofx
 - spec/fixtures/sample.ofx
 - spec/fixtures/utf8.ofx
+- spec/fixtures/v211.ofx
 - spec/ofx/account_spec.rb
 - spec/ofx/ofx102_spec.rb
+- spec/ofx/ofx211_spec.rb
 - spec/ofx/ofx_parser_spec.rb
 - spec/ofx/ofx_spec.rb
 - spec/ofx/transaction_spec.rb
@@ -121,15 +136,17 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports OFX 1.0.2.
+summary: A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports OFX 102, 200 and 211.
 test_files: 
 - spec/fixtures/avatar.gif
 - spec/fixtures/bb.ofx
 - spec/fixtures/invalid_version.ofx
 - spec/fixtures/sample.ofx
 - spec/fixtures/utf8.ofx
+- spec/fixtures/v211.ofx
 - spec/ofx/account_spec.rb
 - spec/ofx/ofx102_spec.rb
+- spec/ofx/ofx211_spec.rb
 - spec/ofx/ofx_parser_spec.rb
 - spec/ofx/ofx_spec.rb
 - spec/ofx/transaction_spec.rb