From 921ca2383b284b9bf8cfcc73684beb57ca81fcbb Mon Sep 17 00:00:00 2001
From: Colin Kuskie <colink@perldreamer.com>
Date: Sat, 4 Jul 2009 22:58:51 +0000
Subject: [PATCH] Add missing POD to ITransact

---
 lib/WebGUI/Shop/PayDriver/ITransact.pm | 76 +++++++++++++++++++++++++-
 1 file changed, 75 insertions(+), 1 deletion(-)

diff --git a/lib/WebGUI/Shop/PayDriver/ITransact.pm b/lib/WebGUI/Shop/PayDriver/ITransact.pm
index c573dfc3f..74a7bdd9f 100644
--- a/lib/WebGUI/Shop/PayDriver/ITransact.pm
+++ b/lib/WebGUI/Shop/PayDriver/ITransact.pm
@@ -276,6 +276,24 @@ sub cancelRecurringPayment {
 }
 
 #-------------------------------------------------------------------
+
+=head2 checkRecurringTransaction ( $xid, $expectedAmount )
+
+Make an XML request back to ITransact to verify a recurring transaction.  Returns 0 if
+the transaction cannot be verified or is incorrect.  Otherwise, it returns 1.
+
+NOTE: THIS CODE IS NOT CALLED ANYWHERE.
+
+=head3 $xid
+
+Transaction ID, from ITransact.
+
+=head3 $expectedAmount
+
+The amount we think should be charged in this transaction.
+
+=cut
+
 sub checkRecurringTransaction {
     my $self            = shift;
     my $xid             = shift;
@@ -290,7 +308,7 @@ sub checkRecurringTransaction {
                 HomePage        => ,
             },
             RecurDetails            => {
-                OperiationXID   => $xid,
+                OperiationXID   => $xid, ##BUGGO, typo?
             },
         }
     };
@@ -434,6 +452,14 @@ sub doXmlRequest {
 }
 
 #-------------------------------------------------------------------
+
+=head2 getButton 
+
+Return a form to select this payment driver and to accept credentials from those
+who wish to use it.
+
+=cut
+
 sub getButton {
     my $self    = shift;
     my $session = $self->session;
@@ -459,6 +485,14 @@ sub handlesRecurring {
 }
 
 #-------------------------------------------------------------------
+
+=head2 processCredentials 
+
+Process the form where credentials (name, address, phone number and credit card information)
+are entered.
+
+=cut
+
 sub processCredentials {
     my $self    = shift;
     my $session = $self->session;
@@ -555,6 +589,17 @@ sub getBillingAddress {
 }
 
 #-------------------------------------------------------------------
+
+=head2 processPayment ($transaction)
+
+Contact ITransact and submit the payment data to them for processing.
+
+=head3 $transaction
+
+A WebGUI::Shop::Transaction object to pull information from.
+
+=cut
+
 sub processPayment {
     my $self        = shift;
     my $transaction = shift;
@@ -645,6 +690,17 @@ sub www_edit {
 }
 
 #-------------------------------------------------------------------
+
+=head2 www_getCredentials ( $errors )
+
+Build a templated form for asking the user for their credentials.
+
+=head3 $errors
+
+An array reference of errors to show the user.
+
+=cut
+
 sub www_getCredentials {
     my $self        = shift;
     my $errors      = shift;
@@ -754,6 +810,15 @@ sub www_getCredentials {
 }
 
 #-------------------------------------------------------------------
+
+=head2 www_pay 
+
+Makes sure that the user has all the requirements for checking out, including
+getting credentials, it processes the transaction and then displays a thank
+you screen.
+
+=cut
+
 sub www_pay {
     my $self        = shift;
     my $session     = $self->session;
@@ -782,6 +847,15 @@ sub www_pay {
 }
 
 #-------------------------------------------------------------------
+
+=head2 www_processRecurringTransactionPostback 
+
+Callback method for ITransact to dial up WebGUI and post the results of a
+recurring transaction.  This allows WebGUI to renew group memberships or
+do whatever other activity a Sku purchase would allow.
+
+=cut
+
 sub www_processRecurringTransactionPostback {
 	my $self    = shift;
     my $session = $self->session;