File Coverage

blib/lib/Mercury/Controller/PushPull.pm

Criterion	Covered	Total	%
statement	25	25	100.0
branch	2	2	100.0
condition			n/a
subroutine	6	6	100.0
pod	3	3	100.0
total	36	36	100.0

package Mercury::Controller::PushPull;
our $VERSION = '0.016';
# ABSTRACT: Push/pull message pattern controller

#pod =head1 SYNOPSIS
#pod
#pod     # myapp.pl
#pod     use Mojolicious::Lite;
#pod     plugin 'Mercury';
#pod     websocket( '/push/*topic' )
#pod       ->to( controller => 'PushPull', action => 'push' );
#pod     websocket( '/pull/*topic' )
#pod       ->to( controller => 'PushPull', action => 'pull' );
#pod
#pod =head1 DESCRIPTION
#pod
#pod This controller enables a Lpull pattern|Mercury::Pattern::PushPull> on
#pod a pair of endpoints (L and L.
#pod
#pod For more information on the push/pull pattern, see L.
#pod
#pod =head1 SEE ALSO
#pod
#pod =over
#pod
#pod =item L
#pod
#pod =item L
#pod
#pod =back
#pod
#pod =cut

use Mojo::Base 'Mojolicious::Controller';
use Mercury::Pattern::PushPull;

#pod =method push
#pod
#pod     $app->routes->websocket( '/push/*topic' )
#pod       ->to( controller => 'PushPull', action => 'push' );
#pod
#pod Controller action to connect a websocket to a push endpoint. A push client
#pod sends messages through the socket. The message will be sent to one of the
#pod connected pull clients in a round-robin fashion.
#pod
#pod This endpoint requires a C in the stash.
#pod
#pod =cut

sub push {
    my ( $c ) = @_;
    my $pattern = $c->_pattern( $c->stash( 'topic' ) );
    $pattern->add_pusher( $c->tx );
    $c->rendered( 101 );
}

#pod =method pull
#pod
#pod     $app->routes->websocket( '/pull/*topic' )
#pod       ->to( controller => 'PushPull', action => 'pull' );
#pod
#pod Controller action to connect a websocket to a pull endpoint. A pull
#pod client will recieve messages from push clients in a round-robin fashion.
#pod One message from a pusher will be received by exactly one puller.
#pod
#pod This endpoint requires a C in the stash.
#pod
#pod =cut

sub pull {
    my ( $c ) = @_;
    my $pattern = $c->_pattern( $c->stash( 'topic' ) );
    $pattern->add_puller( $c->tx );
    $c->rendered( 101 );
}

#pod =method post
#pod
#pod Post a new message to the given topic without subscribing or
#pod establishing a WebSocket connection. This allows new messages to be
#pod easily pushed by any HTTP client.
#pod
#pod =cut

sub post {
    my ( $c ) = @_;
    my $topic = $c->stash( 'topic' );
    my $pattern = $c->_pattern( $topic );
    $pattern->send_message( $c->req->body );
    $c->render(
        status => 200,
        text => '',
    );
}

#=method _pattern
#
#   my $pattern = $c->_pattern( $topic );
#
# Get or create the L object for the given
# topic.
#
#=cut

sub _pattern {
    my ( $c, $topic ) = @_;
    my $pattern = $c->mercury->pattern( PushPull => $topic );
    if ( !$pattern ) {
        $pattern = Mercury::Pattern::PushPull->new;
        $c->mercury->pattern( PushPull => $topic => $pattern );
    }
    return $pattern;
}

1;

__END__