add unicode text support

lib/Nexmo/SMS.pm

@@ -6,6 +6,7 @@ use strict;
 use Nexmo::SMS::BinaryMessage;
 use Nexmo::SMS::TextMessage;
 use Nexmo::SMS::WAPPushMessage;
+use Nexmo::SMS::UnicodeMessage;
 
 use Nexmo::SMS::GetBalance;
 
@@ -116,6 +117,7 @@ sub sms {
 
     my %types = (
         text    => 'Nexmo::SMS::TextMessage',
+        unicode => 'Nexmo::SMS::UnicodeMessage',
         binary  => 'Nexmo::SMS::BinaryMessage',
         wappush => 'Nexmo::SMS::WAPPushMessage',
     );

lib/Nexmo/SMS/UnicodeMessage.pm

@@ -0,0 +1,261 @@
+package Nexmo::SMS::UnicodeMessage;
+
+use strict;
+use warnings;
+
+use Nexmo::SMS::Response;
+
+use LWP::UserAgent;
+use JSON::PP;
+
+=head1 NAME
+
+Nexmo::SMS::UnicodeMessage - Module that respresents a text message for the Nexmo SMS API!
+
+=head1 VERSION
+
+Version 0.01
+
+=cut
+
+our $VERSION = '0.01';
+
+my %attrs = (
+    text              => 'required',
+    type              => 'required',
+    from              => 'required',
+    to                => 'required',
+    server            => 'required',
+    username          => 'required',
+    password          => 'required',
+    status_report_req => 'optional',
+    client_ref        => 'optional',
+    network_code      => 'optional',
+);
+
+for my $attr ( keys %attrs ) {
+    no strict 'refs';
+    *{ __PACKAGE__ . '::' . $attr } = sub {
+        my ($self,$value) = @_;
+
+        my $key = '__' . $attr . '__';
+        $self->{$key} = $value if @_ == 2;
+        return $self->{$key};
+    };
+}
+
+=head1 SYNOPSIS
+
+This module simplifies sending SMS through the Nexmo API.
+
+
+    use Nexmo::SMS::UnicodeMessage;
+
+    my $nexmo = Nexmo::SMS::UnicodeMessage->new(
+        server   => 'http://test.nexmo.com/sms/json',
+        username => 'testuser1',
+        password => 'testpasswd2',
+        text     => 'This is a test',
+        type     => 'unicode',
+        from     => 'Test02',
+        to       => '452312432',
+    );
+        
+    my $response = $sms->send || die $sms->errstr;
+    
+    if ( $response->is_success ) {
+        print "SMS was sent...\n";
+    }
+
+=head1 METHODS
+
+=head2 new
+
+create a new object
+
+    my $message = Nexmo::SMS::UnicodeMessage->new(
+        server   => 'http://test.nexmo.com/sms/json',
+        username => 'testuser1',
+        password => 'testpasswd2',
+    );
+
+This method recognises these parameters:
+
+    text              => 'required',
+    from              => 'required',
+    to                => 'required',
+    server            => 'required',
+    username          => 'required',
+    password          => 'required',
+    status_report_req => 'optional',
+    client_ref        => 'optional',
+    network_code      => 'optional',
+
+=cut
+
+sub new {
+    my ($class,%param) = @_;
+
+    my $self = bless {}, $class;
+
+    for my $attr ( keys %attrs ) {
+        if ( exists $param{$attr} ) {
+            $self->$attr( $param{$attr} );
+        }
+    }
+
+    $self->user_agent(
+        LWP::UserAgent->new(
+            agent => 'Perl module ' . __PACKAGE__ . ' ' . $VERSION,
+        ),
+    );
+
+    return $self;
+}
+
+=head2 user_agent
+
+Getter/setter for the user_agent attribute of the object. By default a new
+object of LWP::UserAgent is used, but you can use your own class as long as it
+is compatible to LWP::UserAgent.
+
+  $sms->user_agent( MyUserAgent->new );
+  my $ua = $sms->user_agent;
+
+=cut
+
+sub user_agent {
+    my ($self,$ua) = @_;
+
+    $self->{__ua__} = $ua if @_ == 2;
+    return $self->{__ua__};
+}
+
+=head2 errstr
+
+return the "last" error as string.
+
+    print $sms->errstr;
+
+=cut
+
+sub errstr {
+    my ($self,$message) = @_;
+
+    $self->{__errstr__} = $message if @_ == 2;
+    return $self->{__errstr__};
+}
+
+=head2 send
+
+This actually calls the Nexmo SMS API. It returns a L<Nexmo::SMS::Response> object or
+C<undef> (on failure).
+
+   my $sms = Nexmo::SMS::UnicodeMessage->new( ... );
+   $sms->send or die $sms->errstr;
+
+=cut
+
+sub send {
+    my ($self) = shift;
+
+    my %optional;
+    $optional{'client-ref'}        = $self->client_ref        if $self->client_ref;
+    $optional{'status-report-req'} = $self->status_report_req if $self->status_report_req;
+    $optional{'network-code'}      = $self->network_code      if $self->network_code;
+
+    my $response = $self->user_agent->post(
+        $self->server,
+        {
+            %optional,
+            username => $self->username,
+            password => $self->password,
+            from     => $self->from,
+            to       => $self->to,
+            text     => $self->text,
+            type     => $self->type,
+        },
+    );
+
+    if ( !$response || !$response->is_success ) {
+        $self->errstr("Request was not successful: " . $response->status_line);
+        warn $response->content if $response;
+        return;
+    }
+
+    my $json            = $response->content;
+    my $response_object = Nexmo::SMS::Response->new( json => $json );
+
+    if ( $response_object->is_error ) {
+        $self->errstr( $response_object->errstr );
+    }
+
+    return $response_object;
+}
+
+=head2 check_needed_params
+
+This method checks if all needed parameters are passed.
+
+  my $params_not_ok = Nexmo::SMS::UnicodeMessage->check_needed_params( ... );
+  if ( $params_not_ok ) {
+      print "Please check $params_not_ok";
+  }
+
+=cut
+
+sub check_needed_params {
+    my ($class,%params) = @_;
+
+    my @params_not_ok;
+
+    for my $attr ( keys %attrs ) {
+        if ( $attrs{$attr} eq 'required' and !$params{$attr} ) {
+            push @params_not_ok, $attr;
+        }
+    }
+
+    return join ", ", @params_not_ok;
+}
+
+=head1 Attributes
+
+These attributes are available for C<Nexmo::SMS::UnicodeMessage> objects:
+
+=over 4
+
+=item * client_ref
+
+=item * from
+
+=item * network_code
+
+=item * password
+
+=item * server
+
+=item * status_report_req
+
+=item * text
+
+=item * to
+
+=item * username
+
+=back
+
+=cut
+
+1;
+
+=head1 ACKNOWLEDGEMENTS
+
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2011 Renee Baecker.
+
+This program is released under the following license: artistic_2
+
+
+=cut