POE::Component::IRC::Plugin::CPAN::LinksToDocs - get links to http://search.cpan.org/ documentation from IRC

 =head1 SYNOPSIS

    use strict;
    use warnings;

    use POE qw(Component::IRC  Component::IRC::Plugin::CPAN::LinksToDocs);

    my $irc = POE::Component::IRC->spawn(
        nick        => 'DocBot',
        server      => 'irc.freenode.net',
        port        => 6667,
        ircname     => 'CPAN LinksToDocs',
    );

    POE::Session->create(
        package_states => [
            main => [ qw(_start irc_001) ],
        ],
    );

    $poe_kernel->run;

    sub _start {
        $irc->yield( register => 'all' );

        $irc->plugin_add(
            'LinksToDocs' =>
                POE::Component::IRC::Plugin::CPAN::LinksToDocs->new
        );

        $irc->yield( connect => {} );
    }

    sub irc_001 {
        $_[KERNEL]->post( $_[SENDER] => join => '#zofbot' );
    }

    <Zoffix> DocBot, uri Acme::BabyEater
    <DocBot> http://search.cpan.org/perldoc?Acme::BabyEater
    <Zoffix> DocBot, perldoc map
    <DocBot> http://perldoc.perl.org/functions/map.html
    <Zoffix> DocBot, perldoc RE
    <DocBot> http://search.cpan.org/perldoc?perlrequick
             http://search.cpan.org/perldoc?perlretut
             http://search.cpan.org/perldoc?perlre
             http://search.cpan.org/perldoc?perlreref

This module is a POE::Component::IRC plugin which uses POE::Component::IRC::Plugin for its base. It provides interface to to link people to documentation on http://search.cpan.org by giving it predefined "tags" (see TAGS section in CPAN::LinksToDocs) or module names. It accepts input from public channel events, /notice messages as well as /msg (private messages); although that can be configured at will.

The tags given to the plugin in IRC will be split on commas, only the link(s) for the first tag will be spoken in IRC but all of the tags will be processed and the all the links will be returned in the response event. See EMITED EVENTS section for more information.

    # plain and simple
    $irc->plugin_add(
        LinksToDocs => POE::Component::IRC::Plugin::CPAN::LinksToDocs->new
    );

    # juicy flavor
    $irc->plugin_add(
        LinksToDocs =>
            POE::Component::IRC::Plugin::CPAN::LinksToDocs->new(
                auto             => 1,
                response_event   => 'irc_docs_ready',
                banned           => [ qr/aol\.com$/i ],
                root             => [ qr/mah.net$/i ],
                addressed        => 1,
                trigger          => qr/^cpan\s+(?=\S)/i,
                listen_for_input => [ qw(public notice privmsg) ],
                linker           => CPAN::LinksToDocs->new( tags => { m => 'http://m.com' } ),
                eat              => 1,
                debug            => 0,
            )
    );

The new() method constructs and returns a new POE::Component::IRC::Plugin::CPAN::LinksToDocs object suitable to be fed to POE::Component::IRC's plugin_add method. The constructor takes a few arguments, but all of them are optional. The possible arguments/values are as follows:

    ->new( auto => 0 );

Optional. Takes either true or false values, specifies whether or not the plugin should auto respond to requests. When the auto argument is set to a true value plugin will respond to the requesting person with the results automatically. When the auto argument is set to a false value plugin will not respond and you will have to listen to the events emited by the plugin to retrieve the results (see EMITED EVENTS section and response_event argument for details). Defaults to: 1.

    ->new(linker => CPAN::LinksToDocs->new(tags => { m => 'http://m.com/' } ));

Optional. The linker argument takes a CPAN::LinksToDocs object as a value, here's where you can add any custom tags if you want. Defaults to: standard, plain CPAN::LinksToDocs object.

    ->new( response_event => 'event_name_to_recieve_results' );

Optional. Takes a scalar string specifying the name of the event to emit when the results of the request are ready. See EMITED EVENTS section for more information. Defaults to: irc_cpan_links_to_docs

    ->new( banned => [ qr/aol\.com$/i ] );

Optional. Takes an arrayref of regexes as a value. If the usermask of the person (or thing) making the request matches any of the regexes listed in the banned arrayref, plugin will ignore the request. Defaults to: [] (no bans are set).

    ->new( root => [ qr/\Qjust.me.and.my.friend.net\E$/i ] );

Optional. As opposed to banned argument, the root argument allows access only to people whose usermasks match any of the regexen you specify in the arrayref the argument takes as a value. By default: it is not specified. Note: as opposed to banned specifying an empty arrayref to root argument will restrict access to everyone.

    ->new( trigger => qr/^cpan\s+(?=\S)/i );

Optional. Takes a regex as an argument. Messages matching this regex will be considered as requests. See also addressed option below which is enabled by default. Note: the trigger will be removed from the message, therefore make sure your trigger doesn't match the actual data that needs to be processed. Defaults to: qr/^(?:ur[il]\s*(?:for)?|perldoc)\s+(?=\S+)/i

    ->new( addressed => 1 );

Optional. Takes either true or false values. When set to a true value all the public messages must be addressed to the bot. In other words, if your bot's nickname is Nick and your trigger is qr/^cpan\s+/ you would make the request by saying Nick, cpan Acme::BabyEater. When addressed mode is turned on, the bot's nickname, including any whitespace and common punctuation character will be removed before matching the trigger (see above). When addressed argument it set to a false value, public messages will only have to match trigger regex in order to make a request. Note: this argument has no effect on /notice and /msg requests. Defaults to: 1

    ->new( listen_for_input => [ qw(public  notice  privmsg) ] );

Optional. Takes an arrayref as a value which can contain any of the three elements, namely public, notice and privmsg which indicate which kind of input plugin should respond to. When the arrayref contains public element, plugin will respond to requests sent from messages in public channels (see addressed argument above for specifics). When the arrayref contains notice element plugin will respond to requests sent to it via /notice messages. When the arrayref contains privmsg element, the plugin will respond to requests sent to it via /msg (private messages). You can specify any of these. In other words, setting ( listen_for_input = [ qr(notice privmsg) ] )> will enable functionality only via /notice and /msg messages. Defaults to: [ qw(public notice privmsg) ]

    ->new( eat => 0 );

Optional. If set to a false value plugin will return a PCI_EAT_NONE after responding. If eat is set to a true value, plugin will return a PCI_EAT_ALL after responding. See POE::Component::IRC::Plugin documentation for more information if you are interested. Defaults to: 1

    ->new( debug => 1 );

Optional. Takes either a true or false value. When debug argument is set to a true value some debugging information will be printed out. When debug argument is set to a false value no debug info will be printed. Defaults to: 0.

    $VAR1 = {
            'who' => 'Zoffix!n=Zoffix@unaffiliated/zoffix',
            'what' => 'map,grep,RE',
            'type' => 'public',
            'channel' => '#zofbot',
            'result' => [
                            'http://perldoc.perl.org/functions/map.html',
                            'http://perldoc.perl.org/functions/grep.html',
                            'http://search.cpan.org/perldoc?perlrequick',
                            'http://search.cpan.org/perldoc?perlretut',
                            'http://search.cpan.org/perldoc?perlre',
                            'http://search.cpan.org/perldoc?perlreref'
                        ],
            'message' => 'DocBot, perldoc map,grep,RE'
            };

The event handler set up to handle the event, name of which you've specified in the response_event argument to the constructor (it defaults to irc_cpan_links_to_docs) will recieve input every time request is completed. The input will come in a form of a hashref. The keys/values of that hashref are as follows:

    { 'who' => 'Zoffix!n=Zoffix@unaffiliated/zoffix' }

The usermask of the person who made the request.

    { 'what' => 'map,grep,RE' }

The user's message after stripping the trigger.

    { 'type' => 'public' }

The type of the request. This will be either public, notice or privmsg

    { 'channel' => '#zofbot' }

The channel where the message came from (this will only make sense when the request came from a public channel as opposed to /notice or /msg)

    { 'message' => 'DocBot, perldoc map,grep,RE' }

The full message that the user has sent.

    {
        'result' => [
            'http://perldoc.perl.org/functions/map.html',
            'http://perldoc.perl.org/functions/grep.html',
            'http://search.cpan.org/perldoc?perlrequick',
            'http://search.cpan.org/perldoc?perlretut',
            'http://search.cpan.org/perldoc?perlre',
            'http://search.cpan.org/perldoc?perlreref'
        ],
    }

The result of the request. Note: the "tags" given to the plugin will be split on commas, only the link(s) for the first tag of that split will be spoken in IRC, but all of them will be returned in the response event.

CPAN::LinksToDocs, POE::Component::IRC::Plugin

Zoffix Znet, <zoffix at cpan.org>

Please report any bugs or feature requests to bug-poe-component-irc-plugin-cpan-linkstodocs at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-IRC-Plugin-CPAN-LinksToDocs. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

You can find documentation for this module with the perldoc command.

    perldoc POE::Component::IRC::Plugin::CPAN::LinksToDocs

You can also look for information at:

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-IRC-Plugin-CPAN-LinksToDocs

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/POE-Component-IRC-Plugin-CPAN-LinksToDocs

* CPAN Ratings

http://cpanratings.perl.org/d/POE-Component-IRC-Plugin-CPAN-LinksToDocs

* Search CPAN

http://search.cpan.org/dist/POE-Component-IRC-Plugin-CPAN-LinksToDocs

Copyright 2008 Zoffix Znet, all rights reserved.

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