news-api-kotlin's Introduction

News-API-Kotlin

This is a Kotlin API Wrapper SDK for the https://newsapi.org. Go to the website to get your apiKey. This can be used for both Android and regular Java/Kotlin projects.

How to import:

Gradle:

Add it in your root build.gradle at the end of repositories:

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

Add the dependency:

dependencies {
        implementation 'com.github.dfloureiro:news-api-kotlin:v2.1'
}

Maven:

<repositories>
	<repository>
	    <id>jitpack.io</id>
	    <url>https://jitpack.io</url>
	</repository>
</repositories>

Add the dependency:

<dependency>
    <groupId>com.github.dfloureiro</groupId>
    <artifactId>news-api-kotlin</artifactId>
    <version>v2.1</version>
</dependency>

How to use examples:

Create an instance of NewsApi:

    val newsApiRepository = NewsApiRepository("myApiKey")

Get top headlines by category/country/query:

    newsApiRepository.getTopHeadlines(category = Category.GENERAL, country = Country.US, q = "trump", pageSize = 20, page = 1)
            .subscribeOn(Schedulers.io())
	.toFlowable()
            .flatMapIterable { articles -> articles.articles }
            .subscribe({ article -> Log.d("getTopHead CC article", article.title) },
                    { t -> Log.d("getTopHeadlines error", t.message) })

Get top headlines by sources/query:

    newsApiRepository.getTopHeadlines(sources = "bbc-news", q = "trump", pageSize = 20, page = 1)
            .subscribeOn(Schedulers.io())
            .toFlowable()
            .flatMapIterable { articles -> articles.articles }
            .subscribe({ article -> Log.d("getTopHead S article", article.title) },
                    { t -> Log.d("getTopHeadlines error", t.message) })

Search articles from the full repo with everything:

    newsApiRepository.getEverything(q = "bitcoin", sources = "bbc-news", domains = null, from =  "2018-01-01", to = "2018-02-13", language = Language.EN, sortBy = SortBy.POPULARITY, pageSize = 20, page = 1)
            .subscribeOn(Schedulers.io())
            .toFlowable()
            .flatMapIterable { articles -> articles.articles }
            .subscribe({ article -> Log.d("getEverything article", article.title) },
                    { t -> Log.d("getEverything error", t.message) })

Get available sources:

    newsApiRepository.getSources(category = Category.GENERAL, language = Language.EN, country = Country.US)
            .subscribeOn(Schedulers.io())
            .toFlowable()
            .flatMapIterable { sources -> sources.sources }
            .subscribe({ source -> Log.d("source", source.name) },
                    { t -> Log.d("getSources error", t.message) })

Used technologies:

news-api-kotlin's People

Contributors

Stargazers

Watchers

news-api-kotlin's Issues

What about Retrofit?

inside lib right?
interface NewsAPI {
@get("{v2}/{top-headlines}")

fun listNews(@Path("v2") version : String,
             @Path("top-headlines") type : String,
             @Query("country") country: String,
             @Query("pageSize") pageSize: String,
             @Query("category") category: String,
             @Query("apiKey") key: String): Observable<ResponseBody>

@GET("{v2}/{everything}")
fun listSearchedNews(@Path("v2") version : String,
             @Path("everything") type : String,
             @Query("q") query: String,
             @Query("language") language: String,
             @Query("sortBy") sortBy: String,
             @Query("pageSize") pageSize: String,
             @Query("apiKey") key: String): Observable<ResponseBody>

}

Recommend Projects