├── .gitignore ├── Gruntfile.js ├── LICENSE ├── README.md ├── bin └── ledger-rest ├── lib ├── handlers │ ├── balance.js │ ├── register.js │ └── version.js ├── ledger-rest.js └── plugins │ └── setLastModifiedHeader.js ├── package.json └── spec ├── balance.spec.js ├── data ├── drewr.dat └── single-transaction.dat └── register.spec.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ -------------------------------------------------------------------------------- /Gruntfile.js: -------------------------------------------------------------------------------- 1 | /*global module:false*/ 2 | module.exports = function(grunt) { 3 | grunt.initConfig({ 4 | pkg: grunt.file.readJSON('package.json'), 5 | banner: '/*! <%= pkg.title || pkg.name %> - v<%= pkg.version %> - ' + 6 | '<%= grunt.template.today("yyyy-mm-dd") %>\n' + 7 | '<%= pkg.homepage ? "* " + pkg.homepage + "\\n" : "" %>' + 8 | '* Copyright (c) <%= grunt.template.today("yyyy") %> <%= pkg.author.name %>;' + 9 | ' Licensed <%= _.pluck(pkg.licenses, "type").join(", ") %> */\n', 10 | 11 | jshint: { 12 | options: { 13 | curly: true, 14 | eqeqeq: true, 15 | immed: true, 16 | latedef: true, 17 | newcap: true, 18 | noarg: true, 19 | sub: true, 20 | undef: true, 21 | unused: true, 22 | boss: true, 23 | eqnull: true, 24 | globals: { 25 | jQuery: true 26 | } 27 | }, 28 | gruntfile: { 29 | src: 'Gruntfile.js' 30 | }, 31 | lib: { 32 | options: { 33 | globals: { 34 | require: true, 35 | module: true, 36 | console: true 37 | } 38 | }, 39 | src: ['lib/**/*.js'] 40 | }, 41 | spec: { 42 | options: { 43 | globals: { 44 | require: true, 45 | describe: true, 46 | beforeEach: true, 47 | afterEach: true, 48 | it: true, 49 | expect: true 50 | } 51 | }, 52 | src: ['spec/**/*.js'] 53 | } 54 | }, 55 | 56 | 'mochaTest': { 57 | src: ['spec/**/*.spec.js'], 58 | options: { 59 | reporter: 'spec' 60 | } 61 | }, 62 | 63 | watch: { 64 | gruntfile: { 65 | files: '<%= jshint.gruntfile.src %>', 66 | tasks: ['jshint:gruntfile'] 67 | }, 68 | lib: { 69 | files: '<%= jshint.lib.src %>', 70 | tasks: ['jshint:lib'] 71 | }, 72 | spec: { 73 | files: '<%= jshint.spec.src %>', 74 | tasks: ['jshint:spec', 'spec'] 75 | } 76 | } 77 | }); 78 | 79 | grunt.loadNpmTasks('grunt-contrib-jshint'); 80 | grunt.loadNpmTasks('grunt-contrib-watch'); 81 | grunt.loadNpmTasks('grunt-mocha-test'); 82 | 83 | grunt.registerTask('spec', ['mochaTest']); 84 | 85 | // Default task. 86 | grunt.registerTask('default', ['jshint', 'spec']); 87 | }; -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | Copyright (c) 2016 Ben Smith (ben@10consulting.com) 3 | 4 | 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: 5 | 6 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 7 | 8 | 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. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ledger-rest 2 | 3 | REST web service API to access the Ledger command-line interface ([ledger-cli.org](http://ledger-cli.org/)). 4 | 5 | > Ledger is a powerful, double-entry accounting system that is accessed from the UNIX command-line. 6 | 7 | MIT License 8 | 9 | ## Dependencies 10 | 11 | * [Ledger 3](http://ledger-cli.org/) 12 | * [Node.js](nodejs.org) and npm 13 | 14 | ### Installing Ledger 15 | 16 | The simplest way to install Ledger 3 is through [Homebrew](http://mxcl.github.com/homebrew/). 17 | 18 | ``` 19 | brew install ledger --HEAD 20 | ``` 21 | 22 | The `--HEAD` option is required to install version 3.x. 23 | 24 | ## Usage 25 | 26 | Install `ledger-rest` and its dependencies with npm. 27 | 28 | ``` 29 | npm install ledger-rest 30 | ``` 31 | 32 | Use the `LedgerRest` class to create a new RESTful server and start listening on a given port. 33 | 34 | ```js 35 | var LedgerRest = require('ledger-rest').LedgerRest; 36 | 37 | var server = new LedgerRest({ file: 'path/to/ledger/journal/file.dat' }); 38 | 39 | server.listen(3000); 40 | ``` 41 | 42 | Or use the command line runner to start a server listening on the given port and serving a single Ledger `.dat` file. 43 | 44 | ``` 45 | npm install ledger-rest -g 46 | 47 | ledger-rest -p -f path/to/ledger/journal/file.dat 48 | ``` 49 | 50 | To confirm the server is listening: 51 | 52 | ``` 53 | curl -H "Content-Type: application/json" http://localhost:/version 54 | 55 | {"version":"3.1.1-20160111"} 56 | ``` 57 | 58 | The following endpoints are available: 59 | 60 | * /version 61 | * /balance 62 | * /register 63 | -------------------------------------------------------------------------------- /bin/ledger-rest: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | var util = require('util'), 4 | LedgerRest = require('../lib/ledger-rest').LedgerRest; 5 | 6 | var help = function() { 7 | util.print([ 8 | 'USAGE: ledger-rest -p -f /path/to/ledger/journal.dat', 9 | '', 10 | 'Options:', 11 | ' -p, --port PORT - port to start the server on', 12 | ' -f, --file FILE - path to Ledger journal file', 13 | ' -v, --verbose - enable verbose logging to stdout', 14 | ' -h, --help - display this help and exit', 15 | '' 16 | ].join('\n')); 17 | 18 | process.exit(-1); 19 | }; 20 | 21 | var args = process.argv.slice(2), 22 | verbose = false, 23 | file = '', 24 | port = ''; 25 | 26 | while(args.length) { 27 | var arg = args.shift(); 28 | 29 | switch(arg) 30 | { 31 | case '-f': 32 | case '--file': 33 | file = args.shift(); 34 | break; 35 | 36 | case '-p': 37 | case '--port': 38 | port = args.shift(); 39 | break; 40 | 41 | case '-v': 42 | case '--verbose': 43 | verbose = true; 44 | break; 45 | } 46 | } 47 | 48 | if (!file || !port) { 49 | help(); 50 | } 51 | 52 | var server = new LedgerRest({ file: file, debug: verbose }); 53 | 54 | server.listen(port); -------------------------------------------------------------------------------- /lib/handlers/balance.js: -------------------------------------------------------------------------------- 1 | var JSONStream = require('JSONStream'); 2 | 3 | var Balance = (function() { 4 | function Balance(ledger) { 5 | this.ledger = ledger; 6 | } 7 | 8 | Balance.prototype.handle = function(req, res, next) { 9 | res.setHeader('content-type', 'application/json'); 10 | 11 | this.ledger.balance() 12 | .pipe(JSONStream.stringify()) 13 | .pipe(res) 14 | .once('error', function (err) { 15 | res.statusCode = 500; 16 | res.end(String(err)); 17 | }) 18 | .once('end', next); 19 | }; 20 | 21 | return Balance; 22 | })(); 23 | 24 | module.exports.Balance = Balance; -------------------------------------------------------------------------------- /lib/handlers/register.js: -------------------------------------------------------------------------------- 1 | var JSONStream = require('JSONStream'); 2 | 3 | var Register = (function() { 4 | function Register(ledger) { 5 | this.ledger = ledger; 6 | } 7 | 8 | Register.prototype.handle = function(req, res, next) { 9 | var options = { }; 10 | 11 | if (req.params.account) { 12 | options.account = req.params.account; 13 | } 14 | 15 | res.setHeader('content-type', 'application/json'); 16 | 17 | this.ledger.register(options) 18 | .pipe(JSONStream.stringify()) 19 | .pipe(res) 20 | .once('error', function (err) { 21 | res.statusCode = 500; 22 | res.end(String(err)); 23 | }) 24 | .once('end', next); 25 | }; 26 | 27 | return Register; 28 | })(); 29 | 30 | module.exports.Register = Register; -------------------------------------------------------------------------------- /lib/handlers/version.js: -------------------------------------------------------------------------------- 1 | var Version = (function() { 2 | function Version(ledger) { 3 | this.ledger = ledger; 4 | } 5 | 6 | Version.prototype.handle = function(req, res, next) { 7 | this.ledger.version(function(err, version) { 8 | if (err) { 9 | return res.send(err); 10 | } 11 | 12 | res.send({ version: version }); 13 | 14 | return next(); 15 | }); 16 | }; 17 | 18 | return Version; 19 | })(); 20 | 21 | module.exports.Version = Version; -------------------------------------------------------------------------------- /lib/ledger-rest.js: -------------------------------------------------------------------------------- 1 | var _ = require('lodash'), 2 | restify = require('restify'), 3 | Ledger = require('ledger-cli').Ledger, 4 | Version = require('./handlers/version').Version, 5 | Balance = require('./handlers/balance').Balance, 6 | Register = require('./handlers/register').Register; 7 | 8 | var LedgerRest = (function() { 9 | var defaultConfig = { 10 | name: 'ledger-rest', 11 | debug: false 12 | }; 13 | 14 | function LedgerRest(options) { 15 | this.options = _.defaults({}, options, defaultConfig); 16 | 17 | this.ledger = new Ledger(this.options); 18 | 19 | this.createServer(this.options); 20 | this.configureRouting(); 21 | } 22 | 23 | LedgerRest.prototype.createServer = function(config) { 24 | this.server = restify.createServer({ 25 | name: config.name 26 | }); 27 | 28 | this.server.use([ 29 | restify.plugins.acceptParser(this.server.acceptable), 30 | restify.plugins.gzipResponse() 31 | ]); 32 | }; 33 | 34 | LedgerRest.prototype.listen = function(port, callback) { 35 | this.server.listen(port, function() { 36 | this.log('%s listening at %s', this.server.name, this.server.url); 37 | 38 | if (callback) { 39 | callback(); 40 | } 41 | }.bind(this)); 42 | }; 43 | 44 | LedgerRest.prototype.close = function(callback) { 45 | this.log('%s is closing...', this.server.name); 46 | 47 | this.server.close(function() { 48 | this.log('%s has closed', this.server.name); 49 | if (callback) { 50 | callback(); 51 | } 52 | }.bind(this)); 53 | }; 54 | 55 | LedgerRest.prototype.configureRouting = function() { 56 | var version = new Version(this.ledger), 57 | balance = new Balance(this.ledger), 58 | register = new Register(this.ledger); 59 | 60 | this.server.get('/version', version.handle.bind(version)); 61 | this.server.get('/balance', balance.handle.bind(balance)); 62 | this.server.get('/register', register.handle.bind(register)); 63 | this.server.get('/register/:account', register.handle.bind(register)); 64 | }; 65 | 66 | LedgerRest.prototype.log = function() { 67 | if (this.options.debug) { 68 | console.log.apply(console, arguments); 69 | } 70 | }; 71 | 72 | return LedgerRest; 73 | })(); 74 | 75 | module.exports.LedgerRest = LedgerRest; 76 | -------------------------------------------------------------------------------- /lib/plugins/setLastModifiedHeader.js: -------------------------------------------------------------------------------- 1 | var setLastModifiedHeader = function(handler, date) { 2 | return function(req, res, next) { 3 | res.header('Last-Modified', date); 4 | 5 | handler.handle(req, res, next); 6 | }; 7 | }; 8 | 9 | module.exports.setLastModifiedHeader = setLastModifiedHeader; -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ledger-rest", 3 | "version": "0.2.1", 4 | "description": "REST web service API to access ledger cli data.", 5 | "repository": { 6 | "type": "git", 7 | "url": "git://github.com/slashdotdash/node-ledger-rest.git" 8 | }, 9 | "keywords": [ 10 | "ledger", 11 | "accounting", 12 | "finance" 13 | ], 14 | "author": { 15 | "name": "Ben Smith", 16 | "email": "ben@10consulting.com" 17 | }, 18 | "license": "MIT", 19 | "bin": { 20 | "ledger-rest": "bin/ledger-rest" 21 | }, 22 | "main": "lib/ledger-rest", 23 | "directories": { 24 | "lib": "lib" 25 | }, 26 | "scripts": { 27 | "test": "grunt" 28 | }, 29 | "devDependencies": { 30 | "chai": "~3.5.0", 31 | "grunt": "~0.4.2", 32 | "grunt-contrib-jshint": "~1.0.0", 33 | "grunt-contrib-watch": "~0.6.1", 34 | "grunt-mocha-test": "~0.12.7", 35 | "mocha": "~2.4.5", 36 | "restify-clients": "^2.0.0" 37 | }, 38 | "dependencies": { 39 | "JSONStream": "^1.3.2", 40 | "ledger-cli": "^0.2.0", 41 | "lodash": "^4.17.5", 42 | "restify": "^6.3.4" 43 | }, 44 | "readmeFilename": "README.md" 45 | } 46 | -------------------------------------------------------------------------------- /spec/balance.spec.js: -------------------------------------------------------------------------------- 1 | var chai = require('chai'), 2 | expect = chai.expect, 3 | restify = require('restify-clients'), 4 | LedgerRest = require('../lib/ledger-rest').LedgerRest; 5 | 6 | describe('Balance', function() { 7 | var spec, server, client; 8 | 9 | // start ledger-rest server 10 | function startServer() { 11 | server = new LedgerRest({ file: 'spec/data/single-transaction.dat' }); 12 | server.listen(3000); 13 | } 14 | 15 | function stopServer(done) { 16 | server.close(done); 17 | } 18 | 19 | // create JSON client 20 | function createClient() { 21 | client = restify.createJsonClient({ 22 | url: 'http://localhost:3000', 23 | version: '*', 24 | headers: { 25 | connection: 'close' 26 | } 27 | }); 28 | } 29 | 30 | beforeEach(function() { 31 | spec = this; 32 | 33 | startServer(); 34 | createClient(); 35 | }); 36 | 37 | afterEach(function(done) { 38 | stopServer(done); 39 | }); 40 | 41 | describe('single transaction', function() { 42 | var balances; 43 | 44 | beforeEach(function(done) { 45 | client.get('/balance', function(err, req, res, obj) { 46 | if (err) { 47 | spec.fail(err); 48 | return done(); 49 | } 50 | 51 | balances = obj; 52 | done(); 53 | }); 54 | }); 55 | 56 | it('should return balance for two accounts', function() { 57 | expect(balances.length).to.equal(2); 58 | }); 59 | 60 | it('should parse first balance', function() { 61 | expect(balances[0]).to.eql({ 62 | total: { 63 | currency : '£', 64 | amount : 1000, 65 | formatted : '£1,000.00' 66 | }, 67 | account: { 68 | fullname: 'Assets:Checking', 69 | shortname: 'Assets:Checking', 70 | depth: 2, 71 | } 72 | }); 73 | }); 74 | 75 | it('should parse second balance', function() { 76 | expect(balances[1]).to.eql({ 77 | total: { 78 | currency : '£', 79 | amount : -1000, 80 | formatted : '£-1,000.00' 81 | }, 82 | account: { 83 | fullname: 'Income:Salary', 84 | shortname: 'Income:Salary', 85 | depth: 2, 86 | } 87 | }); 88 | }); 89 | }); 90 | }); 91 | -------------------------------------------------------------------------------- /spec/data/drewr.dat: -------------------------------------------------------------------------------- 1 | ; -*- ledger -*- 2 | 3 | = /^Income/ 4 | (Liabilities:Tithe) £0.12 5 | 6 | ~ Monthly 7 | Assets:Checking £500.00 8 | Income:Salary 9 | 10 | 2003/12/01 * Checking balance 11 | Assets:Checking £1000.00 12 | Equity:Opening Balances 13 | 14 | 2003/12/20 Organic Co-op 15 | Expenses:Food:Groceries £ 37.50 ; [=2004/01/01] 16 | Expenses:Food:Groceries £ 37.50 ; [=2004/02/01] 17 | Expenses:Food:Groceries £ 37.50 ; [=2004/03/01] 18 | Expenses:Food:Groceries £ 37.50 ; [=2004/04/01] 19 | Expenses:Food:Groceries £ 37.50 ; [=2004/05/01] 20 | Expenses:Food:Groceries £ 37.50 ; [=2004/06/01] 21 | Assets:Checking £ -225.00 22 | 23 | 2003/12/28=2004/01/01 Acme Mortgage 24 | Liabilities:Mortgage:Principal £ 200.00 25 | Expenses:Interest:Mortgage £ 500.00 26 | Expenses:Escrow £ 300.00 27 | Assets:Checking £-1,000.00 28 | 29 | 2004/01/02 Grocery Store 30 | Expenses:Food:Groceries £65.00 31 | Assets:Checking 32 | 33 | 2004/01/05 Employer 34 | Assets:Checking £2000.00 35 | Income:Salary 36 | 37 | 2004/01/14 Bank 38 | ; Regular monthly savings transfer 39 | Assets:Savings £ 300.00 40 | Assets:Checking 41 | 42 | 2004/01/19 Grocery Store 43 | Expenses:Food:Groceries £ 44.00 44 | Assets:Checking 45 | 46 | 2004/01/25 Bank 47 | ; Transfer to cover car purchase 48 | Assets:Checking £ 5,500.00 49 | Assets:Savings 50 | ; :nobudget: 51 | 52 | 2004/01/25 Tom’s Used Cars 53 | Expenses:Auto £ 5,500.00 54 | ; :nobudget: 55 | Assets:Checking 56 | 57 | 2004/01/27 Book Store 58 | Expenses:Books £20.00 59 | Liabilities:MasterCard 60 | 61 | 2004/02/01 Sale 62 | Assets:Checking:Business £30.00 63 | Income:Sales -------------------------------------------------------------------------------- /spec/data/single-transaction.dat: -------------------------------------------------------------------------------- 1 | 2013/03/19 My Employer 2 | Assets:Checking £1,000.00 3 | Income:Salary £-1,000.00 -------------------------------------------------------------------------------- /spec/register.spec.js: -------------------------------------------------------------------------------- 1 | var chai = require('chai'), 2 | expect = chai.expect, 3 | restify = require('restify-clients'), 4 | LedgerRest = require('../lib/ledger-rest').LedgerRest; 5 | 6 | describe('Register', function() { 7 | var spec, server, client; 8 | 9 | // start ledger-rest server 10 | function startServer() { 11 | server = new LedgerRest({ file: 'spec/data/drewr.dat' }); 12 | server.listen(3000); 13 | } 14 | 15 | function stopServer(done) { 16 | server.close(done); 17 | } 18 | 19 | // create JSON client 20 | function createClient() { 21 | client = restify.createJsonClient({ 22 | url: 'http://localhost:3000', 23 | version: '*', 24 | headers: { 25 | connection: 'close' 26 | } 27 | }); 28 | } 29 | 30 | beforeEach(function() { 31 | spec = this; 32 | 33 | startServer(); 34 | createClient(); 35 | }); 36 | 37 | afterEach(function(done) { 38 | stopServer(done); 39 | }); 40 | 41 | describe('multiple transactions', function() { 42 | var entries; 43 | 44 | beforeEach(function(done) { 45 | client.get('/register', function(err, req, res, obj) { 46 | if (err) { 47 | spec.fail(err); 48 | return done(); 49 | } 50 | 51 | entries = obj; 52 | done(); 53 | }); 54 | }); 55 | 56 | it('should return register entries', function() { 57 | expect(entries.length).to.equal(11); 58 | }); 59 | }); 60 | }); 61 | --------------------------------------------------------------------------------