ledger-rest 2.0.3 → 3.0.0

data/lib/ledger-rest/transactions.py

@@ -0,0 +1,47 @@
+import ledger
+import json
+import sys
+
+filename = sys.argv[1]
+query = sys.argv[2]
+
+transactions = []
+last_xact = None
+for match in ledger.read_journal(filename).query(query):
+    if match.xact != last_xact:
+        transaction = {}
+        transaction['payee'] = match.xact.payee
+        transaction['date'] = match.xact.date.strftime('%Y/%m/%d')
+
+        if match.xact.code != None:
+            transaction['code'] = match.xact.code
+
+        if match.xact.note != None:
+            transaction['note'] = match.xact.note.strip()
+
+        if match.xact.aux_date != None:
+            transaction['effective_date'] = match.xact.aux_date.strftime('%Y/%m/%d')
+
+        if str(match.xact.state) == 'Cleared':
+            transaction['cleared'] = True
+            transaction['pending'] = False
+        elif str(match.xact.state) == 'Pending':
+            transaction['cleared'] = False
+            transaction['pending'] = True
+        else:
+            transaction['cleared'] = False
+            transaction['pending'] = False
+
+        transaction['posts'] = []
+        for post in match.xact.posts():
+            new_post = {}
+            new_post['account'] = str(post.account)
+            new_post['amount'] = float(post.amount)
+            new_post['commodity'] = str(post.amount.commodity)
+            transaction['posts'].append(new_post)
+
+        transactions.append(transaction)
+
+        last_xact = match.xact
+
+print json.dumps(transactions)

data/lib/ledger-rest/version.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module LedgerRest
-  VERSION = "2.0.3"
+  VERSION = '3.0.0'
 end

data/spec/files/append.ledger

@@ -0,0 +1,13 @@
+2013/12/03 NaveenaPath
+    Expenses:Restaurants                     9.00EUR
+    Assets:Cash
+
+2013/12/05 Shikgoo
+    Expenses:Restaurants                    12.00EUR
+    Liabilities:Max Mustermann
+    ; meta_info: Some interesting meta information
+
+2013/12/10 Bioladen Tegeler Straße
+    ; Sonnenblumenkernbrot
+    Assets:Reimbursements:Hans Maulwurf      3.10EUR
+    Assets:Cash

data/spec/files/budget.ledger

@@ -0,0 +1,4 @@
+~ Monthly
+  Expenses:Flat          450EUR
+  Expenses:Restaurants   100EUR
+  Assets

data/spec/files/main.ledger

@@ -0,0 +1,4 @@
+include opening_balance.ledger
+include append.ledger
+include budget.ledger
+include transactions.ledger

data/spec/files/opening_balance.ledger

@@ -0,0 +1,4 @@
+2013/01/01 * Opening Balance
+  Assets:Giro                              2000EUR
+  Assets:Reimbursements:Hans Maulwurf        19EUR
+  Equity:Opening Balances

data/spec/files/transactions.ledger

@@ -0,0 +1,11 @@
+2013/12/01=2013/12/02 * Sparkasse
+    Assets:Cash                              50.00EUR
+    Assets:Giro
+
+2013/12/04 Trattoria La Vialla
+    Expenses:Restaurants                     32.20EUR
+    Assets:Cash
+
+2013/12/06 Customer X
+    Assets:Giro                            1200.00EUR
+    Income:Invoice

data/spec/ledger-rest.yml

@@ -0,0 +1,3 @@
+ledger_file: "spec/files/main.ledger"
+ledger_bin: "/bin/ledger"
+ledger_append_file: "spec/files/append.ledger"

data/spec/ledger-rest/api/accounts_spec.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe '/accounts' do
+  it 'returns accounts' do
+    get '/accounts'
+
+    JSON.parse(last_response.body).should =~
+      [
+       'Assets:Cash',
+       'Assets:Giro',
+       'Assets:Reimbursements:Hans Maulwurf',
+       'Equity:Opening Balances',
+       'Expenses:Restaurants',
+       'Income:Invoice',
+       'Liabilities:Max Mustermann'
+      ]
+  end
+end

data/spec/ledger-rest/api/balance_spec.rb

@@ -0,0 +1,117 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe '/balance' do
+  context 'normally' do
+    let(:valid_json) do
+      {
+        'accounts' =>
+        [
+         {
+           'total'    => '3177.80EUR',
+           'name'     => 'Assets',
+           'depth'    => 1,
+           'fullname' => 'Assets',
+           'accounts' =>
+           [
+            {
+              'total'    => '5.70EUR',
+              'name'     => 'Cash',
+              'depth'    => 2,
+              'fullname' => 'Assets:Cash'
+            },
+            {
+              'total'    => '3150.00EUR',
+              'name'     => 'Giro',
+              'depth'    => 2,
+              'fullname' => 'Assets:Giro'
+            },
+            {
+              'total'    => '22.10EUR',
+              'name'     => 'Reimbursements',
+              'depth'    => 2,
+              'fullname' => 'Assets:Reimbursements',
+              'accounts' =>
+              [
+               {
+                 'total'    => '22.10EUR',
+                 'name'     => 'Hans Maulwurf',
+                 'depth'    => 3,
+                 'fullname' => 'Assets:Reimbursements:Hans Maulwurf'
+               }
+              ]
+            }
+           ]
+         },
+         {
+           'total'    => '-12.00EUR',
+           'name'     => 'Liabilities',
+           'depth'    => 1,
+           'fullname' => 'Liabilities',
+           'accounts' =>
+           [
+            {
+              'total'    => '-12.00EUR',
+              'name'     => 'Max Mustermann',
+              'depth'    => 2,
+              'fullname' => 'Liabilities:Max Mustermann'
+            }
+           ]
+         }
+        ],
+        'total' => '3165.80EUR'
+      }
+    end
+
+    it 'expands and wraps accounts' do
+      get '/balance', query: 'Assets Liabilities'
+      JSON.parse(last_response.body).should deep_eq valid_json
+    end
+  end
+
+  context 'with --flat query' do
+    let(:valid_json) do
+      {
+        'accounts' =>
+        [
+         {
+           'total'    => '5.70EUR',
+           'name'     => 'Cash',
+           'depth'    => 2,
+           'fullname' => 'Assets:Cash'
+         }, {
+           'total'    => '3150.00EUR',
+           'name'     => 'Giro',
+           'depth'    => 2,
+           'fullname' => 'Assets:Giro'
+         }, {
+           'total'    => '22.10EUR',
+           'name'     => 'Reimbursements',
+           'depth'    => 2,
+           'fullname' => 'Assets:Reimbursements'
+         }, {
+           'total'    => '22.10EUR',
+           'name'     => 'Hans Maulwurf',
+           'depth'    => 3,
+           'fullname' => 'Assets:Reimbursements:Hans Maulwurf'
+         }, {
+           'total'    => '-12.00EUR',
+           'name'     => 'Liabilities',
+           'depth'    => 1,
+           'fullname' => 'Liabilities'
+         }, {
+           'total'    => '-12.00EUR',
+           'name'     => 'Max Mustermann',
+           'depth'    => 2,
+           'fullname' => 'Liabilities:Max Mustermann' }
+        ],
+        'total' => '3165.80EUR'
+      }
+    end
+
+    it 'does not wrap accounts' do
+      get '/balance', query: '--flat Assets Liabilities'
+      JSON.parse(last_response.body).should deep_eq valid_json
+    end
+  end
+end

data/spec/ledger-rest/api/budget_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe '/budget' do
+  context 'with query' do
+    let(:valid_json) do
+      {
+        'accounts' =>
+        [
+         {
+           'total'      => '3177.80EUR',
+           'budget'     => '-6600.00EUR',
+           'difference' => '9777.80EUR',
+           'percentage' => '-48%',
+           'account'    => 'Assets'
+         }, {
+           'total'      => '53.20EUR',
+           'budget'     => '6600.00EUR',
+           'difference' => '-6546.80EUR',
+           'percentage' => '1%',
+           'account'    => 'Expenses'
+         }, {
+           'total'      => '0',
+           'budget'     => '5400.00EUR',
+           'difference' => '-5400.00EUR',
+           'percentage' => '0%',
+           'account'    => 'Expenses:Flat'
+         }, {
+           'total'      => '53.20EUR',
+           'budget'     => '1200.00EUR',
+           'difference' => '-1146.80EUR',
+           'percentage' => '4%',
+           'account'    => 'Expenses:Restaurants'
+         }
+        ],
+        'total'      => '3231.00EUR',
+        'budget'     => '0',
+        'difference' => '3231.00EUR',
+        'percentage' => '0'
+      }
+    end
+
+    it 'responds with the right budget' do
+      get '/budget'
+
+      JSON.parse(last_response.body).should deep_eq valid_json
+    end
+  end
+
+  context 'querying single account' do
+    let(:valid_json) do
+      {
+        'accounts' =>
+        [
+         {
+           'total'      => '53.20EUR',
+           'budget'     => '100.00EUR',
+           'difference' => '-46.80EUR',
+           'percentage' => '53%',
+           'account'    => 'Expenses:Restaurants'
+         }
+        ]
+      }
+    end
+
+    it 'responds with the right budget' do
+      get '/budget', query: 'Restaurants'
+
+      JSON.parse(last_response.body).should deep_eq valid_json
+    end
+  end
+
+  context 'querying single account' do
+    let(:valid_json) do
+      {
+        'accounts' =>
+        [
+         {
+           'total'      => '53.20EUR',
+           'budget'     => '550.00EUR',
+           'difference' => '-496.80EUR',
+           'percentage' => '10%',
+           'account'    => 'Expenses'
+         }, {
+           'total'      => '0',
+           'budget'     => '450.00EUR',
+           'difference' => '-450.00EUR',
+           'percentage' => '0%',
+           'account'    => 'Expenses:Flat'
+         }, {
+           'total'      => '53.20EUR',
+           'budget'     => '100.00EUR',
+           'difference' => '-46.80EUR',
+           'percentage' => '53%',
+           'account'    => 'Expenses:Restaurants'
+         }
+        ],
+        'total'      => '53.20EUR',
+        'budget'     => '550.00EUR',
+        'difference' => '-496.80EUR',
+        'percentage' => '10%',
+      }
+    end
+
+    it 'responds with the right budget' do
+      get '/budget', query: 'Expenses'
+
+      JSON.parse(last_response.body).should deep_eq valid_json
+    end
+  end
+end

data/spec/ledger-rest/api/payees_spec.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe '/payees' do
+  it 'returns payees' do
+    get '/payees'
+
+    JSON.parse(last_response.body).should =~
+      [
+       'Bioladen Tegeler Straße',
+       'Customer X',
+       'NaveenaPath',
+       'Opening Balance',
+       'Shikgoo',
+       'Sparkasse',
+       'Trattoria La Vialla'
+      ]
+  end
+end

data/spec/ledger-rest/api/register_spec.rb

@@ -0,0 +1,233 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe '/register' do
+  context 'normal' do
+    let(:valid_response) do
+      [
+       {
+         'date' => '2013/12/01',
+         'effective_date' => '2013/12/02',
+         'code' => nil,
+         'cleared' => true,
+         'pending' => false,
+         'payee' => 'Sparkasse',
+         'postings' =>
+         [
+          { 'account' => 'Assets:Cash',
+            'amount' => '50',
+            'total' => '50',
+            'commodity' => 'EUR'
+          },
+          {
+            'account' => 'Assets:Giro',
+            'amount' => '-50',
+            'total' => '-50',
+            'commodity' => 'EUR'
+          }
+         ]
+       }
+      ]
+    end
+
+    it 'shows all fields' do
+      get '/register', query: '-p "2013-12-01"'
+      JSON.parse(last_response.body).should deep_eq valid_response
+    end
+  end
+
+  context 'daily report' do
+    let(:valid_response) do
+      [
+       {
+         'beginning' => '2013/12/03',
+         'end'       => '2013/12/03',
+         'postings'  =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '9',
+            'total'     => '9',
+            'commodity' => 'EUR'
+          }
+         ]
+       }, {
+         'beginning' => '2013/12/04',
+         'end'       => '2013/12/04',
+         'postings'  =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '32.2',
+            'total'     => '32.2',
+            'commodity' => 'EUR'
+          }
+         ]
+       }, {
+         'beginning' => '2013/12/05',
+         'end'       => '2013/12/05',
+         'postings'  =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '12',
+            'total'     => '12',
+            'commodity' => 'EUR'
+          }
+         ]
+       }
+      ]
+    end
+
+    it 'shows beginning, end and postings with account, amount and total' do
+      get '/register', query: '--daily ^Expenses'
+      JSON.parse(last_response.body).should deep_eq valid_response
+    end
+  end
+
+  context 'weekly report' do
+    let(:valid_response) do
+      [
+       {
+         'beginning' => '2013/12/01',
+         'end'       => '2013/12/07',
+         'postings'  =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '53.2',
+            'total'     => '53.2',
+            'commodity' => 'EUR'
+          }
+         ]
+       }
+      ]
+    end
+
+    it 'shows beginning, end and postings with account, amount and total' do
+      get '/register', query: '-W ^Expenses'
+      JSON.parse(last_response.body).should deep_eq valid_response
+    end
+  end
+
+  context 'monthly report' do
+    let(:valid_response) do
+      [
+       {
+         'beginning' => '2013/12/01',
+         'end'       => '2013/12/31',
+         'postings'  =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '53.2',
+            'total'     => '53.2',
+            'commodity' => 'EUR'
+          }
+         ]
+       }
+      ]
+    end
+
+    it 'shows beginning, end and postings with account, amount and total' do
+      get '/register', query: '-M ^Expenses'
+      JSON.parse(last_response.body).should deep_eq valid_response
+    end
+  end
+
+  context 'quarterly report' do
+    let(:valid_response) do
+      [
+       {
+         'beginning' => '2013/10/01',
+         'end'       => '2013/12/31',
+         'postings'  =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '53.2',
+            'total'     => '53.2',
+            'commodity' => 'EUR'
+          }
+         ]
+       }
+      ]
+    end
+
+    it 'shows beginning, end and postings with account, amount and total' do
+      get '/register', query: '--quarterly ^Expenses'
+      JSON.parse(last_response.body).should deep_eq valid_response
+    end
+  end
+
+  context 'yearly report' do
+    let(:valid_response) do
+      [
+       {
+         'beginning' => '2013/01/01',
+         'end'       => '2013/12/31',
+         'postings'  =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '53.2',
+            'total'     => '53.2',
+            'commodity' => 'EUR'
+          }
+         ]
+       }
+      ]
+    end
+
+    it 'shows beginning, end and postings with account, amount and total' do
+      get '/register', query: '-Y ^Expenses'
+      JSON.parse(last_response.body).should deep_eq valid_response
+    end
+  end
+
+  context 'report by payee' do
+    let(:valid_response) do
+      [
+       {
+         'payee'    => 'NaveenaPath',
+         'postings' =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '9',
+            'total'     => '9',
+            'commodity' => 'EUR'
+          }
+         ]
+       }, {
+         'payee'    => 'Shikgoo',
+         'postings' =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '12',
+            'total'     => '12',
+            'commodity' => 'EUR'
+          }
+         ]
+       }, {
+         'payee'    => 'Trattoria La Vialla',
+         'postings' =>
+         [
+          {
+            'account'   => 'Expenses:Restaurants',
+            'amount'    => '32.2',
+            'total'     => '32.2',
+            'commodity' => 'EUR'
+          }
+         ]
+       }
+      ]
+    end
+
+    it 'shows beginning, end and postings with account, amount and total' do
+      get '/register', query: '--by-payee ^Expenses'
+      JSON.parse(last_response.body).should deep_eq valid_response
+    end
+  end
+end