ofxy 0.2.0

Parse OFX files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209

use std::fs::read_dir;
use std::{ffi::OsStr, path::Path, result};
use std::{path::PathBuf, str::FromStr};

use chrono::{TimeZone, Utc};
use rust_decimal::Decimal;

use ofxy::{
    Ofx,
    body::{Currency, TransactionType},
    header::{Encoding, Version},
};

type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;

#[test]
fn test_ofx_sgmlish() -> result::Result<(), Box<dyn std::error::Error>> {
    let input = std::fs::read_to_string("tests/files/sgmlish/example.ofx")
        .expect("unable to read test file");
    let ofx = Ofx::from_str(&input)?;

    let transaction_list = ofx
        .body
        .credit_card
        .expect("missing credit card statement")
        .transaction_response
        .statement
        .bank_transactions
        .expect("missing transaction list");

    assert_eq!(transaction_list.dtstart.unwrap(), "20190501");
    assert_eq!(transaction_list.dtend.unwrap(), "20190531");
    assert_eq!(transaction_list.transactions.len(), 3);

    let trn = &transaction_list.transactions[0];
    assert_eq!(trn.transaction_type, TransactionType::Payment);
    assert_eq!(
        trn.date_posted,
        Utc.with_ymd_and_hms(2019, 5, 10, 0, 0, 0).unwrap()
    );

    assert_eq!(trn.amount, Decimal::from_str("-16.4").unwrap());
    assert_eq!(trn.id, "1DFE2867-0DE3-4357-B865-16986CBFC10A");
    assert_eq!(trn.memo, None);
    assert_eq!(trn.currency, None);

    let trn = &transaction_list.transactions[1];
    assert_eq!(trn.transaction_type, TransactionType::Payment);
    assert_eq!(
        trn.date_posted,
        Utc.with_ymd_and_hms(2019, 5, 12, 0, 0, 0).unwrap()
    );

    assert_eq!(trn.amount, Decimal::from(-10));
    assert_eq!(trn.id, "25518539-814F-4C2C-97E8-3B49A6D48A45");
    assert_eq!(trn.memo.as_deref(), Some("Example International Payment "));
    assert_eq!(
        trn.currency,
        Some(Currency {
            rate: Decimal::from_str("1.1153").unwrap(),
            symbol: "EUR".to_owned(),
        }),
    );

    let trn = &transaction_list.transactions[2];
    assert_eq!(trn.transaction_type, TransactionType::Credit);
    assert_eq!(
        trn.date_posted,
        Utc.with_ymd_and_hms(2019, 5, 20, 0, 0, 0).unwrap()
    );
    assert_eq!(trn.amount, Decimal::from(1_000));
    assert_eq!(trn.id, "3088354E-018B-41D1-ABA7-DB8F66F7B2DB");
    assert_eq!(trn.memo.as_deref(), Some("PAYMENT RECEIVED"));
    assert_eq!(trn.currency, None);

    Ok(())
}

#[test]
fn test_ofx_simple() -> Result<()> {
    let input = std::fs::read_to_string("tests/files/simple.ofx")?;

    let ofx: Ofx = input.parse()?;

    assert_eq!(ofx.header.ofxheader, 100);
    assert_eq!(ofx.header.version, Version::V102);
    assert_eq!(ofx.header.encoding, Encoding::UsAscii);
    assert_eq!(ofx.header.compression, "NONE");

    assert_eq!(
        ofx.body.sign_on.expect("no sign on").response.status.code,
        0
    );

    let transaction_response = ofx
        .body
        .credit_card
        .expect("missing credit card statement")
        .transaction_response;
    assert_eq!(&transaction_response.statement.account.id, "abc123");

    let transactions = transaction_response
        .statement
        .bank_transactions
        .expect("missing bank transactions")
        .transactions;
    assert_eq!(transactions.len(), 4);
    assert_eq!(transactions[0].name, Some("SOME HOSPITAL SOMEWHERE".into()));
    Ok(())
}

fn ofx_files_from_dir(path: impl AsRef<Path>) -> Result<Vec<PathBuf>> {
    Ok(read_dir(path)?
        .filter_map(result::Result::ok)
        .map(|entry| entry.path())
        .filter(|path| {
            matches!(
                path.extension()
                    .and_then(OsStr::to_str)
                    .map(str::to_lowercase)
                    .as_deref(),
                Some("ofx" | "qfx")
            )
        })
        .collect())
}

#[test]
fn parses_files() -> result::Result<(), Box<dyn std::error::Error>> {
    let source_dirs = ["sgmlish", "ofx-reader", "ofxparse", "ofxparser"]
        .into_iter()
        .map(|dir| "tests/files/".to_owned() + dir);

    for dir in source_dirs {
        for entry in ofx_files_from_dir(dir)? {
            let skip_tests = [
                // 'fre' is not a valid ISO 639-1 or 639-3 code.
                "tests/files/ofxparser/ofxdata-oneline.ofx",
                // Language is a required tag per spec; in this test file the
                // tag is present but value is empty. Should this be permitted?
                "tests/files/ofxparse/ofx-v102-empty-tags.ofx",
                // OFX version 2
                "tests/files/ofx-reader/suncorp.ofx",
                "tests/files/ofxparse/anzcc.ofx",
                "tests/files/ofxparse/error_message.ofx",
                "tests/files/ofxparse/multiple_accounts.ofx",
                "tests/files/ofxparse/multiple_accounts2.ofx",
                "tests/files/ofxparse/suncorp.ofx",
                "tests/files/ofxparser/ofx-multiple-accounts-xml.ofx",
                "tests/files/ofxparser/ofxdata-banking-xml200.ofx",
                "tests/files/ofxparser/ofxdata-investments-multiple-accounts-xml.ofx",
                "tests/files/ofxparser/ofxdata-investments-oneline-xml.ofx",
                "tests/files/ofxparser/ofxdata-investments-xml.ofx",
                "tests/files/ofxparser/ofxdata-xml.ofx",
                // Bad datetimes
                //   has `00000000000000` as a date
                "tests/files/ofx-reader/Bradesco.ofx",
                //   bad timezone: `[-:EST]`
                "tests/files/ofxparse/investment_medium.ofx",
                // Non-standard structure with duplicate STMTRS elements in single STMTTRNRS
                "tests/files/ofxparser/ofxdata-bb-two-stmtrs.ofx",
            ];

            if skip_tests.contains(&entry.display().to_string().as_str()) {
                continue;
            }

            let bytes = std::fs::read(&entry)?;
            let mut detector = chardetng::EncodingDetector::new();
            detector.feed(&bytes, true);
            let encoding = detector.guess(None, true);
            let (text, _, had_errors) = encoding.decode(&bytes);
            assert!(!had_errors);

            if let Err(e) = text.parse::<Ofx>() {
                println!("Failed to parse OFX file: {:?}", entry.display());
                panic!("Error: {e:?}");
            }
        }
    }
    Ok(())
}

#[test]
fn test_citi() {
    let input = std::fs::read_to_string("tests/files/citi.ofx").unwrap();
    let ofx: Ofx = input.parse().expect("unable to parse OFX file");
    let transaction_response = ofx
        .body
        .bank
        .expect("missing bank statement")
        .transaction_response;

    assert_eq!(
        transaction_response.statement.account.as_ref().unwrap().id,
        "XXXXXXXXXXXX1234"
    );

    let transactions = transaction_response
        .statement
        .bank_transactions
        .expect("missing bank transactions")
        .transactions;
    assert_eq!(transactions.len(), 3);
    assert_eq!(
        transactions[0].amount,
        Decimal::from_str("-127.15").unwrap()
    );
}