Check if feed is XML first

jocmp · Dec 11, 2023 · 8d50d04 · 8d50d04
1 parent 2a49a6e
commit 8d50d04
Show file tree

Hide file tree

Showing 15 changed files with 69 additions and 85 deletions.
diff --git a/basil/build.gradle.kts b/basil/build.gradle.kts
@@ -39,6 +39,8 @@ dependencies {
     implementation(project(":feedbinclient"))
     implementation(project(":feedfinder"))
     testImplementation("junit:junit:4.13.2")
+    testImplementation("io.mockk:mockk-android:1.13.7")
+    testImplementation("io.mockk:mockk-agent:1.13.7")
     testImplementation(kotlin("test"))
     androidTestImplementation("androidx.test.ext:junit:1.1.5")
     androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")

diff --git a/basil/src/main/java/com/jocmp/basil/Account.kt b/basil/src/main/java/com/jocmp/basil/Account.kt
@@ -7,6 +7,7 @@ import com.jocmp.feedfinder.FeedFinder
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import java.net.URI
+import java.net.URL
 import java.util.UUID
 
 data class Account(
@@ -49,15 +50,17 @@ data class Account(
 
         val feed = Feed(
             id = UUID.randomUUID().toString(),
-            name = entry.name,
-            feedURL = found.feedURL.toString()
+            name = entryNameOrDefault(entry, found.name),
+            feedURL = found.feedURL.toString(),
+            siteURL = entrySiteURL(found.siteURL)
         )
 
         if (entry.folderTitles.isEmpty()) {
             feeds.add(feed)
         } else {
             entry.folderTitles.forEach { folderTitle ->
-                val folder = folders.find { folder -> folder.title == folderTitle } ?: Folder(title = folderTitle)
+                val folder = folders.find { folder -> folder.title == folderTitle }
+                    ?: Folder(title = folderTitle)
 
                 folder.feeds.add(feed)
 
@@ -74,6 +77,18 @@ data class Account(
         return feed
     }
 
+    private fun entrySiteURL(url: URL?): String {
+        return url?.toString() ?: ""
+    }
+
+    private fun entryNameOrDefault(entry: FeedFormEntry, feedName: String): String {
+        if (entry.name.isBlank()) {
+            return feedName
+        }
+
+        return entry.name
+    }
+
     private suspend fun saveOPMLFile() = withContext(Dispatchers.IO) {
         opmlFile.save()
     }
@@ -95,7 +110,7 @@ fun Account.asOPML(): String {
         opml += feed.asOPML(indentLevel = 2)
     }
 
-    folders.sortedBy { it.title } .forEach { folder ->
+    folders.sortedBy { it.title }.forEach { folder ->
         opml += folder.asOPML(indentLevel = 2)
     }
 

diff --git a/basil/src/main/java/com/jocmp/basil/Feed.kt b/basil/src/main/java/com/jocmp/basil/Feed.kt
@@ -6,7 +6,7 @@ data class Feed(
     val id: String,
     val name: String,
     val feedURL: String,
-    val homepageURL: String = ""
+    val siteURL: String = ""
 ) {
     override fun equals(other: Any?): Boolean {
         if (other is Feed) {
@@ -21,6 +21,6 @@ data class Feed(
 }
 
 fun Feed.asOPML(indentLevel: Int): String {
-    val opml = "<outline text=\"${name}\" title=\"${name}\" description=\"\" type=\"rss\" version=\"RSS\" htmlUrl=\"\" xmlUrl=\"${feedURL}\"/>\n"
+    val opml = "<outline text=\"${name}\" title=\"${name}\" description=\"\" type=\"rss\" version=\"RSS\" htmlUrl=\"${siteURL}\" xmlUrl=\"${feedURL}\"/>\n"
     return opml.prepending(tabCount = indentLevel)
 }
diff --git a/basil/src/test/java/com/jocmp/basil/AccountTest.kt b/basil/src/test/java/com/jocmp/basil/AccountTest.kt
@@ -1,10 +1,13 @@
 package com.jocmp.basil
 
+import com.jocmp.feedfinder.FeedFinder
+import io.mockk.coEvery
+import io.mockk.mockkConstructor
 import kotlinx.coroutines.runBlocking
+import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 import org.junit.rules.TemporaryFolder
-import java.util.UUID
 import kotlin.test.assertContains
 import kotlin.test.assertEquals
 
@@ -13,6 +16,15 @@ class AccountTest {
     @Rule
     val folder = TemporaryFolder()
 
+    @Before
+    fun setup() {
+        mockkConstructor(FeedFinder::class)
+
+        coEvery {
+            anyConstructed<FeedFinder>().find()
+        } returns FeedFinder.Result.Success(listOf(FakeParserFeed()))
+    }
+
     @Test
     fun opmlFile_endsWithSubscriptions() {
         val accountPath = folder.newFile().toURI()
@@ -50,7 +62,7 @@ class AccountTest {
         val accountPath = folder.newFile().toURI()
         val account = Account(id = "777", path = accountPath)
         val entry = FeedFormEntry(
-            url = "https://www.theverge.com/rss/index.xml",
+            url = "https://theverge.com/rss/index.xml",
             name = "The Verge",
             folderTitles = listOf(),
         )
@@ -70,7 +82,7 @@ class AccountTest {
         val accountPath = folder.newFile().toURI()
         val account = Account(id = "777", path = accountPath)
         val entry = FeedFormEntry(
-            url = "https://www.theverge.com/rss/index.xml",
+            url = "https://theverge.com/rss/index.xml",
             name = "The Verge",
             folderTitles = listOf("Tech"),
         )
@@ -92,7 +104,7 @@ class AccountTest {
         runBlocking { account.addFolder("Tech") }
 
         val entry = FeedFormEntry(
-            url = "https://www.theverge.com/rss/index.xml",
+            url = "https://theverge.com/rss/index.xml",
             name = "The Verge",
             folderTitles = listOf("Tech"),
         )
@@ -114,7 +126,7 @@ class AccountTest {
         runBlocking { account.addFolder("Tech") }
 
         val entry = FeedFormEntry(
-            url = "https://www.theverge.com/rss/index.xml",
+            url = "https://theverge.com/rss/index.xml",
             name = "The Verge",
             folderTitles = listOf("Tech", "Culture"),
         )

diff --git a/basil/src/test/java/com/jocmp/basil/FakeParserFeed.kt b/basil/src/test/java/com/jocmp/basil/FakeParserFeed.kt
@@ -0,0 +1,13 @@
+package com.jocmp.basil
+
+import com.jocmp.feedfinder.parser.Feed
+import java.net.URL
+
+class FakeParserFeed(
+    override val name: String = "The Verge - All Posts",
+    override val feedURL: URL = URL("https://theverge.com/rss/index.xml"),
+    override val siteURL: URL? = null,
+    private val valid: Boolean = true
+) : Feed {
+    override fun isValid() = valid
+}
diff --git a/feedfinder/src/main/java/com/jocmp/feedfinder/FeedFinder.kt b/feedfinder/src/main/java/com/jocmp/feedfinder/FeedFinder.kt
@@ -22,14 +22,10 @@ import java.net.URL
 // HTML takes response body
 
 class FeedFinder internal constructor(
-    val url: String,
+    private val url: String,
     private val request: Request = DefaultRequest()
 ) {
-    // Convert URL to HTTPS if missing
-    // 1. Download the request using a Java HTTP connection
-    // 2. If the response is an XML Feed itself, return
-    // 3. If the response is HTML and th
-    internal suspend fun find(): Result = withContext(Dispatchers.IO) {
+    suspend fun find(): Result = withContext(Dispatchers.IO) {
         try {
             val parsedURL = URI(url.withProtocol).toURL()
             val response = request.fetch(url = parsedURL)
@@ -52,6 +48,7 @@ class FeedFinder internal constructor(
 
     private fun sources(response: Response): List<Source> {
         return listOf(
+            XMLSource(response),
             MetaLinkSource(response = response, request = request),
         )
     }

diff --git a/feedfinder/src/main/java/com/jocmp/feedfinder/Response.kt b/feedfinder/src/main/java/com/jocmp/feedfinder/Response.kt
@@ -1,9 +1,6 @@
 package com.jocmp.feedfinder
 
-import com.jocmp.feedfinder.parser.FakeFeed
-import com.jocmp.feedfinder.parser.Feed
 import com.jocmp.feedfinder.parser.Parser
-import com.jocmp.feedfinder.parser.XMLFeed
 import java.net.URL
 
 internal class Response(val url: URL, val body: String) {

diff --git a/feedfinder/src/main/java/com/jocmp/feedfinder/parser/FakeFeed.kt b/feedfinder/src/main/java/com/jocmp/feedfinder/parser/FakeFeed.kt
diff --git a/feedfinder/src/main/java/com/jocmp/feedfinder/parser/Feed.kt b/feedfinder/src/main/java/com/jocmp/feedfinder/parser/Feed.kt
@@ -5,5 +5,9 @@ import java.net.URL
 interface Feed {
     fun isValid(): Boolean
 
+    val name: String
+
     val feedURL: URL
+
+    val siteURL: URL?
 }
diff --git a/feedfinder/src/main/java/com/jocmp/feedfinder/parser/XMLFeed.kt b/feedfinder/src/main/java/com/jocmp/feedfinder/parser/XMLFeed.kt
@@ -16,6 +16,14 @@ internal class XMLFeed(
                 hasEntries()
     }
 
+    override val name: String
+        get() = channel!!.title!!
+
+    override val siteURL: URL?
+        get() = channel?.link?.let {
+            URL(it)
+        }
+
     private fun hasEntries(): Boolean {
         return channel != null &&
                 channel.items.isNotEmpty()

diff --git a/feedfinder/src/main/java/com/jocmp/feedfinder/sources/BodyLinkSource.kt b/feedfinder/src/main/java/com/jocmp/feedfinder/sources/BodyLinkSource.kt
diff --git a/feedfinder/src/main/java/com/jocmp/feedfinder/sources/Guess.kt b/feedfinder/src/main/java/com/jocmp/feedfinder/sources/Guess.kt
diff --git a/feedfinder/src/test/java/com/jocmp/feedfinder/FeedFinderTest.kt b/feedfinder/src/test/java/com/jocmp/feedfinder/FeedFinderTest.kt
diff --git a/feedfinder/src/test/java/com/jocmp/feedfinder/sources/BodyLinkTest.kt b/feedfinder/src/test/java/com/jocmp/feedfinder/sources/BodyLinkTest.kt
diff --git a/feedfinder/src/test/java/com/jocmp/feedfinder/sources/XMLSourceTest.kt b/feedfinder/src/test/java/com/jocmp/feedfinder/sources/XMLSourceTest.kt
@@ -8,6 +8,7 @@ import java.net.URL
 import kotlin.math.exp
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
+import kotlin.test.assertTrue
 
 class XMLSourceTest {
     @Test