1WWW::GoodData::Agent(3)User Contributed Perl DocumentatioWnWW::GoodData::Agent(3)
2
3
4

NAME

6       WWW::GoodData::Agent - HTTP client for GoodData JSON-based API
7

SYNOPSIS

9         use WWW::GoodData::Agent;
10         my $ua = new WWW::GoodData::Agent;
11         my $metadata = $ua->get ('/md');
12

DESCRIPTION

14       WWW::GoodData::Agent is HTTP user agent that makes it easy for follow
15       specifics of the GoodData service API, transparently handles conversion
16       to and from JSON content type and recognizes and handles various kinds
17       of exceptions and error states.
18
19       It is a subclass of LWP::UserAgent and follows its semantics unless
20       documented otherwise.
21

PROPERTIES

23       root
24           URI object pointing to root of the service API.
25
26           This is used to resolve relative request paths.
27

METHODS

29       new ROOT, PARAMS
30           Creates a new agent instance. First argument is root of the service
31           API, the rest is passed to LWP::UserAgent as is.
32
33           Compared to stock LWP::UserAgent, it has a memory-backed cookie
34           storage and sets the Accept header to prefer JSON content.
35
36       post URI, BODY, PARAMS
37           Constructs and issues a POST request.
38
39           Compared to stock LWP::UserAgent, the extra body parameter is
40           encoded into JSON and set as request content, which is the only way
41           to set the request content.
42
43           The rest of parameters are passed to LWP::UserAgent untouched.
44
45       put URI, BODY, PARAMS
46           Constructs and issues a PUT request.
47
48           Compared to stock LWP::UserAgent, the extra body parameter is
49           encoded into JSON and set as request content, which is the only way
50           to set the request content.
51
52           The rest of parameters are passed to LWP::UserAgent untouched.
53
54       delete URI
55           Convenience method for constructing and issuing a DELETE request.
56
57       request PARAMS
58           This call is common for all request types.
59
60           While API is same as stock LWP::UserAgent, relative URIs are
61           permitted and extra content processing is done with the response.
62
63           Namely, errors are either handled or turned into exceptions and
64           known content types (JSON) are decoded.
65

SEE ALSO

67       •   <https://secure.gooddata.com/gdc/> -- Browsable GoodData API
68
69       •   LWP::UserAgent -- Perl HTTP client
70

72       Copyright 2011, 2012, 2013 Lubomir Rintel
73
74       Copyright 2012 Jan Orel
75
76       This program is free software; you can redistribute it and/or modify it
77       under the same terms as Perl itself.
78

AUTHOR

80       Lubomir Rintel "lkundrak@v3.sk"
81
82
83
84perl v5.36.0                      2023-01-20           WWW::GoodData::Agent(3)
Impressum