Add fields to documentation: tax, freight, duty, tax_exempt, po_number
[Business-OnlinePayment.git] / OnlinePayment.pm
index 2dc51db..a43b87b 100644 (file)
@@ -6,39 +6,39 @@ use Carp;
 
 require 5.005;
 
-$VERSION = '3.00_08';
+$VERSION = '3.01_01';
 $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,
-    failure_status   => undef,
-    fraud_detect     => undef,
-    is_success       => undef,
-    maximum_risk     => undef,
-    path             => undef,
-    port             => undef,
-    require_avs      => undef,
-    result_code      => undef,
-    server           => undef,
-    server_response  => undef,
-    test_transaction => undef,
-    transaction_type => undef,
+    authorization        => undef,
+    error_message        => undef,
+    failure_status       => undef,
+    fraud_detect         => undef,
+    is_success           => undef,
+    maximum_risk         => undef,
+    path                 => undef,
+    port                 => undef,
+    require_avs          => undef,
+    result_code          => undef,
+    server               => undef,
+    server_response      => undef,
+    test_transaction     => undef,
+    transaction_type     => undef,
+    fraud_score          => undef,
+    fraud_transaction_id => undef,
 );
 
 sub new {
     my($class,$processor,%data) = @_;
 
-    Carp::croak("unspecified processor") unless $processor;
+    croak("unspecified processor") unless $processor;
 
     my $subclass = "${class}::$processor";
-    if(!defined(&$subclass)) {
-        eval "use $subclass";
-        Carp::croak("unknown processor $processor ($@)") if $@;
-    }
+    eval "use $subclass";
+    croak("unknown processor $processor ($@)") if $@;
 
     my $self = bless {processor => $processor}, $subclass;
     $self->build_subs(keys %fields);
@@ -80,6 +80,8 @@ sub _risk_detect {
     $risk_transaction->content( %parent_content );
     $risk_transaction->submit();
     if ($risk_transaction->is_success()) {
+         $self->fraud_score( $risk_transaction->fraud_score );
+         $self->fraud_transaction_id( $risk_transaction->fraud_transaction_id );
        if ( $risk_transaction->fraud_score <= $self->maximum_fraud_score()) {
            return 1;
        } else {
@@ -104,23 +106,21 @@ sub _pre_submit {
     # Search for an appropriate FD module
     foreach my $fraud_class ( @Fraud_Class_Path ) {
        my $subclass = $fraud_class . "::" . $fraud_detection;
-       if (!defined(&$subclass)) {
-           eval "use $subclass ()";
-           if ($@) {
-               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);
-               if ($risk_tx->can('set_defaults')) {
-                   $risk_tx->set_defaults();
-               }
-               $risk_tx->_glean_parameters_from_parent($self);
-               return $self->_risk_detect($risk_tx);
-           }
+       eval "use $subclass ()";
+       if ($@) {
+           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);
+            if ($risk_tx->can('set_defaults')) {
+                $risk_tx->set_defaults();
+            }
+            $risk_tx->_glean_parameters_from_parent($self);
+            return $self->_risk_detect($risk_tx);
        }
     }
-    Carp::croak("Unable to locate fraud_detection module $fraud_detection"
+    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)");
 }
@@ -144,7 +144,7 @@ sub required_fields {
         push(@missing, $_) unless exists $content{$_};
     }
 
-    Carp::croak("missing required field(s): " . join(", ", @missing) . "\n")
+    croak("missing required field(s): " . join(", ", @missing) . "\n")
          if(@missing);
 }
 
@@ -172,7 +172,7 @@ sub remap_fields {
 sub submit {
     my($self) = @_;
 
-    Carp::croak("Processor subclass did not override submit function");
+    croak("Processor subclass did not override submit function");
 }
 
 sub dump_contents {
@@ -197,6 +197,17 @@ sub build_subs {
     }
 }
 
+#helper sub
+
+sub silly_bool {
+  my( $self, $value ) = @_;
+  return 1 if $value =~ /^[yt]/i;
+  return 0 if $value =~ /^[fn]/i;
+  #return 1 if $value == 1;
+  #return 0 if $value == 0;
+  $value; #die??
+}
+
 1;
 
 __END__
@@ -254,128 +265,156 @@ correct fields in the backend.  The currently defined fields are:
 
 =over 4
 
-=item login
+=item login
 
 Your login name to use for authentication to the online processor.
 
-=item password
+=item password
 
 Your password to use for authentication to the online processor.
 
 =back
 
-=head3 GENERAL TRANSACTION FIELDS
+=head3 REQUIRED TRANSACTION FIELDS
 
 =over 4
 
-=item type
+=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).
+are: Visa, MasterCard, American Express, Discover, Check.  Not all
+processors support all transaction types.
 
-=item action
+=item action
 
 What to do with the transaction (currently available are: Normal
-Authorization, Authorization Only, Credit, Post Authorization)
+Authorization, Authorization Only, Credit, Post Authorization,
+Recurring Authorization, Modify Recurring Authorization,
+Cancel Recurring Authorization)
 
-=item * description
+=item amount
 
-A description of the transaction (used by some processors to send
-information to the client, normally not a required field).
+The amount of the transaction.  No dollar signs or currency identifiers,
+just a whole or floating point number (i.e. 26, 26.1 or 26.13).
 
-=item * amount
+=back
 
-The amount of the transaction, most processors don't want dollar signs
-and the like, just a floating point number.
+=head3 OPTIONAL TRANSACTION FIELDS
+
+=over 4
+
+=item description
+
+A description of the transaction (used by some processors to send
+information to the client, normally not a required field).
 
-=item invoice_number
+=item invoice_number
 
 An invoice number, for your use and not normally required, many
 processors require this field to be a numeric only field.
 
+=item po_number
+
+Purchase order number (normally not required).
+
+=item tax
+
+Tax amount (portion of amount field, not added to it).
+
+=item freight
+
+Freight amount (portion of amount field, not added to it).
+
+=item duty
+
+Duty amount (portion of amount field, not added to it).
+
+=item tax_exempt
+
+Tax exempt flag (i.e. TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0).
+
 =back
 
 =head3 CUSTOMER INFO FIELDS
 
 =over 4
 
-=item customer_id
+=item customer_id
 
 A customer identifier, again not normally required.
 
-=item name
+=item name
 
 The customer's name, your processor may not require this.
 
-=item first_name
+=item first_name
 
-=item last_name
+=item last_name
 
 The customer's first and last name as separate fields.
 
-=item company
+=item company
 
 The customer's company name, not normally required.
 
-=item address
+=item address
 
 The customer's address (your processor may not require this unless you
 are requiring AVS Verification).
 
-=item city
+=item city
 
 The customer's city (your processor may not require this unless you
 are requiring AVS Verification).
 
-=item state
+=item state
 
 The customer's state (your processor may not require this unless you
 are requiring AVS Verification).
 
-=item zip
+=item zip
 
 The customer's zip code (your processor may not require this unless
 you are requiring AVS Verification).
 
-=item country
+=item country
 
 Customer's country.
 
-=item ship_first_name
+=item ship_first_name
 
-=item ship_last_name
+=item ship_last_name
 
-=item ship_company
+=item ship_company
 
-=item ship_address
+=item ship_address
 
-=item ship_city
+=item ship_city
 
-=item ship_state
+=item ship_state
 
-=item ship_zip
+=item ship_zip
 
-=item ship_country
+=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
+=item phone
 
 Customer's phone number.
 
-=item fax
+=item fax
 
 Customer's fax number.
 
-=item email
+=item email
 
 Customer's email address.
 
-=item customer_ip
+=item customer_ip
 
 IP Address from which the transaction originated.
 
@@ -385,22 +424,28 @@ IP Address from which the transaction originated.
 
 =over 4
 
-=item card_number
+=item card_number
 
-Credit card number (obviously not required for non-credit card
-transactions).
+Credit card number.
 
-=item cvv2
+=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
+=item expiration
+
+Credit card expiration.
+
+=item track1
+
+Track 1 on the magnetic stripe (Card present only)
 
-Credit card expiration (obviously not required for non-credit card
-transactions).
+=item track2
 
-=item * recurring billing
+Track 2 on the magnetic stripe (Card present only)
+
+=item recurring billing
 
 Recurring billing flag
 
@@ -410,54 +455,78 @@ Recurring billing flag
 
 =over 4
 
-=item account_number
+=item account_number
 
 Bank account number for electronic checks or electronic funds
 transfer.
 
-=item routing_code
+=item routing_code
 
 Bank's routing code for electronic checks or electronic funds
 transfer.
 
-=item account_type
+=item account_type
 
-Account type for electronic checks or electronic funds transfer.
+Account type for electronic checks or electronic funds transfer.  Can be
+(case-insensitive): B<Personal Checking>, B<Personal Savings>,
+B<Business Checking> or B<Business Savings>.
 
-=item account_name
+=item account_name
 
 Account holder's name for electronic checks or electronic funds
 transfer.
 
-=item bank_name
+=item bank_name
 
 Bank's name for electronic checks or electronic funds transfer.
 
-=item check_type
+=item check_type
 
 Check type for electronic checks or electronic funds transfer.
 
-=item customer_org
+=item customer_org
 
 Customer organization type.
 
-=item customer_ssn
+=item customer_ssn
 
 Customer's social security number.  Typically only required for
 electronic checks or electronic funds transfer.
 
-=item license_num
+=item license_num
 
 Customer's driver's license number.  Typically only required for
 electronic checks or electronic funds transfer.
 
-=item license_dob
+=item license_dob
 
 Customer's date of birth.  Typically only required for electronic
 checks or electronic funds transfer.
 
 =back
 
+=head3 RECURRING BILLING FIELDS
+
+=over 4
+
+=item interval 
+
+Interval expresses the amount of time between billings: digits, whitespace
+and units (currently "days" or "months" in either singular or plural form).
+
+=item start
+
+The date of the first transaction (used for processors which allow delayed
+start) expressed as YYYY-MM-DD.
+
+=item periods
+
+The number of cycles of interval length for which billing should occur 
+(inclusive of 'trial periods' if the processor supports recurring billing
+at more than one rate)
+
+=back
+
 =head2 submit();
 
 Submit the transaction to the processor for completion
@@ -531,6 +600,14 @@ RISK).
 Retrieve or change the processor submission path (CHANGE AT YOUR OWN
 RISK).
 
+=head2 fraud_score();
+
+Retrieve or change the fraud score from any Business::FraudDetect plugin
+
+=head2 fraud_transaction_id();
+
+Retrieve or change the transaction id from any Business::FraudDetect plugin
+
 =head1 AUTHORS
 
 Jason Kohles, email@jasonkohles.com
@@ -539,11 +616,35 @@ Jason Kohles, email@jasonkohles.com
 
 Phil Lobbes E<lt>phil at perkpartners dot comE<gt>
 
+=head1 HOMEPAGE
+
+Homepage:  http://420.am/business-onlinepayment/
+
+Development:  http://420.am/business-onlinepayment/ng.html
+
 =head1 MAILING LIST
 
 Please direct current development questions, patches, etc. to the mailing list:
 http://420.am/cgi-bin/mailman/listinfo/bop-devel/
 
+=head1 REPOSITORY
+
+The code is available from our public CVS repository:
+
+  export CVSROOT=":pserver:anonymous@cvs.freeside.biz:/home/cvs/cvsroot"
+  cvs login
+  # The password for the user `anonymous' is `anonymous'.
+  cvs checkout Business-OnlinePayment
+
+Or on the web:
+
+  http://freeside.biz/cgi-bin/viewvc.cgi/Business-OnlinePayment/
+
+Many (but by no means all!) processor plugins are also available in the same
+repository, see:
+
+  http://freeside.biz/cgi-bin/viewvc.cgi/
+
 =head1 DISCLAIMER
 
 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED