fagan2888 / rssreader

RSS reader is a simple Java library for extracting data from RSS and Atom feeds with Java stream API

RSS Reader

RSS (Rich Site Summary) is a type of web feed which allows users to access updates to online content in a standardized, computer-readable format. Subscribing to a website RSS removes the need for the user to manually check the website for new content.

Atom feeds is supported from version 2.0.0 and later.

This Java library makes it easier to automate data extraction from RSS or Atom feeds via Java stream API.

Examples

Read RSS feed

Reads from a RSS (or Atom) feeds and extract all items that contains the word football in the title.

RssReader reader = new RssReader();
Stream<Item> rssFeed = reader.read(URL);
List<Item> articles = rssFeed.filter(i -> i.getTitle().equals(Optional.of("football")))
                             .collect(Collectors.toList());

Merging RSS feeds

Merging several feeds into one feed sored in ascending (oldest first) publication date order and prints the title.

RssReader reader = new RssReader();
Stream.concat(reader.read(URL1),
              reader.read(URL2),  
              reader.read(URL3))
      .sorted()
      .map(Item::getTitle)
      .forEach(System.out::println);

Download

Download the latest JAR or grab via Maven or Gradle.

Maven setup

Add JCenter repository for resolving artifact:

<project>
    ...
    <repositories>
        <repository>
            <id>jcenter</id>
            <url>https://jcenter.bintray.com</url>
        </repository>
    </repositories>
    ...
</project>

Add dependency declaration:

<project>
    ...
    <dependencies>
        <dependency>
            <groupId>com.apptastic</groupId>
            <artifactId>rssreader</artifactId>
            <version>2.3.1</version>
        </dependency>
    </dependencies>
    ...
</project>

Gradle setup

Add JCenter repository for resolving artifact:

repositories {
    jcenter()
}

Add dependency declaration:

dependencies {
    implementation 'com.apptastic:rssreader:2.3.1'
}

RSS Reader library requires at minimum Java 11.

License

MIT License

Copyright (c) 2020, Apptastic Software

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.