Rename taxes() to tax_amounts()

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

diff --git a/InternetSecure.pm b/InternetSecure.pm
index e3a21e5..cb6d00e 100755 (executable)
--- a/InternetSecure.pm
+++ b/InternetSecure.pm
@@ -15,6 +15,8 @@ use base qw(Business::OnlinePayment Exporter);
 our $VERSION = '0.01';
 
 
+use constant SUCCESS_CODES => qw(2000 90000 900P1);
+
 use constant CARD_TYPES => {
                                VI => 'Visa',
                                MC => 'MasterCard',
@@ -40,9 +42,12 @@ sub set_defaults {
                                receipt_number  sales_number    uuid    guid
                                date
                                card_type       cardholder
-                               total_amount
+                               total_amount    tax_amounts
                                avs_response    cvv2_response
                        ));
+       
+       # 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. :(
@@ -103,9 +108,16 @@ sub prod_string {
 
        my @flags = ($currency);
 
-       foreach (split ' ' => uc($data{taxes} || '')) {
-               croak "Unknown tax code $_" unless /^(GST|PST|HST)$/;
-               push @flags, $_;
+       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 $_;
        }
 
        if ($self->test_transaction) {
@@ -141,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
 
@@ -221,6 +231,27 @@ sub infuse {
        }
 }
 
+sub extract_tax_amounts {
+       my ($self, $response) = @_;
+
+       my %tax_amounts;
+
+       my $products = $response->{Products};
+       return unless $products;
+
+       foreach my $node (@$products) {
+               my $flags = $node->{flags};
+               if ($flags &&
+                       grep($_ eq '{TAX}', @$flags) &&
+                       grep($_ eq '{CALCULATED}', @$flags))
+               {
+                       $tax_amounts{ $node->{code} } = $node->{subtotal};
+               }
+       }
+
+       return %tax_amounts;
+}
+
 # Parse the server's response and set various fields
 #
 sub parse_response {
@@ -237,9 +268,6 @@ sub parse_response {
                        SuppressEmpty => undef,
                );
        
-       my $code = $self->result_code($response->{Page});
-       $self->is_success($code eq '2000' || $code eq '90000' || $code eq '900P1');
-
        $self->infuse($response,
                        result_code     => 'Page',
                        error_message   => 'Verbiage',
@@ -258,12 +286,17 @@ sub parse_response {
                        total_amount    => 'TotalAmount',
                        );
        
+       $self->is_success(scalar grep $self->result_code eq $_, SUCCESS_CODES);
+
        # Completely undocumented field that sometimes override <Verbiage>
        $self->error_message($response->{Error}) if $response->{Error};
+
+       # Delete error_message if transaction was successful
+       $self->error_message(undef) if $self->is_success;
        
        $self->card_type(CARD_TYPES->{$self->card_type});
        
-       $self->{products_raw} = $response->{Products};
+       $self->tax_amounts( { $self->extract_tax_amounts($response) } );
 
        return $self;
 }
@@ -437,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
 
@@ -469,9 +504,9 @@ Response code returned by InternetSecure.
 
 =item error_message()
 
-Text description of the response code.  (Do not rely on this to check for
-errors, as a description will also be returned for successful transactions.
-Use B<is_success>() instead.)
+Error message if the transaction was unsuccessful; C<undef> otherwise.  (You
+should not rely on this to test whether a transaction was successful; use
+B<is_success>() instead.)
 
 =item receipt_number()
 
@@ -509,6 +544,12 @@ Date and time of the transaction.  Format is C<YYYY/MM/DD hh:mm:ss>.
 
 Total amount billed for this order, including taxes.
 
+=item tax_amounts()
+
+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()
 
 Cardholder's name.  This is currently a mere copy of the B<name> field passed
@@ -531,10 +572,6 @@ following:
 
 =back
 
-=item products_raw()
-
-...
-
 
 =back