-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e91fb46
commit ba110e5
Showing
9 changed files
with
865 additions
and
0 deletions.
There are no files selected for viewing
14 changes: 14 additions & 0 deletions
14
... Technical_ EU STR - Code Single Digital Entry Point/str-ap-internal-0.0.43/.env.template
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
INTERNAL_PORT=443 | ||
CERT_FILE=/Users/thierryturpin/GolandProjects/str-ap-internal/str.local.pem | ||
KEY_FILE=/Users/thierryturpin/GolandProjects/str-ap-internal/str.local-key.pem | ||
AUTH0_DOMAIN=tt-dp-dev.eu.auth0.com | ||
AUTH0_AUDIENCE=https://str.eu | ||
BOOTSTRAP_SERVERS=pkc-***.cloud:9092 | ||
SECURITY_PROTOCOL=SASL_SSL | ||
SASL_MECHANISMS=PLAIN | ||
SASL_USERNAME=*** | ||
SASL_PASSWORD=*** | ||
SHAPE_DEST=/Users/thierryturpin/GolandProjects/str-ap-internal/shape-files | ||
HOST=eu-str.sdep-pilot.eu | ||
CA_API_URL=https://sdep.acceptatie.toeristischeverhuur.nl/api/v1/registrations/competent-authority-check/ | ||
CA_API_KEY=*** |
29 changes: 29 additions & 0 deletions
29
.../1. Technical_ EU STR - Code Single Digital Entry Point/str-ap-internal-0.0.43/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# If you prefer the allow list template instead of the deny list, see community template: | ||
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore | ||
# | ||
# Binaries for programs and plugins | ||
*.exe | ||
*.exe~ | ||
*.dll | ||
*.so | ||
*.dylib | ||
|
||
# Test binary, built with `go test -c` | ||
*.test | ||
|
||
# Output of the go coverage tool, specifically when used with LiteIDE | ||
*.out | ||
|
||
# Dependency directories (remove the comment below to include it) | ||
# vendor/ | ||
|
||
# Go workspace file | ||
go.work | ||
|
||
# Local config and secrets | ||
/.env | ||
/str.local.pem | ||
/str.local-key.pem | ||
/dist/ | ||
/http-client.env.json | ||
/shape-files/ |
63 changes: 63 additions & 0 deletions
63
...chnical_ EU STR - Code Single Digital Entry Point/str-ap-internal-0.0.43/.goreleaser.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# The lines below are called `modelines`. See `:help modeline` | ||
# Feel free to remove those if you don't want/need to use them. | ||
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json | ||
# vim: set ts=2 sw=2 tw=0 fo=cnqoj | ||
|
||
version: 1 | ||
|
||
builds: | ||
- main: ./cmd/str/ | ||
ldflags: | ||
- -s -w -X str/pkg/handler.Version={{.Version}} | ||
env: | ||
- CGO_ENABLED=0 | ||
goos: | ||
- linux | ||
- darwin | ||
goarch: | ||
- amd64 | ||
- arm64 | ||
|
||
dockers: | ||
- image_templates: | ||
- "ghcr.io/thierryturpin/{{.ProjectName}}:{{ .Tag }}" | ||
- "ghcr.io/thierryturpin/{{.ProjectName}}:latest" | ||
extra_files: | ||
- docs | ||
build_flag_templates: | ||
- "--pull" | ||
- "--label=org.opencontainers.image.created={{.Date}}" | ||
- "--label=org.opencontainers.image.title={{.ProjectName}}" | ||
- "--label=org.opencontainers.image.revision={{.FullCommit}}" | ||
- "--label=org.opencontainers.image.version={{.Version}}" | ||
|
||
|
||
archives: | ||
- format: tar.gz | ||
# this name template makes the OS and Arch compatible with the results of `uname`. | ||
name_template: >- | ||
{{ .ProjectName }}_ | ||
{{- title .Os }}_ | ||
{{- if eq .Arch "amd64" }}x86_64 | ||
{{- else if eq .Arch "386" }}i386 | ||
{{- else }}{{ .Arch }}{{ end }} | ||
{{- if .Arm }}v{{ .Arm }}{{ end }} | ||
# use zip for windows archives | ||
format_overrides: | ||
- goos: windows | ||
format: zip | ||
# Additional files/globs you want to add to the archive. | ||
# | ||
# Default: [ 'LICENSE*', 'README*', 'CHANGELOG', 'license*', 'readme*', 'changelog'] | ||
# Templates: allowed | ||
files: | ||
- docs/**/* | ||
- README.md | ||
- .env.template | ||
|
||
changelog: | ||
sort: asc | ||
filters: | ||
exclude: | ||
- "^docs:" | ||
- "^test:" |
21 changes: 21 additions & 0 deletions
21
.../1. Technical_ EU STR - Code Single Digital Entry Point/str-ap-internal-0.0.43/Dockerfile
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
FROM alpine | ||
|
||
# Create a new user 'str' with user ID 1001 | ||
RUN adduser -D -u 1001 str | ||
|
||
# Copy files | ||
# todo check the naming of the binary | ||
COPY str-ap-internal /opt/str | ||
COPY docs/ /opt/docs/ | ||
|
||
RUN touch /opt/.env | ||
|
||
# Change ownership of the /opt directory to the new user | ||
RUN chown -R str:str /opt | ||
|
||
WORKDIR /opt | ||
|
||
# Switch user | ||
USER str | ||
|
||
ENTRYPOINT ["/opt/str"] |
228 changes: 228 additions & 0 deletions
228
...ical_ EU STR - Code Single Digital Entry Point/str-ap-internal-0.0.43/EU-STR.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,228 @@ | ||
## Setup | ||
This notebook is a collection of `curl` commands that can be executed in the terminal to validate the API endpoints\. | ||
Besides `curl` also `jq` is used for formatting purposes\. | ||
### client credentials | ||
The `bw` command is the Bitwarden password manager CLI command\. | ||
Replace the CLIENT\_ID value\, with your personal CLIENT\_ID\. And provison your CLIENT\_SECRET | ||
```warp-runnable-command | ||
CLIENT_ID=plQ8P4mNxEoKFLY0NnYvfkO1Ak9HozjG \ | ||
CLIENT_SECRET=$(bw get password plQ8P4mNxEoKFLY0NnYvfkO1Ak9HozjG) | ||
``` | ||
The client SECRET can also be captured via CLI read\: | ||
```warp-runnable-command | ||
read CLIENT_SECRET | ||
``` | ||
Get an OAUTH token \( from the `/token` endpoint\) | ||
```warp-runnable-command | ||
# Compose the JSON string using jq | ||
DATA=$(jq -n \ | ||
--arg client_id "$CLIENT_ID" \ | ||
--arg client_secret "$CLIENT_SECRET" \ | ||
--arg audience "https://str.eu" \ | ||
--arg grant_type "client_credentials" \ | ||
'{client_id: $client_id, client_secret: $client_secret, audience: $audience, grant_type: $grant_type}') | ||
# Get the token | ||
TOKEN=$(curl -s --request POST \ | ||
--url https://tt-dp-dev.eu.auth0.com/oauth/token \ | ||
--header 'content-type: application/json' \ | ||
--data $DATA | jq -r .access_token ) | ||
``` | ||
### API host | ||
```warp-runnable-command | ||
HOST=eu-str.sdep-pilot.eu | ||
``` | ||
## Test API | ||
### Unauthenticated health endpoint | ||
```warp-runnable-command | ||
curl -s https://$HOST/api/v0/ping | jq -r . | ||
``` | ||
This should return\: | ||
```json | ||
{ | ||
"status": "ok" | ||
} | ||
``` | ||
## Activity data | ||
### Submit of activity data | ||
Multiple records can be posted at ounce\, but will be stored as individual records\. | ||
For demo purposes\, we can set an invalid country code\. | ||
```warp-runnable-command | ||
curl -s -X POST https://$HOST/api/v0/str/activity-data \ | ||
--header "Authorization: Bearer $TOKEN" \ | ||
--header "Content-Type: application/json" \ | ||
--data '{ | ||
"data": [ | ||
{ | ||
"numberOfGuests": 10, | ||
"countryOfGuests": [ | ||
"ITZ", | ||
"NLD" | ||
], | ||
"temporal": { | ||
"startDateTime": "2024-07-21T17:32:28Z", | ||
"endDateTime": "2024-07-25T17:32:28Z" | ||
}, | ||
"address": { | ||
"street": "123 Main St", | ||
"city": "Brussels", | ||
"postalCode": "1000", | ||
"country": "BEL" | ||
}, | ||
"hostId": "placeholder-host-id", | ||
"unitId": "placeholder-unit-id", | ||
"areaId": "placeholder-area-id" | ||
}, | ||
{ | ||
"numberOfGuests": 2, | ||
"countryOfGuests": [ | ||
"BEL" | ||
], | ||
"temporal": { | ||
"startDateTime": "2024-07-21T17:32:28Z", | ||
"endDateTime": "2024-07-25T17:32:28Z" | ||
}, | ||
"address": { | ||
"street": "123 Main St", | ||
"city": "Brussels", | ||
"postalCode": "1000", | ||
"country": "BEL" | ||
}, | ||
"hostId": "placeholder-host-id", | ||
"unitId": "placeholder-unit-id", | ||
"areaId": "placeholder-area-id" | ||
}, | ||
{ | ||
"numberOfGuests": 3, | ||
"countryOfGuests": [ | ||
"BEL" | ||
], | ||
"temporal": { | ||
"startDateTime": "2024-07-21T17:32:28Z", | ||
"endDateTime": "2024-07-25T17:32:28Z" | ||
}, | ||
"address": { | ||
"street": "123 Main St", | ||
"city": "Brussels", | ||
"postalCode": "1000", | ||
"country": "BEL" | ||
}, | ||
"hostId": "placeholder-host-id", | ||
"unitId": "placeholder-unit-id", | ||
"areaId": "placeholder-area-id" | ||
} | ||
], | ||
"metadata": { | ||
"platform": "booking.com", | ||
"submissionDate": "2024-07-21T17:32:28Z", | ||
"additionalProp1": {} | ||
} | ||
} | ||
' \ | ||
| jq . | ||
``` | ||
Data has been pushed to the Kafka topic\: `activity-data` | ||
|
||
### Only for demonstration purposes\, and if you have an own deployment | ||
We can use `kcat` to list kafka topics and kafka topics content | ||
```warp-runnable-command | ||
kcat -L | ||
``` | ||
```warp-runnable-command | ||
kcat -C -t activity-data -c 20 -f 'Headers: %h || Message value: %s\n' | ||
``` | ||
Confluent Kafka also allows to views data in the topics\: [https\:\/\/confluent\.cloud\/environments\/env\-d19ry\/clusters\/lkc\-1dm6dj\/topics\/activity\-data\/message\-viewer](https://confluent.cloud/environments/env-d19ry/clusters/lkc-1dm6dj/topics/activity-data/message-viewer) | ||
Note also the header data contains the OAUTH2 app name\. | ||
|
||
### Retrieve activity data submitted to the SDEP | ||
```warp-runnable-command | ||
curl -s https://$HOST/api/v0/ca/activity-data \ | ||
--header "Authorization: Bearer $TOKEN" \ | ||
| jq . | ||
``` | ||
Note each consumer has it\'s offset and will only get \"new\" published data\. | ||
|
||
## Listings | ||
### Submit of listings data | ||
```warp-runnable-command | ||
curl -s -X POST https://$HOST/api/v0/str/listings \ | ||
--header "Authorization: Bearer $TOKEN" \ | ||
--header "Content-Type: application/json" \ | ||
--data ' | ||
{ | ||
"data": [ | ||
{ | ||
"registrationNumber": "1234", | ||
"Unit": { | ||
"description": "string", | ||
"floorLevel": "string", | ||
"address": { | ||
"street": "Culliganlaan 5", | ||
"city": "Diegem", | ||
"postalCode": "1831", | ||
"country": "BEL" | ||
}, | ||
"obtainedAuth": true, | ||
"subjectToAuth": true, | ||
"numberOfRooms": 0, | ||
"occupancy": 0, | ||
"purpose": "string", | ||
"type": "string", | ||
"url": "STR-Platform.com/1234" | ||
} | ||
} | ||
], | ||
"metadata": { | ||
"platform": "STR-Platform" | ||
} | ||
} | ||
'\ | ||
| jq . | ||
``` | ||
### Only for demonstration purposes\, and if you have an own deployment | ||
Consuming data from the kafka topic `listings` | ||
```warp-runnable-command | ||
kcat -C -t listings -c 20 -f 'Headers: %h || Message value: %s\n' | ||
``` | ||
### Retrieving listing data | ||
The limit parameter is optional\. | ||
This data retrieval is also incremental and will only return \"new\" data\. | ||
```warp-runnable-command | ||
curl -s https://$HOST/api/v0/ca/listings \ | ||
--header "Authorization: Bearer $TOKEN" \ | ||
| jq . | ||
``` | ||
## Area | ||
### Shape file upload | ||
```warp-runnable-command | ||
curl -s -X POST https://$HOST/api/v0/ca/area \ | ||
--header "Authorization: Bearer $TOKEN" \ | ||
-F "file=@/Users/thierryturpin/GolandProjects/str-ap-internal/BELGIUM_-_Regions.shp" | ||
``` | ||
### List shape files | ||
```warp-runnable-command | ||
curl -s https://$HOST/api/v0/str/area \ | ||
--header "Authorization: Bearer $TOKEN" \ | ||
| jq . | ||
``` | ||
### Download of a shape file | ||
Set the ID returned by the previous command | ||
```warp-runnable-command | ||
curl -s https://$HOST/api/v0/str/area/01J0R0GC700000000000000000 \ | ||
--header "Authorization: Bearer $TOKEN" \ | ||
-o downloaded_shape_file.shp | ||
``` | ||
Verify the downloaded file | ||
```warp-runnable-command | ||
file downloaded_shape_file.shp | ||
``` | ||
### Verify SSL certificate | ||
Only relevant for own deployments\: | ||
```warp-runnable-command | ||
export SERVER_NAME=$HOST | ||
export PORT=443 | ||
openssl s_client -servername $SERVER_NAME -connect $SERVER_NAME:$PORT | openssl x509 -noout -dates | ||
``` |
Oops, something went wrong.