X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=InternetSecure.pm;h=0029e9161d9cb28fd72a888894e9c490170ebb3b;hb=7f30025e73ae69403e8fe0ffd922f5bb4feada11;hp=360b95b4a6f6c86fe6216cbba3b7c4e1b7c54484;hpb=d06a54072be6039a5104e63ff41b3b2c20a04840;p=Business-OnlinePayment-InternetSecure.git diff --git a/InternetSecure.pm b/InternetSecure.pm index 360b95b..0029e91 100755 --- a/InternetSecure.pm +++ b/InternetSecure.pm @@ -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 => '', + NoAttr => 1, + NumericEscape => 2, + RootName => 'TranxRequest', + SuppressEmpty => undef, + XMLDecl => '', ); } @@ -229,10 +239,9 @@ sub parse_response { my ($self, $response) = @_; $self->server_response($response); - - # (It's not quite clear whether there should be some decoding, or if - # the result is already utf8.) + local $/ = "\n"; # Make sure to avoid bug #17687 + $response = xml_in($response, ForceArray => [qw(product flag)], GroupTags => { qw(Products product flags flag) }, @@ -245,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 @@ -256,6 +265,9 @@ sub parse_response { CVV2ResponseCode cvv2_response )); + # Completely undocumented field that sometimes override + $self->error_message($response->{Error}) if $response->{Error}; + $self->card_type(CARD_TYPES->{$self->card_type}); $self->{products_raw} = $response->{Products}; @@ -277,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); } @@ -342,7 +355,7 @@ Business::OnlinePayment::InternetSecure - InternetSecure backend for Business::O Business::OnlinePayment::InternetSecure is an implementation of L that allows for processing online credit card -payments through Internet Secure. +payments through InternetSecure. See L for more information about the generic Business::OnlinePayment interface. @@ -351,11 +364,12 @@ Business::OnlinePayment interface. Object creation is done via L; see its manpage for details. The I 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 for more methods.) +(Other methods are also available -- see L for more +details.) =head2 Before order submission @@ -394,54 +408,55 @@ Transaction type, being one of the following: =item card_number (required) -Credit card number. Any spaces will be removed. +Credit card number. Spaces are allowed, and will be automatically removed. =item exp_date (required) -Credit card expiration date. Since L does not -specify any syntax, this module is rather lax in what it will accept. It is -recommended to use either I or I, to avoid any nasty -surprises. +Credit card expiration date. Since L does not specify +any syntax, this module is rather lax regarding what it will accept. The +recommended syntax is I, but forms such as I or I are +allowed as well. =item cvv2 Three- or four-digit verification code printed on the card. This can be left blank or undefined, in which case no check will be performed. Whether or not a -transaction will be declined in case of a mismatch depends on the merchant. +transaction will be declined in case of a mismatch depends on the merchant +account configuration. This number may be called Card Verification Value (CVV2), Card Validation -Code (CVC2) or Card Identification number (CID). +Code (CVC2) or Card Identification number (CID), depending on the card issuer. =item description 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 is a string, and should be left -undefined if B contains a list of products, as outlined in -L<"Products list syntax">. +This field is required if B is a string, but should be left +undefined if B contains a list of products instead, as outlined +in L<"Products list syntax">. =item currency Currency of all amounts for this order. This can currently be either -C (default) or C. +C (default) or C. =item taxes -Taxes to be added automatically. These should not be included in B; -they will be added by Internet Secure later on. +Taxes to be added automatically to B by InternetSecure. -Available taxes are C, C and C; multiple taxes must be -separated by spaces. +Available taxes are C, C and C. Multiple taxes can specified +by concatenating them with spaces, such as C. =item name / company / address / city / state / zip / country / phone / email -Facultative customer information. B should be either a postal -abbreviation or a two-letter code taken from ISO 3166-2, and B should -be a two-letter code taken from in ISO 3166-1. +Customer information. B should be a two-letter code taken from ISO +3166-1. =back @@ -451,18 +466,23 @@ be a two-letter code taken from in 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 field passed -to B. +Date and time of the transaction. Format is C. + +=item total_amount() + +Total amount billed for this order, including taxes. =item card_type() @@ -483,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 @@ -506,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 @@ -527,14 +552,17 @@ When using a products list, the B field passed to B 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. (Further restrictions may be imposed by InternetSecure itself.) - -=head2 products_raw - -... +When using non-ASCII characters, all data provided to B should either +be in the current native encoding (typically latin-1, unless it was modified +via the C pragma), or be decoded via the C module. +Conversely, all data returned after calling B will be automatically +decoded. =head1 EXPORT @@ -548,11 +576,11 @@ L =head1 AUTHOR -Frederic Briere, Efbriere@fbriere.netE +Frédéric Brière, Efbriere@fbriere.netE =head1 COPYRIGHT AND LICENSE -Copyright (C) 2004 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,