NetNewsWire/Frameworks/Account/FeedProvider/FeedProvider.swift

//
//  FeedProvider.swift
//  FeedProvider
//
//  Created by Maurice Parker on 4/6/20.
//  Copyright © 2020 Ranchero Software, LLC. All rights reserved.
//

import Foundation
import RSCore
import RSParser

public enum FeedProviderAbility {
	case owner
	case available
	case none
}

public struct FeedProviderFeedMetaData {
	let name: String
	let homePageURL: String?
}

public protocol FeedProvider  {
	
	/// Informs the caller of the ability for this feed provider to service the given URL
	func ability(_ urlComponents: URLComponents) -> FeedProviderAbility
	
	/// Provide the iconURL of the given URL
	func iconURL(_ urlComponents: URLComponents, completion: @escaping (Result<String, Error>) -> Void)
	
	/// Construct the associated metadata for the new feed.  If the URL won't be recognized by this Feed Provider, it will error here.
	func metaData(_ urlComponents: URLComponents, completion: @escaping (Result<FeedProviderFeedMetaData, Error>) -> Void)
	
	/// Refresh all the article entries (ParsedItems)
	func refresh(_ webFeed: WebFeed, completion: @escaping (Result<Set<ParsedItem>, Error>) -> Void)
	
}