Conservancy/supporters
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
supporters/Supporters/lib/Supporters.pm

1617 lines
46 KiB
Perl
Raw Normal View History

Add license notice at top of these files.
2015-12-30 19:09:47 +00:00
# License: AGPLv3-or-later
# Copyright info in COPYRIGHT.md, License details in LICENSE.md with this package.
Generated stubs for Supporters module. Generated this by running: h2xs -AXc -n Supporters
2015-12-07 01:20:14 +00:00
package Supporters;
use 5.020002;
use strict;
use warnings;
require Exporter;
our @ISA = qw(Exporter);
# Items to export into callers namespace by default. Note: do not export
# names by default without a very good reason. Use EXPORT_OK instead.
# Do not simply export all your public functions/methods/constants.
# This allows declaration use Supporters ':all';
# If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
# will save memory.
our %EXPORT_TAGS = ( 'all' => [ qw(
) ] );
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
our @EXPORT = qw(
);
This is already version 0.2
2015-12-07 01:27:25 +00:00
our $VERSION = '0.02';
Generated stubs for Supporters module. Generated this by running: h2xs -AXc -n Supporters
2015-12-07 01:20:14 +00:00
new: additional arguments related to ledger. I'll need a full command line here, as it turns out, and also regular expressions to use for searching for monthly vs. annual donations.
2015-12-30 20:08:33 +00:00
use Scalar::Util qw(looks_like_number blessed reftype);
Verify email address format with external module.
2015-12-12 02:32:59 +00:00
use Mail::RFC822::Address;
confess() rather than die() here. We really want to know the context of what happened when it dies here.
2015-12-21 00:52:49 +00:00
use Carp qw(confess);
_verifyId method: initial implementation. Internal method for use to verify that an id we have really is in the database. For use before other operations.
2015-12-10 02:38:07 +00:00
Initial creation code and tests.
2015-12-07 02:28:49 +00:00
######################################################################
Some documentation for existing methods.
2015-12-10 02:37:26 +00:00
=begin new
Create new Supporters object.
Arguments:
=over
=item $dbh
new: Implement verification of $dbh The two previously committed tests now pass: ok 2 - new: dies when dbh is undefined. ok 3 - new: dies when dbh is blessed into another module.
2015-12-17 03:24:24 +00:00
Scalar references for the database handle from the L<DBI>, already opened
and pointing to the right database. This class will take over and control
the DBI object after C<new()> completes.
Some documentation for existing methods.
2015-12-10 02:37:26 +00:00
=item $ledgerCmd
new: additional arguments related to ledger. I'll need a full command line here, as it turns out, and also regular expressions to use for searching for monthly vs. annual donations.
2015-12-30 20:08:33 +00:00
A list reference that contains the main ledger command with any necessary
arguments, for looking up donation data. The options should be presented
such that the output is in the form:
ProgramTag Date Entity Amount
=item $programTypeSearch
This hash should have two keys: "monthly" and "annual". The values of the
hash should be a regular expression that matches the ProgramTag lines for
categorization of the donations in annual or monthly buckets.
Some documentation for existing methods.
2015-12-10 02:37:26 +00:00
=back
=cut
new: additional arguments related to ledger. I'll need a full command line here, as it turns out, and also regular expressions to use for searching for monthly vs. annual donations.
2015-12-30 20:08:33 +00:00
sub new ($$;$) {
Initial creation code and tests.
2015-12-07 02:28:49 +00:00
my $package = shift;
new: additional arguments related to ledger. I'll need a full command line here, as it turns out, and also regular expressions to use for searching for monthly vs. annual donations.
2015-12-30 20:08:33 +00:00
my($dbh, $ledgerCmd, $programTypeSearch) = @_;
Initial creation code and tests.
2015-12-07 02:28:49 +00:00
new: additional arguments related to ledger. I'll need a full command line here, as it turns out, and also regular expressions to use for searching for monthly vs. annual donations.
2015-12-30 20:08:33 +00:00
die "new: second argument must be a list ref for the ledger command line"
unless (defined $ledgerCmd and ref $ledgerCmd and (reftype($ledgerCmd) eq 'ARRAY'));
die "new: keys annual and monthly must be the only keys in this hash"
if defined $programTypeSearch and (not (defined $programTypeSearch->{monthly} and defined $programTypeSearch->{annual}
and scalar(keys(%$programTypeSearch) == 2)));
new: Implement verification of $dbh The two previously committed tests now pass: ok 2 - new: dies when dbh is undefined. ok 3 - new: dies when dbh is blessed into another module.
2015-12-17 03:24:24 +00:00
die "new: first argument must be a database handle"
unless (defined $dbh and blessed($dbh) =~ /DBI/);
new: additional arguments related to ledger. I'll need a full command line here, as it turns out, and also regular expressions to use for searching for monthly vs. annual donations.
2015-12-30 20:08:33 +00:00
my $self = bless({ dbh => $dbh, ledgerCmd => $ledgerCmd },
$package);
$self->{programTypeSearch} = $programTypeSearch if defined $programTypeSearch;
Rework the reference counter for begin_work/commit This code was clearly not correct as it was. The main problem is that I was envisioning begin_work/commit pairs as always matched, but of course if we die in the middle of a transaction, the counter has to be reset. That's why we have to set the $dbh->{HandleError} in new() to a subroutine that does that. Also, we need to similarly wrap rollback() calls. When rolling back, we have to reset the counter as we're not going to commit() (that's the point).
2015-12-17 03:57:59 +00:00
# Turn off AutoCommit, and create our own handler that resets the
# begin_work/commit reference counter.
$dbh->{RaiseError} = 0;
$dbh->{HandleError} = sub {
transaction counter is per instance. The older transaction counter was for the whole class, which was problematic if you had more than one supporter database open at a time, or were otherwise using different supporter databases. I'm not completely sure this fix is fully functional, because perhaps we should be carrying this counter along with the DBH (i.e., what if two Supporter instances are created with the same dbh). I suppose we could fix this problem by changing the new() interface to require the instance itself be in control of the dbh.
2015-12-20 20:21:38 +00:00
$self->{__NESTED_TRANSACTION_COUNTER__} = 0;
confess() rather than die() here. We really want to know the context of what happened when it dies here.
2015-12-21 00:52:49 +00:00
confess $_[0];
Rework the reference counter for begin_work/commit This code was clearly not correct as it was. The main problem is that I was envisioning begin_work/commit pairs as always matched, but of course if we die in the middle of a transaction, the counter has to be reset. That's why we have to set the $dbh->{HandleError} in new() to a subroutine that does that. Also, we need to similarly wrap rollback() calls. When rolling back, we have to reset the counter as we're not going to commit() (that's the point).
2015-12-17 03:57:59 +00:00
};
transaction counter is per instance. The older transaction counter was for the whole class, which was problematic if you had more than one supporter database open at a time, or were otherwise using different supporter databases. I'm not completely sure this fix is fully functional, because perhaps we should be carrying this counter along with the DBH (i.e., what if two Supporter instances are created with the same dbh). I suppose we could fix this problem by changing the new() interface to require the instance itself be in control of the dbh.
2015-12-20 20:21:38 +00:00
$self->{__NESTED_TRANSACTION_COUNTER__} = 0;
new: Implement verification of $dbh The two previously committed tests now pass: ok 2 - new: dies when dbh is undefined. ok 3 - new: dies when dbh is blessed into another module.
2015-12-17 03:24:24 +00:00
return $self;
Initial creation code and tests.
2015-12-07 02:28:49 +00:00
}
######################################################################
Some documentation for existing methods.
2015-12-10 02:37:26 +00:00
=begin dbh
Accessor method, returns the database handle currently used by this
Supporters object.
=cut
Initial creation code and tests.
2015-12-07 02:28:49 +00:00
sub dbh ($) {
return $_[0]->{dbh};
}
######################################################################
Some documentation for existing methods.
2015-12-10 02:37:26 +00:00
=begin ledgerCmd
Accessor method, returns the ledger command currently used by this Supporters
object.
=cut
Initial creation code and tests.
2015-12-07 02:28:49 +00:00
sub ledgerCmd ($) {
return $_[0]->{ledgerCmd};
}
Begin writing addSupporter method. ledger_entity_id is required.
2015-12-07 02:56:59 +00:00
######################################################################
Correct arguments to method; add public_ack
2015-12-07 03:24:10 +00:00
sub addSupporter ($$) {
Did I have some other language on the brain? $self is the standard name for the current object in Perl, of course. :)
2015-12-17 02:07:46 +00:00
my($self, $sp) = @_;
Begin writing addSupporter method. ledger_entity_id is required.
2015-12-07 02:56:59 +00:00
die "ledger_entity_id required" unless defined $sp->{ledger_entity_id};
Correct arguments to method; add public_ack
2015-12-07 03:24:10 +00:00
if ($sp->{public_ack}) {
die "display_name required if public_ack requested" unless defined $sp->{display_name};
}
Did I have some other language on the brain? $self is the standard name for the current object in Perl, of course. :)
2015-12-17 02:07:46 +00:00
$self->_beginWork;
my $sth = $self->dbh->prepare(
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
"INSERT INTO donor(ledger_entity_id, display_name, public_ack, is_supporter)" .
" values(?, ?, ?, " .
$self->dbh->quote(1, 'SQL_BOOLEAN') . ')');
Initial basic support for creating a new Supporter. This is incomplete as of yet, since it doesn't properly set up other tables.
2015-12-09 23:44:05 +00:00
$sth->execute($sp->{ledger_entity_id}, $sp->{display_name}, $sp->{public_ack});
Did I have some other language on the brain? $self is the standard name for the current object in Perl, of course. :)
2015-12-17 02:07:46 +00:00
my $id = $self->dbh->last_insert_id("","","","");
Initial basic support for creating a new Supporter. This is incomplete as of yet, since it doesn't properly set up other tables.
2015-12-09 23:44:05 +00:00
$sth->finish();
Begin work on addEmailAddress method. Basic stub and a few tests.
2015-12-10 03:17:46 +00:00
Did I have some other language on the brain? $self is the standard name for the current object in Perl, of course. :)
2015-12-17 02:07:46 +00:00
$self->addEmailAddress($id, $sp->{email_address}, $sp->{email_address_type})
Begin work on addEmailAddress method. Basic stub and a few tests.
2015-12-10 03:17:46 +00:00
if defined $sp->{email_address};
Did I have some other language on the brain? $self is the standard name for the current object in Perl, of course. :)
2015-12-17 02:07:46 +00:00
$self->_commit;
Initial basic support for creating a new Supporter. This is incomplete as of yet, since it doesn't properly set up other tables.
2015-12-09 23:44:05 +00:00
return $id;
Begin writing addSupporter method. ledger_entity_id is required.
2015-12-07 02:56:59 +00:00
}
Begin work on addEmailAddress method. Basic stub and a few tests.
2015-12-10 03:17:46 +00:00
######################################################################
addAddressType: initial implementation & unit test
2015-12-10 03:48:59 +00:00
=begin addAddressType
Adds an address type, or returns the existing one of that name if it already exists.
Arguments:
=over
=item $addressType
Scalar string that contains the email address type. die() is called if not defined.
=back
Returns id of the address type.
=cut
sub addAddressType($$) {
my($self, $type) = @_;
die "addAddressType: type argument must be defined" if not defined $type;
my $val = $self->dbh()->selectall_hashref("SELECT id, name FROM address_type WHERE name = '$type'", 'name');
return $val->{$type}{id} if (defined $val and defined $val->{$type} and defined $val->{$type}{id});
my $sth = $self->dbh->prepare("INSERT INTO address_type(name) VALUES(?)");
$sth->execute($type);
my $id = $self->dbh->last_insert_id("","","","");
$sth->finish();
return $id;
}
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
######################################################################
addAddressType: initial implementation & unit test
2015-12-10 03:48:59 +00:00
Begin work on addEmailAddress method. Basic stub and a few tests.
2015-12-10 03:17:46 +00:00
=begin addEmailAddress
Arguments:
=over
=item $id
Valid supporter id number currently in the database. die() will occur if
the id number is not in the database already as a supporter id.
Generated stubs for Supporters module. Generated this by running: h2xs -AXc -n Supporters
2015-12-07 01:20:14 +00:00
Begin work on addEmailAddress method. Basic stub and a few tests.
2015-12-10 03:17:46 +00:00
=item $emailAddress
Scalar string that contains an email address. die() will occur if the
email address isn't properly formatted.
=item $emailAddressType
Scalar string that contains the email address type. This type will be
created in the database if it does not already exist, so be careful.
=back
Test to verify addEmailAddress returns a valid id.
2015-12-12 02:23:24 +00:00
Returns the id value of the email_address entry.
Begin work on addEmailAddress method. Basic stub and a few tests.
2015-12-10 03:17:46 +00:00
=cut
sub addEmailAddress($$$$) {
my($self, $id, $emailAddress, $emailAddressType) = @_;
die "addEmailAddress: invalid id, $id" unless $self->_verifyId($id);
addEmailAddress: call addAddressType underneath address_type is added automatically from the addEmailAddress call. Since addAddressType does a lookup first, this should not cause duplicates.
2015-12-10 03:56:22 +00:00
More robust call to addAddressType. This is not strictly necessary, but it seems right to me that we trap the error and rollback ourselves here as well.
2015-12-17 04:24:24 +00:00
die "addEmailAddress: invalid email address, $emailAddressType"
Verify email address format with external module.
2015-12-12 02:32:59 +00:00
unless defined $emailAddressType and Mail::RFC822::Address::valid($emailAddress);
addEmailAddress: permit shared email addresses. An existing email address can exist already. If it does, just map it to the new donor_id as well.
2015-12-30 13:49:12 +00:00
my $existingEmail = $self->_lookupEmailAddress($emailAddress);
Verify email address format with external module.
2015-12-12 02:32:59 +00:00
addEmailAddress: redundant add w/ same address. This should succeed as the previous tests show. They now pass: ok 21 - addEmailAddress: fails adding existing email address with mismatched type. ok 22 - addEmailAddress: succeeds when adding email that already exists... ok 23 - addEmailAddress: ... and returns same id.
2015-12-30 14:00:42 +00:00
if (defined $existingEmail) {
die "addEmailAddress: attempt to add email address that exists, using a different type!"
if $existingEmail->{type} ne $emailAddressType;
my $val = $self->dbh()->selectall_hashref("SELECT email_address_id, donor_id " .
"FROM donor_email_address_mapping WHERE " .
"donor_id = " . $self->dbh->quote($id, 'SQL_INTEGER') . " AND " .
"email_address_id = " . $self->dbh->quote($existingEmail->{id}, 'SQL_INTEGER'),
'donor_id');
return $val->{$id}{email_address_id}
if (defined $val and defined $val->{$id} and defined $val->{$id}{email_address_id});
}
addEmailAddress: permit shared email addresses. An existing email address can exist already. If it does, just map it to the new donor_id as well.
2015-12-30 13:49:12 +00:00
my($sth, $addressId);
Actual email address add code; tests stay same.
2015-12-12 02:15:31 +00:00
addEmailAddress: permit shared email addresses. An existing email address can exist already. If it does, just map it to the new donor_id as well.
2015-12-30 13:49:12 +00:00
$self->_beginWork();
addEmailAddress: supporter_email_address_mapping Properly map email address to supporter when email address is added. Test now passes: ok 12 - addSuporter: email address mapping is created on addSupporter() w/ email address included
2015-12-17 02:13:28 +00:00
addEmailAddress: permit shared email addresses. An existing email address can exist already. If it does, just map it to the new donor_id as well.
2015-12-30 13:49:12 +00:00
if (defined $existingEmail) {
$addressId = $existingEmail->{id};
} else {
my $addressTypeId;
eval {
$addressTypeId = $self->addAddressType($emailAddressType);
};
if ($@ or not defined $addressTypeId) {
my $err = $@;
$err = "addEmailAddress: unable to addAddressType" if (not defined $err);
$self->_rollback();
die $@ if $@;
}
$sth = $self->dbh->prepare("INSERT INTO email_address(email_address, type_id, date_encountered)" .
"VALUES( ?, ?, date('now'))");
$sth->execute($emailAddress, $addressTypeId);
$addressId = $self->dbh->last_insert_id("","","","");
$sth->finish();
}
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
$sth = $self->dbh->prepare("INSERT INTO donor_email_address_mapping" .
addEmailAddress: permit shared email addresses. An existing email address can exist already. If it does, just map it to the new donor_id as well.
2015-12-30 13:49:12 +00:00
"(donor_id, email_address_id) " .
"VALUES( ?, ?)");
addEmailAddress: supporter_email_address_mapping Properly map email address to supporter when email address is added. Test now passes: ok 12 - addSuporter: email address mapping is created on addSupporter() w/ email address included
2015-12-17 02:13:28 +00:00
$sth->execute($id, $addressId);
$sth->finish();
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
$self->_commit();
addEmailAddress: supporter_email_address_mapping Properly map email address to supporter when email address is added. Test now passes: ok 12 - addSuporter: email address mapping is created on addSupporter() w/ email address included
2015-12-17 02:13:28 +00:00
Actual email address add code; tests stay same.
2015-12-12 02:15:31 +00:00
return $addressId;
Begin work on addEmailAddress method. Basic stub and a few tests.
2015-12-10 03:17:46 +00:00
}
_verifyId method: initial implementation. Internal method for use to verify that an id we have really is in the database. For use before other operations.
2015-12-10 02:38:07 +00:00
######################################################################
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
=begin setPreferredEmailAddress
Arguments:
=over
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
=item $donorId
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
Valid supporter id number currently in the database. die() will occur if
the id number is not in the database already as a supporter id.
=item $emailAddress
Scalar string that contains an email address. undef is returned if the
email address is not already in the database for this supporter.
=back
Returns the email_address_id of the preferred email address. undef can be
returned; it means the preferred email address wasn't selected for some reason.
=cut
sub setPreferredEmailAddress($$$) {
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
my($self, $donorId, $emailAddress) = @_;
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
die "setPreferredEmailAddress: invalid supporter id, $donorId" unless $self->_verifyId($donorId);
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
die "setPreferredEmailAddress: email address not defined" unless defined $emailAddress;
die "setPreferredEmailAddress: invalid email address, $emailAddress"
unless Mail::RFC822::Address::valid($emailAddress);
my $ems = $self->dbh()->selectall_hashref("SELECT ea.email_address, ea.id, sem.preferred " .
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
"FROM email_address ea, donor_email_address_mapping sem " .
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
"WHERE ea.id = sem.email_address_id AND ".
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
"sem.donor_id = " . $self->dbh->quote($donorId, 'SQL_INTEGER'),
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
'email_address');
# Shortcut: it was already set
return $ems->{$emailAddress}{id} if (defined $ems->{$emailAddress} and $ems->{$emailAddress}{preferred});
my $anotherPreferred = 0;
my $emailAddressId;
# Iterate over email addresses, finding if any were preferred before, and finding outs too.
foreach my $em (keys %{$ems}) {
$anotherPreferred = 1 if $ems->{$em}{preferred};
$emailAddressId = $ems->{$em}{id} if $em eq $emailAddress;
}
return undef if not defined $emailAddressId;
$self->_beginWork();
if ($anotherPreferred) {
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
$self->dbh->do("UPDATE donor_email_address_mapping " .
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
"SET preferred = " . $self->dbh->quote(0, 'SQL_BOOLEAN') . " " .
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
"WHERE donor_id = " . $self->dbh->quote($donorId, 'SQL_INTEGER'));
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
}
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
$self->dbh->do("UPDATE donor_email_address_mapping " .
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
"SET preferred = " . $self->dbh->quote(1, 'SQL_BOOLEAN') . " " .
"WHERE email_address_id = " . $self->dbh->quote($emailAddressId, 'SQL_INTEGER'));
getPreferredEmailAddress: initial implementation.
2015-12-21 02:22:15 +00:00
$self->_commit;
setPreferredEmailAddress: initial implementation These tests now pass: ok 106 - setPreferredEmailAddress: dies for undefined id ok 107 - setPreferredEmailAddress: dies for non-numeric id ok 108 - setPreferredEmailAddress: email address undefined fails ok 109 - setPreferredEmailAddress: email address with extra @ fails to add. ok 112 - setPreferredEmailAddress: email address not found in database does not die.... ok 113 - setPreferredEmailAddress: ....but returns undef ok 116 - setPreferredEmailAddress: setting preferred email address succeeds.... ok 117 - setPreferredEmailAddress: ... and returns correct email_address_id on success
2015-12-21 02:09:24 +00:00
return $emailAddressId;
}
######################################################################
getPreferredEmailAddress: initial implementation.
2015-12-21 02:22:15 +00:00
=begin getPreferredEmailAddress
Arguments:
=over
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
=item $donorId
getPreferredEmailAddress: initial implementation.
2015-12-21 02:22:15 +00:00
Valid supporter id number currently in the database. die() will occur if
the id number is not in the database already as a supporter id.
=item $emailAddress
Scalar string that contains an email address. undef is returned if the
email address is not already in the database for this supporter.
=back
Returns the email_address_id of the preferred email address. undef can be
returned; it means the preferred email address wasn't selected for some reason.
=cut
sub getPreferredEmailAddress($$) {
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
my($self, $donorId) = @_;
getPreferredEmailAddress: initial implementation.
2015-12-21 02:22:15 +00:00
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
die "setPreferredEmailAddress: invalid supporter id, $donorId" unless $self->_verifyId($donorId);
getPreferredEmailAddress: initial implementation.
2015-12-21 02:22:15 +00:00
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
my $ems = $self->dbh()->selectall_hashref("SELECT email_address FROM email_address em, donor_email_address_mapping sem " .
getPreferredEmailAddress: initial implementation.
2015-12-21 02:22:15 +00:00
"WHERE preferred AND sem.email_address_id = em.id AND " .
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
"sem.donor_id = " . $self->dbh->quote($donorId, 'SQL_INTEGER'),
getPreferredEmailAddress: initial implementation.
2015-12-21 02:22:15 +00:00
'email_address');
my $rowCount = scalar keys %{$ems};
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
die "setPreferredEmailAddress: DATABASE INTEGRITY ERROR: more than one email address is preferred for supporter, \"$donorId\""
getPreferredEmailAddress: initial implementation.
2015-12-21 02:22:15 +00:00
if $rowCount > 1;
if ($rowCount != 1) {
return undef;
} else {
my ($emailAddress) = keys %$ems;
return $emailAddress;
}
}
getLedgerEntityId: tests showing basic API & docs These tests show the basic API for the getLedgerEntityId() method. Documentation for the method also included.
2015-12-30 19:30:22 +00:00
######################################################################
_getDonorField: generalize code for donor fields This method can be used for a one-liner for any field in the donor table. Used it to implement getLedgerEntityId and getPublicAck.
2015-12-31 01:03:07 +00:00
sub _getDonorField($$$) {
my($self, $field, $donorId) = @_;
die "get$field: invalid supporter id, $donorId" unless $self->_verifyId($donorId);
my $results = $self->dbh()->selectall_hashref("SELECT id, $field FROM donor WHERE id = " .
$self->dbh->quote($donorId, 'SQL_INTEGER'),
'id');
my $rowCount = scalar keys %{$results};
die "get$field: DATABASE INTEGRITY ERROR: more than one row found when looking up supporter, \"$donorId\""
if $rowCount > 1;
if ($rowCount == 1) {
my ($val) = $results->{$donorId}{$field};
return $val;
} else {
die "get$field: DATABASE INTEGRITY ERROR: $donorId was valid but non-1 row count returned";
}
}
######################################################################
getLedgerEntityId: tests showing basic API & docs These tests show the basic API for the getLedgerEntityId() method. Documentation for the method also included.
2015-12-30 19:30:22 +00:00
=begin getLedgerEntityId
Arguments:
=over
=item $donorId
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.
=back
Returns the ledger_entity_id of the donor. Since the method die()s for an
invalid donor id, undef should never be returned and callers need not test
for it.
=cut
_getDonorField: generalize code for donor fields This method can be used for a one-liner for any field in the donor table. Used it to implement getLedgerEntityId and getPublicAck.
2015-12-31 01:03:07 +00:00
sub getLedgerEntityId ($$) {
return $_[0]->_getDonorField("ledger_entity_id", $_[1]);
getLedgerEntityId: Initial implementation. All tests now pass: ok 15 - getLedgerEntityId: fails when rows are not returned but _verifyId() somehow passed ok 16 - getLedgerEntityId: fails when rows are not returned but _verifyId() somehow passed ok 17 - getLedgerEntityId: lives when valid id is given... ok 18 - getLedgerEntityId: ...and return value is correct.
2015-12-30 19:31:36 +00:00
}
getPreferredEmailAddress: initial implementation.
2015-12-21 02:22:15 +00:00
######################################################################
getPublicAck: initial tests spec out API.
2015-12-31 00:51:04 +00:00
=begin getPublicAck
Arguments:
=over
=item $donorId
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.
=back
Returns the a boolean indicating whether or not the donor seeks to be
publicly acknowledged. undef can be returned if the donor has not specified,
so callers must check for undef.
=cut
_getDonorField: generalize code for donor fields This method can be used for a one-liner for any field in the donor table. Used it to implement getLedgerEntityId and getPublicAck.
2015-12-31 01:03:07 +00:00
sub getPublicAck($$$) {
return $_[0]->_getDonorField("public_ack", $_[1]);
getPublicAck: initial tests spec out API.
2015-12-31 00:51:04 +00:00
}
######################################################################
isSupporter: tests, implementation & docs.
2015-12-31 01:19:10 +00:00
=begin isSupporter
Arguments:
=over
=item $donorId
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.
=back
Returns the a boolean indicating whether or not the donor is a Supporter (as
opposed to an ordinary donor). undef will not be returned
=cut
sub isSupporter($$$) {
return $_[0]->_getDonorField("is_supporter", $_[1]);
}
######################################################################
getDisplayName: tests, implementation, and docs.
2015-12-31 01:12:58 +00:00
=begin getDisplayName
Arguments:
=over
=item $donorId
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.
=back
Returns the string of the display name for the donor. undef can be returned
if the donor has not specified, so callers must check for undef.
=cut
sub getDisplayName($$$) {
return $_[0]->_getDonorField("display_name", $_[1]);
}
######################################################################
setPublicAck: Implementation ok 48 - setPublicAck: fails supporterId invalid ok 49 - setPublicAck: fails supporterId is string ok 50 - setPublicAck: fails supporterId is undef ok 51 - setPublicAck: 1 failed calls changed nothing. ok 52 - setPublicAck: 1 failed calls changed nothing. ok 53 - setPublicAck: 1 failed calls changed nothing. ok 54 - setPublicAck: lives when valid id is given for undefining... ok 55 - setPublicAck: ...and suceeds in changing value. ok 56 - setPublicAck: lives when valid id is given for off... ok 57 - setPublicAck: ...and suceeds in changing value. ok 58 - setPublicAck: lives when valid id is given for on... ok 59 - setPublicAck: ...and suceeds in changing value.
2015-12-31 01:54:37 +00:00
sub _setDonorField($$$) {
my($self, $field, $donorId, $value, $type) = @_;
die "set$field: invalid supporter id, $donorId" unless $self->_verifyId($donorId);
$self->_beginWork();
$self->dbh->do("UPDATE donor " .
"SET $field = " . $self->dbh->quote($value, $type) . " " .
"WHERE id = " . $self->dbh->quote($donorId, 'SQL_INTEGER'));
$self->_commit;
return $value;
}
######################################################################
=begin setPublicAck
Arguments:
=over
=item $donorId
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 $publicAck
Can be true, false, or undef and will update public acknowledgement bit
accordingly for donor identified with C<$donorId>.
=back
=cut
sub setPublicAck($$$) {
return $_[0]->_setDonorField('public_ack', $_[1], $_[2], 'SQL_BOOLEAN');
}
######################################################################
getDisplayName: tests, implementation, and docs.
2015-12-31 01:12:58 +00:00
Begin implementation of addPostalAddress. These tests mostly fail, although a few pass automatically: not ok 26 - addPostalAddress: dies for undefined id not ok 27 - addPostalAddress: dies for non-numeric id not ok 28 - addPostalAddress: postal address undefined fails ok 29 - addPostalAddress: type is not added when other input paramaters are invalid ok 30 - addPostalAddress: addPostalAddress of a valid formatted_address works. ok 30 - addPostalAddress: addPostalAddress of a valid formatted_address works. not ok 31 - addPostalAddress: id returned is sane. Goal is to implement those and make sure they all pass.
2015-12-17 02:36:47 +00:00
=begin addPostalAddress
Arguments:
=over
=item $id
Valid supporter id number currently in the database. die() will occur if
the id number is not in the database already as a supporter id.
=item $formattedPostalAddress
Scalar string that contains a multi-line, fully formatted, postal address.
=item $addressType
Scalar string that contains the address type. This type will be created in
the database if it does not already exist, so be careful.
=back
Returns the id value of the postal_address table entry.
=cut
sub addPostalAddress($$$$) {
my($self, $id, $formattedPostalAddress, $addressType) = @_;
Implementation of addPostalAddress(). All tests related to addPostalAddress now pass. ok 28 - addPostalAddress: dies for undefined id ok 29 - addPostalAddress: dies for non-numeric id ok 30 - addPostalAddress: postal address undefined fails ok 31 - addPostalAddress: type is not added when other input paramaters are invalid ok 32 - addPostalAddress: addPostalAddress of a valid formatted_address works. ok 33 - addPostalAddress: id returned is sane.
2015-12-17 04:24:52 +00:00
die "addPostalAddress: invalid id, $id" unless $self->_verifyId($id);
die "addPostalAddress: the formatted postal address must be defined"
unless defined $formattedPostalAddress;
$self->_beginWork();
my $addressTypeId;
eval {
Correct mistyped variable name.
2015-12-18 00:59:27 +00:00
$addressTypeId = $self->addAddressType($addressType);
Implementation of addPostalAddress(). All tests related to addPostalAddress now pass. ok 28 - addPostalAddress: dies for undefined id ok 29 - addPostalAddress: dies for non-numeric id ok 30 - addPostalAddress: postal address undefined fails ok 31 - addPostalAddress: type is not added when other input paramaters are invalid ok 32 - addPostalAddress: addPostalAddress of a valid formatted_address works. ok 33 - addPostalAddress: id returned is sane.
2015-12-17 04:24:52 +00:00
};
if ($@ or not defined $addressTypeId) {
my $err = $@;
$err = "addPostalAddress: unable to addAddressType" if (not defined $err);
$self->_rollback();
die $@ if $@;
}
my $sth = $self->dbh->prepare("INSERT INTO postal_address(formatted_address, type_id, date_encountered)" .
"VALUES( ?, ?, date('now'))");
$sth->execute($formattedPostalAddress, $addressTypeId);
my $addressId = $self->dbh->last_insert_id("","","","");
$sth->finish();
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
$sth = $self->dbh->prepare("INSERT INTO donor_postal_address_mapping" .
"(donor_id, postal_address_id) " .
"VALUES( ?, ?)");
Implementation of addPostalAddress(). All tests related to addPostalAddress now pass. ok 28 - addPostalAddress: dies for undefined id ok 29 - addPostalAddress: dies for non-numeric id ok 30 - addPostalAddress: postal address undefined fails ok 31 - addPostalAddress: type is not added when other input paramaters are invalid ok 32 - addPostalAddress: addPostalAddress of a valid formatted_address works. ok 33 - addPostalAddress: id returned is sane.
2015-12-17 04:24:52 +00:00
$sth->execute($id, $addressId);
$sth->finish();
$self->_commit();
return $addressId;
Begin implementation of addPostalAddress. These tests mostly fail, although a few pass automatically: not ok 26 - addPostalAddress: dies for undefined id not ok 27 - addPostalAddress: dies for non-numeric id not ok 28 - addPostalAddress: postal address undefined fails ok 29 - addPostalAddress: type is not added when other input paramaters are invalid ok 30 - addPostalAddress: addPostalAddress of a valid formatted_address works. ok 30 - addPostalAddress: addPostalAddress of a valid formatted_address works. not ok 31 - addPostalAddress: id returned is sane. Goal is to implement those and make sure they all pass.
2015-12-17 02:36:47 +00:00
}
######################################################################
addRequestType and getRequestType methods. Including tests for both.
2015-12-13 20:16:14 +00:00
=begin getRequestType
Arguments:
=over
=item type
A string describing the request.
=back
Returns the id value of the request_type entry. undef is returned if there
is no request of that type.
=cut
sub getRequestType($$) {
my($self, $type) = @_;
return undef if not defined $type;
my $val = $self->dbh()->selectall_hashref("SELECT id, type FROM request_type WHERE type = '$type'", 'type');
return $val->{$type}{id} if (defined $val and defined $val->{$type} and defined $val->{$type}{id});
return undef;
}
######################################################################
=begin addRequestType
Arguments:
=over
=item type
A string describing the request. die()'s if not defined.
=back
Returns the id value of the request_type entry. If the type already exists,
it is simply returned.
=cut
sub addRequestType($$) {
my($self, $requestType) = @_;
die "addRequestType: undefined request type." unless defined $requestType;
my $requestId = $self->getRequestType($requestType);
return $requestId if (defined $requestId);
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
$self->_beginWork();
addRequestType and getRequestType methods. Including tests for both.
2015-12-13 20:16:14 +00:00
my $sth = $self->dbh->prepare("INSERT INTO request_type(type) VALUES(?)");
$sth->execute($requestType);
$requestId = $self->dbh->last_insert_id("","","","");
$sth->finish();
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
$self->_commit();
addRequestType and getRequestType methods. Including tests for both.
2015-12-13 20:16:14 +00:00
return $requestId;
}
######################################################################
Fail causes on getRequestConfigurations.
2015-12-13 20:50:08 +00:00
=begin getRequestConfigurations
Arguments:
=over
=item type
A string describing the request_type.
=back
Returns undef if the request_type is not found in the database. If the reuqest type is
is no request of that type.
=cut
sub getRequestConfigurations($$) {
my($self, $type) = @_;
return undef if not defined $type;
my $typeId = $self->getRequestType($type);
return undef if not defined $typeId;
Implementation of getRequestConfigurations A basic implementation of getRequestConfigurations and tests to go with it. Also added here is the test to verify that no items are added when duplicates are included.
2015-12-13 22:06:22 +00:00
my %descriptions;
my $dbData =
$self->dbh()->selectall_hashref("SELECT description, id FROM request_configuration " .
"WHERE request_type_id = " . $self->dbh->quote($typeId, 'SQL_INTEGER'),
'description');
foreach my $description (keys %$dbData) {
$descriptions{$description} = $dbData->{$description}{id};
}
return { $typeId => \%descriptions };
Fail causes on getRequestConfigurations.
2015-12-13 20:50:08 +00:00
}
######################################################################
Begin implementation of addRequestConfigurations Includes some modifications to reuse data from previous tests.
2015-12-13 21:04:27 +00:00
=begin addRequestConfigurations
Arguments:
=over
=item type
A string describing the request type. This will be created if it does not
already exist, so be careful.
=item descriptionListRef
A list reference to the list of configuration descriptions to associate
Basic implementation of addRequestConfigurations Adjusted one test slightly: there was a missing argument. Also, corrected test count. While implementing, I realized a failure mode that forces a rollback: duplication on the input list of configurations. Tests are now needed for that.
2015-12-13 21:37:52 +00:00
with this requestId. Duplicates aren't permitted in this list, and
die()'s if duplicates exist.
Begin implementation of addRequestConfigurations Includes some modifications to reuse data from previous tests.
2015-12-13 21:04:27 +00:00
=back
Returns a hash in the form of:
$requestTypeId => { description => $requestConfigurationId }
=cut
sub addRequestConfigurations($$$) {
my($self, $requestType, $descriptionListRef) = @_;
die "addRequestConfigurations: undefined request type." unless defined $requestType;
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
$self->_beginWork();
Begin implementation of addRequestConfigurations Includes some modifications to reuse data from previous tests.
2015-12-13 21:04:27 +00:00
my $requestId = $self->addRequestType($requestType);
Fix rollbacks calls properly here. Upon fixing the reference counter thing in the previous commit, this bug caused tests to fail. We have to _rollback() properly any time we've called _begin_work(), particularly before die()'ing after a _begin_work().
2015-12-17 04:11:50 +00:00
if (not defined $requestType) {
$self->_rollback();
die "addRequestConfigurations: unable to create request configurations";
}
Begin implementation of addRequestConfigurations Includes some modifications to reuse data from previous tests.
2015-12-13 21:04:27 +00:00
my %descriptions;
Basic implementation of addRequestConfigurations Adjusted one test slightly: there was a missing argument. Also, corrected test count. While implementing, I realized a failure mode that forces a rollback: duplication on the input list of configurations. Tests are now needed for that.
2015-12-13 21:37:52 +00:00
my $sth = $self->dbh->prepare("INSERT INTO request_configuration(request_type_id, description) " .
"VALUES(?, ?)");
foreach my $description (@{$descriptionListRef}) {
if (defined $descriptions{$description}) {
Fix rollbacks calls properly here. Upon fixing the reference counter thing in the previous commit, this bug caused tests to fail. We have to _rollback() properly any time we've called _begin_work(), particularly before die()'ing after a _begin_work().
2015-12-17 04:11:50 +00:00
$self->_rollback();
Basic implementation of addRequestConfigurations Adjusted one test slightly: there was a missing argument. Also, corrected test count. While implementing, I realized a failure mode that forces a rollback: duplication on the input list of configurations. Tests are now needed for that.
2015-12-13 21:37:52 +00:00
die "addRequestConfigurations: attempt to create duplicate request_configuration \"$description\" for requestType, \"$requestType\"";
}
$sth->execute($requestId, $description);
$descriptions{$description} = $self->dbh->last_insert_id("","","","");
}
$sth->finish();
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
$self->_commit();
Begin implementation of addRequestConfigurations Includes some modifications to reuse data from previous tests.
2015-12-13 21:04:27 +00:00
return { $requestId => \%descriptions };
}
######################################################################
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
=begin getRequest
Arguments:
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
=item $parmas
A hash reference, the following keys are considered:
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
=over
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
=item donorId
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
Valid donor_id number currently in the database. die() will occur if
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
the id number is not in the database already as a supporter id.
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
=item requestTypeId
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
Numeric id of a request_type entry. This must be a valid id in the
request_type table, otherwise the method L<die>()s.
requestType is ignored if this parameter is set.
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
=item requestType
If requestTypeId is not given, requestType will be used. The type is
added to the request_type table if it is not present, so be careful.
=item ignoreFulfilledRequests
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
Optional boolean argument. If true, a request that is found will not be
returned if the request has already been fulfilled. In other words, it
forces a return of undef for
=back
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
=back
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
Returns:
=over
=item undef
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
if the C<$requestType> is not found for C<$donorId> (or, as above,
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
the C<$requestType> is found but has been fufilled and
C<$ignoreFulfilledRequests>.
=item a hash reference
If found, the has reference will contain at least the following keys:
=over
=item requestType
Should match the request type in C<$requestType>
=item requestTypeId
The id from the request_type entry for C<$requestType>
=item requestDate
The date the request was made, in ISO 8601 format.
=back
Optionally, if these values are not null in the database record, the
following fields may also be included:
=over
=item notes
Notes made for the request.
=item requestConfiguration
any rquest configuration option given with the request.
=back
If the request has been fufilled, the following keys will also ahve values.
=over
=item fulfillDate
The date the request was fufilled, in ISO 8601 format.
=back
=back
=cut
sub getRequest($$;$) {
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
my($self, $params) = @_;
my($donorId, $requestType, $requestTypeId, $ignoreFulfilledRequests) =
($params->{donorId}, $params->{requestType}, $params->{requestTypeId}, $params->{ignoreFulfilledRequests});
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
die "getRequest: undefined donorId" unless defined $donorId;
die "getRequest: donorId, \"$donorId\" not found in supporter database"
unless $self->_verifyId($donorId);
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
my $requestTypeClause = "";
if (defined $requestTypeId) {
$requestType = $self->_lookupRequestTypeById($requestTypeId);
die "getRequest: invalid requestTypeId, \"$requestTypeId\"" unless defined $requestType;
$requestTypeClause = " AND rt.id = " . $self->dbh->quote($requestTypeId, 'SQL_INTEGER');
} elsif (defined $requestType) {
$requestTypeClause = " AND rt.type = " . $self->dbh->quote($requestType);
} else {
die "getRequest: undefined requestType" unless defined $requestType;
}
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
my $req = $self->dbh()->selectall_hashref("SELECT r.id, r.request_type_id, r.request_configuration_id, r.date_requested, r.notes, rt.type " .
"FROM request r, request_type rt WHERE r.request_type_id = rt.id AND " .
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
"r.donor_id = " . $self->dbh->quote($donorId, 'SQL_INTEGER') .
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
$requestTypeClause,
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
'type');
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
if (defined $requestTypeId) {
die "getRequest: given requestTypeId, \"$requestTypeId\" was not the one found in the database $req->{$requestType}{'request_type_id'}"
unless $req->{$requestType}{'request_type_id'} == $requestTypeId;
} else {
$requestTypeId = $req->{$requestType}{'request_type_id'};
}
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
return undef unless (defined $req and defined $req->{$requestType} and defined $req->{$requestType}{'id'});
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
getRequest: Initial implementation. This implementation of getRequest passes all the current tests, except for those relate to fulfillment.
2015-12-21 00:40:27 +00:00
my $requestId = $req->{$requestType}{'id'};
my $rsp = { requestType => $requestType,
requestTypeId => $requestTypeId,
requestId => $req->{$requestType}{'id'},
requestDate => $req->{$requestType}{'date_requested'},
notes => $req->{$requestType}{'notes'},
};
my $configs = $self->getRequestConfigurations($requestType);
my $configName;
foreach my $key (keys %{$configs->{$requestTypeId}}) {
if ($configs->{$requestTypeId}{$key} == $req->{$requestType}{'request_configuration_id'}) { $configName = $key; last; }
}
die("getRequest: discovered database integrity error: request_configuration, \"$req->{$requestType}{request_configuration_id} is " .
"not valid for requestId, \"$requestId\"") unless defined $configName or (keys %{$configs->{$requestId}} == 0);
$rsp->{requestConfiguration} = $configName;
my $fulfillReq = $self->dbh()->selectall_hashref("SELECT id, request_id, date FROM fulfillment WHERE request_id = " .
$self->dbh->quote($requestId, 'SQL_INTEGER'),
'request_id');
if (defined $fulfillReq and defined $fulfillReq->{$requestId} and defined $fulfillReq->{$requestId}{id}) {
return undef if $ignoreFulfilledRequests;
$rsp->{fulfillDate} = $fulfillReq->{$requestId}{date};
}
return $rsp;
}
######################################################################
addRequest: begin implementation Basic implementation of addRequest, which causes these test to now pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType
2015-12-20 18:06:30 +00:00
=begin addRequest
Arguments:
=over
=item $parmas
A hash reference, the following keys are considered:
=over
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
=item donorId
addRequest: begin implementation Basic implementation of addRequest, which causes these test to now pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType
2015-12-20 18:06:30 +00:00
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
Valid donor_id number currently in the database. die() will occur if
addRequest: begin implementation Basic implementation of addRequest, which causes these test to now pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType
2015-12-20 18:06:30 +00:00
the id number is not in the database already as a supporter id.
=item requestTypeId
Numeric id of a request_type entry. This must be a valid id in the
request_type table, otherwise the method L<die>()s.
requestType is ignored if this parameter is set.
=item requestType
If requestTypeId is not given, requestType will be used. The type is
added to the request_type table if it is not present, so be careful.
=item requestConfigurationId
Numeric id of a request_configuration entry. This must be a valid id in
the request_configuration table, otherwise the method L<die>()s.
=item requestConfiguration
If requestConfigurationId is not given, requestConfiguration will be used.
This configuration will be added to the request_configuration table if it
is not present, so be careful.
=back
=back
Returns the id value of the request entry.
=cut
sub addRequest($$) {
my($self, $params) = @_;
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
die "addRequest: undefined donorId" unless defined $params->{donorId};
my $donorId = $params->{donorId};
die "addRequest: donorId, \"$donorId\" not found in supporter database"
unless $self->_verifyId($donorId);
addRequest: initial implementation addRequest-specific unit tests now all pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 59 - addRequest: succeeds with a requestType but no configuration parameter. ok 60 - addRequest: id returned on successful addRequest() is a number ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType ok 62 - addRequest: succeeds with a requestType and requestConfiguration and a note. ok 63 - addRequest: succeeds with a requestTypeId and requestConfigurationId with no a note.
2015-12-20 20:46:07 +00:00
addRequest: begin implementation Basic implementation of addRequest, which causes these test to now pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType
2015-12-20 18:06:30 +00:00
$self->_beginWork;
_rollback() work if failure occurs in these calls. This is the location where there was unbalanced _beginWork()/_commit() calls. In future, when writing tests, it's probably good to check this often in the tests.
2015-12-21 02:51:53 +00:00
eval {
$self->_getOrCreateRequestType($params);
$self->_getOrCreateRequestConfiguration($params) if (defined $params->{requestConfiguration} or
defined $params->{requestConfigurationId});
};
if ($@ or not defined $params->{requestTypeId}) {
my $err = $@;
$err = "addRequest: unable to create requestType" if (not defined $err);
$self->_rollback();
die $@ if $@;
}
addRequest: initial implementation addRequest-specific unit tests now all pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 59 - addRequest: succeeds with a requestType but no configuration parameter. ok 60 - addRequest: id returned on successful addRequest() is a number ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType ok 62 - addRequest: succeeds with a requestType and requestConfiguration and a note. ok 63 - addRequest: succeeds with a requestTypeId and requestConfigurationId with no a note.
2015-12-20 20:46:07 +00:00
# After those two calls above, I know I have requestTypeId and
# requestConfigurationId are accurate. Note that
# $params->{requestConfigurationId} can be undef, which is permitted in the
# database schema.
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
my $sth = $self->dbh->prepare("INSERT INTO request(donor_id, request_type_id, request_configuration_id, notes, date_requested) " .
addRequest: initial implementation addRequest-specific unit tests now all pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 59 - addRequest: succeeds with a requestType but no configuration parameter. ok 60 - addRequest: id returned on successful addRequest() is a number ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType ok 62 - addRequest: succeeds with a requestType and requestConfiguration and a note. ok 63 - addRequest: succeeds with a requestTypeId and requestConfigurationId with no a note.
2015-12-20 20:46:07 +00:00
"VALUES(?, ?, ?, ?, date('now'))");
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
$sth->execute($donorId, $params->{requestTypeId}, $params->{requestConfigurationId}, $params->{notes});
addRequest: initial implementation addRequest-specific unit tests now all pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 59 - addRequest: succeeds with a requestType but no configuration parameter. ok 60 - addRequest: id returned on successful addRequest() is a number ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType ok 62 - addRequest: succeeds with a requestType and requestConfiguration and a note. ok 63 - addRequest: succeeds with a requestTypeId and requestConfigurationId with no a note.
2015-12-20 20:46:07 +00:00
my $id = $self->dbh->last_insert_id("","","","");
addRequest: begin implementation Basic implementation of addRequest, which causes these test to now pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType
2015-12-20 18:06:30 +00:00
$self->_commit;
addRequest: initial implementation addRequest-specific unit tests now all pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 59 - addRequest: succeeds with a requestType but no configuration parameter. ok 60 - addRequest: id returned on successful addRequest() is a number ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType ok 62 - addRequest: succeeds with a requestType and requestConfiguration and a note. ok 63 - addRequest: succeeds with a requestTypeId and requestConfigurationId with no a note.
2015-12-20 20:46:07 +00:00
return $id;
addRequest: begin implementation Basic implementation of addRequest, which causes these test to now pass: ok 55 - addRequest: dies if supporterId not specified. ok 56 - addRequest: dies if requestTypeId / requestType not specified. ok 57 - addRequest: dies if supporterId invalid. ok 58 - addRequest: dies if requestTypeId invalid. ok 61 - addRequest: underlying call to addRequestType works properly, per getRequestType
2015-12-20 18:06:30 +00:00
}
######################################################################
Fix my bad spelling: fufill -> fulfill
2015-12-20 22:01:15 +00:00
=begin fulfillRequest
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
Arguments:
=over
=item $parmas
A hash reference, the following keys are considered:
=over
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
=item donorId
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
Valid donor_id number currently in the database. die() will occur if
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
the id number is not in the database already as a supporter id.
=item requestType
requestType of the request to be fulfilled. die() will occur if this is
Fix my bad spelling: fufill -> fulfill
2015-12-20 22:01:15 +00:00
undefined. undef is returned if there is no unfulfilled request of
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
requestType in the database for supporter identified by
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
C<$params->{donorId}>
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
=item who
A scalar string representing the person that fulfilled the request. die()
will occur if C<$params->{who}> is not defined.
=item how
Fix my bad spelling: fufill -> fulfill
2015-12-20 22:01:15 +00:00
A scalar string describing how the request was fulfilled. It can safely be
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
undefined.
=back
=back
fulfillRequest: test had incorrect return value. fulfillRequest() returns the id, not a hash of values.
2015-12-21 01:07:44 +00:00
Returns the id value of the fulfillment entry.
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
=cut
Fix my bad spelling: fufill -> fulfill
2015-12-20 22:01:15 +00:00
sub fulfillRequest($$) {
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
my($self, $params) = @_;
Use donorId rather than supporterId as main handle Since we converted to making this a more general donor database, change the handle used for an individual in the database from supporterId to donorId. Note that I left addSupporter() method name untouched because it does automatically assume you mean a supporter, not a mere donor. Later, an addDonor() method should likely be added.
2015-12-30 11:13:41 +00:00
die "fulfillRequest: undefined donorId" unless defined $params->{donorId};
my $donorId = $params->{donorId};
die "fulfillRequest: donorId, \"$donorId\" not found in supporter database"
unless $self->_verifyId($donorId);
Fix my bad spelling: fufill -> fulfill
2015-12-20 22:01:15 +00:00
die "fulfillRequest: undefined who" unless defined $params->{who};
fulfillRequest: allow requestTypeId per getRequest getRequest() now allows requestTypeId, so fulfillRequest() can as well. Add tests for that, and don't die if requestType isn't given.
2015-12-30 12:12:21 +00:00
die "fulfillRequest: both requestType and requestTypeId undefined"
unless defined $params->{requestType} or defined $params->{requestTypeId};
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
getRequest: re-implement to take hash argument Instead of a bunch of serial arguments, reimplement getRequest() to take a hash of parameters. In the process, add support for requestTypeId to be included.
2015-12-30 11:58:48 +00:00
my $req = $self->getRequest($params);
Extract $requestId from getRequest() return. of course, getRequest() returns a hash so we must properly extract the value we want. This fix causes this test to now pass: ok 73 - fulfillRequest: databse entry from successful return is correct
2015-12-21 01:02:44 +00:00
return undef if not defined $req;
my $requestId = $req->{requestId};
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
return undef if not defined $requestId;
fulfillRequest(): basic implementation. First attempt at implementing fulfillRequest() method. It seems that request_id was incorrectly missing from the fulfillment table.
2015-12-20 21:59:50 +00:00
Fix typos in SQL and return value. This causes the basic add test to finally pass: ok 70 - fulfillRequest: succeeds for existing request
2015-12-21 00:58:13 +00:00
my $fulfillLookupSql = "SELECT id, request_id FROM fulfillment WHERE request_id = " .
fulfillRequest(): basic implementation. First attempt at implementing fulfillRequest() method. It seems that request_id was incorrectly missing from the fulfillment table.
2015-12-20 21:59:50 +00:00
$self->dbh->quote($requestId, 'SQL_INTEGER');
Fix my bad spelling: fufill -> fulfill
2015-12-20 22:01:15 +00:00
my $fulfillRecord = $self->dbh()->selectall_hashref($fulfillLookupSql, "request_id");
Fix typos in SQL and return value. This causes the basic add test to finally pass: ok 70 - fulfillRequest: succeeds for existing request
2015-12-21 00:58:13 +00:00
if (not defined $fulfillRecord or not defined $fulfillRecord->{$requestId}) {
fulfillRequest(): basic implementation. First attempt at implementing fulfillRequest() method. It seems that request_id was incorrectly missing from the fulfillment table.
2015-12-20 21:59:50 +00:00
$self->_beginWork;
Fix typos in SQL and return value. This causes the basic add test to finally pass: ok 70 - fulfillRequest: succeeds for existing request
2015-12-21 00:58:13 +00:00
my $sth = $self->dbh->prepare("INSERT INTO fulfillment(request_id, who, how, date) " .
"VALUES(? , ? , ? , date('now'))");
fulfillRequest(): basic implementation. First attempt at implementing fulfillRequest() method. It seems that request_id was incorrectly missing from the fulfillment table.
2015-12-20 21:59:50 +00:00
$sth->execute($requestId, $params->{who}, $params->{how});
$sth->finish;
$self->_commit;
Fix typos in SQL and return value. This causes the basic add test to finally pass: ok 70 - fulfillRequest: succeeds for existing request
2015-12-21 00:58:13 +00:00
$fulfillRecord = $self->dbh()->selectall_hashref($fulfillLookupSql, "request_id");
fulfillRequest(): basic implementation. First attempt at implementing fulfillRequest() method. It seems that request_id was incorrectly missing from the fulfillment table.
2015-12-20 21:59:50 +00:00
}
Fix typos in SQL and return value. This causes the basic add test to finally pass: ok 70 - fulfillRequest: succeeds for existing request
2015-12-21 00:58:13 +00:00
return $fulfillRecord->{$requestId}{id};
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
}
findDonor: initial implementation. This seems to work and all existing tests for it pass: ok 134 - findDonor: no search criteria dies ok 135 - findDonor: 1 lookup of known missing succeeds ... ok 136 - findDonor: ... but finds nothing. ok 137 - findDonor: 2 lookup of known missing succeeds ... ok 138 - findDonor: ... but finds nothing. ok 139 - findDonor: 1 and'ed criteria succeeds ... ok 140 - findDonor: ... but finds nothing. ok 141 - findDonor: 2 and'ed criteria succeeds ... ok 142 - findDonor: ... but finds nothing. ok 143 - findDonor: 1 valid multiple criteria succeeds ... ok 144 - findDonor: ... and finds right entry. ok 145 - findDonor: 2 valid multiple criteria succeeds ... ok 146 - findDonor: ... and finds right entry. ok 147 - findDonor: 3 valid multiple criteria succeeds ... ok 148 - findDonor: ... and finds right entry. ok 149 - findDonor: single criteria find expecting multiple records succeeds... ok 150 - findDonor: ... and finds the right entires.
2015-12-30 14:09:43 +00:00
######################################################################
=begin findDonor
Arguments:
=over
=item $parmas
A hash reference, the following keys are considered, and are "anded" together
-- in that the donor sought must have all these criteria to be found.
=over
=item emailAddress
A string containing an email_address from email_address table.
=item ledgerEntityId
A string containing a ledger_entity_id from the donor table.
undefined. undef is returned if there is no unfulfilled request of
requestType in the database for supporter identified by
C<$params->{donorId}>
=back
=back
Returns a list of donorIds that meets the criteria, or none if not found.
=cut
sub findDonor($$) {
my($self, $params) = @_;
die "findDonor: no search criteria given"
unless defined $params->{ledgerEntityId} or defined $params->{emailAddress};
my @donorIds;
if (not defined $params->{emailAddress}) {
my $ledgerEntityId = $params->{ledgerEntityId};
# Simple case: just lookup without a join.
my $val = $self->dbh()->selectall_hashref("SELECT id, ledger_entity_id from donor where ledger_entity_id = " .
$self->dbh->quote($ledgerEntityId),
"ledger_entity_id");
# As Connor MacLeod said, "There can be only one!"
# (because of "ledger_entity_id" varchar(300) NOT NULL UNIQUE,)
push(@donorIds, $val->{$ledgerEntityId}{id})
if (defined $val and defined $val->{$ledgerEntityId} and defined $val->{$ledgerEntityId}{id});
} else {
my $sql = "SELECT d.id from donor d, email_address ea, donor_email_address_mapping eam " .
"WHERE eam.email_address_id = ea.id AND d.id = eam.donor_id AND " .
"ea.email_address = " . $self->dbh->quote($params->{emailAddress});
$sql .= " AND d.ledger_entity_id = " . $self->dbh->quote($params->{ledgerEntityId})
if (defined $params->{ledgerEntityId});
my $val = $self->dbh()->selectall_hashref($sql, 'id');
push(@donorIds, keys %{$val}) if (defined $val);
}
return(@donorIds);
}
fufillRequest: parameter checks. Parameter check tests now pass: ok 66 - fufillRequest: dies if supporterId not specified ok 67 - fufillRequest: dies if supporterId not found in database ok 68 - fufillRequest: dies if requestType not specified ok 69 - fufillRequest: who not specified Also added new test.
2015-12-20 21:46:45 +00:00
######################################################################
donorLastGave: initial implementation.
2015-12-31 03:01:03 +00:00
=begin donorLastGave
Arguments:
=over
=item $self
Current object.
=item $donorId
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.
=back
Returns an ISO 8601 formatted date of their last donation. undef will be
returned if the donor has never given (which should rarely be the case, but
it could happen).
=cut
sub donorLastGave($$) {
my($self, $donorId) = @_;
confess "lastGave: donorId, \"$donorId\" not found in supporter database"
unless $self->_verifyId($donorId);
$self->_readLedgerData() if not defined $self->{ledgerData};
my $ledgerEntityId = $self->getLedgerEntityId($donorId);
if (not defined $self->{ledgerData}{$ledgerEntityId} or
not defined $self->{ledgerData}{$ledgerEntityId}{__LAST_GAVE__} or
$self->{ledgerData}{$ledgerEntityId}{__LAST_GAVE__} eq '1975-01-01') {
return undef;
} else {
return $self->{ledgerData}{$ledgerEntityId}{__LAST_GAVE__};
}
}
######################################################################
donorFirstGave: tests and initial implementation.
2015-12-31 03:32:31 +00:00
=begin donorFirstGave
Arguments:
=over
=item $self
Current object.
=item $donorId
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.
=back
Returns an ISO 8601 formatted date of their first donation. undef will be
returned if the donor has never given (which should rarely be the case, but
it could happen).
=cut
sub donorFirstGave($$) {
my($self, $donorId) = @_;
confess "donorFirstGave: donorId, \"$donorId\" not found in supporter database"
unless $self->_verifyId($donorId);
$self->_readLedgerData() if not defined $self->{ledgerData};
my $ledgerEntityId = $self->getLedgerEntityId($donorId);
if (not defined $self->{ledgerData}{$ledgerEntityId} or
not defined $self->{ledgerData}{$ledgerEntityId}{__FIRST_GAVE__} or
$self->{ledgerData}{$ledgerEntityId}{__FIRST_GAVE__} eq '9999-12-31') {
return undef;
} else {
return $self->{ledgerData}{$ledgerEntityId}{__FIRST_GAVE__};
}
}
######################################################################
Add missing =back in documentation.
2015-12-21 01:11:01 +00:00
=back
_verifyId method: initial implementation. Internal method for use to verify that an id we have really is in the database. For use before other operations.
2015-12-10 02:38:07 +00:00
=head1 Non-Public Methods
These methods are part of the internal implementation are not recommended for
use outside of this module.
=over
donorLastGave: initial implementation.
2015-12-31 03:01:03 +00:00
=item _readLedgerData
=cut
sub _readLedgerData($) {
my($self) = @_;
my @cmd = @{$self->{ledgerCmd}};
my %amountTable;
open(ALL, "-|", @cmd) or confess "unable to run command ledger command: @cmd: $!";
while (my $line = <ALL>) {
next if $line =~ /^\s*$/;
die "Invalid line in @cmd output:\n $line"
unless $line =~ /^\s*([^\d]+)\s+([\d\-]+)\s+(\S+)\s+\$\s*(\-?\s*[\d,\.]+)\s*$/;
my($type, $date, $entityId, $amount) = ($1, $2, $3, $4);
if (defined $self->{programTypeSearch}) {
if ($type =~ /$self->{programTypeSearch}{annual}/) {
$type = 'Annual';
} elsif ($type =~ /$self->{programTypeSearch}{monthly}/) {
$type = 'Monthly';
}
}
die "Unknown type $type for $entityId from $line" if $type !~ /^(Monthly|Annual)$/ and defined $self->{programTypeSearch};
$amount =~ s/,//; $amount = abs($amount);
if (defined $amountTable{$entityId}{donations}{$date}) {
$amountTable{$entityId}{donations}{$date} += $amount;
} else {
$amountTable{$entityId}{donations}{$date} = $amount;
}
unless (defined $amountTable{$entityId}{__TOTAL__}) {
$amountTable{$entityId}{__TOTAL__} = 0.00;
$amountTable{$entityId}{__LAST_GAVE__} = '1975-01-01';
$amountTable{$entityId}{__FIRST_GAVE__} = '9999-12-31';
}
$amountTable{$entityId}{__TOTAL__} += $amount;
if ($date gt $amountTable{$entityId}{__LAST_GAVE__}) {
# Consider the "type" of the donor to be whatever type they were at last donation
$amountTable{$entityId}{__TYPE__} = $type;
$amountTable{$entityId}{__LAST_GAVE__} = $date;
}
$amountTable{$entityId}{__FIRST_GAVE__} = $date
if $date lt $amountTable{$entityId}{__FIRST_GAVE__};
}
close ALL; die "error($?) running command, @cmd: $!" unless $? == 0;
$self->{ledgerData} = \%amountTable;
}
DESTROY: detect _beginWork/_commit mismatches. The best place to detect these mismatches is in DESTROY. An error should be given when they are mismatched and we DESTROY the object. That's now done.
2015-12-21 02:52:08 +00:00
=item DESTROY
=cut
sub DESTROY {
my $self = shift;
return unless defined $self;
# Force rollback if we somehow get destroy'ed while counter is up
if (defined $self->{__NESTED_TRANSACTION_COUNTER__} and $self->{__NESTED_TRANSACTION_COUNTER__} > 0) {
my $errorStr = "SUPPORTERS DATABASE ERROR: Mismatched begin_work/commit pair in API implementation";
if (not defined $self->{dbh}) {
$errorStr .= "... and unable to rollback or commit work. Database may very well be inconsistent!";
} else {
# Rollback if we didn't call commit enough; commit if we called commit too often.
($self->{__NESTED_TRANSACTION_COUNTER__} > 0) ? $self->_rollback() : $self->_commit();
$self->{dbh}->disconnect();
}
$self->{__NESTED_TRANSACTION_COUNTER__} = 0;
die $errorStr;
}
delete $self->{__NESTED_TRANSACTION_COUNTER__};
$self->{dbh}->disconnect() if defined $self->{dbh} and blessed($self->{dbh}) =~ /DBI/;
}
_verifyId method: initial implementation. Internal method for use to verify that an id we have really is in the database. For use before other operations.
2015-12-10 02:38:07 +00:00
=item _verifyId()
Parameters:
=over
=item $self: current object.
=item $id: A scalar numeric argument that is the to lookup
=back
Returns: scalar boolean, which is true iff. the $id is valid and already in the supporter database.
=cut
Fix number of arguments on _verifyId in prototype.
2015-12-13 20:15:50 +00:00
sub _verifyId($$) {
_verifyId method: initial implementation. Internal method for use to verify that an id we have really is in the database. For use before other operations.
2015-12-10 02:38:07 +00:00
my($self, $id) = @_;
confess is better here than die. Maybe I should use it throughout?
2015-12-31 00:09:59 +00:00
confess "_verifyId(): called with a non-numeric id" unless defined $id and looks_like_number($id);
_verifyId method: initial implementation. Internal method for use to verify that an id we have really is in the database. For use before other operations.
2015-12-10 02:38:07 +00:00
Change table to donor; add is_supporter field. Up until now, this software has been focused on just Supporters, but really there is no reason this should not be a general donor database. Therefore, don't use the name supporter in the database, and add a field. public_ack is now allowed to be NULL, because the idea being we don't have an answer from all who donate whether or not they want public acknowledgment. the is_supporter boolean is added to record whether or not they came through the supporter program.
2015-12-30 11:10:07 +00:00
my $val = $self->dbh()->selectall_hashref("SELECT id FROM donor WHERE id = " .
We should call the DBI quote function for integer.
2015-12-18 03:54:37 +00:00
$self->dbh->quote($id, 'SQL_INTEGER'), 'id');
_verifyId method: initial implementation. Internal method for use to verify that an id we have really is in the database. For use before other operations.
2015-12-10 02:38:07 +00:00
return (defined $val and defined $val->{$id});
}
_verifyRequestTypeId =>_lookupRequestTypeById I found need to have _verifyRequestTypeId() actually return the request_type in a reimplementation of getRequest() that I'm working on, so I've made this change. Some tests are failing because of the use of _verifyRequestTypeId(). Next commit will address that.
2015-12-30 11:55:28 +00:00
=item _lookupRequestTypeById()
_verifyRequestTypeId: Implementation & unit tests. Straightforward helper method.
2015-12-20 19:07:06 +00:00
Parameters:
=over
=item $self: current object.
=item $requestTypeId: A scalar numeric argument that is the request type id to lookup
=back
_verifyRequestTypeId =>_lookupRequestTypeById I found need to have _verifyRequestTypeId() actually return the request_type in a reimplementation of getRequest() that I'm working on, so I've made this change. Some tests are failing because of the use of _verifyRequestTypeId(). Next commit will address that.
2015-12-30 11:55:28 +00:00
Returns: scalar, which is the request_type found iff. the C<$requestTypeId> is valid and
_verifyRequestTypeId: Implementation & unit tests. Straightforward helper method.
2015-12-20 19:07:06 +00:00
already in the supporter database's request_type table.
_verifyRequestTypeId =>_lookupRequestTypeById I found need to have _verifyRequestTypeId() actually return the request_type in a reimplementation of getRequest() that I'm working on, so I've made this change. Some tests are failing because of the use of _verifyRequestTypeId(). Next commit will address that.
2015-12-30 11:55:28 +00:00
Die if the C<$requestTypeId> isn't a number.
_verifyRequestTypeId: Implementation & unit tests. Straightforward helper method.
2015-12-20 19:07:06 +00:00
=cut
_verifyRequestTypeId =>_lookupRequestTypeById I found need to have _verifyRequestTypeId() actually return the request_type in a reimplementation of getRequest() that I'm working on, so I've made this change. Some tests are failing because of the use of _verifyRequestTypeId(). Next commit will address that.
2015-12-30 11:55:28 +00:00
sub _lookupRequestTypeById($$) {
_verifyRequestTypeId: Implementation & unit tests. Straightforward helper method.
2015-12-20 19:07:06 +00:00
my($self, $requestTypeId) = @_;
die "_verifyRequestTypeId() called with a non-numeric id" unless defined $requestTypeId and looks_like_number($requestTypeId);
_verifyRequestTypeId =>_lookupRequestTypeById I found need to have _verifyRequestTypeId() actually return the request_type in a reimplementation of getRequest() that I'm working on, so I've made this change. Some tests are failing because of the use of _verifyRequestTypeId(). Next commit will address that.
2015-12-30 11:55:28 +00:00
my $val = $self->dbh()->selectall_hashref("SELECT id, type FROM request_type WHERE id = " .
_verifyRequestTypeId: Implementation & unit tests. Straightforward helper method.
2015-12-20 19:07:06 +00:00
$self->dbh->quote($requestTypeId, 'SQL_INTEGER'), 'id');
_verifyRequestTypeId =>_lookupRequestTypeById I found need to have _verifyRequestTypeId() actually return the request_type in a reimplementation of getRequest() that I'm working on, so I've made this change. Some tests are failing because of the use of _verifyRequestTypeId(). Next commit will address that.
2015-12-30 11:55:28 +00:00
if (defined $val and defined $val->{$requestTypeId}) {
return $val->{$requestTypeId}{type};
} else {
return undef;
}
_verifyRequestTypeId: Implementation & unit tests. Straightforward helper method.
2015-12-20 19:07:06 +00:00
}
_lookupEmailAddressId: implement helper function This helper function will be needed for a few changes I'm about to make.
2015-12-30 13:33:05 +00:00
######################################################################
_lookupEmailAddress: replace _lookupEmailAddressId Actually, I will ultimately need the whole record for my purposes, so rework this function to return everything.
2015-12-30 13:41:10 +00:00
=item _lookupEmailAddress()
_lookupEmailAddressId: implement helper function This helper function will be needed for a few changes I'm about to make.
2015-12-30 13:33:05 +00:00
Parameters:
=over
=item $self: current object.
=item $emailAdress: A scalar string argument that is the email_adress
=back
_lookupEmailAddress: replace _lookupEmailAddressId Actually, I will ultimately need the whole record for my purposes, so rework this function to return everything.
2015-12-30 13:41:10 +00:00
Returns: undef if the email address is not found, otherwise a hash with the following values:
=over
=item emailAddress: The email address as given
=item id: The email_adress.id
=item type: The email_adress type
=item dateEncountered: The date_encountered of this email address.
=back
_lookupEmailAddressId: implement helper function This helper function will be needed for a few changes I'm about to make.
2015-12-30 13:33:05 +00:00
=cut
_lookupEmailAddress: replace _lookupEmailAddressId Actually, I will ultimately need the whole record for my purposes, so rework this function to return everything.
2015-12-30 13:41:10 +00:00
sub _lookupEmailAddress($$) {
_lookupEmailAddressId: implement helper function This helper function will be needed for a few changes I'm about to make.
2015-12-30 13:33:05 +00:00
my($self, $emailAddress) = @_;
die "_lookupEmailAddressId() called with undef" unless defined $emailAddress;
_lookupEmailAddress: replace _lookupEmailAddressId Actually, I will ultimately need the whole record for my purposes, so rework this function to return everything.
2015-12-30 13:41:10 +00:00
my $val = $self->dbh()->selectall_hashref("SELECT ea.id, ea.email_address, at.name, ea.date_encountered " .
"FROM email_address ea, address_type at " .
"WHERE ea.type_id = at.id AND " .
"email_address = " . $self->dbh->quote($emailAddress),
'email_address');
_lookupEmailAddressId: implement helper function This helper function will be needed for a few changes I'm about to make.
2015-12-30 13:33:05 +00:00
if (defined $val and defined $val->{$emailAddress}) {
_lookupEmailAddress: replace _lookupEmailAddressId Actually, I will ultimately need the whole record for my purposes, so rework this function to return everything.
2015-12-30 13:41:10 +00:00
return { id => $val->{$emailAddress}{id}, emailAddress => $val->{$emailAddress}{email_address},
type => $val->{$emailAddress}{name}, dateEncountered => $val->{$emailAddress}{date_encountered}};
_lookupEmailAddressId: implement helper function This helper function will be needed for a few changes I'm about to make.
2015-12-30 13:33:05 +00:00
} else {
return undef;
}
}
_verifyRequestTypeId: Implementation & unit tests. Straightforward helper method.
2015-12-20 19:07:06 +00:00
Implementation of _getOrCreateRequestType Tests pass for this now: ok 97 - _getOrCreateRequestType: dies on empty hash ok 98 - _getOrCreateRequestType: dies for string request id ok 99 - _getOrCreateRequestType: dies for non-existant requestTypeId ok 100 - _getOrCreateRequestType: succeeds with just requestType ok 101 - _getOrCreateRequestType: lookup of a request works after _getOrCreateRequestType ok 102 - _getOrCreateRequestType: lookup of a request works after _getOrCreateRequestType ok 103 - _getOrCreateRequestType: lookup of existing requestType suceeds. ok 104 - _getOrCreateRequestType: deletes requestType if both are provided.
2015-12-18 04:15:41 +00:00
=item _getOrCreateRequestType
Arguments:
=over
=item $params (hash reference)
This hash reference usually contains other paramaters, too, but this method
looks only at the keys C<requestType> and C<requestTypeId>. If
C<requestTypeId> is set, it simply deletes the C<requestType> parameter and
verifies c<reuqestTypeId> is in the request_type table.
=cut
sub _getOrCreateRequestType($$) {
my($self, $params) = @_;
if (not defined $params->{requestTypeId}) {
$params->{requestTypeId} = $self->addRequestType($params->{requestType});
} else {
my $id = $params->{requestTypeId};
Simplify code: use helper function that does same This code was roughly duplicate of what _verifyRequestTypeId() was already doing.
2015-12-30 11:33:36 +00:00
die "_getOrCreateRequestType(): invalid requestTypeId, \"$id\""
_verifyRequestTypeId =>_lookupRequestTypeById I found need to have _verifyRequestTypeId() actually return the request_type in a reimplementation of getRequest() that I'm working on, so I've made this change.
2015-12-30 11:57:19 +00:00
unless defined $self->_lookupRequestTypeById($id);
Implementation of _getOrCreateRequestType Tests pass for this now: ok 97 - _getOrCreateRequestType: dies on empty hash ok 98 - _getOrCreateRequestType: dies for string request id ok 99 - _getOrCreateRequestType: dies for non-existant requestTypeId ok 100 - _getOrCreateRequestType: succeeds with just requestType ok 101 - _getOrCreateRequestType: lookup of a request works after _getOrCreateRequestType ok 102 - _getOrCreateRequestType: lookup of a request works after _getOrCreateRequestType ok 103 - _getOrCreateRequestType: lookup of existing requestType suceeds. ok 104 - _getOrCreateRequestType: deletes requestType if both are provided.
2015-12-18 04:15:41 +00:00
}
delete $params->{requestType};
}
_getOrCreateRequestConfiguration: error conditions These tests now pass: ok 110 - _getOrCreateRequestConfiguration: dies on empty hash ok 111 - _getOrCreateRequestConfiguration: dies for string requestConfigurationId ok 112 - _getOrCreateRequestConfiguration: dies for non-existant requestConfigurationId ok 113 - _getOrCreateRequestConfiguration: dies for string request id ok 114 - _getOrCreateRequestConfiguration: dies for non-existant requestTypeId
2015-12-20 19:11:42 +00:00
=item _getOrCreateRequestConfiguration
Arguments:
=over
=item $params (hash reference)
This hash reference usually contains other paramaters, too, but this method
looks only at the keys C<requestTypeId>, C<requestConfiguration> and
C<requestConfigurationId>. If C<requestConfigurationId> is set, it simply
deletes the C<requestConfiguration> parameter and verifies c<reuqestTypeId>
is in the request_type table.
=cut
sub _getOrCreateRequestConfiguration($$) {
my($self, $params) = @_;
die "_getOrCreateRequestConfiguration: requestTypeId is required" unless defined $params->{requestTypeId};
More descriptive variable name.
2015-12-20 19:14:13 +00:00
my $requestTypeId = $params->{requestTypeId};
die "_getOrCreateRequestConfiguration: requestTypeId must be a number" unless looks_like_number($requestTypeId);
_getOrCreateRequestConfiguration: Fix various bugs There was some parameter confusion (using ids instead of the actual types/descriptions) on some of the public facing methods. Also, lookup of existing ids was buggy; just use public facing methods.
2015-12-20 20:10:27 +00:00
my $val = $self->dbh()->selectall_hashref("SELECT id, type FROM request_type WHERE id = " .
$self->dbh->quote($requestTypeId, 'SQL_INTEGER'), 'id');
die "_getOrCreateRequestConfiguration: unknown requestTypeId, \"$requestTypeId\""
unless (defined $val and defined $val->{$requestTypeId} and defined $val->{$requestTypeId}{type});
my $requestType = $val->{$requestTypeId}{type};
my $existingRequestConfig = $self->getRequestConfigurations($requestType);
die "_getOrCreateRequestConfiguration: requestTypeId is unknown" unless (keys(%$existingRequestConfig) == 1);
_getOrCreateRequestConfiguration: error conditions These tests now pass: ok 110 - _getOrCreateRequestConfiguration: dies on empty hash ok 111 - _getOrCreateRequestConfiguration: dies for string requestConfigurationId ok 112 - _getOrCreateRequestConfiguration: dies for non-existant requestConfigurationId ok 113 - _getOrCreateRequestConfiguration: dies for string request id ok 114 - _getOrCreateRequestConfiguration: dies for non-existant requestTypeId
2015-12-20 19:11:42 +00:00
_getOrCreateRequestConfiguration: Implement. Implementation of this method.
2015-12-20 19:20:16 +00:00
if (not defined $params->{requestConfigurationId}) {
_getOrCreateRequestConfiguration: Fix various bugs There was some parameter confusion (using ids instead of the actual types/descriptions) on some of the public facing methods. Also, lookup of existing ids was buggy; just use public facing methods.
2015-12-20 20:10:27 +00:00
die "_getOrCreateRequestConfiguration: requestConfiguration is not defined" unless defined $params->{requestConfiguration};
if (defined $existingRequestConfig->{$requestTypeId}{$params->{requestConfiguration}}) {
$params->{requestConfigurationId} = $existingRequestConfig->{$requestTypeId}{$params->{requestConfiguration}};
} else {
$existingRequestConfig = $self->addRequestConfigurations($requestType, [ $params->{requestConfiguration} ]);
$params->{requestConfigurationId} = $existingRequestConfig->{$requestTypeId}{$params->{requestConfiguration}};
}
_getOrCreateRequestConfiguration: Implement. Implementation of this method.
2015-12-20 19:20:16 +00:00
} else {
my $id = $params->{requestConfigurationId};
die "_getOrCreateRequestConfiguration(): called with a non-numeric requestConfigurationId, \"$id\""
unless defined $id and looks_like_number($id);
_getOrCreateRequestConfiguration: Fix various bugs There was some parameter confusion (using ids instead of the actual types/descriptions) on some of the public facing methods. Also, lookup of existing ids was buggy; just use public facing methods.
2015-12-20 20:10:27 +00:00
my $found = 0;
foreach my $foundId (values %{$existingRequestConfig->{$requestTypeId}}) { if ($foundId == $id) { $found = 1; last; } }
_getOrCreateRequestConfiguration: Implement. Implementation of this method.
2015-12-20 19:20:16 +00:00
die "_getOrCreateRequestType(): given requestConfigurationId, \"$id\", is invalid"
_getOrCreateRequestConfiguration: Fix various bugs There was some parameter confusion (using ids instead of the actual types/descriptions) on some of the public facing methods. Also, lookup of existing ids was buggy; just use public facing methods.
2015-12-20 20:10:27 +00:00
unless defined $found;
_getOrCreateRequestConfiguration: Implement. Implementation of this method.
2015-12-20 19:20:16 +00:00
}
delete $params->{requestConfiguration};
return $params->{requestConfigurationId};
_getOrCreateRequestConfiguration: error conditions These tests now pass: ok 110 - _getOrCreateRequestConfiguration: dies on empty hash ok 111 - _getOrCreateRequestConfiguration: dies for string requestConfigurationId ok 112 - _getOrCreateRequestConfiguration: dies for non-existant requestConfigurationId ok 113 - _getOrCreateRequestConfiguration: dies for string request id ok 114 - _getOrCreateRequestConfiguration: dies for non-existant requestTypeId
2015-12-20 19:11:42 +00:00
}
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
=item _beginWork()
Parameters:
=over
=item $self: current object.
=back
Returns: None.
This method is a reference counter to keep track of nested begin_work()/commit().
=cut
sub _beginWork($) {
my($self) = @_;
transaction counter is per instance. The older transaction counter was for the whole class, which was problematic if you had more than one supporter database open at a time, or were otherwise using different supporter databases. I'm not completely sure this fix is fully functional, because perhaps we should be carrying this counter along with the DBH (i.e., what if two Supporter instances are created with the same dbh). I suppose we could fix this problem by changing the new() interface to require the instance itself be in control of the dbh.
2015-12-20 20:21:38 +00:00
if ($self->{__NESTED_TRANSACTION_COUNTER__} < 0) {
Rework the reference counter for begin_work/commit This code was clearly not correct as it was. The main problem is that I was envisioning begin_work/commit pairs as always matched, but of course if we die in the middle of a transaction, the counter has to be reset. That's why we have to set the $dbh->{HandleError} in new() to a subroutine that does that. Also, we need to similarly wrap rollback() calls. When rolling back, we have to reset the counter as we're not going to commit() (that's the point).
2015-12-17 03:57:59 +00:00
die "_beginWork: Mismatched begin_work/commit pair in API implementation";
transaction counter is per instance. The older transaction counter was for the whole class, which was problematic if you had more than one supporter database open at a time, or were otherwise using different supporter databases. I'm not completely sure this fix is fully functional, because perhaps we should be carrying this counter along with the DBH (i.e., what if two Supporter instances are created with the same dbh). I suppose we could fix this problem by changing the new() interface to require the instance itself be in control of the dbh.
2015-12-20 20:21:38 +00:00
$self->{__NESTED_TRANSACTION_COUNTER__} = 0;
Rework the reference counter for begin_work/commit This code was clearly not correct as it was. The main problem is that I was envisioning begin_work/commit pairs as always matched, but of course if we die in the middle of a transaction, the counter has to be reset. That's why we have to set the $dbh->{HandleError} in new() to a subroutine that does that. Also, we need to similarly wrap rollback() calls. When rolling back, we have to reset the counter as we're not going to commit() (that's the point).
2015-12-17 03:57:59 +00:00
}
transaction counter is per instance. The older transaction counter was for the whole class, which was problematic if you had more than one supporter database open at a time, or were otherwise using different supporter databases. I'm not completely sure this fix is fully functional, because perhaps we should be carrying this counter along with the DBH (i.e., what if two Supporter instances are created with the same dbh). I suppose we could fix this problem by changing the new() interface to require the instance itself be in control of the dbh.
2015-12-20 20:21:38 +00:00
$self->dbh->begin_work() if ($self->{__NESTED_TRANSACTION_COUNTER__}++ == 0);
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
}
=item _commit()
Parameters:
=over
=item $self: current object.
=back
Returns: None.
This method is a reference counter to keep track of nested begin_work()
transactions to verify we don't nest $self->dbh->begin_work()
=cut
sub _commit($) {
my($self) = @_;
transaction counter is per instance. The older transaction counter was for the whole class, which was problematic if you had more than one supporter database open at a time, or were otherwise using different supporter databases. I'm not completely sure this fix is fully functional, because perhaps we should be carrying this counter along with the DBH (i.e., what if two Supporter instances are created with the same dbh). I suppose we could fix this problem by changing the new() interface to require the instance itself be in control of the dbh.
2015-12-20 20:21:38 +00:00
if ($self->{__NESTED_TRANSACTION_COUNTER__} < 0) {
Rework the reference counter for begin_work/commit This code was clearly not correct as it was. The main problem is that I was envisioning begin_work/commit pairs as always matched, but of course if we die in the middle of a transaction, the counter has to be reset. That's why we have to set the $dbh->{HandleError} in new() to a subroutine that does that. Also, we need to similarly wrap rollback() calls. When rolling back, we have to reset the counter as we're not going to commit() (that's the point).
2015-12-17 03:57:59 +00:00
die "_commit: Mismatched begin_work/commit pair in API implementation";
transaction counter is per instance. The older transaction counter was for the whole class, which was problematic if you had more than one supporter database open at a time, or were otherwise using different supporter databases. I'm not completely sure this fix is fully functional, because perhaps we should be carrying this counter along with the DBH (i.e., what if two Supporter instances are created with the same dbh). I suppose we could fix this problem by changing the new() interface to require the instance itself be in control of the dbh.
2015-12-20 20:21:38 +00:00
$self->{__NESTED_TRANSACTION_COUNTER__} = 0;
Rework the reference counter for begin_work/commit This code was clearly not correct as it was. The main problem is that I was envisioning begin_work/commit pairs as always matched, but of course if we die in the middle of a transaction, the counter has to be reset. That's why we have to set the $dbh->{HandleError} in new() to a subroutine that does that. Also, we need to similarly wrap rollback() calls. When rolling back, we have to reset the counter as we're not going to commit() (that's the point).
2015-12-17 03:57:59 +00:00
}
transaction counter is per instance. The older transaction counter was for the whole class, which was problematic if you had more than one supporter database open at a time, or were otherwise using different supporter databases. I'm not completely sure this fix is fully functional, because perhaps we should be carrying this counter along with the DBH (i.e., what if two Supporter instances are created with the same dbh). I suppose we could fix this problem by changing the new() interface to require the instance itself be in control of the dbh.
2015-12-20 20:21:38 +00:00
$self->dbh->commit() if (--$self->{__NESTED_TRANSACTION_COUNTER__} == 0);
Rework the reference counter for begin_work/commit This code was clearly not correct as it was. The main problem is that I was envisioning begin_work/commit pairs as always matched, but of course if we die in the middle of a transaction, the counter has to be reset. That's why we have to set the $dbh->{HandleError} in new() to a subroutine that does that. Also, we need to similarly wrap rollback() calls. When rolling back, we have to reset the counter as we're not going to commit() (that's the point).
2015-12-17 03:57:59 +00:00
}
=item _rollback()
Parameters:
=over
=item $self: current object.
=back
Returns: None.
This method resets the reference counter entirely and calls $dbh->rollback.
=cut
sub _rollback($) {
my($self) = @_;
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
transaction counter is per instance. The older transaction counter was for the whole class, which was problematic if you had more than one supporter database open at a time, or were otherwise using different supporter databases. I'm not completely sure this fix is fully functional, because perhaps we should be carrying this counter along with the DBH (i.e., what if two Supporter instances are created with the same dbh). I suppose we could fix this problem by changing the new() interface to require the instance itself be in control of the dbh.
2015-12-20 20:21:38 +00:00
$self->{__NESTED_TRANSACTION_COUNTER__} = 0;
Rework the reference counter for begin_work/commit This code was clearly not correct as it was. The main problem is that I was envisioning begin_work/commit pairs as always matched, but of course if we die in the middle of a transaction, the counter has to be reset. That's why we have to set the $dbh->{HandleError} in new() to a subroutine that does that. Also, we need to similarly wrap rollback() calls. When rolling back, we have to reset the counter as we're not going to commit() (that's the point).
2015-12-17 03:57:59 +00:00
$self->dbh->rollback();
Wrap dbh->begin_work & dbh->commit I want to be able to nest begin_work()/commit() calls. Years ago (in the mid-1990s), when I did database programming, this is how we handled this scenario. I have no idea if there is now a "better way" to do this, but some quick net searches found nothing that is recommended, but I admittedly didn't search that hard. This should work for our needs.
2015-12-15 01:16:35 +00:00
}
_verifyId method: initial implementation. Internal method for use to verify that an id we have really is in the database. For use before other operations.
2015-12-10 02:38:07 +00:00
=back
=cut
Generated stubs for Supporters module. Generated this by running: h2xs -AXc -n Supporters
2015-12-07 01:20:14 +00:00
1;
__END__
=head1 NAME
Wrote basic documentation.
2015-12-07 01:27:13 +00:00
Supporters - Simple database of supporters of an organation.
Generated stubs for Supporters module. Generated this by running: h2xs -AXc -n Supporters
2015-12-07 01:20:14 +00:00
=head1 SYNOPSIS
use Supporters;
=head1 DESCRIPTION
Wrote basic documentation.
2015-12-07 01:27:13 +00:00
Supporters is an extremely lightweight alternative to larger systems like
CiviCRM to manage a database of Supporters. The module assumes a setup that
works with Ledger-CLI to find the actual amounts donated.
Generated stubs for Supporters module. Generated this by running: h2xs -AXc -n Supporters
2015-12-07 01:20:14 +00:00
=head2 EXPORT
None by default.
=head1 AUTHOR
Wrote basic documentation.
2015-12-07 01:27:13 +00:00
Bradley M. Kuhn, E<lt>bkuhn@ebb.org<gt>
Generated stubs for Supporters module. Generated this by running: h2xs -AXc -n Supporters
2015-12-07 01:20:14 +00:00
=head1 COPYRIGHT AND LICENSE
Wrote basic documentation.
2015-12-07 01:27:13 +00:00
See COPYRIGHT.md and LICENSE.md in the main distribution of this software.
Generated stubs for Supporters module. Generated this by running: h2xs -AXc -n Supporters
2015-12-07 01:20:14 +00:00
Wrote basic documentation.
2015-12-07 01:27:13 +00:00
License: AGPLv3-or-later
Generated stubs for Supporters module. Generated this by running: h2xs -AXc -n Supporters
2015-12-07 01:20:14 +00:00
=cut
Add local variables for Emacs.
2015-12-10 02:36:57 +00:00
###############################################################################
#
# Local variables:
# compile-command: "perl -c Supporters.pm"
# End:
Reference in a new issue Copy permalink