From e43b6e34ae1c6e9abe0bb3c49ee3e14f92512380 Mon Sep 17 00:00:00 2001
From: "Bradley M. Kuhn" <bkuhn@ebb.org>
Date: Thu, 7 Jan 2016 13:35:24 -0800
Subject: [PATCH] donorTotalGaveInPeriod: First implementation.

This passes all tests:

ok 224 - donorTotalGaveInPeriod(): dies with undefined donorId
ok 225 - donorTotalGaveInPeriod(): dies with non-numeric donorId
ok 226 - donorTotalGaveInPeriod(): dies with non-existent id
ok 227 - donorTotalGaveInPeriod():  dies with non ISO-8601 string in startDate
ok 228 - donorTotalGaveInPeriod():  dies with non ISO-8601 string in endDate
ok 229 - donorTotalGaveInPeriod(): dies if given an argument that is not recognized
ok 230 - donorTotalGaveInPeriod(): total for a donor with no period named succeeds...
ok 231 - donorTotalGaveInPeriod(): ...and returned value is correct.
ok 232 - donorTotalGaveInPeriod(): check for total with both start and end date succeeds...
ok 233 - donorTotalGaveInPeriod(): ...and returned value is correct.
ok 234 - donorTotalGaveInPeriod(): check for total with just a start date succeeds...
ok 235 - donorTotalGaveInPeriod(): ...and returned value is correct.
ok 236 - donorTotalGaveInPeriod(): check for total with just a end date succeeds...
ok 237 - donorTotalGaveInPeriod(): ...and returned value is correct.
---
 Supporters/lib/Supporters.pm | 81 ++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)

diff --git a/Supporters/lib/Supporters.pm b/Supporters/lib/Supporters.pm
index 8914e9d..79c7e62 100644
--- a/Supporters/lib/Supporters.pm
+++ b/Supporters/lib/Supporters.pm
@@ -1263,6 +1263,87 @@ sub donorFirstGave($$) {
   }
 }
 
+######################################################################
+
+=begin donorTotalGaveInPeriod
+
+Arguments:
+
+=over
+
+=item $self
+
+Current object.
+
+=item a list of arguments, which must be even and will be interpreted as a
+ hash, with the following keys relevant:
+
+=item donorId
+
+   This mandatory key must have a value of a Valid donor id number currently
+   in the database.  die() will occur if the id number is not in the database
+   already as a donor id.
+
+=item startDate
+
+   This optional key, if given, must contain an ISO 8601 formatted date for the start
+   date of the period.  die() may occur if not in ISO-8601 format.
+
+=item endDate
+
+   This optional key, if given, must contain an ISO 8601 formatted date for the start
+   date of the period.  die() may occur if not in ISO-8601 format.
+
+=back
+
+All other hash keys given generate a die().
+
+=back
+
+=cut
+
+sub donorTotalGaveInPeriod($$) {
+  my $self = shift @_;
+
+  confess "donorTotalGaveInPeriod: arguments not in hash format" unless (scalar(@_) % 2) == 0;
+  my(%args) = @_;
+
+  my $donorId = $args{donorId};  delete $args{donorId};
+
+  confess "donorTotalGaveInPeriod: donorId, \"$donorId\" not found in supporter database"
+    unless $self->_verifyId($donorId);
+
+  # FIXME: Does not handle address before the Common Era
+  my $startDate = '0000-01-01';
+  if (defined $args{startDate}) { $startDate = $args{startDate}; delete $args{startDate}; }
+
+  # FIXME: Year 10,000 problem!
+
+  my $endDate = '9999-12-31';
+  if (defined $args{endDate}) { $endDate = $args{endDate}; delete $args{endDate}; }
+
+  my(@argKeys) = keys %args;
+  confess("Unknown arugments: ".  join(", ", @argKeys)) if @argKeys > 0;
+
+  foreach my $date ($startDate, $endDate) {
+    confess "donorTotalGaveInPeriod: invalid date in argument list, \"$date\""
+      unless $date =~ /^\d{4,4}-\d{2,2}-\d{2,2}/;
+    # FIXME: check better for ISO-8601.
+  }
+  $self->_readLedgerData() if not defined $self->{ledgerData};
+
+  my $entityId = $self->getLedgerEntityId($donorId);
+  my $amount = 0.00;
+
+  foreach my $date (keys %{$self->{ledgerData}{$entityId}{donations}}) {
+    next if $date =~ /^__/;
+    $amount += $self->{ledgerData}{$entityId}{donations}{$date}
+      if $date ge $startDate and $date le $endDate;
+  }
+  return $amount;
+}
+######################################################################
+
 =begin supporterExpirationDate
 
 Arguments: