File Coverage

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

Criterion	Covered	Total	%
statement	27	69	39.1
branch	3	30	10.0
condition	0	6	0.0
subroutine	8	13	61.5
pod	2	2	100.0
total	40	120	33.3

package SMS::Send::IN::eSMS;

# ABSTRACT: SMS::Send driver to send messages via eSMS ( http://api.esms.kerala.gov.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 eSMS
our %eSMS_error_codes = ( "401", "Credentials Error, may be invalid username or password",
   "402", "1 message submitted successfully",
   "403", "Credits not available",
   "404", "Internal Database Error",
   "405", "Internal Networking Error",
   "406", "Invalid or Duplicate numbers",
   "407", "Network Error on SMSC",
   "408", "Network Error on SMSC",
   "409", "SMSC response timed out, message will be submitted",
   "410", "Internal Limit Exceeded, Contact support",
   "411", "Sender ID not approved.",
   "412", "Sender ID not approved.",
   "413", "Suspect Spam, we do not accept these messages.",
   "414", "Rejected by varous reasons by the operator such as DND, SPAM etc" );

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

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

    # build the object
    my $self = bless {
        _endpoint  => 'http://api.esms.kerala.gov.in/fastclient/SMSclient.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, %eSMS_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(
        username      => $self->{_login},
        password      => $self->{_password},
        numbers       => $args{to},
        message       => $args{text},
		senderid      => $self->{_senderid},
    );
}

# -----------------------------------------------------
# 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 "eSMS error $ecode : $uecodes{$ecode}";
      }
  }
}

1;

__END__