billtrap 0.0.2

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Oliver Guenther
+
+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,218 @@
+# Billtrap
+
+
+Billtrap is a command line invoice management tool in ruby.
+It allows creation and monitoring of invoices and exporting data using template formatters.
+
+Billtrap is based on the time tracking tool [Timetrap](https://github.com/samg/timetrap) by Sam Goldstein, and allows importing time entries from Timetrap into invoices.
+However, Billtrap can be used to create invoices manually without data from Timetrap.
+
+
+
+## Installation
+To install, use rubygems:
+
+	gem install billtrap
+
+This will place the Billtrap executable `bt` in your path.
+
+## Usage
+
+If you call Billtrap without any argument (or using --help) will
+display usage information:
+
+	$ bt --help
+
+### Configuring BillTrap
+
+Use `bt configure` to write a config file to `HOME/.billtrap/billtrap.yml` (Override by setting BILLTRAP_HOME in env)
+
+The following options are supported
+
+- **database**: Sequel Databsae identifier, defaults to `sqlite://<BILLTRAP_HOME>/.billtrap.db`
+- **timetrap_database**: Timetrap database, used to import Entries
+- **round_in_seconds** => 900,
+- **currency**: Currency to use (see [RubyMoney.format](http://rubydoc.info/gems/money/Money/Formatting:format) for options)
+- **default_rate**: Default rate in the above currency
+- **invoice_number_format**: Invoice numbering format. Expands [Date.strftime directives](http://ruby-doc.org/stdlib-2.0/libdoc/date/rdoc/Date.html#method-i-strftime) and `%{invoice_id}`, `%{client_id}` upon export of the invoice (e.g., `%Y%m%d_%{invoice_id}`)
+- **currency_format**: Money formatter, see <http://rubydoc.info/gems/money/Money/Formatting> for output options
+- **date_format**: date format
+- **billtrap_archive**: Output path for exported invoices
+- **serenity_template**: OOffice adapter: Path to invoice template
+
+### Adding invoices
+
+Add a **new** invoice with the title *Some important project* to Billtrap and activate it:
+
+	$ bt new --name 'Some important project'
+
+You can also specify a certain date (using [Chronic keywords](https://github.com/mojombo/chronic)) to use with the invoice:
+
+	# Adds an unnamed invoice, dated yesterday
+	$ bt new --date yesterday
+
+### Switching between invoices
+
+To display the current set of open invoices, use `bt show`.
+
+	$ bt show
+	Showing open invoices
+	 ID    Name        				Client          Created         Payments / Total
+	 1     Some important project     -             2013-04-12      0,00 EUR / 0,00 EUR
+	 >>2    -  				          -             2013-04-11      0.00 USD / 0.00 USD
+
+Billtrap manages a set of invoices, and allows you to focus on one invoice at a time.
+The "**>>**" marks the current active invoice (ID 2), which we just added with `--date yesterday`.
+
+To switch between invoices, use the `in` comand with the ID of the invoice to switch to.
+Now, to switch to the 'Some important project' invoice, enter:
+
+	$ bt in 1
+	Activating invoice #1
+
+The active invoice is persisted between calls, i.e., you always
+edit the latest invoice until `bt in` or `bt new` is called.
+
+### Editing the active invoice
+Let's add some entries to the important project by executing
+`bt entry --add`. This will read the entry from STDIN.
+
+	$ bt entry --add
+	Entry title: Programming
+	Entry date (YYYY-MM-DD): 2013-04-10
+	Displayed unit (Defaults to 'h' for hours):
+	Quantity (Numeric): 2.5
+	Price in USD per unit (Numeric): 20
+	Optional Notes: (Multiline input, type Ctrl-D or insert END and return to exit)
+	^D
+
+	Added entry (#1) to current invoice (ID 1)
+
+Lets check the values we entered with `bt show --detail 1`,
+which displays details for the invoice with ID 1.
+
+	$ bt show --detail 1
+
+	Invoice:    Some important project (#1)
+	Created on: 2013-04-13
+	----------------------
+	Invoice entries
+	  Title          Date        Quantity    Price       Notes
+	  Programming    2013-04-10  2.5h        50.00 USD   
+
+### Importing data from Timetrap
+If you manage your time using Timetrap, you can use the `import` command to import entries to the current invoice.
+
+Assume you have a sheet called *test* with three entries.
+	
+	$ t display test
+    Day                Start      End        Duration   Notes
+    Sat Oct 29, 2011   22:42:36 - 23:13:02   0:30:26    Foo
+                                             0:30:26
+    Sat Nov 17, 2012   23:13:57 - 23:14:07  24:00:10    Bar
+                                            24:00:10
+    Sun Nov 18, 2012   22:26:00 - 22:31:20   0:05:20    Moo
+
+You can import the whole sheet into BillTrap using the following command:
+
+	$ dbt impoort --sheet test
+
+	Imported 0.51 hours from sheet test as entry #2
+	Imported 0.09 hours from sheet test as entry #3
+	Imported 24.0 hours from sheet test as entry #4
+
+You could also import single IDs into the current invoice:
+
+	$ dbt import --entry 1 2
+	Imported 0.51 hours from sheet test as entry #5
+	Imported 0.09 hours from sheet test as entry #6
+
+
+If you wish to clear all entries *prior* to the import,
+use the `--clear` flag:
+
+	$ dbt import --entry 1 2
+	Imported 0.51 hours from sheet test as entry #1
+	Imported 0.09 hours from sheet test as entry #2
+
+**Beware:** Using the `--clear` flag does not ask for confirmation prior to deleting all entries of the current invoice.
+
+
+### Setting a client
+
+BillTrap allows you to add and manage clients.
+**Note**: This feature is still rudimentary and subject to change.
+
+Use `bt client --add` to add a client from STDIN:
+
+	$ bt client --add
+	First name: John
+	Surname: Doe
+	Company: Doemasters Inc.
+	Address: (Multiline input, type Ctrl-D or insert END and return to exit)
+	Somestreet 12  
+	12345 Sometown^D
+	Mail: mail@example.com
+	Hourly rate: 25
+	Use non-standard Currency? [Leave empty for USD]: EUR
+
+	Client John Doe was created with id 1
+
+Let's set *John Doe* as the client for our important project.
+
+	# Equivalent to 'bt set client 1'
+	$ bt set client Doe
+
+	SET client to John Doe (#1)
+
+**Note**: The client currency setting overrides BillTrap's default setting, thus the currency for all entries of invoice #1
+have changed to EUR.
+
+### Exporting invoices
+Let's review our changes to the Invoice #1:
+
+	$ bt show
+	Showing open invoices
+	 ID    Name                      Client                  Created         Payments / Total
+	 >>1   Some important project    John Doe                2013-04-13      0,00 EUR / 50,00 EUR
+	 2      -                         -                      2013-04-12      0.00 USD / 0.00 USD
+
+To export the invoice:
+
+	$ bt export
+
+	Generated invoice has been output to: /Users/oliver/Documents/billtrap/invoices/2013/4/13/1.odt
+
+Currently, the only working adapter uses the [serenity gem](https://github.com/kremso/serenity) to populate a Open/LibreOffice template of your choosing and renders an ODT.
+
+**Note**: Have a look at the config (see *configuring BillTrap*) to change invoice numbering, output paths et cetera.
+
+I'm working on creating more adapters. If you want to participate in the discussion, I suggest opening an issue on the [Github tracker](http://github.com/oliverguenther/Billtrap/issues).
+
+### Abbreviating commands
+All commands and their paremeters can be abbreviated.
+For example, instead of `bt new --date yesterday`, you could also enter with same result:
+
+	$ bt n -d yesterday
+
+BillTrap warns you about ambiguous command abbreviations, e.g.,
+
+	$ bt s
+	Error: Ambiguous command 's'
+	Matching commands are: set, show
+
+## Special Thanks
+
+I'd like to thank Sam Goldstein for his work on Timetrap, which motivated me to improve on my time management and to start this project.
+
+Billtrap intentionally borrows heavily from Timetrap, which is available at <https://github.com/samg/timetrap>.
+
+--------
+
+## Bugs and Feature Requests
+
+Billtrap is still under heavy development.
+
+If you have feature requests or found a bug, please file an issue on the Github tracker:
+
+<http://github.com/oliverguenther/Billtrap/issues>

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+desc 'Default: run spec.'
+task :default => :spec
+
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'billtrap/version'
+Rake::RDocTask.new do |rdoc|
+  version = BillTrap::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "BillTrap #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/billtrap/**/*.rb')
+  rdoc.rdoc_files.include('lib/billtrap.rb')
+end

data/billtrap.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'billtrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name           = "billtrap"
+  spec.version        = BillTrap::VERSION
+  spec.authors        = ["Oliver Günther"]
+  spec.email          = ["mail@oliverguenther.de"]
+  spec.summary        = "Command line invoice management."
+  spec.description    = "This gem provides invoice management with imported time slices from the Timetrap gem."
+  spec.homepage       = "http://github.com/oliverguenther/billtrap/"
+  spec.license        = "MIT"
+
+  spec.files          = `git ls-files`.split($/)
+  spec.bindir         = "bin"
+  spec.executables    = ['bt']
+  spec.test_files     = ['spec/']
+  spec.require_paths  = ['lib']
+
+  spec.add_dependency "sequel", ">= 3.9.0"
+  spec.add_dependency "sqlite3", ">= 1.3.3"
+  spec.add_dependency "chronic", ">= 0.6.4"
+  spec.add_dependency "json", ">= 1.4.6"
+  spec.add_dependency "trollop", ">= 2.0"
+  spec.add_dependency "money", ">= 5.0"
+  spec.add_dependency "timetrap", ">= 1.5"
+  spec.add_dependency "rubyzip"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2'
+  spec.add_development_dependency 'fakefs'
+end

data/bin/bt

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+begin
+  require 'billtrap'
+rescue LoadError
+  if File.symlink? __FILE__
+    require File.dirname(File.readlink(__FILE__)) + '/../lib/billtrap'
+  else
+    require File.dirname(__FILE__) + '/../lib/billtrap'
+  end
+end
+BillTrap::CLI.args = Array.new(ARGV)
+BillTrap::CLI.invoke

data/bin/dev_b

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# Executable with absolute path to lib for hacking and development
+require File.join(File.dirname(__FILE__), '..', 'lib', 'billtrap')
+# run on argv
+BillTrap::CLI.args = Array.new(ARGV)
+BillTrap::CLI.invoke

data/lib/billtrap.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+require "rubygems"
+require 'sequel'
+# Load migrations
+Sequel.extension :migration, :core_extensions
+# Load inflector (String.classify)
+Sequel.extension :inflector
+
+require 'chronic'
+require 'money'
+require 'yaml'
+require 'erb'
+require 'trollop'
+require 'pathname'
+
+# require serenity 0.2.2
+require File.join(File.dirname(__FILE__), 'serenity', 'serenity')
+
+# Set billtrap home
+BILLTRAP_HOME = ENV['BILLTRAP_HOME'] || File.join(ENV['HOME'], '.billtrap')
+
+
+BILLTRAP_PATH = Pathname.new(__FILE__).realpath.dirname.to_s
+$:.unshift(BILLTRAP_PATH + '/billtrap')
+require 'version'
+require 'config'
+require 'helpers'
+require 'cli'
+require 'adapters'
+module BillTrap
+  # Force encoding to utf-8
+  Encoding.default_internal= Encoding::UTF_8
+  Sequel::Model.plugin :force_encoding, Encoding::UTF_8
+
+
+  unless File.directory? BILLTRAP_HOME
+    FileUtils.mkdir BILLTRAP_HOME
+  end
+
+
+  # We need to inclue spec testing here, as RSpec doesn't allow
+  # stubs in around blocks, but we need around blocks for Sequel transactions
+	DB_NAME = defined?(SPEC_RUNNING) ? "sqlite://test.db" : BillTrap::Config['database']
+	DB = Sequel.connect(DB_NAME)
+
+  # Update to latest migration, if necessary
+  unless (Sequel::Migrator.is_current? DB, File.dirname(__FILE__) + '/../migrations/')
+    Sequel::Migrator.run(DB, File.dirname(__FILE__) + '/../migrations/')
+  end
+
+  # Open TT timetrap_databasee
+  TT_DB_NAME = defined?(SPEC_RUNNING) ? "sqlite://testTT.db" : BillTrap::Config['timetrap_database']
+  TT_DB = Sequel.connect(TT_DB_NAME)
+
+end
+require 'models'

data/lib/billtrap/adapters.rb

@@ -0,0 +1,12 @@
+module BillTrap
+  module Adapters
+    extend self
+
+    def load_adapter name
+      adapter = name.downcase
+      require "adapters/#{adapter}"
+      # Try to load the adapter
+      BillTrap::Adapters.const_get(adapter.classify)
+    end
+  end
+end

data/lib/billtrap/adapters/ooffice.rb

@@ -0,0 +1,27 @@
+module BillTrap
+  module Adapters
+    class Ooffice
+      # uses Serenity for ODT output
+      include ::Serenity::Generator
+      include BillTrap::Helpers
+      attr_reader :id
+
+      def initialize attributes
+        attributes.each do |key, val|
+          # slurp attributes into instances variables
+          instance_variable_set("@#{key}", val)
+        end
+      end
+
+      def generate
+        date = @invoice[:created]
+        output_path = "#{Config['billtrap_archive']}/#{date.year}/#{date.month}/#{date.mday}"
+        FileUtils.mkpath(output_path)
+
+        render_odt Config['serenity_template'], "#{output_path}/#{@invoice.id}.odt"
+        puts "Generated invoice has been output to: #{output_path}/#{@invoice.id}.odt"
+    end
+
+  end
+end
+end