NetNewsWire/Frameworks/RSParser/Feeds/JSON/JSONFeedParser.swift

//
//  JSONFeedParser.swift
//  RSParser
//
//  Created by Brent Simmons on 6/25/17.
//  Copyright © 2017 Ranchero Software, LLC. All rights reserved.
//

import Foundation

// See https://jsonfeed.org/version/1

public struct JSONFeedParser {

	public static func parse(_ parserData: ParserData) throws -> ParsedFeed? {

		do {
			guard let parsedObject = try JSONSerialization.jsonObject(with: parserData.data) as? JSONDictionary else {
				throw FeedParserError(.invalidJSON)
			}

			guard let version = parsedObject["version"] as? String, version.hasPrefix("https://jsonfeed.org/version/") else {
				throw FeedParserError(.jsonFeedVersionNotFound)
			}
			guard let itemsArray = parsedObject["items"] as? JSONArray else {
				throw FeedParserError(.jsonFeedItemsNotFound)
			}
			guard let title = parsedObject["title"] as? String else {
				throw FeedParserError(.jsonFeedTitleNotFound)
			}

			let authors = parseAuthors(parsedObject)
			let homePageURL = parsedObject["home_page_url"] as? String
			let feedURL = parsedObject["feed_url"] as? String ?? parserData.url
			let feedDescription = parsedObject["description"] as? String
			let nextURL = parsedObject["next_url"] as? String
			let iconURL = parsedObject["icon_url"] as? String
			let faviconURL = parsedObject["favicon_url"] as? String
			let expired = parsedObject["expired"] as? Bool ?? false
			let hubs = parseHubs(parsedObject)

			let items = parseItems(itemsArray, parserData.url)

			return ParsedFeed(type: .jsonFeed, title: title, homePageURL: homePageURL, feedURL: feedURL, feedDescription: feedDescription, nextURL: nextURL, iconURL: iconURL, faviconURL: faviconURL, authors: authors, expired: expired, hubs: hubs, items: items)

		}
		catch { throw error }
	}
}

private extension JSONFeedParser {

	static func parseAuthors(_ dictionary: JSONDictionary) -> Set<ParsedAuthor>? {

		guard let authorDictionary = dictionary["author"] as? JSONDictionary else {
			return nil
		}

		let name = authorDictionary["name"] as? String
		let url = authorDictionary["url"] as? String
		let avatar = authorDictionary["avatar"] as? String
		if name == nil && url == nil && avatar == nil {
			return nil
		}
		let parsedAuthor = ParsedAuthor(name: name, url: url, avatarURL: avatar, emailAddress: nil)
		return Set([parsedAuthor])
	}

	static func parseHubs(_ dictionary: JSONDictionary) -> Set<ParsedHub>? {

		guard let hubsArray = dictionary["hubs"] as? JSONArray else {
			return nil
		}

		let hubs = hubsArray.flatMap { (hubDictionary) -> ParsedHub? in
			guard let hubURL = hubDictionary["url"] as? String, let hubType = hubDictionary["type"] as? String else {
				return nil
			}
			return ParsedHub(type: hubType, url: hubURL)
		}
		return hubs.isEmpty ? nil : Set(hubs)
	}

	static func parseItems(_ itemsArray: JSONArray, _ feedURL: String) -> Set<ParsedItem> {

		return Set(itemsArray.flatMap { (oneItemDictionary) -> ParsedItem? in
			return parseItem(oneItemDictionary, feedURL)
		})
	}

	static func parseItem(_ itemDictionary: JSONDictionary, _ feedURL: String) -> ParsedItem? {

		guard let uniqueID = parseUniqueID(itemDictionary) else {
			return nil
		}

		let contentHTML = itemDictionary["content_html"] as? String
		let contentText = itemDictionary["content_text"] as? String
		if contentHTML == nil && contentText == nil {
			return nil
		}
		let decodedContentHTML = contentHTML?.rsparser_stringByDecodingHTMLEntities()

		let url = itemDictionary["url"] as? String
		let externalURL = itemDictionary["external_url"] as? String
		let title = itemDictionary["title"] as? String
		let summary = itemDictionary["summary"] as? String
		let imageURL = itemDictionary["image"] as? String
		let bannerImageURL = itemDictionary["banner_image"] as? String

		let datePublished = parseDate(itemDictionary["date_published"] as? String)
		let dateModified = parseDate(itemDictionary["date_modified"] as? String)

		let authors = parseAuthors(itemDictionary)
		var tags: Set<String>? = nil
		if let tagsArray = itemDictionary["tags"] as? [String] {
			tags = Set(tagsArray)
		}
		let attachments = parseAttachments(itemDictionary)

		return ParsedItem(syncServiceID: nil, uniqueID: uniqueID, feedURL: feedURL, url: url, externalURL: externalURL, title: title, contentHTML: decodedContentHTML, contentText: contentText, summary: summary, imageURL: imageURL, bannerImageURL: bannerImageURL, datePublished: datePublished, dateModified: dateModified, authors: authors, tags: tags, attachments: attachments)
	}

	static func parseUniqueID(_ itemDictionary: JSONDictionary) -> String? {

		if let uniqueID = itemDictionary["id"] as? String {
			return uniqueID // Spec says it must be a string
		}
		// Spec also says that if it’s a number, even though that’s incorrect, it should be coerced to a string.
		if let uniqueID = itemDictionary["id"] as? Int {
			return "\(uniqueID)"
		}
		if let uniqueID = itemDictionary["id"] as? Double {
			return "\(uniqueID)"
		}
		return nil
	}

	static func parseDate(_ dateString: String?) -> Date? {

		guard let dateString = dateString, !dateString.isEmpty else {
			return nil
		}
		return RSDateWithString(dateString)
	}

	static func parseAttachments(_ itemDictionary: JSONDictionary) -> Set<ParsedAttachment>? {

		guard let attachmentsArray = itemDictionary["attachments"] as? JSONArray else {
			return nil
		}
		return Set(attachmentsArray.flatMap { (oneAttachmentObject) -> ParsedAttachment? in
			return parseAttachment(oneAttachmentObject)
		})
	}

	static func parseAttachment(_ attachmentObject: JSONDictionary) -> ParsedAttachment? {

		guard let url = attachmentObject["url"] as? String else {
			return nil
		}
		guard let mimeType = attachmentObject["mime_type"] as? String else {
			return nil
		}

		let title = attachmentObject["title"] as? String
		let sizeInBytes = attachmentObject["size_in_bytes"] as? Int
		let durationInSeconds = attachmentObject["duration_in_seconds"] as? Int

		return ParsedAttachment(url: url, mimeType: mimeType, title: title, sizeInBytes: sizeInBytes, durationInSeconds: durationInSeconds)
	}
}