ledger-rest 2.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gem "escape"
+gem "sinatra"
+gem "git"
+
+group :development do
+  gem "rake"
+  gem "pry"
+  gem "rspec"
+  gem "rb-inotify"
+  gem "guard-rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
+    escape (0.0.4)
+    ffi (1.2.0)
+    git (1.2.5)
+    guard (1.5.4)
+      listen (>= 0.4.2)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.1.2)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    listen (0.6.0)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rake (0.9.2.2)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    slop (3.3.3)
+    thor (0.16.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  escape
+  git
+  guard-rspec
+  pry
+  rake
+  rb-inotify
+  rspec
+  sinatra

data/Guardfile

@@ -0,0 +1,24 @@
+# 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' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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.
+
+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,17 @@
+# ledger-rest - REST assured your finances are in good hands ;-)
+
+ledger-rest is a REST webservice to access your ledger account data
+
+## What already works
+
+* balance reports (``/balance``)
+* register reports (``/register``)
+* budget reports (``/budget``)
+* version query (``/version``)
+
+## What you need
+
+* ruby
+  * sinatra
+  * escape
+* ledger

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config.ru

@@ -0,0 +1,5 @@
+$: << "./lib"
+
+require 'ledger-rest'
+
+run LedgerRest::App

data/ledger-rest.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ledger-rest/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ledger-rest"
+  gem.version       = LedgerRest::VERSION
+  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.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"]
+end

data/ledger-rest.org

@@ -0,0 +1,14 @@
+* TODO ledger-rest
+** DONE move responsibilities into classes
+   CLOSED: [2012-11-22 Thu 19:03]
+   - State "DONE"       from "TODO"       [2012-11-22 Thu 19:03]
+** TODO implement entry GET
+** TODO implement entry POST
+** TODO implement transactions GET method
+   Get all transactions.
+** TODO implement transactions POST method
+   Create a new transaction in the respective file.
+** TODO implement transactions PUT method
+   Modify a transaction in the respective file.
+** TODO implement transactions DELETE method
+   Remove a transaction from the respective file.

data/lib/ledger-rest.rb

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'fileutils'
+require 'json'
+require 'yaml'
+require 'bundler'
+
+Bundler.require
+
+require 'ledger-rest/version'
+require 'ledger-rest/app'

data/lib/ledger-rest/app.rb

@@ -0,0 +1,124 @@
+# -*- coding: utf-8 -*-
+require 'ledger-rest/ledger'
+require 'ledger-rest/ledger/balance'
+require 'ledger-rest/ledger/transaction'
+require 'ledger-rest/ledger/register'
+require 'ledger-rest/ledger/budget'
+require 'ledger-rest/ledger/entry'
+require 'ledger-rest/git'
+require 'ledger-rest/core_ext'
+
+require 'pry'
+
+module LedgerRest
+  class App < Sinatra::Base
+    CONFIG_FILE = "ledger-rest.yml"
+
+    configure do |c|
+      begin
+        config = YAML.load_file(CONFIG_FILE)
+        config.symbolize_keys!
+      rescue Exception => e
+        puts "Failed to load config."
+      end
+
+      Ledger.configure config
+      Git.configure config
+    end
+
+    get '/version' do
+      content_type :json
+      {
+        "version" => LedgerRest::VERSION,
+        "ledger-version" => Ledger.version
+      }.to_json
+    end
+
+    get '/balance/?:query?' do
+      content_type :json
+      Ledger::Balance.json(params[:query])
+    end
+
+    get '/budget/?:query?' do
+      content_type :json
+      Ledger::Budget.json(params[:query])
+    end
+
+    get '/register/?:query?' do
+      content_type :json
+      Ledger::Register.json(params[:query])
+    end
+
+    get '/accounts/?:query?' do
+      content_type :json
+      Ledger.accounts(params[:query]).to_json
+    end
+
+    get '/payees/?:query?' do
+      content_type :json
+      Ledger.payees(params[:query]).to_json
+    end
+
+    # 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
+    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!"
+    end
+
+    get '/transactions' do
+      "Not yet implemented!"
+    end
+
+    post '/transactions' do
+      content_type :json
+      begin
+        params = JSON.parse(params[:transaction], :symbolize_names => true)
+
+        transaction = Transaction.create params
+
+        raise "Verification error" unless transaction.valid?
+
+        Git.invoke :before_write
+
+        @@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
+        ]
+      rescue RuntimeError => e
+        [400,
+         {
+           :error => true,
+           :message => "Adding the transaction failed: '#{e}'"
+         }.to_json
+        ]
+      end
+    end
+
+    put '/transactions/:meta' do
+
+    end
+
+    delete '/transactions/:meta' do
+
+    end
+
+  end
+end

data/lib/ledger-rest/core_ext.rb

@@ -0,0 +1,23 @@
+class Hash
+  def symbolize_keys
+    hash = {}
+    self.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
+    end
+    self
+  end
+
+  def inject acc, &block
+    self.each_pair do |key, val|
+      acc = block.call acc, key, val
+    end
+    acc
+  end
+end

data/lib/ledger-rest/git.rb

@@ -0,0 +1,68 @@
+module LedgerRest
+  class Git
+    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')
+        @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
+        @remote = options[:git_remote] || 'origin'
+        @branch = options[:git_branch] || 'master'
+        @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?
+          @git_repo = ::Git.open(repository)
+          FileUtils.touch(options[:ledger_append_file])
+          @git_repo.add(options[:ledger_append_file])
+        end
+      end
+
+      def invoke hook
+        case hook
+        when :before_read
+          pull if pull_before_read? and not blocked?
+        when :before_write
+          pull if pull_before_write?
+        when :after_write
+          push if push_after_write?
+        end
+      end
+
+      def blocked_read_pull?
+        (Time.new - @last_read_pull) > read_pull_block_time
+      end
+
+      def pull_before_read?
+        @pull_before_read
+      end
+
+      def pull_before_write?
+        @pull_before_write
+      end
+
+      def push_after_write?
+        @push_after_write
+      end
+
+      # Execute the pull command.
+      def pull
+        @git_repo.pull(remote, branch)
+        @last_read_pull = Time.new
+      rescue Exception => e
+        $stderr.puts "Git pull failed: #{e}"
+      end
+
+      # Execute the push command after commiting all.
+      def push
+        @git_repo.commit_all("transaction added 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

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+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']
+        @append_file = options[:ledger_append_file] || ENV['LEDGER_FILE']
+        @home = options[:ledger_home] || ''      # Return a budget representation
+      end
+
+      # Execute ledger command with given parameters
+      def exec(cmd, params = {})
+        Git.invoke :before_read
+
+        params = {
+          '-f' => @file
+        }.merge(params)
+
+        params = params.inject '' do |acc, key, val|
+          acc << " #{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|
+          if f.pos == 0
+            last_char = "\n"
+          else
+            f.pos = f.pos-1
+            last_char = f.getc
+          end
+
+          f.write "\n" unless last_char == "\n"
+          f.write(transaction_string)
+        end
+      end
+
+      # Return the ledger version.
+      def version
+        exec("--version").match(/^Ledger (.*),/)[1]
+      end
+
+      # Get a new transaction entry based on previous entries found
+      # in the append file.
+      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") }
+      end
+
+      # Returns an Array of payees with their respective usage count.
+      def payees_with_usage
+
+      end
+
+      # Return an array of accounts.
+      def accounts(query = nil)
+        result = exec "accounts #{query if query}"
+        { :accounts => result.split("\n") }
+      end
+
+      # Return an Array of accounts with their respective usage count.
+      def accounts_with_usage
+
+      end
+    end
+
+  end
+end