Feature/getjoke (#143)

Author: fandomario

app/database/models.py

@@ -382,6 +382,13 @@ def __repr__(self):
         )
 
 
+class Joke(Base):
+    __tablename__ = "jokes"
+
+    id = Column(Integer, primary_key=True, index=True)
+    text = Column(String, nullable=False)
+
+
 # insert language data
 
 # Credit to adrihanu   https://stackoverflow.com/users/9127249/adrihanu

app/internal/jokes.py

@@ -0,0 +1,24 @@
+from typing import Dict, Optional
+
+from sqlalchemy.orm import Session
+from sqlalchemy.sql.expression import func
+
+from app.database.models import Joke
+
+
+def get_joke(joke_: Dict[str, Optional[str]]) -> Joke:
+    """Returns a Joke object from the dictionary data.
+
+    Args:
+        joke_: A dictionary joke related information.
+
+    Returns:
+        A new Joke object.
+    """
+    return Joke(
+        text=joke_['text'],
+    )
+
+
+def get_a_joke(session: Session):
+    return session.query(Joke).order_by(func.random()).first()

app/internal/json_data_loader.py

@@ -5,8 +5,8 @@
 from loguru import logger
 from sqlalchemy.orm import Session
 
-from app.database.models import Base, Quote, Zodiac
-from app.internal import daily_quotes, zodiac
+from app.database.models import Base, Joke, Quote, Zodiac
+from app.internal import daily_quotes, jokes, zodiac
 
 
 def load_to_database(session: Session) -> None:
@@ -35,6 +35,13 @@ def load_to_database(session: Session) -> None:
         daily_quotes.get_quote,
     )
 
+    _insert_into_database(
+        session,
+        'app/resources/jokes.json',
+        Joke,
+        jokes.get_joke,
+    )
+
 
 def _insert_into_database(
         session: Session,

app/main.py

@@ -42,7 +42,7 @@ def create_tables(engine, psql_environment):
 from app.routers import (  # noqa: E402
     about_us, agenda, calendar, categories, celebrity, credits,
     currency, dayview, email, event, export, four_o_four, friendview,
-    google_connect, invitation, login, logout, profile,
+    google_connect, invitation, joke, login, logout, profile,
     register, search, telegram, user, weekview, whatsapp,
 )
 
@@ -82,6 +82,7 @@ async def swagger_ui_redirect():
     four_o_four.router,
     google_connect.router,
     invitation.router,
+    joke.router,
     login.router,
     logout.router,
     profile.router,

app/resources/jokes.json

@@ -0,0 +1,12 @@
+from fastapi import APIRouter, Depends, Request
+from app.internal import jokes
+from sqlalchemy.orm import Session
+from app.dependencies import get_db
+
+
+router = APIRouter()
+
+
+@router.get("/joke")
+async def joke(request: Request, db: Session = Depends(get_db)):
+    return jokes.get_a_joke(db)

app/routers/joke.py

@@ -0,0 +1,14 @@
+function makejoke() {
+  fetch('/joke')
+    .then(response => response.json())
+    .then(data => Swal.fire(data.text));
+}
+
+
+function addEventsAfterPageLoaded() {
+  const element = document.getElementById("a-joke");
+  element.addEventListener("click", makejoke, false);
+}
+
+
+document.addEventListener("DOMContentLoaded", addEventsAfterPageLoaded);

app/static/joke.js

@@ -55,6 +55,9 @@
                                 <li class="nav-item">
                                     <a class="nav-link" href="{{ url_for('friendview') }}">Friend View</a>
                                 </li>
+                                <li class="nav-item">
+                                    <button id="a-joke" class="btn btn-link">Make me Laugh</button>
+                                </li>
                                 <li class="nav-item">
                                     <a class="nav-link" href="{{ url_for('about') }}">{{ gettext("About Us") }}</a>
                                 </li>
@@ -75,6 +78,9 @@
     <!-- This bootstrap version is needed here because of the toggler bug in the beta version-->
     <script src="https://stackpath.bootstrapcdn.com/bootstrap/5.0.0-alpha2/js/bootstrap.bundle.min.js" integrity="sha384-BOsAfwzjNJHrJ8cZidOg56tcQWfp6y72vEJ8xQ9w6Quywb24iOsW913URv1IS4GD" crossorigin="anonymous"></script>
     <script src="{{ url_for('static', path='/horoscope.js') }}"></script>
+    <script src="{{ url_for('static', path='/joke.js') }}"></script>
+    <script src="https://cdn.jsdelivr.net/npm/sweetalert2@10"></script>
+
 </body>
 
 </html>

app/templates/base.html

@@ -20,6 +20,7 @@
     'smtpdfix',
     'tests.quotes_fixture',
     'tests.zodiac_fixture',
+    'tests.jokes_fixture',
     'tests.comment_fixture',
 ]
 

tests/conftest.py

@@ -0,0 +1,20 @@
+import pytest
+from sqlalchemy.orm import Session
+
+from app.database.models import Joke
+from app.internal.utils import create_model, delete_instance
+
+
+def add_joke(session: Session, id_joke: int, text: str) -> Joke:
+    joke = create_model(session, Joke, id=id_joke, text=text)
+    yield joke
+    delete_instance(session, joke)
+
+
+@pytest.fixture
+def joke(session: Session) -> Joke:
+    yield from add_joke(
+        session=session,
+        id_joke=1,
+        text='Chuck Norris can slam a revolving door.',
+    )

tests/jokes_fixture.py

@@ -0,0 +1,17 @@
+from app.database.models import Joke
+from app.internal import jokes
+
+
+def get_jokes_amount(session):
+    return session.query(Joke).count()
+
+
+def test_get_a_joke(session, joke):
+    assert jokes.get_a_joke(session).text == joke.text
+
+
+def test_jokes_not_load_twice_to_db(session):
+    jokes.get_a_joke(session)
+    first_load_amount = get_jokes_amount(session)
+    jokes.get_a_joke(session)
+    assert first_load_amount == get_jokes_amount(session)

tests/test_joke.py

@@ -0,0 +1,4 @@
+def test_joke(client, session):
+    resp = client.get('/joke')
+    assert resp.ok
+    assert resp.json