Added more methods with unittests

.travis.yml

@@ -0,0 +1,5 @@
+language: python
+python:
+  - "3.6"
+script:
+  - python -m unittest

README.md

@@ -40,13 +40,20 @@ It's just a start, so the list of implemented methods is shorter than not.
 - Survey
   + list_surveys
   + list_questions
+  + delete_survey
+  + export_responses
+  + import_survey
+  + activate_survey
+  + activate_tokens
+  + list_groups
 - Token
   + add_participants
   + delete_participants
   + get_participant_properties
   + get_summary
   + invite_participants
   + list_participants
+  + remind_participants
 
 
 ### Error Handling

limesurveyrc2api/_survey.py

@@ -1,6 +1,8 @@
+import warnings
 from collections import OrderedDict
 from limesurveyrc2api.exceptions import LimeSurveyError
-
+from os.path import splitext
+from base64 import b64encode
 
 class _Survey(object):
 
@@ -76,3 +78,238 @@ def list_questions(self, survey_id,
         else:
             assert response_type is list
         return response
+
+    def delete_survey(self, survey_id):
+        """ Delete a survey.
+
+        Parameters
+        :param survey_id: The ID of the Survey to be deleted.
+        :type: Integer
+        """
+        method = "delete_survey"
+        params = OrderedDict([
+            ("sSessionKey", self.api.session_key),
+            ("iSurveyID", survey_id)
+        ])
+        response = self.api.query(method=method, params=params)
+        response_type = type(response)
+
+        if response_type is dict and "status" in response:
+            status = response["status"]
+            error_messages = [
+                "No permission",
+                "Invalid session key"
+            ]
+            for message in error_messages:
+                if status == message:
+                    raise LimeSurveyError(method, status)
+        else:
+            assert response_type is list
+        return response
+
+    def export_responses(self, survey_id, document_type, language_code=None,
+                         completion_status='all', heading_type='code',
+                         response_type='short', from_response_id=None,
+                         to_response_id=None, fields=None):
+        """ Export responses in base64 encoded string.
+
+        Parameters
+        :param survey_id: Id of the Survey.
+        :type survey_id: Integer
+        :param document_type: Any format available by plugins 
+                             (e.g. pdf, csv, xls, doc, json)
+        :type document_type: String
+        :param language_code: (optional) The language to be used.
+        :type language_code: String
+        :param completion_status: (optional) 'complete', 'incomplete' or 'all'
+        :type completion_status: String
+        :param heading_type: (optional) 'code', 'full' or 'abbreviated'
+        :type heading_type: String
+        :param response_type: (optional) 'short' or 'long'
+        :type response_type: String
+        :param from_response_id: (optional)
+        :type from_response_id: Integer
+        :param to_response_id: (optional)
+        :type to_response_id: Integer
+        :param fields: (optional) Selected fields.
+        :type fields: Array
+        """
+        method = "export_responses"
+        params = OrderedDict([
+            ("sSessionKey", self.api.session_key),
+            ("iSurveyID", survey_id),
+            ("sDocumentType", document_type),
+            ("sLanguageCode", language_code),
+            ("sCompletionStatus", completion_status),
+            ("sHeadingType", heading_type),
+            ("sResponseType", response_type),
+            ("iFromResponseID", from_response_id),
+            ("iToResponseID", to_response_id),
+            ("aFields", fields)
+        ])
+        response = self.api.query(method=method, params=params)
+        response_type = type(response)
+
+        if response_type is dict and "status" in response:
+            status = response["status"]
+            error_messages = [
+                "Language code not found for this survey.",
+                "No Data, could not get max id.",
+                "No Data, survey table does not exist",
+                "No permission",
+                "Invalid session key"
+            ]
+            for message in error_messages:
+                if status == message:
+                    raise LimeSurveyError(method, status)
+        else:
+            assert response_type is str
+        return response
+
+    def import_survey(self, path_to_import_survey, new_name=None,
+                      dest_survey_id=None):
+        """ Import a survey. Allowed formats: lss, csv, txt or lsa
+
+        Parameters
+        :param path_to_import_survey: Path to survey as file to copy.
+        :type path_to_import_survey: String
+        :param new_name: (optional) The optional new name of the survey
+                    Important! Seems only to work if lss file is given!
+        :type new_name: String
+        :param dest_survey_id: (optional) This is the new ID of the survey - 
+                          if already used a random one will be taken instead
+        :type dest_survey_id: Integer
+        """
+        import_datatype = splitext(path_to_import_survey)[1][1:]
+        # TODO: Naming seems only to work with lss files - why?
+        if import_datatype != 'lss' and new_name:
+            warnings.warn("New naming seems only to work with lss files",
+                          RuntimeWarning)
+        # encode import data
+        with open(path_to_import_survey, 'rb') as f:
+            # import data must be a base 64 encoded string
+            import_data = b64encode(f.read())
+            # decoding needed because json.dumps() in method get of
+            # class LimeSurvey can not encode bytes
+            import_data = import_data.decode('ascii')
+
+        method = "import_survey"
+        params = OrderedDict([
+            ("sSessionKey", self.api.session_key),
+            ("sImportData", import_data),
+            ("sImportDataType", import_datatype),
+            ("sNewSurveyName", new_name),
+            ("DestSurveyID", dest_survey_id)
+        ])
+        response = self.api.query(method=method, params=params)
+        response_type = type(response)
+
+        if response_type is dict and "status" in response:
+            status = response["status"]
+            error_messages = [
+                "Error: ...",  # TODO: Unclear what might be returned here
+                "Invalid extension",
+                "No permission",
+                "Invalid session key"
+            ]
+            for message in error_messages:
+                if status == message:
+                    raise LimeSurveyError(method, status)
+        else:
+            assert response_type is int  # the new survey id
+        return response
+
+    def activate_survey(self, survey_id):
+        """ Activate an existing survey.
+
+        Parameters
+        :param survey_id: Id of the Survey to be activated.
+        :type survey_id: Integer
+        """
+        method = "activate_survey"
+        params = OrderedDict([
+            ("sSessionKey", self.api.session_key),
+            ("iSurveyID", survey_id)
+        ])
+        response = self.api.query(method=method, params=params)
+        response_type = type(response)
+
+        if response_type is dict and "status" in response:
+            status = response["status"]
+            error_messages = [
+                "Error: Invalid survey ID",
+                "Error: ...",  # TODO: what could be output of ActivateResults?
+                "No permission",
+                "Invalid session key"
+            ]
+            for message in error_messages:
+                if status == message:
+                    raise LimeSurveyError(method, status)
+        else:
+            assert response_type is list
+        return response
+
+    def activate_tokens(self, survey_id, attribute_fields=[]):
+        """
+
+        Parameters
+        :param survey_id: ID of the Survey where a participants table will
+            be created for.
+        :type survey_id: Integer
+        :param attribute_fields: An array of integer describing any additional 
+            attribute fiields.
+        :type attribute_fields: Array
+        """
+        method = "activate_tokens"
+        params = OrderedDict([
+            ("sSessionKey", self.api.session_key),
+            ("iSurveyId", survey_id),
+            ("aAttributeFields", attribute_fields)
+        ])
+        response = self.api.query(method=method, params=params)
+        response_type = type(response)
+
+        if response_type is dict and "status" in response:
+            status = response["status"]
+            error_messages = [
+                "Error: Invalid survey ID",
+                "Survey participants table could not be created",
+                "No permission",
+                "Invalid session key"
+            ]
+            for message in error_messages:
+                if status == message:
+                    raise LimeSurveyError(method, status)
+        else:
+            assert response_type is list
+        return response
+
+    def list_groups(self, survey_id):
+        """ Return the ids and all attributes of groups belonging to survey.
+
+        Parameters
+        :param survey_id: ID of the survey containing the groups.
+        :rtype survey_id: Integer
+        """
+        method = "list_groups"
+        params = OrderedDict([
+            ("sSessionKey", self.api.session_key),
+            ("iSurveyID", survey_id)
+        ])
+        response = self.api.query(method=method, params=params)
+        response_type = type(response)
+
+        if response_type is dict and "status" in response:
+            status = response["status"]
+            error_messages = [
+                "Error: Invalid survey ID",
+                "No groups found",
+                "No permission"
+                "Invalid S ession key"  # typo in remotecontrol_handle.php
+            ]
+            for message in error_messages:
+                if status == message:
+                    raise LimeSurveyError(method, status)
+        else:
+            assert response_type is list
+        return response

limesurveyrc2api/_token.py

@@ -13,7 +13,7 @@ def add_participants(
         Add participants to the specified survey.
 
         Parameters
-        :param survey_id: ID of survey to delete participants from.
+        :param survey_id: ID of survey to add participants.
         :type survey_id: Integer
         :param participant_data: List of participant detail dictionaries.
         :type participant_data: List[Dict]
@@ -277,6 +277,45 @@ def list_participants(
             assert response_type is list
         return response
 
-    def remind_participants(self):
-        # TODO
-        raise NotImplementedError
+    def remind_participants(self, survey_id, min_days_between=None,
+                            max_reminders=None, token_ids=False):
+        """ Send a reminder to participants in a survey.
+
+        Returns result of sending.
+
+        Parameters
+        :param survey_id: ID of the Survey that participants belong.
+        :type survey_id: Integer
+        :param min_days_between: (optional) Days from last reminder.
+        :type min_days_between: Integer
+        :param max_reminders: (optional) Maximum reminders count.
+        :type max_reminders: Integer
+        :param token_ids: (optional filter) IDs of the participant to remind.
+        :type token_ids: array
+        """
+        method = "remind_participants"
+        params = OrderedDict([
+            ("sSessionKey", self.api.session_key),
+            ("iSurveyID", survey_id),
+            ("iMinDaysBetween", min_days_between),
+            ("iMaxReminders", max_reminders),
+            ("aTokenIds", token_ids)
+        ])
+        response = self.api.query(method=method, params=params)
+        response_type = type(response)
+
+        if response_type is dict and "status" in response:
+            status = response["status"]
+            error_messages = [
+                "Error: No survey participants table",
+                "Error: No candidate tokens",
+                "Error: Invalid survey ID",
+                "No permission",
+                "Invalid Session Key"
+            ]
+            for message in error_messages:
+                if status == message:
+                    raise LimeSurveyError(method, status)
+        else:
+            assert response_type is list
+        return response

setup.py

@@ -6,8 +6,8 @@
     version=__version__,
     description="LimeSurvey RC2 API Web Services Client",
     url="https://github.com/lindsay-stevens",
-    author="Lindsay Stevens",
-    author_email="[email protected]",
+    author="Lindsay Stevens, forked by Elke Schaechtele",
+    author_email="[email protected], [email protected]",
     packages=["limesurveyrc2api"],
     test_suite="tests",
     include_package_data=True,

tests/config.ini

@@ -0,0 +1,5 @@
+[test]
+url         =  http://localhost/index.php/admin/remotecontrol
+username    = admin
+password    = admin
+survey_id   = 369411

tests/config.ini.tmpl

@@ -2,3 +2,4 @@
 url         = http://localhost/limesurvey/index.php/admin/remotecontrol
 username    = admin
 password    = admin
+survey_id   = 0