-
Notifications
You must be signed in to change notification settings - Fork 1
/
README
112 lines (79 loc) · 3.74 KB
/
README
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
NAME
CPAN::Testers::WWW::Reports::Query::Reports
DESCRIPTION
This module queries the CPAN Testers website and retrieves a data set.
For a date request, the data set returned relates to the ids that can
be retrieved for that date. A range request will return the records for
the requested IDs.
SYNOPSIS
# establish the object
my $query = CPAN::Testers::WWW::Reports::Query::Reports->new;
# get list of ids for a particular date
my $result = $query->date(
'2012-02-08' # must be YYYY-MM-DD format
);
# $query is a hash ref
print "From: $result->{from}, To: $result->{to}, Range: $result->{range}\n";
# $result->{list} is an array of the actual ids posted for the given date.
# note that this list may not include all ids within $result->{range}.
print "List: " . join(', ',@{$result->{list}}) . "\n";
# get metabase for a range of ids
my $result = $query->range(
'20080300-20120330'
# '20120330' # just get <id>
# '20120330-' # from <id> until the latest [see caveat]
# '-20120330' # previous <n> reports up to <id> [see caveat]
# '-' # the latest <n> reports [see caveat]
);
# $result is a hash ref, with the reports ids as the top level keys
my @ids = sort keys %$result;
my $id = $ids[0];
print "id = $id, dist = '$result->{$id}{dist}', version = '$result->{$id}{version}'\n";
# get the raw data for all results, or a specific version if supplied
my $data = $query->raw;
# get the last error
my $error = $query->error;
Caveat
When using the range parameter, note that at most 2500 records will be
returned. This is to avoid accidental request for all the records!
This value may change in the future.
INTERFACE
The Constructor
· new
Instatiates the object CPAN::WWW::Testers. Requires a hash of
parameters, with 'config' being the only mandatory key. Note that
'config' can be anything that Config::IniFiles accepts for the
-file option.
Search Methods
· date
For the given date, returns a hash describing the IDs accessible
for that date.
· range
For the given range, returns the metadata records stored for those
IDs.
Data Methods
· raw
Returns the raw content returned from the server.
· error
Returns the last recorded error.
BUGS, PATCHES & FIXES
There are no known bugs at the time of this release. However, if you
spot a bug or are experiencing difficulties, that is not explained
within the POD documentation, please send bug reports and patches to
the RT Queue (see below).
Fixes are dependant upon their severity and my availablity. Should a
fix not be forthcoming, please feel free to (politely) remind me.
RT Queue -
http://rt.cpan.org/Public/Dist/Display.html?Name=CPAN::Testers::WWW::Reports::Query::Reports
SEE ALSO
CPAN::Testers::Data::Generator, CPAN::Testers::WWW::Reports
http://www.cpantesters.org/, http://stats.cpantesters.org/,
http://wiki.cpantesters.org/
Initially released during the 2012 QA Hackathon in Paris.
AUTHOR
Barbie, <barbie@cpan.org>
for Miss Barbell Productions <http://www.missbarbell.co.uk>.
COPYRIGHT AND LICENSE
Copyright (C) 2012 Barbie for Miss Barbell Productions.
This module is free software; you can redistribute it and/or
modify it under the Artistic License 2.0.