Merge branch 'develop' for release 1.0.0

Author: Aitor Magán García

.travis.yml

@@ -19,6 +19,7 @@ before_script:
   - sleep 3 # give xvfb some time to start
 script: 
   - sh bin/travis-run.sh
+after_success: coveralls
 branches:
   only:
-    - develop
+    - develop

README.md

@@ -1,4 +1,4 @@
-# CKAN Data Requests [![Build Status](https://travis-ci.org/conwetlab/ckanext-datarequests.svg?branch=develop)](https://travis-ci.org/conwetlab/ckanext-datarequests)
+# CKAN Data Requests [![Build Status](https://travis-ci.org/conwetlab/ckanext-datarequests.svg?branch=develop)](https://travis-ci.org/conwetlab/ckanext-datarequests) [![Coverage Status](https://coveralls.io/repos/github/conwetlab/ckanext-datarequests/badge.svg?branch=develop)](https://coveralls.io/github/conwetlab/ckanext-datarequests?branch=develop)
 
 CKAN extension that allows users to ask for datasets that are not already published in the CKAN instance. In this way we can set up a Data Market, not only with data supplies but also with data demands.
 
@@ -25,7 +25,7 @@ On the other hand, you can also use the API. To access this API, you should POST
 
 Here you have a brief description of all the implemented actions:
 
-#### `datarequest_create(context, data_dict)`
+#### `create_datarequest(context, data_dict)`
 Action to create a new data request. This function checks the access rights of the user before creating the data request. If the user is not allowed, a `NotAuthorized` exception will be risen.
 
 In addition, you should note that the parameters will be checked and an exception (`ValidationError`) will be risen if some of these parameters are not valid.
@@ -36,10 +36,10 @@ In addition, you should note that the parameters will be checked and an exceptio
 * **`organization_id`** (string): The ID of the organization you want to asign the data request (optional).
 
 ##### Returns:
-A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`).
+A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`, `followers`).
 
 
-#### `datarequest_show(context, data_dict)`
+#### `show_datarequest(context, data_dict)`
 Action to retrieve the information of a data request. The only required parameter is the `id` of the data request. A `NotFound` exception will be risen if the `id` is not found.
 
 Access rights will be checked before returning the information and an exception will be risen (`NotAuthorized`) if the user is not authorized.
@@ -48,10 +48,10 @@ Access rights will be checked before returning the information and an exception
 * **`id`** (string): the ID of the datarequest to be returned.
 
 ##### Returns:
-A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`).
+A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`, `followers`).
 
 
-#### `datarequest_update(context, data_dict)`
+#### `update_datarequest(context, data_dict)`
 Action to update a data request. The function checks the access rights of the user before updating the data request. If the user is not allowed, a `NotAuthorized` exception will be risen
 
 In addition, you should note that the parameters will be checked and an exception (`ValidationError`) will be risen if some of these parameters are not valid.
@@ -63,10 +63,10 @@ In addition, you should note that the parameters will be checked and an exceptio
 * **`organization_id`** (string): The ID of the organization you want to asign the data request (optional).
 
 ##### Returns:
-A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`).
+A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`, `followers`).
 
 
-#### `datarequest_index(context, data_dict)`
+#### `list_datarequests(context, data_dict)`
 Returns a list with the existing data requests. Rights access will be checked before returning the results. If the user is not allowed, a `NotAuthorized` exception will be risen
 
 ##### Parameters (included in `data_dict`):
@@ -82,28 +82,28 @@ Returns a list with the existing data requests. Rights access will be checked be
 A dict with three fields: `result` (a list of data requests), `facets` (a list of the facets that can be used) and `count` (the total number of existing data requests)
 
 
-#### `datarequest_delete(context, data_dict)`
+#### `delete_datarequest(context, data_dict)`
 Action to delete a new data request. The function checks the access rights of the user before deleting the data request. If the user is not allowed, a `NotAuthorized` exception will be risen.
 
 ##### Parameters (included in `data_dict`):
 * **`id`** (string): the ID of the datarequest to be deleted
 
 ##### Returns:
-A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`).
+A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`, `followers`).
 
 
-#### `datarequest_close(context, data_dict)`
+#### `close_datarequest(context, data_dict)`
 Action to close a data request. Access rights will be checked before closing the data request. If the user is not allowed, a `NotAuthorized` exception will be risen
 
 ##### Parameters (included in `data_dict`):
 * **`id`** (string): the ID of the datarequest to be closed
 * **`accepted_dataset`** (string): The ID of the dataset accepted as solution for the data request
 
 ##### Returns:
-A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`).
+A dict with the data request (`id`, `user_id`, `title`, `description`,`organization_id`, `open_time`, `accepted_dataset`, `close_time`, `closed`, `followers`).
 
 
-#### `datarequest_comment(context, data_dict)`
+#### `comment_datarequest(context, data_dict)`
 Action to create a comment in a data request. Access rights will be checked before creating the comment and a `NotAuthorized` exception will be risen if the user is not allowed to create the comment
 
 ##### Parameters (included in `data_dict`):
@@ -114,7 +114,7 @@ Action to create a comment in a data request. Access rights will be checked befo
 A dict with the data request comment (`id`, `user_id`, `datarequest_id`, `time` and `comment`)
 
 
-#### `datarequest_comment_show(context, data_dict)`
+#### `show_datarequest_comment(context, data_dict)`
 Action to retrieve a comment. Access rights will be checked before getting the comment and a `NotAuthorized` exception will be risen if the user is not allowed to get the comment
 
 ##### Parameters (included in `data_dict`):
@@ -124,7 +124,7 @@ Action to retrieve a comment. Access rights will be checked before getting the c
 A dict with the following fields: `id`, `user_id`, `datarequest_id`, `time` and `comment`
 
 
-#### `datarequest_comment_list(context, data_dict)`
+#### `list_datarequest_comments(context, data_dict)`
 Action to retrieve all the comments of a data request. Access rights will be checked before getting the comments and a `NotAuthorized` exception will be risen if the user is not allowed to read the comments
 
 ##### Parameters (included in `data_dict`):
@@ -135,7 +135,7 @@ Action to retrieve all the comments of a data request. Access rights will be che
  A list with all the comments of a data request. Every comment is a dict with the following fields: `id`, `user_id`, `datarequest_id`, `time` and `comment`
 
 
-#### `datarequest_comment_update(context, data_dict)`
+#### `update_datarequest_comment(context, data_dict)`
 Action to update a comment of a data request. Access rights will be checked before updating the comment and a `NotAuthorized` exception will be risen if the user is not allowed to update the comment
 
 ##### Parameters (included in `data_dict`):
@@ -146,7 +146,7 @@ Action to update a comment of a data request. Access rights will be checked befo
 A dict with the data request comment (`id`, `user_id`, `datarequest_id`, `time` and `comment`)
 
 
-#### `datarequest_comment_delete(context, data_dict)`
+#### `delete_datarequest_comment(context, data_dict)`
 Action to delete a comment of a data request. Access rights will be checked before deleting the comment and a `NotAuthorized` exception will be risen if the user is not allowed to delete the comment
 
 ##### Parameters (included in `data_dict`):
@@ -155,9 +155,30 @@ Action to delete a comment of a data request. Access rights will be checked befo
 ##### Returns:
 A dict with the data request comment (`id`, `user_id`, `datarequest_id`, `time` and `comment`)
 
+#### `follow_datarequest(context, data_dict)`
+
+Action to follow a data request. Access rights will be cheked before following a datarequest and a `NotAuthorized` exception will be risen if the user is not allowed to follow the given datarequest. `ValidationError` will be risen if the datarequest ID is not included or if the user is already following the datarequest. `ObjectNotFound` will be risen if the given datarequest does not exist.
+
+##### Parameters (included in `data_dict`):
+* **`id`** (string): The ID of the datarequest to be followed
+
+##### Returns:
+`True`
+
+#### `unfollow_datarequest(context, data_dict)`
+
+Action to unfollow a data request. Access rights will be cheked before unfollowing a datarequest and a NotAuthorized exception will be risen if the user is not allowed to unfollow the given datarequest. `ValidationError` will be risen if the datarequest ID is not included in the request. `ObjectNotFound` will be risen if the user is not following the given datarequest.
+
+##### Parameters (included in `data_dict`):
+* **`id`** (string): The ID of the datarequest to be unfollowed
+
+##### Returns:
+`True`
+
+
 ## Installation
 
-Install this extension in your CKAN instance is as easy as intall any other CKAN extension.
+Install this extension in your CKAN instance is as easy as install any other CKAN extension.
 
 * Activate your virtual environment
 ```
@@ -223,8 +244,30 @@ python setup.py nosetests
 ```
 **Note:** The `test.ini` file contains a link to the CKAN `test-core.ini` file. You will need to change that link to the real path of the file in your system (generally `/usr/lib/ckan/default/src/ckan/test-core.ini`).
 
+**Note 2:** When creating a PR that includes code changes, please, ensure your new code is tested. No PR will be merged until the Travis CI system marks it as valid.
+
 ## Changelog
 
+### v1.0.0
+
+* New: Option to follow data requests.
+* New: Email notifications:
+  * An email will be sent to organization staff when a data request is created in a organization.
+  * An email will be sent to followers, people that commented, datarequest creator and organization staff when a comment in a datarequest is created.
+  * An email will be sent to followers, people that commented, datarequest creator and organization staff when a data request is closed.
+* New: Major API changes:
+  * `datarequest_create` :arrow_right: `create_datarequest`
+  * `datarequest_show` :arrow_right: `show_datarequest`
+  * `datarequest_update` :arrow_right: `update_datarequest`
+  * `datarequest_index` :arrow_right: `list_datarequests`
+  * `datarequest_delete` :arrow_right: `delete_datarequest`
+  * `datarequest_close` :arrow_right: `close_datarequest`
+  * `datarequest_comment` :arrow_right: `comment_datarequest`
+  * `datarequest_comment_show` :arrow_right: `show_datarequest_comment`
+  * `datarequest_comment_list` :arrow_right: `list_datarequest_comments`
+  * `datarequest_comment_update` :arrow_right: `update_datarequest_comment`
+  * `datarequest_comment_delete` :arrow_right: `delete_datarequest_comment`
+
 ### v0.4.1
 
 * New: Brazilian Portuguese (thanks to @allysonbarros)