Scripts for paymentech batch transfer
authormark <mark>
Sat, 24 Oct 2009 23:37:42 +0000 (23:37 +0000)
committermark <mark>
Sat, 24 Oct 2009 23:37:42 +0000 (23:37 +0000)
FS/FS/Conf.pm
FS/FS/pay_batch.pm
FS/FS/pay_batch/paymentech.pm
bin/paymentech-download [new file with mode: 0755]
bin/paymentech-upload [new file with mode: 0755]

index fafd738..56dae58 100644 (file)
@@ -2451,7 +2451,7 @@ worry that config_items is freeside-specific and icky.
   {
     'key'         => 'batchconfig-paymentech',
     'section'     => 'billing',
-    'description' => 'Configuration for Chase Paymentech batching, four lines: 1. BIN, 2. Terminal ID, 3. Merchant ID, 4. Username',
+    'description' => 'Configuration for Chase Paymentech batching, four lines: 1. BIN, 2. Terminal ID, 3. Merchant ID, 4. Username, 5. Password',
     'type'        => 'textarea',
   },
 
index 83bf7a3..e0531f4 100644 (file)
@@ -196,7 +196,7 @@ sub import_results {
     or die "unknown format $format";
 
   my $filetype            = $info->{'filetype'};      # CSV or fixed
-  my @fields              = @{ $info->{'fields'} };
+  my @fields              = @{ $info->{'fields'}};
   my $formatre            = $info->{'formatre'};      # for fixed
   my @all_values;
   my $begin_condition     = $info->{'begin_condition'};
@@ -256,7 +256,7 @@ sub import_results {
     }
     $rows = [ $rows ] if ref($rows) ne 'ARRAY';
     foreach my $row (@$rows) {
-      push @all_values, [ @{$row}{@xmlkeys} ];
+      push @all_values, [ @{$row}{@xmlkeys}, $row ];
     }
   }
   else {
@@ -269,9 +269,9 @@ sub import_results {
           $dbh->rollback if $oldAutoCommit;
           return "can't parse: ". $csv->error_input();
         };
-        push @all_values, [ $csv->fields() ];
+        push @all_values, [ $csv->fields(), $line ];
       }elsif ($filetype eq 'fixed'){
-        my @values = $line =~ /$formatre/;
+        my @values = ( $line =~ /$formatre/, $line );
         unless (@values) {
           $dbh->rollback if $oldAutoCommit;
           return "can't parse: ". $line;
@@ -288,15 +288,20 @@ sub import_results {
     my @values = @$_;
 
     my %hash;
+    my $line = pop @values;
     foreach my $field ( @fields ) {
       my $value = shift @values;
       next unless $field;
       $hash{$field} = $value;
     }
 
-    if ( defined($end_condition) and &{$end_condition}(\%hash) ) {
+    if ( defined($begin_condition) and &{$begin_condition}(\%hash, $line)) {
+      undef $begin_condition;
+    }
+
+    if ( defined($end_condition) and &{$end_condition}(\%hash, $line) ) {
       my $error;
-      $error = &{$end_hook}(\%hash, $total) if defined($end_hook);
+      $error = &{$end_hook}(\%hash, $total, $line) if defined($end_hook);
       if ( $error ) {
         $dbh->rollback if $oldAutoCommit;
         return $error;
index 44fa78a..c1e9c9a 100644 (file)
@@ -66,7 +66,7 @@ my %paytype = (
         batchFileID  => {
           userID        => $username,
           fileDateTime  => time2str('%Y%m%d%H%M%s',time),
-          fileID        => 'batch'.time2str('%Y%m%d',time),
+          fileID        => 'FILEID',
         },
         newOrder => [ map { {
           # $_ here refers to a cust_pay_batch record.
diff --git a/bin/paymentech-download b/bin/paymentech-download
new file mode 100755 (executable)
index 0000000..07d5c78
--- /dev/null
@@ -0,0 +1,109 @@
+#!/usr/bin/perl
+
+use strict;
+use Getopt::Std;
+use Net::SFTP::Foreign;
+use FS::UID qw(adminsuidsetup datasrc);
+use FS::Record qw(qsearch qsearchs);
+use FS::pay_batch;
+use FS::cust_pay_batch;
+use FS::Conf;
+
+use Date::Format 'time2str';
+use File::Temp;
+
+use vars qw( $opt_t $opt_v );
+getopts('vt');
+
+#$Net::SFTP::Foreign::debug = -1;
+sub usage { '
+  Usage:
+      paymentech-download [ -v ] [ -t ] user
+
+'
+}
+
+my $user = shift or die &usage;
+adminsuidsetup $user;
+
+my $tmpdir = File::Temp->newdir();
+
+my $conf = new FS::Conf;
+my @batchconf = $conf->config('batchconfig-paymentech');
+# BIN, terminalID, merchantID, username, password
+my $username = $batchconf[3] or die "no Paymentech batch username configured\n";
+my $password = $batchconf[4] or die "no Paymentech batch password configured\n";
+
+my $host = ($opt_t ? 'orbitalbatchvar.paymentech.net' : 'orbitalbatch.paymentech.net');
+print STDERR "Connecting to $username\@$host...\n" if $opt_v;
+
+my $sftp = Net::SFTP::Foreign->new( host => $host,
+                                    user => $username,
+                                    password => $password,
+                                    timeout => 30,
+                                    );
+die "failed to connect to '$username\@$host'\n(".$sftp->error.")\n" if $sftp->error;
+
+my @files = map { $_->{filename} } @{ $sftp->ls('.', wanted => qr/_resp\.zip$/) };
+die "no response files found\n" if !@files;
+
+BATCH: foreach my $filename (@files) {
+  $filename =~ s/\_resp\.zip$//;
+  print STDERR "Retrieving $filename\n" if $opt_v;
+  $sftp->get("$filename\_resp.zip", "$tmpdir/$filename\_resp.zip");
+  if($sftp->error) {
+    warn "failed to download $filename\n";
+    next BATCH;
+  }
+  system("unzip -P $password -q $tmpdir/$filename\_resp.zip -d $tmpdir");
+  if(! -f "$tmpdir/$filename\_resp.xml") {
+    warn "failed to extract $filename\_resp.xml\n";
+    next BATCH;
+  }
+  open my $fh, "<$tmpdir/$filename\_resp.xml";
+  my ($batchnum) = split ('-', $filename); 
+  $batchnum = sprintf("%d", $batchnum); # remove leading zeroes
+  my $batch = qsearchs('pay_batch', { batchnum => $batchnum });
+  if(! $batch) {
+    warn "batch '$batchnum' not found\n";
+    next BATCH;
+  }
+  print STDERR "Importing batch #$batchnum\n" if $opt_v;
+  my $error = $batch->import_results( filehandle => $fh,
+                                      format     => 'paymentech' );
+  warn "error: $error\n" if $error;
+};
+print STDERR "Finished!\n" if $opt_v;
+
+=head1 NAME
+
+paymentech-download
+
+paymentech-download - Retrieve payment batch responses from Chase Paymentech.
+
+=head1 SYNOPSIS
+
+  paymentech-download [ -v ] [ -t ] user
+
+=head1 DESCRIPTION
+
+Command line tool to download payment batch responses from the Chase Paymentech
+gateway.  These are XML files packaged in ZIP files.  This script downloads them 
+by SFTP, extracts the contents, and passes them to L<FS::pay_batch::import_result>.
+
+-v: Be verbose.
+
+-t: Use the test server.
+
+user: freeside username
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::pay_batch>
+
+=cut
+
+1;
+
diff --git a/bin/paymentech-upload b/bin/paymentech-upload
new file mode 100755 (executable)
index 0000000..332339e
--- /dev/null
@@ -0,0 +1,108 @@
+#!/usr/bin/perl
+
+use strict;
+use Getopt::Std;
+use Net::SFTP::Foreign;
+use FS::UID qw(adminsuidsetup datasrc);
+use FS::Record qw(qsearch qsearchs);
+use FS::pay_batch;
+use FS::cust_pay_batch;
+use FS::Conf;
+
+use Date::Format 'time2str';
+use File::Temp;
+
+use vars qw( $opt_t $opt_v );
+getopts('vt');
+
+#$Net::SFTP::Foreign::debug = -1;
+
+sub usage { '
+  Usage:
+    paymentech-upload [ -v ] [ -t ] user batchnum
+
+'
+}
+
+my $user = shift or die &usage;
+adminsuidsetup $user;
+
+my $batchnum = shift or die &usage;
+my $pay_batch = qsearchs('pay_batch', { batchnum => $batchnum })
+  or die "can't find payment batch '$batchnum'\n";
+
+my $filename = sprintf('%06d',$batchnum) . '-' .time2str('%Y%m%d%H%M%S', time);
+print STDERR "Exporting batch $batchnum to $filename...\n" if $opt_v;
+my $tmpdir = File::Temp->newdir();
+my $text = $pay_batch->export_batch('paymentech');
+$text =~ s!<fileID>FILEID</fileID>!<fileID>$filename</fileID>! 
+  or die "couldn't find FILEID tag\n";
+open OUT, ">$tmpdir/$filename.xml";
+print OUT $text;
+close OUT;
+
+my $conf = new FS::Conf;
+my @batchconf = $conf->config('batchconfig-paymentech');
+# BIN, terminalID, merchantID, username, password
+my $username = $batchconf[3] or die "no Paymentech batch username configured\n";
+my $password = $batchconf[4] or die "no Paymentech batch password configured\n";
+
+# This is less than ideal.
+system("zip -P $password -q -j $tmpdir/$filename.zip $tmpdir/$filename.xml");
+
+die "failed to create zip file\n" if (! -f "$tmpdir/$filename.zip" );
+
+
+#my $host = ($opt_t ? 'orbitalbatchvar.paymentech.net' : 'orbitalbatch.paymentech.net');
+my $host = ($opt_t ? 'orbitalbatchvar.paymentech.net' : '127.0.0.1');
+print STDERR "Connecting to $username\@$host...\n" if $opt_v;
+
+my $sftp = Net::SFTP::Foreign->new( host => $host,
+                                    user => $username,
+                                    password => $password,
+                                    timeout => 30,
+                                    );
+die "failed to connect to '$username\@$host'\n(".$sftp->error.")\n" if $sftp->error;
+
+$sftp->put("$tmpdir/$filename.zip", "$filename.zip")
+  or die "failed to upload file (".$sftp->error.")\n";
+
+print STDERR "Finished!\n" if $opt_v;
+
+=head1 NAME
+
+paymentech-upload
+
+paymentech-upload - Transmit a payment batch to Chase Paymentech via SFTP.
+
+=head1 SYNOPSIS
+
+  paymentech-upload [ -v ] [ -t ] user batchnum
+
+=head1 DESCRIPTION
+
+Command line tool to upload a payment batch to the Chase Paymentech gateway.
+The batch will be exported to the Paymentech XML format, packaged in a ZIP 
+file, and transmitted via SFTP.  Use L<paymentech-download> to retrieve the 
+response file.
+
+-v: Be verbose.
+
+-t: Send the transaction to the test server.
+
+user: freeside username
+
+batchnum: pay_batch primary key
+
+=head1 BUGS
+
+Passing the zip password on the command line is slightly risky.
+
+=head1 SEE ALSO
+
+L<FS::pay_batch>
+
+=cut
+
+1;
+