Log::Dispatch::FogBugz - Log::Dispatch appender for sending log messages to the FogBugz bug tracking system

Log-Dispatch-FogBugz documentation Contained in the Log-Dispatch-FogBugz distribution.

Index

Code Index:

NAME

Top

Log::Dispatch::FogBugz - Log::Dispatch appender for sending log messages to the FogBugz bug tracking system

VERSION

Top

Version 0.01

SYNOPSIS

Top

    use Log::Dispatch::FogBugz;

    my $log = Log::Dispatch::FogBugz->new
        (
            URL               => 'http://fogbugz.bar.com/scoutSubmit.php'
          , Project           => 'Bar'
          , Area              => 'Baz'
          , ForceNewBug       => 0
          , User              => 'Bob the Submitter'
          , DescriptionPrefix => 'Log4perl error!'
          , DescriptionRegex  => qr/> (.+)$/
        );
    $log->log( message => "FATAL> main::do_baz(23) - Something really bad happened here", level => 'fatal' );

DESCRIPTION

Top

This is a subclass of Log::Dispatch::Output that implements sending log messages to a FogBugz (http://fogcreek.com/fogbugz) bug tracking system.

METHODS

Top

* new

This method takes configuration parameters as follows:

* URL ($) Required

Fully qualified url for fogbugz scoutsubmit script.

* Project ($) Required

The project to create this bug message in.

* Area ($) Required

The area within the given project.

* ForceNewBug (0|1)

Whether or not to force the creation of a new bug

* User ($) Required

Username to use when submitting.

* DescriptionPrefix ($) Optionally Required

String to use as either a prefix or a full description for the error. One of DescriptionRegex or DescriptionPrefix are required.

* DescriptionRegex (Regex) Optionally Required

Capturing regex to use to dynamically pull out the description. $1 will be used as the description. Will be concatenated to DescriptionPrefix if set. One of DescriptionRegex or DescriptionPrefix are required.

* log_message( level => $, message => $ )

Sends the message if the level is greater than or equal to the object's minimum level.

SEE ALSO

Top

Log::Log4perl::Config, Log::Log4perl::Appender, Log::Dispatch,

AUTHOR

Top

DIMARTINO, <chris.dimartino at gmail.com>

BUGS

Top

Please report any bugs or feature requests to bug-log-dispatch-fogbugz at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Log-Dispatch-FogBugz. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

Top

You can find documentation for this module with the perldoc command.

    perldoc Log::Dispatch::FogBugz

You can also look for information at:

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=Log-Dispatch-FogBugz

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/Log-Dispatch-FogBugz

* CPAN Ratings

http://cpanratings.perl.org/d/Log-Dispatch-FogBugz

* Search CPAN

http://search.cpan.org/dist/Log-Dispatch-FogBugz/

ACKNOWLEDGEMENTS

Top

Thanks to the authors of Log::Log4perl and Log::Dispatch modules.

COPYRIGHT & LICENSE

Top

Copyright 2009 CDIMARTINO, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Log-Dispatch-FogBugz documentation Contained in the Log-Dispatch-FogBugz distribution. 
package Log::Dispatch::FogBugz;

use warnings;
use strict;
use Log::Dispatch::Output;
use base qw/Log::Dispatch::Output/;
use Carp qw{croak};

use LWP::UserAgent;

our $VERSION = '0.1';

sub new {
  my $proto = shift;
  my $class = ref $proto || $proto;

  my %p = @_;

  my $self = bless {}, $class;

  $self->_basic_init(%p);
  $self->_init(%p);
  return $self;
}

sub log_message {
    my $self = shift;
    my %p = @_;

    $self->{form}{Description} = $self->{params}{DescriptionPrefix} ? $self->{params}{DescriptionPrefix} : '';
    $p{message} =~ $self->{params}{DescriptionRegex};

    if ( $1 ) {
        $self->{form}{Description} .= $1;
    }

    $self->{form}{Extra} = $p{message};

    my $ua = LWP::UserAgent->new;
    my $resp = $ua->post($self->{params}{URL}, $self->{form});
}

sub _init {
    my ( $self, %opts ) = @_;
    $self->{params} = \%opts;

    foreach my $req ( qw/URL Project User Area/ ) {
        croak "Required configuration parameter `$req` was not defined" unless defined $opts{$req};
    }

    unless ( $opts{DescriptionPrefix} or $opts{DescriptionRegex} ) {
        croak "One of DescriptionPrefix or DescriptionRegex options are required";
    }

    if ( $opts{DescriptionRegex} and ref($opts{DescriptionRegex}) ne 'Regexp' ) {
        croak "DescriptionRegex must be a compiled regex (use qr{})";
    }

    $self->{form} = {
        ScoutProject      => $opts{Project}
      , ScoutUserName     => $opts{User}
      , ScoutArea         => $opts{Area}
      , ForceNewBug       => ( $opts{ForceNewBug} || 0 )
      , FriendlyResponse  => 0
    };
}

__END__


1; # End of Log::Dispatch::FogBugz