File Coverage

blib/lib/SMS/Send/IN/Unicel.pm

Criterion	Covered	Total	%
statement	27	69	39.1
branch	2	28	7.1
condition	0	6	0.0
subroutine	8	13	61.5
pod	2	2	100.0
total	39	118	33.0

package SMS::Send::IN::Unicel;

# ABSTRACT: SMS::Send driver to send messages via Unicel (http://unicel.in/)

use 5.006;
use strict;
use warnings;
use LWP::UserAgent;
use URI::Escape;

use base 'SMS::Send::Driver';

our $VERSION = '0.01'; # VERSION
our $AUTHORITY = 'cpan:INDRADG'; # AUTHORITY

# setup error code lookup list for Unicel
our %unicel_error_codes = ( "0x200", "Invalid Username or Password",
   "0x201", "Account suspended due to one of several defined reasons",
   "0x202", "Invalid Source Address/Sender ID. As per GSM standard, the sender ID should be within 11 characters",
   "0x203", "Message length exceeded (more than 160 characters) if concat is set to 0 Message",
   "0x204", "Message length exceeded (more than 459 characters) in concat is set to 1",
   "0x205", "DRL URL is not set",
   "0x206", "Only the subscribed service type can be accessed - make sure of the service type you are trying to connect with",
   "0x207", "Invalid Source IP - kindly check if the IP is responding",
   "0x208", "Account deactivated/expired",
   "0x209", "Invalid message length (less than 160 characters) if concat is set to 1",
   "0x210", "Invalid Parameter values",
   "0x211", "Invalid Message Length (more than 280 characters)",
   "0x212", "Invalid Message Length",
   "0x213", "Invalid Destination Number" );

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

    # check we have an username and password
    die "Username needs to be passed as 'uname'" unless ( $args{_login}  );
    die "Password needs to be passed as 'pass'" unless ( $args{_password} );

    # build the object
    my $self = bless {
        _endpoint  => 'https://unicel.in/SendSMS/sendmsg.php',
        _debug     => 0,
        %args
    }, $class;

    # get an LWP user agent ready
    $self->{ua} = LWP::UserAgent->new;

    return $self;
}

sub _send_method {
    my ( $self, @args ) = @_;

    my @params;
    while (@args) {
        my $key = shift @args;
        my $val = shift @args;
        push( @params, join( '=', uri_escape($key), uri_escape($val) ) );
        print STDERR ">>>     Arg $key = $val\n" if ( $self->{_debug} );
    }
    my $url = join( '?', $self->{_endpoint}, join( '&', @params ) );
    print STDERR ">>> GET $url\n" if ( $self->{_debug} );

    my $res = $self->{ua}->get($url);

    printf STDERR "<<< Status:  %s\n<<< Content: %s\n", $res->code, $res->content if ( $self->{_debug} );

    my $errorbroker = $self->_ERRORHANDLER ( $res, %unicel_error_codes );

    die $res->status_line unless ( $res->is_success );

    return $res;
}

sub send_sms {

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

    # check for message for 160 char limit
    my $text = $self->_MESSAGETEXT (  $args{text} );

    # check destination number for well-formedness under NNP 2003 schema
    my $to = $self->_TO ( $args{to} );

    $self->_send_method(
        uname      => $self->{_login},
        pass       => $self->{_password},
        dest       => $args{to},
        msg        => $args{text},
    );
}

# -----------------------------------------------------
# internal sanitization routines
# -----------------------------------------------------

sub _MESSAGETEXT {
  my ( $self, $text ) = @_;
  use bytes;
  die "Message length over limit. Max length is 160 characters" unless ( length($text) <= 160 );
} # check for 160 char length of message text

# As per National Numbering Plan 2003, Indian mobile phone numbers have to be in
# [9|8|7]XXXXXXXXX format. So we need to sanitize our input. The driver expects
# number string in 91XXXXXXXXXX format

sub _TO {
  my ( $self, $dest ) = @_;

  my $checkseries;
  my $countrycode;

  # strip out NaN characters
  $dest =~ s/[^\d]//g;

  # strip leading zero as some have the habit of inputing numbers as 0XXXXXXXXXX
  $dest =~ s/^0+//g;

  # check destination number length and format for well-formedness and fix common issues.
  if ( length($dest) == 12 or length($dest) == 10 ) {
  	if ( length($dest) == 12 ) {
	    $countrycode = substr $dest, 0, 2;
	    die "Country code incorrect, needs to be 91 for India" unless ( $countrycode eq '91' );
        }
	if ( length($dest) == 10 ) {
	    $countrycode = "91";
	    $dest = $countrycode . $dest;	#bring it up to 91XXXXXXXXXX
	}

	# check for 9,8,7 series numbering under NNP 2003
        $checkseries = substr $dest, 2, 1;
        die "Invalid phone number as per National Numbering Plan 2003" unless ( $checkseries =~ /[9|8|7]/ );
  } else {
        die "Invalid phone number format";
  }
  return $dest;
}

sub _ERRORHANDLER {
  my ( $self, $res, %uecodes ) = @_;

  my $res_content = $res->content;

  # check for unique MID (message ID) signifying a successful transaction

  if ( $res_content =~ /^[0-9]+$/  and  length( $res_content ) == 19 ) {
      return "Successfully transmitted with MID $res_content\n";
  } else {
      my $ecode = substr $res_content, 0, 5;
      if ( $uecodes{$ecode} ) {
	die "Unicel error $ecode : $uecodes{$ecode}";
      }
  }
}

1;

__END__