chrismou/phergie-irc-plugin-react-pingpong

Phergie plugin for testing the bot's responsiveness

v1.1.0 2015-11-26 14:57 UTC

Requires

• php: >=5.5.0
• phergie/phergie-irc-bot-react: <3.0
• phergie/phergie-irc-plugin-react-command: ~1.0

Requires (Dev)

• codeclimate/php-test-reporter: dev-master
• mockery/mockery: ~0.9
• phpunit/phpunit: 4.*
• squizlabs/php_codesniffer: *
• vectorface/dunit: ^2.1

Suggests

• phergie/phergie-irc-plugin-react-commandhelp: provides interactive help for commands

BSD-2-Clause

• Chris Chrisostomou

• plugin
• bot
• irc
• phergie

README

Phergie plugin for testing the bot's responsiveness.

About

This plugin is designed to simply return a response to the phrase "ping", most commonly used to test the bot's responsiveness.

Install

The recommended method of installation is through composer.

composer require chrismou/phergie-irc-plugin-react-pingpong

See Phergie documentation for more information on installing and enabling plugins.

Configuration

To use the default settings, simply add the following to your config file:

new \Chrismou\Phergie\Plugin\PingPong\Plugin

Or you can set one of both of the custom config values. "response" is the phrase the bot will reply back with (defaults to "pong"), and "reply" sets whether the bot should reply back to the user directly (defaults to false):

new \Chrismou\Phergie\Plugin\PingPong\Plugin(array(
    "response" => "lolwut",
    "reply" => false
))

Tests

To run the unit test suite:

curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit

License

Released under the BSD License. See LICENSE.