Refactor, add tests, update README

.github/workflows/publish.yaml

@@ -26,6 +26,14 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
 
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.21.x'
+
+      - name: Test
+        run: go test -v ./...
+
       - name: Log in to the container registry
         uses: docker/login-action@v2
         with:

README.md

@@ -1,15 +1,39 @@
+# PrioBike Shlink Guard
+
+This is a proxy that can be used in front of the Shlink to make sure that only valid requests and espacially valid long links are sent to the Shlink.
+
 ## Quickstart
 
+Run locally:
 ```bash
 docker-compose up
 ```
 
+Run tests:
 ```bash
-curl -X POST --header "X-Api-Key: secret" -H "Content-Type: application/json" -d @example_long_link.json  http://localhost/rest/v3/short-urls
+go test
 ```
 
-Then
+### POST 
+
+Should not work:
+```bash
+curl -X POST --header "X-Api-Key: secret" -H "Content-Type: application/json" -d @example_long_link_base64_invalid.json  http://localhost/rest/v3/short-urls
+```
 
+Should work:
 ```bash
-curl -X GET --header "X-Api-Key: secret" -H "Content-Type: application/json" -d @example_long_link.json  http://localhost/rest/v3/short-urls/<shortcode>
+curl -X POST --header "X-Api-Key: secret" -H "Content-Type: application/json" -d @example_long_link_shortcut_location.json  http://localhost/rest/v3/short-urls
 ```
+
+### GET
+
+Should not work:
+```bash
+curl -X GET --header "X-Api-Key: secret" -H "Content-Type: application/json" http://localhost/rest/v3/short-urls
+```
+
+Should work (if short link exists):
+```bash
+curl -X GET --header "X-Api-Key: secret" -H "Content-Type: application/json" http://localhost/rest/v3/short-urls/segrs4
+```

docker-compose.yml

@@ -8,7 +8,7 @@ services:
     environment:
       # Http cannot be omitted here
       - PROXY_TARGET=http://shlink:8080
-      - LOGGING_LEVEL=debug
+      - LOG_LEVEL=debug
     networks:
       - test-network
     labels:

go.mod

@@ -0,0 +1,3 @@
+module shlink-guard
+
+go 1.21.3