NAME

POE::Component::IRC::Plugin::Google::PageRank - non-blocking access to Google's PageRank via IRC

SYNOPSIS

    use strict;
    use warnings;

    use POE qw(Component::IRC  Component::IRC::Plugin::Google::PageRank);

    my $irc = POE::Component::IRC->spawn(
        nick        => 'RankBot',
        server      => 'irc.freenode.net',
        port        => 6667,
        ircname     => 'Google PageRank Bot',
    );

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

    $poe_kernel->run;

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

        $irc->plugin_add(
            'GoogleRank' =>
                POE::Component::IRC::Plugin::Google::PageRank->new
        );

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

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


    [22:37:04] <Zoffix> RankBot, rank zoffix.com
    [22:37:05] <RankBot> Rank is 4
    [22:37:09] <Zoffix> RankBot, rank google.com
    [22:37:10] <RankBot> Rank is 10

DESCRIPTION

This module is a POE::Component::IRC plugin which uses POE::Component::IRC::Plugin for its base. It provides access to Google PageRank from IRC. It accepts input from public channel events, /notice messages as well as /msg (private messages); although that can be configured at will.

CONSTRUCTOR

new

    # plain and simple
    $irc->plugin_add(
        'GoogleRank' => POE::Component::IRC::Plugin::Google::PageRank->new
    );

    # juicy flavor
    $irc->plugin_add(
        'GoogleRank' =>
            POE::Component::IRC::Plugin::Google::PageRank->new(
                auto             => 1,
                response_event   => 'irc_google_pagerank',
                banned           => [ qr/aol\.com$/i ],
                addressed        => 1,
                trigger          => qr/^rank\s+(?=\S)/i,
                listen_for_input => [ qw(public notice privmsg) ],
                eat              => 1,
                debug            => 0,
            )
    );

The new() method constructs and returns a new POE::Component::IRC::Plugin::Google::PageRank 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:

auto

    ->new( auto => 0 );

Optional. Takes either true or false values, specifies whether or not the plugin should auto respond to pagerank requests. When the auto argument is set to a true value plugin will respond to the person requesting pagerank 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 emitted by the plugin to retrieve the results (see EMITTED EVENTS section and response_event argument for details). Defaults to: 1.

response_event

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

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

banned

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

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

trigger

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

Optional. Takes a regex as an argument. Messages matching this regex will be considered as requests for pagerank. 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 URI of the page for which pagerank is needed. Defaults to: qr/^rank\s+(?=\S)/i

addressed

    ->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 RankBot and your trigger is qr/^rank/ you would request the pagerank by saying RankBot, rank http://zoffix.com. 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 request pagerank. Note: this argument has no effect on /notice and /msg pagerank requests. Defaults to: 1

listen_for_input

    ->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 pagerank requests sent to it via /notice messages. When the arrayref contains privmsg element, the plugin will respond to pagerank 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 pagerank requests only via /notice and /msg messages. Defaults to: [ qw(public notice privmsg) ]

eat

    ->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

debug

    ->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.

EMITTED EVENTS

response_event

    $VAR1 = {
        'who' => 'Zoffix!n=Zoffix@unaffiliated/zoffix',
        'page' => 'http://haslayout.net',
        'type' => 'public',
        'channel' => '#zofbot',
        'message' => 'RankBot, rank haslayout.net',
        'result' => 'Rank is 4'
    };

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_google_pagerank) will receive input every time pagerank request is completed. The input will come in the form of a hashref in ARG0. The keys/values of that hashref are as follows:

who

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

The who key will contain the usermask of the user who requested the pagerank.

    { 'type' => 'public' }

The type key will contain the "type" of the message sent by the requestor. The possible values are: public, notice and privmsg indicating that request was requested in public channel, via /notice and via /msg (private message) respectively.

channel

    { 'channel' => '#zofbot' }

The channel key will contain the name of the channel from which the request came from. This will only make sense when type key (see above) contains public.

message

    { 'message' => 'RankBot, rank haslayout.net' }

The message key will contain the message which the user has sent to request the pagerank.

page

    { 'page' => 'http://haslayout.net', }

The page key will contain the page for which the pagerank was requested.

result

    { 'result' => 'Rank is 4' }

The result key will contain the pagerank of the specified page, in other words what you'd see the plugin say when auto (see constructor arguments) is turned on (that's the default). Note: the successful results will begin with Rank is and if an error occurred during the request, or no result was returned the result's value will begin with Error:.

REPOSITORY

Fork this module on GitHub: https://github.com/zoffixznet/POE-Component-IRC-PluginBundle-WebDevelopment

BUGS

To report bugs or request features, please use https://github.com/zoffixznet/POE-Component-IRC-PluginBundle-WebDevelopment/issues

If you can't access GitHub, you can email your request to bug-POE-Component-IRC-PluginBundle-WebDevelopment at rt.cpan.org

AUTHOR

Zoffix Znet <zoffix at cpan.org> (http://zoffix.com/, http://haslayout.net/)

LICENSE

You can use and distribute this module under the same terms as Perl itself. See the LICENSE file included in this distribution for complete details.