nmdias / feedparser Goto Github PK

View Code? Open in Web Editor NEW

11.0 1.0 1.0 414 KB

An RSS and Atom feed parser written in Swift

License: MIT License

Objective-C 0.56% Swift 99.23% Ruby 0.21%

atom atom-feed-parser atom-reader dublin-core feed-parser feed-reader rss rss-feed-parser rss-reader swift syndication

feedparser's Introduction

FeedParser

An RSS and Atom feed parser written in Swift

Deprecated Notice ⚠️

FeedParser and been renamed FeedKit and moved to a new repository.

The sole reason for deprecating the FeedParser repository lies under the need to rename the framework while keeping a consistent use of it's new name. The new repository FeedKit will be under active development and maintenance.

Features

Requirements

Installation

CocoaPods

CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To give FeedParser a try with an example project, run the following command:

$ pod try FeedParser

To integrate FeedParser into your Xcode project, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

target 'MyApp' do
  pod 'FeedParser', '~> 3.1'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a dependency manager that builds your dependencies and provides you with binary frameworks.

To install Carthage with Homebrew use the following command:

$ brew update
$ brew install carthage

To integrate FeedParser into your Xcode project using Carthage, specify it in your Cartfile:

github "nmdias/FeedParser" ~> 3.1

Build the framework:

$ carthage update

Then, drag the built FeedParser.framework into your Xcode project.

Usage

Feed Parsing

RSS

import FeedParser

let URL = NSURL(string: "http://images.apple.com/main/rss/hotnews/hotnews.rss")!

FeedParser(URL: URL)?.parse({ (result) in
    result.rssFeed // An `RSSFeed` model
})

Atom

FeedParser(URL: URL)?.parse({ (result) in
    result.atomFeed // An `AtomFeed` model
})

Aditional initializers can also be found for NSData and NSInputStream objects.

Parse Result

Multiple FeedType's and, or Error handling can be acomplished using the Result enum

FeedParser(URL: URL)?.parse({ (result) in
    
    switch result {
    case .RSS(let rssFeed):
        print(rssFeed) // An `RSSFeed` model
    case .Atom(let atomFeed):
        print(atomFeed) // An `AtomFeed` model
    case .Failure(let error):
        print(error) // An `NSError` object
    }
    
})

Model Preview

RSSFeed

FeedParser(URL: URL)?.parse({ (result) in
    
    guard let feed = result.rssFeed where result.isSuccess else {
        print(result.error)
        return
    }
    
    print(feed.title)                      // The feed's `Title`
    print(feed.items?.count)               // The number of articles
    print(feed.items?.first?.title)        // The feed's first article `Title`
    print(feed.items?.first?.description)  // The feed's first article `Description`
    print(feed.items?.first?.pubDate)      // The feed's first article `Publication Date`
    
})

Refer to the RSSFeed documentation for the complete model properties and description

AtomFeed

FeedParser(URL: URL)?.parse({ (result) in
    
    guard let feed = result.atomFeed where result.isSuccess else {
        print(result.error)
        return
    }
    
    print(feed.title)                    // The feed's `Title`
    print(feed.entries?.count)           // The number of articles
    print(feed.entries?.first?.title)    // The feed's first article `Title`
    print(feed.entries?.first?.summary)  // The feed's first article `Summary`
    print(feed.entries?.first?.updated)  // The feed's first article `Updated Date`
    
})

Refer to the AtomFeed documentation for the complete model properties and description

Background Parsing

dispatch_async(dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0), {
    // Run parsing in a background thread
    FeedParser(URL: URL)?.parse({ (result) in
        dispatch_async(dispatch_get_main_queue(), { () -> Void in
            // Perform updates to the UI
        })
    })
})

License

FeedParser is released under the MIT license. See LICENSE for details.

feedparser's People

Contributors

Stargazers

Watchers

Forkers

andj207

feedparser's Issues

FeedParser issue

In the Core folder.
The FeedParser.swift file.

Error: All stored properties of a class instance must be initialized before returning nil form an initializer

I am using xcode version 7.2 if that helps.

public init?(URL: NSURL) {

    guard let parser = Parser(contentsOfURL: URL) else {

//This line gives me a error. -------> return nil
}

    self.parser = parser

}

FeedParser class and namespace

Hi, I'm facing an issue with your library. I have already an implementation of Result Enum in my project. Since your module FeedParser has a class named exactly the same I cannot specify in my code your version of Result as FeedParser.Result since XCode always assumes the class FeedParser type.