view release on metacpan or  search on metacpan

lib/App/RoboBot/Plugin/API/Github.pm  view on Meta::CPAN

package App::RoboBot::Plugin::API::Github;
$App::RoboBot::Plugin::API::Github::VERSION = '4.004';
use v5.20;

use namespace::autoclean;

use Moose;
use MooseX::SetOnce;

use AnyEvent;
use Data::Dumper;
use HTTP::Request;
use JSON;
use LWP::UserAgent;
use URI;

use App::RoboBot::Channel;
use App::RoboBot::Response;

extends 'App::RoboBot::Plugin';

=head1 api.github

Provides functions for interacting with Github APIs, including watching for
repository related events.

A poor man's alternative to simply enabling Github's built-in chat notifiers.

=cut

has '+name' => (
    default => 'API::Github',
);

has '+description' => (
    default => 'Provides functions for interacting with Github APIs, including watching for repository related events.',
);

=head2 github-watch

=head3 Description

Adds a watcher for the current channel on the given Github project. The watcher
will periodically poll the Github APIs for commit, issue, and other events and
report them in the channel when they occur. If multiple events have occurred
since the last reporting, they will be bundled together.

=head3 Usage

<project url>

=head3 Examples

    (github-watch https://github.com/jsime/robobot)

=head2 github-unwatch

=head3 Description

Removes the watcher for the given Github project in the current channel. If the
same project is being watched in other channels as well, it will need to be
removed from them separately.

=head3 Usage