File Coverage

blib/lib/WebService/MIAB.pm

Criterion	Covered	Total	%
statement	29	112	25.8
branch	0	30	0.0
condition	0	24	0.0
subroutine	10	24	41.6
pod	10	12	83.3
total	49	202	24.2

package WebService::MIAB;

use 5.006;
use strict;
use warnings;

=head1 NAME

WebService :: MIAB - MIAB (Mail in a Box) helps you manage user and aliasaddressen

=head1 VERSION

version 0.01

=cut

use version;
our $VERSION = '0.01';

use Moo;
with 'WebService::Client';

use LWP::UserAgent;
use MIME::Base64;
use Carp qw(croak);
use re qw(is_regexp);

use JSON;
my $json = JSON->new->allow_nonref;

#Alias_Address
has alias_get_uri => ( is => 'ro', default => '/mail/aliases?format=json' );
has alias_add_uri => ( is => 'ro', default => '/mail/aliases/add' );
has alias_remove_uri => ( is => 'ro', default => '/mail/aliases/remove' );

#User_Address
has user_get_uri => ( is => 'ro', default => '/mail/users?format=json');
has user_add_uri => ( is => 'ro', default => '/mail/users/add' );
has user_remove_uri => ( is => 'ro', default => '/mail/users/remove' );

#General
has host => (is => 'ro', required => 1);
has pass => ( is => 'ro', required => 1 );
has username => ( is => 'ro', required => 1 );
has '+base_url' => (
	is => 'ro',
	lazy => 1,
	builder => sub {
		my ($self) = @_;
		return 'https://'.$self->host.'/admin';
	},
);

# custom deserializer needed as the MIAB webservice doesn't return JSON for post requests
has '+deserializer' => (
    is      => 'ro',
    lazy    => 1,
    default => sub {
        my $self = shift;
        my $usejson = $self->json;
        sub {
            my ($res, %args) = @_;
			my $decoded = $res;

			if ($res->request->uri =~ /json/) {
				$decoded = $json->decode($res->content);
			}
#				else {
#					# no json request - nothing to do
#				}
			return $decoded;
        }
    },
);

################ Constructor ################
sub BUILD(){
	my ($self) = @_;
	my $empty = q{};
	my $colon = q{:};
	return $self->ua->default_header('Authorization' => 'Basic '.encode_base64($self->username.$colon.$self->pass , $empty));
}

=head1 SYNOPSIS

use WebService::MIAB;

my $MIAB = WebService::MIAB->new(
	username => '[e-mail]',
	pass => 'ThisIsThePassword',
	host => 'example.com',
);

my $users = $MIAB->get_users();
my $result = $MIAB->create_user(
	{
	email => '[e-mail]',
	password => 'EatMyShorts',
	});

=head1 DESCRIPTION

WebService::MIAB is a Perl module that manages user and alias addresses from the mail server MIAB (Mail in a Box).
The module is based on the WebService::Client module that is written from Naveed Massjouni.
You can list, create and remove user and alias addresses.

=head1 METHODES

=head2 User methods

=head3 get_user()

The get_user function returns all users which are defined in JSON format.
The function only need the Uri for gets the Users.
MIAB->get_user()

sub get_users{
	my ($self) = @_;
	my $result = $self->get($self->user_get_uri);
	return $result;
}

=cut

sub get_users{
	my ($self) = @_;
	my $result = $self->get($self->user_get_uri);
	return $result;
}

=head3 create_user($hashWithParam)

The create_user function create a new User.
The function receives the parameters email and password in form of a hash reference for creating an user.
The create_user function consists only a post command that create the user.
$MIAB->create_user(email => '[e-mail]',password => 'EatMyShorts')

sub create_user{
	my ($self,$param) = @_;
	my $result = $self->post($self->user_add_uri,
				{
					email => $param->{email},
					password => $param->{password},
				},
				headers => { 'Content-Type' => 'application/x-www-form-urlencoded' },
	);
	return $result;
}

=cut

sub create_user{
	my ($self,$param) = @_;
	my $result = $self->post($self->user_add_uri,
				{
					email => $param->{email},
					password => $param->{password},
				},
				headers => { 'Content-Type' => 'application/x-www-form-urlencoded' },
	);
	return $result;
}

=head3 remove_user($hashWithParam)

The remove_user function delete a User.
The function receives the parameters email in form of a hash reference for deleting an user.
The remove_user function consists only a post command that delete an user.
$MIAB->remove_user(email => [e-mail])

sub remove_user{
	my ($self, $param) = @_;
	my $result = $self->post($self->user_remove_uri,
				{
					email => $param->{email},
				},
				headers => { 'Content-Type' => 'application/x-www-form-urlencoded' },
	);
	return $result;
}

=cut

sub remove_user{
	my ($self, $param) = @_;
	my $result = $self->post($self->user_remove_uri,
				{
					email => $param->{email},
				},
				headers => { 'Content-Type' => 'application/x-www-form-urlencoded' },
	);
	return $result;
}

=head3 find_user($email_pattern, $domain_pattern)

The find_user function search an user.
The function receives the parameters E-Mail and Domain to search the user.
The function is_regexp checks if the given parameter are a regular expression.
The function gets with get_users () all users that are present and then filters them according to the passed parameters.
$MIAB->remove_user(email => [e-mail])

sub find_user {
	my ($self, $email_pattern, $domain_pattern) = @_;
	my @result;
	if ( !is_regexp($email_pattern) ) {
		$email_pattern = qr/$email_pattern/mxs;
	}
	if ($domain_pattern && !is_regexp($domain_pattern)) {
		$domain_pattern = qr/$domain_pattern/mxs;
	}

	my $users = $self->get_users();
	foreach ( @{$users} ) {
		if (!$domain_pattern || $_->{'domain'} =~ $domain_pattern) {
			foreach (@{$_->{'users'}}) {
				my $value = $_->{'email'};

				# filter list
				push( @result,
					grep {
						$_ && $_ =~ $email_pattern
					} ($value && 'ARRAY' eq ref $value)
						? @{$value}
						: ( $value )
				);
			}
		}
	}
	return @result;
}

=cut

sub find_user {
	my ($self, $email_pattern, $domain_pattern) = @_;
	my @result;
	if ( !is_regexp($email_pattern) ) {
		$email_pattern = qr/$email_pattern/mxs;
	}
	if ($domain_pattern && !is_regexp($domain_pattern)) {
		$domain_pattern = qr/$domain_pattern/mxs;
	}

	my $users = $self->get_users();
	foreach ( @{$users} ) {
		if (!$domain_pattern || $_->{'domain'} =~ $domain_pattern) {
			foreach (@{$_->{'users'}}) {
				my $value = $_->{'email'};

				# filter list
				push( @result,
					grep {
						$_ && $_ =~ $email_pattern
					} ($value && 'ARRAY' eq ref $value)
						? @{$value}
						: ( $value )
				);
			}
		}
	}
	return @result;

}

=head2 Alias mehtods

=head3 get_aliases()

The get_aliases function returns all Aliasaddresses for all domains which exist in Json format.
$MIAB->get_aliases()

sub get_aliases{
	my ($self) = @_;
	my $result = $self->get($self->alias_get_uri);
	return $result;
}

=cut

sub get_aliases{
	my ($self) = @_;
	my $result = $self->get($self->alias_get_uri);
	return $result;
}

=head3 get_domains()

The get_domains function returns all Domains which are defined.
$MIAB->get_domains()

sub get_domains{
	my ($self) = @_;
	my $aliases = $self->get_aliases();
	my @result;
	map {
		push( @result, $_->{'domain'} );
	} @{$aliases};
	return @result;
}

=cut

sub get_domains{
	my ($self) = @_;
	my $aliases = $self->get_aliases();
	my @result;
	map {
		push( @result, $_->{'domain'} );
	} @{$aliases};
	return @result;
}

=head3 find_forward_to_aliases($alias_pattern, $domain_pattern)

The function receives the parameters alias_pattern and domain_pattern.
The find_forward_to_aliases function contains only one function call and a transfer of parameters
MIAB->find_forward_to_aliases($alias_pattern, $domain_pattern)

sub find_forward_to_aliases {
	my ($self, $alias_pattern, $domain_pattern) = @_;
	return $self->_find_aliases_generic('forwards_to', $alias_pattern, $domain_pattern);
}

=cut

sub find_forward_to_aliases {
	my ($self, $alias_pattern, $domain_pattern) = @_;

	return $self->_find_aliases_generic('forwards_to', $alias_pattern, $domain_pattern);
}

=head3 find_permitted_sender_aliases($alias_pattern, $domain_pattern)

The function receives the parameters alias_pattern and domain_pattern.
The find_permitted_sender_aliases function contains only one function call and a transfer of parameters
MIAB->find_permitted_sender_aliases($alias_pattern, $domain_pattern)

sub find_permitted_sender_aliases {
	my ($self, $alias_pattern, $domain_pattern) = @_;
	return $self->_find_aliases_generic('permitted_senders', $alias_pattern, $domain_pattern);
}

=cut

sub find_permitted_sender_aliases {
	my ($self, $alias_pattern, $domain_pattern) = @_;

	return $self->_find_aliases_generic('permitted_senders', $alias_pattern, $domain_pattern);
}

=head3 find_aliases($alias_pattern, $domain_pattern)

The function receives the parameters alias_pattern and domain_pattern.
The find_aliases function contains only one function call and a transfer of parameters
MIAB->find_aliases($alias_pattern, $domain_pattern)

sub find_aliases {
	my ($self, $alias_pattern, $domain_pattern) = @_;
	return $self->_find_aliases_generic('address', $alias_pattern, $domain_pattern);
}

=cut

sub find_aliases {
	my ($self, $alias_pattern, $domain_pattern) = @_;

	return $self->_find_aliases_generic('address', $alias_pattern, $domain_pattern);
}

=head3 create_alias($param)

The create_alias function create a new Aliasaddress.
The function receives the parameters address and forwards_to or permitted_senders in form of a hash reference for create a Aliasaddress.
The create_alias function consists a post command that create the Aliasaddress.
$param = {
	address => '[e-mail]',
	forwards_to => ['[e-mail]','[e-mail]'],	# One of
	permitted_senders => ['[e-mail]','[e-mail]'], # these
};
$MIAB->create_alias($param);

sub create_alias{
	my ($self,$param) = @_;
	my $empty = q{};
	my $point = q{,};
	# Parameters normalizee
	if (defined $param->{forwards_to} && ref $param->{forwards_to} ne 'ARRAY')
	{
		$param->{forwards_to} = [$param->{forwards_to}];
	}
	if (defined $param->{permitted_senders} && ref $param->{permitted_senders} ne 'ARRAY')
	{
		$param->{permitted_senders} = [$param->{permitted_senders}];
	}
	# Rest-Interface Paramter generieren
	my $forward_address_for_request = defined $param->{forwards_to}
		? join ($point, @{$param->{forwards_to}})
		: $empty;
	my $permittet_senders_for_request = defined $param->{permitted_senders}
		? join ($point, @{$param->{permitted_senders}})
		: $empty;

	# At least one alias parameter must exist
	if(!length($forward_address_for_request.$permittet_senders_for_request))
	{
		croak 'forwardsaddress and permitted_sender are required';
	}

	my $result = $self->post($self->alias_add_uri,
				{
					address => $param->{address},
					forwards_to => $forward_address_for_request,
					permitted_senders => $permittet_senders_for_request,
				},
				headers => { 'Content-Type' => 'application/x-www-form-urlencoded' },
	);
	return $result;
}

=cut

sub create_alias{
	my ($self,$param) = @_;
	my $empty = q{};
	my $point = q{,};
	# parameters normalize
	if (defined $param->{forwards_to} && ref $param->{forwards_to} ne 'ARRAY'){
		$param->{forwards_to} = [$param->{forwards_to}];
	}
	if (defined $param->{permitted_senders} && ref $param->{permitted_senders} ne 'ARRAY'){
		$param->{permitted_senders} = [$param->{permitted_senders}];
	}
	# Rest-Interface Paramter generieren
	my $forward_address_for_request = defined $param->{forwards_to}
		? join ($point, @{$param->{forwards_to}})
		: $empty;
	my $permittet_senders_for_request = defined $param->{permitted_senders}
		? join ($point, @{$param->{permitted_senders}})
		: $empty;

	# One alias parameter must exist
	if(!length($forward_address_for_request.$permittet_senders_for_request)){
		croak 'forwardsaddress and permitted_sender are required';
	}

	my $result = $self->post($self->alias_add_uri,
				{
					address => $param->{address},
					forwards_to => $forward_address_for_request,
					permitted_senders => $permittet_senders_for_request,
				},
				headers => { 'Content-Type' => 'application/x-www-form-urlencoded' },
	);
	return $result;
}

=head3 remove_alias($param)

The remove_alias function delete a Aliasaddress.
The function gets in form of a hash reference the parameter address for delete a Aliasaddress.
The remove_alias function consists only a post command that delete a Aliasaddress.
$MIAB->remove_alias(address => [e-mail])

sub remove_alias{
	my ($self, $param) = @_;
	my $result = $self->post($self->alias_remove_uri,
				{
					address => $param->{address},
				},
				headers => { 'Content-Type' => 'application/x-www-form-urlencoded' }
	);
	return $result;
}

=cut

sub remove_alias{
	my ($self, $param) = @_;
	my $result = $self->post($self->alias_remove_uri,
				{
					address => $param->{address},
				},
				headers => { 'Content-Type' => 'application/x-www-form-urlencoded' }
	);
	return $result;
}

sub _find_aliases_generic {
	my ($self, $param_name, $alias_pattern, $domain_pattern) = @_;
	my @result;

	# force patterns to be a regex
	if (!is_regexp($alias_pattern)) {
		$alias_pattern = qr/$alias_pattern/mxs;
	}
	if ($domain_pattern && !is_regexp($domain_pattern)) {
		$domain_pattern = qr/$domain_pattern/mxs;
	}

	# get all aliases
	my $aliases = $self->get_aliases();

	# filter
	foreach (@{$aliases}) {
		if (!$domain_pattern || $_->{'domain'} =~ $domain_pattern)
		{
			# either $domain_pattern is undefined (param not given)
			# or the current domain matched the given $domain_pattern

			foreach (@{$_->{'aliases'}}) {
				my $value = $_->{$param_name};

				# filter list
				push( @result,
					grep {
						$_ && $_ =~ $alias_pattern
					} ($value && 'ARRAY' eq ref $value)
						? @{$value}
						: ( $value )
				);
			}
		}
	}
	return @result;
}

=head1 AUTHOR

Alexander Schneider, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.


=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc WebService::MIAB


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2018 Alexander Schneider.

This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:

L

Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


=cut

1; # End of WebService::MIAB