Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nmdias/FeedKit
An RSS, Atom and JSON Feed parser written in Swift
https://github.com/nmdias/FeedKit
atom atom-feed-parser atom-reader feed-parser feedkit parsing rss rss-feed-parser rss-reader swift
Last synced: about 1 month ago
JSON representation
An RSS, Atom and JSON Feed parser written in Swift
- Host: GitHub
- URL: https://github.com/nmdias/FeedKit
- Owner: nmdias
- License: mit
- Created: 2016-07-16T20:30:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-06T17:39:49.000Z (3 months ago)
- Last Synced: 2024-07-19T00:40:57.985Z (2 months ago)
- Topics: atom, atom-feed-parser, atom-reader, feed-parser, feedkit, parsing, rss, rss-feed-parser, rss-reader, swift
- Language: Swift
- Homepage:
- Size: 1.02 MB
- Stars: 1,168
- Watchers: 20
- Forks: 172
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - FeedKit - An RSS and Atom feed parser written in Swift. (Parsing / Other Parsing)
- awesome-ios-star - FeedKit - An RSS and Atom feed parser written in Swift. (Parsing / Other Parsing)
- awesome-starts - nmdias/FeedKit - An RSS, Atom and JSON Feed parser written in Swift (Swift)
README
[](https://travis-ci.org/nmdias/FeedKit)
[](https://cocoapods.org/pods/FeedKit)
[](https://github.com/Carthage/Carthage)
[](https://swift.org)
[](https://github.com/nmdias/DefaultsKit/releases)
## Features
- [x] [Atom](https://tools.ietf.org/html/rfc4287)
- [x] RSS [0.90](http://www.rssboard.org/rss-0-9-0), [0.91](http://www.rssboard.org/rss-0-9-1), [1.00](http://web.resource.org/rss/1.0/spec), [2.00](http://cyber.law.harvard.edu/rss/rss.html)
- [x] [JSON](https://jsonfeed.org/version/1)
- [x] Namespaces
- [x] [Dublin Core](http://web.resource.org/rss/1.0/modules/dc/)
- [x] [Syndication](http://web.resource.org/rss/1.0/modules/syndication/)
- [x] [Content](http://web.resource.org/rss/1.0/modules/content/)
- [x] [Media RSS](http://www.rssboard.org/media-rss)
- [x] [iTunes Podcasting Tags](https://help.apple.com/itc/podcasts_connect/#/itcb54353390)
- [x] [Documentation](http://cocoadocs.org/docsets/FeedKit)
- [x] Unit Test Coverage
## Requirements
Installation >> [`instructions`](https://github.com/nmdias/FeedKit/blob/master/INSTALL.md) <<
## Usage
Build a URL pointing to an RSS, Atom or JSON Feed.
```swift
let feedURL = URL(string: "http://images.apple.com/main/rss/hotnews/hotnews.rss")!
```
Get an instance of `FeedParser`
```swift
let parser = FeedParser(URL: feedURL) // or FeedParser(data: data) or FeedParser(xmlStream: stream)
```
Then call `parse` or `parseAsync` to start parsing the feed...
> A **common scenario** in UI environments would be parsing a feed **asynchronously** from a user initiated action, such as the touch of a button. e.g.
```swift
// Parse asynchronously, not to block the UI.
parser.parseAsync(queue: DispatchQueue.global(qos: .userInitiated)) { (result) in
// Do your thing, then back to the Main thread
DispatchQueue.main.async {
// ..and update the UI
}
}
```
Remember, you are responsible to manually bring the result closure to whichever queue is apropriate. Usually to the Main thread, for UI apps, by calling `DispatchQueue.main.async` .
Alternatively, you can also parse synchronously.
```swift
let result = parser.parse()
```
## Parse Result
FeedKit adopts Swift 5 Result type, as `Result`, and as such, if parsing succeeds you should now have a `Strongly Typed Model` of an `RSS`, `Atom` or `JSON Feed`, within the `Feed` enum:
```swift
switch result {
case .success(let feed):
// Grab the parsed feed directly as an optional rss, atom or json feed object
feed.rssFeed
// Or alternatively...
switch feed {
case let .atom(feed): // Atom Syndication Format Feed Model
case let .rss(feed): // Really Simple Syndication Feed Model
case let .json(feed): // JSON Feed Model
}
case .failure(let error):
print(error)
}
```
## Model Preview
> The RSS and Atom feed Models are rather extensive throughout the supported namespaces. These are just a preview of what's available.
#### RSS
```swift
feed.title
feed.link
feed.description
feed.language
feed.copyright
feed.managingEditor
feed.webMaster
feed.pubDate
feed.lastBuildDate
feed.categories
feed.generator
feed.docs
feed.cloud
feed.rating
feed.ttl
feed.image
feed.textInput
feed.skipHours
feed.skipDays
//...
feed.dublinCore
feed.syndication
feed.iTunes
// ...
let item = feed.items?.first
item?.title
item?.link
item?.description
item?.author
item?.categories
item?.comments
item?.enclosure
item?.guid
item?.pubDate
item?.source
//...
item?.dublinCore
item?.content
item?.iTunes
item?.media
// ...
```
#### Atom
```swift
feed.title
feed.subtitle
feed.links
feed.updated
feed.authors
feed.contributors
feed.id
feed.generator
feed.icon
feed.logo
feed.rights
// ...
let entry = feed.entries?.first
entry?.title
entry?.summary
entry?.authors
entry?.contributors
entry?.links
entry?.updated
entry?.categories
entry?.id
entry?.content
entry?.published
entry?.source
entry?.rights
// ...
```
#### JSON
```swift
feed.version
feed.title
feed.homePageURL
feed.feedUrl
feed.description
feed.userComment
feed.nextUrl
feed.icon
feed.favicon
feed.author
feed.expired
feed.hubs
feed.extensions
// ...
let item = feed.items?.first
item?.id
item?.url
item?.externalUrl
item?.title
item?.contentText
item?.contentHtml
item?.summary
item?.image
item?.bannerImage
item?.datePublished
item?.dateModified
item?.author
item?.url
item?.tags
item?.attachments
item?.extensions
// ...
```
## License
FeedKit is released under the MIT license. See [LICENSE](https://github.com/nmdias/FeedKit/blob/master/LICENSE) for details.