File: Request.pm

package info (click to toggle)
libnet-amazon-s3-perl 0.991-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,620 kB
  • sloc: perl: 9,906; makefile: 20
file content (217 lines) | stat: -rw-r--r-- 4,909 bytes parent folder | download | duplicates (2)
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
package Net::Amazon::S3::Request;
$Net::Amazon::S3::Request::VERSION = '0.991';
use Moose 0.85;
use MooseX::StrictConstructor 0.16;
use Moose::Util::TypeConstraints;
use Regexp::Common qw /net/;

# ABSTRACT: Base class for request objects

use Net::Amazon::S3::Constraint::ACL::Canned;

enum 'LocationConstraint' => [
	# https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
	# https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html#API_CreateBucket_RequestSyntax
	'af-south-1',
	'ap-east-1',
	'ap-northeast-1',
	'ap-northeast-2',
	'ap-northeast-3',
	'ap-south-1',
	'ap-southeast-1',
	'ap-southeast-2',
	'ca-central-1',
	'cn-north-1',
	'cn-northwest-1',
	'EU',
	'eu-central-1',
	'eu-north-1',
	'eu-south-1',
	'eu-west-1',
	'eu-west-2',
	'eu-west-3',
	'me-south-1',
	'sa-east-1',
	'us-east-1',
	'us-east-2',
	'us-gov-east-1',
	'us-gov-west-1',
	'us-west-1',
	'us-west-2',
];

subtype 'MaybeLocationConstraint'
	=> as 'Maybe[LocationConstraint]'
	;

# maintain backward compatiblity with 'US' and 'EU' values
my %location_constraint_alias = (
	US => 'us-east-1',
	EU => 'eu-west-1',
);

enum 'LocationConstraintAlias' => [ keys %location_constraint_alias ];

coerce 'LocationConstraint'
	=> from 'LocationConstraintAlias'
	=> via { $location_constraint_alias{$_} }
	;

coerce 'MaybeLocationConstraint'
	=> from 'LocationConstraintAlias'
	=> via { $location_constraint_alias{$_} }
	;

# To comply with Amazon S3 requirements, bucket names must:
# Contain lowercase letters, numbers, periods (.), underscores (_), and dashes (-)
# Start with a number or letter
# Be between 3 and 255 characters long
# Not be in an IP address style (e.g., "192.168.5.4")

subtype 'BucketName1' => as 'Str' => where {
	$_ =~ /^[a-zA-Z0-9._-]+$/;
} => message {
	"Bucket name ($_) must contain lowercase letters, numbers, periods (.), underscores (_), and dashes (-)";
};

subtype 'BucketName2' => as 'BucketName1' => where {
	$_ =~ /^[a-zA-Z0-9]/;
} => message {
	"Bucket name ($_) must start with a number or letter";
};

subtype 'BucketName3' => as 'BucketName2' => where {
	length($_) >= 3 && length($_) <= 255;
} => message {
	"Bucket name ($_) must be between 3 and 255 characters long";
};

subtype 'BucketName' => as 'BucketName3' => where {
	$_ !~ /^$RE{net}{IPv4}$/;
} => message {
	"Bucket name ($_) must not be in an IP address style (e.g., '192.168.5.4')";
};

has 's3' => ( is => 'ro', isa => 'Net::Amazon::S3', required => 1 );

has '_http_request_content' => (
	is => 'ro',
	init_arg => undef,
	isa => 'Maybe[Str]',
	lazy => 1,
	builder => '_request_content',
);

__PACKAGE__->meta->make_immutable;

sub _request_content {
	'';
}

sub _request_path {
	'';
}

sub _request_headers {
}

sub _request_query_action {
}

sub _request_query_params {
}

sub _request_query_string {
	my ($self) = @_;

	my %query_params = $self->_request_query_params;

	my @parts = (
		($self->_request_query_action) x!! $self->_request_query_action,
		map "$_=${\ $self->s3->_urlencode( $query_params{$_} ) }", sort keys %query_params,
	);

	return '' unless @parts;
	return '?' . join '&', @parts;
}

sub _http_request_path {
	my ($self) = @_;

	return $self->_request_path . $self->_request_query_string;
}

sub _http_request_headers {
	my ($self) = @_;

	return +{ $self->_request_headers };
}

sub _build_signed_request {
	my ($self, %params) = @_;

	$params{path}       = $self->_http_request_path     unless exists $params{path};
	$params{method}     = $self->_http_request_method   unless exists $params{method};
	$params{headers}    = $self->_http_request_headers  unless exists $params{headers};
	$params{content}    = $self->_http_request_content  unless exists $params{content} or ! defined $self->_http_request_content;

	# Although Amazon's Signature 4 test suite explicitely handles // it appears
	# it's inconsistent with their implementation so removing it here
	$params{path} =~ s{//+}{/}g;

	return Net::Amazon::S3::HTTPRequest->new(
		%params,
		s3 => $self->s3,
		$self->can( 'bucket' ) ? (bucket => $self->bucket) : (),
	);
}

sub _build_http_request {
	my ($self, %params) = @_;

	return $self->_build_signed_request( %params )->http_request;
}

sub http_request {
	my $self = shift;

	return $self->_build_http_request;
}

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Net::Amazon::S3::Request - Base class for request objects

=head1 VERSION

version 0.991

=head1 SYNOPSIS

  # do not instantiate directly

=head1 DESCRIPTION

This module is a base class for all the Net::Amazon::S3::Request::*
classes.

=head1 AUTHOR

Branislav ZahradnĂ­k <barney@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2022 by Amazon Digital Services, Leon Brocard, Brad Fitzpatrick, Pedro Figueiredo, Rusty Conover, Branislav ZahradnĂ­k.

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