NAME

App::Dochazka::REST::Dispatch - Implementation of top-level resources

DESCRIPTION

This module contains the init_router method as well as all the resource handlers referred to in the resource definitions.

PACKAGE VARIABLES

This module uses some package variables, which are essentially constants, to do its work.

FUNCTIONS

Router initialization method

The "router" (i.e., Path::Router instance) is initialized when the first request comes in, as a first step before any processing of the request takes place.

This happens when Web::MREST::Resource calls the init_router method.

init_router

App::Dochazka::REST implements its own init_router method, overriding the default one in Web::MREST::InitRouter.

Top-level handlers

These are largely (but not entirely) copy-pasted from Web::MREST::Dispatch.

handler_bugreport

Handler for the bugreport resource.

handler_configinfo

Handler for the configinfo resource.

handler_dbstatus

Handler for the dbstatus resource.

handler_docu

The definition of resource $docu_resource lacks a 'documentation' property EOH # if they want POD, give them POD; if they want HTML, give them HTML, etc. if ( $resource_name eq 'docu/pod' ) { $pl->{'format'} = 'POD'; $pl->{'documentation'} = $docs; } elsif ( $resource_name eq 'docu/html' ) { $pl->{'format'} = 'HTML'; $pl->{'documentation'} = pod_to_html( $docs ); } else { # fall back to plain text $pl->{'format'} = 'text'; $pl->{'documentation'} = pod_to_text( $docs ); } return $CELL->status_ok( 'DISPATCH_ONLINE_DOCUMENTATION', payload => $pl ); }

handler_echo

Echo request body back in the response

handler_forbidden

Handler for 'forbidden' resource.

handler_param

Handler for 'param/:type/:param' resource.

handler_noop

Generalized handler for resources that don't do anything.

Handler for the session resource.

handler_version

Handler for the version resource.

Activity handlers

handler_get_activity_all

Handler for 'GET activity/all'

handler_get_activity_all_disabled

Handler for 'GET activity/all/disabled'

handler_post_activity_aid

Handler for 'POST activity/aid' resource.

handler_post_activity_code

Handler for 'POST activity/code' resource. This is a little more complicated because it can be either create or modify.

handler_activity_aid

Handler for the 'activity/aid/:aid' resource.

handler_get_activity_code

Handler for the 'GET activity/code/:code' resource.

handler_delete_activity_code

Handler for the 'DELETE activity/code/:code' resource.

handler_put_activity_code

Handler for the 'PUT activity/code/:code' resource.

Employee handlers

handler_get_employee_count

Handler for 'GET employee/count/?:priv' resource.

handler_get_employee_list

Handler for 'GET employee/list/?:priv' resource.

handler_get_employee_team

Handler for 'GET employee/team' resource.

handler_whoami

Handler for GET requests on the 'whoami', 'employee/current', and 'employee/self' resources (which are all synonyms).

handler_get_employee_self_privsched

Handler for GET requests on 'employee/self/priv' and 'employee/current/priv', which are synonymous resources.

handler_put_employee_eid

Handler for 'PUT employee/eid/:eid' - can only be update.

handler_post_employee_eid

Handler for 'POST employee/eid' - can only be update.

handler_put_employee_nick

Handler for 'PUT employee/nick/:nick' - a little complicated because it can be insert or update, depending on whether or not the employee exists.

handler_post_employee_nick

Handler for 'POST employee/nick' - a little complicated because it can be insert or update, depending on whether or not the employee exists.

handler_post_employee_self

Handler for 'POST employee/{current,self}' resources. The request entity is supposed to contain a list of key:value pairs where the keys are properties of the employee object and the values are new values for those properties, e.g.:

    { 
        "fullname" : "Bubba Jones",
        "nick" : "bubba"
    }

Note that it should be possible to set a property to null:

    { "fullname" : null }

The JSON will be converted into a Perl hashref, of course, and that will be handed off to the DBI for insertion into placeholders in an UPDATE statement.

handler_delete_employee_eid

Handler for 'DELETE employee/eid/:eid' resource.

handler_get_employee_eid

Handler for 'GET employee/eid/:eid'

handler_get_employee_ldap

Handler for 'GET employee/nick/:nick/ldap' resource.

handler_put_employee_ldap

Handler for 'PUT employee/nick/:nick/ldap' resource.

handler_get_employee_minimal

Handler for 'GET employee/eid/:eid/minimal' resource. Handler for 'GET employee/nick/:nick/minimal' resource. Handler for 'GET employee/sec_id/:sec_id/minimal' resource.

handler_get_employee_eid_team

Handler for 'GET employee/eid/:eid/team'

handler_get_employee_nick_team

Handler for 'GET employee/nick/:nick/team'

handler_delete_employee_nick

Handler for 'DELETE employee/nick/:nick'

handler_get_employee_nick

Handler for 'GET employee/nick/:nick'

handler_get_employee_sec_id

Handler for 'GET employee/sec_id/:sec_id'

handler_get_employee_search_nick

Handler for 'GET employee/search/nick/:key'

History handlers

handler_history_self

Handler method for the '{priv,schedule}/history/self/?:tsrange' resource.

handler_history_get

Handler method for GET requests on the '/{priv,schedule}/history/eid/..' and '/{priv,schedule}/history/nick/..' resources.

handler_history_post

Handler method for POST requests on the '/{priv,schedule}/history/eid/..' and '/{priv,schedule}/history/nick/..' resources.

handler_history_get_phid

Handler for 'GET priv/history/phid/:phid'

handler_history_post_phid

Handler for 'POST priv/history/phid/:phid'

handler_history_delete_phid

handler_history_get_shid

Handler for 'GET schedule/history/shid/:shid'

handler_history_post_shid

Handler for 'POST priv/history/shid/:shid'