NAME
App::Dochazka::REST::Resource - web resource definition
VERSION
Version 0.125
SYNOPSIS
In PSGI file:
use Web::Machine;
Web::Machine->new(
resource => 'App::Dochazka::REST::Resource',
)->to_app;DESCRIPTION
This is where we override the default versions of various methods defined by our "highway to H.A.T.E.O.S.": Web::Machine.
(Methods not defined in this module will be inherited from Web::Machine::Resource.)
Do note, however, that none of the routines in this module are called by App::Dochazka::REST.
PACKAGE VARIABLES
METHODS
content_types_provided
Web::Machine calls this routine to determine how to generate the response body. It says: "generate responses in JSON using the 'render' method".
render_html
Whip out some HTML to educate passersby.
render_json
Encode the context as a JSON string.
context
This method is where we store data that needs to be shared among various "users" of the given object (i.e. among routines in this module).
router
Accessor. Takes one parameter -- the method. Returns the router instance for that method.
charsets_provided
This method causes Web::Machine to encode the response body in UTF-8.
default_charset
Really use UTF-8 all the time.
allowed_methods
Determines which HTTP methods we recognize.
uri_too_long
Is the URI too long?
is_authorized
Authentication method.
Authenticate the originator of the request, using HTTP Basic Authentication. Upon successful authentication, check that the user (employee) exists in the database (create if necessary) and retrieve her EID. Push the EID and current privilege level onto the context.
forbidden
Authorization (ACL check) method.
First, parse the path and look at the method to determine which controller action the user is asking us to perform. Each controller action has an ACL associated with it, from which we can determine whether employees of each of the four different privilege levels are authorized to perform that action.
Requests for non-existent resources will always pass the ACL check.
If the request passes the ACL check, the mapping (if any) is pushed onto the context for use in the "resource_exists" routine which actually runs the action.
resource_exists
If the resource exists, its mapping will have been determined in the "forbidden" routine. So, our job here is to execute the appropriate target if the mapping exists. Executing the target builds the response entity.
_push_onto_context
Takes a hashref and "pushes" it onto $self->{'context'} for use later on in the course of processing the request.
_make_json
Makes the JSON for inclusion in the response entity.
_authenticate
Authenticate the nick associated with an incoming REST request. Takes a nick and a password (i.e., a set of credentials). Returns a status object, which will have level 'OK' on success (with employee object in the payload), 'NOT_OK' on failure.