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
|
package Dancer2::Serializer::Mutable;
# ABSTRACT: Serialize and deserialize content based on HTTP header
$Dancer2::Serializer::Mutable::VERSION = '1.1.0';
use Moo;
use Carp 'croak';
use Encode;
use Module::Runtime 'require_module';
with 'Dancer2::Core::Role::Serializer';
use constant DEFAULT_CONTENT_TYPE => 'application/json';
has '+content_type' => ( default => DEFAULT_CONTENT_TYPE() );
my $serializer = {
'YAML' => {
to => sub { Dancer2::Core::DSL::to_yaml(@_) },
from => sub { Dancer2::Core::DSL::from_yaml(@_) },
},
'Dumper' => {
to => sub { Dancer2::Core::DSL::to_dumper(@_) },
from => sub { Dancer2::Core::DSL::from_dumper(@_) },
},
'JSON' => {
to => sub { Dancer2::Core::DSL::to_json(@_) },
from => sub { Dancer2::Core::DSL::from_json(@_) },
},
};
has mapping => (
is => 'ro',
lazy => 1,
default => sub {
my $self = shift;
if ( my $mapping = $self->config->{mapping} ) {
# initialize non-default serializers
for my $s ( values %$mapping ) {
# TODO allow for arguments via the config
next if $serializer->{$s};
my $serializer_class = "Dancer2::Serializer::$s";
require_module($serializer_class);
my $serializer_object = $serializer_class->new;
$serializer->{$s} = {
from => sub { shift; $serializer_object->deserialize(@_) },
to => sub { shift; $serializer_object->serialize(@_) },
};
}
return $mapping;
}
return {
'text/x-yaml' => 'YAML',
'text/html' => 'YAML',
'text/x-data-dumper' => 'Dumper',
'text/x-json' => 'JSON',
'application/json' => 'JSON',
}
},
);
sub serialize {
my ( $self, $entity ) = @_;
# Look for valid format in the headers
my $format = $self->_get_content_type('accept');
# Match format with a serializer and return
$format and return $serializer->{$format}{'to'}->(
$self, $entity
);
# If none is found then just return the entity without change
return $entity;
}
sub deserialize {
my ( $self, $content ) = @_;
my $format = $self->_get_content_type('content_type');
$format and return $serializer->{$format}{'from'}->($self, $content);
return $content;
}
sub _get_content_type {
my ($self, $header) = @_;
if ( $self->has_request ) {
# Search for the first HTTP header variable which specifies
# supported content. Both content_type and accept are checked
# for backwards compatibility.
foreach my $method ( $header, qw<content_type accept> ) {
if ( my $value = $self->request->header($method) ) {
if ( my $serializer = $self->mapping->{$value} ) {
$self->set_content_type($value);
return $serializer;
}
}
}
}
# If none if found, return the default, 'JSON'.
$self->set_content_type( DEFAULT_CONTENT_TYPE() );
return 'JSON';
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::Serializer::Mutable - Serialize and deserialize content based on HTTP header
=head1 VERSION
version 1.1.0
=head1 SYNOPSIS
# in config.yml
serializer: Mutable
engines:
serializer:
Mutable:
mapping:
'text/x-yaml' : YAML
'text/html' : YAML
'text/x-data-dumper' : Dumper
'text/x-json' : JSON
'application/json' : JSON
# in the app
put '/something' => sub {
# deserialized from request
my $name = param( 'name' );
...
# will be serialized to the most
# fitting format
return { message => "user $name added" };
};
=head1 DESCRIPTION
This serializer will try find the best (de)serializer for a given request.
For this, it will pick the first valid content type found from the following list
and use its related serializer.
=over
=item
The B<content_type> from the request headers
=item
the B<accept> from the request headers
=item
The default is B<application/json>
=back
The content-type/serializer mapping that C<Dancer2::Serializer::Mutable>
uses is
serializer | content types
----------------------------------------------------------
Dancer2::Serializer::YAML | text/x-yaml, text/html
Dancer2::Serializer::Dumper | text/x-data-dumper
Dancer2::Serializer::JSON | text/x-json, application/json
A different mapping can be provided via the config file. For example,
the default mapping would be configured as
engines:
serializer:
Mutable:
mapping:
'text/x-yaml' : YAML
'text/html' : YAML
'text/x-data-dumper' : Dumper
'text/x-json' : JSON
'application/json' : JSON
The keys of the mapping are the content-types to serialize,
and the values the serializers to use. Serialization for C<YAML>, C<Dumper>
and C<JSON> are done using internal Dancer mechanisms. Any other serializer will
be taken to be as Dancer2 serialization class (minus the C<Dancer2::Serializer::> prefix)
and an instance of it will be used
to serialize/deserialize data. For example, adding L<Dancer2::Serializer::XML>
to the mapping would be:
engines:
serializer:
Mutable:
mapping:
'text/x-yaml' : YAML
'text/html' : YAML
'text/x-data-dumper' : Dumper
'text/x-json' : JSON
'text/xml' : XML
=head2 INTERNAL METHODS
The following methods are used internally by C<Dancer2> and are not made
accessible via the DSL.
=head2 serialize
Serialize a data structure. The format it is serialized to is determined
automatically as described above. It can be one of YAML, Dumper, JSON, defaulting
to JSON if there's no clear preference from the request.
=head2 deserialize
Deserialize the provided serialized data to a data structure. The type of
serialization format depends on the request's content-type. For now, it can
be one of YAML, Dumper, JSON.
=head2 content_type
Returns the content-type that was used during the last C<serialize> /
C<deserialize> call. B<WARNING> : you must call C<serialize> / C<deserialize>
before calling C<content_type>. Otherwise the return value will be C<undef>.
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023 by Alexis Sukrieh.
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
|
