From 48eae091bd7019bc9b714bb2ca90ca39bbc92b59 Mon Sep 17 00:00:00 2001 From: Philipp Gewessler Date: Fri, 2 Dec 2022 09:00:18 +0100 Subject: [PATCH 1/4] clean up test directory --- .github/workflows/CI.yml | 2 +- test/{ => limesurvey}/Dockerfile | 0 test/{ => limesurvey}/docker-compose.latest.yml | 0 test/{ => limesurvey}/docker-compose.lts.yml | 0 test/{ => limesurvey}/docker-compose.yml | 0 5 files changed, 1 insertion(+), 1 deletion(-) rename test/{ => limesurvey}/Dockerfile (100%) rename test/{ => limesurvey}/docker-compose.latest.yml (100%) rename test/{ => limesurvey}/docker-compose.lts.yml (100%) rename test/{ => limesurvey}/docker-compose.yml (100%) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 87dc77c..7116aa7 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -28,7 +28,7 @@ jobs: - 'latest' steps: - uses: actions/checkout@v2 - - run: docker compose -f test/docker-compose.yml -f test/docker-compose.${{ matrix.lsversion }}.yml up -d --build + - run: docker compose -f test/limesurvey/docker-compose.yml -f test/limesurvey/docker-compose.${{ matrix.lsversion }}.yml up -d --build - uses: julia-actions/setup-julia@v1 with: version: ${{ matrix.version }} diff --git a/test/Dockerfile b/test/limesurvey/Dockerfile similarity index 100% rename from test/Dockerfile rename to test/limesurvey/Dockerfile diff --git a/test/docker-compose.latest.yml b/test/limesurvey/docker-compose.latest.yml similarity index 100% rename from test/docker-compose.latest.yml rename to test/limesurvey/docker-compose.latest.yml diff --git a/test/docker-compose.lts.yml b/test/limesurvey/docker-compose.lts.yml similarity index 100% rename from test/docker-compose.lts.yml rename to test/limesurvey/docker-compose.lts.yml diff --git a/test/docker-compose.yml b/test/limesurvey/docker-compose.yml similarity index 100% rename from test/docker-compose.yml rename to test/limesurvey/docker-compose.yml From 28c40da94cdeecf792a329135fe7a313df847768 Mon Sep 17 00:00:00 2001 From: Philipp Gewessler Date: Fri, 2 Dec 2022 09:09:34 +0100 Subject: [PATCH 2/4] update documentation --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 59eda3f..5ec6adf 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,15 @@ [![Build Status](https://github.com/p-gw/CitrusAPI.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/p-gw/CitrusAPI.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/p-gw/CitrusAPI.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/p-gw/CitrusAPI.jl) -This Julia package provides a thin wrapper for the [LimeSurvey API](https://manual.limesurvey.org/RemoteControl_2_API). For a list of methods see https://api.limesurvey.org/classes/remotecontrol_handle.html. +This Julia package provides a wrapper for the [LimeSurvey Remote Control 2 API](https://manual.limesurvey.org/RemoteControl_2_API). -Note that this package uses a more "julian" syntax for API methods. Methods that mutate data by either adding, deleting or modifying data are implemented as [bang functions](https://docs.julialang.org/en/v1/manual/style-guide/#bang-convention). For example the API method `add_survey` is implemented as the `add_survey!` function in `CitrusAPI.jl`. +## Installation +CitrusAPI is registered in the Julia General package registry. +Simply install it by calling + +```julia +pkg> add CitrusAPI +``` ## Getting started If your LimeSurvey server is set up correctly you can start by setting up a `CitrusClient` and connecting to the server. @@ -28,6 +34,8 @@ disconnect!(client) ``` ## Available methods +Note that CitrusAPI uses a more "julian" syntax for API methods. Methods that mutate data by either adding, deleting or modifying data are implemented as [bang functions](https://docs.julialang.org/en/v1/manual/style-guide/#bang-convention). For example the API method `add_survey` is implemented as the `add_survey!`. + - `activate_survey!` - `activate_tokens!` - `add_group!` @@ -82,4 +90,4 @@ disconnect!(client) - `connect!` - `disconnect!` - `expire_survey!` -- `is_active` \ No newline at end of file +- `is_active` From 57c6bb6756f41029bf5d58f933cf6e179f7aad0e Mon Sep 17 00:00:00 2001 From: Philipp Gewessler Date: Fri, 2 Dec 2022 09:12:56 +0100 Subject: [PATCH 3/4] schedule weekly CI runs --- .github/workflows/CI.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 7116aa7..704fc8f 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -1,5 +1,7 @@ name: CI on: + schedule: + - cron: 0 0 * * 0 push: branches: - main From c10c04aa8d1248944a38ff2236ef31e688110d10 Mon Sep 17 00:00:00 2001 From: Philipp Gewessler Date: Fri, 2 Dec 2022 09:17:00 +0100 Subject: [PATCH 4/4] fix file path in Dockerfile --- test/limesurvey/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/limesurvey/Dockerfile b/test/limesurvey/Dockerfile index bca6d9c..3b23944 100644 --- a/test/limesurvey/Dockerfile +++ b/test/limesurvey/Dockerfile @@ -1,3 +1,3 @@ ARG LS_VERSION FROM acspri/limesurvey:${LS_VERSION} -COPY limesurvey/config.php /var/www/html/application/config/config.php \ No newline at end of file +COPY ./config.php /var/www/html/application/config/config.php \ No newline at end of file