App::Dochazka::REST::Guide - Dochazka REST server guide
This POD-only module describes the Dochazka REST server (API) in more detail.
Dochazka as a whole aims to be a convenient, open-source ATT solution.
Dochazka consists of three main components:
REST server (this module)
The REST server listens for and processes incoming HTTP requests. Processing includes authentication and authorization. The server attempts to map the request URI to a Dochazka resource. The resource handler takes action on the request, depending on the HTTP method (GET, PUT, POST, DELETE). Typically, this action will culminate in one or more SQL statements which are sent to the PostgreSQL database for execution. The results are sent back to the client in the HTTP reponse.
PostgreSQL database
The PostgreSQL database is configured to listen for incoming SQL statements from the REST server. Based on these statements, it creates, retrieves, updates, and deletes (CRUD) employee attendance records and related data in the Dochazka database.
Dochazka clients
Dochazka clients, such as App::Dochazka::WWW, App::Dochazka::CLI, and perhaps others, present a user interface (UI) to employees, by which they try to divine their intent and express it in terms of HTTP requests to the REST server.
The HTTP protocol is used in all communication between client and server. In Dochazka, the term "client" should be understood in a broad sense to mean anything that communicates with the server using the HTTP protocol. This encompasses stand-alone report generators, specialized administration utilities, cronjobs, web browsers, etc., in addition to the purpose-built clients or just plain curl.
curl
Installation is the process of creating (setting up, bootstrapping) a new Dochazka instance, or "site" in Dochazka terminology.
It entails the following steps.
Dochazka REST needs hardware (either physical or virtualized) to run on. The hardware will need to have a network connection, etc. Obviously, this step is entirely beyond the scope of this document.
Once the hardware is ready, the Dochazka REST software and all its dependencies are installed on it. This could be accomplished by downloading and unpacking the tarball (or running git clone) and following the installation instructions, or, more expediently, by installing a packaged version of Dochazka REST if one is available (see https://build.opensuse.org/package/show/home:smithfarm/perl-App-Dochazka-REST).
git clone
One of Dochazka REST's principal dependencies is PostgreSQL server (version 9.2 or higher). This needs to be installed (should happen automatically when using the packaged version of App::Dochazka::REST). Steps to enable it:
bash# systemctl enable postgresql.service bash# systemctl start postgresql.service bash# su - postgres bash$ psql postgres postgres-# ALTER ROLE postgres WITH PASSWORD 'mypass'; ALTER ROLE
At this point, we exit psql and, still as the user postgres, we edit pg_hba.conf. In SUSE distributions, this file is located in data/ under the postgres home directory. Using our favorite editor, we change the METHOD entry for local so it looks like this:
psql
postgres
pg_hba.conf
data/
local
# TYPE DATABASE USER ADDRESS METHOD local all all password
For the audit triggers to work (and the application will not run otherwise), we must to add the following line to the end of postgresql.conf (also located in data/ in SUSE distros):
postgresql.conf
dochazka.eid = -1
Then, as root, we restart the postgresql service:
bash# systemctl restart postgresql.service
Lastly, check if you can connect to the postgres database using the password:
bash$ psql --username postgres postgres Password for user postgres: [...type 'mypass'...] psql (9.2.7) Type "help" for help. postgres=#
To exit, type \q at the postgres prompt:
\q
postgres=# \q bash$
Before the Dochazka REST database can be initialized, we will need to tell App::Dochazka::REST about the PostgreSQL superuser password that we set in the previous step. This is done via a site parameter. There may be other site params we will want to set, but the following is sufficient to run the test suite.
First, create a sitedir:
bash# mkdir /etc/dochazka-rest
and, second, a file therein:
# cat << EOF > /etc/dochazka-rest/REST_SiteConfig.pm set( 'MREST_DEBUG_MODE', 1 ); set( 'DBINIT_CONNECT_SUPERAUTH', 'mypass' ); set( 'DOCHAZKA_REST_LOG_FILE', "dochazka-rest.log" ); set( 'DOCHAZKA_REST_LOG_FILE_RESET', 1); EOF #
Where 'mypass' is the PostgreSQL password you set in the 'ALTER ROLE' command, above.
The DBINIT_CONNECT_SUPERAUTH setting is only needed for database initialization (see below), when App::Dochazka::REST connects to PostgreSQL as user 'postgres' to drop/create the database. Once the database is created, App::Dochazka::REST connects to it using the PostgreSQL credentials of the current user.
DBINIT_CONNECT_SUPERAUTH
To initialize the database or reset it to a pristine state:
$ dochazka-resetdb
Note that this is a two-step process. The first step is to create the database, role, extensions etc. - i.e., everything that requires database superuser permissions. The second step is to create the schemas, etc. For this, the ordinary "dochazka" role is used.
In a production setting, or whenever the two steps need to be done separately, the database administrator can perform the first step using the "psql" command in bin/dochazka-resetdb. After that, the second step can be performed by simply running
bin/dochazka-resetdb
$ dochazka-dbinit
The last step is to start the Dochazka REST server. In the future, this will be possible using a command like systemctl start dochazka-rest.service. At the moment, however, we are still in development/testing phase and we start the server like this:
systemctl start dochazka-rest.service
$ dochazka-rest Starting Web::MREST ver. 0.282 App distro is App-Dochazka-REST App module is App::Dochazka::REST::Dispatch Distro sharedir is /usr/lib/perl5/site_perl/5.18.2/auto/share/dist/App-Dochazka-REST Local site configuration directory is /etc/dochazka-rest Loading configuration parameters from /etc/dochazka-rest Setting up logging Logging to /home/smithfarm/mrest.log Calling App::Dochazka::REST::Dispatch::init() Starting server HTTP::Server::PSGI: Accepting connections at http://0:5000/
Note that the development web server HTTP::Server::PSGI is used. To use Starman instead, use the following command:
$ dochazka-rest -- --server Starman
Point your browser to http://localhost:5000/
The server assumes all incoming requests are encoded in UTF-8, and it encodes all of its responses in UTF-8 as well.
In order to protect user passwords from network sniffing and other nefarious activities, it is recommended that the server be set up to accept HTTPS requests only.
Another implication of REST is that the server provides "resources" and that those resources are, to some extent at least, self-documenting.
Some resources (those that use the GET method) are accessible using a web browser. That said, if we are only interested in displaying information from the database, GET requests are all we need and using a web browser can be convenient.
To start exploring, fire up a standard web browser and point it to the base URI of your App::Dochazka::REST installation:
http://dochazka.site
and entering one's credentials in the Basic Authentication dialog.
To access all the resources, you will need a client that is capable of generating POST, PUT, and DELETE requests as well as GET requests. Also, since some of the information App::Dochazka::REST provides is in the response headers, the client needs to be capable of displaying those as well.
One such client is Daniel Stenberg's curl.
In the HTTP request, the client may provide an Accept: header specifying either HTML (text/html) or JSON (application/json). For the convenience of those using a web browser, HTML is the default.
Accept:
text/html
application/json
Here are some examples of how to use curl (or a web browser) to explore resources. These examples assume a vanilla installation of App::Dochazka::REST with the default root password. The same commands can be used with a production server, but keep in mind that the resources you will see may be limited by your privilege level.
GET resources
The GET method is used to search for and display information. The top-level GET resources are listed at the top-level URI, either using curl
$ curl -v -H 'Accept: application/json' http://demo:demo@dochazka.site/
Similarly, to display a list of sub-resources under the 'privhistory' top-level resource, enter the command:
$ curl http://demo:demo@dochazka.site/employee -H 'Accept: application/json'
Oops - no resources are displayed because the 'demo' user has only passerby privileges, but all the privhistory resources require at least 'active'. To see all the available resources, we can authenticate as 'root':
$ curl http://root:immutable@dochazka.site/employee -H 'Accept: application/json'
POST resources
With the GET method, we could only access resources for finding and displaying information: we could not add, change, or delete information. For that we will need to turn to some other client than the web browser -- a client like curl that is capable of generating HTTP requests with methods like POST (as well as PUT and DELETE).
Here is an example of how we would use curl to display the top-level POST resources:
curl -v http://root:immutable@dochazka.site -X POST -H "Content-Type: application/json"
The "Content-Type: application/json" header is necessary because the server only accepts JSON in the POST request body -- even though in this case we did not send a request body, most POST requests will have one. For best results, the request body should be a legal JSON string represented as a sequence of bytes encoded in UTF-8.
PUT resources
The PUT method is used to add new resources and update existing ones. Since the resources are derived from the underlying database, this implies executing INSERT and UPDATE statements on tables in the database.
PUT resources can be explored using a curl command analogous to the one given for the POST method.
DELETE resources
Any time we need to delete information -- i.e., completely wipe it from the database, we will need to use the DELETE method.
DELETE resources can be explored using a curl command analogous to the one given for the POST method.
Keep in mind that the data integrity constraints in the underlying PostgreSQL database may make it difficult to delete a resource if any other resources are linked to it. For example, an employee cannot be deleted until all intervals, privhistory records, schedhistory records, locks, etc. linked to that employee have been deleted. Intervals, on the other hand, can be deleted as long as they are not subject to a lock.
The definition of each resource includes an HTML string containing the resource's documentation. This string can be accessed via POST request for the docu resource (provide the resource name in double quotes in the request body).
docu
In order to be "self-documenting", the definition of each REST resource contains a "short" description and a "long" POD string. From time to time, the entire resource tree is walked to generate a module, App::Dochazka::REST::Docs::Resources, containing all the resource documentation.
Incoming HTTP requests are handled by App::Dochazka::REST::Resource, which inherits from Web::Machine::Resource. The latter uses Plack to implement a PSGI-compliant stack.
Web::Machine takes a "state-machine" approach to implementing the HTTP 1.1 standard. Requests are processed by running them through a state machine, each "cog" of which is a Web::Machine::Resource method that can be overridden by a child module. In our case, this module is App::Dochazka::REST::Resource.
The behavior of the resulting web server can be characterized as follows:
Allowed methods test
One of the first things the server looks at, when it receives a request, is the method. Only certain HTTP methods, such as 'GET' and 'POST', are accepted. If this test fails, a "405 Method Not Allowed" response is sent.
Internal and external authentication, session management
This takes place when Web::Machine calls the is_authorized method, our implementation of which is in App::Dochazka::REST::Auth.
is_authorized
Though the method is called is_authorized, what it really does is authenticate the request - i.e., validate the user's credentials to determine his or her identity. Authorization - determination whether the user has sufficient privileges to make the request - takes place one step further on. (The HTTP standard uses the term "authorized" to mean "authenticated"; the name of this method is a nod to that usage.)
In is_authorized, the user's credentials are authenticated against an external database (LDAP), an internal database (PostgreSQL 'employees' table), or both. Session management techniques are utilized to minimize external authentication queries, which impose latency. The authentication and session management algorithms are described in "AUTHENTICATION AND SESSION MANAGEMENT". If authentication fails, a "401 Unauthorized" response is sent.
Since this is the first time that the PostgreSQL database is needed, this is also where the DBIx::Connector object is attached to the request context. (The request context is a hashref that accompanies the request as it undergoes processing.) For details, see "is_authorized" in App::Dochazka::REST::Auth.
In a web browser, repeated failed authentication attempts are typically associated with repeated display of the credentials dialog (and no other indication of what is wrong, which can be confusing to users but is probably a good idea, because any error messages could be abused by attackers).
Authorization/ACL check
After the request is authenticated (associated with a known employee), the server examines the ACL profile of the resource being requested and compares it with the employee's privilege level. If the privilege level is too low for the requested operation, a "403 Forbidden" response is sent.
The ACL profile is part of the resource definition. It can be specified either as a single value for all HTTP methods, or as a hash, e.g.:
{ GET => 'passerby', PUT => 'admin', DELETE => 'admin', }
In certain operations (i.e., combinations of HTTP method and resource), the full range of functionality may be available only to administrators. See These operations are special cases. Their ACL profile is either 'inactive' or 'active', but a non-administrator employee may still get a 403 Forbidden error on the operation if they are trying to do something, such as update an interval belonging to a different employee, that is reserved for administrators.
Test for resource existence
The next test a request undergoes on its quest to become a response is the test of resource existence. If the request is asking for a non-existent resource, e.g. http://dochazka.site/employee/curent, it cannot be fulfilled and a "404 Not Found" response will be sent.
For GET requests, this is ordinarily the last cog in the state machine: if the test passes, a "200 OK" response is typically sent, along with a response body. (There are exceptions to this rule, however - see the AUTHORIZATION chapter.) Requests using other methods (POST, PUT, DELETE) are subject to further processing as described below.
Because they are expected to have a request body, incoming POST and PUT requests are subject to the following additional test:
malformed_request
This test examines the request body. If it is non-existent, the test passes. If the body exists and is valid JSON, the test passes. Otherwise, it fails.
known_content_type
Test the request for the 'Content-Type' header. POST and PUT requests should have a header that says:
Content-Type: application/json
If this header is not present, a "415 Unsupported Media Type" response is sent.
#=item * post_is_create # #This test examines the POST request and places it into one of two #categories: (1) generic request for processing, (2) a request that creates #or otherwise manipulates a resource.
This section describes the App::Dochazka::REST data model. Conceptually, Dochazka data can be seen to exist in the following classes of objects:
App::Dochazka::REST
##=item * Policy (parameters set when database is first created) ## =item * Employee (an individual employee)
* Privhistory (history of changes in an employee's privilege level)
* Schedule (a schedule)
* Schedhistory (history of changes in an employee's schedule)
* Activities (what kinds of work are recognized)
* Intervals (the "work", or "attendance", itself)
* Locks (determining whether a reporting period is locked or not)
* Components (Mason components, i.e. report templates)
The "state" of each object is stored in a PostgreSQL database (see "DATABASE" for details).
These classes are described in the following sections.
Users of Dochazka are referred to as "employees" regardless of their legal status -- in reality they might be independent contractors, or students, or even household pets, but as far as Dochazka is concerned they are employees. You could say that "employee" is the Dochazka term for "user".
The purpose of the Employee table/object is to store whatever data the site is accustomed to use to identify its employees.
Within Dochazka itself, employees are distinguished by an internal employee ID number (EID), which is assigned by Dochazka itself when the employee record is created. In addition, four other fields/properties are provided to identify the employee:
nick
sec_id
fullname
email
All four of these, plus the eid field, have UNIQUE constraints defined at the database level, meaning that duplicate entries are not permitted. However, of the four, only nick is required.
eid
UNIQUE
Depending on how authentication is set up, employee passwords may also be stored in this table, using the passhash and salt fields.
passhash
salt
For details, see App::Dochazka::REST::Model::Employee.
Dochazka has four privilege levels: admin, active, inactive, and passerby:
admin
active
inactive
passerby
admin -- employee can view, modify, and place/remove locks on her own attendance data as well as that of other employees; she can also administer employee accounts and set privilege levels of other employees
active -- employee can view her own profile, attendance data, modify her own unlocked attendance data, and place locks on her attendance data
inactive -- employee can view her own profile and attendance data
passerby -- employee can view her own profile
Dochazka's privhistory object is used to track changes in an employee's privilege level over time. Each time an employee's privilege level changes, a Dochazka administrator (i.e., an employee whose current privilege level is 'admin'), a record is inserted into the database (in the privhistory table). Ordinary employees (i.e. those whose current privilege level is 'active') can read their own privhistory.
privhistory
Thus, with Dochazka it is possible not only to determine not only an employee's current privilege level, but also to view "privilege histories" and to determine employees' privilege levels for any date (timestamp) in the past.
For details, see App::Dochazka::REST::Model::Privhistory and "When history changes take effect".
In addition to actual attendance data, Dochazka sites may need to store schedules. Dochazka defines the term "schedule" as a series of non-overlapping "time intervals" (or "timestamp ranges" in PostgreSQL terminology) falling within a single week. These time intervals express the times when the employee is "expected" or "supposed" to work (or be "at work") during the scheduling period.
Example: employee "Barb" is on a weekly schedule. That means her scheduling period is "weekly" and her schedule is an array of non-overlapping time intervals, all falling within a single week.
In its current form, Dochazka is only capable of handling weekly schedules only. Some sites, such as hospitals, nuclear power plants, fire departments, and the like, might have employees on more complicated schedules such as "one week on, one week off", alternating day and night shifts, "on call" duty, etc.
Dochazka can still be used to track attendance of such employees, but if their work schedule cannot be expressed as a series of non-overlapping time intervals contained within a contiguous 168-hour period (i.e. one week), then their Dochazka schedule should be set to NULL.
For details, see App::Dochazka::REST::Model::Schedule.
The schedhistory table contains a historical record of changes in the employee's schedule. This makes it possible to determine an employee's schedule for any date (timestamp) in the past, as well as (crucially) the employee's current schedule.
schedhistory
Every time an employee's schedule is to change, a Dochazka administrator must insert a record into this table. (Employees who are not administrators can only read their own history; they do not have write privileges.) For more information on privileges, see "AUTHORIZATION".
For details, see App::Dochazka::REST::Model::Schedhistory.
While on the job, employees "work" -- i.e., they engage in various activities that are tracked using Dochazka. The activities table contains definitions of all the possible activities that may be entered in the intervals table.
activities
intervals
The initial set of activities is defined in the site install configuration (DOCHAZKA_ACTIVITY_DEFINITIONS) and enters the database at installation time. Additional activities can be added later (by administrators), but activities can be deleted only if no intervals refer to them.
DOCHAZKA_ACTIVITY_DEFINITIONS
Each activity has a code, or short name (e.g., "WORK") -- which is the primary way of referring to the activity -- as well as an optional long description. Activity codes must be all upper-case.
For details, see App::Dochazka::REST::Model::Activity.
Intervals are the heart of Dochazka's attendance data. For Dochazka, an interval is an amount of time that an employee spends doing an activity. In the database, intervals are represented using the tsrange range operator introduced in PostgreSQL 9.2.
tsrange
Optionally, an interval can have a long_desc (employee's description of what she did during the interval) and a remark (admin remark).
long_desc
remark
For details, see App::Dochazka::REST::Model::Interval.
In Dochazka, a "lock" is a record in the "locks" table specifying that a particular user's attendance data (i.e. activity intervals) for a given period (tsrange) cannot be changed. That means, for intervals in the locked tsrange:
existing intervals cannot be updated or deleted
no new intervals can be inserted
Employees can create locks (i.e., insert records into the locks table) on their own EID, but they cannot delete or update those locks (or any others). Administrators can insert, update, or delete locks at will.
How the lock is used will differ from site to site, and some sites may not even use locking at all. The typical use case would be to lock all the employee's attendance data within the given period as part of pre-payroll processing. For example, the Dochazka client application may be set up to enable reports to be generated only on fully locked periods.
"Fully locked" means either that a single lock record has been inserted covering the entire period, or that the entire period is covered by multiple locks.
Any attempts (even by administrators) to enter activity intervals that intersect an existing lock will result in an error.
Clients can of course make it easy for the employee to lock entire blocks of time (weeks, months, years . . .) at once, if that is deemed expedient.
For details, see App::Dochazka::REST::Model::Lock.
Reports are generated from Mason templates which consist of components. Mason expects these components to be stored in text files under a directory called the "component root". For the purposes of Dochazka, the component root is created under the Dochazka state directory, which is determined from the DOCHAZKA_STATE_DIR site parameter (defaults to /var/lib/dochazka). When the server starts, this Mason state in the filesystem is wiped and re-created from the database. The Component class is used to manipulate Mason components.
DOCHAZKA_STATE_DIR
/var/lib/dochazka
Component
This rather complicated setup is designed to enable administrators to develop their own report templates.
Generation of reports is a core function of any ATT system. This section describes the infrastructure Dochazka provides for this purpose. This infrastructure is built around the Mason templating system.
The templates for a sample report are provided with the Dochazka distribution. The idea is that site administrators will develop and add more templates to meet their particular reporting needs.
The Dochazka report generation infrastructure has three parts: a template management API, a report population API, and the report generation resource.
The template management API is a set of REST resources for creating, reading, updating, and deleting Mason components. It is built around a "Component" class, instances of which correspond to individual Mason components.
The report population API is, basically, the Dochazka data model itself. Since Mason enables Perl code to be embedded in templates, and since the templates are processed by the Dochazka server, template authors have the entire Dochazka data model at their disposal.
A REST resource, GET genreport, that takes the path of the Mason component to be run and a hash of arguments to pass to it. The Mason component is run with the provided arguments and the result (a string of characters that can be interpreted as, e.g., an HTML page) is returned in the response content body.
GET genreport
The Component class is used to work with Mason components. Each instance has the following three attributes:
The relative path to the component in the Mason component directory tree.
The source code of the component, e.g. a mixture of HTML with Mason directives.
The ACL profile of the component, determining who can use it. As usual, supervisors can generate reports pertaining to employees who report directly to them.
For the time being, the Component class does not implement any argument validation. It is up to the caller to provide valid arguments when the component is called.
Let us examine a typical reporting requirement: a summary of one employee's activity over the course of a time interval.
In addition to the employee's name, etc., this will require a data set consisting of the days of the month and the total number of hours of each activity logged by (or for) the employee on each day.
Be careful when entering unbounded intervals: PostgreSQL 9.3 is picky about how they are formatted. This, for example, is syntactically correct:
select * from intervals where intvl && '[,)';
But this will generate a syntax error:
select * from intervals where intvl && '[, )';
Even though this is OK:
select * from intervals where intvl && '[, infinity)';
Unfortunately, the weekly scheduling period is hard-coded at this time. Dochazka does not care what dates are used to define the intervals -- only that they fall within a contiguous 168-hour period. Consider the following contrived example. If the scheduling intervals for EID 1 were defined like this:
"[1964-12-30 22:05, 1964-12-31 04:35)" "[1964-12-31 23:15, 1965-01-01 03:10)"
for Dochazka that would mean that the employee with EID 1 has a weekly schedule of "WED/22:05-THU/04:35" and "THU/23:15-FRI/03:10", because the dates in the ranges fall on a Wednesday (1964-12-30), a Thursday (1964-12-31), and a Friday (1964-01-01), respectively.
The effective field of the privhistory and schedhistory tables contains the effective date/time of the history change. This field takes a timestamp, and a trigger ensures that the value is evenly divisible by five minutes (by rounding). In other words,
effective
'1964-06-13 14:45'
is a valid effective timestamp, while
'2014-01-01 00:00:01'
will be rounded to '2014-01-01 00:00'.
Employees do not access the database directly, but only via HTTP requests. For authorization and auditing purposes, App::Dochazka::REST needs to associate each incoming request to an EID.
The Plack::Middleware::Session module associates each incoming request with a session. Sessions are validated by examining the session state in the App::Dochazka::REST::Auth module.
If the session state is valid, it will contain:
the Employee ID, eid
the IP address from which the session was first originated, ip_addr
ip_addr
the date/time when the session was last seen, last_seen
last_seen
If any of these are missing, or the difference between last_seen and the current date/time is greater than the time interval defined in the DOCHAZKA_REST_SESSION_EXPIRATION_TIME, the request is rejected with 401 Unauthorized.
DOCHAZKA_REST_SESSION_EXPIRATION_TIME
Requests for a new session are subject to HTTP Basic Authentication. To protect employee credentials from network sniffing attacks, the HTTP traffic must be encrypted. This can be accomplished using an SSL-capable HTTP server or transparent proxy such as nginx.
If the DOCHAZKA_LDAP site parameter is set to a true value, the _authenticate routine of App::Dochazka::REST::Resource will attempt to authenticate the request against an external resource using the LDAP protocol.
DOCHAZKA_LDAP
_authenticate
LDAP authentication takes place in two phases:
lookup phase
authentication phase
The purpose of the lookup phase is to determine if the user exists in the LDAP resource and, if it does exist, to get its 'cn' property. In the second phase, the password entered by the user is compared with the password stored in the LDAP resource.
If the LDAP lookup phase fails, or if LDAP is disabled, App::Dochazka::REST falls back to "internal authentication", which means that the credentials are compared against the nick, passhash, and salt fields of the employees table in the database.
employees
To protect user credentials from snooping, the actual passwords are not stored in the database, Instead, they are run through a one-way hash function and the hash (along with a random "salt" string) is stored in the database instead of the password itself. Since some "one-way" hashing algorithms are subject to brute force attacks, the Blowfish algorithm was chosen to provide the best known protection.
If the request passes Basic Authentication, a session ID is generated and stored in a cookie.
As stated above, communication between the server and its clients takes place using the HTTP protocol. More abstractly, the communication takes the form of requests (from client to server) and responses (from server back to client) to those requests. In other words, communication is never initiated by the server, but always by the clients.
An HTTP request has the following basic components:
Method
Dochazka supports GET, PUT, POST, and DELETE
URI
Universal Resource Indicator specifying a Dochazka resource
Headers
More on these below
Request entity
Data accompanying the request - may or may not be present
The Dochazka REST server accepts the following HTTP methods: GET, PUT, POST, and DELETE.
GET
PUT
POST
DELETE
A GET request on a resource is a request for information - in other words, it is "read-only": GET requests never change the underlying data. In Dochazka, GET requests frequently map to SELECT statements.
SELECT
PUT requests always refer to a concrete data entity, or chunk of data. In simple cases, this will be a single record in the underlying database. If the record already exists, the PUT request is interpreted to mean modification (or UPDATE in SQL). If the record does not exist, then the request will map to an INSERT statement to create the resource. In both cases, upon success the response status will be 200 OK.
UPDATE
INSERT
200 OK
Sometimes, especially for create operations, the exact specification of the resource is not known beforehand. To address these cases, some resources accept POST requests. If the request causes a new resource to be created, the HTTP response status will be 201 Created and there will be a Location header specifying the URI of the newly created resource.
201 Created
Location
As their name would suggest, DELETE requests are issued when we want to dissolve (destroy) a resource. Whether or not this actually happens is determined by two factors: (1) whether the user issuing the request has the requisite authorization and, (2), whether the underlying data record is referred to by other records - in which case typically the DELETE request will fail with a 500 Internal Server Error status.
500 Internal Server Error
The purpose of the Universal Resource Indicator (URI, sometimes also known as an URL) is to uniquely identify a resource.
URIs consist of several syntactical elements. An exhaustive description can be found in RFC ..., but for Dochazka purposes we can present them as follows:
https://
This part of the URI says that we are using the HTTPS protocol (or SSL-encrypted HTTP) to communicate. It is separated from the next component by two forward slashes.
dochazka.site
After the protocol, the next URI component is the REST server's domain name. Obviously, this will differ from site to site. It is separated from the next component (i.e. the resource specification) by a single forward slash.
As stated above, the domain name is terminated by a single forward slash. Everything after that is interpreted as a resource specification.
A single forward slash '/' specifies the root resource.
'/'
Of these three components, the first two are site-specific. It is possible, for example, to run the Dochazka server without SSL encryption, in which case the protocol would be http:// instead of https://.
http://
Once the application's implementation at a given site has stabilized, these two URI components will change very seldomly, if at all.
Dochazka resources are much more ephemeral. Different resources present different ways that users can access and modify the data (in this case, attendance data) in the underlying database.
Some resources, such as employee/nick/simona, refer directly to a unit of information that may or may not exist in the database information. Other resources, like interval/new, are not linked to a specific database record.
employee/nick/simona
interval/new
Also, in programming terms the resources are generalized, so we think about, e.g., employee/nick/simona and employee/nick/wanda as two instances of a more generalized employee/nick/:nick resource, where :nick is like an argument to a function call.
employee/nick/wanda
employee/nick/:nick
:nick
And, indeed, internally all resources resolve to function calls. The function in this case is referred to as the "resource handler".
Some resources accept all four HTTP methods listed above, others accept two or three, and still others accept only one.
HTTP headers are somewhat obscure because they are often hidden by the client. Nevertheless, they are an important part of the HTTP protocol. The Dochazka REST server only accepts certain headers in the request.
#FIXME: describe the more common response headers
PUT and POST requests may take a request body. If a request body is expected or accepted, it must be a valid JSON string. (JSON is a simple way of "stringifying" a data structure.)
The HTTP response returned by the REST server consists of:
Status code (e.g. 200, 400, 404, etc.)
Content body (or "response entity")
The HTTP standard stipulates a number of status codes. The server listens for incoming requests. Under normal operation, the server processes each request. The result of such processing is a "response", which is sent back to the client that originated the request. Each response will contain one and only one status code. The meanings of the various status codes are explained in the HTTP standard. Some of the more common ones are as follows:
200
The request was accepted and processed. Refer to the response body for the result.
204
This code is returned on DELETE requests when either the record was successfully deleted or the resource did not exist in the first place.
404
The resource specification given in the URI could not be associated with a known resource.
405
The resource was recognized but it is not defined for this method.
401
A valid method+resource combination was specified, but the user failed to authenticate herself to the REST server.
403
A valid method+resource combination was specified and the user was successfully authenticated, but the user is not authorized to perform the operation she is requesting.
400
A valid method+resource combination was specified and the user passed authentication and authorization. However, the information provided by the user in the resource specification or in the request body could not be parsed.
HTTP responses are always accompanied by headers, which qualify the response in various ways. For example, the Content-Encoding header indicates how the bytes in the response body string should be interpreted. In Dochazka's case, the response body will always be in JSON, which implies the UTF-8 encoding.
Content-Encoding
UTF-8
The response body holds the information returned by a "successful" request. Be aware that "success" in this context only means that, from the perspective of the REST server, the request was fully processed. It does not means that that whatever the user was requesting was actually done. For example, if a GET request for a resource is sent and the reponse code is 200, the client programmer can assume that a response body will be present, and that it will be an App::CELL::Status object, but that is all she can assume. Particularly, she cannot assume that the payload of that status object contains the object requested.
As stated above, the response body will always be a JSON string. This string can either be displayed to the user as-is, or it can be interpreted and further processed by the client.
A body may be included in the response, provided the status code is 200 (OK). For the client, an HTTP response of 200 is a signal to look into the response body for further information. For the purposes of Dochazka, a 200 status does not provide any information beyond this imperative: "look into the response body".
Since looking into the response body is fundamental to the operation of Dochazka clients, the REST server emits response bodies in a strictly defined format detailed in App::CELL::Status. Client developers, then, can count on the truthfulness of the following statements:
While the HTTP protocol provides a range of general status codes, some of which make sense for and are used by Dochazka, in some cases Dochazka needs to return status codes that are not provided for by the standard. For this reason, the information returned by Dochazka is further encapsulated in a Dochazka-specific status structure, and this is what is returned in the response body.
The "state" of practically all data model objects is stored in a PostgreSQL database - one database per site.
PostgreSQL is used for its tsrange type (see http://www.postgresql.org/docs/9.4/static/rangetypes.html for details), which is used to store and manipulate schedule and attendance intervals, as well as locks.
The database is accessed through DBI, and the DBI connection is accessed through a DBIx::Connector singleton stored in App::Dochazka::Rest::ConnBank. When an incoming request is authenticated, the DBIx::Connector singleton is placed in the request context (a hashref used to store request processing state).
The purpose of this somewhat complicated mechanism is to ensure that each request can potentially have its own database connection.
App::Dochazka::REST offers the following debug facilities:
bin/dochazka-rest -- --early-debug=$TMPFILE
Calling the server startup script as shown will cause the --early-debug parameter to be passed through to bin/mrest (from the Web::MREST distro). This has the interesting effect of capturing even the earliest debug messages to a temporary file, which the server must be able to touch. Once the server has started, the filename can also be determined by sending a GET param/meta/MREST_EARLY_DEBUGGING request.
--early-debug
bin/mrest
touch
GET param/meta/MREST_EARLY_DEBUGGING
DOCHAZKA_DEBUG environment variable
If the DOCHAZKA_DEBUG environment variable is set to a true value, the entire 'context' will be returned in each JSON response, instead of just the 'entity'. For more information, see Resource.pm.
DOCHAZKA_DEBUG
Resource.pm
MREST_DEBUG_MODE site configuration parameter
If the MREST_DEBUG_MODE site parameter is set to a true value, debug messages will be logged.
MREST_DEBUG_MODE
In Dochazka, some commonly-used terms have special meanings:
employee -- Regardless of whether they are employees in reality, for the purposes of Dochazka employees are the folks whose attendance/time is being tracked. Employees are expected to interact with Dochazka using the following functions and commands.
administrator -- In Dochazka, administrators are employees with special powers. Certain REST/CLI functions are available only to administrators.
CLI client -- CLI stands for Command-Line Interface. The CLI client is the Perl script that is run when an employee types dochazka at the bash prompt.
dochazka
REST server -- REST stands for ... . The REST server is a collection of Perl modules running on a server at the site.
site -- In a general sense, the "site" is the company, organization, or place that has implemented (installed, configured) Dochazka for attendance/time tracking. In a technical sense, a site is a specific instance of the Dochazka REST server that CLI clients connect to.
Nathan Cutler, <ncutler@suse.cz>
<ncutler@suse.cz>
To report bugs or request features, use the GitHub issue tracker at https://github.com/smithfarm/dochazka-rest/issues.
Copyright (c) 2014-2015, SUSE LLC All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of SUSE LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2 POD Errors
The following errors were encountered while parsing the POD:
You can't have =items (as at line 526) unless the first thing after the =over is an =item
=back without =over
To install App::Dochazka::REST, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Dochazka::REST
CPAN shell
perl -MCPAN -e shell install App::Dochazka::REST
For more information on module installation, please visit the detailed CPAN module installation guide.