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
|
=encoding UTF-8
=head1 NAME
WebService::S3::Tiny - Perl module for using S3 or compatible APIs
=for html
<a href=https://travis-ci.org/cv-library/WebService-S3-Tiny>
<img src=https://api.travis-ci.org/cv-library/WebService-S3-Tiny.svg>
</a>
<a href=https://coveralls.io/r/cv-library/WebService-S3-Tiny>
<img src=https://coveralls.io/repos/cv-library/WebService-S3-Tiny/badge.svg>
</a>
<a href=https://metacpan.org/pod/WebService::S3::Tiny>
<img src=https://badge.fury.io/pl/WebService-S3-Tiny.svg>
</a>
<a href=https://github.com/cv-library/WebService-S3-Tiny/issues>
<img src=https://img.shields.io/github/issues/cv-library/WebService-S3-Tiny.svg>
</a>
=head1 SYNOPSIS
use WebService::S3::Tiny;
my $s3 = WebService::S3::Tiny->new(
access_key => 'foo',
host => 'http://localhost:1337',
secret_key => 'bar',
);
=head1 METHODS
All the request methods of the form {get,put,delete,head}_{bucket,object} can
also be called with the C<_url> suffix to generate a pre-signed URL for the
corresponding call.
These URL methods take almost the same arguments as their request counterparts,
with the difference that they take an optional argument to indicate the lifetime
of the URL in seconds. This argument always comes after the bucket and object, and
before the header and parameter references. This value cannot be greater than
604800 (= one week).
=head2 new
WebService::S3::Tiny->new(
access_key => ..., # required
host => ..., # required
region => ..., # optional, defaults to "us-east-1"
secret_key => ..., # required
service => ..., # optional, defaults to "s3"
ua => ..., # optional, defaults to HTTP::Tiny->new
);
=head2 delete_bucket
$s3->delete_bucket($bucket);
$s3->delete_bucket($bucket, \%headers);
=head2 get_bucket
$s3->get_bucket($bucket);
$s3->get_bucket($bucket, \%headers);
$s3->get_bucket($bucket, \%headers, \%parameters);
=head2 head_bucket
$s3->head_bucket($bucket);
$s3->head_bucket($bucket, \%headers);
=head2 put_bucket
$s3->put_bucket($bucket);
$s3->put_bucket($bucket, \%headers);
=head2 delete_object
$s3->delete_object($bucket, $object);
$s3->delete_object($bucket, $object, \%headers);
=head2 get_object
$s3->get_object($bucket, $object);
$s3->get_object($bucket, $object, \%headers);
$s3->get_object($bucket, $object, \%headers, \%parameters);
=head2 head_object
$s3->head_object($bucket, $object);
$s3->head_object($bucket, $object, \%headers);
=head2 put_object
$s3->put_object($bucket, $object, $content);
$s3->put_object($bucket, $object, $content, \%headers);
# Set foo/bar to "qux"
$s3->put_object('foo', 'bar', 'qux');
# Copy foo/bar to foo/baz
$3->put_object('foo', 'baz', undef, { 'x-amz-copy-source' => 'foo/bar' });
=head2 request
$s3->request($method, $bucket, $object, $content, \%headers, \%parameters);
=head2 delete_bucket_url
$s3->delete_bucket_url($bucket, $expires);
$s3->delete_bucket_url($bucket, $expires, \%headers);
=head2 get_bucket_url
$s3->get_bucket_url($bucket, $expires);
$s3->get_bucket_url($bucket, $expires, \%headers);
$s3->get_bucket_url($bucket, $expires, \%headers, \%parameters);
=head2 head_bucket_url
$s3->head_bucket_url($bucket, $expires);
$s3->head_bucket_url($bucket, $expires, \%headers);
=head2 put_bucket_url
$s3->put_bucket_url($bucket, $expires);
$s3->put_bucket_url($bucket, $expires, \%headers);
=head2 delete_object_url
$s3->delete_object_url($bucket, $object, $expires);
$s3->delete_object_url($bucket, $object, $expires, \%headers);
=head2 get_object_url
$s3->get_object_url($bucket, $object, $expires);
$s3->get_object_url($bucket, $object, $expires, \%headers);
$s3->get_object_url($bucket, $object, $expires, \%headers, \%parameters);
=head2 head_object_url
$s3->head_object_url($bucket, $object, $expires);
$s3->head_object_url($bucket, $object, $expires, \%headers);
=head2 put_object_url
$s3->put_object_url($bucket, $object, $expires);
$s3->put_object_url($bucket, $object, $expires, \%headers);
=head2 signed_url
$s3->signed_url($method, $bucket, $object, $expires, \%headers, \%parameters );
=head1 COPYRIGHT AND LICENSE
Copyright © 2018 CV-Library Ltd.
This is free software; you can redistribute it and/or modify it under the
same terms as Perl itself.
|