File Coverage

blib/lib/Slack/WebHook.pm

Criterion	Covered	Total	%
statement	102	108	94.4
branch	32	46	69.5
condition	6	16	37.5
subroutine	25	26	96.1
pod	7	8	87.5
total	172	204	84.3

# Copyright (c) 2019, cPanel, LLC.
# All rights reserved.
# http://cpanel.net
#
# This is free software; you can redistribute it and/or modify it under the
# same terms as Perl itself. See L.

package Slack::WebHook;

use strict;
use warnings;

# ABSTRACT: Slack WebHook with preset layout & colors for sending slack notifications

BEGIN {

    our $VERSION = '0.003'; # VERSION: generated by DZP::OurPkgVersion
}

use Simple::Accessor qw{
  url
  json
  auto_detect_utf8
  _http
  _started_at
};

use HTTP::Tiny;
use JSON::XS ();
use Encode   ();

use constant SLACK_COLOR_START   => '#2b3bd9';    # blue
use constant SLACK_COLOR_OK      => '#2eb886';    # green
use constant SLACK_COLOR_INFO    => '#4b42f4';    # blue
use constant SLACK_COLOR_ERROR   => '#cc0000';    # red
use constant SLACK_COLOR_WARNING => '#f5ca46';    # yellowish

sub _build_url {
    die q[Missing URL, please set it using Slack::WebHook->new( url => ... )];
}

sub _build__http {
    return HTTP::Tiny->new(
        default_headers => {
            'Content-Type' => 'application/json; charset=UTF-8',
        }
    );
}

sub _build_json {
    return JSON::XS->new->utf8(0)->pretty(1);
}

# by default on
sub _build_auto_detect_utf8 { 1 }

sub post {
    my ( $self, @opts ) = @_;

    die "post method only takes one argument: txt or hash ref"
      if scalar @opts > 1;

    my $txt_or_ref = $opts[0];
    my $data       = ref $txt_or_ref ? $txt_or_ref : { text => $txt_or_ref };

    return $self->_http_post($data);
}

sub post_start {
    my ( $self, @args ) = @_;

    $self->_started_at( scalar time() );

    return $self->_notify(
        { color => SLACK_COLOR_START },
        @args
    );
}

sub post_end {
    my ( $self, @args ) = @_;

    my $delta = int( ( time() - ( $self->_started_at() // 0 ) ) );

    my $timestr = '';

    my $hours = int( $delta / 3600 );
    if ($hours) {
        $delta -= $hours * 3600;
        $timestr .= " " if length $timestr;
        $timestr .= "$hours hour" . ( $hours > 1 ? 's' : '' );
    }
    my $minutes = int( $delta / 60 );
    if ($minutes) {
        $delta -= $minutes * 60;
        $timestr .= " " if length $timestr;
        $timestr .= "$minutes minute" . ( $minutes > 1 ? 's' : '' );
    }
    my $seconds = $delta;
    {
        $timestr .= " " if length $timestr;
        $timestr .= "$seconds second" . ( $seconds > 1 ? 's' : '' );
    }

    return $self->_notify(
        {
            color => SLACK_COLOR_OK,
            $delta > 0 ? ( post_text => "\n_run time: ${timestr}_" ) : ()
        },
        @args
    );
}

sub post_ok {
    my ( $self, @args ) = @_;

    return $self->_notify(
        { color => SLACK_COLOR_OK },
        @args
    );

    # could also work
    #return $self->notify_slack( @args );
}

sub post_warning {
    my ( $self, @args ) = @_;

    return $self->_notify(
        { color => SLACK_COLOR_WARNING },
        @args
    );
}

sub post_error {
    my ( $self, @args ) = @_;

    return $self->_notify(
        { color => SLACK_COLOR_ERROR },
        @args
    );
}

sub post_info {
    my ( $self, @args ) = @_;

    return $self->_notify(
        { color => SLACK_COLOR_INFO },
        @args
    );
}

sub _notify {
    my ( $self, $defaults, @args ) = @_;

    die("defaults should be a Hash Ref") unless ref $defaults eq 'HASH';
    my @user;

    my $nb_args = scalar @args;

    if ( $nb_args <= 1 ) {
        @user = ( text => $args[0] );
    }
    else {

        if ( $nb_args % 2 ) {
            my (@caller) = caller(1);
            my $called_by = $caller[3] // 'unknown';

            die q[Invalid number of args from $called_by];
        }

        @user = @args;
    }

    return $self->notify_slack( %$defaults, @user );
}

sub notify_slack {
    my ( $self, @args ) = @_;

    my ( $color, $title, $text );

    my $nb_args = scalar @args;
    die q[No arguments to notify_slack] unless $nb_args;

    if ( $nb_args == 1 ) {
        $text = $args[0];
    }
    else {
        die q[Invalid number of arguments] if $nb_args % 2;
        my %opts = @args;

        $color = $opts{color};
        $title = $opts{title};                                         # can be undefined
        $text  = $opts{text} // $opts{body} // $opts{content} // '';

        $text .= $opts{post_text} if defined $opts{post_text};
    }

    # title can be undefined
    $color //= SLACK_COLOR_OK;
    $text  //= '';

    my $data = {
        attachments => [
            {
                defined $title ? ( title => $title ) : (),
                color     => $color,
                text      => $text,
                mrkdwn_in => [qw/text title/],
            }
        ]
    };

    return $self->_http_post($data);
}

sub _http_post {
    my ( $self, $data ) = @_;

    die unless ref $data eq 'HASH';

    if ( $self->auto_detect_utf8 ) {
        foreach my $field (qw{text title post_text}) {
            if ( defined $data->{$field} ) {
                if ( !Encode::is_utf8( $data->{$field} ) ) {
                    Encode::_utf8_on( $data->{$field} );
                }
            }
        }
    }

    return $self->_http->post_form(
        $self->url,
        { payload => $self->json->encode($data) },
    );

}

1;

__END__