Initial commit -- packaging in progress

[u/jw35/ucam-sms-send.git] / build / BUILD / Ucam-SMS-Send-1.00 / blib / lib / Ucam / SMS / Send.pm

#!/usr/bin/perl

{ package Ucam::SMS::Send;

use warnings;
use strict;
use LWP::UserAgent;
use HTML::Entities;

use vars qw/$VERSION/;
$VERSION = '1.00';

sub new
{
    my $proto = shift;
    my $class = ref($proto) || $proto;
    my $self = {};
    bless ($self,$class);

    my %args = (@_);

    # Save allowed arguments in $self, ignore extraneous ones (e.g. that
    # can only be used in other calls).
    $self->{'url'} = $args{'url'};
    # The message-specific details...
    $self->{'msg'}{'token'} = $args{'token'};
    $self->{'msg'}{'bulk'} = $args{'bulk'};
    $self->{'msg'}{'truncate'} = $args{'truncate'};
    $self->{'msg'}{'long_message'} = $args{'long_message'};
    $self->{'msg'}{'test'} = $args{'test'};

    return $self;
}

sub SendMessage
{
    my $self = shift;
    my %args = (@_);

    # Set default URL for retrieving status.
    $self->{'url'} = "https://api.phone.cam.ac.uk/api/text/1/submitSMS";

    # Save allowed arguments in $self, ignore extraneous ones (e.g. that
    # can only be used in other calls or are misspelled).
    $self->{'url'} = $args{'url'} if defined $args{'url'};
    # The message-specific details...
    $self->{'msg'}{'token'} = $args{'token'} if defined $args{'token'};
    $self->{'msg'}{'number'} = $args{'number'} if defined $args{'number'};
    $self->{'msg'}{'message'} = $args{'message'} if defined $args{'message'};
    $self->{'msg'}{'bulk'} = $args{'bulk'} if defined $args{'bulk'};
    $self->{'msg'}{'truncate'} = $args{'truncate'} if defined $args{'truncate'};
    $self->{'msg'}{'long_message'} = $args{'long_message'} if defined $args{'long_message'};
    $self->{'msg'}{'test'} = $args{'test'} if defined $args{'test'};

    my $ourname = (caller(0))[3];
    die "$ourname: mandatory argument token is undefined\n" unless defined $self->{'msg'}{'token'};
    die "$ourname: mandatory argument number is undefined\n" unless defined $self->{'msg'}{'number'};
    die "$ourname: mandatory argument message is undefined\n" unless defined $self->{'msg'}{'message'};

    print "";
    my $ua = LWP::UserAgent->new;
    $ua->timeout(10);                   # max 10s for response


    my $url = $self->{'url'};
    my $response = $ua->post($url,$self->{'msg'});
    print "";                           # for breakpointing
    unless ($response->is_success)
    {
        my $msg = $self->{'msg'}{'message'};
        my $number = $self->{'msg'}{'number'};
        my $status = $response->code;
        my $message = $response->message;
        die "$0: error sending SMS message '$msg' to $number: HTTP status $status message '$message'\n";
    }

    # Parse SMS service response (HTTP response content).

    my @content = split(/\n/,$response->content);
    my %results = ();
    foreach my $line (@content)
    {
        chomp($line);
        if ($line =~ /^(\S+):\s+(.*)\s*$/)
        {
            my ($key,$value) = ($1,$2);
            $results{$1} = $2;

            $self->{'msg'}{'messageid'} = $2 if $1 eq 'Msg-ID';
#            warn "$key: $value\n";
        }
        else
        {
            warn "unrecognised result line: $line";
        }
    }

    my $status = $results{'Status'} eq 'OK';
    return ($status,%results);

}

sub GetStatus
{
    my $self = shift;
    my %args = (@_);

    # Set default URL for retrieving status.
    $self->{'url'} = "https://api.phone.cam.ac.uk/api/text/1/getMessageStatus";

    # Save allowed arguments in $self, ignore extraneous ones (e.g. that
    # can only be used in other calls or are misspelled).

    $self->{'url'} = $args{'url'} if defined $args{'url'};
    $self->{'msg'}{'token'} = $args{'token'} if defined $args{'token'};
    $self->{'msg'}{'messageid'} = $args{'messageid'} if defined $args{'messageid'};

    my $ourname = (caller(0))[3];
    die "$ourname: mandatory argument token is undefined\n" unless defined $self->{'msg'}{'token'};
    die "$ourname: mandatory argument messageid is undefined (was it a test-mode message?)\n" unless defined $self->{'msg'}{'messageid'};

    print "";
    my $ua = LWP::UserAgent->new;
    $ua->timeout(10);                   # max 10s for response

    my $url = $self->{'url'};
    my $response = $ua->post($url,$self->{'msg'});
    print "";                           # for breakpointing
    unless ($response->is_success)
    {
        my $msgid = $self->{'msg'}{'messageid'};
        my $msg = $self->{'msg'}{'message'};
        my $number = $self->{'msg'}{'number'};
        my $status = $response->code;
        my $message = $response->message;
        die "$0: error getting SMS message ID '$msgid' status: HTTP status $status message '$message'\n";
    }

    # Parse SMS service response (HTTP response content).

    my @content = split(/\n/,$response->content);
    my %results = ();
    foreach my $line (@content)
    {
        chomp($line);
        if ($line =~ /^(\S+):\s+(.*)\s*$/)
        {
            my ($key,$value) = ($1,$2);
            $results{$1} = $2;
        }
        else
        {
            warn "unrecognised result line: $line";
        }
    }


    my $status = $results{'Status'} eq 'OK';

    print "";    
    return ($status,%results);

}
#~~~
sub GetBalance
{
    my $self = shift;
    my %args = (@_);

    # Set default URL for retrieving status.
    $self->{'url'} = "https://api.phone.cam.ac.uk/api/text/1/getBalance";

    # Save allowed arguments in $self, ignore extraneous ones (e.g. that
    # can only be used in other calls or are misspelled).

    $self->{'msg'}{'token'} = $args{'token'} if defined $args{'token'};

    my $ourname = (caller(0))[3];
    die "$ourname: mandatory argument token is undefined\n" unless defined $self->{'msg'}{'token'};

    print "";
    my $ua = LWP::UserAgent->new;
    $ua->timeout(10);                   # max 10s for response

    my $url = $self->{'url'};
    my $response = $ua->post($url,$self->{'msg'});
    print "";                           # for breakpointing
    unless ($response->is_success)
    {
        my $msgid = $self->{'msg'}{'messageid'};
        my $msg = $self->{'msg'}{'message'};
        my $number = $self->{'msg'}{'number'};
        my $status = $response->code;
        my $message = $response->message;
        die "$0: error getting SMS message ID '$msgid' status: HTTP status $status message '$message'\n";
    }

    # Parse SMS service response (HTTP response content).

    my @content = split(/\n/,$response->content);
    my %results = ();
    foreach my $line (@content)
    {
        chomp($line);
        if ($line =~ /^(\S+):\s+(.*)\s*$/)
        {
            my ($key,$value) = ($1,$2);
            $results{$1} = $2;
        }
        else
        {
            warn "unrecognised result line: $line";
        }
    }


    my $status = $results{'Status'} eq 'OK';

    print "";    
    return ($status,%results);

}


#my $testmsg = Ucam::SMS::Send->new();#test => 'true');
#my $token = 'vjaa-aaqb-zlni-hwvo-rhee';
#my ($status,%results) = $testmsg->SendMessage(number => '07757080423', 
#    token => $token,
#    message => 'test message 1-2-3');
#($status,%results) = $testmsg->GetStatus(token => $token);
#print "SendMessage status: $status\n";
#foreach my $key (sort(keys(%results)))
#{
#    printf "%-11s %s\n",$key,$results{$key};
#}
#sleep(1);
#($status,%results) = $testmsg->GetStatus(token => $token);
#print "GetStatus#1: $status\n";
#foreach my $key (sort(keys(%results)))
#{
#    printf "%-11s %s\n",$key,$results{$key};
#}
#sleep(1);
#($status,%results) = $testmsg->GetStatus(token => $token);
#print "GetStatus#2: $status\n";
#foreach my $key (sort(keys(%results)))
#{
#    printf "%-11s %s\n",$key,$results{$key};
#}
#($status,%results) = $testmsg->GetBalance(token => $token);
#print "Balance status:: $status\n";
#foreach my $key (sort(keys(%results)))
#{
#    printf "%-11s %s\n",$key,$results{$key};
#}
#
#print "";


} # end of package

1;