—package
Dancer2::Serializer::Mutable;
# ABSTRACT: Serialize and deserialize content based on HTTP header
$Dancer2::Serializer::Mutable::VERSION
=
'0.206000_01'
;
# TRIAL
use
Encode;
has
'+content_type'
=> (
default
=>
sub
{
'application/json'
} );
my
$formats
= {
'text/x-yaml'
=>
'YAML'
,
'text/html'
=>
'YAML'
,
'text/x-data-dumper'
=>
'Dumper'
,
'text/x-json'
=>
'JSON'
,
'application/json'
=>
'JSON'
,
};
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(
@_
) },
},
};
sub
support_content_type {
my
(
$self
,
$ct
) =
@_
;
# FIXME: are we getting full content type?
if
(
$ct
&&
grep
+(
$_
eq
$ct
),
keys
%{
$formats
} ) {
$self
->set_content_type(
$ct
);
return
1;
}
return
0;
}
sub
serialize {
my
(
$self
,
$entity
) =
@_
;
# Look for valid format in the headers
my
$format
=
$self
->_get_content_type();
# 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
) =
@_
;
# The right content type should already be set
my
$format
=
$formats
->{
$self
->content_type};
$format
and
return
$serializer
->{
$format
}{
'from'
}->(
$self
,
$content
);
return
$content
;
}
sub
_get_content_type {
my
$self
=
shift
;
$self
->has_request or
return
;
# Search for the first HTTP header variable which
# specifies supported content.
foreach
my
$method
(
qw<content_type accept>
) {
if
(
my
$value
=
$self
->request->header(
$method
) ) {
if
(
exists
$formats
->{
$value
} ) {
$self
->set_content_type(
$value
);
return
$formats
->{
$value
};
}
}
}
# If none if found, return undef.
return
;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::Serializer::Mutable - Serialize and deserialize content based on HTTP header
=head1 VERSION
version 0.206000_01
=head1 SYNOPSIS
# in config.yml
serializer: Mutable
# 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
=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 NAME
Dancer2::Serializer::Mutable - Serialize and deserialize content using the appropriate HTTP header
(ported from Dancer)
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2017 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