moved server stuff to its own class

improved exception throw
created general connection function for cleaner api requests
improved documentation

Author: FranzTutao

README.md

@@ -1,7 +1,7 @@
 ### Notes:
 
 - Brings DeArrow to RSS
-- Works with invidious and youtube feeds
+- Works with invidious and YouTube feeds
 - not tested in actual feed reader
 
 ### How?
@@ -14,3 +14,5 @@
 
 - write tests
 - create frontend?
+- add insecure mode where you don't request the image and check for a valid return but just pass the url without
+  checking

src/main/java/de/mueller/franz/DeArrow.java

@@ -5,45 +5,38 @@
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
-import java.net.HttpURLConnection;
-import java.net.URL;
-import java.net.URLEncoder;
+import java.net.*;
+import java.nio.charset.StandardCharsets;
 import java.util.List;
 
-// TODO Javadoc
-
+/**
+ * class responsible for all things with the DeArrow api and data formatting
+ */
 public class DeArrow {
 
 	/**
 	 * get DeArrow information
 	 *
-	 * @param videoID
+	 * @param videoID id of the individual video
 	 * @return response as String
 	 * @throws IOException
 	 */
 	public String getInitialInformation(String videoID) throws IOException {
 		String apiUrl = "https://sponsor.ajay.app/api/branding";
 
 		// Encode the videoID parameter
-		String encodedVideoID = URLEncoder.encode(videoID, "UTF-8");
+		String encodedVideoID = URLEncoder.encode(videoID, StandardCharsets.UTF_8);
 
 		// Construct the URL with query parameters
 		String queryParameters = String.format("?videoID=%s", encodedVideoID);
 		String completeUrl = apiUrl + queryParameters;
 
-		URL url = new URL(completeUrl);
-		HttpURLConnection con = (HttpURLConnection) url.openConnection();
+		// connect to api and return response if successful
+		HttpURLConnection con = initializeConnection(completeUrl);
+		if (con == null) return null;
 
-		// TODO move to Config / separate Object
-		con.setRequestMethod("GET");
-		con.setRequestProperty("Content-Type", "application/json");
-		con.setRequestProperty("Accept", "application/json");
-		// handle everything that's not 200
-		if (con.getResponseCode() != HttpURLConnection.HTTP_OK) {
-			return null;
-		}
 		try (BufferedReader br = new BufferedReader(
-				new InputStreamReader(con.getInputStream(), "utf-8"))) {
+				new InputStreamReader(con.getInputStream(), StandardCharsets.UTF_8))) {
 			StringBuilder response = new StringBuilder();
 			String responseLine;
 			while ((responseLine = br.readLine()) != null) {
@@ -57,25 +50,17 @@ public String getInitialInformation(String videoID) throws IOException {
 	 * helper class representing the extracted information
 	 */
 	public static class ProcessedInformation {
-		private String title;
-		private String url;
+		private final String title;
+		private final String url;
 
 		public String getTitle() {
 			return title;
 		}
 
-		public void setTitle(String title) {
-			this.title = title;
-		}
-
 		public String getUrl() {
 			return url;
 		}
 
-		public void setUrl(String url) {
-			this.url = url;
-		}
-
 		public ProcessedInformation(String title, String url) {
 			this.title = title;
 			this.url = url;
@@ -85,7 +70,7 @@ public ProcessedInformation(String title, String url) {
 	/**
 	 * post process information from DeArrow api
 	 *
-	 * @param jsonResponse
+	 * @param jsonResponse api response from DeArrow
 	 * @return title and url as ProcessedInformation (null if not existing)
 	 */
 	public ProcessedInformation processInformation(String videoID, String jsonResponse) throws IOException {
@@ -125,11 +110,12 @@ public ProcessedInformation processInformation(String videoID, String jsonRespon
 		}
 		return new ProcessedInformation(title, url);
 	}
+
 	/**
 	 * fetches thumbnail image
 	 *
-	 * @param videoID
-	 * @param number
+	 * @param videoID id of video in question
+	 * @param number Thumbnail timestamp (DeArrow internal number)
 	 * @return image url or null
 	 * @throws IOException
 	 */
@@ -138,31 +124,32 @@ public String getImageInformation(String videoID, double number) throws IOExcept
 		String apiUrl = "https://dearrow-thumb.ajay.app/api/v1/getThumbnail";
 
 		// Encode the videoID parameter
-		String encodedVideoID = URLEncoder.encode(videoID, "UTF-8");
+		String encodedVideoID = URLEncoder.encode(videoID, StandardCharsets.UTF_8);
 
 		// Construct the URL with query parameters
 		String queryParameters = String.format("?videoID=%s&time=%s", encodedVideoID, number);
 		String completeUrl = apiUrl + queryParameters;
-
+		// get api response and return complete url if successful
+		HttpURLConnection con = initializeConnection(completeUrl);
+		if (con == null) return null;
+		else return completeUrl;
+	}
+	/**
+	 * create GET connection to provided url with json as request/ response
+	 * @param completeUrl url you want to connect to (please encode UTF-8)
+	 * @return connection ready to go or null if connection is not ok
+	 * @throws IOException
+	 */
+	private HttpURLConnection initializeConnection(String completeUrl) throws IOException {
 		URL url = new URL(completeUrl);
 		HttpURLConnection con = (HttpURLConnection) url.openConnection();
 		con.setRequestMethod("GET");
 		con.setRequestProperty("Content-Type", "application/json");
 		con.setRequestProperty("Accept", "application/json");
-
-		int responseCode = con.getResponseCode();
-		if (responseCode == HttpURLConnection.HTTP_OK) {
-			return completeUrl;
-		} else return null;
-
-		// no need for receiving and process the image
-		/*try (BufferedReader br = new BufferedReader(
-				new InputStreamReader(con.getInputStream(), "utf-8"))) {
-			StringBuilder response = new StringBuilder();
-			String responseLine;
-			while ((responseLine = br.readLine()) != null) {
-				response.append(responseLine.trim());
-			}
-		}*/
+		// handle everything that's not 200
+		if (con.getResponseCode() != HttpURLConnection.HTTP_OK) {
+			return null;
+		}
+		return con;
 	}
 }

src/main/java/de/mueller/franz/HandleRssFeed.java

@@ -19,8 +19,9 @@
 import java.net.URL;
 import java.util.List;
 
-// TODO Javadoc
-
+/**
+ * class responsible to do everything RSS feed related
+ */
 public class HandleRssFeed {
 	DeArrow deArrow = new DeArrow();
 
@@ -31,16 +32,14 @@ public class HandleRssFeed {
 	 * @return SyndFeed
 	 * @throws IOException
 	 * @throws FeedException
+	 * @throws FeedException
 	 */
 	public SyndFeed readFeed(String feedUrl) {
 		try {
 			URL url = new URI(feedUrl).toURL();
 			return new SyndFeedInput().build(new XmlReader(url));
 		} catch (Exception e) {
-			e.printStackTrace();
-			System.out.println("ERROR: " + e.getMessage());
-			// TODO throw new Exception("Wrong feed ...: " + e.stackTrace());
-			throw new IllegalArgumentException("Wrong feed provided. Please provide a valid YouTube RSS feed");
+			throw new IllegalArgumentException("Wrong feed provided. Please provide a valid YouTube RSS feed: " + e.getMessage());
 		}
 	}
 
@@ -76,7 +75,7 @@ public void writeFeedToFile(SyndFeed feed) throws IOException, FeedException {
 	/**
 	 * read feed from file
 	 *
-	 * @param fileName
+	 * @param fileName name of the file or path if not in root folder
 	 * @return SyndFeed
 	 * @throws IOException
 	 * @throws FeedException
@@ -85,16 +84,16 @@ public SyndFeed readFeedFromFile(String fileName) throws IOException, FeedExcept
 		return this.readFeed(new FileReader(fileName));
 	}
 
-	public SyndFeed readFeed(Reader content) throws IOException, FeedException {
+	public SyndFeed readFeed(Reader content) throws FeedException {
 		SyndFeedInput input = new SyndFeedInput();
 		return input.build(content);
 	}
 
 	/**
 	 * replace url for media:thumbnail element with jdom2
 	 *
-	 * @param entry
-	 * @param newUrl
+	 * @param entry  entry which is changed
+	 * @param newUrl image url you want to change it to
 	 */
 	public void setMediaThumbnailUrl(SyndEntry entry, String newUrl) {
 		// yt and invidious
@@ -123,7 +122,7 @@ public void setMediaThumbnailUrl(SyndEntry entry, String newUrl) {
 	/**
 	 * get url for media:thumbnail element with jdom2
 	 *
-	 * @param entry
+	 * @param entry entry which is edited
 	 * @return url from media:thumbnail
 	 */
 	public String getMediaThumbnailUrl(SyndEntry entry) {
@@ -142,23 +141,22 @@ public String getMediaThumbnailUrl(SyndEntry entry) {
 	/**
 	 * create the final feed from url
 	 *
-	 * @param rssFeedURL
+	 * @param rssFeedURL url to the YouTube/ Invidious RSS feed you want to DeArrow
 	 * @throws FeedException
 	 * @throws IOException
 	 */
 	public String createModifiedFeed(String rssFeedURL) throws FeedException, IOException {
 		SyndFeed feed = readFeed(rssFeedURL);
 		for (SyndEntry entry : feed.getEntries()) {
-			// get vidID from entry
-			// TODO Example: url.../...=...:... ->
-			String videoId = entry.getUri().substring(entry.getUri().lastIndexOf('=') + 1); // TODO why?
-			videoId = videoId.substring(videoId.lastIndexOf(":") + 1); // TODO why?
-			// get info
+			// get vidID from entry by formatting the uri ("yt:video:7DKv5H5Frt0" --> "7DKv5H5Frt0")
+			String videoId = entry.getUri();
+			videoId = videoId.substring(videoId.lastIndexOf(":") + 1);
+			// get information (title and thumbnail url)
 			DeArrow.ProcessedInformation processedInformation = deArrow.processInformation(videoId, deArrow.getInitialInformation(videoId));
 			// change rss feed
 			editEntry(entry, processedInformation.getTitle(), processedInformation.getUrl());
 		}
-		// create file
+		// create file if wanted
 		// writeFeedToFile(feed);
 
 		// return as String

src/main/java/de/mueller/franz/Main.java

@@ -1,65 +1,16 @@
 package de.mueller.franz;
 
-import spark.Spark;
-
-import static spark.Spark.*;
-
 public class Main {
-	// TODO main -> Server
 	public static void main(String[] args) {
-		// DeArrow: https://wiki.sponsor.ajay.app/w/API_Docs/DeArrow
-		// ROME: https://rometools.github.io/rome/
-		// Spark: https://sparkjava.com/
-
-		// ToDo make dynamic and exposed to web; speed up image request; write tests
-		HandleRssFeed handleRssFeed = new HandleRssFeed();
-		// Tom Scott
-		// String rssFeedURL = "https://www.youtube.com/feeds/videos.xml?channel_id=UCBa659QWEk1AI4Tg--mrJ2A";
-		String rssFeedURL = "https://yewtu.be/feed/channel/UCBa659QWEk1AI4Tg--mrJ2A";
-		// Franz3
-		// String rssFeedURL = "https://yewtu.be/feed/channel/UCBa659QWEk1AI4Tg--mrJ2A";
-
-		Spark.webSocketIdleTimeoutMillis((60 * 1000) * 5);
-		// initialize web server for http://localhost:4567/DeArrow/
-		get("/DeArrow/*", (request, response) -> {
-			// get the inputted YouTube/ Invidious url
-			String feedUrl = request.raw().getRequestURL().toString();
-			String queryString = request.raw().getQueryString();
-			if (queryString != null) {
-				feedUrl += "?" + queryString;
-			}
-			feedUrl = feedUrl.replace("http://localhost:4567/DeArrow/", "");
-			feedUrl = feedUrl.replace("http://localhost:4567/dearrow/", "");
-			// respond
-			response.type("text/xml");
-			return handleRssFeed.createModifiedFeed(feedUrl);
+		Server server = new Server();
+		// Test URLs:
+		// Tom Scott:
+		// https://www.youtube.com/feeds/videos.xml?channel_id=UCBa659QWEk1AI4Tg--mrJ2A
+		// https://yewtu.be/feed/channel/UCBa659QWEk1AI4Tg--mrJ2A
+		// Franz3:
+		// https://yewtu.be/feed/channel/UCBa659QWEk1AI4Tg--mrJ2A
 
-		});
-		// handle internal error (500)
-		internalServerError((request, response) -> {
-			response.type("text/html");
-			return "<html>" +
-					"<body>" +
-					"<img src=\"https://http.cat/500\" alt=\"https://http.cat/500\" width=\"747\" height=\"598\">" +
-					"</body>" +
-					"</html>";
-		});
-		// handle wrong address (404)
-		notFound((request, response) -> {
-			response.type("text/html");
-			return "<html>" +
-					"<body>" +
-					"<img src=\"https://http.cat/404\" alt=\"https://http.cat/404\" width=\"747\" height=\"598\">" +
-					"</body>" +
-					"</html>";
-		});
-		// handle IllegalArgumentException (thrown when url is wrong)
-		get("/wrong_url", (request, response) -> {
-			response.type("text/html");
-			return "Please provide a valid feed url";
-		});
-		exception(IllegalArgumentException.class, (exception, request, response) -> {
-			response.redirect("/wrong_url");
-		});
+		// start server
+		server.startWebserver();
 	}
 }