Features
Requirements
Installation >> instructions <<
Usage
Build a URL pointing to an RSS, Atom or JSON Feed.
let feedURL = URL(string: "http://images.apple.com/main/rss/hotnews/hotnews.rss")!
Get an instance of FeedParser
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.
// 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.
let result = parser.parse()
Parse Result
FeedKit adopts Swift 5 Result type, as Result<Feed, ParserError>, 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:
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
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
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
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 for details.
684 Dec 21, 2022
22 Oct 6, 2020
1.1k Dec 16, 2022
544 Dec 30, 2022
153 Dec 8, 2022
1k Jan 7, 2023
3 Aug 28, 2022
0 Jan 9, 2022
14 Aug 13, 2018
62 Nov 23, 2022
8 Nov 22, 2022
132 Dec 5, 2021
3.8k Jan 5, 2023
13 Nov 29, 2022
117 Sep 9, 2022
6.3k Dec 29, 2022
34 Dec 27, 2022
11 Aug 30, 2022