File Coverage

blib/lib/SMS/Send/AQL.pm

Criterion	Covered	Total	%
statement	12	24	50.0
branch	0	4	0.0
condition	0	5	0.0
subroutine	4	6	66.6
pod	2	2	100.0
total	18	41	43.9

package SMS::Send::AQL;

# $Id: AQL.pm 281 2008-03-09 01:54:50Z davidp $

use strict;
use warnings;
use SMS::AQL;
our $VERSION = '0.04';
use base 'SMS::Send::Driver';




=head1 NAME

SMS::Send::AQL - SMS::Send driver to send messages via AQL (www.aql.com)

=head1 SYNOPSIS

  use SMS::Send;

  # Create a sender
  my $sender = SMS::Send->new('AQL',
        _login    => 'your_aql_username',
        _password => 'your_aql_password',
        _sender   => 'sender number',
  );

  # Send a message
  my $sent = $sender->send_sms(
        text => 'This is a test message',
        to   => '[phone]',
  );

  if ( $sent ) {
        print "Message sent ok\n";
  } else {
        print "Failed to send message\n";
  }


=head1 DESCRIPTION

A driver for SMS::Send to send SMS text messages via AQL (www.aql.com)

This is not intended to be used directly, but instead called by SMS::Send
(see synopsis above for a basic illustration, and see SMS::Send's documentation
for further information).



=head1 METHODS

=over 4

=item new

Constructor, takes argument pairs passed by SMS::Send, returns an SMS::Send::AQL
object.  See usage synopsis for example, and see SMS::Send documentation for
further info on using SMS::Send drivers.

=cut

sub new {

    my ($class, %args) = @_;

    my $self = bless { %args }, $class;

    # Previous versions of this module documented _username as the param name
    # for the username; unfortunately there's no "standard" for SMS::Send
    # drivers, but the general concensus seems to be to use _login, but we'll
    # continue to support _username too.
    if (!exists $args{_login} && exists $args{_username}) {
        $args{_login} = delete $args{_username};
    }

    if (grep { ! $args{$_} } qw(_login _password)) {
        die "_login (or _username) and _password required";
    }



    $self->{aql} = new SMS::AQL({
        username => $args{_login},
        password => $args{_password},
        options => {
            sender => $args{_sender} || 'SMS::AQL',
        },
    });

    return $self;

}



=item send_sms

Send the message - see SMS::Send for details.

=cut

sub send_sms {

    my ($self, %args) = @_;

    # AQL's gateway won't accept numbers in the format [phone],
    # it wants to see 00441234567890 instead:
    $args{to} =~ s/^\+/00/;


    return $self->{aql}->send_sms(@args{ qw (to text) });

}



=back

=head1 AUTHOR

David Precious, [e-mail]


=head1 COPYRIGHT AND LICENSE

Copyright (C) 2008-2011  by David Precious

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.7 or,
at your option, any later version of Perl 5 you may have available.


=cut



1;
__END__