package Business::OnlinePayment::HTTPS;
use strict;
-use vars qw($VERSION $DEBUG $ssl_module $skip_NetSSLeay);
-use URI::Escape;
-use Tie::IxHash;
use base qw(Business::OnlinePayment);
+use vars qw($VERSION $DEBUG);
+use Tie::IxHash;
+use Net::HTTPS::Any 0.10;
-$VERSION = '0.05_01';
-$VERSION = eval $VERSION; # modperlstyle: convert the string into a number
+$VERSION = '0.10';
$DEBUG = 0;
-BEGIN {
-
- $ssl_module = '';
-
- eval {
- die if defined($skip_NetSSLeay) && $skip_NetSSLeay;
- require Net::SSLeay;
- Net::SSLeay->VERSION(1.30);
- #import Net::SSLeay
- # qw(get_https post_https make_form make_headers);
- $ssl_module = 'Net::SSLeay';
- };
-
- if ($@) {
- eval {
- require LWP::UserAgent;
- require HTTP::Request::Common;
- require Crypt::SSLeay;
- #import HTTP::Request::Common qw(GET POST);
- $ssl_module = 'Crypt::SSLeay';
- };
- }
-
- unless ( $ssl_module ) {
- die "One of Net::SSLeay (v1.30 or later)".
- " or Crypt::SSLeay (+LWP) is required";
- }
-
-}
-
=head1 NAME
Business::OnlinePayment::HTTPS - Base class for HTTPS payment APIs
=head1 SYNOPSIS
- package Business::OnlinePayment::MyProcessor
+ package Business::OnlinePayment::MyProcessor;
use base qw(Business::OnlinePayment::HTTPS);
-
+
sub submit {
- my $self = shift;
-
- #...
-
- # pass a list (order is preserved, if your gateway needs that)
- ($page, $response, %reply_headers)
- = $self->https_get( field => 'value', ... );
-
- #or a hashref
- my %hash = ( field => 'value', ... );
- ($page, $response_code, %reply_headers)
+ my $self = shift;
+
+ #...
+
+ # pass a list (order is preserved, if your gateway needs that)
+ ( $page, $response, %reply_headers )
+ = $self->https_get( field => 'value', ... );
+
+ # or a hashref
+ my %hash = ( field => 'value', ... );
+ ( $page, $response_code, %reply_headers )
= $self->https_get( \%hash );
-
- #...
+
+ #...
}
=head1 DESCRIPTION
-This is a base class for HTTPS based gateways, providing useful code for
-implementors of HTTPS payment APIs.
+This is a base class for HTTPS based gateways, providing useful code
+for implementors of HTTPS payment APIs.
-It depends on Net::SSLeay _or_ ( Crypt::SSLeay and LWP::UserAgent ).
+It depends on Net::HTTPS::Any, which in turn depends on
+Net::SSLeay _or_ ( Crypt::SSLeay and LWP::UserAgent ).
=head1 METHODS
=item https_get [ \%options ] HASHREF | FIELD => VALUE, ...
-Accepts parameters as either a hashref or a list of fields and values. In the
-latter case, ordering is preserved (see L<Tie::IxHash> to do so when passing a
-hashref).
-
-Returns a list consisting of the page content as a string, the HTTP response
-code, and a list of key/value pairs representing the HTTP response headers.
-
-=cut
-
-sub https_get {
- my $self = shift;
+Accepts parameters as either a hashref or a list of fields and values.
+In the latter case, ordering is preserved (see L<Tie::IxHash> to do so
+when passing a hashref).
- # handle optional options hashref
- my $opts;
- if ( scalar(@_) > 1 and ref($_[0]) eq "HASH" ) {
- $opts = shift;
- }
+Returns a list consisting of the page content as a string, the HTTP
+response code and message (i.e. "200 OK" or "404 Not Found"), and a list of
+key/value pairs representing the HTTP response headers.
- # accept a hashref or a list (keep it ordered)
- my $post_data;
- if ( ref($_[0]) eq 'HASH' ) {
- $post_data = shift;
- } elsif ( scalar(@_) > 1 ) {
- tie my %hash, 'Tie::IxHash', @_;
- $post_data = \%hash;
- } elsif ( scalar(@_) == 1 ) {
- $post_data = shift;
- } else {
- die "https_get called with no params\n";
- }
+The options hashref supports setting headers:
- $opts->{"Content-Type"} ||= "application/x-www-form-urlencoded";
-
- ### XXX referer!!!
- my %headers;
- if ( ref( $opts->{headers} ) eq "HASH" ) {
- %headers = %{ $opts->{headers} };
+ {
+ headers => { 'X-Header1' => 'value', ... },
}
- $headers{'Host'} ||= $self->server;
-
- my $path = $self->path;
- if ( keys %$post_data ) {
-
- #my $u = URI->new("", "https");
- #$u->query_param(%$post_data);
- #$path .= '?'. $u->query;
- $path .= '?'. join('&',
- map { uri_escape($_).'='. uri_escape($post_data->{$_}) }
- keys %$post_data
- );
- #warn $path;
-
- }
-
- if ( $ssl_module eq 'Net::SSLeay' ) {
+=cut
- import Net::SSLeay qw(get_https make_headers);
- my $headers = make_headers(%headers);
- get_https( $self->server, $self->port, $path, $headers, "", $opts->{"Content-Type"} );
+# Content-Type => 'text/namevalue',
- } elsif ( $ssl_module eq 'Crypt::SSLeay' ) {
+sub https_get {
+ my $self = shift;
- import HTTP::Request::Common qw(GET);
+ # handle optional options hashref
+ my $opts = {};
+ if ( scalar(@_) > 1 and ref( $_[0] ) eq "HASH" ) {
+ $opts = shift;
+ }
- my $url = 'https://'. $self->server;
- $url .= ':'. $self->port
- unless $self->port == 443;
- $url .= "/$path";
+ # accept a hashref or a list (keep it ordered)
+ my $post_data;
+ if ( ref( $_[0] ) eq 'HASH' ) {
+ $post_data = shift;
+ } elsif ( scalar(@_) > 1 ) {
+ tie my %hash, 'Tie::IxHash', @_;
+ $post_data = \%hash;
+ } elsif ( scalar(@_) == 1 ) {
+ $post_data = shift;
+ } else {
+ die "https_get called with no params\n";
+ }
- my $ua = new LWP::UserAgent;
- my $res = $ua->request( GET( $url ) );
+ $self->build_subs(qw( response_page response_code response_headers ));
- #( $res->as_string, # wtf?
- ( $res->content,
- $res->code,
- map { $_ => $res->header($_) } $res->header_field_names
+ my( $res_page, $res_code, @res_headers) = Net::HTTPS::Any::https_get(
+ 'host' => $self->server,
+ 'path' => $self->path,
+ 'headers' => $opts->{headers},
+ 'args' => $post_data,
+ 'debug' => $DEBUG,
);
- } else {
+ $self->response_page( $res_page );
+ $self->response_code( $res_code );
+ $self->response_headers( { @res_headers } );
- die "unknown SSL module $ssl_module";
-
- }
+ ( $res_page, $res_code, @res_headers );
}
=item https_post [ \%options ] SCALAR | HASHREF | FIELD => VALUE, ...
-Accepts form fields and values as either a hashref or a list. In the latter
-case, ordering is preserved (see L<Tie::IxHash> to do so when passing a
-hashref).
+Accepts form fields and values as either a hashref or a list. In the
+latter case, ordering is preserved (see L<Tie::IxHash> to do so when
+passing a hashref).
Also accepts instead a simple scalar containing the raw content.
-Returns a list consisting of the page content as a string, the HTTP response
-code, and a list of key/value pairs representing the HTTP response headers.
-
-=cut
-
-sub https_post {
- my $self = shift;
-
- # handle optional options hashref
- my $opts;
- if ( scalar(@_) > 1 and ref($_[0]) eq "HASH" ) {
- $opts = shift;
- }
-
- # accept a hashref or a list (keep it ordered)
- my $post_data;
- if ( ref($_[0]) eq 'HASH' ) {
- $post_data = shift;
- } elsif ( scalar(@_) > 1 ) {
- tie my %hash, 'Tie::IxHash', @_;
- $post_data = \%hash;
- } elsif ( scalar(@_) == 1 ) {
- $post_data = shift;
- } else {
- die "https_post called with no params\n";
- }
-
- $opts->{"Content-Type"} ||= "application/x-www-form-urlencoded";
+Returns a list consisting of the page content as a string, the HTTP
+response code and message (i.e. "200 OK" or "404 Not Found"), and a list of
+key/value pairs representing the HTTP response headers.
- ### XXX referer!!!
- my %headers;
- if ( ref( $opts->{headers} ) eq "HASH" ) {
- %headers = %{ $opts->{headers} };
- }
- $headers{'Host'} ||= $self->server;
+The options hashref supports setting headers and Content-Type:
- if ( $DEBUG && ref($post_data) ) {
- warn "post data:\n", join('', map { " $_ => ". $post_data->{$_}. "\n" } keys %$post_data );
+ {
+ headers => { 'X-Header1' => 'value', ... },
+ Content-Type => 'text/namevalue',
}
- if ( $ssl_module eq 'Net::SSLeay' ) {
-
- import Net::SSLeay qw(post_https make_headers make_form);
- my $headers = make_headers(%headers);
-
- if ( $DEBUG ) {
- no warnings 'uninitialized';
- warn $self->server. ':'. $self->port. $self->path. "\n";
- $Net::SSLeay::trace = $DEBUG;
- }
-
- my $raw_data = ref($post_data) ? make_form(%$post_data) : $post_data;
- post_https( $self->server, $self->port, $self->path,
- $headers, $raw_data, $opts->{"Content-Type"} );
-
- } elsif ( $ssl_module eq 'Crypt::SSLeay' ) {
-
- import HTTP::Request::Common qw(POST);
+=cut
- my $url = 'https://'. $self->server;
- $url .= ':'. $self->port
- unless $self->port == 443;
- $url .= $self->path;
+sub https_post {
+ my $self = shift;
- if ( $DEBUG ) {
- warn $url;
+ # handle optional options hashref
+ my $opts = {};
+ if ( scalar(@_) > 1 and ref( $_[0] ) eq "HASH" ) {
+ $opts = shift;
}
- my $ua = new LWP::UserAgent;
+ my %post = (
+ 'host' => $self->server,
+ 'path' => $self->path,
+ 'headers' => $opts->{headers},
+ 'Content-Type' => $opts->{'Content-Type'},
+ 'debug' => $DEBUG,
+ );
- my $res;
- if ( ref($post_data) ) {
- $res = $ua->request( POST( $url, [ %$post_data ] ) );
+ # accept a hashref or a list (keep it ordered)
+ my $post_data = '';
+ my $content = undef;
+ if ( ref( $_[0] ) eq 'HASH' ) {
+ $post{'args'} = shift;
+ } elsif ( scalar(@_) > 1 ) {
+ tie my %hash, 'Tie::IxHash', @_;
+ $post{'args'} = \%hash;
+ } elsif ( scalar(@_) == 1 ) {
+ $post{'content'} = shift;
} else {
- my $req =new HTTP::Request( 'POST' => $url );
- $req->content_type( $opts->{"Content-Type"} );
- $req->content($post_data);
- $res = $ua->request($req);
+ die "https_post called with no params\n";
}
- #( $res->as_string, # wtf?
- ( $res->content,
- $res->code,
- map { $_ => $res->header($_) } $res->header_field_names
- );
+ $self->build_subs(qw( response_page response_code response_headers ));
- } else {
+ my( $res_page, $res_code, @res_headers)= Net::HTTPS::Any::https_post(%post);
- die "unknown SSL module $ssl_module";
+ $self->response_page( $res_page );
+ $self->response_code( $res_code );
+ $self->response_headers( { @res_headers } );
- }
+ ( $res_page, $res_code, @res_headers );
}
=head1 SEE ALSO
-L<Business::OnlinePayment>
+L<Business::OnlinePayment>, L<Net::HTTPS::Any>
=cut
projects / Business-OnlinePayment.git / blobdiff