-
Notifications
You must be signed in to change notification settings - Fork 308
/
ClearlyDefinedService.kt
160 lines (140 loc) · 4.66 KB
/
ClearlyDefinedService.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*
* Copyright (C) 2019 Bosch Software Innovations 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.
*
* SPDX-License-Identifier: Apache-2.0
* License-Filename: LICENSE
*/
package com.here.ort.clearlydefined
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonValue
import retrofit2.Call
import retrofit2.http.GET
import retrofit2.http.Path
import retrofit2.Retrofit
import retrofit2.converter.jackson.JacksonConverterFactory
import java.io.File
import java.net.URL
/**
* Interface for the ClearlyDefined REST API, based on code generated by https://app.quicktype.io/ from
* https://github.com/clearlydefined/service/tree/master/schemas.
*/
interface ClearlyDefinedService {
companion object {
fun create(server: Server): ClearlyDefinedService {
val retrofit = Retrofit.Builder()
.baseUrl(server.url)
.addConverterFactory(JacksonConverterFactory.create())
.build()
return retrofit.create(ClearlyDefinedService::class.java)
}
}
enum class Server(val url: String) {
PRODUCTION("https://api.clearlydefined.io"),
DEVELOPMENT("https://dev-api.clearlydefined.io"),
LOCALHOST("http://localhost:4000")
}
/**
* See https://github.com/clearlydefined/service/blob/master/schemas/curation-1.0.json.
*/
data class Curation(
val described: Described? = null,
val files: List<FileEntry>? = null,
val licensed: Licensed? = null
)
data class Described(
val facets: Facets? = null,
val issueTracker: URL? = null,
val projectWebsite: URL? = null,
val releaseDate: String? = null,
val sourceLocation: SourceLocation? = null
)
data class Facets(
val data: List<String>? = null,
val dev: List<String>? = null,
val doc: List<String>? = null,
val examples: List<String>? = null,
val tests: List<String>? = null
)
data class SourceLocation(
val name: String,
val namespace: String? = null,
val path: String? = null,
val provider: Provider,
val revision: String,
val type: Type,
val url: String? = null
)
// See https://github.com/clearlydefined/service/blob/master/schemas/curation-1.0.json#L44
enum class Provider(val value: String) {
COCOAPODS("cocoapods"),
CRATES_IO("cratesio"),
DEBIAN("debian"),
GITHUB("github"),
MAVEN_CENTRAL("mavencentral"),
NPM_JS("npmjs"),
NUGET("nuget"),
PACKAGIST("packagist"),
PYPI("pypi"),
RUBYGEMS("rubygems");
companion object {
@JsonCreator
@JvmStatic
fun fromString(value: String) = enumValues<Provider>().single { value.equals(it.value, true) }
}
@JsonValue
override fun toString() = value
}
// See https://github.com/clearlydefined/service/blob/master/schemas/curation-1.0.json#L23.
enum class Type(val value: String) {
COMPOSER("composer"),
CRATE("crate"),
DEBIAN("deb"),
DEBIAN_SOURCES("debsrc"),
GEM("gem"),
GIT("git"),
MAVEN("maven"),
NPM("npm"),
NUGET("nuget"),
POD("pod"),
PYPI("pypi"),
SOURCE_ARCHIVE("sourcearchive");
companion object {
@JsonCreator
@JvmStatic
fun fromString(value: String) = enumValues<Provider>().single { value.equals(it.value, true) }
}
@JsonValue
override fun toString() = value
}
data class FileEntry(
val attributions: List<String>? = null,
val license: String? = null,
val path: File
)
data class Licensed(
val declared: String? = null
)
/**
* Get a curation for a component revision.
*/
@GET("curations/{type}/{provider}/{namespace}/{name}/{revision}")
fun getCuration(
@Path("type") type: Type,
@Path("provider") provider: Provider,
@Path("namespace") namespace: String,
@Path("name") name: String,
@Path("revision") revision: String
): Call<Curation>
}