Future-HTTP/lib/Future/HTTP/Mojo.pm
package Future::HTTP::Mojo;
use strict;
use Future::Mojo 1.003; # only 1.003+ is compatible with Future::XS
use Mojo::UserAgent;
use Moo 2; # or Moo::Lax if you can't have Moo v2
use experimental 'signatures';
our $VERSION = '0.17';
with 'Future::HTTP::Handler';
has ua => (
is => 'lazy',
default => sub { Mojo::UserAgent->new( %{ $_[0]->_ua_args } ) }
);
has _ua_args => (
is => 'ro',
default => sub { +{
max_redirects => 10,
} } ,
);
=head1 NAME
Future::HTTP::Mojo - asynchronous HTTP client with a Future interface
=head1 DESCRIPTION
This is the backend when running with L<Mojo::IOLoop>. It will execute the
requests asynchronously.
=cut
sub BUILDARGS {
my( $class, %options ) = @_;
my @ua_args = keys %options ? (_ua_args => \%options) : ();
return +{
@ua_args
}
}
sub is_async { !0 }
sub _ae_from_mojolicious( $self, $tx ) {
# Convert the result back to a future
my $res = $tx->res;
my( $body ) = $res->body;
my $headers = $res->headers->to_hash; # This means only a single header is allowed! Multiple cookies will vanish!
$headers->{Status} = $res->code;
$headers->{Reason} = '';
$headers->{URL} = $tx->req->url;
if( $tx->redirects) {
my $r = $headers;
for my $mojolicious_result ( reverse @{ $tx->redirects } ) {
$r->{Redirect} = [ $self->_ae_from_mojolicious( $mojolicious_result ) ];
$r = $r->{Redirect}->[1]; # point to the new result headers
};
};
return ($body, $headers)
};
sub _request($self, $method, $url, %options) {
# Munge the parameters from AnyEvent::HTTP to Mojolicious::UserAgent
# we should handle on_body parts here with the 'on read' callback
my $body = defined $options{ body } ? $options{ body } : '';
# Execute the request (asynchronously)
my $_tx = $self->ua->build_tx(
$method => $url,
$options{ headers } || {},
$body,
);
my $res = Future::Mojo->new();
$_tx = $self->ua->start($_tx, sub( $ua, $tx ) {
my( $body, $headers ) = $self->_ae_from_mojolicious( $tx );
$self->http_response_received( $res, $body, $headers );
});
$res
}
sub http_request($self,$method,$url,%options) {
$self->_request(
$method => $url,
%options
)
}
sub http_get($self,$url,%options) {
$self->_request(
'GET' => $url,
%options,
)
}
sub http_head($self,$url,%options) {
$self->_request(
'HEAD' => $url,
%options
)
}
sub http_post($self,$url,$body,%options) {
$self->_request(
'POST' => $url,
body => $body,
%options
)
}
=head1 METHODS
=head2 C<< Future::HTTP::Mojo->new() >>
my $ua = Future::HTTP::Mojo->new();
Creates a new instance of the HTTP client.
=head2 C<< $ua->is_async() >>
Returns true, because this backend is asynchronous.
=head2 C<< $ua->http_get($url, %options) >>
$ua->http_get('http://example.com/',
headers => {
'Accept' => 'text/json',
},
)->then(sub {
my( $body, $headers ) = @_;
...
});
Retrieves the URL and returns the body and headers, like
the function in L<AnyEvent::HTTP>.
=head2 C<< $ua->http_head($url, %options) >>
$ua->http_head('http://example.com/',
headers => {
'Accept' => 'text/json',
},
)->then(sub {
my( $body, $headers ) = @_;
...
});
Retrieves the header of the URL and returns the headers,
like the function in L<AnyEvent::HTTP>.
=head2 C<< $ua->http_post($url, $body, %options) >>
$ua->http_post('http://example.com/api',
'{token:"my_json_token"}',
headers => {
'Accept' => 'text/json',
},
)->then(sub {
my( $body, $headers ) = @_;
...
});
Posts the content to the URL and returns the body and headers,
like the function in L<AnyEvent::HTTP>.
=head2 C<< $ua->http_request($method, $url, %options) >>
$ua->http_request('PUT' => 'http://example.com/api',
headers => {
'Accept' => 'text/json',
},
body => '{token:"my_json_token"}',
)->then(sub {
my( $body, $headers ) = @_;
...
});
Posts the content to the URL and returns the body and headers,
like the function in L<AnyEvent::HTTP>.
Note that this subclass will automatically collect cookies. This
may or may not be the behaviour you want.
=head1 SEE ALSO
L<Future>
L<AnyEvent::HTTP> for the details of the API
L<Mojo::UserAgent> for the backend
=head1 REPOSITORY
The public repository of this module is
L<http://github.com/Corion/future-http>.
=head1 SUPPORT
The public support forum of this module is
L<https://perlmonks.org/>.
=head1 BUG TRACKER
Please report bugs in this module via the RT CPAN bug queue at
L<https://rt.cpan.org/Public/Dist/Display.html?Name=Future-HTTP>
or via mail to L<future-http-Bugs@rt.cpan.org>.
=head1 AUTHOR
Max Maischein C<corion@cpan.org>
=head1 COPYRIGHT (c)
Copyright 2016-2024 by Max Maischein C<corion@cpan.org>.
=head1 LICENSE
This module is released under the same terms as Perl itself.
=cut
1;