NAME
MooseX::RemoteHelper - adds an attribute name to represent remote naming
VERSION
version 0.001016
SYNOPSIS
{
package Message;
use Moose 2;
extends 'MooseY::RemoteHelper::MessagePart';
with 'MooseX::RemoteHelper::CompositeSerialization';
use MooseX::RemoteHelper;
use MooseX::RemoteHelper::Types qw( Bool );
has bool => (
remote_name => 'Boolean',
isa => Bool,
is => 'ro',
coerce => 1,
serializer => sub {
my ( $attr, $instance ) = @_;
return $attr->get_value( $instance ) ? 'Y' : 'N';
},
);
has foo_bar => (
remote_name => 'FooBar',
isa => 'Str',
is => 'ro',
required => 1,
);
has optional => (
remote_name => 'Optional',
isa => 'Str',
is => 'ro',
predicate => 'has_optional',
);
__PACKAGE__->meta->make_immutable;
}
use Try::Tiny;
# note: hardcoding is an example, more likely these values come from user
# input, or remote system input, so getting undef where you expect a str
# is more common, or enabled, where you need a bool
my $message0
= Message->new({
Boolean => 'enabled',
foo_bar => 'Baz',
optional => undef,
});
$message0->bool; # 1
$message0->has_optional; # ''
$message0->serialize; # { Boolean => 'Y', FooBar => 'Baz' }
# you probably want to handle exceptions
my $message1
= try {
Message->new({
Boolean => 'enabled',
foo_bar => undef,
});
}
catch {
# note you probably want to use Safe::Isa if you may have more
# exceptions
if ( $_->isa('MooseX::Constructor::AllErrors::Error::Constructor')
) {
foreach my $error ( $_->errors ) {
# log $error->message
}
}
};DESCRIPTION
Many Remote APIs have key names that don't look good in a perl API, such as variants of camel case or even names that you don't want to use simply because they are inconsistent with your Perl API. This module allows you to provide a remote name on your attribute. We also allow you to use the remote name as an init_arg so that you can more easily construct a response from a remote response.
How the attributes work is documented in MooseX::RemoteHelper::Meta::Trait::Attribute
for serialize read
MooseX::RemoteHelper::CompositeSerialization
This module is well tested, but the method, attribute, and module names may be subject to change as I haven't decided that I am in love with all of them. Also, suggestions welcome to that end. Version will update semantically on API change.
ACKNOWLEDGMENTS
Some of this code is based on or outright copied from MooseX::Aliases
-
for help getting the basics working and understanding what some of this code does.
BUGS
Please report any bugs or feature requests on the bugtracker website https://github.com/xenoterracide/moosex-remotehelper/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
Please see those modules/websites for more information related to this module.
AUTHOR
Caleb Cushing <xenoterracide@gmail.com>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2013 by Caleb Cushing.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)