fix(frontend): Reference @AaronBenDaniel's code for Story ID fetching from Part IDs

* add URI encoding to credentials

* chore(api): Comment on FastAPI's automatic URL Decode

---------

Co-authored-by: TheOnlyWayUp <hi@towu.dev>

.gitignore

@@ -1,5 +1,6 @@
 __pycache__
 venv
+*epub
 data
 *ipynb
 build

.vscode/settings.json

@@ -1,9 +1,3 @@
 {
-    "python.analysis.autoImportCompletions": true,
-    "vscord.app.privacyMode.enable": false,
-    "python.testing.pytestArgs": [
-        "src"
-    ],
-    "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
+    "python.analysis.autoImportCompletions": true
 }

README.md

@@ -9,11 +9,12 @@ Stars ⭐ are appreciated. Thanks!
 
 ## Features
 - ⚡ Lightweight Frontend and Minimal Javascript.
+- 🪙 Supports Authentication (Download paid stories from your account!)
 - 🌐 API Support (Visit the `/docs` path on your instance for more.)
-- 🐇 Fast Generation, Basic Ratelimit Handling.
+- 🐇 Fast Generation, Ratelimit Handling.
 - 🐳 Docker Support
 - 🏷️ Generated EPUB File includes Metadata. (Dublin Core Spec)
-- 📖 Plays well with E-Readers. (Kindle Support if KOReader present)
+- 📖 Plays well with E-Readers. (Kindle Support if KOReader present, ReMarkable, KOBO, ...)
 - 💻 Easily Hackable. Extend with ease.
 
 
@@ -31,5 +32,5 @@ My thanks to [aerkalov/ebooklib](https://github.com/aerkalov/ebooklib) for a fas
 ---
 
 <div align="center">
-    <p>TheOnlyWayUp © 2023</p>
+    <p>TheOnlyWayUp © 2024</p>
 </div>

src/api/src/create_book.py

@@ -174,7 +174,7 @@ async def add_chapters(
 ):
     chapters = []
 
-    for part in data["parts"]:
+    for cidx, part in enumerate(data["parts"]):
         content = await fetch_part_content(part["id"], cookies=cookies)
         title = part["title"]
         clean_title = slugify(title)
@@ -182,7 +182,7 @@ async def add_chapters(
         # Thanks https://eu17.proxysite.com/process.php?d=5VyWYcoQl%2BVF0BYOuOavtvjOloFUZz2BJ%2Fepiusk6Nz7PV%2B9i8rs7cFviGftrBNll%2B0a3qO7UiDkTt4qwCa0fDES&b=1
         chapter = epub.EpubHtml(
             title=title,
-            file_name=f"{clean_title}.xhtml",
+            file_name=f"{cidx}.xhtml",  # Used to be clean_title.xhtml, but that broke Arabic support as slugify turns arabic strings into '', leading to multiple files with the same name, breaking those chapters.
             lang=data["language"]["name"],
         )
 
@@ -200,11 +200,11 @@ async def add_chapters(
                         img = epub.EpubImage(
                             media_type="image/jpeg",
                             content=await response.read(),
-                            file_name=f"static/{clean_title}/{idx}.jpeg",
+                            file_name=f"static/{cidx}/{idx}.jpeg",
                         )
                         book.add_item(img)
                         content = content.replace(
-                            str(image), f'<img src="static/{clean_title}/{idx}.jpeg"/>'
+                            str(image), f'<img src="static/{cidx}/{idx}.jpeg"/>'
                         )
 
         chapter.set_content(f"<h1>{title}</h1>" + content)

src/api/src/main.py

@@ -34,10 +34,11 @@ async def download_book(
     if username and not password or password and not username:
         return HTMLResponse(
             status_code=422,
-            content='Include both the username _and_ password, or neither. Support is available on the <a href="https://discord.gg/P9RHC4KCwd" target="_blank">Discord</a>',
+            content='Include both the username <u>and</u> password, or neither. Support is available on the <a href="https://discord.gg/P9RHC4KCwd" target="_blank">Discord</a>',
         )
 
     if username and password:
+        # username and password are URL-Encoded by the frontend. FastAPI automatically decodes them.
         try:
             cookies = await wp_get_cookies(username=username, password=password)
         except ValueError:

src/api/src/tests/test_story.py

@@ -1,31 +0,0 @@
-from .. import create_book
-
-
-import pytest
-
-STORY_ID = 372219540
-
-
-@pytest.mark.asyncio
-async def test_retrieve_story():
-    story_data = await create_book.retrieve_story(STORY_ID)
-    story_data.pop("modifyDate", None)  # Subject to change
-
-    response = {
-        "id": "372219540",
-        "title": "WPD Test",
-        "createDate": "2024-07-02T15:29:13Z",
-        # "modifyDate": "2024-07-02T15:41:26Z",
-        "language": {"name": "English"},
-        "user": {"username": "KindaAssNgl"},
-        "description": "Testing story for WPD.",
-        "cover": r"https:\/\/img.wattpad.com\/cover\/372219540-256-k908955.jpg",
-        "completed": False,
-        "tags": ["testing", "towu", "wpd"],
-        "mature": False,
-        "url": r"https:\/\/www.wattpad.com\/story\/372219540-wpd-test",
-        "parts": [{"id": 1458516761, "title": "Ganesh"}],
-        "isPaywalled": False,
-    }
-
-    assert story_data == response

src/frontend/src/routes/+page.svelte

@@ -6,21 +6,42 @@
     username: "",
     password: "",
   };
-
   let after_download_page = false;
   let url = "";
 
+  let raw_story_id = "";
+  let is_part_id = false;
+
   let button_disabled = false;
   $: button_disabled =
     !story_id ||
     (is_paid_story && !(credentials.username && credentials.password));
 
-  $: url =
-    `/download/${story_id}?om=1` +
-    (download_images ? "&download_images=true" : "") +
-    (is_paid_story
-      ? `&username=${credentials.username}&password=${credentials.password}`
-      : "");
+  $: {
+    is_part_id = false;
+    if (raw_story_id.includes("wattpad.com")) {
+      // Originally, I was going to call the Wattpad API (wattpad.com/api/v3/stories/${story_id}), but Wattpad kept blocking those requests. I suspect it has something to do with the Origin header, I wasn't able to remove it.
+      // In the future, if this is considered, it would be cool if we could derive the Story ID from a pasted Part URL. Refer to @AaronBenDaniel's https://github.com/AaronBenDaniel/WattpadDownloader/blob/49b29b245188149f2d24c0b1c59e4c7f90f289a9/src/api/src/create_book.py#L156 (https://www.wattpad.com/api/v3/story_parts/{part_id}?fields=url).
+
+      if (raw_story_id.includes("/story/")) {
+        // https://wattpad.com/story/237369078-wattpad-books-presents
+        story_id = raw_story_id.split("/story/")[1].split("-")[0];
+        raw_story_id = story_id;
+      } else if (raw_story_id.includes("/stories/")) {
+        // https://www.wattpad.com/api/v3/stories/237369078?fields=...
+        story_id = raw_story_id.split("/stories/")[1].split("?")[0];
+        raw_story_id = story_id;
+      } else {
+        // https://www.wattpad.com/939051741-wattpad-books-presents-part-name
+        is_part_id = true;
+        raw_story_id = "";
+        story_id = "";
+      }
+    } else {
+      story_id = parseInt(raw_story_id) || ""; // parseInt returns NaN for undefined values.
+      raw_story_id = story_id;
+    }
+  }
 </script>
 
 <div>
@@ -39,27 +60,42 @@
             Download your favourite books with a single click!
           </p>
           <ul class="pt-4 list list-inside text-xl">
-            <li>06/24 - 🎉 Image Downloading!</li>
+            <!-- TODO: 'max-lg: hidden' to hide on screen sizes smaller than lg. I'll do this when I figure out how to make this show up _below_ the card on smaller screen sizes. -->
+            <li>07/24 - 🔡 RTL Language support! (Arabic, etc.)</li>
+            <li>06/24 - 🔑 Authenticated Downloads!</li>
+            <li>06/24 - 🖼️ Image Downloading!</li>
           </ul>
         </div>
         <div class="card shrink-0 w-full max-w-sm shadow-2xl bg-base-100">
           <form class="card-body">
             <div class="form-control">
               <input
-                type="number"
+                type="text"
                 placeholder="Story ID"
                 class="input input-bordered"
-                bind:value={story_id}
+                class:input-warning={is_part_id}
+                bind:value={raw_story_id}
                 required
                 name="story_id"
               />
               <label class="label" for="story_id">
+                {#if is_part_id}
+                  <p class=" text-red-500">
+                    Refer to (<button
+                      class="link font-semibold"
+                      onclick="StoryIDTutorialModal.showModal()"
+                      data-umami-event="Part StoryIDTutorialModal Open"
+                      >How to get a Story ID</button
+                    >).
+                  </p>
+                {:else}
                   <button
                     class="label-text link font-semibold"
                     onclick="StoryIDTutorialModal.showModal()"
                     data-umami-event="StoryIDTutorialModal Open"
                     >How to get a Story ID</button
                   >
+                {/if}
               </label>
               <label class="cursor-pointer label">
                 <span class="label-text"
@@ -167,13 +203,13 @@
         >✕</button
       >
     </form>
-    <h3 class="font-bold text-lg">Downloading a Story</h3>
-    <ol class="list list-disc list-inside py-4 space-y-2">
+    <h3 class="font-bold text-lg">Retrieving a Story ID</h3>
+    <ol class="list list-disc list-inside py-4 space-y-4">
       <li>
-        Open the Story URL (For example, <span
-          class="font-mono bg-slate-100 p-1"
+        Open the Story URL, this page includes the story description and tags.
+        (For example, <span class="font-mono bg-slate-100 p-1"
           >wattpad.com/story/237369078-wattpad-books-presents</span
-        >)
+        >).
       </li>
       <li>
         Copy the numbers after the <span class="font-mono bg-slate-100 p-1"