File Coverage

blib/lib/SMS/Send/Kannel/SMSbox.pm

Criterion	Covered	Total	%
statement	9	28	32.1
branch	0	8	0.0
condition	0	2	0.0
subroutine	3	8	37.5
pod	1	1	100.0
total	13	47	27.6

package SMS::Send::Kannel::SMSbox;
use strict;
use warnings;
use base qw{SMS::Send::Driver::WebService};

our $VERSION = '0.05';
our $PACKAGE = __PACKAGE__;

=head1 NAME

SMS::Send::Kannel::SMSbox - SMS::Send driver for Kannel SMSbox web service

=head1 SYNOPSIS

Using L Driver API

  SMS-Send.ini
  [Kannel::SMSbox]
  host=mykannelserver
  username=myuser
  password=mypass

  use SMS::Send;
  my $service = SMS::Send->new('Kannel::SMSbox');
  my $success = $service->send_sms(
                                   to   => '[phone]',
                                   text => 'Hello World!',
                                  );

=head1 DESCRIPTION

SMS::Send driver for Kannel SMSbox web service.

=head1 USAGE

  use SMS::Send::Kannel::SMSbox;
  my $service = SMS::Send::Kannel::SMSbox->new(
                                       username => $username,
                                       password => $password,
                                       host     => $host,
                                      );
  my $success = $service->send_sms(
                                   to   => '[phone]',
                                   text => 'Hello World!',
                                  );

=head1 METHODS

=head2 send_sms

Sends the SMS message and returns 1 for success and 0 for failure or die on critical error.

=cut

sub send_sms {
  my $self = shift;
  my %argv = @_;
  my $to   = $argv{"to"} or die("Error: to address required");
  my $text = defined($argv{"text"}) ? $argv{"text"} : '';
  my $url  = $self->url; #isa URI
  my @form = (
               username   => $self->username,
               password   => $self->password,
               to         => $to,
               text       => $text,
             );
  $url->query_form(\@form);
  #print "$url\n";
  my $response = $self->ua->get($url);
  die(sprintf("HTTP Error: %s", $response->status_line)) unless $response->is_success;
  my $content  = $response->decoded_content;
  $self->{"__content"}=$content;
  #use Data::Dumper qw{Dumper};
  #print Dumper($content);
  my $data     = $content;
  $self->{"__data"}=$data;
  #print Dumper($data);
  my $status   = $data || '';
  return $status =~ m/^0:/ ? 1 : 0; #0: Accepted for delivery
}

=head1 PROPERTIES

=head2 username

Sets and returns the username string value

Override in sub class

  sub _username_default {"myusername"};

Override in configuration

  [Kannel::SMSbox]
  username=myusername

=cut

#see SMS::Send::Driver::WebService->userame

=head2 password

Sets and returns the password string value

Override in sub class

  sub _password_default {"mypassword"};

Override in configuration

  [Kannel::SMSbox]
  password=mypassword

=cut

#see SMS::Send::Driver::WebService->password

=head2 host

Default: 127.0.0.1

Override in sub class

  sub _host_default {"myhost.domain.tld"};

Override in configuration

  [Kannel::SMSbox]
  host=myhost.domain.tld

=cut

#see SMS::Send::Driver::WebService->host

sub _host_default {"127.0.0.1"};

=head2 protocol

Default: http

Override in sub class

  sub _protocol_default {"https"};

Override in configuration

  [Kannel::SMSbox]
  protocol=https

=cut

#see SMS::Send::Driver::WebService->protocol

sub _protocol_default {"http"};

=head2 port

Default: 13013

Override in sub class

  sub _port_default {443};

Override in configuration

  [Kannel::SMSbox]
  port=443

=cut

#see SMS::Send::Driver::WebService->port

sub _port_default {13013};

=head2 script_name

Default: /cgi-bin/sendsms

Override in sub class

  sub _script_name_default {"/path/file"};

Override in configuration

  [Kannel::SMSbox]
  script_name=/path/file

=cut

#see SMS::Send::Driver::WebService->script_name

sub _script_name_default {'/cgi-bin/sendsms'};

=head2 url

Returns a L object based on above properties

=cut

#see SMS::Send::Driver::WebService->url

=head1 BUGS

=head1 SUPPORT

=head1 AUTHOR

  Michael R. Davis
  CPAN ID: MRDVT
  Satellite Tracking of People, LLC
  [e-mail]
  http://www.stopllc.com/

=head1 COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

=head1 SEE ALSO

L, L

=cut

1;