Public Member Functions
public	send_message_to_slack ()

protected	_pretty_die ()

public	send_beekeeper_message_to_slack ()

Detailed Description

Description

A library to interface eHive with Slack

Definition at line 10 of file Slack.pm.

Member Function Documentation

◆ _pretty_die()

protected Bio::EnsEMBL::Hive::Utils::Slack::_pretty_die ( )

    Description: Helper method to have uniform error messages

Code:

click to view

◆ send_beekeeper_message_to_slack()

public Bio::EnsEMBL::Hive::Utils::Slack::send_beekeeper_message_to_slack ( )

    Arg [1]      : $slack_webhook (string URL)
    Arg [2]      : $hive_pipeline (Bio::EnsEMBL::Hive::HivePipeline)
    Arg [3]      : $is_error (non-zero if message should be displayed as an error)
    Arg [4]      : $is_exit (non-zero if message should be displayed as an exit -
                   a non-zero $is_error overrides $is_exit)
    Arg [5]      : $beekeeper_message (string)
    Arg [6]      : (optional) $loop_until (string) beekeeper's loop_until setting
    Description  : Formats and packages a message from the beekeeper, then sends to Slack.

Code:

click to view

◆ send_message_to_slack()

public Bio::EnsEMBL::Hive::Utils::Slack::send_message_to_slack ( )

    Description: A core method to send a message to a Slack webhook.
                 The payload should be a hash-structure that can be encoded in
                 JSON and follows Slack's message structure. See more details at
                 https://api.slack.com/incoming-webhooks and
                 https://api.slack.com/docs/formatting

Code:

click to view

sub send_message_to_slack {
    my ($slack_webhook, $payload) = @_;
    require HTTP::Request::Common;
    require LWP::UserAgent;
    require JSON;
    # Fix the channel name (it *must* start with a hash)
    $payload->{'channel'} = '#'.$payload->{'channel'} if ($payload->{'channel'} || '') =~ /^[^#@]/;
    my $json_payload = JSON::encode_json($payload);
    my $req = HTTP::Request::Common::POST($slack_webhook, ['payload' => $json_payload]);
    my $ua = LWP::UserAgent->new;
    $ua->timeout(15);
    my $resp = $ua->request($req);
    if ($resp->is_success) {
        # well done
    } else {
        # All taken from https://api.slack.com/changelog/2016-05-17-changes-to-errors-for-incoming-webhooks
        if ($resp->code == 400) {
            if ($resp->content eq 'invalid_payload') {
                _pretty_die($resp, 'The data sent in your request cannot be understood as presented; verify your content body matches your content type and is structurally valid'. "\n$json_payload");
            } elsif ($resp->content eq 'user_not_found') {
                _pretty_die($resp, 'The user used in your request does not actually exist' . "\n$json_payload");
            }
        } elsif ($resp->code == 403) {
            if ($resp->content eq 'action_prohibited') {
                _pretty_die($resp, 'The team associated with your request has some kind of restriction on the webhook posting in this context.'. "\n$json_payload");
            }
        } elsif ($resp->code == 404) {
            if ($resp->content eq 'channel_not_found') {
                _pretty_die($resp, sprintf('The channel associated with your request (%s) does not exist', $payload->{'channel'}));
            }
        } elsif ($resp->code == 405) {
            if ($resp->content eq 'channel_is_archived') {
                _pretty_die($resp, sprintf(q{The channel '%s' has been archived and doesn't accept further messages, even from your incoming webhook.}, $payload->{'channel'}));
            }
        } elsif ($resp->code == 500) {
            if ($resp->content eq 'rollup_error') {
                _pretty_die($resp, 'Something strange and unusual happened that was likely not your fault at all.'. "\n$json_payload");
            }
        }
        _pretty_die($resp, $resp->content);
    }
}

The documentation for this class was generated from the following file:

modules/Bio/EnsEMBL/Hive/Utils/Slack.pm

Public Member Functions

Detailed Description

Description

Member Function Documentation

◆ _pretty_die()

◆ send_beekeeper_message_to_slack()

◆ send_message_to_slack()