From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

LANCEW / WebService-Readwise-0.002-TRIAL / lib / WebService / Readwise.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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

              
use strict;
use warnings;
use v5.010;
package WebService::Readwise;
# ABSTRACT: Perl module to interact with Readwise.io API
use HTTP::Tiny;
use JSON::MaybeXS;
use Moo;
use namespace::clean;
has token => (
    is       => 'ro',
    required => 0,
    default  => sub { return $ENV{WEBSERVICE_READWISE_TOKEN} },
);
has base_url => (
    is      => 'ro',
    default => sub {'https://readwise.io/api/v2/'},
);
has http => (
    is      => 'ro',
    default => sub {
        return HTTP::Tiny->new;
    },
);
sub auth {
    my $self = shift;
    my $response = $self->http->request(
        'GET',
        $self->base_url . 'auth/',
        { headers => { Authorization => "Token $self->{token}", }, }
    );
    return $response->{status};
}
sub export {
    my ( $self, %params ) = @_;
    my $path = 'export/';
    if ( %params && $params{'pageCursor'} ) {
        $path .= '?pageCursor=' . $params{pageCursor};
    }
    my $response = $self->http->request(
        'GET',
        $self->base_url . $path,
        { headers => { Authorization => "Token $self->{token}", }, }
    );
    if ( !$response->{success} ) {
        return 'Response error';
    }
    my $json = decode_json $response->{content};
    return $json;
}
sub highlights {
    my $self = shift;
    my $response = $self->http->request(
        'GET',
        $self->base_url . 'highlights/',
        { headers => { Authorization => "Token $self->{token}", }, }
    );
    if ( !$response->{success} ) {
        return 'Response error';
    }
    my $json = decode_json $response->{content};
    return $json;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
WebService::Readwise - Perl module to interact with Readwise.io API
=head1 VERSION
version 0.002
=head1 SYNOPSIS
    use WebService::Readwise;
    my $readwise = WebService::Readwise->new(token => 'readwise_token_foo');
    my $highlights = $readwise->highlights;
    say 'First highlight: ' . $highlights->{results}[0]{text};
=head1 DESCRIPTION
Access the L<https://readwise.io/api_deets> API.
=head1 ATTRIBUTES
=head2 token( $token )
API token from readwise.io.
Obtain thihs from L<https://readwise.io/access_token>
If not provided can be obtained from WEBSERVICE_READWISE_TOKEN environment variable
=head2 base_url( $url )
URL for the Readwise API.
Defaults if not specified
=head2 http( )
Provides L<HTTP::Tiny> object. Used to get data from API.
=head1 METHODS
=head2 auth( )
Returns 204 if you have a valid token
Makes a GET request to https://readwise.io/api/v2/auth/
=head2 export( pageCursor => $cursor)
Returns data structure containing a paginated record of all your Readwise data.
Optionally,the pageCursor parameter can be used to retrieve additionalpages of results
Makes a GET request to https://readwise.io/api/v2/export/
=head2 highlights( )
Returns array of highlights
Makes a GET request to https://readwise.io/api/v2/highlight/
=head1 AUTHOR
Lance Wicks <lw@judocoach.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023 by Lance Wicks.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut