statements 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff2b7e3e918329fc0e03bec9e77b195c3843fda6
+  data.tar.gz: 42b4173c2c664d3e510d90946875b7ea0a028772
+SHA512:
+  metadata.gz: 9e4050e7a812a5e0fa47ffd4441f9949e96f78b866b3aadf69547345bc0455c0b70671371e35e68a4b98f293be67874e2d8f956a8cbf8000cc341b01b157ed7b
+  data.tar.gz: 3f5c9a2c5abe973b48468fa660623c8d66de92f987c6168322cbd6ccaf41d163ee3df2a394bca7526ab7781a69b32d9f4fb91a7337ed203d0f3f24cb4543562a

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Neil E. Pearson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+# Statements
+
+Builds a database of bank account transaction history by reading PDF bank statements, and provides a simple web interface for browsing data.
+
+## Installation
+
+```bash
+$ gem install statements
+```
+
+## Usage
+
+1. `cd` to a directory containing all your bank statements.
+2. Run `statements` and wait for new statements to be parsed.
+3. Open `http://localhost:57473` in a browser.
+
+## Supported banks
+
+- St. George Credit Cards
+- St. George Cash Accounts
+
+The list is small. Want it to grow? Send a pull request!

data/bin/statements

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$:.unshift lib unless $:.include? lib
+
+require 'statements'
+
+Statements::Cli.main Dir.pwd, ARGV

data/lib/html/css/main.css

@@ -0,0 +1,115 @@
+.container-fluid {
+  padding-top: 15px; }
+
+#colour a:before {
+  content: "";
+  border: 1px solid transparent;
+  padding: 6px;
+  display: block;
+  border-radius: 15px; }
+#colour a.colour-white:before {
+  background: white; }
+#colour a.colour-red:before {
+  background: #a13f3e; }
+#colour a.colour-yellow:before {
+  background: #e9d543; }
+#colour a.colour-green:before {
+  background: #3f9d5a; }
+#colour a.colour-cyan:before {
+  background: #99d7ff; }
+#colour a.colour-blue:before {
+  background: #48609d; }
+#colour a.colour-magenta:before {
+  background: #af6bd7; }
+
+#content thead th {
+  padding-top: 0; }
+#content td p {
+  margin: 0; }
+  #content td p.small {
+    color: #666; }
+#content .amount,
+#content tfoot tr > * {
+  text-align: right; }
+#content .credit .amount:before {
+  content: "($"; }
+#content .credit .amount:after {
+  content: ")"; }
+#content .debit .amount:before,
+#content tfoot td:before {
+  content: "$"; }
+#content tr.colour-white {
+  background: white; }
+#content tr.colour-red {
+  background: #ffefef; }
+#content tr.colour-yellow {
+  background: #ffffd7; }
+#content tr.colour-green {
+  background: #e9fce7; }
+#content tr.colour-blue {
+  background: #ebeffd; }
+#content tr.colour-cyan {
+  background: #e1f7f7; }
+#content tr.colour-magenta {
+  background: #fbefff; }
+#content tr > td,
+#content tr > th {
+  background: inherit; }
+#content tr.colour-white a.picker,
+#content li.colour-white a {
+  background: white; }
+#content tr.colour-red a.picker,
+#content li.colour-red a {
+  background: #a13f3e; }
+#content tr.colour-green a.picker,
+#content li.colour-green a {
+  background: #3f9d5a; }
+#content tr.colour-blue a.picker,
+#content li.colour-blue a {
+  background: #48609d; }
+#content tr.colour-cyan a.picker,
+#content li.colour-cyan a {
+  background: #99d7ff; }
+#content tr.colour-magenta a.picker,
+#content li.colour-magenta a {
+  background: #af6bd7; }
+#content tr.colour-yellow a.picker,
+#content li.colour-yellow a {
+  background: #e9d543; }
+#content td.colour {
+  width: 20px;
+  position: relative; }
+  #content td.colour a {
+    display: block;
+    border: 1px solid #eee;
+    border-radius: 10px;
+    width: 20px;
+    height: 20px; }
+    #content td.colour a:hover {
+      border-color: #ddd; }
+  #content td.colour ul {
+    list-style: none;
+    position: absolute;
+    display: block;
+    right: 100%;
+    top: 1px;
+    margin-bottom: 0;
+    width: 167px;
+    text-align: right;
+    background: white;
+    border: 1px solid #eee;
+    border-radius: 50px;
+    padding: 3px;
+    height: 28px; }
+    #content td.colour ul li {
+      display: inline-block;
+      margin-right: 3px; }
+      #content td.colour ul li:last-child {
+        margin-right: 0; }
+
+footer {
+  font-size: .8em;
+  text-align: center;
+  padding: 20px 0; }
+
+/*# sourceMappingURL=main.css.map */

data/lib/html/css/main.css.map

@@ -0,0 +1,7 @@
+{
+"version": 3,
+"mappings": "AASA,gBAAiB;EACf,WAAW,EAAE,IAAI;;AAKf,gBAAS;EACP,OAAO,EAAE,EAAE;EACX,MAAM,EAAE,qBAAqB;EAC7B,OAAO,EAAC,GAAG;EACX,OAAO,EAAE,KAAK;EACd,aAAa,EAAE,IAAI;AAErB,6BAAsB;EAAE,UAAU,EArB9B,KAAK;AAsBT,2BAAoB;EAAE,UAAU,EArB9B,OAAO;AAsBT,8BAAuB;EAAE,UAAU,EArB9B,OAAO;AAsBZ,6BAAsB;EAAE,UAAU,EArB9B,OAAO;AAsBX,4BAAqB;EAAE,UAAU,EApB9B,OAAO;AAqBV,4BAAqB;EAAE,UAAU,EAtB9B,OAAO;AAuBV,+BAAwB;EAAE,UAAU,EArB9B,OAAO;;AA2Bf,iBAAS;EACP,WAAW,EAAE,CAAC;AAGhB,aAAK;EACH,MAAM,EAAE,CAAC;EAET,mBAAQ;IACN,KAAK,EAAE,IAAI;AAIf;qBACa;EACX,UAAU,EAAE,KAAK;AAIjB,+BAAS;EAAE,OAAO,EAAE,IAAI;AACxB,8BAAQ;EAAE,OAAO,EAAE,GAAG;AAKtB;wBAAS;EAAE,OAAO,EAAE,GAAG;AAIvB,wBAAe;EACb,UAAU,EA9DkB,KAAK;AAgEnC,sBAAa;EACX,UAAU,EAhEgB,OAAO;AAkEnC,yBAAgB;EACd,UAAU,EAlEmB,OAAO;AAoEtC,wBAAe;EACb,UAAU,EApEkB,OAAO;AAsErC,uBAAc;EACZ,UAAU,EAtEiB,OAAO;AAwEpC,uBAAc;EACZ,UAAU,EAxEiB,OAAO;AA0EpC,0BAAiB;EACf,UAAU,EA1EoB,OAAO;AA4EvC;gBACK;EACH,UAAU,EAAE,OAAO;AAIvB;0BACkB;EAChB,UAAU,EA1FN,KAAK;AA6FX;wBACgB;EACd,UAAU,EA9FR,OAAO;AAiGX;0BACkB;EAChB,UAAU,EAjGN,OAAO;AAoGb;yBACiB;EACf,UAAU,EArGP,OAAO;AAwGZ;yBACiB;EACf,UAAU,EAzGP,OAAO;AA4GZ;4BACoB;EAClB,UAAU,EA7GJ,OAAO;AAgHf;2BACmB;EACjB,UAAU,EAtHL,OAAO;AAyHd,kBAAU;EACR,KAAK,EAAE,IAAI;EACX,QAAQ,EAAE,QAAQ;EAElB,oBAAE;IACA,OAAO,EAAE,KAAK;IACd,MAAM,EAAE,cAAc;IACtB,aAAa,EAAE,IAAI;IACnB,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IAEZ,0BAAQ;MACN,YAAY,EAAE,IAAI;EAItB,qBAAG;IACD,UAAU,EAAE,IAAI;IAChB,QAAQ,EAAE,QAAQ;IAClB,OAAO,EAAE,KAAK;IACd,KAAK,EAAE,IAAI;IACX,GAAG,EAAE,GAAG;IACR,aAAa,EAAE,CAAC;IAChB,KAAK,EAAE,KAAK;IACZ,UAAU,EAAE,KAAK;IACjB,UAAU,EAAE,KAAK;IACjB,MAAM,EAAE,cAAc;IACtB,aAAa,EAAE,IAAI;IACnB,OAAO,EAAE,GAAG;IACZ,MAAM,EAAE,IAAI;IAEZ,wBAAG;MACD,OAAO,EAAE,YAAY;MACrB,YAAY,EAAE,GAAG;MAEjB,mCAAa;QACX,YAAY,EAAE,CAAC;;AAQzB,MAAO;EACL,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,MAAM;EAClB,OAAO,EAAE,MAAM",
+"sources": ["main.scss"],
+"names": [],
+"file": "main.css"
+}

data/lib/html/css/main.scss

@@ -0,0 +1,173 @@
+// Colours
+$white: white;      $light-white: white;
+$red: #a13f3e;      $light-red: #ffefef;
+$yellow: #e9d543;   $light-yellow: #ffffd7;
+$green: #3f9d5a;    $light-green: #e9fce7;
+$blue: #48609d;     $light-blue: #ebeffd;
+$cyan: #99d7ff;     $light-cyan: #e1f7f7;
+$magenta: #af6bd7;  $light-magenta: #fbefff;
+
+.container-fluid {
+  padding-top: 15px;
+}
+
+#colour {
+  a {
+    &:before {
+      content: "";
+      border: 1px solid transparent;
+      padding:6px;
+      display: block;
+      border-radius: 15px;
+    }
+    &.colour-white:before { background: $white; }
+    &.colour-red:before { background: $red; }
+    &.colour-yellow:before { background: $yellow; }
+    &.colour-green:before { background: $green; }
+    &.colour-cyan:before { background: $cyan; }
+    &.colour-blue:before { background: $blue; }
+    &.colour-magenta:before { background: $magenta; }
+  }
+}
+
+#content {
+
+  thead th {
+    padding-top: 0;
+  }
+
+  td p {
+    margin: 0;
+
+    &.small {
+      color: #666;
+    }
+  }
+
+  .amount,
+  tfoot tr > * {
+    text-align: right;
+  }
+
+  .credit .amount {
+    &:before { content: "($"; }
+    &:after { content: ")"; }
+  }
+
+  .debit .amount,
+  tfoot td {
+    &:before { content: "$"; }
+  }
+
+  tr {
+    &.colour-white {
+      background: $light-white;
+    }
+    &.colour-red {
+      background: $light-red;
+    }
+    &.colour-yellow {
+      background: $light-yellow;
+    }
+    &.colour-green {
+      background: $light-green;
+    }
+    &.colour-blue {
+      background: $light-blue;
+    }
+    &.colour-cyan {
+      background: $light-cyan;
+    }
+    &.colour-magenta {
+      background: $light-magenta;
+    }
+    > td,
+    > th {
+      background: inherit;
+    }
+  }
+
+  tr.colour-white a.picker,
+  li.colour-white a {
+    background: $white;
+  }
+
+  tr.colour-red a.picker,
+  li.colour-red a {
+    background: $red;
+  }
+
+  tr.colour-green a.picker,
+  li.colour-green a {
+    background: $green;
+  }
+
+  tr.colour-blue a.picker,
+  li.colour-blue a {
+    background: $blue;
+  }
+
+  tr.colour-cyan a.picker,
+  li.colour-cyan a {
+    background: $cyan;
+  }
+
+  tr.colour-magenta a.picker,
+  li.colour-magenta a {
+    background: $magenta;
+  }
+
+  tr.colour-yellow a.picker,
+  li.colour-yellow a {
+    background: $yellow;
+  }
+
+  td.colour {
+    width: 20px;
+    position: relative;
+
+    a {
+      display: block;
+      border: 1px solid #eee;
+      border-radius: 10px;
+      width: 20px;
+      height: 20px;
+
+      &:hover {
+        border-color: #ddd;
+      }
+    }
+
+    ul {
+      list-style: none;
+      position: absolute;
+      display: block;
+      right: 100%;
+      top: 1px;
+      margin-bottom: 0;
+      width: 167px;
+      text-align: right;
+      background: white;
+      border: 1px solid #eee;
+      border-radius: 50px;
+      padding: 3px;
+      height: 28px;
+
+      li {
+        display: inline-block;
+        margin-right: 3px;
+
+        &:last-child {
+          margin-right: 0;
+        }
+      }
+    }
+  }
+
+}
+
+footer {
+  font-size: .8em;
+  text-align: center;
+  padding: 20px 0;
+}

data/lib/html/index.html

@@ -0,0 +1,94 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <title>Statements</title>
+    <meta charset="UTF-8">
+    <link rel="stylesheet" href="vendor/bootstrap/css/bootstrap.css"/>
+    <link rel="stylesheet" href="vendor/bootstrap/css/bootstrap-theme.css"/>
+    <link rel="stylesheet" href="vendor/datepicker3.css"/>
+    <link rel="stylesheet" href="css/main.css"/>
+    <script src="q/accounts.js"></script>
+    <script src="vendor/jquery-2.1.3.js"></script>
+    <script src="vendor/underscore.js"></script>
+    <script src="vendor/bootstrap/js/bootstrap.js"></script>
+    <script src="vendor/bootstrap-datepicker.js"></script>
+    <script src="js/main.js"></script>
+</head>
+<body>
+<div class="container-fluid">
+    <div class="row">
+        <div class="col-sm-3 sidebar">
+            <form>
+                <div class="form-group">
+                    <label for="order">Order</label>
+                    <select id="order" name="order" class="form-control">
+                        <option selected value="posted_at desc, document_line desc">Newest first</option>
+                        <option value="posted_at asc, document_line desc">Oldest first</option>
+                        <option value="description asc, posted_at asc, document_line asc">Alphabetical</option>
+                        <option value="abs(amount) desc, description asc, posted_at asc, document_line asc">High value first</option>
+                        <option value="abs(amount) asc, description asc, posted_at asc, document_line asc">Low value first</option>
+                    </select>
+                </div>
+                <div class="form-group">
+                    <label for="date-start">Period</label>
+                    <div class="input-daterange input-group" id="date-range">
+                        <input type="text" class="input-sm form-control" name="date-start" id="date-start" placeholder="Start"/>
+                        <span class="input-group-addon">to</span>
+                        <input type="text" class="input-sm form-control" name="date-end" id="date-end" placeholder="Finish"/>
+                    </div>
+                </div>
+                <div class="form-group">
+                    <label for="text">Search</label>
+                    <input type="text"
+                           class="form-control"
+                           name="text"
+                           id="text"
+                           placeholder="Partial description"/>
+                </div>
+                <div class="form-group">
+                    <label>Type</label>
+                    <div id="type" class="btn-group btn-group-justified" role="group">
+                        <a role="button" class="btn btn-default" data-type="credits">Credits</a>
+                        <a role="button" class="btn btn-default active" data-type="both">Both</a>
+                        <a role="button" class="btn btn-default" data-type="debits">Debits</a>
+                    </div>
+                </div>
+                <div class="form-group">
+                    <label>Colour</label>
+                    <div id="colour" class="btn-group btn-group-justified" role="group" data-toggle="buttons">
+                        <a role="button" class="btn btn-default active colour-white"></a>
+                        <a role="button" class="btn btn-default active colour-red"></a>
+                        <a role="button" class="btn btn-default active colour-yellow"></a>
+                        <a role="button" class="btn btn-default active colour-green"></a>
+                        <a role="button" class="btn btn-default active colour-cyan"></a>
+                        <a role="button" class="btn btn-default active colour-blue"></a>
+                        <a role="button" class="btn btn-default active colour-magenta"></a>
+                    </div>
+                </div>
+                <div class="form-group">
+                    <label>Accounts</label>
+                    <div id="account-buttons"
+                         class="btn-group-vertical btn-group-xs"
+                         role="group"
+                         style="width:100%"
+                         data-toggle="buttons"></div>
+                    <script>populate_accounts('#account-buttons')</script>
+                </div>
+                <div>
+                    <div id="account-button-bulk" class="btn-group btn-group-justified" role="group">
+                        <a role="button" class="btn btn-default" data-set="on">All</a>
+                        <a role="button" class="btn btn-default" data-set="off">None</a>
+                    </div>
+                </div>
+            </form>
+            <footer>
+                <p>For my Anna ❤️</p>
+            </footer>
+        </div>
+        <div id="content" class="col-sm-9 content">
+
+        </div>
+    </div>
+</div>
+</body>
+</html>

data/lib/html/js/main.coffee

@@ -0,0 +1,146 @@
+# List of colour literals
+COLOURS = 'white red yellow green cyan blue magenta'.split ' '
+
+# Populates the list of bank accounts in the sidebar
+window.populate_accounts = (id) ->
+  $el = $(id)
+  for account in accounts
+    a = $('<a role="button" class="btn btn-default active" />')
+    a.text account.name
+    a.append '<br/>'
+    a.append $('<span class="small">').text(account.number)
+    a.data id: account.id
+    $el.append a
+
+# AJAX layer
+post = (page, data) -> $.ajax
+  url: "q/#{page}"
+  method: 'post'
+  contentType: 'application/json; charset=UTF-8'
+  dataType: page.match(/[^.]+$/)[0]
+  data: JSON.stringify data
+
+# Method to query the database
+querying = false
+query_again = false
+query = ->
+
+  # Handle interrupts
+  if querying
+    query_again = true
+    return
+  querying = true
+  query_again = false
+
+  # Clear content
+  $('#content').html 'One moment...'
+
+  # Submit data
+  req = post 'search.html',
+    order: $('#order').val()
+    date_start: $('#date-start').val()
+    date_end: $('#date-end').val()
+    search: $('#text').val()
+    type: $('#type .active').data 'type'
+    accounts: $('#account-buttons .active').map(-> $(@).data 'id').toArray()
+    colours: $('#colour .active').map(-> @className.match(/colour-(\w+)/)[1]).toArray()
+
+  # On success
+  req.done (result) -> $('#content').html result
+
+  # On fail
+  req.fail -> alert 'Query failed'
+
+  # Clean up
+  req.always ->
+    querying = false
+    query() if query_again
+
+# Pad querying out a bit
+query = _.debounce(query, 300)
+
+# Method to change a transaction's colour
+setColour = (transactionId, colour) -> post 'colour.json',
+  id: transactionId
+  colour: colour
+
+$ ->
+  # Set the date range to last financial year
+  months = 'Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec'.split ' '
+  range = end: new Date
+  range.end.setDate 1
+  range.end.setMonth range.end.getMonth() - 1 until range.end.getMonth() is 6
+  range.start = new Date(range.end)
+  range.start.setFullYear range.start.getFullYear() - 1
+  range.end.setDate range.end.getDate() - 1
+
+  $("#date-#{k}").val "#{i.getDate()} #{months[i.getMonth()]} #{i.getFullYear()}" for k, i of range
+
+  # Set up the date picker
+  $('.input-daterange').datepicker
+    format: "d M yyyy"
+    startView: 2
+    todayBtn: 'linked'
+    autoclose: true
+  .on 'changeDate', query
+
+  # Order
+  $('#order').on 'change', query
+
+  # Dates
+  $('date-range').on 'change', 'input', query
+
+  # Search
+  $('#text').on 'change keyup', query
+
+  # Colours
+  $('#colour').on 'click', 'a', query
+
+  # Account buttons
+  $accountButtons = $('#account-buttons a')
+  $accountButtons.on 'click', query
+
+  # Account select all/none buttons
+  $('#account-button-bulk').on 'click', 'a', (e) ->
+    set = $(e.currentTarget).data('set')
+    $accountButtons.toggleClass 'active', set is 'on'
+    query()
+
+  # Radio button behaviour for transaction types
+  $typeButtons = $('#type a')
+  $('#type').on 'click', 'a', (e) ->
+    return if $(e.currentTarget).hasClass 'active'
+    $typeButtons.each -> $(this).toggleClass 'active', this is e.currentTarget
+    query()
+
+  # Handler for blurring colour pickers
+  $picker = null
+  $('body').on 'click', (e) ->
+    target = e.currentTarget
+    closePicker() unless $picker and (target is $picker[0] or $picker.find(target)[0])
+
+  # Method to remove colour picker
+  closePicker = ->
+    $picker.remove() if $picker
+    $picker = null
+
+  # Handlers for clicks on colour pickers
+  $('#content').on 'click', 'td.colour a.picker', (e) ->
+    e.stopPropagation()
+    closePicker()
+    $tr = $(e.currentTarget).parents('tr').first()
+    $td = $tr.find('td.colour')
+    $picker = $('<ul class="colours">')
+    $picker.append $('<li>').addClass("colour-#{i}").append('<a href="javascript:">') for i in COLOURS
+    $picker.appendTo $td
+    $picker.on 'click', 'a', (e) ->
+      $li = $(e.currentTarget).parents('li').first()
+      colour = $li[0].className.match(/colour-(\w+)/)[1]
+      op = setColour $tr.data('id'), colour
+      op.fail -> alert 'Something went wrong. Try reloading?'
+      op.done -> $tr[0].className = $tr[0].className.replace /colour-\w+/, "colour-#{colour}"
+      closePicker()
+
+
+  # Do an initial query
+  query()