=================================================================== RCS file: /cvs/RT/Invoicing/rt_invoices.pl,v retrieving revision 1.11 retrieving revision 1.29 diff -u -r1.11 -r1.29 --- RT/Invoicing/rt_invoices.pl 2011/03/22 01:16:32 1.11 +++ RT/Invoicing/rt_invoices.pl 2011/05/03 05:38:56 1.29 @@ -1,5 +1,5 @@ #!/usr/bin/perl -# $AFresh1$ +# $AFresh1: rt_invoices.pl,v 1.28 2011/04/19 03:35:12 andrew Exp $ ######################################################################## # Copyright (c) 2011 Andrew Fresh # @@ -20,12 +20,12 @@ use 5.010; -use YAML::Any; use Template; use RT::Client::REST; use RT::Client::REST::Ticket; use RT::Client::REST::User; +use File::Path; use DateTime; my $config = RTI::Config->new(); @@ -37,94 +37,16 @@ timeout => $rt_conf->{timeout}, ); my $tickets = RT::Client::REST::Ticket->new( rt => $rt ); -my $users = RT::Client::REST::User->new( rt => $rt ); $rt->login( username => $rt_conf->{user}, password => $rt_conf->{pass} ); +#use YAML; #print Dump $config, $state; exit; my $startdate; my $customers = $config->get('customers'); -CUSTOMER: while ( my ( $custid, $cust ) = each %{$customers} ) { - my %invoice = ( end => DateTime->now, ); - - if ( $cust->{base_rate} ) { - my $day = $cust->{day} || 1; - my $freq = $cust->{frequency} || 1; - - my $per; - my $day_method; - given ( $cust->{per} ) { - when ('week') { $per = 'weeks'; $day_method = 'dow' } - when ('month') { $per = 'months'; $day_method = 'day' } - default { die "Unknown per [$cust->{per}]\n" } - } - - my $billends - = DateTime->now->set( hour => 0, minute => 0, second => 0 ); - $billends->subtract( days => 1 ) while $billends->$day_method != $day; - - my $date = $billends->clone->subtract( $per => $freq ); - - my $lastinvoice = $state->last_invoice($custid); - if ( $lastinvoice->{date} ) { - my $last_invoice_date = ymd_to_DateTime( $lastinvoice->{date} ); - $date = $last_invoice_date->clone->add( days => 1 ); - } - - next CUSTOMER if $billends <= $date; - - my $title - = $freq == 1 - ? ucfirst( $cust->{per} . 'ly' ) - : $freq . ' ' . ucfirst( $cust->{per} ); - $title .= ' Retainer'; - - my %project = ( title => $title, fees => [], ); - - while ( $date < $billends ) { - my $start = $date->clone; - - $date->add( $per => $freq ); - $date = $billends->clone if $date > $billends; - - # XXX This is helpful, but monthly and billday > 28 == !!! - $date->subtract( days => 1 ) while $date->$day_method != $day; - - my $end = $date->clone->subtract( seconds => 1 ); - - next if $end < $start; - - $startdate = $start->clone if !$startdate || $startdate > $start; - $invoice{start} ||= $start->clone; - $invoice{end} = $end->clone; - my %hours = ( - start => $start->clone, - end => $end->clone, - hours => { %{ $cust->{hours} } }, - ); - - push @{ $invoice{hours} }, \%hours; - push @{ $project{fees} }, - { - count => 1, - rate => $cust->{base_rate}, - contents => $start->ymd . ' to ' . $end->ymd, - }; - - } - - if ( @{ $project{fees} } ) { - push @{ $invoice{projects} }, \%project; - } - } - - $cust->{from} ||= get_user($custid); - $cust->{invoice} = \%invoice; -} - my @limits = map +{ attribute => 'status', operator => '=', @@ -154,22 +76,30 @@ my $iterator = $results->get_iterator; while ( my $ticket = &$iterator ) { - my $cust = find_customer_for_ticket( $customers, $ticket ); + if ( !$ticket->time_worked ) { + say "Ticket " . $ticket->id . " has no time worked"; + next; + } + + my $cust = find_customer_for_ticket($ticket); if ( !$cust ) { warn "No customer found for ticket " . $ticket->id; next; } - if ( !$cust->{invoice} ) { - #say "Customer has no open invoices for ticket " . $ticket->id; + + say 'Ticket ' . $ticket->id . " belongs to $cust->{id}"; + + $cust->{invoice} ||= make_invoice($cust); + if ( !$cust->{invoice}->{end} ) { + say " $cust->{id} has no open invoices [" . $ticket->id . ']'; next; } - my $invoice = $cust->{invoice}; my $project = make_project( $ticket, $cust ); next unless @{ $project->{fees} } || @{ $project->{expenses} }; foreach my $fee ( @{ $project->{fees} } ) { - my $hours = hours_for_date( $invoice, $fee->{date} ); + my $hours = hours_for_date( $cust->{invoice}, $fee->{date} ); my $h_type = exists $hours->{ $fee->{type} } @@ -189,22 +119,26 @@ } if ($discount_time) { - $invoice->{discount}{amount} += $discount_time * $fee->{rate}; - $invoice->{discount}{hours}{$h_type} += $discount_time; + $cust->{invoice}->{discount}->{amount} + += round( $discount_time * $fee->{rate} ); + $cust->{invoice}->{discount}->{hours}{$h_type} += $discount_time; $h_type = '' if $h_type eq 'default'; $fee->{detail} = "$discount_time $h_type Hours Discounted"; } } - push @{ $invoice->{projects} }, $project; + push @{ $cust->{invoice}->{projects} }, $project; } -while ( my ( $custid, $cust ) = each %{$customers} ) { +foreach my $cust ( @{$customers} ) { my $invoice = $cust->{invoice}; - next unless $invoice->{projects} && @{ $invoice->{projects} }; + next unless $invoice && $invoice->{projects} && @{ $invoice->{projects} }; - my %li = ( custid => $custid, ); + my %li = ( + custid => $cust->{id}, + invdate => DateTime->now( time_zone => 'local' )->ymd, + ); foreach my $project ( @{ $invoice->{projects} } ) { if ( $project->{transactions} ) { @@ -241,14 +175,18 @@ next unless $invoice->{total} > 0 || $invoice->{total_due}; - # XXX Here we need to "make_address" $invoice->{info} = $config->get('info'); - $invoice->{from} = $config->get('from'); - $invoice->{to} = $cust->{address}; + my $from = $config->get('from'); + $from = get_user($from) if !ref $from; + $invoice->{organization} = $from->{organization} || $from->{name}; + $invoice->{from} = make_address($from); + $invoice->{to} = make_address( $cust->{address} || $cust->{id} ); + $state->{lastinvoice}++; $invoice->{id} = $state->{lastinvoice}; - $invoice->{file} = 'invoice_' . $state->{lastinvoice} . '.pdf'; + $invoice->{file} = sprintf 'invoice_%06d.pdf', $state->{lastinvoice}; + $invoice->{logo} = $config->get('logo'); foreach my $k (qw/ file transactions start end total past_due total_due /) { @@ -256,7 +194,7 @@ if ( $invoice->{$k} ) { $v = $invoice->{$k} } elsif ( $cust->{$k} ) { $v = $cust->{$k} } - if (defined $v && length $v) { + if ( defined $v && length $v ) { if ( ref $v eq 'DateTime' ) { $li{$k} = $v->ymd; } @@ -272,11 +210,18 @@ $invoice->{$key} = $invoice->{$key}->strftime('%B %d, %Y'); } } - my $tt = Template->new; - $tt->process( 'invoice.tex.tt', $invoice, $invoice->{file} ) + + my $invoice_dir = $config->get('invoice_dir'); + File::Path::make_path($invoice_dir); + my $file = join '/', $invoice_dir, $invoice->{file}; + + my $tt = Template->new( INCLUDE_PATH => $config->get('template_dir'), ) + || die $Template::ERROR, "\n"; + + $tt->process( $config->get('invoice_template'), $invoice, $file ) or die $tt->error . "\n"; - printf "Generated %s for %s: \$%.02f\n", $invoice->{file}, $custid, + printf "Generated %s for %s: \$%.02f\n", $invoice->{file}, $cust->{id}, $invoice->{total}; } @@ -291,55 +236,39 @@ } sub find_customer_for_ticket { - my ( $customers, $ticket ) = @_; + my ($ticket) = @_; -INVOICE: foreach my $cust ( values %{$customers} ) { - next INVOICE unless $cust->{match}; + foreach my $cust ( @{$customers} ) { + next unless $cust->{match}; foreach my $m ( @{ $cust->{match} } ) { my $type = $m->{type}; - my $thing = join ' ', $ticket->$type; + my $match + = exists $m->{$type} + ? lc( $m->{$type} ) + : qr/\Q$m->{regex}\E/; + my $thing = [ map {lc} $ticket->$type ]; - if ( $m->{$type} ) { - my $match = lc $m->{$type}; - next INVOICE unless lc($thing) ~~ $match; - } - elsif ( $m->{regex} ) { - next INVOICE unless $thing ~~ /\Q$m->{regex}\E/; - } - else { + if ( !$match ) { warn "Invalid match!"; - next INVOICE; + next; } + return $cust if ( $match ~~ $thing ); } - return $cust; } - return fake_customer( $customers, $ticket ); -} - -sub fake_customer { - my ( $customers, $ticket ) = @_; - - # make the custid the first requestor - my ($custid) = $ticket->requestors; - return unless $custid; - + # Fake customer if we didn't find one my $cust = $config->get('default') || {}; - $cust->{to} = get_user($custid); - my %invoice = ( end => DateTime->now ); + ( $cust->{id} ) = $ticket->requestors; + return unless $cust->{id}; + push @{$customers}, $cust; - my $lastinvoice = $state->last_invoice($custid); - if ( $lastinvoice->{date} ) { - my $last_invoice_date = ymd_to_DateTime( $lastinvoice->{date} ); - $invoice{start} = $last_invoice_date->clone->add( days => 1 ); - } + $cust->{match} = [ + { type => 'requestors', + regex => $cust->{id}, + } + ]; - if ( !( $invoice{start} && $invoice{start} < $invoice{end} ) ) { - $cust->{invoice} = \%invoice; - } - - $customers->{$custid} = $cust; return $cust; } @@ -357,7 +286,7 @@ name => 'username', ); - $users->id($id); + my $users = RT::Client::REST::User->new( rt => $rt, id => $id ); $users->retrieve; my %user; @@ -376,6 +305,150 @@ return \%user; } +sub make_invoice { + my ($cust) = @_; + + my $day = $cust->{day} ||= 0; + my $per = $cust->{per} ||= 'week'; + my $freq = $cust->{frequency} ||= 1; + + my $day_method; + given ($per) { + when ('week') { $per = 'weeks'; $day_method = 'dow' } + when ('month') { $per = 'months'; $day_method = 'day' } + default { die "Unknown per [$per]\n" } + } + + my $billend = DateTime->now( time_zone => 'local' ) + ->set( hour => 0, minute => 0, second => 0 ); + + # XXX This is helpful, but monthly and billday > 28 == !!! + $billend->subtract( days => 1 ) + while $day && $billend->$day_method != $day; + + my $date = $billend->clone->subtract( $per => $freq ); + my %invoice = ( end => $billend->clone->subtract( seconds => 1 ) ); + + my $lastinvoice = $state->last_invoice( $cust->{id} ); + if ( $lastinvoice->{date} ) { + my $last_invoice_date = ymd_to_DateTime( $lastinvoice->{date} ); + $date = $last_invoice_date->clone->add( days => 1 ); + + $invoice{start} = $date->clone; + + $startdate = $date->clone->subtract( $per => $freq ) + if !$startdate || $startdate > $date; + } + + # Is the start date more than $freq $per before the end date? + my $diff = $billend - $date; + return {} if $diff->in_units($per) < 1; + + if ( $cust->{base_rate} ) { + my ( $project, $hours ) = make_base_project( + $cust, + { date => $date, + billend => $billend, + per => $per, + freq => $freq, + } + ); + + if ( @{ $project->{fees} } ) { + $invoice{end} = $project->{end}; + $invoice{hours} = $hours; + push @{ $invoice{projects} }, $project; + } + } + elsif ( $cust->{hours} ) { + $invoice{hours} = [ + { end => $invoice{end}->clone, + hours => $cust->{hours}, + } + ]; + } + + return {} if $invoice{start} && $invoice{end} < $invoice{start}; + + return \%invoice; +} + +sub make_base_project { + my ( $cust, $args ) = @_; + + my $date = $args->{date}; + my $billend = $args->{billend}; + my $per = $args->{per}; + my $freq = $args->{freq}; + + my $title + = $freq == 1 + ? ucfirst( $cust->{per} . 'ly' ) + : $freq . ' ' . ucfirst( $cust->{per} ); + $title .= ' Retainer'; + + my %project = ( title => $title, start => $date->clone, fees => [], ); + my @hours; + + while ( $date < $billend ) { + my $start = $date->clone; + + $date->add( $per => $freq ); + + my $end = $date->clone->subtract( seconds => 1 ); + $end = $billend->clone->subtract( seconds => 1 ) if $date > $billend; + + $project{end} = $end->clone; + + push @{ $project{fees} }, + { + count => 1, + rate => $cust->{base_rate}, + contents => $start->ymd . ' to ' . $end->ymd, + }; + + push @hours, + { + start => $start->clone, + end => $end->clone, + hours => { %{ $cust->{hours} } }, + }; + } + + return \%project, \@hours; +} + +sub make_address { + my ($addr) = @_; + my @adr; + + $addr = get_user($addr) unless ref $addr; + + if ( $addr->{organization} ) { + push @adr, $addr->{organization}; + } + elsif ( $addr->{name} && !$addr->{attn} ) { + push @adr, $addr->{name}; + } + + if ( ( $addr->{addr1} || $addr->{addr2} ) + && $addr->{city} + && $addr->{state} + && $addr->{zip} ) + { + push @adr, $addr->{attn} if $addr->{attn}; + push @adr, $addr->{addr1} if $addr->{addr1}; + push @adr, $addr->{addr2} if $addr->{addr2}; + push @adr, + $addr->{city} . ', ' . $addr->{state} . ' ' . $addr->{zip}; + } + else { + push @adr, $addr->{email} if $addr->{email}; + } + + return join "\n\n", @adr; +} + sub make_project { my ( $ticket, $cust ) = @_; @@ -386,8 +459,8 @@ title => $ticket->subject, detail => 'Ticket: ' . $ticket->id - . ' Queue: ' - . $ticket->queue + . ' Status: ' + . $ticket->status . ' Requestors: ' . join( ', ', $ticket->requestors ), fees => [], @@ -408,9 +481,13 @@ } my $invoice = $cust->{invoice}; - next - if $invoice->{start} - && $invoice->{start} > $fee->{date}; + if ( $invoice->{start} && $invoice->{start} > $fee->{date} ) { + warn "Ticket " + . $ticket->id + . " has uninvoiced Transaction " + . $txn->id . "\n"; + next; + } next if $invoice->{end} < $fee->{date}; push @{ $project{fees} }, $fee; @@ -469,12 +546,13 @@ my ( $hour, $minute, $second ) = split ':', $time if $time; return DateTime->new( - year => $year, - month => $month, - day => $day, - hour => $hour || 0, - minute => $minute || 0, - second => $second || 0, + year => $year, + month => $month, + day => $day, + hour => $hour || 0, + minute => $minute || 0, + second => $second || 0, + time_zone => 'local', ); } @@ -485,7 +563,7 @@ use 5.010; use YAML::Any qw/ LoadFile Dump Load /; -use File::Basename; +use File::Spec; sub new { my ( $class, $args ) = @_; @@ -520,9 +598,9 @@ my $c = LoadFile($file) or die "Unable to load $file\n"; - $c->{customers} ||= {}; + $c->{customers} ||= []; if ( $c->{default} ) { - foreach my $cust ( values %{ $c->{customers} } ) { + foreach my $cust ( @{ $c->{customers} } ) { foreach my $k ( keys %{ $c->{default} } ) { $cust->{$k} //= Load( Dump( $c->{default}->{$k} ) ); } @@ -536,13 +614,30 @@ sub get { my ( $self, $key ) = @_; my $value = Load( Dump( $self->{_config}->{$key} ) ); - if ( !$value ) { - given ($key) { - when ('state') { - $value = dirname( $self->{file} ) . '/rt_invoice.state' - } + + return $value if $value; + my ( $volume, $directories, $file ) + = File::Spec->splitpath( File::Spec->rel2abs( $self->{file} ) ); + + given ($key) { + when ('state') { + $value = $self->{file}; + $value =~ s/(?:\.[^.]+)?$/\.state/; } + when ('invoice_dir') { + $value = File::Spec->catdir( $volume, $directories, 'invoices' ); + } + when ('template_dir') { + $value = File::Spec->catdir( $volume, $directories ); + } + when ('invoice_template') { + $value = 'invoice.tex.tt'; + } + when ('logo') { + $value = File::Spec->catfile( $volume, $directories, 'Logo.pdf' ); + } } + return $value; }