Feedback

.github/workflows/workflow_app.yml

@@ -0,0 +1,44 @@
+name: CI/CD for Web App
+
+run-name: ${{ github.actor }} is automating using Github Actions
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.11"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade pipenv
+          python -m pip install --upgrade Flask-Pytest
+          pipenv install --dev
+          pipenv install tomli
+          pipenv sync
+      - name: Test with pytest (web-app)
+        run: |
+          pipenv run pytest -v test_app.py
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Deploy to Production
+        run: |
+          docker-compose build
+          docker-compose up -d
+          docker-compose push

Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.12-slim
+
+WORKDIR /usr/src/app
+
+RUN pip install pipenv
+
+COPY Pipfile Pipfile.lock ./
+
+RUN pipenv install --deploy --ignore-pipfile
+
+COPY . .
+
+EXPOSE 5000
+
+ENV NAME spotifyquiz
+
+CMD ["pipenv", "run", "python", "./app.py"]

Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+flask = "*"
+requests = "*"
+pymongo = "*"
+flask-pymongo = "*"
+coverage = "*"
+exceptiongroup = "*"
+
+[dev-packages]
+pytest = "*"
+
+[requires]
+python = "3.12"

README.md

@@ -1,3 +1,28 @@
-# Final Project
+![Web-App](https://github.com/software-students-fall2023/5-final-project-fivepeat/actions/workflows/workflow_app.yml/badge.svg)
 
-An exercise to put to practice software development teamwork, subsystem communication, containers, deployment, and CI/CD pipelines. See [instructions](./instructions.md) for details.
+# Do You Know Your Own Music?
+
+A web app that gives you info about your Spotify listening habits, recommends songs, and also tests your music knowledge!
+Please contact us with your spotify email, so that we can register you on the API developer server!
+## Deployed App
+https://whale-app-4h3br.ondigitalocean.app/
+
+## DockerHub Links
+https://hub.docker.com/r/emxyz/5-final-project-fivepeat-web
+
+## Instructions to Run
+1. Clone the repository from Github
+2. Navigate to the project root folder
+# Local
+3. `pipenv install`
+4. `pipenv shell`
+5. `python app.py`
+
+# Using Docker
+3. `docker-compose up —build`
+
+### Contributors
+Danica Jin - https://github.com/dj9771    
+Emma Zheng - https://github.com/emxyz   
+Gabriel Park - https://github.com/gmp9469    
+Megan Chen - https://github.com/meganchen99

app.py

@@ -0,0 +1,219 @@
+import requests
+from flask import Flask, redirect, request, jsonify, session, render_template
+from datetime import datetime
+import urllib.parse
+import random
+import db
+
+app = Flask(__name__)
+app.secret_key = 'a1w12lje-df2jgd45kjg-s2fs3d8'
+
+CLIENT_ID = 'ebd35c5b8a8644bc9eb08657951956ac'
+CLIENT_SECRET = '9a0a789fc56b4a9fa43c66a093dfdd84'
+REDIRECT_URI = 'https://whale-app-4h3br.ondigitalocean.app/callback'
+AUTH_URL = 'https://accounts.spotify.com/authorize'
+TOKEN_URL = 'https://accounts.spotify.com/api/token'
+API_BASE_URL = 'https://api.spotify.com/v1/'
+
+@app.route('/')
+def index():
+    return render_template('welcome.html')
+
+@app.route('/login')
+def login():
+    scope = 'user-read-private user-read-email user-top-read user-library-read' 
+    params = {
+        'client_id': CLIENT_ID,
+        'response_type': 'code',
+        'scope': scope,
+        'redirect_uri': REDIRECT_URI,
+        'show_dialog': True
+    }
+
+    auth_url = f"{AUTH_URL}?{urllib.parse.urlencode(params)}"
+    return redirect(auth_url)
+
+@app.route('/callback')
+def callback():
+    if 'error' in request.args:
+        return jsonify({"error": request.args['error']})
+
+    if 'code' in request.args:
+        req_body = {
+            'code': request.args['code'],
+            'grant_type': 'authorization_code',
+            'redirect_uri': REDIRECT_URI,
+            'client_id': CLIENT_ID,
+            'client_secret': CLIENT_SECRET
+        }
+
+        response = requests.post(TOKEN_URL, data=req_body)
+        token_info = response.json()
+        session['access_token'] = token_info['access_token']
+        session['refresh_token'] = token_info['refresh_token']
+        session['expires_at'] = datetime.now().timestamp() + token_info['expires_in']
+        return redirect('/top_artists')
+
+@app.route('/top_artists')
+def top_artists():
+    if 'access_token' not in session:
+        return redirect('/login')
+    if datetime.now().timestamp() > session['expires_at']:
+        return redirect('/refresh-token')
+
+    headers = {
+        'Authorization': f"Bearer {session['access_token']}"
+    }
+
+    user_info = requests.get(API_BASE_URL + 'me', headers=headers)
+    display_name = user_info.json().get('display_name')
+    response = requests.get(API_BASE_URL + 'me/top/artists?limit=3', headers=headers)
+    artists_data = response.json().get('items', [])
+    if artists_data:
+        artists_info = []
+        for artist in artists_data:
+            artist_info = {
+                'name': artist.get('name', 'Unknown Artist'),
+                'image_url': artist['images'][0]['url'] if artist.get('images') else None
+            }
+            artists_info.append(artist_info)
+
+        return render_template('top_artists.html', display_name=display_name, artists=artists_info)
+    else:
+        return "empty response"
+
+
+@app.route('/refresh-token')
+def refresh_token():
+    req_body = {}
+    if 'refresh_token' not in session:
+        return redirect('/login')
+    if datetime.now().timestamp() > session['expires_at']:
+        req_body = {
+            'grant_type': 'refresh_token',
+            'refresh_token': session['refresh_token'],
+            'client_id': CLIENT_ID,
+            'client_secret': CLIENT_SECRET
+        }
+    response = requests.post(TOKEN_URL, data=req_body)
+    new_token_info = response.json()
+    session['access_token'] = new_token_info['access_token']
+    session['expires_at'] = datetime.now().timestamp() + new_token_info['expires_in']
+    return redirect('/top_artists')
+
+@app.route('/quiz')
+def quiz():
+    if 'access_token' not in session:
+        return redirect('/login')
+    if datetime.now().timestamp() > session['expires_at']:
+        return redirect('/refresh-token')
+
+    headers = {
+        'Authorization': f"Bearer {session['access_token']}"
+    }
+    saved_tracks_response = requests.get(API_BASE_URL + 'me/top/tracks?limit=100', headers=headers)
+    saved_tracks = saved_tracks_response.json()['items']
+    selected_tracks = random.sample(saved_tracks, 2)
+
+    track_ids = ','.join([track['id'] for track in selected_tracks])
+    features_response = requests.get(API_BASE_URL + f'audio-features?ids={track_ids}', headers=headers)
+    audio_features = features_response.json()['audio_features']
+
+    song1, song2 = selected_tracks
+    if random.choice([True, False]):
+        features1 = [feature for feature in audio_features if feature['id'] == song1['id']][0]
+        features2 = [feature for feature in audio_features if feature['id'] == song2['id']][0]
+        session['correct_answer'] = song1['id']
+    else:
+        features1 = [feature for feature in audio_features if feature['id'] == song2['id']][0]
+        features2 = [feature for feature in audio_features if feature['id'] == song1['id']][0]
+        session['correct_answer'] = song2['id']
+
+    session['quiz_data'] = {
+        'song1': song1,
+        'song2': song2,
+        'features1': features1,
+        'features2': features2,
+        'song1_image_url': selected_tracks[0].get('album', {}).get('images', [])[0]['url'] if selected_tracks[0].get('album') else None,
+        'song2_image_url': selected_tracks[1].get('album', {}).get('images', [])[0]['url'] if selected_tracks[1].get('album') else None
+    }
+
+    return render_template('quiz.html', song1_name=song1, song2_name=song2, features1=features1, features2=features2)
+
+@app.route('/quiz/submit', methods=['POST'])
+def quiz_submit():
+    submitted_answer = request.form['answer1']
+    correct_answer = session.get('correct_answer')
+    quiz_data = session.get('quiz_data', {})
+
+    song1_features = quiz_data['song1'].get('features1') if 'features1' in quiz_data.get('song1', {}) else None
+    song2_features = quiz_data['song2'].get('features2') if 'features2' in quiz_data.get('song2', {}) else None
+
+    if submitted_answer == correct_answer:
+        result = "Correct!"
+    else:
+        result = "Incorrect!"
+
+    """Saves quiz into the MongoDB database"""
+    data = {
+        "Song 1 Name": quiz_data['song1']['name'],
+        "Song 1 Features": song1_features,
+        "Song 2 Name": quiz_data['song2']['name'],
+        "Song 2 Features": song2_features,
+        "Song 1 Image URL": quiz_data['song1_image_url'],
+        "Song 2 Image URL": quiz_data['song2_image_url'],
+        "Result": result,
+        "timestamp_field": datetime.utcnow()
+
+    }
+
+    db.collection.insert_one(data)
+
+    return render_template('quiz_result.html', result=result)
+
+@app.route('/random_song')
+def random_song():
+    if 'access_token' not in session:
+        return redirect('/login')
+    if datetime.now().timestamp() > session['expires_at']:
+        return redirect('/refresh-token')
+
+    headers = {
+        'Authorization': f"Bearer {session['access_token']}"
+    }
+
+    response = requests.get(API_BASE_URL + 'browse/featured-playlists', headers=headers)
+    featured_playlists_data = response.json().get('playlists', {}).get('items', [])
+    if featured_playlists_data:
+        selected_playlist = random.choice(featured_playlists_data)
+        playlist_endpoint = selected_playlist['href']
+        playlist_response = requests.get(playlist_endpoint, headers=headers)
+        playlist_data = playlist_response.json()
+
+        tracks_data = playlist_data.get('tracks', {}).get('items', [])
+        if tracks_data:
+            random_track = random.choice(tracks_data)['track']
+            track_info = {
+                'name': random_track.get('name', 'Unknown Track'),
+                'artists': [artist['name'] for artist in random_track.get('artists', [])],
+                'album': random_track.get('album', {}).get('name', 'Unknown Album'),
+                'image_url': random_track.get('album', {}).get('images', [])[0]['url'] if random_track.get('album') else None,
+                'external_url': random_track.get('external_urls', {}).get('spotify', '')
+            }
+
+            return render_template('song_gen.html', track_info=track_info)
+        else:
+            return jsonify({"message": "No tracks found in the selected playlist"})
+    else:
+        return jsonify({"message": "No featured playlists available"})
+
+@app.route('/history')
+def history():
+    if 'access_token' not in session:
+        return redirect('/login')
+    quiz_history = db.collection.find().sort("timestamp_field", -1)
+    return render_template('history.html', quiz_history=quiz_history)
+
+
+if __name__ == '__main__':
+    app.run(host='0.0.0.0', port=5000, debug=True)

db.py

@@ -0,0 +1,23 @@
+"""Database for this application"""
+import os
+from pymongo import MongoClient
+
+"""DATABASE_HOST = os.getenv("DATABASE_HOST", "localhost")
+CONNECTION_STRING = f"mongodb://{DATABASE_HOST}:27017/"
+
+client = MongoClient(CONNECTION_STRING)
+db = client['quiz_game_db']
+collection = db['quiz_scores']"""
+
+
+username = "doadmin"
+password = "Si7Hu4p9ln31F026"
+host = "db-mongodb-nyc3-33511-709f7b62.mongo.ondigitalocean.com"
+database_name = "admin"
+
+uri = f"mongodb+srv://{username}:{password}@{host}/{database_name}?retryWrites=true&w=majority"
+client = MongoClient(uri)
+db = client['quiz_game_db']
+collection = db['quiz_scores']
+
+

docker-compose.yml

@@ -0,0 +1,17 @@
+version: '3.12'
+services:
+  web:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    ports:
+      - "5000:5000"
+    depends_on:
+      - db
+    environment:
+      - DATABASE_HOST=db
+
+  db:
+    image: mongo
+    ports:
+      - "27017:27017"