Why not adopt me?

This distribution is up for adoption! If you're interested then please contact the PAUSE module admins via email.

NAME

POE::Component::IRC::Plugin::Fortune - fortune cookies plugin for IRC

SYNOPSIS

    use strict;
    use warnings;

    use POE qw(Component::IRC  Component::IRC::Plugin::Fortune);

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

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

    $poe_kernel->run;

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

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

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

    sub irc_001 {
        $irc->yield( join => '#zofbot' );
    }


    <FortuneBot> Zoffix, Try the Moo Shu Pork. It is especially good today.
    <Zoffix> FortuneBot, fortune
    <FortuneBot> Zoffix, You will be held hostage by a radical group.
    <Zoffix> FortuneBot, fortune
    <FortuneBot> Zoffix, Q: What do you say to a New Yorker with a job? A: Big Mac, fries and a Coke, please!

DESCRIPTION

The module brings all the joys of the fortune *nix program to IRC. You do need to have the actual program installed. Future versions may incorporate the Fortune module to be used instead; give me a shout if you would like that.

This module is a POE::Component::IRC plugin which uses POE::Component::IRC::Plugin for its base. 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(
        'fortune' => POE::Component::IRC::Plugin::Fortune->new
    );

    # juicy flavor
    $irc->plugin_add(
        'fortune' =>
            POE::Component::IRC::Plugin::Fortune->new(
                auto             => 1,
                call             => [ qw/fortune -s -n 300/ ],
                response_event   => 'irc_fortune',
                banned           => [ qr/aol\.com$/i ],
                root             => [ qr/mah.net$/i ],
                addressed        => 1,
                trigger          => qr/^(?=fortune$)/i,
                triggers         => {
                    public  => qr/^(?=fortune$)/i,
                    notice  => qr/^(?=fortune$)/i,
                    privmsg => qr/^(?=fortune$)/i,
                },
                listen_for_input => [ qw(public notice privmsg) ],
                eat              => 1,
                debug            => 0,
            )
    );

The new() method constructs and returns a new POE::Component::IRC::Plugin::Fortune 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. Note: you can change the values of the arguments dynamically by accessing them as hashref keys in your plugin's object; e.g. to ban some user during runtime simply do push @{ $your_plugin_object->{banned} }, qr/user!mask/ 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 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 emitted by the plugin to retrieve the results (see EMITTED EVENTS section and response_event argument for details). Defaults to: 1.

`call`

    call => [ qw/fortune -s -n 300/ ],

Optional. Takes an arrayref as a value. This is, so to speak, the "core" of the module. Currently the module utilizes open() to read the data from fortune program. The arrayref passed to the call argument will be passed to that open(). So... man fortune and get creative if you really wish so. Defaults to: [ qw/fortune -s -n 300/ ]

`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 the request are ready. See EMITTED EVENTS section for more information. Defaults to: irc_fortune

`banned`

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

`root`

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

`trigger`

    ->new( trigger => qr/^(?=fortune$)/i );

Optional. Takes a regex as an argument. Messages matching this regex, irrelevant of the type of the message, will be considered as requests. See also addressed option below which is enabled by default as well as triggers option which is more specific. Defaults to: qr/^(?=fortune$)/i

`triggers`

    ->new( triggers => {
            public  => qr/^(?=fortune$)/i,
            notice  => qr/^(?=fortune$)/i,
            privmsg => qr/^(?=fortune$)/i,
        }
    );

Optional. Takes a hashref as an argument which may contain either one or all of keys public, notice and privmsg which indicates the type of messages: channel messages, notices and private messages respectively. The values of those keys are regexes of the same format and meaning as for the trigger argument (see above). Messages matching this regex will be considered as requests. The difference is that only messages of type corresponding to the key of triggers hashref are checked for the trigger. Note: the trigger will be matched irrelevant of the setting in triggers, thus you can have one global and specific "local" triggers. See also addressed option below which is enabled by default as well as triggers option which is more specific. Defaults to: qr/^(?=fortune$)/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 Nick and your trigger is qr/^trig\s+/ you would make the request by saying Nick, trig EXAMPLE. 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

`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 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) ]

`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 = {
        'fortune' => [
            'Zoffix, The naked truth of it is, I have no shirt. -- William Shakespeare, "Love\'s Labour\'s Lost" '
        ],
        'who' => 'Zoffix!n=Zoffix@unaffiliated/zoffix',
        'what' => 'fortune',
        'type' => 'public',
        'channel' => '#zofbot',
        'message' => 'FortuneBot, fortune'
    };

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_fortune) will receive input every time request is completed. The input will come in $_[ARG0] in form of a hashref, the keys/values of which are as follows:

`fortune`

    'fortune' => [
            'Zoffix, The naked truth of it is, I have no shirt. -- William Shakespeare, "Love\'s Labour\'s Lost" '
        ],

The fortune key will contain an arrayref with one element (don't ask why it's an arrayref). That element is what is spoken by the bot when auto is turned on.

`who`

    { 'who' => 'Zoffix!Zoffix@i.love.debian.org', }

The who key will contain the user mask of the user who sent the request.

`what`

    { 'what' => 'fortune', }

The what key will contain user's message after stripping the trigger (see CONSTRUCTOR).

`message`

    { 'message' => 'FortuneBot, fortune' }

The message key will contain the actual message which the user sent; that is before the trigger is stripped.

`type`

    { 'type' => 'public', }

The type key will contain the "type" of the message the user have sent. This will be either public, privmsg or notice.

`channel`

    { 'channel' => '#zofbot', }

The channel key will contain the name of the channel where the message originated. This will only make sense if type key contains public.

REPOSITORY

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

BUGS

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

If you can't access GitHub, you can email your request to bug-POE-Component-IRC-PluginBundle-Toys 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.

To install POE::Component::IRC::PluginBundle::Toys, copy and paste the appropriate command in to your terminal.

cpanm

cpanm POE::Component::IRC::PluginBundle::Toys

CPAN shell

perl -MCPAN -e shell
install POE::Component::IRC::PluginBundle::Toys

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

Why not adopt me?

NAME

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new

auto

call

response_event

banned

root

trigger

triggers

addressed

listen_for_input

eat

debug

EMITTED EVENTS

response_event

fortune

who

what

message

type

channel

REPOSITORY

BUGS

AUTHOR

LICENSE

Module Install Instructions

`new`

`auto`

`call`

`response_event`

`banned`

`root`

`trigger`

`triggers`

`addressed`

`listen_for_input`

`eat`

`debug`

`response_event`

`fortune`

`who`

`what`

`message`

`type`

`channel`