Merge pull request #14 from linked-planet/feature/ZITIS-845_core_common

Feature/zitis 845 core common

Author: HighKo

kotlin-atlassian-client-core-common/pom.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>com.linked-planet.client</groupId>
+        <artifactId>kotlin-atlassian-client</artifactId>
+        <version>0.12.10-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>kotlin-atlassian-client-core-common</artifactId>
+    <name>kotlin-atlassian-client-core-common</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>javax.validation</groupId>
+            <artifactId>validation-api</artifactId>
+            <version>2.0.1.Final</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+</project>

kotlin-atlassian-client-core-common/src/main/kotlin/com/linkedplanet/kotlinatlassianclientcore/common/api/JiraUser.kt

@@ -0,0 +1,30 @@
+/*-
+ * #%L
+ * kotlin-atlassian-client-core-common
+ * %%
+ * Copyright (C) 2022 - 2023 linked-planet GmbH
+ * %%
+ * 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.
+ * #L%
+ */
+package com.linkedplanet.kotlinatlassianclientcore.common.api
+
+import javax.validation.constraints.NotNull
+
+data class JiraUser(
+    @field:NotNull val key: String,
+    @field:NotNull val name: String,
+    @field:NotNull val emailAddress: String,
+    @field:NotNull val avatarUrl: String? = null,
+    @field:NotNull val displayName: String
+)

kotlin-atlassian-client-core-common/src/main/kotlin/com/linkedplanet/kotlinatlassianclientcore/common/api/Page.kt

@@ -0,0 +1,30 @@
+/*-
+ * #%L
+ * kotlin-atlassian-client-core-common
+ * %%
+ * Copyright (C) 2022 - 2023 linked-planet GmbH
+ * %%
+ * 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.
+ * #L%
+ */
+package com.linkedplanet.kotlinatlassianclientcore.common.api
+
+import javax.validation.constraints.NotNull
+
+data class Page<T> (
+    @field:NotNull val items: List<T>,
+    @field:NotNull val totalItems: Int,
+    @field:NotNull val totalPages: Int,
+    @field:NotNull val currentPageIndex: Int,
+    @field:NotNull val pageSize: Int
+)

kotlin-atlassian-client-core-common/src/main/kotlin/com/linkedplanet/kotlinatlassianclientcore/common/error/AtlassianClientError.kt

@@ -0,0 +1,35 @@
+/*-
+ * #%L
+ * kotlin-atlassian-client-core-common
+ * %%
+ * Copyright (C) 2022 - 2023 linked-planet GmbH
+ * %%
+ * 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.
+ * #L%
+ */
+@file:Suppress("CanBeParameter", "unused") // we want clients to access the additional information
+
+package com.linkedplanet.kotlinatlassianclientcore.common.error
+
+import arrow.core.Either
+import javax.validation.constraints.NotNull
+
+open class AtlassianClientError(
+    @field:NotNull val error: String,
+    @field:NotNull val message: String,
+    @field:NotNull val stacktrace: String = ""
+) {
+    companion object
+}
+
+fun <ERROR : AtlassianClientError, T> ERROR.asEither(): Either<ERROR, T> = Either.Left(this)

kotlin-http-client/kotlin-http-client-api/src/main/kotlin/com/linkedplanet/kotlinhttpclient/error/DomainError.kt renamed to kotlin-http-client/kotlin-http-client-api/src/main/kotlin/com/linkedplanet/kotlinhttpclient/error/HttpDomainError.kt

@@ -19,17 +19,4 @@
  */
 package com.linkedplanet.kotlinhttpclient.error
 
-import com.linkedplanet.kotlinhttpclient.api.http.GSON
-
-data class DomainErrorObject(
-    val error: String,
-    val message: String
-)
-
-open class DomainError(val error: String, val message: String) {
-    fun toJson(): String =
-        GSON.toJson(DomainErrorObject(error, message))
-}
-
-class HttpDomainError(val statusCode: Int, error: String, message: String) : DomainError(error, message)
-class ResponseError(message: String) : DomainError("Schnittstellen-Fehler", message)
+class HttpDomainError(val statusCode: Int, val error: String, val message: String)

kotlin-insight-client/kotlin-insight-client-api/pom.xml

@@ -34,5 +34,10 @@
             <version>2.2.2-atlassian-1</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.linked-planet.client</groupId>
+            <artifactId>kotlin-atlassian-client-core-common</artifactId>
+            <version>${project.version}</version>
+        </dependency>
     </dependencies>
 </project>

kotlin-insight-client/kotlin-insight-client-api/src/main/kotlin/com/linkedplanet/kotlininsightclient/api/error/InsightClientError.kt

@@ -22,6 +22,8 @@
 package com.linkedplanet.kotlininsightclient.api.error
 
 import arrow.core.Either
+import com.linkedplanet.kotlinatlassianclientcore.common.error.AtlassianClientError
+import com.linkedplanet.kotlinatlassianclientcore.common.error.asEither
 import com.linkedplanet.kotlininsightclient.api.model.InsightAttribute
 import com.linkedplanet.kotlininsightclient.api.model.InsightObjectId
 import com.linkedplanet.kotlininsightclient.api.model.InsightObjectTypeId
@@ -43,10 +45,10 @@ import io.swagger.v3.oas.annotations.media.Schema
 
 @Suppress("unused")
 sealed class InsightClientError(
-    val error: String,
-    val message: String,
-    val stacktrace: String = ""
-) {
+    error: String,
+    message: String,
+    stacktrace: String = ""
+) : AtlassianClientError(error, message, stacktrace) {
 
     companion object {
         private const val internalErrorString = "Jira/Insight hat ein internes Problem festgestellt"
@@ -58,7 +60,6 @@ sealed class InsightClientError(
 
     }
 }
-fun <T> InsightClientError.asEither(): Either<InsightClientError, T> = Either.Left(this)
 
 class InvalidArgumentInsightClientError(message: String) : InsightClientError("Unerwarteter Parameter", message)
 

kotlin-insight-client/kotlin-insight-client-api/src/main/kotlin/com/linkedplanet/kotlininsightclient/api/impl/AbstractInsightObjectRepository.kt

@@ -22,6 +22,7 @@ package com.linkedplanet.kotlininsightclient.api.impl
 import arrow.core.Either
 import arrow.core.computations.either
 import arrow.core.rightIfNotNull
+import com.linkedplanet.kotlinatlassianclientcore.common.api.Page
 import com.linkedplanet.kotlininsightclient.api.error.InsightClientError
 import com.linkedplanet.kotlininsightclient.api.error.OtherNotFoundError
 import com.linkedplanet.kotlininsightclient.api.interfaces.InsightObjectRepository
@@ -30,7 +31,6 @@ import com.linkedplanet.kotlininsightclient.api.model.InsightAttribute
 import com.linkedplanet.kotlininsightclient.api.model.InsightObject
 import com.linkedplanet.kotlininsightclient.api.model.InsightObjectId
 import com.linkedplanet.kotlininsightclient.api.model.InsightObjectTypeId
-import com.linkedplanet.kotlininsightclient.api.model.Page
 import kotlin.math.ceil
 
 abstract class AbstractInsightObjectRepository<DomainType> : InsightObjectRepository<DomainType> {

kotlin-insight-client/kotlin-insight-client-api/src/main/kotlin/com/linkedplanet/kotlininsightclient/api/impl/AbstractNameMappedRepository.kt

@@ -23,9 +23,9 @@ import arrow.core.Either
 import arrow.core.computations.either
 import arrow.core.right
 import arrow.core.sequenceEither
+import com.linkedplanet.kotlinatlassianclientcore.common.error.asEither
 import com.linkedplanet.kotlininsightclient.api.error.InsightClientError
 import com.linkedplanet.kotlininsightclient.api.error.InvalidArgumentInsightClientError
-import com.linkedplanet.kotlininsightclient.api.error.asEither
 import com.linkedplanet.kotlininsightclient.api.interfaces.InsightObjectTypeOperator
 import com.linkedplanet.kotlininsightclient.api.interfaces.InsightSchemaOperator
 import com.linkedplanet.kotlininsightclient.api.model.InsightAttribute.Companion.toReferences
@@ -169,7 +169,7 @@ abstract class AbstractNameMappedRepository<DomainType : Any>(
             is InsightAttribute.Select -> attribute.values// List<String>
             else -> InvalidArgumentInsightClientError(
                 "kType.classifier ${kType.classifier} is not supported."
-            ).asEither<DomainType?>(
+            ).asEither<InsightClientError, DomainType?>(
             ).bind()
         }
     }

kotlin-insight-client/kotlin-insight-client-api/src/main/kotlin/com/linkedplanet/kotlininsightclient/api/interfaces/InsightObjectRepository.kt

@@ -22,7 +22,7 @@ package com.linkedplanet.kotlininsightclient.api.interfaces
 import arrow.core.Either
 import com.linkedplanet.kotlininsightclient.api.error.InsightClientError
 import com.linkedplanet.kotlininsightclient.api.model.InsightObjectId
-import com.linkedplanet.kotlininsightclient.api.model.Page
+import com.linkedplanet.kotlinatlassianclientcore.common.api.Page
 
 /**
  * Generic Interface to CRUD one type of domain object, like a customer, to Insight.