The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

DUFFEE / Astro-ADS-1.90 / lib / Astro / ADS.pm 

            

              
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

              
package Astro::ADS;
# ABSTRACT: Perl library to connect with the Harvard Astrophysical Data Service
# https://ads.harvard.edu/
$Astro::ADS::VERSION = '1.90';
use Moo;
use Carp;
use Data::Dumper::Concise;
use Feature::Compat::Try;
use Mojo::Base -strict;
use Mojo::URL;
use Mojo::UserAgent;
no warnings 'experimental'; # suppress warning for native perl 5.36 try/catch
#use constant SESSION_DURATION_SECS => 3600; # 60 min
my $DEBUG = 0;
has ua    => ( is => 'lazy' );
has proxy => ( is => 'lazy' );
has base_url => (
    is      => 'ro',
    default => sub { Mojo::URL->new('https://api.adsabs.harvard.edu/v1/') },
);
sub _build_ua {
    my ($self) = @_;
    return Mojo::UserAgent->new;
}
sub _build_proxy {
    my ($self, $proxy) = @_;
    $self->ua->proxy->https( $proxy );
    return $proxy;
}
sub get_response {
    my ($self, $url) = @_;
    my $tx = $self->ua->build_tx( GET => $url );
    $tx->req->headers->authorization( 'Bearer ' . $ENV{ADS_DEV_KEY} );
    warn $tx->req->to_string if $DEBUG;
    
    try { $tx = $self->ua->start($tx) }
    catch ($error) {
        carp "Got this error: ", $error;
    }
    my $res;
    try { $res = $tx->result } # call to result dies on connection error
    catch ($error) {
        carp "Connection error: ", $error;
        return;
    }
    if    ($res->is_success)  { warn $res->body if $DEBUG > 1 }
    elsif ($res->is_error)    { carp 'HTTP Error: ', $res->message }
    elsif ($res->code == 301) { carp 'Redirected: ', $res->headers->location if $DEBUG }
    return $res;
}
sub post_response {
    my ($self, $url) = @_;
    my $tx = $self->ua->build_tx( POST => $url );
    $tx->req->headers->authorization( 'Bearer ' . $ENV{ADS_DEV_KEY} );
    carp $tx->req->to_string if $DEBUG;
    
    try { $tx = $self->ua->start($tx) }
    catch ($error) {
        carp "Got this error: ", $error;
    }
    return $tx->result;
}
1; # Perl is my Igor
__END__
=pod
=encoding UTF-8
=head1 NAME
Astro::ADS - Perl library to connect with the Harvard Astrophysical Data Service
=head1 VERSION
version 1.90
=head1 SYNOPSIS
    my $client = Astro::ADS->new({
        proxy => '...', # your web proxy
    });
    my $search = $client->search( q => 'star', fl => 'bibcode' );
=head1 DESCRIPTION
Astro::ADS is the base class for accessing the ADS API.
It handles methods common to all services such as setting the UserAgent and
including your API key in all request headers.
=head1 AUTHOR
Boyd Duffee <duffee@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2025 by Boyd Duffee.
This is free software, licensed under:
  The MIT (X11) License
=cut