NAME

Finance::Bank::Bankwest::Parser - Bankwest Online Banking response parser superclass

VERSION

This module is part of distribution Finance-Bank-Bankwest v1.0.1.

This distribution's version numbering follows the conventions defined at semver.org.

DESCRIPTION

Subclasses of this module receive an HTTP::Response object when instantiated, and are capable of reporting whether they recognise that that particular response and optionally returning structured data.

ATTRIBUTES

response

An HTTP::Response object holding the response to analyse.

METHODS

bad_response

$self->bad_response if ...;

Called internally by subclasses to conveniently throw a Finance::Bank::Bankwest::Error::BadResponse exception with the "response" attached.

test

$class->test($http_response);

Inspect the supplied HTTP::Response object. Return without error if the response is recognised and acceptable, or throw an appropriate exception.

TEST

Must be implemented by subclasses; called internally by "test" and "parse".

parse

return $class->parse($http_response);

Produce and return a specific data structure from the supplied HTTP::Response object, or throw an appropriate exception if the response is not recognised and acceptable.

PARSE

Implemented by subclasses if parsing is applicable to them; called internally by "parse".

SEE ALSO

AUTHOR

Alex Peters <lxp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Alex Peters.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the 'LICENSE' file included with this distribution.