Merge pull request #13 from YuWei-CH/blueground

Blueground

Author: YuWei-CH

README.md

@@ -3,7 +3,7 @@ EasyRelocate is an open-source, non-commercial decision-support tool for housing
 
 When relocating for an internship, research visit, or new job, housing information is often fragmented across multiple platforms, making comparison slow and error-prone. EasyRelocate helps users organize and compare housing options by focusing on what matters most: where to live, not where to book.
 
-Users collect listings while browsing platforms such as Airbnb, BlueGround, facebook group using a lightweight browser extension. EasyRelocate then aggregates the minimal, user-authorized information needed to visualize listings on a single map and compare them by price, location, and commute time to a chosen workplace.
+Users collect listings while browsing platforms such as Airbnb, Blueground, facebook group using a lightweight browser extension. EasyRelocate then aggregates the minimal, user-authorized information needed to visualize listings on a single map and compare them by price, location, and commute time to a chosen workplace.
 
 EasyRelocate does not scrape platforms server-side, host listings, process payments, or replace original marketplaces. It exists solely to help users make better relocation decisions, while respecting platform boundaries and directing all final actions back to the original sources.
 
@@ -86,7 +86,8 @@ Set your workplace target by:
 4. Select the `extension/` folder
 5. In the extension **Options**, set API base URL to `http://localhost:8000` (default)
 
-Then open an Airbnb listing detail page (`/rooms/...`) and click “Add to Compare”.
+Then open an Airbnb listing detail page (`https://www.airbnb.com/rooms/...`) or a Blueground
+property page (`https://www.theblueground.com/p/...`) and click “Add to Compare”.
 
 ## Google Maps setup (required)
 EasyRelocate uses Google Maps Platform for:

backend/app/schemas.py

@@ -12,7 +12,7 @@
 )
 
 
-ListingSource = Literal["airbnb"]
+ListingSource = Literal["airbnb", "blueground"]
 PricePeriod = Literal["night", "month", "total", "unknown"]
 
 

backend/tests/test_targets_compare.py

@@ -187,3 +187,24 @@ def test_listings_summary_empty_then_one() -> None:
         assert data["count"] == 1
         assert data["latest_id"] == listing_id
         assert data["latest_captured_at"] == "2026-01-30T10:00:00Z"
+
+
+def test_upsert_listing_accepts_blueground_source() -> None:
+    with TestClient(main.app) as client:
+        created = client.post(
+            "/api/listings",
+            json={
+                "source": "blueground",
+                "source_url": "https://www.theblueground.com/p/furnished-apartments/sfo-1622",
+                "title": "Blueground test",
+                "currency": "USD",
+                "price_period": "unknown",
+                "captured_at": "2026-01-30T10:00:00Z",
+                "lat": 37.4052047,
+                "lng": -122.104919,
+                "location_text": "Mountain View, CA",
+            },
+        )
+        assert created.status_code == 200, created.text
+        data = created.json()
+        assert data["source"] == "blueground"

docs/PLATFORM_ORGANIZATION.md

@@ -49,5 +49,7 @@ If/when needed, add a thin `backend/app/platforms/` layer for:
 - Optional “source metadata” (still minimal; avoid storing full descriptions/images)
 
 ## Current status
-- The extension uses a platform folder for Airbnb at `extension/platforms/airbnb/content.js`.
-
+- Shared overlay UI lives at `extension/shared/overlay.js`.
+- Platform extraction scripts:
+  - Airbnb: `extension/platforms/airbnb/content.js`
+  - Blueground: `extension/platforms/blueground/content.js`

extension/README.md

@@ -14,12 +14,18 @@
 Note: the extension does **not** read `.env` files. Its API base URL is stored in Chrome sync storage
 and can differ from the frontend’s `VITE_API_BASE_URL` if needed.
 
-## Notes on Airbnb location
+## Notes on supported platforms
+### Airbnb
 Airbnb typically does **not** show precise street addresses. The extension tries to capture:
 - Lat/lng (when available in structured data / meta tags)
 - A rough location string (city/region)
 
 If only lat/lng is available, the backend may reverse-geocode it to a rough location (city/state).
 
+### Blueground
+Blueground property pages include a map location. The extension typically captures:
+- Lat/lng (from the page’s embedded data)
+- A location string (often including street/building + city)
+
 ## UI
 - The “Add to Compare” button is draggable; drop it where you like and it will remember the position.

extension/manifest.json

@@ -2,21 +2,31 @@
   "manifest_version": 3,
   "name": "EasyRelocate",
   "version": "0.1.0",
-  "description": "Save Airbnb listings to compare in EasyRelocate.",
+  "description": "Save listings (Airbnb, Blueground) to compare in EasyRelocate.",
   "permissions": ["storage"],
   "host_permissions": [
     "http://localhost/*",
     "http://127.0.0.1/*",
     "https://airbnb.com/*",
-    "https://*.airbnb.com/*"
+    "https://*.airbnb.com/*",
+    "https://theblueground.com/*",
+    "https://*.theblueground.com/*"
   ],
   "background": {
     "service_worker": "background.js"
   },
   "content_scripts": [
     {
       "matches": ["https://airbnb.com/rooms/*", "https://*.airbnb.com/rooms/*"],
-      "js": ["platforms/airbnb/content.js"],
+      "js": ["shared/overlay.js", "platforms/airbnb/content.js"],
+      "run_at": "document_idle"
+    },
+    {
+      "matches": [
+        "https://theblueground.com/p/*",
+        "https://*.theblueground.com/p/*"
+      ],
+      "js": ["shared/overlay.js", "platforms/blueground/content.js"],
       "run_at": "document_idle"
     }
   ],

extension/platforms/airbnb/content.js

@@ -1,31 +1,3 @@
-const ROOT_ID = 'easyrelocate-root'
-const OVERLAY_POS_KEY = 'easyrelocate_overlay_pos_v1'
-const OVERLAY_MARGIN_PX = 10
-
-function sleep(ms) {
-  return new Promise((r) => setTimeout(r, ms))
-}
-
-function storageGet(keysWithDefaults) {
-  return new Promise((resolve) => {
-    try {
-      chrome.storage.sync.get(keysWithDefaults, (items) => resolve(items))
-    } catch {
-      resolve(keysWithDefaults)
-    }
-  })
-}
-
-function storageSet(items) {
-  return new Promise((resolve) => {
-    try {
-      chrome.storage.sync.set(items, () => resolve())
-    } catch {
-      resolve()
-    }
-  })
-}
-
 function canonicalAirbnbUrl(href) {
   try {
     const url = new URL(href)
@@ -41,10 +13,6 @@ function parseNumber(value) {
   return Number.isFinite(n) ? n : null
 }
 
-function clamp(n, min, max) {
-  return Math.min(max, Math.max(min, n))
-}
-
 function currencyFromSymbol(sym) {
   if (sym === '$') return 'USD'
   if (sym === '€') return 'EUR'
@@ -458,209 +426,9 @@ function extractListingSnapshot() {
   }
 }
 
-function showToast(message, kind = 'info') {
-  const el = document.createElement('div')
-  el.textContent = message
-  el.style.position = 'fixed'
-  el.style.right = '16px'
-  el.style.bottom = '16px'
-  el.style.zIndex = '2147483647'
-  el.style.padding = '10px 12px'
-  el.style.borderRadius = '10px'
-  el.style.border = '1px solid rgba(0,0,0,0.08)'
-  el.style.boxShadow = '0 6px 20px rgba(0,0,0,0.12)'
-  el.style.background = kind === 'error' ? '#fee2e2' : '#ffffff'
-  el.style.color = '#0f172a'
-  el.style.fontFamily = 'system-ui, -apple-system, Segoe UI, Roboto, Helvetica, Arial'
-  el.style.fontSize = '13px'
-  document.documentElement.appendChild(el)
-  setTimeout(() => el.remove(), 2400)
-}
-
-function clampOverlayPosition(root, left, top) {
-  const rect = root.getBoundingClientRect()
-  const maxLeft = window.innerWidth - rect.width - OVERLAY_MARGIN_PX
-  const maxTop = window.innerHeight - rect.height - OVERLAY_MARGIN_PX
-  return {
-    left: clamp(left, OVERLAY_MARGIN_PX, Math.max(OVERLAY_MARGIN_PX, maxLeft)),
-    top: clamp(top, OVERLAY_MARGIN_PX, Math.max(OVERLAY_MARGIN_PX, maxTop)),
-  }
-}
-
-function applyOverlayPosition(root, left, top) {
-  const clamped = clampOverlayPosition(root, left, top)
-  root.style.left = `${clamped.left}px`
-  root.style.top = `${clamped.top}px`
-  root.style.right = 'auto'
-  root.style.bottom = 'auto'
-}
-
-async function loadOverlayPosition(root) {
-  const items = await storageGet({ [OVERLAY_POS_KEY]: null })
-  const pos = items[OVERLAY_POS_KEY]
-  if (!pos || typeof pos !== 'object') return
-  const left = Number(pos.left)
-  const top = Number(pos.top)
-  if (!Number.isFinite(left) || !Number.isFinite(top)) return
-  applyOverlayPosition(root, left, top)
-}
-
-function createOverlay() {
-  if (document.getElementById(ROOT_ID)) return
-
-  const root = document.createElement('div')
-  root.id = ROOT_ID
-  root.style.position = 'fixed'
-  root.style.top = '16px'
-  root.style.right = '16px'
-  root.style.zIndex = '2147483647'
-  root.style.userSelect = 'none'
-  root.style.touchAction = 'none'
-
-  const btn = document.createElement('button')
-  btn.textContent = 'Add to Compare'
-  btn.style.display = 'inline-flex'
-  btn.style.alignItems = 'center'
-  btn.style.gap = '8px'
-  btn.style.border = '1px solid rgba(15,23,42,0.14)'
-  btn.style.background = 'linear-gradient(135deg, #0f172a 0%, #1d4ed8 120%)'
-  btn.style.color = '#ffffff'
-  btn.style.borderRadius = '999px'
-  btn.style.padding = '10px 14px'
-  btn.style.fontSize = '13px'
-  btn.style.fontWeight = '650'
-  btn.style.cursor = 'pointer'
-  btn.style.boxShadow = '0 10px 26px rgba(2,6,23,0.18)'
-  btn.style.letterSpacing = '0.2px'
-  btn.style.fontFamily =
-    'system-ui, -apple-system, Segoe UI, Roboto, Helvetica, Arial'
-  btn.style.transition = 'filter 140ms ease, transform 80ms ease'
-
-  const plus = document.createElement('span')
-  plus.textContent = '+'
-  plus.style.display = 'inline-grid'
-  plus.style.placeItems = 'center'
-  plus.style.width = '18px'
-  plus.style.height = '18px'
-  plus.style.borderRadius = '999px'
-  plus.style.background = 'rgba(255,255,255,0.18)'
-  plus.style.fontWeight = '800'
-  plus.style.lineHeight = '1'
-  plus.style.flexShrink = '0'
-  btn.prepend(plus)
-
-  let isDragging = false
-  let didDrag = false
-  let startX = 0
-  let startY = 0
-  let startLeft = 0
-  let startTop = 0
-
-  function ensureLeftTopPositioning() {
-    if (root.style.left) return
-    const rect = root.getBoundingClientRect()
-    root.style.left = `${rect.left}px`
-    root.style.top = `${rect.top}px`
-    root.style.right = 'auto'
-    root.style.bottom = 'auto'
-  }
-
-  btn.addEventListener('pointerdown', (e) => {
-    if (e.button !== 0) return
-    btn.setPointerCapture(e.pointerId)
-    ensureLeftTopPositioning()
-    const rect = root.getBoundingClientRect()
-    startX = e.clientX
-    startY = e.clientY
-    startLeft = rect.left
-    startTop = rect.top
-    isDragging = true
-    didDrag = false
-    btn.style.transform = 'scale(0.98)'
-  })
-
-  btn.addEventListener('pointermove', (e) => {
-    if (!isDragging) return
-    const dx = e.clientX - startX
-    const dy = e.clientY - startY
-    if (!didDrag && Math.hypot(dx, dy) < 6) return
-    didDrag = true
-    applyOverlayPosition(root, startLeft + dx, startTop + dy)
-  })
-
-  async function finishDrag(e) {
-    if (!isDragging) return
-    isDragging = false
-    btn.style.transform = ''
-    try {
-      btn.releasePointerCapture(e.pointerId)
-    } catch {
-      // ignore
-    }
-    if (!didDrag) return
-    const rect = root.getBoundingClientRect()
-    await storageSet({
-      [OVERLAY_POS_KEY]: { left: rect.left, top: rect.top },
-    })
-  }
-
-  btn.addEventListener('pointerup', (e) => void finishDrag(e))
-  btn.addEventListener('pointercancel', (e) => void finishDrag(e))
-
-  btn.addEventListener('mouseenter', () => {
-    btn.style.filter = 'brightness(1.03)'
+if (globalThis.EasyRelocateOverlay && typeof globalThis.EasyRelocateOverlay.boot === 'function') {
+  void globalThis.EasyRelocateOverlay.boot({
+    extractListingSnapshot,
+    initialDelayMs: 1200,
   })
-  btn.addEventListener('mouseleave', () => {
-    btn.style.filter = ''
-    btn.style.transform = ''
-  })
-
-  btn.addEventListener('click', async () => {
-    if (didDrag) {
-      didDrag = false
-      return
-    }
-    btn.disabled = true
-    btn.style.opacity = '0.75'
-    try {
-      const payload = extractListingSnapshot()
-      const res = await new Promise((resolve) => {
-        chrome.runtime.sendMessage({ type: 'EASYRELOCATE_ADD_LISTING', payload }, (resp) =>
-          resolve(resp),
-        )
-      })
-      if (res && res.ok) {
-        showToast('Saved to EasyRelocate.')
-      } else {
-        showToast(`Failed: ${res?.error ?? 'Unknown error'}`, 'error')
-      }
-    } catch (e) {
-      showToast(`Failed: ${String(e?.message ?? e)}`, 'error')
-    } finally {
-      btn.disabled = false
-      btn.style.opacity = '1'
-    }
-  })
-
-  root.appendChild(btn)
-  document.documentElement.appendChild(root)
-
-  void loadOverlayPosition(root)
-  window.addEventListener(
-    'resize',
-    () => {
-      if (!root.style.left) return
-      const rect = root.getBoundingClientRect()
-      applyOverlayPosition(root, rect.left, rect.top)
-    },
-    { passive: true },
-  )
 }
-
-async function boot() {
-  // Wait a bit for Airbnb client rendering to settle.
-  await sleep(1200)
-  createOverlay()
-}
-
-void boot()