diff --git a/.woodpecker.yml b/.woodpecker.yml index d6ffe9a..ccc0226 100644 --- a/.woodpecker.yml +++ b/.woodpecker.yml @@ -2,7 +2,7 @@ pipeline: # =====TESTING===== test-backend: # Alpine version doesn't have make - image: python:3.8 + image: python:3.9 pull: true group: test commands: @@ -23,7 +23,7 @@ pipeline: # =====LINTING===== lint-backend: - image: python:3.8 + image: python:3.9 group: lint commands: - make lint diff --git a/Makefile b/Makefile index 6b6e2c5..dcaf859 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ PYTHON := python3 # This can't contain spaces (I think) VENV := .venv # Minimum % coverage for tests to succeed -MIN_COV := 0 +MIN_COV := 50 # Directory name for the frontend WEB_DIR := web @@ -55,7 +55,7 @@ test: venv ## Starting the server ### Run the Quart server run: venv - @ '$(VENV)'/bin/python app + @ QUART_ENV=development '$(VENV)'/bin/python app .PHONY: run diff --git a/app/__main__.py b/app/__main__.py index 3848299..0ae9974 100644 --- a/app/__main__.py +++ b/app/__main__.py @@ -1,7 +1,9 @@ -"""Main entrypoint for the program.""" +"""Entrypoint for the program.""" from quart import Quart +from app.api import api_bp app = Quart("jos", static_folder="web/dist", static_url_path="/") +app.register_blueprint(api_bp, url_prefix="/api") @app.route("/", methods=["GET"], defaults={"path": ""}) @@ -11,4 +13,5 @@ async def frontend(path): return await app.send_static_file("index.html") -app.run(host="0.0.0.0") +if __name__ == "__main__": + app.run(host="0.0.0.0") diff --git a/app/api/__init__.py b/app/api/__init__.py new file mode 100644 index 0000000..718ec88 --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1,8 @@ +"""Module containing all Flask-related code.""" +from quart import Blueprint +from .search import search_bp + + +# Main blueprint exposing entire API +api_bp = Blueprint("api", __name__) +api_bp.register_blueprint(search_bp, url_prefix="/search") diff --git a/app/api/search.py b/app/api/search.py new file mode 100644 index 0000000..c0d32dc --- /dev/null +++ b/app/api/search.py @@ -0,0 +1,11 @@ +"""Handles the search endpoint.""" +from quart import Blueprint + + +search_bp = Blueprint("search", __name__) + + +@search_bp.route("/", methods=["GET"]) +async def search_spotify(): + """Search the Spotify API.""" + return "yeet" diff --git a/app/spotify.py b/app/spotify.py new file mode 100644 index 0000000..2021498 --- /dev/null +++ b/app/spotify.py @@ -0,0 +1,98 @@ +"""Handle connections with the Spotify API.""" +import base64 +import requests +import urllib +from datetime import datetime, timedelta +from typing import List + + +AUTH_URL = "https://accounts.spotify.com/api/token" +API_URL = "https://api.spotify.com/v1" + + +def requires_token(method: callable, retries: int = 2): + """Decorator that handles refreshing the token. + + Args: + method: function to decorate + retries: how many times to retry creating the token + """ + + def inner(ref, *args, **kwargs): + for _ in range(retries): + if ref._access_token and datetime.now() < ref._expiration_time: + break + + ref._refresh_token() + + method(ref, *args, **kwargs) + + return inner + + +class CredentialError(Exception): + """Thrown when invalid credentials are passed to Spotify API.""" + + pass + + +class Spotify: + """Represents a connection object with the Spotify API.""" + + def __init__(self, client_id: str, client_secret: str): + """Initialize a new Spotify object. + + Args: + client_id: client id for the API + client_secret: client secret for the API + """ + self._client_id = client_id + self._client_secret = client_secret + + self._access_token = "" + self._token_type = "" + self._expiration_time = 0 + self._scope = "" + + def _refresh_token(self): + """Refresh the current token, or create a new one.""" + b64_encoded = base64.b64encode( + f"{self.client_id}:{self.client_secret}".encode() + ) + + headers = {"Authorization": f"Basic {b64_encoded.decode('ascii')}"} + data = {"grant_type": "client_credentials"} + + post = requests.post(AUTH_URL, headers=headers, data=data) + status_code = post.status_code + + if status_code == 401: + raise CredentialError("Provided credentials are not correct.") + + if status_code == 200: + self.access_token = post.json()["access_token"] + self.token_type = post.json()["token_type"] + self.expiration_time = datetime.now() + timedelta(seconds=post.json()["expires_in"]) + self.scope = post.json()["scope"] + + # TODO raise errors on failure + + @requires_token + def search(self, search_term: str, types: List[str]): + """Search the API for entries. + + Args: + search_term: the searm term to use + types: which object types to search for + """ + encoded_search_term = urllib.parse.quote(search_term) + types_str = ",".join(types) + + r = requests.get( + f"{API_URL}/search?q={encoded_search_term}&type={types_str}", + headers={"Authorization": "Bearer " + self.access_token}, + ) + + results = r.json() + + return results diff --git a/setup.cfg b/setup.cfg index 9a7c913..e724943 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,12 +1,12 @@ [options] install_requires = - quart==0.15.1 + quart==0.15.0 [options.extras_require] # Used inside Tox for running tests test = pytest==6.2.4 - pytest-cov==2.12.1 + pytest-cov==2.12.0 # Worth testing out pytest-tldr==0.2.4 diff --git a/tests/test_succeed.py b/tests/test_succeed.py deleted file mode 100644 index 81db0b6..0000000 --- a/tests/test_succeed.py +++ /dev/null @@ -1,3 +0,0 @@ -def test_succeed(): - """Placeholder test to make CI succeed.""" - pass diff --git a/.mocharc.yml b/web/.mocharc.yml similarity index 100% rename from .mocharc.yml rename to web/.mocharc.yml diff --git a/web/package.json b/web/package.json index f9e5dd5..63f2510 100644 --- a/web/package.json +++ b/web/package.json @@ -26,10 +26,10 @@ "eslint-config-standard": "^16.0.2", "eslint-plugin-import": "^2.23.2", "eslint-plugin-node": "^11.1.0", - "eslint-plugin-promise": "^5.0.0", + "eslint-plugin-promise": "^4.3.1", "eslint-plugin-vue": "^7.9.0", "mocha": "^8.4.0", - "ts-node": "^10.0.0", + "ts-node": "^9.1.1", "typescript": "^4.1.3", "vite": "^2.2.3", "vue-tsc": "^0.1.0" diff --git a/web/yarn.lock b/web/yarn.lock index 351ff9d..d123f24 100644 --- a/web/yarn.lock +++ b/web/yarn.lock @@ -222,26 +222,6 @@ dependencies: defer-to-connect "^1.0.1" -"@tsconfig/node10@^1.0.7": - version "1.0.7" - resolved "https://registry.yarnpkg.com/@tsconfig/node10/-/node10-1.0.7.tgz#1eb1de36c73478a2479cc661ef5af1c16d86d606" - integrity sha512-aBvUmXLQbayM4w3A8TrjwrXs4DZ8iduJnuJLLRGdkWlyakCf1q6uHZJBzXoRA/huAEknG5tcUyQxN3A+In5euQ== - -"@tsconfig/node12@^1.0.7": - version "1.0.7" - resolved "https://registry.yarnpkg.com/@tsconfig/node12/-/node12-1.0.7.tgz#677bd9117e8164dc319987dd6ff5fc1ba6fbf18b" - integrity sha512-dgasobK/Y0wVMswcipr3k0HpevxFJLijN03A8mYfEPvWvOs14v0ZlYTR4kIgMx8g4+fTyTFv8/jLCIfRqLDJ4A== - -"@tsconfig/node14@^1.0.0": - version "1.0.0" - resolved "https://registry.yarnpkg.com/@tsconfig/node14/-/node14-1.0.0.tgz#5bd046e508b1ee90bc091766758838741fdefd6e" - integrity sha512-RKkL8eTdPv6t5EHgFKIVQgsDapugbuOptNd9OOunN/HAkzmmTnZELx1kNCK0rSdUYGmiFMM3rRQMAWiyp023LQ== - -"@tsconfig/node16@^1.0.1": - version "1.0.1" - resolved "https://registry.yarnpkg.com/@tsconfig/node16/-/node16-1.0.1.tgz#a6ca6a9a0ff366af433f42f5f0e124794ff6b8f1" - integrity sha512-FTgBI767POY/lKNDNbIzgAX6miIDBs6NTCbdlDb8TrWovHsSvaVIZDlTqym29C6UqhzwcJx4CYr+AlrMywA0cA== - "@types/chai@^4.2.18": version "4.2.18" resolved "https://registry.yarnpkg.com/@types/chai/-/chai-4.2.18.tgz#0c8e298dbff8205e2266606c1ea5fbdba29b46e4" @@ -1325,10 +1305,10 @@ eslint-plugin-node@^11.1.0: resolve "^1.10.1" semver "^6.1.0" -eslint-plugin-promise@^5.0.0: - version "5.1.0" - resolved "https://registry.yarnpkg.com/eslint-plugin-promise/-/eslint-plugin-promise-5.1.0.tgz#fb2188fb734e4557993733b41aa1a688f46c6f24" - integrity sha512-NGmI6BH5L12pl7ScQHbg7tvtk4wPxxj8yPHH47NvSmMtFneC077PSeY3huFj06ZWZvtbfxSPt3RuOQD5XcR4ng== +eslint-plugin-promise@^4.3.1: + version "4.3.1" + resolved "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-4.3.1.tgz" + integrity sha512-bY2sGqyptzFBDLh/GMbAxfdJC+b0f23ME63FOE4+Jao0oZ3E1LEwFtWJX/1pGMJLiTtrSSern2CRM/g+dfc0eQ== eslint-plugin-vue@^7.9.0: version "7.9.0" @@ -3504,15 +3484,11 @@ trough@^1.0.0: resolved "https://registry.npmjs.org/trough/-/trough-1.0.5.tgz" integrity sha512-rvuRbTarPXmMb79SmzEp8aqXNKcK+y0XaB298IXueQ8I2PsrATcPBCSPyK/dDNa2iWOhKlfNnOjdAOTBU/nkFA== -ts-node@^10.0.0: - version "10.0.0" - resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.0.0.tgz#05f10b9a716b0b624129ad44f0ea05dac84ba3be" - integrity sha512-ROWeOIUvfFbPZkoDis0L/55Fk+6gFQNZwwKPLinacRl6tsxstTF1DbAcLKkovwnpKMVvOMHP1TIbnwXwtLg1gg== +ts-node@^9.1.1: + version "9.1.1" + resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-9.1.1.tgz#51a9a450a3e959401bda5f004a72d54b936d376d" + integrity sha512-hPlt7ZACERQGf03M253ytLY3dHbGNGrAq9qIHWUY9XHYl1z7wYngSr3OQ5xmui8o2AaxsONxIzjafLUiWBo1Fg== dependencies: - "@tsconfig/node10" "^1.0.7" - "@tsconfig/node12" "^1.0.7" - "@tsconfig/node14" "^1.0.0" - "@tsconfig/node16" "^1.0.1" arg "^4.1.0" create-require "^1.1.0" diff "^4.0.1"