1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
#############################################################################
##
## Copyright (C) 2017 The Qt Company Ltd.
## Contact: https://www.qt.io/licensing/
##
## This file is part of the Quality Assurance module of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:GPL-EXCEPT$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see https://www.qt.io/terms-conditions. For further
## information use the contact form at https://www.qt.io/contact-us.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 3 as published by the Free Software
## Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
## included in the packaging of this file. Please review the following
## information to ensure the GNU General Public License requirements will
## be met: https://www.gnu.org/licenses/gpl-3.0.html.
##
## $QT_END_LICENSE$
##
#############################################################################
package QtQA::WWW::Util;
use strict;
use warnings;
use AnyEvent::HTTP;
use Carp;
use Coro;
use JSON;
use URI;
use base 'Exporter';
our @EXPORT_OK = qw(
blocking_http_request
fetch_json_data
fetch_to_scalar
www_form_urlencoded
);
our %EXPORT_TAGS = (all => \@EXPORT_OK);
sub www_form_urlencoded
{
my (%args) = @_;
my $uri = URI->new( );
$uri->query_form( %args );
return $uri->query( );
}
sub blocking_http_request
{
my ($method, $url, @args) = @_;
http_request( $method, $url, @args, Coro::rouse_cb() );
return Coro::rouse_wait();
}
sub fetch_to_scalar
{
my ($url) = @_;
my ($data, $headers) = blocking_http_request( GET => $url );
if ($headers->{ Status } != 200) {
croak "fetch $url: $headers->{ Status } $headers->{ Reason }";
}
return $data;
}
sub fetch_json_data
{
my ($url) = @_;
my $json = fetch_to_scalar( $url );
return decode_json( $json );
}
=head1 NAME
QtQA::WWW::Util - utility methods for dealing with web services
=head1 METHODS
Methods are not exported by default; they may be exported individually,
or all together by using the ':all' tag.
=over
=item www_form_urlencoded( key1 => $val1, key2 => $val2 ... )
Given a hash, returns a string representation in application/x-www-form-urlencoded format.
Useful for constructing the body of an HTTP POST normally filled by a web form.
my $postdata = www_form_urlencoded(id => 1234, request => 'do this; do that' );
# $postdata eq 'request=do+this%3B+do+that&id=1234'
=item blocking_http_request( $method => $url, key => value... )
Like http_request from L<AnyEvent::HTTP>, but blocks until the request is complete and returns
the result rather than invoking a callback.
Blocking is achieved by the usage of L<Coro>, so use this only if your application is Coro-aware.
=item fetch_to_scalar( $url )
Do an HTTP GET on the given URL and return the fetched content. Croaks on error.
Note: uses L<Coro>.
=item fetch_json_data( $url )
Do an HTTP GET on the given URL, parse the fetched content as JSON and return the parsed object.
Croaks on error.
Note: uses L<Coro>.
=back
=cut
1;
|
