Update convenience functions (#21)

* update expire_survey!

* add Dates dependency

* add start_survey! method

* export start_survey!

* bump version

Author: p-gw

Project.toml

@@ -1,7 +1,7 @@
 name = "CitrusAPI"
 uuid = "fb58f9c3-ae58-4847-ba51-3b3c84151ac7"
 authors = ["Philipp Gewessler"]
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

README.md

@@ -91,3 +91,4 @@ Note that CitrusAPI uses a more "julian" syntax for API methods. Methods that mu
 - `disconnect!`
 - `expire_survey!`
 - `is_active`
+- `start_survey!`

src/CitrusAPI.jl

@@ -10,7 +10,7 @@ using UUIDs
 
 export CitrusClient, connect!, disconnect!
 export LimeSurveyError, AuthenticationError
-export is_active, expire_survey!
+export is_active, expire_survey!, start_survey!
 
 include("utils.jl")
 include("CitrusClient.jl")
@@ -58,15 +58,27 @@ function is_active(client::CitrusClient, survey_id::Int)
     return res.active == "Y"
 end
 
+"""
+    start_survey!(client, survey_id, datetime=now())
+
+Set the start date of the remote survey with `survey_id`
+
+See also: [`set_survey_properties!`](@ref)
+"""
+function start_survey!(client, survey_id, datetime::DateTime=now())
+    response = set_survey_properties!(client, survey_id, Dict("startdate" => datetime))
+    return response
+end
+
 """
     expire_survey!(client, survey_id, date=now())
 
 Set the expiry date of the remote survey with `survey_id`.
 
 See also: [`set_survey_properties!`](@ref)
 """
-function expire_survey!(client, survey_id, date::Union{Date,DateTime}=now())
-    response = set_survey_properties!(client, survey_id, Dict("expires" => date))
+function expire_survey!(client, survey_id, datetime::DateTime=now())
+    response = set_survey_properties!(client, survey_id, Dict("expires" => datetime))
     return response
 end
 

src/query.jl

@@ -1,11 +1,7 @@
 function construct_payload(method::AbstractString, params)
     request_id = string(UUIDs.uuid4())
-    payload = Dict(
-        "method" => method,
-        "params" => params,
-        "id" => request_id
-    )
-    json_payload = JSON3.write(payload)
+    payload = Dict("method" => method, "params" => params, "id" => request_id)
+    json_payload = JSON3.write(payload, dateformat=dateformat"yyyy-mm-dd HH:MM:SS")
     return json_payload
 end
 

test/runtests.jl

@@ -4,6 +4,7 @@ using Test
 using Base64
 using CSV
 using DataFrames
+using Dates
 using JSON3
 
 function dataframe_to_base64csv(df::DataFrame)
@@ -180,6 +181,25 @@ end
             @test set_lang.surveyls_title == true
             @test get_language_properties(c, s1).surveyls_title == "testtitle"
 
+            # start survey
+            df = dateformat"yyyy-mm-dd HH:MM:SS"
+            starts_at = DateTime("2022-01-01 12:00:00", df)
+            props = start_survey!(c, s1, starts_at)
+            @test props.startdate == true
+
+            start_date = get_survey_properties(c, s1).startdate
+            parsed_start_date = DateTime(start_date, df)
+            @test parsed_start_date == starts_at
+
+            # expire survey
+            expire_at = DateTime("2022-01-01 12:30:15", df)
+            props = expire_survey!(c, s1, expire_at)
+            @test props.expires == true
+
+            expire_date = get_survey_properties(c, s1).expires
+            parsed_expire_date = DateTime(expire_date, df)
+            @test parsed_expire_date == expire_at
+
             # clean up remaining surveys
             for s in [s1, s2, s3, s5, s6]
                 res = delete_survey!(c, s)