File Coverage

blib/lib/Astro/ADS.pm
Criterion Covered Total %
statement 9 9 100.0
branch n/a
condition n/a
subroutine 3 3 100.0
pod n/a
total 12 12 100.0


line stmt bran cond sub pod time code
1             package Astro::ADS;
2              
3             =head1 NAME
4              
5             Astro::ADS - An object orientated interface to NASA's ADS database
6              
7             =head1 DESCRIPTION
8              
9             This module does nothing, and is here as a placeholder in case of need. The
10             user interface to the goodness wrapped in the ADS package can be found in
11             the L module.
12              
13             =head1 REVISION
14              
15             B The API for the ADS is changing and the current interface will disappear.
16             This will be the final revision of this version of Astro::ADS. The new API
17             (described at L ) will be implemented
18             as version 2.0 sometime in 2015.
19              
20             $Id: ADS.pm,v 1.26 2014/06/15 bjd Exp $
21             $Id: ADS.pm,v 1.25 2013/08/06 bjd Exp $
22             $Id: ADS.pm,v 1.3 2004/01/28 09:04:42 aa Exp $
23              
24             =head1 METHODS
25              
26             The Astro::ADS module itself has no methods, and is just a placeholder
27             module, see L for the actual interface.
28              
29             =head1 COPYRIGHT
30              
31             Copyright (C) 2001-2003 University of Exeter. All Rights Reserved.
32              
33             This program was written as part of the eSTAR project and is free software;
34             you can redistribute it and/or modify it under the terms of the GNU Public
35             License.
36              
37             =head1 AUTHORS
38              
39             Alasdair Allan Eaa@astro.ex.ac.ukE,
40              
41             =head1 BUGS
42              
43             =over
44              
45             =item Followup queries using default URL
46              
47             When an B object has set the url to a non-default server,
48             the B objects it returns use the default URL in the
49             B, B, B and B methods. This
50             is likely not what you want if you are doing a lot of followup queries.
51              
52             You can re-use the original query with the followup method or use v1.21.0 or
53             above which turns the URL from an object variable to a class variable.
54              
55             =back
56              
57             =head1 TODO
58              
59             =over
60              
61             =item Document issues with ADS mirrors, proxy() and $ENV{HTTP_PROXY}
62              
63             Explain the preference to set the class variable using the ads_mirror() method
64             in Astro::ADS::Query at the top of the script so that followup queries go to
65             the expected place.
66             *NB*
67             Also note that the proxy() method is only affects one query object and
68             the user agent looks at the environment variables HTTP_PROXY and NO_PROXY to
69             the exclusion of almost all else. Once again, set $ENV{HTTP_PROXY} at the
70             top of your script for least confusion.
71              
72             =item Fix followup queries on B and B
73              
74             Followups are new query objects, so there are issues with alsoread and tableofcontents.
75             No one has noticed yet and I don't have time to fix it.
76              
77             =item Tweak make to prompt for default ADS mirror
78              
79             This is a "good" idea, but fiddly to implement. Prompt the user for one of the
80             ADS mirrors during the installation and write it into Astro::ADS::Query to save
81             setting it at the beginning of each script
82              
83             =item Error 500: handle network failures gracefully.
84              
85             Return undef instead of die()ing.
86              
87             =back
88              
89             =cut
90              
91 1     1   55581 use strict;
  1         3  
  1         37  
92 1     1   5 use warnings;
  1         2  
  1         33  
93 1     1   5 use vars qw/ $VERSION /;
  1         5  
  1         64  
94             $VERSION = '1.26';
95              
96             1;