ydim 1.0.0

data/lib/ydim/autoinvoicer.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# AutoInvoicer -- ydim -- 13.01.2006 -- hwyss@ywesee.com
+
+require 'date'
+require 'pdfinvoice/config'
+require 'pdfinvoice/invoice'
+require 'odba/odba'
+require 'ydim/debitor'
+require 'ydim/mail'
+
+module YDIM
+	class AutoInvoicer
+		def initialize(serv)
+			@serv = serv
+		end
+		def run
+			Debitor.odba_extent { |debitor| 
+				autoinvoice(debitor)
+			}
+		end
+		def autoinvoice(debitor)
+      today = Date.today
+      next_month = today >> 1
+      debitor.autoinvoices.each { |auto|
+        if(auto.total_netto > 0)
+          case auto.date
+          when today
+            Mail.send_invoice(@serv.config, generate(auto)) 
+          when next_month
+            Mail.send_reminder(@serv.config, auto)
+          end
+        end
+      }
+		end
+		def generate(autoinvoice)
+      ODBA.transaction {
+        @serv.factory.generate_invoice(autoinvoice)
+      }
+		end
+	end
+end

data/lib/ydim/client.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# Client -- ydim -- 12.01.2006 -- hwyss@ywesee.com
+
+require 'drb'
+
+module YDIM
+	class Client
+		include DRb::DRbUndumped
+		attr_reader :session
+		def initialize(config)
+			@config = config
+			DRb.start_service(config.client_url)
+		end
+		def login(server, private_key)
+			@server = server
+			@session = @server.login(self, @config.user) { |challenge|
+				if(private_key.respond_to?(:syssign))
+					private_key.syssign(challenge)
+				end
+			}
+		end
+		def logout
+			@server.logout(@session) if(@server)
+		end
+		def method_missing(meth, *args, &block)
+			@session.send(meth, *args, &block)
+		end
+	end
+end

data/lib/ydim/config.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# CONFIG -- ydim -- 12.01.2006 -- hwyss@ywesee.com
+
+require 'rclconf'
+require 'fileutils'
+
+module YDIM
+        VERSION = '1.0.0'
+	class Client
+		home_dir = ENV['HOME'] || '/tmp'
+		ydim_default_dir = File.join(home_dir, '.ydim')
+		default_config_files = [
+			File.join(ydim_default_dir, 'ydim.yml'),
+			'/etc/ydim/ydim.yml',
+		]
+		defaults = {
+			'client_url'					=> 'druby://localhost:0',
+			'config'							=> default_config_files,
+			'private_key'					=> File.join(home_dir, '.ssh', 'id_dsa'),
+			'user'								=> nil,
+			'server_url'					=> 'druby://localhost:12375', 
+			'currency'						=> 'EUR',
+			'invoice_description'	=> 'Auto-Invoice',
+      'mail_charset'        => 'iso-8859-1',
+			'payment_period'			=> 30,
+		}
+		config = RCLConf::RCLConf.new(ARGV, defaults)
+		config.load(config.config)
+
+		CONFIG = config
+	end
+end

data/lib/ydim/currency_converter.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# CurrencyConverter -- ydim -- 01.02.2006 -- hwyss@ywesee.com
+
+module YDIM
+	class MobileCurrencyConverter
+		def initialize(conversions={})
+			@conversions = conversions
+		end
+		def convert(amount, origin, target)
+			return amount if(origin == target)
+			amount.to_f * @conversions.fetch([origin, target]) { 
+				raise "Unknown Conversion '#{origin}' -> '#{target}'"
+			}
+		end
+	end
+	class CurrencyConverter < MobileCurrencyConverter
+		def drb_dup
+			MobileCurrencyConverter.new(@conversions)
+		end
+		def known_currencies
+			@conversions.keys.collect { |origin, target| origin }.uniq.size
+		end
+		def store(origin, target, rate)
+			@conversions.store([target, origin], 1.0/rate)
+			@conversions.store([origin, target], rate)
+		end
+	end
+end

data/lib/ydim/currency_updater.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# CurrencyUpdater -- ydim -- 01.02.2006 -- hwyss@ywesee.com
+
+require 'net/http'
+
+module YDIM
+	class CurrencyUpdater
+		def initialize(serv)
+			@serv = serv
+		end
+		def run
+			curr = @serv.config.currencies.dup
+			while(origin = curr.shift)
+				curr.each { |target|
+					update_conversion(origin, target)
+				}
+			end
+			@serv.currency_converter.odba_store
+		end
+		def extract_conversion(html)
+			if(match = /1\s+[^<>=]+=\s+(\d+\.\d+)/.match(html))
+				match[1]
+			end
+		end
+		def get_conversion(origin, target)
+			extract_conversion(get_html(origin, target)).to_f
+		end
+		def get_html(origin, target)
+			## not in test-suite, test manually when modified
+			Net::HTTP.start('www.google.com') { |session|
+				session.get("/search?q=1+#{origin.upcase}+in+#{target.upcase}").body
+			}
+		end
+		def update_conversion(origin, target)
+			@serv.currency_converter.store(origin, target, 
+																		 get_conversion(origin, target))
+		end
+	end
+end

data/lib/ydim/debitor.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# Debitor -- ydim -- 10.01.2006 -- hwyss@ywesee.com
+
+require 'ydim/item'
+
+module YDIM
+	class Debitor
+		attr_reader :autoinvoices, :unique_id, :invoices
+    attr_accessor :address_lines, :contact, :contact_firstname,
+      :contact_title, :country, :debitor_type, :email, :location,
+      :name, :salutation, :phone
+		def initialize(unique_id)
+			@unique_id = unique_id
+			@address_lines = []
+			@invoices = []
+      @autoinvoices = []
+		end
+    def autoinvoice(unique_id)
+      @autoinvoices.find { |invoice| invoice.unique_id == unique_id }
+    end
+    def autoinvoice_infos
+      @autoinvoices.collect { |inv| inv.info }
+    end
+    def add_autoinvoice(invoice)
+      @autoinvoices.push(invoice)
+      invoice
+    end
+		def add_invoice(invoice)
+			@invoices.push(invoice)
+			invoice
+		end
+		def address
+			lns = [@name]
+			lns.push(["z.H.", @salutation, 
+							 @contact_firstname, @contact].compact.join(' '))
+			lns.push(@contact_title)
+			lns.concat(@address_lines)
+			lns.push(@location, @country)
+      if @email
+        lns.push "To: #@email"
+        unless emails_cc.empty?
+          lns.push "Cc: #{emails_cc.join(', ')}"
+        end
+      end
+			lns.compact!
+			lns
+		end
+    def delete_autoinvoice(invoice)
+      @autoinvoices.delete(invoice)
+    end
+		def delete_invoice(invoice)
+			@invoices.delete(invoice)
+		end
+    def emails_cc
+      @emails_cc ||= []
+    end
+    def emails_cc=(emails)
+      @emails_cc = emails
+    end
+    def emails
+      [ @email ].concat(emails_cc).compact
+    end
+    def emails=(emails)
+      @email = emails.shift
+      @emails_cc = emails
+      emails
+    end
+    def foreign?
+      @country && !@country.to_s.strip.empty? \
+        && @country != Server.config.home_country
+    end
+		def invoice(unique_id)
+			@invoices.find { |invoice| invoice.unique_id == unique_id }
+		end
+		def invoice_infos(status)
+			@invoices.select { |inv| 
+				inv.status == status 
+			}.collect { |inv| inv.info }
+		end
+		def next_invoice_date
+			@autoinvoices.collect { |inv| inv.date }.compact.min
+		end
+		private
+		include ItemId
+	end
+end

data/lib/ydim/factory.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# Factory -- ydim -- 16.01.2006 -- hwyss@ywesee.com
+
+require 'ydim/debitor'
+require 'ydim/invoice'
+
+module YDIM
+	class Factory
+		def initialize(serv)
+			@serv = serv
+		end
+		def create_autoinvoice(debitor)
+			id = @serv.id_server.next_id(:autoinvoice, 
+                                   @serv.config.invoice_number_start)
+			invoice = AutoInvoice.new(id)
+			yield(invoice) if(block_given?)
+      if debitor.foreign?
+        invoice.suppress_vat = true
+      end
+			invoice.debitor = debitor
+			debitor.autoinvoices.odba_store
+			invoice
+		end
+		def create_invoice(debitor)
+			id = @serv.id_server.next_id(:invoice, @serv.config.invoice_number_start)
+			invoice = Invoice.new(id)
+			yield(invoice) if(block_given?)
+			invoice.debitor = debitor
+      if debitor.foreign?
+        invoice.suppress_vat = true
+      end
+			debitor.invoices.odba_store
+			invoice
+		end
+    def generate_invoice(autoinvoice)
+      create_invoice(autoinvoice.debitor) { |inv|
+        date = autoinvoice.date || Date.today
+        nextdate = autoinvoice.advance(date)
+        inv.date = date
+        inv.currency = autoinvoice.currency
+        inv.description = sprintf("%s %s-%s", autoinvoice.description,
+                                  date.strftime("%d.%m.%Y"),
+                                  (nextdate - 1).strftime("%d.%m.%Y"))
+        inv.precision = autoinvoice.precision
+        inv.payment_period = autoinvoice.payment_period
+        autoinvoice.items.each { |item|
+          nitem = item.dup
+          nitem.time = Time.now
+          nitem.expiry_time = Time.local(nextdate.year, nextdate.month,
+                                         nextdate.day)
+          nitem.vat_rate = @serv.config.vat_rate
+          inv.add_item(nitem)
+        }
+        autoinvoice.odba_store
+      }
+    end
+	end
+end

data/lib/ydim/invoice.rb

@@ -0,0 +1,146 @@
+#!/usr/bin/env ruby
+# Invoice -- ydim -- 11.01.2006 -- hwyss@ywesee.com
+
+require 'pdfinvoice/config'
+require 'pdfinvoice/invoice'
+require 'ydim/item'
+require 'ydim/server'
+
+module YDIM
+	class Invoice
+		class Info
+			KEYS = [:unique_id, :date, :description, :payment_received, :currency,
+				:status, :debitor_name, :debitor_email, :debitor_id, :due_date,
+				:total_netto, :total_brutto, :deleted, :suppress_vat ]
+			attr_accessor *KEYS
+			def initialize(invoice)
+				KEYS.each { |key|
+					instance_variable_set("@#{key}", invoice.send(key))
+				}
+			end
+		end
+		attr_reader :unique_id, :debitor, :items, :suppress_vat
+		attr_accessor :precision, :date, :description, :payment_period, 
+			:payment_received, :currency, :deleted
+		def Invoice.sum(key)
+			define_method(key) {
+				@items.inject(0.0) { |value, item| value + item.send(key) }
+			}
+		end
+		def initialize(unique_id)
+			@unique_id = unique_id
+			@items = []
+			@precision = 2
+      @payment_period = 10
+		end
+    def invoice_key
+      :invoice
+    end
+		def add_item(item)
+			item.index = next_item_id
+			@items.push(item)
+			item
+		end
+		def debitor=(debitor)
+			if(@debitor)
+				@debitor.send("delete_#{invoice_key}", self)
+			end
+			if(debitor)
+				debitor.send("add_#{invoice_key}", self)
+			end
+			@debitor = debitor
+		end
+		def debitor_email
+			@debitor.email if(@debitor)
+		end
+		def debitor_id
+			@debitor.unique_id if(@debitor)
+		end
+		def debitor_name
+			@debitor.name if(@debitor)
+		end
+		def due_date
+			if(@date && !@payment_received)
+				@date + @payment_period.to_i
+			end
+		end
+    def empty?
+      @items.empty?
+    end
+		def info
+			Info.new(self)
+		end
+		def item(index)
+			@items.find { |item| item.index == index }
+		end
+		def status
+			if(@deleted)
+				'is_trash'
+			elsif(@payment_received)
+				'is_paid'
+			elsif(@date && @payment_period \
+						&& ((@date + @payment_period) < Date.today))
+				'is_due'
+			else
+				'is_open'
+			end
+		end
+    def pdf_invoice(sort_args={})
+      config = PdfInvoice.config.dup
+      config.formats['quantity'] = "%1.#{@precision}f"
+      config.formats['total'] = "#{@currency} %1.2f"
+      invoice = PdfInvoice::Invoice.new(config)
+      invoice.date = @date
+      invoice.invoice_number = @unique_id
+      invoice.description = @description
+      invoice.debitor_address = @debitor.address
+      items = @items
+      if sort_by = sort_args[:sortby]
+        begin
+          items = items.sort_by do |item|
+            item.send(sort_by)
+          end
+          if sort_args[:sort_reverse]
+            items.reverse!
+          end
+        rescue StandardError
+        end
+      end
+      invoice.items = items.collect { |item|
+        [ item.time, item.text, item.unit, item.quantity.to_f,
+          item.price.to_f, item.vat.to_f ]
+      }
+      invoice
+    end
+    def suppress_vat= bool
+      rate = bool ? 0 : YDIM::Server.config.vat_rate
+      @items.each do |item| item.vat_rate = rate end
+      @suppress_vat = bool
+    end
+    def to_pdf(sort_args={})
+      pdf_invoice(sort_args).to_pdf
+    end
+		sum :total_brutto
+		sum :total_netto
+		sum :vat
+		private
+		include ItemId
+	end
+  class AutoInvoice < Invoice
+    @@year_ptrn = %r{<year>([^<])*</year>}
+    attr_accessor :invoice_interval, :reminder_body, :reminder_subject
+    def invoice_key
+      :autoinvoice
+    end
+    def advance(date)
+      months = @invoice_interval.to_s[/\d+/].to_i
+      if @reminder_subject
+        @reminder_subject.gsub!(@@year_ptrn) do |match|
+          years = months / 12
+          match.gsub(%r{\d+}) do |year| (year.to_i + years).to_s end
+        end
+      end
+      @date = date >> months
+    end
+  end
+end

data/lib/ydim/item.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# Item -- ydim -- 11.01.2006 -- hwyss@ywesee.com
+
+module YDIM
+	class Item
+		DATA_KEYS = [ :data, :expiry_time, :item_type, :price, :quantity, :text,
+			:time, :unit, :vat_rate ]
+		attr_accessor :index, *DATA_KEYS
+		def initialize(data={})
+			update(data)
+		end
+		def total_brutto
+			total_netto + vat
+		end
+		def total_netto
+			@quantity.to_f * @price.to_f
+		end
+		def update(data)
+			data.each { |key, val|
+				if(DATA_KEYS.include?(key.to_sym))
+					instance_variable_set("@#{key}", val)
+				end
+			}
+		end
+		def vat
+			total_netto * (@vat_rate.to_f / 100.0)
+		end
+	end
+	module ItemId
+		def next_item_id
+			id = @next_item_id.to_i
+			@next_item_id = id.next
+			id
+		end
+	end
+end

data/lib/ydim/mail.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+# Mail -- ydim -- 18.01.2006 -- hwyss@ywesee.com
+
+require 'net/smtp'
+require 'rmail'
+require 'ydim/smtp_tls'
+
+module YDIM
+	module Mail
+		def Mail.body(config, debitor, invoice)
+			salutation = config.salutation[debitor.salutation.to_s]
+			sprintf(config.mail_body, salutation, debitor.contact, invoice.description)
+		end
+		def Mail.send_invoice(config, invoice, sort_args={})
+			debitor = invoice.debitor
+			to = debitor.email
+			subject = sprintf('Rechnung %s #%i, %s', debitor.name,
+							invoice.unique_id, invoice.description)
+			invoice_name = sprintf("%s.pdf", subject.tr(' /', '_-'))
+			mpart = RMail::Message.new
+			header = mpart.header
+			header.to = to
+      cc = header.cc = debitor.emails_cc
+			header.from = config.mail_from
+      header.subject = encode_subject config, subject
+      header.date = Time.now
+			tpart = RMail::Message.new
+			mpart.add_part(tpart)
+			tpart.header.add('Content-Type', 'text/plain', nil, 
+                       'charset' => config.mail_charset)
+			tpart.body = body(config, debitor, invoice)
+			fpart = RMail::Message.new
+			mpart.add_part(fpart)
+			header = fpart.header
+			header.add('Content-Type', 'application/pdf')
+			header.add('Content-Disposition', 'attachment', nil,
+				{'filename' => invoice_name })
+			header.add('Content-Transfer-Encoding', 'base64')
+			fpart.body = [invoice.to_pdf(sort_args)].pack('m')
+			recipients = config.mail_recipients.dup.push(to).concat(cc).uniq
+			Net::SMTP.start(config.smtp_server, config.smtp_port,
+                      config.smtp_domain, config.smtp_user, config.smtp_pass,
+                      config.smtp_authtype) { |smtp|
+				recipients.each { |recipient|
+					smtp.sendmail(mpart.to_s, config.smtp_user, recipient)
+				}
+			}
+			recipients
+    rescue Timeout::Error
+      retries ||= 3
+      if retries > 0
+        sleep 3 - retries
+        retries -= 1
+        retry
+      else
+        raise
+      end
+		end
+    def Mail.send_reminder(config, autoinvoice)
+      subject = autoinvoice.reminder_subject.to_s.strip
+      subject.gsub! %r{<year>\s*}, ''
+      subject.gsub! %r{\s*</year>}, ''
+      body = autoinvoice.reminder_body.to_s.strip
+      body.gsub! %r{<invoice>\s*}, ''
+      body.gsub! %r{\s*</invoice>}, ''
+      unless(subject.empty? || body.empty?)
+        debitor = autoinvoice.debitor
+        to = debitor.email
+        mpart = RMail::Message.new
+        header = mpart.header
+        header.to = to
+        cc = header.cc = debitor.emails_cc
+        header.from = config.mail_from
+        header.subject = encode_subject config, subject
+        header.date = Time.now
+        header.add('Content-Type', 'text/plain', nil, 
+                   'charset' => config.mail_charset)
+        mpart.body = body
+        recipients = config.mail_recipients.dup.push(to).concat(cc).uniq
+        Net::SMTP.start(config.smtp_server, config.smtp_port,
+                        config.smtp_domain, config.smtp_user, config.smtp_pass,
+                        config.smtp_authtype) { |smtp|
+          recipients.each { |recipient|
+            smtp.sendmail(mpart.to_s, config.smtp_user, recipient)
+          }
+        }
+        recipients
+      end
+		end
+    def Mail.encode_subject(config, subject)
+      encoded = [subject].pack('M').gsub("=\n", '').gsub(' ', '=20')
+      sprintf("=?%s?q?%s?=", config.mail_charset, encoded)
+    end
+	end
+end

data/lib/ydim/odba.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# ODBA -- ydim -- 10.01.2006 -- hwyss@ywesee.com
+
+require 'odba'
+require 'ydim/currency_converter'
+require 'ydim/debitor'
+require 'ydim/invoice'
+
+module ODBA
+  module Persistable
+    alias :save :odba_store
+  end
+end
+module YDIM
+	class CurrencyConverter
+		include ODBA::Persistable
+		ODBA_SERIALIZABLE = ['@conversions']
+	end
+	class Debitor
+		include ODBA::Persistable
+		ODBA_SERIALIZABLE = ['@address_lines', '@emails_cc', '@hosting_items']
+    odba_index :email
+    odba_index :name
+    odba_index :unique_id
+	end
+	class Invoice
+		include ODBA::Persistable
+    class << self
+      alias :all :odba_extent
+    end
+    alias :save :odba_store
+		ODBA_SERIALIZABLE = ['@items']
+    odba_index :status
+    odba_index :unique_id, :class_filter => :instance_of?
+	end
+	class AutoInvoice
+    odba_index :unique_id, :class_filter => :instance_of?
+	end
+end