banker-ofx 0.4.0

data/spec/ofx/account_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe OFX::Account do
+  describe "accounts" do
+    let(:file) { "spec/fixtures/sample.ofx" }
+    let(:ofx) { OFX::Parser::Base.new(file) }
+    let(:parser) { ofx.parser }
+    let(:accounts) { parser.bank_accounts }
+
+    context 'multiple accounts' do
+      let(:file) { "spec/fixtures/many_debit_accounts.ofx" }
+
+      it { accounts.should be_an_instance_of(Array) }
+      it { accounts.size.should eql(3) }
+    end
+
+    context 'debit' do
+      subject { accounts.first }
+
+      context 'keys' do
+        it { subject.should respond_to(:bank_id) }
+        it { subject.should respond_to(:id) }
+        it { subject.should respond_to(:type) }
+        it { subject.should respond_to(:transactions) }
+        it { subject.should respond_to(:balance) }
+        it { subject.should respond_to(:currency) }
+      end
+
+      context 'values' do
+        it { subject.currency.should eql("BRL") }
+        it { subject.bank_id.should eql("0356") }
+        it { subject.id.should eql("03227113109") }
+        it { subject.type.should eql(:checking) }
+        it { subject.transactions.should be_an_instance_of(Array) }
+        it { subject.transactions.size.should eql(36) }
+        it { subject.balance.amount.should eql(598.44) }
+        it { subject.balance.amount_in_pennies.should eql(59844) }
+        it { subject.balance.posted_at.should eql(Time.parse("2009-11-01")) }
+      end
+    end
+
+    context 'credit' do
+      let(:file) { "spec/fixtures/v211.ofx" }
+      let(:accounts) { parser.credit_cards }
+      subject { accounts.first }
+
+      context 'keys' do
+        it { subject.should respond_to(:id) }
+        it { subject.should respond_to(:transactions) }
+        it { subject.should respond_to(:balance) }
+        it { subject.should respond_to(:currency) }
+      end
+
+      context 'values' do
+        it { subject.currency.should eql("USD") }
+        it { subject.id.should eql("123412341234") }
+        it { subject.transactions.should be_an_instance_of(Array) }
+        it { subject.transactions.size.should eql(2) }
+        it { subject.balance.amount.should eql(-562.0) }
+        it { subject.balance.amount_in_pennies.should eql(-56200) }
+        it { subject.balance.posted_at.should eql(Time.parse("2005-08-31 16:51:53 +0100")) }
+      end
+    end
+
+
+  end
+end

data/spec/ofx/ofx102_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe OFX::Parser::OFX102 do
+  let(:file) { "spec/fixtures/sample.ofx" }
+  let(:ofx) { OFX::Parser::Base.new(file) }
+  let(:parser) { ofx.parser }
+  let(:accounts) { parser.bank_accounts }
+  let(:account) { accounts.first }
+
+  it "have a version" do
+    OFX::Parser::OFX102::VERSION.should eql("1.0.2")
+  end
+
+  it "set headers" do
+    parser.headers.should eql(ofx.headers)
+  end
+
+  it "trim trailing whitespace from headers" do
+    headers = OFX::Parser::OFX102.parse_headers("VERSION:102   ")
+    headers["VERSION"].should eql("102")
+  end
+
+  it "set body" do
+    parser.body.should eql(ofx.body)
+  end
+
+  it "set account" do
+    account.should be_an_instance_of(OFX::Account)
+  end
+
+  it "know about all transaction types" do
+    valid_types = [
+      'CREDIT', 'DEBIT', 'INT', 'DIV', 'FEE', 'SRVCHG', 'DEP', 'ATM', 'POS', 'XFER',
+      'CHECK', 'PAYMENT', 'CASH', 'DIRECTDEP', 'DIRECTDEBIT', 'REPEATPMT', 'OTHER'
+    ]
+
+    valid_types.sort.should eql(OFX::Parser::OFX102::TRANSACTION_TYPES.keys.sort)
+
+    valid_types.each do |transaction_type|
+      transaction_type.downcase.to_sym.should eql(OFX::Parser::OFX102::TRANSACTION_TYPES[transaction_type])
+    end
+  end
+
+end

data/spec/ofx/ofx211_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe OFX::Parser::OFX211 do
+  let(:file) { "spec/fixtures/v211.ofx" }
+  let(:ofx) { OFX::Parser::Base.new(file) }
+  let(:parser) { ofx.parser }
+  let(:accounts) { parser.bank_accounts }
+  let(:account) { accounts.first }
+
+  it "have a version" do
+    OFX::Parser::OFX211::VERSION.should eql("2.1.1")
+  end
+
+  it "set headers" do
+    parser.headers.should eql(ofx.headers)
+  end
+
+  it "set body" do
+    parser.body.should eql(ofx.body)
+  end
+
+  it "set account" do
+    account.should be_an_instance_of(OFX::Account)
+  end
+
+  context "transactions" do
+    let(:transactions) { account.transactions }
+
+    context "first" do
+      let(:transaction) { transactions[0] }
+
+      it "contain the correct values" do
+        transaction.amount.should eql(-80)
+        transaction.fit_id.should eql("219378")
+        transaction.memo.should be_empty
+        transaction.posted_at.should eql(Time.parse("2005-08-24 08:00:00"))
+        transaction.name.should eql("FrogKick Scuba Gear")
+      end
+    end
+  end
+end
+

data/spec/ofx/ofx_parser_spec.rb

@@ -0,0 +1,110 @@
+require "spec_helper"
+
+describe OFX::Parser do
+  let(:file) { "spec/fixtures/sample.ofx" }
+  let(:ofx) { OFX::Parser::Base.new(file) }
+
+  it { ofx.should respond_to(:headers) }
+  it { ofx.should respond_to(:body) }
+  it { ofx.should respond_to(:content) }
+  it { ofx.should respond_to(:parser) }
+
+  context 'file path' do
+    it { ofx.content.should_not be_nil }
+  end
+
+  context 'file handler' do
+    let(:file) { open("spec/fixtures/sample.ofx") }
+
+    subject { ofx.content }
+
+    it { subject.should_not be_nil }
+  end
+
+  context 'file context' do
+    let(:file) { open("spec/fixtures/sample.ofx").read }
+
+    subject { ofx.content }
+
+    it { subject.should_not be_nil }
+  end
+
+  context 'content' do
+    subject { ofx.content }
+
+    it "set content" do
+      subject.should eql(open("spec/fixtures/sample.ofx").read)
+    end
+  end
+
+  context 'body' do
+    subject { ofx.body }
+
+    it "set body" do
+      subject.should_not be_nil
+    end
+  end
+
+  context 'encoding' do
+    let(:file) { "spec/fixtures/utf8.ofx" }
+
+    subject { ofx.content }
+
+    it "work with UTF8 and Latin1 encodings" do
+      subject.should eql(open("spec/fixtures/utf8.ofx", "r:iso-8859-1:utf-8").read)
+    end
+  end
+
+  context 'error handing' do
+    context 'invalid ofx' do
+      let(:file) { "spec/fixtures/invalid_version.ofx" }
+
+      it "raise exception when trying to parse an unsupported OFX version" do
+        lambda { ofx }.should raise_error(OFX::UnsupportedFileError)
+      end
+    end
+
+    context 'invalid file type' do
+      let(:file) { "spec/fixtures/avatar.gif" }
+
+      it "raise exception when trying to parse an unsupported OFX version" do
+        lambda { ofx }.should raise_error(OFX::UnsupportedFileError)
+      end
+    end
+  end
+
+  describe "headers" do
+
+    subject { ofx.headers }
+
+    context 'should have' do
+      it { subject["OFXHEADER"].should eql("100") }
+      it { subject["DATA"].should eql("OFXSGML") }
+      it { subject["VERSION"].should eql("102") }
+      it { subject.should have_key("SECURITY") }
+      it { subject["SECURITY"].should be_nil }
+      it { subject["ENCODING"].should eql("USASCII") }
+      it { subject["CHARSET"].should eql("1252") }
+      it { subject.should have_key("COMPRESSION") }
+      it { subject["COMPRESSION"].should be_nil }
+      it { subject.should have_key("OLDFILEUID") }
+      it { subject["OLDFILEUID"].should be_nil }
+      it { subject.should have_key("NEWFILEUID") }
+      it { subject["NEWFILEUID"].should be_nil }
+    end
+
+    context 'CR LF Headers' do
+      let(:file) { ofx_with_carriage_return }
+
+      it "should parse headers with CR and without LF" do
+        subject.size.should eql(9)
+      end
+
+      def ofx_with_carriage_return
+        header = %{OFXHEADER:100\rDATA:OFXSGML\rVERSION:102\rSECURITY:NONE\rENCODING:USASCII\rCHARSET:1252\rCOMPRESSION:NONE\rOLDFILEUID:NONE\rNEWFILEUID:NONE\r}
+        body   = open("spec/fixtures/sample.ofx").read.split(/<OFX>/, 2)[1]
+        header + "<OFX>" + body
+      end
+    end
+  end
+end

data/spec/ofx/ofx_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe OFX do
+  describe "#OFX" do
+    it "should yield an OFX instance" do
+      OFX("spec/fixtures/sample.ofx") do |ofx|
+        ofx.class.should == OFX::Parser::OFX102
+      end
+    end
+
+    it "should be an OFX instance" do
+      OFX("spec/fixtures/sample.ofx") do
+        self.class.should == OFX::Parser::OFX102
+      end
+    end
+
+    it "should return parser" do
+      OFX("spec/fixtures/sample.ofx").class.should == OFX::Parser::OFX102
+    end
+  end
+end

data/spec/ofx/transaction_spec.rb

@@ -0,0 +1,137 @@
+require "spec_helper"
+
+describe OFX::Transaction do
+  let(:file) { "spec/fixtures/sample.ofx" }
+  let(:ofx) { OFX::Parser::Base.new(file) }
+  let(:parser) { ofx.parser }
+  let(:accounts) { parser.bank_accounts }
+  let(:account) { accounts.first }
+
+  context "debit" do
+    let(:transaction) { account.transactions[0] }
+
+    it "set amount" do
+      transaction.amount.should eql(-35.34)
+    end
+
+    it "cast amount to BigDecimal" do
+      transaction.amount.class.should eql(BigDecimal)
+    end
+
+    it "set amount in pennies" do
+      transaction.amount_in_pennies.should eql(-3534)
+    end
+
+    it "set fit id" do
+      transaction.fit_id.should eql("200910091")
+    end
+
+    it "set memo" do
+      transaction.memo.should eql("COMPRA VISA ELECTRON")
+    end
+
+    it "set check number" do
+      transaction.check_number.should eql("0001223")
+    end
+
+    it "have date" do
+      transaction.posted_at.should eql(Time.parse("2009-10-09 08:00:00"))
+    end
+
+    it "have type" do
+      transaction.type.should eql(:debit)
+    end
+  end
+
+  context "credit" do
+    let(:transaction) { account.transactions[1] }
+
+    it "set amount" do
+      transaction.amount.should eql(60.39)
+    end
+
+    it "set amount in pennies" do
+      transaction.amount_in_pennies.should eql(6039)
+    end
+
+    it "set fit id" do
+      transaction.fit_id.should eql("200910162")
+    end
+
+    it "set memo" do
+      transaction.memo.should eql("DEPOSITO POUP.CORRENTE")
+    end
+
+    it "set check number" do
+      transaction.check_number.should eql("0880136")
+    end
+
+    it "have date" do
+      transaction.posted_at.should eql(Time.parse("2009-10-16 08:00:00"))
+    end
+
+    it "have type" do
+      transaction.type.should eql(:credit)
+    end
+  end
+
+  context "with more info" do
+    let(:transaction) { account.transactions[2] }
+
+    it "set payee" do
+      transaction.payee.should eql("Pagto conta telefone")
+    end
+
+    it "set check number" do
+      transaction.check_number.should eql("000000101901")
+    end
+
+    it "have date" do
+      transaction.posted_at.should eql(Time.parse("2009-10-19 12:00:00"))
+    end
+
+    it "have type" do
+      transaction.type.should eql(:other)
+    end
+
+    it "have reference number" do
+      transaction.ref_number.should eql("101.901")
+    end
+  end
+
+  context "with name" do
+    let(:transaction) { account.transactions[3] }
+
+    it "set name" do
+      transaction.name.should eql("Pagto conta telefone")
+    end
+  end
+
+  context "with other types" do
+    let(:file) { "spec/fixtures/bb.ofx" }
+
+    context 'dep' do
+      let(:transaction) { account.transactions[9] }
+
+      it { transaction.type.should eql(:dep) }
+    end
+
+    context 'xfer' do
+      let(:transaction) { account.transactions[18] }
+
+      it { transaction.type.should eql(:xfer) }
+    end
+
+    context 'cash' do
+      let(:transaction) { account.transactions[45] }
+
+      it { transaction.type.should eql(:cash) }
+    end
+
+    context 'check' do
+      let(:transaction) { account.transactions[0] }
+
+      it { transaction.type.should eql(:check) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+unless ENV['TRAVIS']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec'
+  end
+end
+
+require 'rspec'
+require "ofx"
+
+RSpec.configure do |config|
+  config.order = :rand
+  config.color_enabled = true
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
+RSpec::Matchers.define :have_key do |key|
+  match do |hash|
+    hash.respond_to?(:keys) &&
+    hash.keys.kind_of?(Array) &&
+    hash.keys.include?(key)
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: banker-ofx
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Welsby
+- Chuck Hardy
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple OFX (Open Financial Exchange) parser built on top of Nokogiri.
+  Currently supports OFX 102, 200 and 211.
+email:
+- app@britishruby.com
+- fnando.vieira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/ofx.rb
+- lib/ofx/account.rb
+- lib/ofx/balance.rb
+- lib/ofx/errors.rb
+- 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
+- spec/fixtures/avatar.gif
+- spec/fixtures/bb.ofx
+- spec/fixtures/invalid_version.ofx
+- spec/fixtures/many_debit_accounts.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
+- spec/spec_helper.rb
+homepage: https://github.com/BritRuby/Banker-OFX
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+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/many_debit_accounts.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
+- spec/spec_helper.rb