Feature/add icon url to issue type (#24)

* add iconUrl to JiraIssueType

* fix GetIssueType Test

* use jaxrs context to aquire ContextUriInfo

* remove ContextUriInfo

* use restApi2BaseUrl

* add NotNull annotations to Jira Model

* add provided to dependency

Author: HighKo

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

@@ -21,13 +21,13 @@ package com.linkedplanet.kotlinatlassianclientcore.common.api
 
 import javax.validation.constraints.NotNull
 
-open class Page<T> (
+open 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
-) {
+) : List<T> by items {
     @Suppress("unused") // useful for inheritance by clients
     constructor() : this(emptyList<T>(), 0, 0, 0, 1)
 

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

@@ -24,5 +24,11 @@
             <artifactId>kotlin-atlassian-client-core-common</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>javax.validation</groupId>
+            <artifactId>validation-api</artifactId>
+            <version>2.0.1.Final</version>
+            <scope>provided</scope>
+        </dependency>
     </dependencies>
 </project>

kotlin-jira-client/kotlin-jira-client-api/src/main/kotlin/com/linkedplanet/kotlinjiraclient/api/model/Model.kt

@@ -19,51 +19,58 @@
  */
 package com.linkedplanet.kotlinjiraclient.api.model
 
+import javax.validation.constraints.NotNull
+
 data class JiraStatus(
-    val id: String,
-    val name: String,
-    val statusCategory: String
+    @field:NotNull val id: String,
+    @field:NotNull val name: String,
+    @field:NotNull val statusCategory: String
 )
 
 data class JiraTransition(
-    val id: String,
-    val name: String
+    @field:NotNull val id: String,
+    @field:NotNull val name: String
 )
 
 data class JiraProject(
-    val id: String,
-    val key: String,
-    val name: String
+    @field:NotNull val id: String,
+    @field:NotNull val key: String,
+    @field:NotNull val name: String
 )
 
 data class JiraIssueType(
-    val id: String,
-    val name: String
+    @field:NotNull val id: String,
+    @field:NotNull val name: String,
+    @field:NotNull val self: String,
+    @field:NotNull val description: String,
+    @field:NotNull val subTask: Boolean,
+    @field:NotNull val iconUrl: String,
+    @field:NotNull val avatarId: Long
 )
 
 data class JiraIssueTypeAttribute(
-    val id: String,
-    val name: String,
-    val schema: JiraIssueTypeAttributeSchema
+    @field:NotNull val id: String,
+    @field:NotNull val name: String,
+    @field:NotNull val schema: JiraIssueTypeAttributeSchema
 )
 
 data class JiraIssueTypeAttributeSchema(
-    val type: String, // "date" see com.atlassian.jira.issue.fields.rest.json.JsonType
+    @field:NotNull val type: String, // "date" see com.atlassian.jira.issue.fields.rest.json.JsonType
     val items: String?, // unclear what this is
     val system: String?, // only used if its a system field, e.g. "assignee"
     val custom: String?, // e.g. com.atlassian.jira.plugin.system.customfieldtypes:datepicker
     val customId: Long? // e.g. 10202
 )
 
 data class JiraIssue(
-    val id: String,
-    val key: String,
-    val self: String
+    @field:NotNull val id: String,
+    @field:NotNull val key: String,
+    @field:NotNull val self: String
 )
 
 data class JiraIssueComment(
-    val id: String,
-    val content: String,
-    val author: String,
-    val dateTime: String
+    @field:NotNull val id: String,
+    @field:NotNull val content: String,
+    @field:NotNull val author: String,
+    @field:NotNull val dateTime: String
 )

kotlin-jira-client/kotlin-jira-client-http/src/main/kotlin/com/linkedplanet/kotlinjiraclient/http/model/HttpModel.kt

@@ -83,10 +83,10 @@ data class HttpJiraIssueType(
     val iconUrl: String,
     val name: String,
     val subtask: Boolean,
-    val avatarId: Int
+    val avatarId: Long
 ) {
     fun toJiraIssueType() =
-        JiraIssueType(id, name)
+        JiraIssueType(id, name, self, description, subtask, iconUrl, avatarId)
 }
 
 fun List<HttpJiraIssueType>.toJiraIssueTypes(): List<JiraIssueType> =

kotlin-jira-client/kotlin-jira-client-sdk/src/main/kotlin/com/linkedplanet/kotlinjiraclient/sdk/SdkJiraIssueTypeOperator.kt

@@ -24,19 +24,25 @@ import com.atlassian.jira.bc.project.ProjectService
 import com.atlassian.jira.component.ComponentAccessor
 import com.atlassian.jira.config.IssueTypeService
 import com.atlassian.jira.issue.fields.rest.RestAwareField
+import com.atlassian.jira.issue.fields.rest.json.beans.JiraBaseUrls
 import com.atlassian.jira.issue.fields.screen.FieldScreenLayoutItem
 import com.atlassian.jira.issue.fields.screen.FieldScreenTab
 import com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenSchemeManager
 import com.atlassian.jira.issue.issuetype.IssueType
 import com.atlassian.jira.issue.operation.IssueOperations
+import com.atlassian.jira.rest.v2.issue.IssueTypeResource
+import com.atlassian.jira.rest.v2.issue.ResourceUriBuilder
 import com.linkedplanet.kotlinjiraclient.api.error.JiraClientError
 import com.linkedplanet.kotlinjiraclient.api.interfaces.JiraIssueTypeOperator
 import com.linkedplanet.kotlinjiraclient.api.model.JiraIssueType
 import com.linkedplanet.kotlinjiraclient.api.model.JiraIssueTypeAttribute
 import com.linkedplanet.kotlinjiraclient.api.model.JiraIssueTypeAttributeSchema
 import com.linkedplanet.kotlinjiraclient.sdk.util.eitherAndCatch
 import com.linkedplanet.kotlinjiraclient.sdk.util.toEither
+import java.net.MalformedURLException
+import java.net.URL
 import javax.inject.Named
+import javax.ws.rs.core.UriBuilder
 
 @Named
 object SdkJiraIssueTypeOperator : JiraIssueTypeOperator {
@@ -45,6 +51,7 @@ object SdkJiraIssueTypeOperator : JiraIssueTypeOperator {
     private val issueTypeService = ComponentAccessor.getComponent(IssueTypeService::class.java)
     private val issueTypeScreenSchemeManager = ComponentAccessor.getComponent(IssueTypeScreenSchemeManager::class.java)
     private val jiraAuthenticationContext = ComponentAccessor.getJiraAuthenticationContext()
+    private val jiraBaseUrls: JiraBaseUrls = ComponentAccessor.getComponent(JiraBaseUrls::class.java)
 
     private fun user() = jiraAuthenticationContext.loggedInUser
 
@@ -64,6 +71,7 @@ object SdkJiraIssueTypeOperator : JiraIssueTypeOperator {
                 screenTab.fieldScreenLayoutItems.map { layoutItem: FieldScreenLayoutItem ->
                     val orderableField = layoutItem.orderableField
                     val schema = (orderableField as? RestAwareField)?.jsonSchema
+                    // code inspired by AbstractMetaFieldBeanBuilder.java
                     JiraIssueTypeAttribute(
                         id = orderableField.id,
                         name = orderableField.name,
@@ -88,16 +96,27 @@ object SdkJiraIssueTypeOperator : JiraIssueTypeOperator {
         eitherAndCatch {
             val issueType = issueTypeService.getIssueType(user(), issueTypeId.toString()).orNull
                 ?: return@getIssueType issueTypeNotFound(issueTypeId)
-            issueType.let { it: IssueType ->
-                JiraIssueType(it.id, it.name)
-            }
+            toJiraIssueType(issueType)
         }
 
     override suspend fun getIssueTypes(projectId: Number): Either<JiraClientError, List<JiraIssueType>> =
         eitherAndCatch {
             projectService.getProjectById(user(), projectId.toLong()).toEither().bind().project?.issueTypes
-                ?.map { it: IssueType ->
-                    JiraIssueType(it.id, it.name)
-                } ?: emptyList()
+                ?.map(::toJiraIssueType)
+                ?: emptyList()
         }
+
+    private fun toJiraIssueType(issueType: IssueType): JiraIssueType =
+        issueType.run {
+            // code inspired by IssueTypeBeanBuilder
+            val iconAbsoluteURL = try {
+                URL(issueType.iconUrl).toString()
+            } catch (_: MalformedURLException) {
+                jiraBaseUrls.baseUrl() + issueType.iconUrl
+            }
+            val restApiUrl = UriBuilder.fromPath(jiraBaseUrls.restApi2BaseUrl())
+            val self = ResourceUriBuilder().build(restApiUrl, IssueTypeResource::class.java, issueType.id).toString()
+            JiraIssueType(id, name, self, descTranslation, isSubTask, iconAbsoluteURL, avatar?.id ?: 0L)
+        }
+
 }

kotlin-jira-client/kotlin-jira-client-test-base/src/main/kotlin/com/linkedplanet/kotlinjiraclient/JiraIssueTypeOperatorTest.kt

@@ -40,6 +40,11 @@ interface JiraIssueTypeOperatorTest<JiraFieldType> : BaseTestConfigProvider<Jira
         val issueType = runBlocking { issueTypeOperator.getIssueType(issueTypeId) }.orFail()
         assertThat(issueType.id, equalTo(issueTypeId.toString()))
         assertThat(issueType.name, equalTo("Story"))
+        assertThat(issueType.subTask, equalTo(false))
+        assertThat(issueType.description, containsString("Issue type for a user story."))
+        assertThat(issueType.self, endsWith("rest/api/2/issuetype/10001"))
+        assertThat(issueType.iconUrl, endsWith("images/icons/issuetypes/story.svg"))
+        assertThat(issueType.avatarId, equalTo(0L))
     }
 
     @Test