readme updates

.gitignore

@@ -1,6 +1,8 @@
 .idea
 venv
 
+extension/build
+
 __pycache__
 *.py[cod]
 

README.md

@@ -1,2 +1,24 @@
-# Unshorten
+# Unshortener
 Firefox Extension and API server for revealing links behind shortened URLs.
+
+**Supported sites**:
+- t.co
+- tinyurl.com
+
+
+## Usage
+In order to deal with CORS, Unshorten must send links to a resolver API. 
+
+```shell
+cd server
+make build
+docker -d --name unshortener -p 8000:8000 unshortener-api
+```
+
+Build the extension and import into Firefox. Right click on a link and choose 
+"Unshorten Link". The result will be copied to the clipboard.
+
+```shell
+cd extension
+make zip
+```

extension/Makefile

@@ -6,9 +6,11 @@ VERSION := $(shell jq -r '.version' $(SRC_DIR)/manifest.json)
 ZIP_FILE := $(EXTENSION_NAME)-$(VERSION).zip
 
 all: zip
+
 zip:
 	@mkdir -p $(BUILD_DIR)
 	zip -r $(BUILD_DIR)/$(ZIP_FILE) $(SRC_DIR) -x "*.DS_Store"
+
 clean:
 	rm -rf $(BUILD_DIR)
 

extension/README.md

@@ -1,2 +1,14 @@
-# Unshorten
-A Firefox extension to unshorten links from sites like Twitter.
+# Unshortener Extension
+A Firefox extension to reveal links behind URL shorteners like Twitter and TinyURL.
+
+**Supported sites:**
+- t.co
+- tinyurl.com
+
+## Usage
+Build the extension and install it in Firefox. Right-clicking links will reveal a new
+"Unshorten link" option which will resolve the link and copy it to the clipboard.
+
+```shell
+make zip
+```

extension/src/background.js

@@ -1,5 +1,6 @@
 const shortenerDomains = [
-    "t.co"
+    "t.co",
+    "tinyurl.com"
 ];
 
 browser.contextMenus.create({
@@ -28,16 +29,17 @@ function getDomainFromUrl(linkUrl) {
 }
 
 function unshortenUrl(linkUrl) {
-    console.log(linkUrl);
-
     fetch("http://localhost:8000/?url=" + linkUrl)
     .then(res => {
         if (!res.ok) {
-            console.log("error fetching result");
+            console.log("Couldn't unshorten URL: " + res.statusText);
         }
         return res.json();
     })
-    .then(data => {
-        console.log(data);
-    });
+    .then(unshortenedUrl => {
+        console.log("unshortened: " + unshortenedUrl)
+        navigator.clipboard.writeText(unshortenedUrl)
+        .catch(err => console.error("Couldn't copy to clipboard: ", err));
+    })
+    .catch(err => {console.error("Couldn't contact server:", err)});
 }

extension/src/manifest.json

@@ -1,7 +1,7 @@
 {
   "manifest_version": 2,
-  "name": "Unshorten",
-  "version": "0.1",
+  "name": "Unshortener",
+  "version": "0.3",
 
   "description": "Unshorten links from Twitter.",
 
@@ -18,6 +18,7 @@
 
   "permissions": [
     "activeTab",
+    "clipboardWrite",
     "contextMenus"
   ]
 }

server/Makefile

@@ -0,0 +1,15 @@
+IMAGE_NAME=unshortener-api
+CONTAINER_NAME=unshortener
+CONTAINER_PORT=8000
+
+build:
+	docker build -t $(IMAGE_NAME) .
+run:
+	docker run --name $(CONTAINER_NAME) -d -p $(CONTAINER_PORT):8000 $(IMAGE_NAME)
+stop:
+	docker stop $(CONTAINER_NAME)
+clean:
+	docker rm $(CONTAINER_NAME)
+
+clean-image:
+	docker rmi $(IMAGE_NAME)

server/README.md

@@ -1,2 +1,14 @@
-# Unshorten Server
-Simple FastAPI app to unshorten URLs.
+# Unshortener Resolver API
+Simple FastAPI app to resolve links behind shortened URLs.
+
+**Supported sites**:
+- t.co
+- tinyurl.com
+
+## Usage
+Build and run the Docker container:
+
+```shell
+make build
+docker -d --name unshortener -p 8000:8000 unshortener-api
+```

server/src/main.py

@@ -3,12 +3,15 @@ from typing import Optional
 from urllib.parse import urlparse
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
-from unshorteners import unshorten_twitter
+from unshorteners import unshorten_twitter, unshorten_tinyurl
 
-UNSHORTENERS = {
-    't.co': unshorten_twitter
+UNSHORTEN = {
+    't.co': unshorten_twitter,
+    'tinyurl.com': unshorten_tinyurl
 }
 
+CACHE = {}
+
 app = FastAPI(docs_url=None, redoc_url=None)
 app.add_middleware(
     CORSMiddleware,
@@ -26,7 +29,15 @@ async def receive_url(url: Optional[str] = None):
         return {"error": "no url provided"}
 
     domain = urlparse(url).netloc
-    if domain not in UNSHORTENERS:
+    if domain not in UNSHORTEN:
         return {"error": f"cannot unshorten {domain}"}
 
-    return UNSHORTENERS[domain](url)
+    if url in CACHE:
+        return CACHE[url]
+
+    result = UNSHORTEN[domain](url)
+    if result:
+        CACHE[url] = result
+        return result
+
+    return {"error": "server error"}

server/src/unshorteners.py

@@ -1,12 +1,27 @@
 """Unshortening functions"""
 import re
+from typing import Optional
 import requests
 
 
-def unshorten_twitter(url):
+def unshorten_tinyurl(url: str) -> Optional[str]:
+    """Retrieve the actual URL behind a TinyURL."""
+    try:
+        response = requests.get(url, timeout=4, allow_redirects=False)
+    except requests.RequestException:
+        return None
+
+    if response.status_code == 301:
+        return response.headers.get("location", None)
+
+    return None
+
+
+def unshorten_twitter(url: str) -> Optional[str]:
     """Retrieve the actual URL behind a Twitter URL."""
     pattern = re.compile(r"<title>(.*?)<\/title>")
 
+    try:
         response = requests.get(
             url=url,
             headers={
@@ -14,6 +29,8 @@ def unshorten_twitter(url):
             },
             timeout=4
         )
+    except requests.RequestException:
+        return None
 
     match = pattern.search(response.text)
     if match: