File Coverage

blib/lib/Mojolicious/Plugin/SMS.pm

Criterion	Covered	Total	%
statement	16	18	88.8
branch	1	4	25.0
condition	1	5	20.0
subroutine	4	4	100.0
pod	1	1	100.0
total	23	32	71.8

package Mojolicious::Plugin::SMS;
use Mojo::Base 'Mojolicious::Plugin';
use SMS::Send;

our $VERSION = '0.01';

sub register {
  my ($self, $app, $conf) = @_;
  $conf ||= {};
  $conf->{driver} = delete $conf->{driver};
  my $sms_send = SMS::Send->new($conf->{driver}, %$conf);

  $app->helper(
    sms => sub {
      my $self = shift;
      my %params;
      if (@_ == 2) {
          @params{qw(to text)} = @_;
      } elsif (@_ > 2 && @_ % 2 == 0) {
          %params = @_;
      } else {
          die "Invalid params passed to sms helper!";
      }
      return $sms_send->send_sms(%params);
    }
  );
}

1;

=head1 NAME

Mojolicious::Plugin::SMS - Easy SMS sending from Mojolicious apps

=head1 SYNOPSIS

  # Mojolicious::Lite
  plugin 'SMS' => {
    driver    => 'Test'
  };

  # Mojolicious
  $self->plugin(SMS => {
    driver    => 'Nexmo',
    _username => 'testuser',
    _password => 'testpassword'
    _from     => 'Bender'
  });

  # in controller named params
  $self->sms(
    to   => '[phone]',
    text => 'use Perl or die;'
  );

  # in controller positional params
  $self->sms('[phone]', 'use Perl or die;');

=head1 DESCRIPTION

Provides a quick and easy way to send SMS messages using L drivers
(of which there are many, so chances are the service you want to use is already
supported; if not, they're easy to write, and if you want to change providers
later, you can simply update a few lines in your config file, and you're done.

=head1 OPTIONS

L has one required option 'driver', all other options
are passed to appropriate L driver.

=head2 C

L driver name. This is a required option. You may specify 'Test' if
you need a testing driver.

=head1 HELPERS

L implements one helper.

=head2 sms

Send an SMS message.  You can pass the destination and message as positional
params:

    sms $to, $message;

Or, you can use named params:

    sms to => $to, text => $message;

The latter form may be clearer, and would allow any additional driver-specific
parameters to be passed too, but the former is terser.  The choice is yours.

=head1 METHODS

L inherits all methods from L
and implements the following new ones.

=head2 C

$plugin->register;

Register plugin hooks and helpers in L application.

=head1 SEE ALSO

L, L, L.

=head1 AUTHOR

Yuriy Syrota

=head1 COPYRIGHT & LICENSE

Copyright (C) 2011 by Yuriy Syrota.

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

=cut