Chisel > WebService-NotifyMyAndroid-0.0.6 > WebService::NotifyMyAndroid

Download:
WebService-NotifyMyAndroid-0.0.6.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.0.6   Source  

NAME ^

WebService::NotifyMyAndroid - Perl interface to Notify My Android web API

VERSION ^

version 0.0.6

SYNOPSIS ^

    use WebService::NotifyMyAndroid;

    my $nma = WebService::NotifyMyAndroid->new;

    # verify an existing API key
    my $result = $nma->verify( apikey => $my_api_key );
    defined( $result->{success} ) or die( $result->{error}->{content} );

    # send a message
    my $message = $nma->notify(
        apikey      => [ $my_first_api_key, $my_second_api_key, ],
        application => 'The Printer',
        event       => 'I can't print!',
        description => 'Really, I cannot print.  Please come help me.',
        priority    => 1,
    );
    defined( $message->{success} ) or die( $message->{error}->{content} );

DESCRIPTION ^

WebService::NotifyMyAndroid is a Perl interface to the Notify My Android (http://www.notifymyandroid.com/) web API. One or more NMA API keys are necessary in order to use this module.

INTERFACE ^

verify(%params)

Documentation located at http://www.notifymyandroid.com/api.jsp.

notify(%params)

Documentation located at http://www.notifymyandroid.com/api.jsp.

DIAGNOSTICS ^

FIXME! Error handling is pathetic at this point.

CONFIGURATION AND ENVIRONMENT ^

WebService::NotifyMyAndroid requires no configuration files or environment variables. Future development will support a custom NMA API URL.

DEPENDENCIES ^

Readonly
Regexp::Common
WebService::Simple
XML::Simple

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-webservice-nma@rt.cpan.org, or through the web interface at http://rt.cpan.org.

TODO ^

write a real README
command-line tool for generating notifications
integration with other tools: MTAs? Nagios? IM?

SEE ALSO ^

WebService::Prowl

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Chisel Wright.

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

syntax highlighting: