File Coverage

blib/lib/Catalyst/TraitFor/Controller/Ping.pm

Criterion	Covered	Total	%
statement	1	3	33.3
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	2	4	50.0

package Catalyst::TraitFor::Controller::Ping;
our $VERSION = '0.001';

#ABSTRACT: Provides a ping action for consuming controllers

use MooseX::MethodAttributes::Role;
use namespace::autoclean;
use Try::Tiny;


has model_name => (isa => 'Str', is => 'ro', predicate => 'has_model_name', clearer => '_clear_model_name', writer => '_set_model_name');


has model_method => (isa => 'Str', is => 'ro', predicate => 'has_model_method', clearer => '_clear_model_method', writer => '_set_model_method');


has model_method_arguments => (isa => 'ArrayRef', is => 'ro', predicate => 'has_model_method_arguments', clearer => '_clear_model_method_arguments', writer => '_set_model_method_arguments');


sub ping :Local
{
    my ($self, $c) = @_;

    if($self->has_model_name)
    {
        my $model = $c->model($self->model_name);

        if(!defined($model))
        {
            $c->error("Unable to find model '${\$self->model_name}'");
            $c->detach();
        }
        elsif($self->has_model_method)
        {
            my $args;

            if($self->has_model_method_arguments)
            {
                $args = $self->model_method_arguments;
            }

            try
            {
                $model->${\$self->model_method}(@$args);
            }
            catch
            {
                $c->error("Problem calling '${\$self->model_method}' on '${\$self->model_name}': $_");
                $c->detach();
            }
        }
    }
}

1;


=pod

=head1 NAME

Catalyst::TraitFor::Controller::Ping - Provides a ping action for consuming controllers

=head1 VERSION

version 0.001

=head1 SYNOPSIS

 package MyApp::Controller::Foo;
 use Moose;
 use namespace::autoclean;
 BEGIN { extends 'Catalyst::Controller' }

 with 'Catalyst::TraitFor::Controller::Ping';

 __PACKAGE__->config
 (
    {
        model_name => 'SomeModel',
        model_method => 'some_method',
        model_method_arguments => [qw/ one two three /],
    }
 );

 ...

=head1 DESCRIPTION

Ever wanted to monitor a web app? With this simple role, you can easily add an action to L</ping> to test if the app is up and running. You can even define a L</model_name> and a L</model_method> to call so it perihperally tests the app's connection to the database (or some other resource). Simply add exceptions for L</ping> in your ACL, and you're good to go.

=head1 PUBLIC_ATTRIBUTES

=head2 model_name

 isa: Str, is: ro

Define a model name to access via $c->model();

=head2 model_method

 isa: Str, is: ro

Define a method name to call upon the model

=head2 model_method_arguments

 isa: ArrayRef, is: ro

Define arguments to pass to the method upon the model

=head1 PUBLIC_METHODS

=head2 ping

 :Local

ping is an action added to which ever controller consumes this role that simply returns. If a L</model_name> is configured, the model will be gathered via $c->model(). If L</model_method> is configured, that method will be called upon the retrived model. If L</model_method_arguments> are provided, they will be passed to the model method. The return value is discarded. Only that the method executed without exception matters for ping. Ping will return no content so it doesn't forward to views or anything else.

=head1 AUTHOR

  Nicholas Perez <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Infinity Interactive, Inc..

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

=cut


__END__