phergie/phergie-irc-plugin-react-twitter

Phergie plugin for displaying data from tweets

1.0.1 2016-03-21 02:30 UTC

This package is not auto-updated.

Last update: 2020-05-25 05:48:24 UTC


README

This repo is being kept for posterity and will be archived in a readonly state. If you're interested it can be forked under a new Composer namespace/GitHub organization.

phergie/phergie-irc-plugin-react-twitter

Phergie plugin for displaying data from tweets.

Build Status

Install

The recommended method of installation is through composer.

{
    "require": {
        "phergie/phergie-irc-plugin-react-twitter": "dev-master"
    }
}

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

Configuration

return [
    'plugins' => [
        // dependencies
        new \WyriHaximus\Phergie\Plugin\Url\Plugin, // Emits url.host.twitter.com events

        // configuration
        new \Phergie\Irc\Plugin\React\Twitter\Plugin([
            // required string containing OAuth consumer key
            'consumer_key' => 'xvz1evFS4wEEPTGEFPHBog'

            // required string containing OAuth consumer secret
            'consumer_secret' => '9z6157pUbOBqtbm0A0q4r29Y2EYzIHlUwbF4Cl9c'

            // required string containing OAuth token
            'token' => '370773112-GmHxMAgYyLbNEtIKZeRNFsMKPR9EyMZeS9weJAEb'

            // required string containing OAuth token secret
            'token_secret' => '9z6157pUbOBqtbm0A0q4r29Y2EYzIHlUwbF4Cl9c'

            // optional object implementing \Phergie\Irc\Plugin\React\Twitter\FormatterInterface
            // used to format tweets prior to their syndication
            'formatter' => new \Phergie\Irc\Plugin\React\Twitter\DefaultFormatter('<@%user.screen_name%> %text% - %created_at.relative% (%url%)', \DateTime::ISO8601)
        ])
    ]
];

Usage

  • twitter username - fetches and displays the last tweet by @username
  • twitter username 3 - fetches and displays the third last tweet by @username
  • twitter 1234567 - fetches and displays tweet number 1234567
  • http://twitter.com/username/statuses/1234567 - Url plugin routes to this plugin, same output as twitter 1234567

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.