Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Moving lynofx to a separate repo (from fixofx).

  • Loading branch information...
commit c66ed508ed2d29f43ccc6d8288abb87633120f38 1 parent 454a1f0
@precipice precipice authored
Showing with 489 additions and 1 deletion.
  1. +3 −0  .gitmodules
  2. +202 −0 LICENSE
  3. +96 −1 README.md
  4. +1 −0  fixofx
  5. +187 −0 lynofx.py
View
3  .gitmodules
@@ -0,0 +1,3 @@
+[submodule "fixofx"]
+ path = fixofx
+ url = git://github.com/wesabe/fixofx.git
View
202 LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
View
97 README.md
@@ -1 +1,96 @@
-Nothing here yet.
+# lynofx #
+### Command-line client for OFX requests ("Lynx for OFX") ###
+
+The `lynofx.py` script is a command-line OFX client -- the name is meant to
+suggest "[Lynx](http://lynx.browser.org/) for OFX." This can be very useful when
+testing out OFX connections or debugging a connection to a particular server,
+or just for getting your data out of your bank on the command line.
+
+## Installation ##
+
+Python 2.6 or above is required. The project has not been tested at all with Python 3.
+
+The `lynofx` project depends on another Wesabe repo, `fixofx`.
+`fixofx` is a submodule of the lynofx project as a result.
+
+First, clone the repo from GitHub:
+
+ git clone git://github.com/wesabe/lynofx.git
+
+Then, initial the submodule:
+
+ cd lynofx
+ git submodule init
+ git submodule update
+
+With that you should be good to go.
+
+## Options ##
+
+`lynofx.py` requires a number of options to work. Some of the options ask for
+account information, but many ask for OFX parameters that are required for the
+request. Unfortunately the OFX parameters for different financial institutions
+are not well known, and they are not included with this script. The three values
+needed are the OFX URL, OFX FID, and OFX ORG. One place to look for these values
+is at [the GNUCash wiki](http://wiki.gnucash.org/wiki/OFX_Direct_Connect_Bank_Settings)
+or just searching on Google. If neither of those work, try calling your financial
+institution and asking them; larger credit unions, especially, are sometimes
+willing to help.
+
+Invoke `lynofx.py` with the options for your institution, any other options
+needed, and the action you want to perform. Three actions are supported:
+
+* `profile` -- This returns a profile of the institution. Generally, you don't
+ need this profile for anything, but if you were building an OFX server
+ crawler, the data in the profile would be useful. Also, since you don't
+ need a username or password for the institution to get the profile (usually),
+ the `profile` action is a good "ping" test to see if the server is up and
+ considers your request well-formed. The `profile` action requires the `-f`,
+ `-o`, and `-u` options.
+* `accounts` -- This returns a list of the accounts this institution has for
+ a given username and password. This is very useful, since asking for a
+ statement from an institution requires a lot of the information in the account
+ information list, and sometimes helps show you the expected format for those
+ values when you're making statement requests. (For instance, USAA account
+ numbers are eight digits, but their OFX server expects a ten-digit account
+ number, zero-padded, such as 0012345678. Since the account info response
+ shows the format exactly as they expect it, you can avoid errors by using this
+ value instead of entering the number any other way.) Specifically, the `BANKID`,
+ `ACCTID`, and `ACCTTYPE` fields in the account info list are needed for the
+ `statement` action, below. The `accounts` action requires the `-f`, `-o`, and
+ `-u` options, and a username and password for the institution.
+* `statement` -- This returns a statement for the account requested, including
+ current balances and a list of transactions. See the `accounts` action, above,
+ to learn the required option values for this action. The `statement` action
+ requires the `-f`, `-o`, `-u`, `-b`, `-i`, and `-t` options, and a username
+ and password for the institution.
+
+Use the `lynofx.py` script like this:
+
+ ./lynofx.py [options] (profile|accounts|statement)
+
+The command-line options supported by `lynofx.py` are as follows:
+
+ --version show program's version number and exit
+ -h, --help show this help message and exit
+ -v, --verbose be more talkative, social, outgoing
+ -r, --raw show raw response (don't pretty-print as OFX/2.0)
+ -f FID, --fid=FID OFX ID of the financial institution
+ -o ORG, --org=ORG OFX organization of the financial institution
+ -u URL, --url=URL OFX URL of the financial institution
+ -t ACCTTYPE, --accttype=ACCTTYPE type of the account
+ -i ACCTID, --acctid=ACCTID ID of the account (a.k.a. account number)
+ -b BANKID, --bankid=BANKID ID of the bank (a.k.a. routing number)
+
+The script will prompt for username and password, if required, after it is run.
+
+## Contributing ##
+
+Contributions to lynofx are welcome. Please add tests for your contribution
+and make sure all tests pass before sending a pull request. Here are some
+ideas for things to do:
+
+* Allow the user to specify a username and password from the command line or a
+ config file so the script can be run out of cron.
+* Allow the user to configure the user-agent string and the client identifier claimed.
+* Add options for specifying the date range of the request.
1  fixofx
@@ -0,0 +1 @@
+Subproject commit 1792d94697af682ca1d4a75cfefe98465d95a288
View
187 lynofx.py
@@ -0,0 +1,187 @@
+#!/usr/bin/env python
+
+# Copyright 2005-2010 Wesabe, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#
+# lynofx.py - Issue OFX requests from the command line
+#
+
+import getpass
+import optparse
+import os
+import os.path
+import sys
+import urllib2
+
+sys.path.insert(0, '3rdparty')
+sys.path.insert(0, 'lib')
+
+import ofx
+
+VERSION = "%prog 1.0"
+
+actions = ["profile", "accounts", "statement"]
+
+__doc__ = \
+"""Command-line client for making OFX requests and showing the responses that
+come back. Use option flags to pass the OFX client parameters for the request,
+and then specify the request type as the action. Each financial institution
+has a set of parameters that are needed to make requests; those parameters are
+not provided by this script but must be found elsewhere (for instance, see
+http://wiki.gnucash.org/wiki/OFX_Direct_Connect_Bank_Settings). By default, the
+response will be shown as a pretty-printed OFX/2.0 document, but the raw
+response will be shown instead if the -r/--raw option is passed.
+
+Possible actions are:
+`profile` - get a profile of this OFX server's capabilities.
+`accounts` - get a list of accounts for an authenticated user.
+`statement` - get a single account statement for an authenticated user.
+"""
+
+parser = optparse.OptionParser(usage="%prog [options] (profile|accounts|statement)",
+ version=VERSION, description=__doc__)
+parser.add_option("-v", "--verbose", action="store_true", dest="verbose",
+ default=False, help="be more talkative, social, outgoing")
+parser.add_option("-r", "--raw", action="store_true", dest="raw",
+ default=False, help="show raw response (don't pretty-print as OFX/2.0)")
+parser.add_option("-f", "--fid", dest="fid",
+ help="OFX ID of the financial institution")
+parser.add_option("-o", "--org", dest="org",
+ help="OFX organization of the financial institution")
+parser.add_option("-u", "--url", dest="url",
+ help="OFX URL of the financial institution")
+parser.add_option("-t", "--accttype", dest="accttype",
+ help="type of the account")
+parser.add_option("-i", "--acctid", dest="acctid",
+ help="ID of the account (a.k.a. account number)")
+parser.add_option("-b", "--bankid", dest="bankid",
+ help="ID of the bank (a.k.a. routing number)")
+(options, args) = parser.parse_args()
+
+if len(args) != 1:
+ print "Call lynofx.py with one and only one action (use --help for more info)."
+ sys.exit(1)
+
+action = args[0] # just for clarity
+
+if action not in actions:
+ print "Unrecognized option '%s' (use --help for more info)." % action
+ sys.exit(1)
+
+if options.verbose:
+ print "Using options:"
+ print " action: %s" % action
+ if options.fid: print " fid: %s" % options.fid
+ if options.org: print " org: %s" % options.org
+ if options.url: print " url: %s" % options.url
+ if options.accttype: print " accttype: %s" % options.accttype
+ if options.acctid: print " acctid: %s" % options.acctid
+ if options.bankid: print " bankid: %s" % options.bankid
+ print
+
+# FIXME: should check to make sure all required options for this action were provided.
+
+if action != "profile":
+ # The following allows the username prompt to be written even if output is redirected.
+ # On UNIX and Mac, that is. The sys.stdout fallback should work elsewhere, assuming
+ # people on those other platforms aren't redirecting output like the UNIX-heads are.
+ terminal = None
+ if os.access("/dev/tty", os.W_OK):
+ terminal = open("/dev/tty", 'w')
+ else:
+ terminal = sys.stdout
+ terminal.write("Enter account username: ")
+ username = sys.stdin.readline().rstrip()
+ password = getpass.getpass("Enter account password: ")
+
+institution = ofx.Institution(ofx_org=options.org,
+ ofx_url=options.url,
+ ofx_fid=options.fid)
+
+account = ofx.Account(acct_type=options.accttype,
+ acct_number=options.acctid,
+ aba_number=options.bankid,
+ institution=institution)
+
+try:
+ client = ofx.Client(debug=options.verbose)
+ response = None
+
+ if options.verbose:
+ # Install an HTTP handler with debug output
+ http_handler = urllib2.HTTPHandler(debuglevel=1)
+ https_handler = urllib2.HTTPSHandler(debuglevel=1)
+ opener = urllib2.build_opener(http_handler, https_handler)
+ urllib2.install_opener(opener)
+
+ print "HTTP Debug Output:"
+ print "=================="
+ print
+
+ if action == "profile":
+ response = client.get_fi_profile(institution)
+
+ elif action == "accounts":
+ response = client.get_account_info(institution, username, password)
+
+ elif action == "statement":
+ response = client.get_statement(account, username, password)
+
+ if options.verbose:
+ print
+ print "Request Message:"
+ print "================"
+ print
+ print client.get_request_message()
+ print
+ print "Response Message:"
+ print "================="
+ print
+
+ if options.raw:
+ print response.as_string()
+ else:
+ print response.as_xml()
+
+except ofx.Error, exception:
+ if options.verbose:
+ print
+ print "Request Message:"
+ print "================"
+ print
+ print client.get_request_message()
+ print
+
+ sys.stderr.write("*** Server returned an OFX error:\n")
+ sys.stderr.write(str(exception))
+ sys.stderr.write("\n")
+ sys.exit(3)
+
+except urllib2.HTTPError, exception:
+ if options.verbose:
+ print
+ print "Request Message:"
+ print "================"
+ print
+ print client.get_request_message()
+ print
+
+ sys.stderr.write("*** Server returned an HTTP error:\n")
+ sys.stderr.write(str(exception))
+ sys.stderr.write(str(exception.hdrs))
+ sys.stderr.write(exception.fp.read())
+ sys.stderr.write("\n")
+ sys.exit(4)
+
Please sign in to comment.
Something went wrong with that request. Please try again.