Rename taxes() to tax_amounts()

[Business-OnlinePayment-InternetSecure.git] / InternetSecure.pm

diff --git a/InternetSecure.pm b/InternetSecure.pm
index 9aa2d8d..cb6d00e 100755 (executable)
--- a/InternetSecure.pm
+++ b/InternetSecure.pm
@@ -42,12 +42,12 @@ sub set_defaults {
                                receipt_number  sales_number    uuid    guid
                                date
                                card_type       cardholder
-                               total_amount    taxes
+                               total_amount    tax_amounts
                                avs_response    cvv2_response
                        ));
        
-       # Just in case someone tries to call taxes() *before* submit()
-       $self->taxes( {} );
+       # Just in case someone tries to call tax_amounts() *before* submit()
+       $self->tax_amounts( {} );
 }
 
 # OnlinePayment's get_fields now filters out undefs in 3.x. :(
@@ -108,9 +108,14 @@ sub prod_string {
 
        my @flags = ($currency);
 
-       foreach (ref $data{taxes} ?
-                       @{ $data{taxes} } :
-                       split(' ' => $data{taxes} || '')) {
+       my @taxes;
+       if (ref $data{taxes}) {
+               @taxes = @{ $data{taxes} };
+       } elsif ($data{taxes}) {
+               @taxes = split ' ' => $data{taxes};
+       }
+
+       foreach (@taxes) {
                croak "Unknown tax code $_" unless /^(GST|PST|HST)$/i;
                push @flags, uc $_;
        }
@@ -148,8 +153,6 @@ sub to_xml {
        croak "Unknown currency code ", $content{currency}
                unless $content{currency} =~ /^(CAD|USD)$/;
        
-       $content{taxes} = uc($content{taxes} || '');
-
        my %data = $self->get_remap_fields(qw(
                        xxxCard_Number          card_number
 
@@ -228,10 +231,10 @@ sub infuse {
        }
 }
 
-sub extract_taxes {
+sub extract_tax_amounts {
        my ($self, $response) = @_;
 
-       my %taxes;
+       my %tax_amounts;
 
        my $products = $response->{Products};
        return unless $products;
@@ -242,11 +245,11 @@ sub extract_taxes {
                        grep($_ eq '{TAX}', @$flags) &&
                        grep($_ eq '{CALCULATED}', @$flags))
                {
-                       $taxes{ $node->{code} } = $node->{subtotal};
+                       $tax_amounts{ $node->{code} } = $node->{subtotal};
                }
        }
 
-       return %taxes;
+       return %tax_amounts;
 }
 
 # Parse the server's response and set various fields
@@ -293,7 +296,7 @@ sub parse_response {
        
        $self->card_type(CARD_TYPES->{$self->card_type});
        
-       $self->taxes( { $self->extract_taxes($response) } );
+       $self->tax_amounts( { $self->extract_tax_amounts($response) } );
 
        return $self;
 }
@@ -467,10 +470,12 @@ C<CAD> (default) or C<USD>.
 
 =item taxes
 
-Taxes to be added automatically to B<amount> by InternetSecure.
+Taxes to be added automatically to B<amount> by InternetSecure.  Available
+taxes are C<GST>, C<PST> and C<HST>.
 
-Available taxes are C<GST>, C<PST> and C<HST>.  Multiple taxes can specified
-by concatenating them with spaces, such as C<GST HST>.
+This argument can either be a single string of taxes concatenated with spaces
+(such as C<GST PST>), or a reference to an array of taxes (such as C<[ "GST",
+"PST" ]>).
 
 =item name / company / address / city / state / zip / country / phone / email
 
@@ -539,10 +544,11 @@ Date and time of the transaction.  Format is C<YYYY/MM/DD hh:mm:ss>.
 
 Total amount billed for this order, including taxes.
 
-=item taxes()
+=item tax_amounts()
 
-Returns a I<reference> to a hash that maps tax names (such as C<GST>) to the
-amount that was billed for each.
+Returns a I<reference> to a hash that maps taxes, which were listed under the
+B<taxes> argument to B<submit>(), to the amount that was calculated by
+InternetSecure.
 
 =item cardholder()