ledger-rest 2.0.3 → 3.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjFiMDgwN2U5ZWJhYjdmNjcyMWJmMzk3YmYyZjQwOTU4MmMxYWY4OQ==
+  data.tar.gz: !binary |-
+    NjUxNDBlNjY4MzkxODNjYzQyMTRjMTIzOTQwMzczMmRjMTU1MjQxNw==
+SHA512:
+  metadata.gz: !binary |-
+    OTQxY2Y5NTgyMmFlNzc3NjU2N2Y0MzlhNWI1YjUzNWQzYWNmNTZkMzk0MmI0
+    ZDEyMjE5MGZmMjAyMDg3N2I4ZjljODM2NmI5YzczMTIwZDdjZDI4ZjUyYzNk
+    ZjM1NmRjOThlNjk4OTEyZjQ5ZWM1Nzk1NGQ5M2MzYWJkNTkyZmI=
+  data.tar.gz: !binary |-
+    MDBlNTNhMjBkNmZmMjJhMWY0MWY2OTBlNzllZWYyM2Y2YjQ0ZDg0NjI2NmQ3
+    ZDczOWY0ZmY0YTI5YzcyY2QzMzg5YjFkYmRiM2Y1NmI3YTg4OGVkZWQ3NDRi
+    NDM2Y2IxM2ZiZGY3N2UwZDI0MTE4YTM4ZjNhZWVmMWU2ZGM2OTU=

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+/.ruby-gemset
+/.ruby-version

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/Guardfile

@@ -1,24 +1,6 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
 guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-
-  # Rails example
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-
-  # Capybara features specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
-
-  # Turnip features and steps
-  watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+  watch(/^spec\/.+_spec\.rb$/)
+  watch(/^lib\/(.+)\.rb$/) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
 end
-

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Max Wolter,Arthur Andersen
+Copyright (c) 2012 Max Wolter, Arthur Andersen
 
 MIT License
 

data/README.md

@@ -1,17 +1,68 @@
-# ledger-rest - REST assured your finances are in good hands ;-)
+# ledger-rest
 
-ledger-rest is a REST webservice to access your ledger account data
+> REST assured your finances are in good hands ;-)
+
+`ledger-rest` is a REST webservice to access your ledger account data.
+
+## What you need
+
+*Please Note:* You will have to install ledger with the `--python` flag, because
+currently ledger-rest uses a most ugly hack, that uses python to query
+complete xacts for the `GET /transactions` endpoint.
+
+To install and run ledger-rest, just clone this repository and run
+`bundle`. Everything you need will be installed by bundler. Then run
+`rackup` to start ledger rest.
+
+The configuration resides in `ledger-rest.yml` have a look at the
+example file in the repository root.
 
 ## What already works
 
-* balance reports (``/balance``)
-* register reports (``/register``)
-* budget reports (``/budget``)
-* version query (``/version``)
+* query balance reports (``GET /balance``)
+* query register reports (``GET /register``)
+* query budget reports (``GET /budget``)
+* query a transactions list (``GET /transactions``)
+* query the ledger and ledger-rest version (``GET /version``)
 
-## What you need
+# Contribute
+
+All help is welcome. Just fork and send pull requests.
+
+## What needs to be done
+
+### Replace the ugly transactions retrieval
+
+Replace the ugly transactions retrieval by a better method. This is
+only implemented because I need to get out the specific data fast. Via
+commandline only I do not get the full transactions with all their
+posts when I add a query. Only `ledger print` would do what I want,
+but then I would have to parse the transactions myself.
+
+The ideal solution would be to implement ruby ledger bindings, but I
+am not familiar enough with the inner workings of ledger.
+
+# License
+
+Copyright (c) 2012 Max Wolter, Arthur Andersen
+
+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.
 
-* ruby
-  * sinatra
-  * escape
-* ledger
+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/config.ru

@@ -1,4 +1,4 @@
-$: << "./lib"
+$: << './lib'
 
 require 'ledger-rest'
 

data/ledger-rest.gemspec

@@ -4,27 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ledger-rest/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "ledger-rest"
+  gem.name          = 'ledger-rest'
   gem.version       = LedgerRest::VERSION
-  gem.authors       = ["Prof. MAAD", "Arthur Andersen"]
-  gem.email         = ["leoc.git@gmail.com"]
+  gem.authors       = ['Prof. MAAD', 'Arthur Andersen']
+  gem.email         = ['leoc.git@gmail.com']
   gem.description   = %q{Provide a REST web service for ledger.}
   gem.summary       = %q{Ledger via REST.}
-  gem.homepage      = "https://github.com/leoc/ledger-rest"
+  gem.homepage      = 'https://github.com/leoc/ledger-rest'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split($RS)
+  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.require_paths = ['lib']
 
-  gem.add_dependency "escape"
-  gem.add_dependency "sinatra"
-  gem.add_dependency "git"
-
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "rb-inotify"
-  gem.add_development_dependency "guard-rspec"
+  gem.add_dependency 'escape'
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'git'
 
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'rb-inotify'
+  gem.add_development_dependency 'guard-rspec'
 end

data/ledger-rest.yml.example

@@ -0,0 +1,3 @@
+ledger_file: "/path/to/my/ledger/files.dat"
+ledger_bin: "/bin/ledger"
+ledger_append_file: "/path/to/my/ledger/append_file.dat"

data/lib/ledger-rest/app.rb

@@ -12,15 +12,14 @@ require 'ledger-rest/core_ext'
 
 module LedgerRest
   class App < Sinatra::Base
-    CONFIG_FILE = "ledger-rest.yml"
-
     configure do |c|
       config = {}
+      filename = ENV['CONFIG_FILE'] || 'ledger-rest.yml'
       begin
-        config = YAML.load_file(CONFIG_FILE)
+        config = YAML.load_file(filename)
         config.symbolize_keys!
-      rescue Exception => e
-        puts "Failed to load config."
+      rescue Errno::ENOENT
+        raise "'#{filename}' not found."
       end
 
       Ledger.configure(config)
@@ -30,14 +29,14 @@ module LedgerRest
     get '/version' do
       content_type :json
       {
-        "version" => LedgerRest::VERSION,
-        "ledger-version" => Ledger.version
+        'version' => LedgerRest::VERSION,
+        'ledger-version' => Ledger.version
       }.to_json
     end
 
     get '/balance/?:query?' do
       content_type :json
-      Ledger::Balance.json(params[:query])
+      Ledger.balance(params[:query]).to_json
     end
 
     get '/budget/?:query?' do
@@ -63,62 +62,50 @@ module LedgerRest
     # gets a potential new entry via the entry command
     get '/transactions/entry/?:desc?' do
       content_type :json
-      { :transaction => Ledger::Entry.get(params[:desc]) }.to_json
+      { transaction: Ledger::Entry.get(params[:desc]) }.to_json
     end
 
     # creates a new entry based on the
     post '/transactions/entry/?:desc?' do
       content_type :json
-      { :transaction => Ledger::Entry.append(params[:desc]) }.to_json
-    end
-
-    get '/transactions/:meta' do
-      "Not yet implemented!"
+      { transaction: Ledger::Entry.append(params[:desc]) }.to_json
     end
 
-    get '/transactions' do
-      "Not yet implemented!"
+    get '/transactions/?:query?' do
+      content_type :json
+      Ledger.transactions(params[:query])
     end
 
     post '/transactions' do
       content_type :json
       begin
-        params = JSON.parse(params[:transaction], :symbolize_names => true)
+        request.body.rewind
+        request_payload = JSON.parse(request.body.read, symbolize_names: true)
 
-        transaction = Transaction.create params
+        transaction = Ledger::Transaction.new(request_payload)
 
-        raise "Verification error" unless transaction.valid?
+        fail transaction.check.join("\n") unless transaction.valid?
 
         Git.invoke :before_write
 
-        @@ledger.append transaction
+        Ledger.append(transaction)
 
         Git.invoke :after_write
 
         [201, { transaction: transaction }.to_json]
       rescue JSON::ParserError => e
-        [422,
-         {
-           :error => true,
-           :message => "Unprocessible Entity: '#{e}'"
-         }.to_json
-        ]
+        [422, { error: true, message: "Unprocessible Entity: '#{e}'" }.to_json ]
       rescue RuntimeError => e
-        [400,
-         {
-           :error => true,
-           :message => "Adding the transaction failed: '#{e}'"
-         }.to_json
-        ]
+        [400, { error: true, message: "Adding the transaction failed: '#{e}'" }.to_json ]
       end
     end
 
     put '/transactions/:meta' do
-      "Not yet implemented!"
+      'Not yet implemented!'
     end
 
     delete '/transactions/:meta' do
-      "Not yet implemented!"
+      'Not yet implemented!'
     end
   end
 end

data/lib/ledger-rest/core_ext.rb

@@ -1,15 +1,16 @@
+# -*- coding: utf-8 -*-
 class Hash
   def symbolize_keys
     hash = {}
-    self.each_pair do |key, val|
+    each_pair do |key, val|
       hash[key.to_sym] = val
     end
     hash
   end
 
   def symbolize_keys!
-    self.keys.each do |key|
-      self[key.to_sym] = self.delete key
+    keys.each do |key|
+      self[key.to_sym] = delete key
     end
     self
   end

data/lib/ledger-rest/git.rb

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 require 'git'
 
 module LedgerRest
@@ -5,8 +7,8 @@ module LedgerRest
     class << self
       attr_reader :repository, :remote, :branch, :read_pull_block_time
 
-      def configure options
-        @repository = options[:git_repository] or File.dirname(options[:ledger_file] || 'main.ledger')
+      def configure(options)
+        @repository = options[:git_repository] || File.dirname(options[:ledger_file] || 'main.ledger')
         @pull_before_read = options[:git_pull_before_read] || false
         @pull_before_write = options[:git_pull_before_write] || false
         @push_after_write = options[:git_push_after_write] || false
@@ -15,17 +17,17 @@ module LedgerRest
         @read_pull_block_time = options[:git_read_pull_block_time] || 10*60
 
         @last_read_pull = Time.new
-        if pull_before_read? or pull_before_write? or push_after_write?
+        if pull_before_read? || pull_before_write? || push_after_write?
           @git_repo = ::Git.open(repository)
           FileUtils.touch(options[:ledger_append_file])
           @git_repo.add(options[:ledger_append_file])
         end
       end
 
-      def invoke hook
+      def invoke(hook)
         case hook
         when :before_read
-          pull if pull_before_read? and not blocked?
+          pull if pull_before_read? && !blocked?
         when :before_write
           pull if pull_before_write?
         when :after_write
@@ -59,12 +61,11 @@ module LedgerRest
 
       # Execute the push command after commiting all.
       def push
-        @git_repo.commit_all("transaction added via ledger-rest")
+        @git_repo.commit_all('Add transaction via ledger-rest')
         @git_repo.push(remote, branch)
       rescue Exception => e
         $stderr.put "Git push failed: #{e}"
       end
-
     end
   end
 end

data/lib/ledger-rest/ledger.rb

@@ -4,13 +4,13 @@ require 'ledger-rest/ledger/parser'
 module LedgerRest
   class Ledger
     class << self
-
       attr_accessor :rcfile, :bin, :file, :append_file, :home
 
       def configure(options)
         @bin = options[:ledger_bin] || '/usr/bin/ledger'
         @file = options[:ledger_file] || ENV['LEDGER_FILE'] || 'main.ledger'
-        @append_file = options[:ledger_append_file] || ENV['LEDGER_FILE'] || 'append.ledger'
+        @append_file =
+          options[:ledger_append_file] || ENV['LEDGER_FILE'] || 'append.ledger'
         @home = options[:ledger_home] || ''
       end
 
@@ -22,67 +22,72 @@ module LedgerRest
           '-f' => @file
         }.merge(options)
 
-        params = ""
+        params = ''
         options.each do |key, val|
           params << " #{key} #{Escape.shell_single_word(val)}"
         end
 
         command = "#{bin} #{params} #{cmd}"
 
-        puts command
         `#{command}`.rstrip
       end
 
       # Append a new transaction to the append_file.
-      def append transaction
-        File.open(append_file, "a+") do |f|
+      def append(transaction)
+        File.open(append_file, 'a+') do |f|
           if f.pos == 0
             last_char = "\n"
           else
-            f.pos = f.pos-1
+            f.pos = f.pos - 1
             last_char = f.getc
           end
 
-          f.write "\n" unless last_char == "\n"
-          f.write(transaction_string)
+          f.write "\n"
+          f.write(transaction.to_ledger)
         end
       end
 
+      # Returns a hash with the balance for given query
+      def balance(query = nil)
+        Ledger::Balance.get(query)
+      end
+
       # Return the ledger version.
       def version
-        exec("--version").match(/^Ledger (.*),/)[1]
+        exec('--version').match(/^Ledger (.*),/)[1]
       end
 
       # Get a new transaction entry based on previous entries found
       # in the append file.
-      def entry description
+      def entry(description)
         result = exec "entry #{description}", '-f' => append_file
-
-
       end
 
       # Return a list of payees.
       def payees(query = nil)
-        result = exec "payees #{query if query}"
-        { :payees => result.split("\n") }
+        exec("payees #{query if query}").split("\n")
       end
 
       # Returns an Array of payees with their respective usage count.
-      def payees_with_usage
-
-      end
+      def payees_with_usage; end
 
       # Return an array of accounts.
       def accounts(query = nil)
-        result = exec "accounts #{query if query}"
-        { :accounts => result.split("\n") }
+        exec("accounts #{query if query}").split("\n")
       end
 
-      # Return an Array of accounts with their respective usage count.
-      def accounts_with_usage
-
+      # Returns a list of transactions as JSON
+      def transactions(query)
+        # This is a most ugly hack, which gathers the ledger
+        # information via python.
+        # TODO: write ruby-ledger bindings to retrieve reports with
+        # ruby directly!
+        query.gsub!('-', '\-') if query
+        `#{bin} python #{File.join(File.dirname(__FILE__), 'transactions.py')} "#{@file}" "#{query}"`
       end
-    end
 
+      # Return an Array of accounts with their respective usage count.
+      def accounts_with_usage; end
+    end
   end
 end