billtrap 0.0.2

data/lib/billtrap/cmd/usage.rb

@@ -0,0 +1,80 @@
+module BillTrap
+  module CLI
+    def usage 
+      <<-EOF
+
+Billtrap - Manage invoices, import time slices from Timetrap
+
+Usage: bt COMMAND [OPTIONS] [ARGS...]
+
+COMMAND can be abbreviated. For example `bt edit --delete 1` and `bt e -d 1` are equivalent.
+
+COMMAND is one of:
+
+  * configure - Write out a YAML config file to HOME/.billtrap.yml.
+    usage: bt configure
+
+  * client - Manage clients (adding, deleting and connecting to current invoice)
+    usage: bt client [--add] [--delete [ID]] [--set [ID]]
+    -a, --add         Manually add a client, reads from STDIN
+    -d, --delete      Delete a client. If no ID is given, prints all clients.
+                      Note: Clients cannot be deleted if a non-archived invoiced is linked to it.
+
+  * entry - Edit the active invoice, adding or deleting invoice entries manually 
+    usage: bt edit [--add] [--delete [ID]]
+    -a, --add         Manually add an invoice entry (timeslice or product), reads from STDIN
+    -d, --delete      Delete an invoice entry. If no ID is given, prints all entries and asks for an ID.
+
+  * export - Export active invoice, using the default adapter (Serenity)
+    -a, --adapter     Override the default adapter
+
+  * in - Switch to another invoice, making it active for edits
+    usage: bt in [ID | NAME]
+
+  * import - Import data from Timetrap. Sets invoice title to the sheet name and description to notes
+    usage: bt import [--clear] [--sheet NAME] [--entry ID [ID ..]]
+    -c, --clear       Clears ALL invoice entries before import
+    -e, --entry       Import the given entries.
+    -s, --sheet       Import all entries from the given sheet. 
+
+  * new - Create a new invoice, activating it for edits
+    usage: bt new [--name NAME] [--date DATE] [--client ID | NAME]
+    -c, --client      Tie the invoice to a client
+    -d, --date        Set to override invoice date (defaults to today)
+    -n, --name        Set invoice reference name
+
+  * payment - add, remove payments to current id
+    usage: bt payment [--add AMOUNT ['NOTES']] [--delete ID]
+    -a, --add         Add a payment to current invoice
+    -d, --delete      Delete a payment by ID from current invoice
+
+  * set - Set variables on the current invoice
+    usage: bt set TOKEN [VALUE]
+    Where TOKEN is one of
+      client          Set a client by id or surname
+      date            Set the `created on` date (YYYY-MM-DD), leave empty for today
+      name            Set name of current invoice
+      sent            Set the `sent on` date (YYYY-MM-DD), leave empty for today
+      other           Add { 'other' => VALUE } to the invoice's custom attributes.
+                      Use this to set attributes for populating templates
+
+  * show - Display a list invoices. Shows pending invoices by default (open or unpaid)
+    usage: bt show [--details ID | NAME] [--completed]
+    -d, --detail      Show details (including entries) of a particular invoice
+    -c, --completed   Show only completed (i.e., sent and paid) invoices
+
+  GLOBAL OPTIONS
+  Use global options by prepending them before any command.
+  --debug         Display stack traces for errors.
+  usage: bt --debug COMMAND [ARGS]
+
+  OTHER OPTIONS
+  -h, --help      Display this help.
+
+  EXAMPLES
+
+  Please submit bugs and feature requests to http://github.com/oliverguenther/billtrap/issues
+      EOF
+    end
+  end
+end

data/lib/billtrap/config.rb

@@ -0,0 +1,68 @@
+module BillTrap
+  module Config
+    extend self
+
+    CONFIG_PATH = File.join(BILLTRAP_HOME, 'billtrap.yml')
+
+    # Application defaults.
+    #
+    # These are written to BILLTRAP_CONFIG_PATH or <HOME>/.billtrap/billtrap.yml by executing
+    # <code>
+    # billtrap configure
+    # </code>
+    def defaults
+      {
+        # Database identifier, defaults to 'sqlite://<BILLTRAP_HOME>/.billtrap.db'
+        'database' => "sqlite://#{BILLTRAP_HOME}/billtrap.db",
+        # Timetrap database, used to import Entries
+        'timetrap_database' => "sqlite://#{ENV['HOME']}/.timetrap.db",
+        # We'll also need the round specifier
+        'round_in_seconds' => 900,
+				# Path to invoice archive
+				'billtrap_archive' => "#{ENV['HOME']}/Documents/billtrap/invoices",
+        # Currency to use (see RubyMoney for codes)
+        'currency' => 'USD',
+        # Default rate in the above currency
+        'default_rate' => '25.00',
+				# Invoice numbering scheme
+        # TODO possible values
+				'invoice_number_format' => "%Y%m%d_%{invoice_id}",
+        # Money formatter
+        # See http://rubydoc.info/gems/money/Money/Formatting for options
+        'currency_format' =>  { :with_currency => true , :symbol => false},
+        # Date output format
+        'date_format' => '%Y-%m-%d',
+				# Due date in days
+				'due_date' => 30,
+        # Default invoice adapter to use when none is specified
+        'default_formatter' => 'serenity',
+        # Serenity adapter: Path to invoice template
+        'serenity_template' => "#{BILLTRAP_HOME}/.billtrap_template.odt",
+      }
+    end
+
+    def [](key)
+      overrides = File.exist?(CONFIG_PATH) ? YAML.load(erb_render(File.read(CONFIG_PATH))) : {}
+      defaults.merge(overrides)[key]
+    rescue => e
+      warn "invalid config file"
+      warn e.message
+      defaults[key]
+    end
+
+    def erb_render(content)
+      ERB.new(content).result
+    end
+
+    def configure!
+      configs = if File.exist?(CONFIG_PATH)
+        defaults.merge(YAML.load_file(CONFIG_PATH))
+      else
+        defaults
+      end
+      File.open(CONFIG_PATH, 'w') do |fh|
+        fh.puts(configs.to_yaml)
+      end
+    end
+  end
+end

data/lib/billtrap/helpers.rb

@@ -0,0 +1,17 @@
+module BillTrap
+  module Helpers
+
+    def is_i? val
+      !!(val.is_a? Integer or val =~ /^\d+$/)
+    end 
+
+    def format_date d, format_str=BillTrap::Config['date_format']
+      d.strftime(format_str)
+    end
+
+    def format_money m, opts=BillTrap::Config['currency_format']
+      m.format(opts)
+    end
+
+  end
+end

data/lib/billtrap/models.rb

@@ -0,0 +1,239 @@
+require 'sequel'
+# uses json for serialization of
+# custom invoice flags
+require 'json'
+
+# encoding: UTF-8
+module BillTrap
+  class Client < Sequel::Model
+    extend Helpers
+    one_to_many :invoices
+
+    # Retrieve client
+    # If numeric, assumes it's an ID
+    # If string, returns first match c == surname
+    # Returns nil otherwise / if no match was found
+    def self.get c
+      if is_i? c
+        Client[c]
+      elsif c.is_a? String
+        Client.find(:surname => c)
+      else
+        nil
+      end
+    end
+
+
+    def name
+      "#{firstname} #{surname}"
+    end
+
+ end
+
+ class Invoice < Sequel::Model
+  extend Helpers
+
+  # Associates to a client
+  many_to_one :client
+
+  # Associates to many InvoiceEntries
+  one_to_many :invoice_entries
+
+  # Associates to many Payments
+  one_to_many :payments
+
+  # Serialize custom flags
+  plugin :serialization, :json, :attributes
+
+  def self.open
+    all.select { |i| !i.paid? }
+  end
+
+  def self.completed
+    exclude(:sent => nil).all.select { |i| i.paid? }
+  end
+
+  # Retrieve invoice
+  # If numeric, assumes it's an ID
+  # If string, returns first match inv == name
+  # Returns nil otherwise / if no match was found
+  def self.get inv
+    if is_i? inv
+      Invoice[inv]
+    elsif inv.is_a? String
+      Invoice.find(:name => inv)
+    else
+      nil
+    end
+  end
+
+  def self.current= id
+    last = Meta.find_or_create(:key => 'current_invoice')
+    last.value = id
+    last.save
+  end
+
+  def self.current
+    last = Meta.find(:key => 'current_invoice')
+    Invoice[last.value]
+  end
+
+  def currency
+    if client_id
+      client.currency
+    else
+      BillTrap::Config['currency']
+    end
+  end
+
+  def set_attr k,v
+    attributes[k] = v
+    save
+  end
+
+  def total
+    sum = Money.new(0, currency)
+    entries = InvoiceEntry.filter(:invoice_id=>id)
+    entries.each do |entry|
+      sum += entry.total
+    end
+    return sum
+  end
+
+  def paid?
+    if sent.nil?
+      return false
+    end
+    # TODO == vs. >= ?
+    puts "received = #{received_amount}, total = #{total}"
+    return received_amount == total
+  end
+
+  def rate
+    rate = if client.nil?
+      BillTrap::Config['default_rate']
+    else
+      client.rate
+    end
+    Money.parse(rate, currency)
+  end
+
+
+  def received_amount
+    cents = Payment.where(:invoice_id => id).sum(:cents)
+    Money.new(cents, currency)
+  end
+
+  def overdue?
+    due_date > Date.today
+  end
+
+  def due_date
+   created + BillTrap::Config['due_date']
+ end
+
+end
+
+class InvoiceEntry < Sequel::Model
+
+  # Associates with one invoice
+  many_to_one :invoice
+
+  def typed_amount
+   return "#{count}#{unit}"
+  end
+
+  def total
+    Money.new(cents, invoice.currency) * count
+  end
+
+end
+
+class Payment < Sequel::Model
+
+  # Associates with one invoice
+  many_to_one :invoice
+
+  def amount
+    Money.new(cents, invoice.currency)
+  end
+end
+
+
+class Entry < Sequel::Model(TT_DB)
+  class << self
+    attr_accessor :round
+  end
+
+  def round?
+    !!self.class.round
+  end
+
+  def date
+   start.to_date
+  end
+
+  def start= time
+   self[:start]= Timer.process_time(time)
+  end
+
+  def end= time
+    self[:end]= Timer.process_time(time)
+  end
+
+  def start
+    round? ? rounded_start : self[:start]
+  end
+
+  def end
+    round? ? rounded_end : self[:end]
+  end
+
+  def sheet
+    self[:sheet].to_s
+  end
+
+  def duration
+    @duration ||= self.end_or_now.to_i - self.start.to_i
+  end
+
+  def duration
+    @rounded_duration ||= self.end_or_now.to_i - self.start.to_i
+  end
+
+
+  def end_or_now
+    self.end || (round? ? round(Time.now) : Time.now)
+  end
+
+  def rounded_start
+    round(self[:start])
+  end
+
+  def rounded_end
+    round(self[:end])
+  end
+
+  def round time, roundsecs=BillTrap::Config['round_in_seconds']
+    return nil unless time
+    Time.at(
+      if (r = time.to_i % roundsecs) < 450
+        time.to_i - r
+      else
+        time.to_i + (roundsecs - r)
+      end
+      )
+  end
+
+  def self.sheets
+    map{|e|e.sheet}.uniq.sort
+  end
+
+  end
+
+  class Meta < Sequel::Model(:meta)
+    def value
+      self[:value].to_s
+    end
+  end
+end

data/lib/billtrap/version.rb

@@ -0,0 +1,3 @@
+module BillTrap
+  VERSION = "0.0.2"
+end

data/lib/serenity/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Tomas Kramar
+
+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/lib/serenity/serenity.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), 'serenity' , 'line')
+require File.join(File.dirname(__FILE__), 'serenity' , 'debug')
+require File.join(File.dirname(__FILE__), 'serenity' , 'escape_xml')
+require File.join(File.dirname(__FILE__), 'serenity' , 'node_type')
+require File.join(File.dirname(__FILE__), 'serenity' , 'odteruby')
+require File.join(File.dirname(__FILE__), 'serenity' , 'template')
+require File.join(File.dirname(__FILE__), 'serenity' , 'xml_reader')
+require File.join(File.dirname(__FILE__), 'serenity' , 'generator')