doc: list a bunch of previously undocumented fields
[Business-OnlinePayment.git] / OnlinePayment.pm
index 7c7287c..1d579f2 100644 (file)
@@ -3,13 +3,15 @@ package Business::OnlinePayment;
 use strict;
 use vars qw($VERSION);
 use Carp;
-use Symbol;
 
 require 5.005;
 
-$VERSION = '3.00_04';
+$VERSION = '3.00_06';
 $VERSION = eval $VERSION; # modperlstyle: convert the string into a number
 
+# Remember subclasses we have "wrapped" submit() with _pre_submit()
+my %Presubmit_Added = ();
+
 my %fields = (
     authorization    => undef,
     error_message    => undef,
@@ -27,7 +29,6 @@ my %fields = (
     transaction_type => undef,
 );
 
-
 sub new {
     my($class,$processor,%data) = @_;
 
@@ -54,16 +55,18 @@ sub new {
         $self->$key($value);
     }
 
-    unless ( $subclass->can('submit') eq $class->can('submit') ) {
-        no strict 'refs';
-        no warnings 'redefine';
-        my $submit = qualify_to_ref('submit', $subclass);
+    # "wrap" submit with _pre_submit only once
+    unless ( $Presubmit_Added{$subclass} ) {
+        my $real_submit = $subclass->can('submit');
 
-        $self->{_child_submit} = \&$submit;
-        *{"${subclass}::submit"} = sub {
-            my $self = shift;
-            $self->_pre_submit();
-        }
+       no warnings 'redefine';
+       no strict 'refs';
+
+       *{"${subclass}::submit"} = sub {
+           my $self = shift;
+           return unless $self->_pre_submit(@_);
+           return $real_submit->($self, @_);
+       }
     }
 
     return $self;
@@ -78,33 +81,34 @@ sub _risk_detect {
     $risk_transaction->submit();
     if ($risk_transaction->is_success()) {
        if ( $risk_transaction->fraud_score <= $self->maximum_fraud_score()) {
-           $self->{_child_submit}->($self);
+           return 1;
        } else {
-           $self->is_success(0);
            $self->error_message('Excessive risk from risk management');
        }
     } else {
        $self->error_message('Error in risk detection stage: ' .  $risk_transaction->error_message);
-       $self->is_success(0);
     }
+    $self->is_success(0);
+    return 0;
 }
 
-sub _pre_submit{
+my @Fraud_Class_Path = qw(Business::OnlinePayment Business::FraudDetect);
+
+sub _pre_submit {
     my ($self) = @_;
     my $fraud_detection = $self->fraud_detect();
 
     # early return if user does not want optional risk mgt
-    return $self->{_child_submit}->($self,@_) unless $fraud_detection && length $fraud_detection;
+    return 1 unless $fraud_detection;
 
     # Search for an appropriate FD module
-    foreach my $subclass ( q(Business::OnlinePayment::) . $fraud_detection,
-                          q(Business::FraudDetect::) . $fraud_detection) {
-
+    foreach my $fraud_class ( @Fraud_Class_Path ) {
+       my $subclass = $fraud_class . "::" . $fraud_detection;
        if (!defined(&$subclass)) {
-           eval "use $subclass";
+           eval "use $subclass ()";
            if ($@) {
-               Carp::croak("serious problem loading fraud_detection module ($@)") unless
-                   $@ =~ m/^Can\'t locate/;
+               Carp::croak("error loading fraud_detection module ($@)")
+                     unless ( $@ =~ m/^Can\'t locate/ );
            } else {
                my $risk_tx = bless ( { processor => $fraud_detection } , $subclass );
                $risk_tx->build_subs(keys %fields);
@@ -116,7 +120,10 @@ sub _pre_submit{
            }
        }
     }
-};
+    Carp::croak("Unable to locate fraud_detection module $fraud_detection"
+               . " in \@INC under Fraud_Class_Path (\@Fraud_Class_Path"
+               . " contains: @Fraud_Class_Path) (\@INC contains: @INC)");
+}
 
 sub content {
     my($self,%params) = @_;
@@ -213,9 +220,9 @@ Business::OnlinePayment - Perl extension for online payment processing
   $transaction->submit();
   
   if($transaction->is_success()) {
-    print "Card processed successfully: ".$transaction->authorization()."\n";
+    print "Card processed successfully: ", $transaction->authorization(), "\n";
   } else {
-    print "Card was rejected: ".$transaction->error_message()."\n";
+    print "Card was rejected: ", $transaction->error_message(), "\n";
   }
 
 =head1 DESCRIPTION
@@ -243,13 +250,9 @@ little depending on the processor, so we have chosen to use a system
 which defines specific fields in the frontend which get mapped to the
 correct fields in the backend.  The currently defined fields are:
 
-=over 4
-
-=item * type
+=head3 PROCESSOR FIELDS
 
-Transaction type, supported types are:
-Visa, MasterCard, American Express, Discover, Check (not all
-processors support all these transaction types).
+=over 4
 
 =item * login
 
@@ -259,6 +262,15 @@ Your login name to use for authentication to the online processor.
 
 Your password to use for authentication to the online processor.
 
+=head3 GENERAL TRANSACTION FIELDS
+
+=item * type
+
+Transaction type, supported types are: CC (credit card), ECHECK (electronic
+check) and LEC (phone bill billing).  Deprecated types are: Visa, MasterCard,
+American Express, Discover, Check (not all processors support all these
+transaction types).
+
 =item * action
 
 What to do with the transaction (currently available are: Normal
@@ -279,38 +291,70 @@ and the like, just a floating point number.
 An invoice number, for your use and not normally required, many
 processors require this field to be a numeric only field.
 
+=head3 CUSTOMER INFO FIELDS
+
 =item * customer_id
 
 A customer identifier, again not normally required.
 
 =item * name
 
-The customers name, your processor may not require this.
+The customer's name, your processor may not require this.
+
+=item * first_name
+
+=item * last_name
+
+The customer's first and last name as separate fields.
+
+=item * company
+
+The customer's company name, not normally required.
 
 =item * address
 
-The customers address (your processor may not require this unless you
+The customer's address (your processor may not require this unless you
 are requiring AVS Verification).
 
 =item * city
 
-The customers city (your processor may not require this unless you are
+The customer's city (your processor may not require this unless you are
 requiring AVS Verification).
 
 =item * state
 
-The customers state (your processor may not require this unless you
+The customer's state (your processor may not require this unless you
 are requiring AVS Verification).
 
 =item * zip
 
-The customers zip code (your processor may not require this unless you
+The customer's zip code (your processor may not require this unless you
 are requiring AVS Verification).
 
 =item * country
 
 Customer's country.
 
+=item * ship_first_name
+
+=item * ship_last_name
+
+=item * ship_company
+
+=item * ship_address
+
+=item * ship_city
+
+=item * ship_state
+
+=item * ship_zip
+
+=item * ship_country
+
+These shipping address fields may be accepted by your processor.  Refer to the
+description for the corresponding non-ship field for general information on
+each field.
+
 =item * phone
 
 Customer's phone number.
@@ -323,16 +367,29 @@ Customer's fax number.
 
 Customer's email address.
 
+=head3 CREDIT CARD FIELDS
+
 =item * card_number
 
 Credit card number (obviously not required for non-credit card
 transactions).
 
-=item * exp_date
+=item * cvv2
+
+CVV2 number (also called CVC2 or CID) is a three- or four-digit security code
+used to reduce credit card fraud.
+
+=item * expiration
 
 Credit card expiration (obviously not required for non-credit card
 transactions).
 
+=item * recurring billing
+
+Recurring billing flag
+
+=head3 ELECTRONIC CHECK FIELDS
+
 =item * account_number
 
 Bank account number for electronic checks or electronic funds transfer.
@@ -341,10 +398,41 @@ Bank account number for electronic checks or electronic funds transfer.
 
 Bank's routing code for electronic checks or electronic funds transfer.
 
+=item * account_type
+
+Account type for electronic checks or electronic funds transfer.
+
+=item * account_name
+
+Account holder's name for electronic checks or electronic funds transfer.
+
 =item * bank_name
 
 Bank's name for electronic checks or electronic funds transfer.
 
+=item * check_type
+
+Check type for electronic checks or electronic funds transfer.
+
+=item * customer_org
+
+Customer organization type.
+
+=item * customer_ssn
+
+Customer's social security number.  Typically only required for electronic
+checks or electronic funds transfer.
+
+=item * license_num
+
+Customer's driver's license number.  Typically only required for electronic
+checks or electronic funds transfer.
+
+=item * license_dob
+
+Customer's date of birth.  Typically only required for electronic
+checks or electronic funds transfer.
+
 =back
 
 =head2 submit();