fcs.manager.api_views

This module contains methods that handle REST requests for tasks management. All methods are decorated with Django REST framework @api_view decorator. These methods are mapped on URLs in fcs.manager.api_urls module.

add_task(request)

Creates new task. Handles REST request for task creation. Required POST parameters:

  • name - name of task
  • priority - task priority
  • expire - datetime of task expiration
  • mime_type - list of MIME types separated by whitespace
  • start_links - list of urls separated by whitespace - starting point of crawling
  • whitelist - URLs (regexp) which should be crawled
  • blacklist - URLs (regexp) which should not be crawled
  • max_links - size of task
Parameters:request (rest_framework.Request) – Request object.

Note

Request must be authenticated with OAuth2 Token.

Returns:Response with new task’s ID if successful, response with error message and code otherwise.
Return type:rest_framework.response.Response
delete_task(request, task_id)

Finishes a task. Handles REST request for task finish. Required POST parameters:

  • id - task id
Parameters:
  • request (rest_framework.Request) – Request object.
  • task_id (int) – ID of task to be deleted.

Note

Request must be authenticated with OAuth2 Token.

Returns:Response with confirmation if successful, response with error message and code otherwise.
Return type:rest_framework.response.Response
pause_task(request, task_id)

Pauses a task. Handles REST request for task deactivation. Required POST parameters:

  • id - task id
Parameters:
  • request (rest_framework.Request) – Request object.
  • task_id (int) – ID of task to be paused.

Note

Request must be authenticated with OAuth2 Token.

Returns:Response with confirmation if successful, response with error message and code otherwise.
Return type:rest_framework.response.Response
resume_task(request, task_id)

Resumes a task. Handles REST request for task activation. Required POST parameters:

  • id - task id
Parameters:
  • request (rest_framework.Request) – Request object.
  • task_id (int) – ID of task to be resumed.

Note

Request must be authenticated with OAuth2 Token.

Returns:Response with confirmation if successful, response with error message and code otherwise.
Return type:rest_framework.response.Response
get_data_from_crawler(request, task_id, size)

Downloads data gathered by crawler.

Parameters:
  • request (rest_framework.Request) – Request object.
  • task_id (int) – ID of task which data is to be downloaded.
  • size (int) – Size of requested data.

Note

Request must be authenticated with OAuth2 Token.

Returns:Response with crawled content if successful, response with error message and code otherwise.
Return type:rest_framework.response.Response