Browse Source

Initial commit

Jakub Valenta 3 years ago
commit
d058ef08fc

+ 202 - 0
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.

+ 13 - 0
NOTICE

@@ -0,0 +1,13 @@
+Copyright 2015 Jakub Valenta
+
+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.

+ 35 - 0
README.md

@@ -0,0 +1,35 @@
+# Account Statement
+
+Retrieve a bank account statement.
+
+Supported banks:
+
+- [Fio](https://www.fio.cz/)
+
+## Installation
+
+This software requires Python 3. See [Pythons's website](https://www.python.org/) for installation instructions.
+
+When you have Python 3 installed, install required packages with pip (Python's package management system):
+
+```
+pip install requests
+```
+
+Then you can call the executable:
+
+```
+./account-statement -h
+```
+
+Or you can install this software as a Python package, which will also install all the dependencies and make the executable available globally:
+
+```
+python setup.py install
+
+account-statement -h
+```
+
+## Contributing
+
+__Feel free to remix this piece of software.__ See [NOTICE](./NOTICE) and [LICENSE](./LICENSE) for license information.

+ 5 - 0
account-statement

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+
+import account_statement.account_statement
+if __name__ == '__main__':
+    account_statement.account_statement.main()

BIN
account_statement/__pycache__/account_statement.cpython-35.pyc


+ 52 - 0
account_statement/account_statement.py

@@ -0,0 +1,52 @@
+import sys
+
+import json
+
+BACKENDS = ['fio']
+DEFAULT_BACKEND = 'fio'
+
+
+def main():
+    import argparse
+
+    parser = argparse.ArgumentParser(
+        description='Account Statement: Retrieve account statement.'
+    )
+    parser.add_argument('--token', '-t', dest='tokenfile', required=True,
+                        help='token file path -- first line is the token '
+                        'string')
+    parser.add_argument('--output', '-o', dest='outputfile',
+                        help='output JSON file path')
+    parser.add_argument('--cache', '-c', dest='cachedir', required=True,
+                        help='cache directory path')
+    parser.add_argument('--backend', '-b', dest='backend',
+                        default=DEFAULT_BACKEND,
+                        help='backend; options: "{}"; defaults to "{}"'.format(
+                            '", "'.join(BACKENDS), DEFAULT_BACKEND))
+    args = parser.parse_args()
+
+    if args.backend not in BACKENDS:
+        print('No such backend "{}". Available backends: "{}".'.format(
+            args.backend,
+            '", "'.join(BACKENDS)))
+        sys.exit(1)
+
+    with open(args.tokenfile, 'r') as f:
+        for line in f.readlines():
+            token = line.strip()
+            break
+        else:
+            token = None
+    if not token:
+        print('File "{}" is empty.'.format(args.tokenfile))
+        sys.exit(1)
+
+    print('Using backend "{}".'.format(args.backend))
+    if args.backend == 'fio':
+        from account_statement.backends import fio
+        obj = fio.read_account_statement(token, args.cachedir)
+
+    with open(args.outputfile, 'w') as f:
+        json.dump(list(obj), f)
+
+    sys.exit()

BIN
account_statement/backends/__pycache__/fio.cpython-35.pyc


+ 107 - 0
account_statement/backends/fio.py

@@ -0,0 +1,107 @@
+import datetime
+import os.path
+
+import json
+import requests
+
+
+def read_account_statement(token,
+                           path_cache_dir,
+                           date_from=datetime.date(year=2016, month=1, day=1),
+                           date_to=datetime.datetime.now().date()):
+    data_cached = read_cached_data(path_cache_dir, date_from, date_to)
+    if data_cached:
+        print('Cached data found.')
+        data = data_cached
+    else:
+        data = fetch_data(token, date_from, date_to)
+    if not data:
+        return None
+    else:
+        write_data_to_cache(path_cache_dir, date_from, date_to, data)
+    return parse_data(data)
+
+
+def format_cache_key(date_from, date_to):
+    return '{date_from}_{date_to}.json'.format(
+        date_from=date_from.strftime('%y%m%d'),
+        date_to=date_to.strftime('%y%m%d')
+    )
+
+
+def read_cached_data(path_cache_dir, date_from, date_to):
+    cache_key = format_cache_key(date_from, date_to)
+    path_cache_file = os.path.join(path_cache_dir, cache_key)
+    print('Reading cache file "{}".'.format(path_cache_file))
+    if os.path.isfile(path_cache_file):
+        with open(path_cache_file, 'r') as f:
+            return f.read()
+    return None
+
+
+def write_data_to_cache(path_cache_dir, date_from, date_to, data):
+    cache_key = format_cache_key(date_from, date_to)
+    path_cache_file = os.path.join(path_cache_dir, cache_key)
+    with open(path_cache_file, 'w') as f:
+        print(data, file=f)
+
+
+def fetch_data(token, date_from, date_to):
+    URL_PATTERN = 'https://www.fio.cz/ib_api/rest/periods/' +\
+                  '{token}/{date_from}/{date_to}/transactions.{data_format}'
+    DATA_FORMAT = 'json'
+
+    url = URL_PATTERN.format(
+        token=token,
+        date_from=date_from.strftime('%Y-%m-%d'),
+        date_to=date_to.strftime('%Y-%m-%d'),
+        data_format=DATA_FORMAT
+    )
+
+    print('Requesting URL "{}".'.format(url))
+
+    r = requests.get(url)
+    if r.status_code != requests.codes.ok:
+        return None
+
+    return r.text
+
+
+def parse_data(data):
+    out = []
+    _json = json.loads(data)
+    balance = _json['accountStatement']['info']['openingBalance']
+    for t in _json['accountStatement']['transactionList']['transaction']:
+        item = dict(
+            date=datetime.date.fromtimestamp(
+                get_trans_prop(t, 'Datum') / 1000).strftime('%Y-%m-%d'),
+            amount=get_trans_prop(t, 'Objem', float),
+            currency=get_trans_prop(t, 'Měna'),
+            account=get_trans_prop(t, 'Protiúčet', int),
+            account_bank=get_trans_prop(t, 'Kód banky', int),
+            bank_name=get_trans_prop(t, 'Název banky'),
+            ks=get_trans_prop(t, 'KS', int),
+            vs=get_trans_prop(t, 'VS', int),
+            ss=get_trans_prop(t, 'SS', int),
+            info=get_trans_prop(t, 'Uživatelská identifikace'),
+            message=get_trans_prop(t, 'Zpráva pro příjemce'),
+            type=get_trans_prop(t, 'Typ'),
+            user=get_trans_prop(t, 'Provedl'),
+            spec=get_trans_prop(t, 'Upřesnění'),
+            comment=get_trans_prop(t, 'Komentář'),
+            bic=get_trans_prop(t, 'BIC'),
+        )
+        balance = balance + item['amount']
+        item['balance'] = balance
+        out.append(item)
+    return out
+
+
+def get_trans_prop(obj, name, transform=None):
+    for _, prop in obj.items():
+        if prop and prop['name'] == name:
+            value = prop['value']
+            if value is not None and transform:
+                return transform(value)
+            return value
+    return None

+ 46 - 0
setup.py

@@ -0,0 +1,46 @@
+from setuptools import setup, find_packages
+from codecs import open
+from os import path
+
+here = path.abspath(path.dirname(__file__))
+
+with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name='account_statements',
+
+    version='1.0.0',
+
+    description='Retrieve a bank account statement',
+    long_description=long_description,
+
+    url='https://lab.saloun.cz/jakub/account-statements',
+
+    author='Jakub Valenta',
+    author_email='jakub@jakubvalenta.cz',
+
+    license='Apache Software License',
+
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Topic :: Artistic Software',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python :: 3',
+    ],
+
+    keywords='',
+
+    packages=find_packages(),
+
+    install_requires=[
+        'requests',
+    ],
+
+    entry_points={
+        'console_scripts': [
+            'account-statement=account_statement.account_statement:main',
+        ],
+    },
+)