IS cannot support UTF-8 properly
[Business-OnlinePayment-InternetSecure.git] / InternetSecure.pm
index 1442894..0029e91 100755 (executable)
@@ -18,8 +18,9 @@ our $VERSION = '0.01';
 use constant CARD_TYPES => {
                                VI => 'Visa',
                                MC => 'MasterCard',
-                               AX => 'American Express',
+                               AX => 'American Express', # FIXME: AM?
                                NN => 'Discover',
+                               # JB?
                        };
 
 
@@ -36,13 +37,26 @@ sub set_defaults {
        $self->path('/process.cgi');
 
        $self->build_subs(qw(
-                               receipt_number  sales_order_number
-                               cardholder      card_type
+                               receipt_number  sales_number
+                               date
+                               card_type
                                total_amount
                                avs_response    cvv2_response
                        ));
 }
 
+# OnlinePayment's get_fields now filters out undefs in 3.x. :(
+#
+sub get_fields {
+       my ($self, @fields) = @_;
+
+       my %content = $self->content;
+
+       my %new = map +($_ => $content{$_}), @fields;
+
+       return %new;
+}
+
 # OnlinePayment's remap_fields is buggy, so we simply rewrite it
 #
 sub remap_fields {
@@ -63,10 +77,6 @@ sub get_remap_fields {
        $self->remap_fields(reverse %map);
        my %data = $self->get_fields(keys %map);
 
-       foreach (values %data) {
-               $_ = '' unless defined;
-       }
-
        return %data;
 }
 
@@ -99,14 +109,13 @@ sub parse_expdate {
 # Convert a single product into a product string
 #
 sub prod_string {
-       my ($self, $currency, $taxes, %data) = @_;
+       my ($self, $currency, %data) = @_;
 
        croak "Missing amount in product" unless defined $data{amount};
 
        my @flags = ($currency);
 
-       $taxes = uc $data{taxes} if defined $data{taxes};
-       foreach (split ' ' => $taxes) {
+       foreach (split ' ' => uc($data{taxes} || '')) {
                croak "Unknown tax code $_" unless /^(GST|PST|HST)$/;
                push @flags, $_;
        }
@@ -140,16 +149,14 @@ sub to_xml {
        croak 'Unsupported action'
                unless $content{action} =~ /^Normal Authori[zs]ation$/i;
        
-       $content{currency} ||= 'CAD';
-       $content{currency} = uc $content{currency};
+       $content{currency} = uc($content{currency} || 'CAD');
        croak "Unknown currency code ", $content{currency}
                unless $content{currency} =~ /^(CAD|USD)$/;
        
-       $content{taxes} ||= '';
-       $content{taxes} = uc $content{taxes};
+       $content{taxes} = uc($content{taxes} || '');
 
        my %data = $self->get_remap_fields(qw(
-                       xxxCardNumber           card_number
+                       xxxCard_Number          card_number
 
                        xxxName                 name
                        xxxCompany              company
@@ -174,7 +181,8 @@ sub to_xml {
        
        $data{MerchantNumber} = $self->merchant_id;
 
-       $data{xxxCardNumber} =~ tr/ //d;
+       $data{xxxCard_Number} =~ tr/ //d;
+       $data{xxxCard_Number} =~ s/^[^3-6]/4/ if $self->test_transaction;
 
        my ($y, $m) = $self->parse_expdate($content{exp_date});
        $data{xxxCCYear} = sprintf '%.4u' => $y;
@@ -190,24 +198,26 @@ sub to_xml {
        
        if (ref $content{description}) {
                $data{Products} = join '|' => map $self->prod_string(
-                                                       $content{currency},
-                                                       $content{taxes},
-                                                       %$_),
-                                               @{ $content{description} };
+                                               $content{currency},
+                                               taxes => $content{taxes},
+                                               %$_),
+                                       @{ $content{description} };
        } else {
                $self->required_fields(qw(amount));
                $data{Products} = $self->prod_string(
                                        $content{currency},
-                                       $content{taxes},
-                                       amount => $content{amount},
+                                       taxes       => $content{taxes},
+                                       amount      => $content{amount},
                                        description => $content{description},
                                );
        }
 
        xml_out(\%data,
-               NoAttr => 1,
-               RootName => 'TranxRequest',
-               XMLDecl => '<?xml version="1.0" encoding="utf-8" standalone="yes"?>',
+               NoAttr          => 1,
+               NumericEscape   => 2,
+               RootName        => 'TranxRequest',
+               SuppressEmpty   => undef,
+               XMLDecl         => '<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>',
        );
 }
 
@@ -229,6 +239,8 @@ sub parse_response {
        my ($self, $response) = @_;
 
        $self->server_response($response);
+
+       local $/ = "\n";  # Make sure to avoid bug #17687
        
        $response = xml_in($response,
                        ForceArray => [qw(product flag)],
@@ -242,8 +254,8 @@ sub parse_response {
 
        $self->infuse($response, qw(
                        ReceiptNumber           receipt_number
-                       SalesOrderNumber        sales_order_number
-                       xxxName                 cardholder
+                       SalesOrderNumber        sales_number
+                       Date                    date
                        CardType                card_type
                        Page                    result_code
                        ApprovalCode            authorization
@@ -253,6 +265,9 @@ sub parse_response {
                        CVV2ResponseCode        cvv2_response
                ));
        
+       # Completely undocumented field that sometimes override <Verbiage>
+       $self->error_message($response->{Error}) if $response->{Error};
+       
        $self->card_type(CARD_TYPES->{$self->card_type});
        
        $self->{products_raw} = $response->{Products};
@@ -274,15 +289,16 @@ sub submit {
                                undef,
                                make_form(
                                        xxxRequestMode => 'X',
-                                       xxxRequestData => Encode::encode_utf8(
-                                                               $self->to_xml
-                                                         ),
+                                       xxxRequestData => $self->to_xml,
                                )
                        );
 
        croak 'Error connecting to server' unless $page;
        croak 'Server responded, but not in XML' unless $page =~ /^<\?xml/;
 
+       # The response is marked UTF-8, but it's really Latin-1.  Sigh.
+       $page =~ s/^(<\?xml.*?) encoding="utf-8"/$1 encoding="iso-8859-1"/si;
+
        $self->parse_response($page);
 }
 
@@ -339,7 +355,7 @@ Business::OnlinePayment::InternetSecure - InternetSecure backend for Business::O
 
 Business::OnlinePayment::InternetSecure is an implementation of
 L<Business::OnlinePayment> that allows for processing online credit card
-payments through Internet Secure.
+payments through InternetSecure.
 
 See L<Business::OnlinePayment> for more information about the generic
 Business::OnlinePayment interface.
@@ -348,11 +364,12 @@ Business::OnlinePayment interface.
 
 Object creation is done via L<Business::OnlinePayment>; see its manpage for
 details.  The I<merchant_id> processor option is required, and corresponds
-to the merchant ID assigned to you by Internet Secure.
+to the merchant ID assigned to you by InternetSecure.
 
 =head1 METHODS
 
-(See L<Business::OnlinePayment> for more methods.)
+(Other methods are also available -- see L<Business::OnlinePayment> for more
+details.)
 
 =head2 Before order submission
 
@@ -415,12 +432,14 @@ Code (CVC2) or Card Identification number (CID), depending on the card issuer.
 A short description of the purchase.  See L<"Products list syntax"> for
 an alternate syntax that allows a list of products to be specified.
 
-=item amount
+=item amount (usually required)
+
+Total amount to be billed, excluding taxes if they are to be added separately
+by InternetSecure.
 
-Total amount to be billed, excluding taxes if they are to be added separately.
-This field is required if B<description> is a string, and should be left
-undefined if B<description> contains a list of products, as outlined in
-L<"Products list syntax">.
+This field is required if B<description> is a string, but should be left
+undefined if B<description> contains a list of products instead, as outlined
+in L<"Products list syntax">.
 
 =item currency
 
@@ -429,17 +448,15 @@ C<CAD> (default) or C<USD>.
 
 =item taxes
 
-Taxes to be added automatically.  These should not be included in B<amount>;
-they will be automatically added by Internet Secure later on.
+Taxes to be added automatically to B<amount> by InternetSecure.
 
-Available taxes are C<GST>, C<PST> and C<HST>.  Taxes can be combined by
-separating them with spaces, such as C<GST 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>.
 
 =item name / company / address / city / state / zip / country / phone / email
 
-Facultative customer information.  B<state> should be either a postal
-abbreviation or a two-letter code taken from ISO 3166-2, and B<country> should
-be a two-letter code taken from ISO 3166-1.
+Customer information.  B<Country> should be a two-letter code taken from ISO
+3166-1.
 
 =back
 
@@ -449,18 +466,23 @@ be a two-letter code taken from ISO 3166-1.
 
 =over 4
 
-=item receipt_number() / sales_order_number()
+=item receipt_number()
 
-Receipt number and sales order number of submitted order.
+Receipt number of this transaction; this is actually a string, unique to all
+InternetSecure transactions.
 
-=item total_amount()
+=item sales_number()
 
-Total amount billed for this order, including taxes.
+Sales order number of this transaction.  This is a number, unique to each
+merchant, which is incremented by 1 each time.
 
-=item cardholder()
+=item date()
 
-Cardholder's name.  This is currently a mere copy of the B<name> field passed
-to B<submit()>.
+Date and time of the transaction.  Format is C<YYYY/MM/DD hh:mm:ss>.
+
+=item total_amount()
+
+Total amount billed for this order, including taxes.
 
 =item card_type()
 
@@ -481,9 +503,14 @@ following:
 
 =item avs_response() / cvv2_response()
 
-Results of the AVS and CVV2 checks.  See the Internet Secure documentation for
+Results of the AVS and CVV2 checks.  See the InternetSecure documentation for
 the list of possible values.
 
+=item products_raw()
+
+...
+
+
 =back
 
 
@@ -504,7 +531,7 @@ Unit price of this product.
 
 =item quantity
 
-Ordered quantity of this product.  This can be a decimal value.
+Ordered quantity of this product.
 
 =item sku
 
@@ -525,14 +552,17 @@ When using a products list, the B<amount> field passed to B<content()> should
 be left undefined.
 
 
-=head2 Character encodings
+=head2 Character encoding
 
-...
+Since communication to/from InternetSecure is encoded with UTF-8, all Unicode
+characters are theoretically available when submitting information via
+B<submit()>.  (Further restrictions may be imposed by InternetSecure itself.)
 
-
-=head2 products_raw
-
-...
+When using non-ASCII characters, all data provided to B<submit()> should either
+be in the current native encoding (typically latin-1, unless it was modified
+via the C<encoding> pragma), or be decoded via the C<Encode> module.
+Conversely, all data returned after calling B<submit()> will be automatically
+decoded.
 
 
 =head1 EXPORT
@@ -546,11 +576,11 @@ L<Business::OnlinePayment>
 
 =head1 AUTHOR
 
-Frederic Briere, E<lt>fbriere@fbriere.netE<gt>
+Frédéric Brière, E<lt>fbriere@fbriere.netE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright (C) 2006 by Frederic Briere
+Copyright (C) 2006 by Frédéric Brière
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself, either Perl version 5.8.4 or,