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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
package Net::Flowdock::Stream;
use Moose;
# ABSTRACT: Streaming API for Flowdock
use JSON;
use MIME::Base64;
use Net::HTTPS::NB;
=head1 SYNOPSIS
my $stream = Net::Flowdock::Stream->new(
token => '...',
flows => ['myorg/testing'],
);
while (1) {
if (my $event = $stream->get_next_event) {
process_event($event);
}
}
=head1 DESCRIPTION
This module implements the streaming api for
L<Flowdock|https://www.flowdock.com/>. It provides a non-blocking method which
you can call to get the next available event in the stream. You can then
integrate this method into your existing event-driven app.
=cut
=attr token
Your account's API token, for authentication. Required unless C<email> and
C<password> are provided.
=cut
has token => (
is => 'ro',
isa => 'Str',
);
=attr email
Your account's email address, for authentication. Required unless C<token> is
provided.
=cut
has email => (
is => 'ro',
isa => 'Str',
);
=attr password
Your account's password, for authentication. Required unless C<token> is
provided.
=cut
has password => (
is => 'ro',
isa => 'Str',
);
=attr flows
An arrayref of flows that should be listened to for events. Note that the flow
names must include the organization, so C<myorg/testing>, not just C<testing>.
=cut
has flows => (
traits => ['Array'],
isa => 'ArrayRef[Str]',
required => 1,
handles => {
flows => 'elements',
},
);
has socket_timeout => (
is => 'ro',
isa => 'Num',
default => 0.01,
);
has debug => (
is => 'rw',
isa => 'Bool',
default => 0,
);
has _socket => (
is => 'rw',
isa => 'Net::HTTPS::NB',
);
has _readbuf => (
traits => ['String'],
is => 'rw',
isa => 'Str',
default => '',
handles => {
_append_readbuf => 'append',
},
);
has _events => (
is => 'rw',
isa => 'ArrayRef[HashRef]', # XXX make these into objects
default => sub { [] },
);
sub BUILD {
my $self = shift;
my $auth;
if (my $token = $self->token) {
$auth = $token;
}
elsif (my ($email, $pass) = ($self->email, $self->password)) {
$auth = "$email:$pass";
}
else {
die "You must supply either your token or your email and password";
}
my $s = Net::HTTPS::NB->new(Host => 'stream.flowdock.com');
my $flows = join(',', $self->flows);
$s->write_request(
GET => "/flows?filter=$flows" =>
Authorization => 'Basic ' . MIME::Base64::encode($auth),
Accept => 'application/json',
);
my ($code, $message, %headers) = $s->read_response_headers;
die "Unable to connect: $message"
unless $code == 200;
$self->_socket($s);
}
=method get_next_event
Returns the next event that has been received in the stream. This call is
nonblocking, and will return undef if no events are currently available.
=cut
sub get_next_event {
my $self = shift;
return unless $self->_socket_is_readable;
$self->_read_next_chunk;
return $self->_process_readbuf;
}
sub _socket_is_readable {
my $self = shift;
my ($rin, $rout) = ('');
vec($rin, fileno($self->_socket), 1) = 1;
my $res = select($rout = $rin, undef, undef, $self->socket_timeout);
if ($res == -1) {
return if $!{EAGAIN} || $!{EINTR};
die "Error reading from socket: $!";
}
return if $res == 0;
return 1 if $rout;
return;
}
sub _read_next_chunk {
my $self = shift;
my $nbytes = $self->_socket->read_entity_body(my $buf, 4096);
if (!defined $nbytes) {
return if $!{EINTR} || $!{EAGAIN};
die "Error reading from server";
}
die "Disconnected" if $nbytes == 0;
return if $nbytes == -1;
$self->_append_readbuf($buf);
}
sub _process_readbuf {
my $self = shift;
if ((my $buf = $self->_readbuf) =~ s/^([^\x0d]*)\x0d//) {
my $chunk = $1;
$self->_readbuf($buf);
warn "New event:\n$chunk" if $self->debug;
return decode_json($chunk);
}
return;
}
__PACKAGE__->meta->make_immutable;
no Moose;
=head1 BUGS
No known bugs.
Please report any bugs through RT: email
C<bug-net-flowdock-stream at rt.cpan.org>, or browse to
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Flowdock-Stream>.
=head1 SEE ALSO
L<https://www.flowdock.com/>
=head1 SUPPORT
You can find this documentation for this module with the perldoc command.
perldoc Net::Flowdock::Stream
You can also look for information at:
=over 4
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Net-Flowdock-Stream>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Net-Flowdock-Stream>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Flowdock-Stream>
=item * Search CPAN
L<http://search.cpan.org/dist/Net-Flowdock-Stream>
=back
=begin Pod::Coverage
BUILD
=end Pod::Coverage
=cut
1;
|
