Feature/geolocation (#193)

Author: Eliory09

.DS_Store

@@ -162,3 +162,7 @@ app/routers/stam
 .idea
 
 junit/
+
+# .DS_Store
+.DS_Store
+DS_Store

.gitignore

@@ -92,6 +92,8 @@ class Event(Base):
     end = Column(DateTime, nullable=False)
     content = Column(String)
     location = Column(String, nullable=True)
+    latitude = Column(String, nullable=True)
+    longitude = Column(String, nullable=True)
     vc_link = Column(String, nullable=True)
     is_google_event = Column(Boolean, default=False)
     color = Column(String, nullable=True)

app/database/models.py

@@ -1,17 +1,29 @@
 import logging
 import re
-from typing import List, Set
+from typing import List, NamedTuple, Set, Union
 
 from email_validator import EmailSyntaxError, validate_email
 from fastapi import HTTPException
+from geopy.adapters import AioHTTPAdapter
+from geopy.exc import GeocoderTimedOut, GeocoderUnavailable
+from geopy.geocoders import Nominatim
+from loguru import logger
 from sqlalchemy.orm import Session
 from starlette.status import HTTP_400_BAD_REQUEST
 
 from app.database.models import Event
 
+
 ZOOM_REGEX = re.compile(r"https://.*?\.zoom.us/[a-z]/.[^.,\b\s]+")
 
 
+class Location(NamedTuple):
+    # Location type hint class.
+    latitude: str
+    longitude: str
+    name: str
+
+
 def raise_if_zoom_link_invalid(vc_link):
     if ZOOM_REGEX.search(vc_link) is None:
         raise HTTPException(
@@ -101,3 +113,27 @@ def get_messages(
             f"Want to create another one {weeks_diff} after too?",
         )
     return messages
+
+
+async def get_location_coordinates(
+    address: str,
+) -> Union[Location, str]:
+    """Return location coordinates and accurate
+    address of the specified location."""
+    try:
+        async with Nominatim(
+            user_agent="Pylendar",
+            adapter_factory=AioHTTPAdapter,
+        ) as geolocator:
+            geolocation = await geolocator.geocode(address)
+    except (GeocoderTimedOut, GeocoderUnavailable) as e:
+        logger.exception(str(e))
+    else:
+        if geolocation is not None:
+            location = Location(
+                latitude=geolocation.latitude,
+                longitude=geolocation.longitude,
+                name=geolocation.raw["display_name"],
+            )
+            return location
+    return address

app/internal/event.py

@@ -16,18 +16,20 @@
 
 from app.database.models import Comment, Event, User, UserEvent
 from app.dependencies import get_db, logger, templates
+from app.internal import comment as cmt
+from app.internal.emotion import get_emotion
 from app.internal.event import (
     get_invited_emails,
+    get_location_coordinates,
     get_messages,
     get_uninvited_regular_emails,
     raise_if_zoom_link_invalid,
 )
-from app.internal import comment as cmt
-from app.internal.emotion import get_emotion
 from app.internal.privacy import PrivacyKinds
 from app.internal.utils import create_model, get_current_user
 from app.routers.categories import get_user_categories
 
+
 EVENT_DATA = Tuple[Event, List[Dict[str, str]], str]
 TIME_FORMAT = "%Y-%m-%d %H:%M"
 START_FORMAT = "%A, %d/%m/%Y %H:%M"
@@ -132,9 +134,16 @@ async def create_new_event(
         title,
         invited_emails,
     )
+    latitude, longitude = None, None
 
     if vc_link:
         raise_if_zoom_link_invalid(vc_link)
+    else:
+        location_details = await get_location_coordinates(location)
+        if not isinstance(location_details, str):
+            location = location_details.name
+            latitude = location_details.latitude
+            longitude = location_details.longitude
 
     event = create_event(
         db=session,
@@ -145,6 +154,8 @@ async def create_new_event(
         owner_id=owner_id,
         content=content,
         location=location,
+        latitude=latitude,
+        longitude=longitude,
         vc_link=vc_link,
         invitees=invited_emails,
         category_id=category_id,
@@ -411,6 +422,8 @@ def create_event(
     content: Optional[str] = None,
     location: Optional[str] = None,
     vc_link: str = None,
+    latitude: Optional[str] = None,
+    longitude: Optional[str] = None,
     color: Optional[str] = None,
     invitees: List[str] = None,
     category_id: Optional[int] = None,
@@ -432,6 +445,8 @@ def create_event(
         content=content,
         owner_id=owner_id,
         location=location,
+        latitude=latitude,
+        longitude=longitude,
         vc_link=vc_link,
         color=color,
         emotion=get_emotion(title, content),

app/routers/event.py

@@ -50,10 +50,6 @@ div.event_info_row,
   margin-block-end: 0.2em;
 }
 
-.title {
-  border-bottom: 4px solid blue;
-}
-
 .title h1 {
   white-space: nowrap;
   margin-block-start: 0.2em;
@@ -72,4 +68,8 @@ div.event_info_row,
 
 button {
   height: 100%;
-}
+}
+
+.google_maps_object {
+  width: 100%;
+}

app/static/event/eventview.css

@@ -1,11 +1,11 @@
 <div class="event_info_row title" style="border-bottom: 4px solid {{ event.color }}">
-    <div class="event_info_row_start">
-        <h1>{{ event.title }}</h1>
-    </div>
-    <div class="event_info_row_end">
-        <!--        <span class="icon">AVAILABILITY</span>-->
-        <!--        <span class="icon">PRIVACY</span>-->
-    </div>
+  <div class="event_info_row_start">
+    <h1>{{ event.title }}</h1>
+  </div>
+  <div class="event_info_row_end">
+    <!--        <span class="icon">AVAILABILITY</span>-->
+    <!--        <span class="icon">PRIVACY</span>-->
+  </div>
 </div>
 <div class="event_info_row">
     <span class="icon">ICON</span>
@@ -35,24 +35,39 @@ <h1>{{ event.title }}</h1>
   <address>VC link<a href="{{ event.vc_link }}">VC URL</a></address>
 </div>
 {% endif %}
+
+{% if event.latitude is not none and event.longitude is not none %}
+  <div class="google_maps_object">
+    <iframe
+      width="600"
+      height="400"
+      frameborder="0"
+      scrolling="no"
+      marginheight="0"
+      marginwidth="0"
+      src="https://maps.google.com/maps?q={{event.latitude}},{{event.longitude}}&hl=es;z=14&amp;output=embed">
+    </iframe>
+  </div>
+{% endif %}
+
 {% if event.invitees %}
 <form method="POST" action="/event/{{event.id}}/owner">
-    <div class="mb-3"></div>
-    <label for="username">{{ gettext('Choose user') }}</label>
-    <select id="username" name="username">
-        {% for username in event.invitees.split(',') %}
-      <option value="{{username}}">{{username}}</option>
-      {% endfor %}
-    </select>
-    <input type="submit" class="btn btn-primary" value="Change owner">
+  <div class="mb-3"></div>
+  <label for="username">{{ gettext('Choose user') }}</label>
+  <select id="username" name="username">
+    {% for username in event.invitees.split(',') %}
+    <option value="{{username}}">{{username}}</option>
+    {% endfor %}
+  </select>
+  <input type="submit" class="btn btn-primary" value="Change owner">
 </form>
 {% endif %}
 <p class="event_info_row">
-    {{event.owner.username}}
+  {{event.owner.username}}
 </p>
 
 <div class="event_info_buttons_row event_info_row_end">
-    <!-- Buttons could and should be replaced with button-like anchors if need so -->
-    <button type="button">Duplicate</button>
-    <button type="button">Edit</button>
+  <!-- Buttons could and should be replaced with button-like anchors if need so -->
+  <button type="button">Duplicate</button>
+  <button type="button">Edit</button>
 </div>

app/templates/partials/calendar/event/view_event_details_tab.html

@@ -1,4 +1,5 @@
 aiofiles==0.6.0
+aiohttp==3.7.3
 aioredis==1.3.1
 aiosmtpd==1.2.2
 aiosmtplib==1.1.4
@@ -24,7 +25,7 @@ cachetools==4.2.0
 certifi==2020.12.5
 cffi==1.14.4
 cfgv==3.2.0
-chardet==4.0.0
+chardet==3.0.4
 click==7.1.2
 colorama==0.4.4
 coverage==5.3.1
@@ -44,6 +45,8 @@ fastapi-mail==0.3.3.1
 filelock==3.0.12
 flake8==3.8.4
 frozendict==1.2
+geographiclib==1.50
+geopy==2.1.0
 google-api-core==1.25.0
 google-api-python-client==1.12.8
 google-auth==1.24.0
@@ -77,13 +80,15 @@ mocker==1.1.1
 multidict==5.1.0
 mypy==0.790
 mypy-extensions==0.4.3
+nest-asyncio==1.5.1
 nltk==3.5
 nodeenv==1.5.0
 oauth2client==4.1.3
 oauthlib==3.1.0
 outcome==1.1.0
 packaging==20.8
 passlib==1.7.4
+pathspec==0.8.1
 Pillow==8.1.0
 pluggy==0.13.1
 pre-commit==2.10.0
@@ -148,4 +153,5 @@ win32-setctime==1.0.3
 word-forms==2.1.0
 wsproto==1.0.0
 yapf==0.30.0
-zipp==3.4.0
+yarl==1.6.3
+zipp==3.4.0

requirements.txt

@@ -33,6 +33,7 @@ def fake_user_events(session):
     create_event(
         db=session,
         title='Cool today event',
+        color='red',
         start=today_date,
         end=today_date + timedelta(days=2),
         all_day=False,
@@ -44,6 +45,7 @@ def fake_user_events(session):
     create_event(
         db=session,
         title='Cool (somewhen in two days) event',
+        color='blue',
         start=today_date + timedelta(days=1),
         end=today_date + timedelta(days=3),
         all_day=False,

tests/asyncio_fixture.py

@@ -1,11 +1,12 @@
 import calendar
 
+import nest_asyncio
 import pytest
+from app.config import PSQL_ENVIRONMENT
+from app.database.models import Base
 from sqlalchemy import create_engine
 from sqlalchemy.orm import sessionmaker
 
-from app.config import PSQL_ENVIRONMENT
-from app.database.models import Base
 
 pytest_plugins = [
     'tests.user_fixture',
@@ -80,3 +81,6 @@ def sqlite_engine():
 @pytest.fixture
 def Calendar():
     return calendar.Calendar(0)
+
+
+nest_asyncio.apply()