NAME

Clustericious - A framework for RESTful processing systems.

VERSION

version 0.9936

SYNOPSIS

Generate a new Clustericious application:

 % clustericious generate app MyApp

Generate a new Clustericious application database schema:

 % clustericious generate mbd_app MyApp --schema schema.sql

Basic application layout:

 package MyApp;
 
 use Mojo::Base qw( Clustericious::App );
 
 sub startup
 {
   my($self) = @_;
   # just like Mojolicious startup()
 }
 
 package MyApp::Routes;
 
 use Clustericious::RouteBuilder;
 
 # Mojolicious::Lite style routing
 get '/' => sub { shift->render(text => 'welcome to myapp') };

Basic testing for Clustericious application:

 use Test::Clustericious::Cluster;
 use Test::More tests => 4;
 
 # see Test::Clustericious::Cluster for more details
 # and examples.
 my $cluster = Test::Clustericious::Cluster->new;
 $cluster->create_cluster_ok('MyApp');    # 1
 
 my $url = $cluster->url;
 my $t   = $cluster->t;   # Test::Mojo object
 
 $t->get_ok("$url/")                      # 2
   ->status_is(200)                       # 3
   ->content_is('welcome to myapp');      # 4
 
 __DATA__
 
 @ etc/MyApp.conf
 ---
 url: <%= cluster->url %>

DESCRIPTION

Clustericious is a web application framework designed to create HTTP/RESTful web services that operate on a cluster, where each service does one thing and ideally does it well. The design goal is to allow for easy deployment of applications. Clustericious is based on the Mojolicious and borrows some ideas from Mojolicious::Lite (Clustericious::RouteBuilder is based on Mojolicious::Lite routing).

Two examples of Clustericious applications on CPAN are Yars the archive server and PlugAuth the authentication server.

FEATURES

Here are some of the distinctive aspects of Clustericious :

• Simplified route builder based on Mojolicious::Lite (see Clustericious::RouteBuilder).

• Provides a set of default routes (e.g. /status, /version, /api) for consistent interaction with Clustericious services (see Clustericious::RouteBuilder::Common).

• Introspects the routes available and publishes the API as /api.

• Automatically handle different formats (YAML or JSON) depending on request (see Clustericious::Plugin::AutodataHandler).

• Interfaces with Clustericious::Client to allow easy creation of clients.

• Uses Clustericious::Config for configuration.

• Uses Clustericious::Log for logging.

• Integrates with Module::Build::Database and Rose::Planter to provide a basic RESTful CRUD interface to a database.

• Provides 'stop' and 'start' commands, and high-level configuration facilities for a variety of deployment options.

TODO

I am ramping up to a release candidate and a final release for 1.00. Specific things that need to be completed for this task include (but are not limited to):

• documentation tutorial for a non database app

• documentation tutorial for a Module::Build::Database / Rose::Planter app (replacement for the existing README, which is broken)

• use SQLite for above instead of Postgres

• documentation tutorial for migrating SQLite app to Postgres

• documentation tutorial for clients (Clustericious::Client)

• remove TEST_HARNESS detection / dependency (see GH#8)

NOTES

This is a beta release. The API is subject to change without notice.

AUTHOR

original author: Brian Duggan

current maintainer: Graham Ollis <plicease@cpan.org>

contributors:

Curt Tilmes

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by NASA GSFC.

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

cpanm Clustericious

perl -MCPAN -e shell
install Clustericious