-
Notifications
You must be signed in to change notification settings - Fork 1
/
Upload.pm
252 lines (161 loc) · 5.43 KB
/
Upload.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
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
package WebService::ScormCloud::Service::Upload;
use Moose::Role;
with 'WebService::ScormCloud::Service';
=head1 NAME
WebService::ScormCloud::Service::Upload - ScormCloud API "upload" namespace
=head1 VERSION
Version 0.02
=cut
our $VERSION = '0.02';
=head1 SYNOPSIS
use WebService::ScormCloud;
my $ScormCloud = WebService::ScormCloud->new(
app_id => '12345678',
secret_key => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
);
my $token = $ScormCloud->getUploadToken;
my $remote_filename = $ScormCloud->uploadFile($file, $token);
my $progress = $ScormCloud->getUploadProgress($token);
my $uploaded_files = $ScormCloud->listFiles;
=head1 DESCRIPTION
This module defines L<WebService::ScormCloud> API methods in the "upload"
namespace. See L<WebService::ScormCloud> for more info.
=cut
use Carp;
requires 'process_request';
=head1 METHODS
=head2 getUploadToken
Get and return an upload token to be used with a file upload.
=cut
sub getUploadToken ## no critic (NamingConventions::Capitalization)
{
my ($self) = @_;
return $self->process_request(
{method => 'upload.getUploadToken'},
sub {
my ($response) = @_;
return $response->{token}->{id};
}
);
}
=head2 getUploadProgress ( I<token> )
Given an upload token, get progress info for the corresponding
upload.
=cut
sub getUploadProgress ## no critic (NamingConventions::Capitalization)
{
my ($self, $token) = @_;
croak 'Missing token' unless $token;
return $self->process_request(
{method => 'upload.getUploadProgress', token => $token},
sub {
my ($response) = @_;
return {} if exists $response->{empty};
return $response->{upload_progress};
}
);
}
=head2 uploadFile ( I<file> [ , I<token> ] )
Upload a file. Will generate an upload token is none is supplied.
Returns the generated destination path on the remote filesystem.
=cut
sub uploadFile ## no critic (NamingConventions::Capitalization)
{
my ($self, $file, $token) = @_;
croak 'Missing file' unless $file;
$token ||= $self->getUploadToken;
croak 'Cannot generate upload token' unless $token;
return $self->process_request(
{method => 'upload.uploadFile', token => $token},
sub {
my ($response) = @_;
return $response->{location};
},
{request_content => [file => [$file]]}
);
}
=head2 listFiles
Return a list of files that have been uploaded using the given AppID.
=cut
sub listFiles ## no critic (NamingConventions::Capitalization)
{
my ($self) = @_;
return $self->process_request(
{method => 'upload.listFiles'},
sub {
my ($response) = @_;
die "bad\n" unless exists $response->{dir};
if ($response->{dir}->{file})
{
return $response->{dir}->{file};
}
else
{
return []; # empty list
}
},
{xml_parser => {ForceArray => ['file']}}
);
}
=head2 deleteFiles ( I<file> )
Delete a file that was uploaded.
Note: This method only handles one file at a time even though the
API service can accept multiple files for deletion in a single
request.
=cut
sub deleteFiles ## no critic (NamingConventions::Capitalization)
{
my ($self, $file) = @_;
croak 'Missing file' unless $file;
return $self->process_request(
{method => 'upload.deleteFiles', file => $file},
sub {
my ($response) = @_;
die "bad\n" unless $response->{results}->[0]->{file} eq $file;
die "bad\n" unless $response->{results}->[0]->{deleted} eq 'true';
return 1;
},
{
xml_parser => {
ForceArray => ['result'],
GroupTags => {'results' => 'result',},
}
}
);
}
1;
__END__
=head1 SEE ALSO
L<WebService::ScormCloud>
=head1 AUTHOR
Larry Leszczynski, C<< <larryl at cpan.org> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-scormcloud at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-ScormCloud>. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
Patches more than welcome, especially via GitHub:
L<https://github.com/larryl/ScormCloud>
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc WebService::ScormCloud::Service::Upload
You can also look for information at:
=over 4
=item * GitHub
L<https://github.com/larryl/ScormCloud>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-ScormCloud>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/WebService-ScormCloud>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/WebService-ScormCloud>
=item * Search CPAN
L<http://search.cpan.org/dist/WebService-ScormCloud/>
=back
=head1 ACKNOWLEDGEMENTS
=head1 COPYRIGHT & LICENSE
Copyright 2010 Larry Leszczynski.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut