/
Skraper.kt
57 lines (50 loc) · 1.62 KB
/
Skraper.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
/*
* Copyright (c) 2019-present Mikhael Sokolov
*
* 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.
*/
package ru.sokomishalov.skraper
import kotlinx.coroutines.flow.Flow
import ru.sokomishalov.skraper.client.SkraperClient
import ru.sokomishalov.skraper.model.Media
import ru.sokomishalov.skraper.model.PageInfo
import ru.sokomishalov.skraper.model.Post
/**
* Interface for the minimum provider functionality
*/
interface Skraper {
/**
* @return http client
*/
val client: SkraperClient get() = Skrapers.client
/**
* @param path page specific url path (should start with "/")
* @return flow of posts
*/
fun getPosts(path: String): Flow<Post>
/**
* @param path page specific url path (should start with "/")
* @return page info
*/
suspend fun getPageInfo(path: String): PageInfo?
/**
* @param url posts/page/media url
* @return true if such skraper supports this url
*/
fun supports(url: String): Boolean
/**
* @param media with provider relative url
* @return media with direct url
*/
suspend fun resolve(media: Media): Media
}