This repository has been archived by the owner. It is now read-only.
⛔️ DEPRECATED - Plugin to integrate with Bigstock API
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
composer.json
composer.lock
phpunit.xml

README.md

DEPRECATED

This repo is no longer publicly supported.

shutterstock/phergie-irc-plugin-react-bigstock

Phergie plugin to use Bigstock API to search for and display images.

Build Status

Install

The recommended method of installation is through composer.

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

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

Configuration

If you do not already have a Bigstock API account, you will need to create one. You will be given an account ID which must be included in plugin configuration.

return [
    'plugins' => [
        // dependencies
        new \Phergie\Irc\Plugin\React\Command\Plugin, // Handles commands and routes to correct plugins
        new \Phergie\Irc\Plugin\React\CommandHelp\Plugin, // Optional - enables help messages for commands
        new \Phergie\Plugin\Dns\Plugin, // Handles DNS lookups for the HTTP plugin
        new \Phergie\Plugin\Http\Plugin, // Handles the HTTP requests for this plugin
        new \Phergie\Irc\Plugin\React\Url\Plugin, // Helps get hostname for building url.shorten.* events
        new \PSchwisow\Phergie\Plugin\UrlShorten\Plugin, // Optional - provides short URLs if available

        // configuration
        new \Shutterstock\Phergie\Plugin\Bigstock\Plugin([
            // REQUIRED: The API account ID associated with your Bigstock account
            'accountId' => '123456',

            // OPTIONAL: The formatter used for output (default value is shown)
            'formatter' => new \Shutterstock\Phergie\Plugin\Bigstock\DefaultFormatter(
                '%title% - %url_short% < %large_thumb% >'
            )

            // OPTIONAL: How long to wait for URL shortener before skipping it (default value is shown)
            'shortenTimeout' => 15,
        ])
    ]
];

Usage

Use the bigstock command to search for images matching your query string and return a randomly selected image from the top 10.

PSchwisow: !bigstock puppy
Phergie: Newborn Baby And Puppy - http://gsc.io/u/38 < http://static7.bigstockphoto.com/thumbs/6/3/8/small3/83626697.jpg >

Tests

To run the unit test suite:

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

License

BSD-2-Clause © 2015-2017 Shutterstock Images, LLC