File Coverage

blib/lib/Finance/OFX/UserAgent.pm

Criterion	Covered	Total	%
statement	24	79	30.3
branch	0	14	0.0
condition	0	3	0.0
subroutine	8	19	42.1
pod	8	11	72.7
total	40	126	31.7

# Filename: UserAgent.pm
#
# OFX Interface for interacting with a Financial Institution server
#
# Created January 30, 2008  Brandon Fosdick
#
# Copyright 2008 Brandon Fosdick  (BSD License)
#
# $Id: UserAgent.pm,v 1.2 2008/03/04 04:22:27 bfoz Exp $

package Finance::OFX::UserAgent;

use strict;
use warnings;

our $VERSION = '2';

use Finance::OFX::Parse;
use Finance::OFX::Response;
use Data::GUID;
use LWP;
use POSIX qw(strftime);

use constant DEFAULT_OPTIONS =>
{
    'ofxVersion'    => '100',
    'ofxAppID'	    => 'QWIN',
    'ofxAppVer'	    => '0900',
    'userID'	    => 'anonymous00000000000000000000000',
    'userPass'	    => 'anonymous00000000000000000000000',
};

sub new
{
    my ($this, %options) = @_;
    my $class = ref($this) || $this;
    my $self = {};
    bless $self, $class;

    # Initialization
    $self->{Institution} = delete $options{Institution};
    $self->{ofxVersion} = delete $options{ofxVersion};
    $self->{ofxAppID} = delete $options{ofxAppID};
    $self->{ofxAppVer} = delete $options{ofxAppVer};
    $self->{userID} = delete $options{userID};
    $self->{userPass} = delete $options{userPass};

    # Defaults
    for( keys %{DEFAULT_OPTIONS()} )
    {
	$self->{$_} = DEFAULT_OPTIONS()->{$_} unless defined $self->{$_};
    }

    $self->{ua} = LWP::UserAgent->new(%options);

    return $self;
}

sub account_info
{
    my $s = shift;

    my $r = $s->request('

'.$s->sonrq.'



	    '.(Data::GUID->new()->as_string).'

		19700101


    ');
    return $s->{response} = Finance::OFX::Response->from_http_response($r);
}

sub statement
{
    my ($s, $acct, %options) = @_;
    my $start = delete $options{start};
    my $end = delete $options{end};
    my $transactions = delete $options{transactions};

    my $r = $s->request('
    '.$s->sonrq.'



      '.(Data::GUID->new()->as_string).'
      '.$acct->bankacctfrom().'
      '.
	($start ?
	    ''.strftime('%Y%m%d%H%M%S', gmtime($start))."[0:UTC]\n" : '').
	($end ?
	    ''.strftime('%Y%m%d%H%M%S', gmtime($end))."[0:UTC]\n" : '').'
        '.($transactions ? 'Y' : 'N').'



    ');

    return $s->{response} = Finance::OFX::Response->from_http_response($r);
}

sub profile
{
    my $s = shift;

    my $request = HTTP::Request->new(POST => ${$s->{Institution}}->url);
    $request->content_type('application/x-ofx');
    $request->content($s->header().
'

'.$s->sonrq.'



	    '.(Data::GUID->new()->as_string).'

		NONE
		'.${$s->{Institution}}->date.'



');

    print $request->as_string;
    my $r = $s->request($request);
    return $s->{response} = Finance::OFX::Response->from_http_response($r);
}

# --- Getters and Setters ---

sub institution
{
    my $s = shift;
    $s->{Institution} = shift if scalar @_;
    $s->{Institution};
}

sub response
{
    my $s = shift;
    $s->{response};
}

sub user_id
{
    my $s = shift;
    $s->{userID} = shift if scalar @_;
    $s->{userID};
}

sub user_pass
{
    my $s = shift;
    $s->{userPass} = shift if scalar @_;
    $s->{userPass};
}

# --- Internal use only ---

# Returns an OFX header appropriate for the protocol version in use
sub header
{
    my $s = shift;

'OFXHEADER:100
DATA:OFXSGML
VERSION:102
SECURITY:NONE
ENCODING:USASCII
CHARSET:1252
COMPRESSION:NONE
OLDFILEUID:NONE
NEWFILEUID:NONE'."\n\n"
}

sub request
{
    my ($s, $content) = @_;
    my $r = HTTP::Request->new(POST => $s->{Institution}->url);
    $r->content_type('application/x-ofx');
    $r->content($s->header().''.$content.'');
#    print "request: ", $r->as_string, "\n\n---\n\n";
    return $s->{ua}->request($r);
}

# Returns a SONRQ block
sub sonrq
{
    my $s = shift;
    my $t = strftime('%Y%m%d%H%M%S[%z:%Z]', localtime);
    $t =~ s/00:/:/;	# Fix the %z format

'
    '.$t.'
    '.$s->{userID}.'
    '.$s->{userPass}.'
    '.$s->{Institution}->language.'

	'.$s->{Institution}->org.'
	'.$s->{Institution}->fid.'

    '.$s->{ofxAppID}.'
    '.$s->{ofxAppVer}.'
'
}

1;

__END__