NAME

MojoX::Dispatcher::Qooxdoo::Jsonrpc - Dispatcher for Qooxdoo Json Rpc Calls

SYNOPSIS

# lib/your-application.pm

use base 'Mojolicious';

use RpcService;

sub startup {
   my $self = shift;
   
   # instantiate all services
   my $services= {
       Test => RpcService->new(),
       
   };
   
   
   # add a route to the Qooxdoo dispatcher and route to it
   my $r = $self->routes;
   $r->route('/qooxdoo') -> to(
               'Jsonrpc#dispatch', 
               services    => $services, 
               debug       => 0,
               namespace   => 'MojoX::Dispatcher::Qooxdoo'
           );
       
}

   

DESCRIPTION

MojoX::Dispatcher::Qooxdoo::Jsonrpc dispatches incoming rpc requests from a qooxdoo application to your services and renders a (hopefully) valid json reply.

EXAMPLE

This example exposes a service named "Test" in a folder "RpcService". The Mojo application is named "QooxdooServer". The scripts are in the 'example' directory. First create this application using "mojolicious generate app QooxdooServer".

Then, lets write the service:

Change to the root directory "qooxdoo_server" of your fresh Mojo-Application and make a dir named 'qooxdoo-services' for the services you want to expose.

Our "Test"-service could look like:

package RpcService;

use base qw(Mojo::Base);

# if this attribute is created it will hold the mojo cookie session hash
__PACKAGE__->attr('_mojo_session');
# if this attribute exists it will provide access to the stash
__PACKAGE__->attr('_mojo_stash');

# optional access_check method the method is called right before the actual
# method is called but after the _mojo_session and _mojo_stash properties
# are assigned

sub _check_access {
   my $self = shift;
   my $method = shift;          
   # check if we can access
   return 1; # if ok
}

sub add{
   my $self = shift;
   my @params = @_;
   
   # Debug message on Mojo-server console (or log)
   print "Debug: $params[0] + $params[1]\n";
   
   # uncomment if you want to die without further handling
   # die;
   
   # uncomment if you want to die with a message in a hash
   # die {code => 20, message => "Test died on purpose :-)"};
   
   
   # uncomment if you want to die with your homemade error object 
   # (simple example see below)
   # better use your elaborate error handling instead!
   
   # use Error;
   # my $error = new Error('stupid error message', '56457');
   # die $error;
   
   my $result =  $params[0] + $params[1]
   return $result;
   
}

1;


# Example of simple and stupid Error class:

package Error;

sub new{
   my $class = shift;
   
   my $error = {
       message => shift;
       code    => shift;
   };
   
   bless $error, $class;
   return $error;
}

sub message{
   my $self = shift;
   return $self->{message};
}

sub code{
   my $self = shift;
   return $self->{code};
}

1;

Please create a constructor (like "new" here) which instantiates an object because we are going to use this in our 'lib/QooxdooServer.pm' below.

Notice the exception handling: You can die without or with a message (see example above). MojoX::Dispatcher::Qooxdoo::Jsonrpc will catch the "die" like an exception an send a message to the client. Happy dying! :-)

Now, lets write our application. Almost everything should have been prepared by Mojo when you invoked "mojolicious generate app QooxdooServer" (see above).

Change to "lib/" and open "QooxdooServer.pm" in your favourite editor. Then add some lines to make it look like this:

package QooxdooServer;

use strict;
use warnings;

use RpcService::Test;

use base 'Mojolicious';

# This method will run once at server start
sub startup {
   my $self = shift;
   
   my $services= {
       Test => new RpcService::Test(),
       # more services here
   };
   
   # tell Mojo about your services:
   my $r = $self->routes;
   
   # this sends all requests for "/qooxdoo" in your Mojo server 
   # to our little dispatcher.
   # change this at your own taste.
   $r->route('/qooxdoo')->to('
       jsonrpc#dispatch', 
       services    => $services, 
       debug       => 0,
       namespace   => 'MojoX::Dispatcher::Qooxdoo'
   );
   
}

1;

Now start your Mojo Server by issuing 'script/QooxdooServer daemon'. If you want to change any options, type 'script/QooxdooServer help'.

Security MojoX::Dispatcher::Qooxdoo::Jsonrpc only allows methods matching this pattern: /^[a-zA-Z_]+$/ This means you are allowed to use letters and the underscore. Be aware that methods starting with an underscore are private by convention and not exposed.

Only services explicitly loaded in lib/your-application.pm will be accessible.

AUTHOR

Matthias Bloch, <lt>matthias at puffin ch<gt> This Module is sponsored by OETIKER+PARTNER AG

COPYRIGHT AND LICENSE

Copyright (C) 2010 by :m)

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.