Rob Hoelz > App-TracksBot-0.01 > App::TracksBot

Download:
App-TracksBot-0.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.01   Source  

NAME ^

App::TracksBot - An XMPP-based chatbot for interacting with a Tracks installation

VERSION ^

0.01

SYNOPSIS ^

  use App::TracksBot;

  App::TracksBot->run($yaml_file_name);

DESCRIPTION ^

This module provides the logic behind the tracks-bot program.

METHODS ^

App::TracksBot->run($config_file)

Runs the bot, using configuration provided by $config_file. $config_file must use the YAML format.

CONFIGURATION ^

Tracks-bot is configured using a single YAML configuration file (a sample can be found in the module distribution, under tracks-bot-sample.yaml). The configuration consists of several sections:

xmpp

The xmpp section contains configuration for the XMPP connection. All attributes are passed as-is into AnyEvent::XMPP::IM::Connection->new. If the boolean attribute 'google_talk' is provided and true, several attributes are added to automatically connect to Google Talk, so if you provide this attribute, you'll probably only need to provide your username and password as well.

whitelist

The whitelist section is a list of bare JIDS that are allowed to talk to your chatbot.

tracks

The tracks section contains configuration for the Tracks connection. All attributes are passed as-is into AnyEvent::WebService::Tracks->new, except for the default_context attribute, which is the name of the context that todos created with the chatbot should go into.

AUTHOR ^

Rob Hoelz, rob at hoelz.ro

BUGS ^

Please report any bugs or feature requests to bug-App-TracksBot at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-TracksBot. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

COPYRIGHT & LICENSE ^

Copyright 2011 Rob Hoelz.

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

SEE ALSO ^

http://getontracks.org, tracks-bot, AnyEvent::WebService::Tracks, AnyEvent::XMPP

syntax highlighting: