summaryrefslogtreecommitdiffstats
path: root/lib/WWW/Pinboard.pm
blob: 585924d8b624cf3720bcd84f745476d6e212fb89 (plain) (blame)
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
package WWW::Pinboard;
use Moose;
# ABSTRACT: https://pinboard.in/ API client

use HTTP::Tiny;
use JSON::PP;
use URI;

=head1 SYNOPSIS

  my $latest_post_sync_time = ...;
  my $api = WWW::Pinboard->new(token => $token);
  my $last_updated = $api->update->{update_time};
  if ($last_updated ge $latest_post_sync_time) {
      my @posts = @{ $api->all(fromdt => $latest_post_sync_time) };
      for my $post (@posts) {
          ...;
      }
  }

=head1 DESCRIPTION

This module is a basic client for the L<https://pinboard.in/> API. It currently
provides methods for each API method in the C<posts/> namespace (patches
welcome to add support for more methods). Each method takes a hash of
arguments, which correspond to the parameters documented in the API
documentation at L<https://pinboard.in/api/>. They can also take an additional
parameter C<progress>, which will be passed to the C<data_callback> parameter
of the call to C<get> on the L<HTTP::Tiny> object.

=cut

=attr token

Pinboard API token. You can access your API token at
L<https://pinboard.in/settings/password>.

=cut

has token => (
    is       => 'ro',
    isa      => 'Str',
    required => 1,
);

=attr endpoint

URL of the API endpoint. Defaults to C<https://api.pinboard.in/v1/>.

=cut

has _endpoint => (
    is       => 'ro',
    isa      => 'Str',
    init_arg => 'endpoint',
    default  => 'https://api.pinboard.in/v1/',
);

has endpoint => (
    is      => 'ro',
    isa     => 'URI',
    lazy    => 1,
    default => sub {
        my $self = shift;
        my $uri = URI->new($self->_endpoint);
        $uri->query_form(auth_token => $self->token, format => 'json');
        return $uri;
    },
);

has ua => (
    is      => 'ro',
    isa     => 'HTTP::Tiny',
    lazy    => 1,
    default => sub { HTTP::Tiny->new },
);

has json => (
    is      => 'ro',
    isa     => 'JSON::PP',
    lazy    => 1,
    default => sub { JSON::PP->new },
);

=method update

=method add

=method delete

=method get

=method recent

=method dates

=method all

=method suggest

=cut

for my $method (qw(update add delete get recent dates all suggest)) {
    __PACKAGE__->meta->add_method($method => sub {
        my $self = shift;
        my (%args) = @_;

        my $progress = delete $args{progress};

        my $uri = $self->endpoint->clone;
        # XXX eventually support other parts of the api
        $uri->path($uri->path . 'posts/' . $method);
        $uri->query_form($uri->query_form, %args);

        my $res = $self->ua->get(
            $uri, { $progress ? (data_callback => $progress) : () }
        );
        die $res->{content} unless $res->{success};
        return $self->json->decode($res->{content});
    });
}

__PACKAGE__->meta->make_immutable;
no Moose;

=head1 BUGS

No known bugs.

Please report any bugs to GitHub Issues at
L<https://github.com/doy/www-pinboard/issues>.

=head1 SEE ALSO

L<https://pinboard.in/>

=head1 SUPPORT

You can find this documentation for this module with the perldoc command.

    perldoc WWW::Pinboard

You can also look for information at:

=over 4

=item * MetaCPAN

L<https://metacpan.org/release/WWW-Pinboard>

=item * Github

L<https://github.com/doy/www-pinboard>

=item * RT: CPAN's request tracker

L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WWW-Pinboard>

=item * CPAN Ratings

L<http://cpanratings.perl.org/d/WWW-Pinboard>

=back

=cut

1;