Created skeleton chart

.drone.yml

@@ -158,10 +158,9 @@ volumes:
       path: /var/lib/drone/cache/.ansible
 
 trigger:
-#  target:
+  target:
-#    - production
+    - production
   event:
     include:
       - promote
       - rollback
-      - custom

.editorconfig

@@ -543,9 +543,9 @@ ij_html_space_inside_empty_tag = false
 ij_html_text_wrap = normal
 
 [{*.kt,*.kts}]
-indent_size = 4
+indent_size = 2
-tab_width = 4
+tab_width = 2
-ij_continuation_indent_size = 8
+ij_continuation_indent_size = 4
 ij_kotlin_align_in_columns_case_branch = false
 ij_kotlin_align_multiline_binary_operation = false
 ij_kotlin_align_multiline_extends_list = false

module-deploy/deploy.gradle.kts

@@ -8,7 +8,7 @@ dependencies {
 
 jib {
     from {
-        image = "amazoncorretto:" + properties["projectSourceCompatibility"]
+        image = "amazoncorretto:" + properties["projectSourceCompatibility"] + "-al2023"
         platforms {
             platform {
                 architecture = "amd64"

module-deploy/helm/wahlrecht/Chart.yaml

@@ -0,0 +1,3 @@
+apiVersion: v2
+name: wahlrecht
+version: 0.2.4

module-deploy/helm/wahlrecht/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

module-deploy/helm/wahlrecht/README.md

@@ -0,0 +1,4 @@
+# Wahlrecht API
+
+This chart installs the Wahlrecht API
+into the Kubernetes cluster.

module-server/src/main/kotlin/de/twomartens/wahlrecht/configuration/FilterConfiguration.kt

@@ -0,0 +1,13 @@
+package de.twomartens.wahlrecht.configuration
+
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.web.filter.ForwardedHeaderFilter
+
+@Configuration
+open class FilterConfiguration {
+  @Bean
+  open fun forwardedFilter(): ForwardedHeaderFilter {
+    return ForwardedHeaderFilter()
+  }
+}

module-server/src/main/kotlin/de/twomartens/wahlrecht/configuration/OpenApiConfiguration.kt

@@ -6,7 +6,6 @@ import io.swagger.v3.oas.annotations.security.OAuthFlows
 import io.swagger.v3.oas.annotations.security.SecurityScheme
 import io.swagger.v3.oas.models.OpenAPI
 import io.swagger.v3.oas.models.info.Info
-import io.swagger.v3.oas.models.servers.Server
 import org.springframework.beans.factory.annotation.Value
 import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
@@ -36,7 +35,5 @@ open class OpenApiConfiguration {
                     .version(apiVersion)
                     .description(apiDescription)
             )
-            .addServersItem(Server().url("http://localhost:12000"))
-            .addServersItem(Server().url("https://api.2martens.de"))
     }
 }

module-server/src/main/kotlin/de/twomartens/wahlrecht/controller/v1/ElectionController.kt

@@ -12,10 +12,12 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse
 import io.swagger.v3.oas.annotations.security.SecurityRequirement
 import io.swagger.v3.oas.annotations.tags.Tag
 import org.mapstruct.factory.Mappers
-import org.springframework.http.HttpStatus
 import org.springframework.http.MediaType
 import org.springframework.http.ResponseEntity
+import org.springframework.http.ResponseEntity.created
+import org.springframework.http.ResponseEntity.ok
 import org.springframework.web.bind.annotation.*
+import org.springframework.web.util.UriComponentsBuilder
 
 @RestController
 @RequestMapping(value = ["/wahlrecht/v1"])
@@ -58,14 +60,14 @@ class ElectionController(private val service: ElectionService) {
           content = [Content(mediaType = "application/json", schema = Schema(implementation = Election::class))]
       )]
   )
-    @GetMapping(value = ["/elections/by-name/{electionName}"], produces = [MediaType.APPLICATION_JSON_VALUE])
+  @GetMapping(value = ["/elections/{electionName}"], produces = [MediaType.APPLICATION_JSON_VALUE])
   @SecurityRequirement(name = "bearerAuth")
   @SecurityRequirement(name = "oauth2")
   fun getElectionByName(
       @PathVariable @Parameter(description = "the election name", example = "Bezirkswahl 2019") electionName: String?
   ): ResponseEntity<Election> {
     val election = mapper.mapToExternal(service.elections[electionName]!!)
-        return ResponseEntity.ok()
+    return ok()
         .contentType(MediaType.APPLICATION_JSON)
         .body(election)
   }
@@ -84,8 +86,14 @@ class ElectionController(private val service: ElectionService) {
   @PutMapping("/election")
   @SecurityRequirement(name = "bearerAuth")
   @SecurityRequirement(name = "oauth2")
-    fun putElection(@RequestBody election: Election?): ResponseEntity<*> {
+  fun putElection(@RequestBody election: Election?, uriComponentsBuilder: UriComponentsBuilder):
+      ResponseEntity<Void> {
     val createdNew = service.storeElection(mapper.mapToDB(election!!))
-        return if (createdNew) ResponseEntity<Any>(HttpStatus.CREATED) else ResponseEntity<Any>(HttpStatus.OK)
+    return if (createdNew) {
+      created(uriComponentsBuilder.path("/elections/{electionName}")
+          .buildAndExpand(election.name).toUri())
+          .build()
+    }
+    else ok().build()
   }
 }

module-server/src/main/kotlin/de/twomartens/wahlrecht/controller/v1/ElectionResultController.kt

@@ -14,10 +14,12 @@ import io.swagger.v3.oas.annotations.tags.Tag
 import lombok.RequiredArgsConstructor
 import lombok.extern.slf4j.Slf4j
 import org.mapstruct.factory.Mappers
-import org.springframework.http.HttpStatus
 import org.springframework.http.MediaType
 import org.springframework.http.ResponseEntity
+import org.springframework.http.ResponseEntity.created
+import org.springframework.http.ResponseEntity.ok
 import org.springframework.web.bind.annotation.*
+import org.springframework.web.util.UriComponentsBuilder
 
 @Slf4j
 @RestController
@@ -40,16 +42,16 @@ class ElectionResultController(private val service: ElectionResultService) {
         )]
     )
     @GetMapping(
-        value = ["/electionResult/by-election-name/{electionName}"],
+        value = ["/electionResults/{electionName}"],
         produces = [MediaType.APPLICATION_JSON_VALUE]
     )
     @SecurityRequirement(name = "bearerAuth")
     @SecurityRequirement(name = "oauth2")
-    fun getElectionByName(
+    fun getElectionResultByElectionName(
         @PathVariable @Parameter(description = "the election name", example = "Bezirkswahl 2019") electionName: String
     ): ResponseEntity<ElectionResult> {
         val result = mapper.mapToExternal(service.getElectionResult(electionName))
-        return ResponseEntity.ok()
+        return ok()
             .contentType(MediaType.APPLICATION_JSON)
             .body(result)
     }
@@ -68,8 +70,14 @@ class ElectionResultController(private val service: ElectionResultService) {
     @PutMapping("/electionResult")
     @SecurityRequirement(name = "bearerAuth")
     @SecurityRequirement(name = "oauth2")
-    fun putElection(@RequestBody electionResult: ElectionResult?): ResponseEntity<*> {
+    fun putElection(@RequestBody electionResult: ElectionResult?,
+                    uriComponentsBuilder: UriComponentsBuilder): ResponseEntity<Void> {
         val createdNew = service.storeResult(mapper.mapToDB(electionResult!!))
-        return if (createdNew) ResponseEntity<Any>(HttpStatus.CREATED) else ResponseEntity<Any>(HttpStatus.OK)
+        return if (createdNew) {
+          created(uriComponentsBuilder.path("/electionResult/{electionName}")
+              .buildAndExpand(electionResult.electionName).toUri())
+              .build()
+        }
+        else ok().build()
     }
 }

module-server/src/main/kotlin/de/twomartens/wahlrecht/controller/v1/PartyController.kt

@@ -13,17 +13,20 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse
 import io.swagger.v3.oas.annotations.security.SecurityRequirement
 import io.swagger.v3.oas.annotations.tags.Tag
 import org.mapstruct.factory.Mappers
-import org.springframework.http.HttpStatus
 import org.springframework.http.MediaType
 import org.springframework.http.ResponseEntity
+import org.springframework.http.ResponseEntity.created
+import org.springframework.http.ResponseEntity.ok
 import org.springframework.stereotype.Controller
 import org.springframework.web.bind.annotation.*
+import org.springframework.web.util.UriComponentsBuilder
 
 @Controller
 @RequestMapping(value = ["/wahlrecht/v1"])
 @Tag(name = "Parties", description = "all requests relating to parties")
 class PartyController(private val service: PartyService) {
   private val mapper = Mappers.getMapper(PartyInElectionMapper::class.java)
+
   @Operation(
       summary = "Returns all stored parties for given election name",
       responses = [ApiResponse(
@@ -39,7 +42,7 @@ class PartyController(private val service: PartyService) {
           content = [Content(mediaType = "application/json", schema = Schema(implementation = ErrorMessage::class))]
       )]
   )
-    @GetMapping(value = ["/parties/by-election-name/{electionName}"], produces = [MediaType.APPLICATION_JSON_VALUE])
+  @GetMapping(value = ["/parties/{electionName}"], produces = [MediaType.APPLICATION_JSON_VALUE])
   @SecurityRequirement(name = "bearerAuth")
   @SecurityRequirement(name = "oauth2")
   fun getPartiesByElectionName(
@@ -52,11 +55,41 @@ class PartyController(private val service: PartyService) {
           )
         }
         .toList()
-        return ResponseEntity.ok()
+    return ok()
         .contentType(MediaType.APPLICATION_JSON)
         .body(parties)
   }
 
+  @Operation(
+      summary = "Returns stored party for given election name and party abbreviation",
+      responses = [ApiResponse(
+          responseCode = "200",
+          description = "Returns stored party",
+          content = [Content(
+              mediaType = "application/json",
+              schema = Schema(implementation = PartyInElection::class)
+          )]
+      ), ApiResponse(
+          responseCode = "404",
+          description = "No party found",
+          content = [Content(mediaType = "application/json", schema = Schema(implementation = ErrorMessage::class))]
+      )]
+  )
+  @GetMapping(value = ["/parties/{electionName}/{abbreviation}"], produces = [MediaType.APPLICATION_JSON_VALUE])
+  @SecurityRequirement(name = "bearerAuth")
+  @SecurityRequirement(name = "oauth2")
+  fun getPartyByElectionNameAndAbbreviation(
+      @PathVariable @Parameter(description = "the election name", example = "Bezirkswahl 2019") electionName: String,
+      @PathVariable @Parameter(description = "the party abbreviation", example = "SPD") abbreviation: String
+  ): ResponseEntity<PartyInElection> {
+    val party = mapper.mapToExternal(
+        service.getPartyByElectionNameAndAbbreviation(electionName, abbreviation)
+    )
+    return ok()
+        .contentType(MediaType.APPLICATION_JSON)
+        .body(party)
+  }
+
   @Operation(
       summary = "Stores a new party in an election",
       responses = [ApiResponse(
@@ -70,8 +103,13 @@ class PartyController(private val service: PartyService) {
   @PutMapping("/party")
   @SecurityRequirement(name = "bearerAuth")
   @SecurityRequirement(name = "oauth2")
-    fun putParty(@RequestBody party: PartyInElection?): ResponseEntity<*> {
+  fun putParty(@RequestBody party: PartyInElection?,
+               uriComponentsBuilder: UriComponentsBuilder): ResponseEntity<Void> {
     val createdNew = service.storeParty(mapper.mapToDB(party!!))
-        return if (createdNew) ResponseEntity<Any>(HttpStatus.CREATED) else ResponseEntity<Any>(HttpStatus.OK)
+    return if (createdNew) {
+      created(uriComponentsBuilder.path("/parties/{electionName}/{abbreviation}")
+          .buildAndExpand(party.electionName, party.abbreviation).toUri())
+          .build()
+    } else ok().build()
   }
 }

module-server/src/main/kotlin/de/twomartens/wahlrecht/repository/PartyRepository.kt

@@ -5,4 +5,6 @@ import org.springframework.data.mongodb.repository.MongoRepository
 
 interface PartyRepository : MongoRepository<PartyInElection, String> {
     fun findByElectionName(name: String): Collection<PartyInElection>
+
+    fun findByElectionNameAndAbbreviation(electionName: String, abbreviation: String): PartyInElection?
 }

module-server/src/main/kotlin/de/twomartens/wahlrecht/service/PartyService.kt

@@ -18,6 +18,13 @@ class PartyService(
         fetchParties()
     }
 
+  fun getPartyByElectionNameAndAbbreviation(electionName: String,
+                                            abbreviation: String): PartyInElection {
+    return partyRepository.findByElectionNameAndAbbreviation(electionName, abbreviation)
+        ?: throw ResponseStatusException(HttpStatus.NOT_FOUND,
+            "no party found for $electionName and $abbreviation")
+  }
+
     fun getPartiesByElectionName(electionName: String): Collection<PartyInElection> {
         val parties = partyRepository.findByElectionName(electionName)
         if (parties.isEmpty()) {

module-server/src/main/resources/application.yaml

@@ -1,6 +1,7 @@
 server:
   port: 12000
   shutdown: graceful
+  forward-headers-strategy: framework
 
 ### technical configurations ###
 management: