From b5696a6a1eebb13723672d4c057b5deaa953362e Mon Sep 17 00:00:00 2001 From: Raissa Barbosa Date: Mon, 24 Apr 2023 17:54:46 -0400 Subject: [PATCH 01/12] Wavy one and wavy 2 done --- app/__init__.py | 5 ++++- app/routes.py | 51 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..490a7a8fe 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,4 +4,7 @@ def create_app(test_config=None): app = Flask(__name__) - return app + from .routes import planet_bp + app.register_blueprint(planet_bp) + + return app \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..a65e5b683 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,53 @@ from flask import Blueprint +from flask import Blueprint, jsonify, abort, make_response +class Planet: + def __init__(self, id, name, description, diameter): + self.id = id + self.name = name + self.description = description + self.diameter = diameter + + def make_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + diameter=self.diameter + ) + + +planets = [ + Planet(1, "Mercury", "smallest planet", 3031.9), + Planet(2, "Venus", "hottest planet", 7520.8), + Planet(3, "Earth", "home planet", 7917.5), + Planet(4, "Mars", "red planet", 4212.3), + Planet(5, "Jupiter", "biggest planet", 86881), + Planet(6, "Saturn", "ringed planet", 72367), + Planet(7, "Neptune", "blue planet", 30599), + Planet(8, "Uranus", "furthest planet", 31518) +] + +planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + +@planet_bp.route("", methods=["GET"]) +def read_planets(): + planet_list = [planet.make_dict() for planet in planets] + return jsonify(planet_list) + +@planet_bp.route("/", methods=["GET"]) +def handle_planet(planet_id): + planet = validate_planet(planet_id) + return planet + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except ValueError: + abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) + + for planet in planets: + if planet_id == planet.id: + return planet.make_dict() + + abort(make_response({"message": f"planet {planet_id} not found"}, 404)) \ No newline at end of file From d0cc07a7dc04cd4191f8d912aaccb3bf4b5d8406 Mon Sep 17 00:00:00 2001 From: Raissa Barbosa Date: Fri, 28 Apr 2023 15:07:59 -0400 Subject: [PATCH 02/12] init db is alredy running --- -/bin/Activate.ps1 | 247 ++++++++++++++++++ -/bin/activate | 69 +++++ -/bin/activate.csh | 26 ++ -/bin/activate.fish | 69 +++++ -/bin/pip | 8 + -/bin/pip3 | 8 + -/bin/pip3.10 | 8 + -/bin/python | 1 + -/bin/python3 | 1 + -/bin/python3.10 | 1 + -/pyvenv.cfg | 3 + app/__init__.py | 14 + app/models/__init__.py | 0 app/models/planet.py | 9 + app/routes.py | 156 +++++++---- migrations/README | 1 + migrations/alembic.ini | 45 ++++ migrations/env.py | 96 +++++++ migrations/script.py.mako | 24 ++ .../a3873e9e775e_adds_planets_model.py | 34 +++ 20 files changed, 774 insertions(+), 46 deletions(-) create mode 100644 -/bin/Activate.ps1 create mode 100644 -/bin/activate create mode 100644 -/bin/activate.csh create mode 100644 -/bin/activate.fish create mode 100755 -/bin/pip create mode 100755 -/bin/pip3 create mode 100755 -/bin/pip3.10 create mode 120000 -/bin/python create mode 120000 -/bin/python3 create mode 120000 -/bin/python3.10 create mode 100644 -/pyvenv.cfg create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.py create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/a3873e9e775e_adds_planets_model.py diff --git a/-/bin/Activate.ps1 b/-/bin/Activate.ps1 new file mode 100644 index 000000000..b49d77ba4 --- /dev/null +++ b/-/bin/Activate.ps1 @@ -0,0 +1,247 @@ +<# +.Synopsis +Activate a Python virtual environment for the current PowerShell session. + +.Description +Pushes the python executable for a virtual environment to the front of the +$Env:PATH environment variable and sets the prompt to signify that you are +in a Python virtual environment. Makes use of the command line switches as +well as the `pyvenv.cfg` file values present in the virtual environment. + +.Parameter VenvDir +Path to the directory that contains the virtual environment to activate. The +default value for this is the parent of the directory that the Activate.ps1 +script is located within. + +.Parameter Prompt +The prompt prefix to display when this virtual environment is activated. By +default, this prompt is the name of the virtual environment folder (VenvDir) +surrounded by parentheses and followed by a single space (ie. '(.venv) '). + +.Example +Activate.ps1 +Activates the Python virtual environment that contains the Activate.ps1 script. + +.Example +Activate.ps1 -Verbose +Activates the Python virtual environment that contains the Activate.ps1 script, +and shows extra information about the activation as it executes. + +.Example +Activate.ps1 -VenvDir C:\Users\MyUser\Common\.venv +Activates the Python virtual environment located in the specified location. + +.Example +Activate.ps1 -Prompt "MyPython" +Activates the Python virtual environment that contains the Activate.ps1 script, +and prefixes the current prompt with the specified string (surrounded in +parentheses) while the virtual environment is active. + +.Notes +On Windows, it may be required to enable this Activate.ps1 script by setting the +execution policy for the user. You can do this by issuing the following PowerShell +command: + +PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser + +For more information on Execution Policies: +https://go.microsoft.com/fwlink/?LinkID=135170 + +#> +Param( + [Parameter(Mandatory = $false)] + [String] + $VenvDir, + [Parameter(Mandatory = $false)] + [String] + $Prompt +) + +<# Function declarations --------------------------------------------------- #> + +<# +.Synopsis +Remove all shell session elements added by the Activate script, including the +addition of the virtual environment's Python executable from the beginning of +the PATH variable. + +.Parameter NonDestructive +If present, do not remove this function from the global namespace for the +session. + +#> +function global:deactivate ([switch]$NonDestructive) { + # Revert to original values + + # The prior prompt: + if (Test-Path -Path Function:_OLD_VIRTUAL_PROMPT) { + Copy-Item -Path Function:_OLD_VIRTUAL_PROMPT -Destination Function:prompt + Remove-Item -Path Function:_OLD_VIRTUAL_PROMPT + } + + # The prior PYTHONHOME: + if (Test-Path -Path Env:_OLD_VIRTUAL_PYTHONHOME) { + Copy-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME -Destination Env:PYTHONHOME + Remove-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME + } + + # The prior PATH: + if (Test-Path -Path Env:_OLD_VIRTUAL_PATH) { + Copy-Item -Path Env:_OLD_VIRTUAL_PATH -Destination Env:PATH + Remove-Item -Path Env:_OLD_VIRTUAL_PATH + } + + # Just remove the VIRTUAL_ENV altogether: + if (Test-Path -Path Env:VIRTUAL_ENV) { + Remove-Item -Path env:VIRTUAL_ENV + } + + # Just remove VIRTUAL_ENV_PROMPT altogether. + if (Test-Path -Path Env:VIRTUAL_ENV_PROMPT) { + Remove-Item -Path env:VIRTUAL_ENV_PROMPT + } + + # Just remove the _PYTHON_VENV_PROMPT_PREFIX altogether: + if (Get-Variable -Name "_PYTHON_VENV_PROMPT_PREFIX" -ErrorAction SilentlyContinue) { + Remove-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Scope Global -Force + } + + # Leave deactivate function in the global namespace if requested: + if (-not $NonDestructive) { + Remove-Item -Path function:deactivate + } +} + +<# +.Description +Get-PyVenvConfig parses the values from the pyvenv.cfg file located in the +given folder, and returns them in a map. + +For each line in the pyvenv.cfg file, if that line can be parsed into exactly +two strings separated by `=` (with any amount of whitespace surrounding the =) +then it is considered a `key = value` line. The left hand string is the key, +the right hand is the value. + +If the value starts with a `'` or a `"` then the first and last character is +stripped from the value before being captured. + +.Parameter ConfigDir +Path to the directory that contains the `pyvenv.cfg` file. +#> +function Get-PyVenvConfig( + [String] + $ConfigDir +) { + Write-Verbose "Given ConfigDir=$ConfigDir, obtain values in pyvenv.cfg" + + # Ensure the file exists, and issue a warning if it doesn't (but still allow the function to continue). + $pyvenvConfigPath = Join-Path -Resolve -Path $ConfigDir -ChildPath 'pyvenv.cfg' -ErrorAction Continue + + # An empty map will be returned if no config file is found. + $pyvenvConfig = @{ } + + if ($pyvenvConfigPath) { + + Write-Verbose "File exists, parse `key = value` lines" + $pyvenvConfigContent = Get-Content -Path $pyvenvConfigPath + + $pyvenvConfigContent | ForEach-Object { + $keyval = $PSItem -split "\s*=\s*", 2 + if ($keyval[0] -and $keyval[1]) { + $val = $keyval[1] + + # Remove extraneous quotations around a string value. + if ("'""".Contains($val.Substring(0, 1))) { + $val = $val.Substring(1, $val.Length - 2) + } + + $pyvenvConfig[$keyval[0]] = $val + Write-Verbose "Adding Key: '$($keyval[0])'='$val'" + } + } + } + return $pyvenvConfig +} + + +<# Begin Activate script --------------------------------------------------- #> + +# Determine the containing directory of this script +$VenvExecPath = Split-Path -Parent $MyInvocation.MyCommand.Definition +$VenvExecDir = Get-Item -Path $VenvExecPath + +Write-Verbose "Activation script is located in path: '$VenvExecPath'" +Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)" +Write-Verbose "VenvExecDir Name: '$($VenvExecDir.Name)" + +# Set values required in priority: CmdLine, ConfigFile, Default +# First, get the location of the virtual environment, it might not be +# VenvExecDir if specified on the command line. +if ($VenvDir) { + Write-Verbose "VenvDir given as parameter, using '$VenvDir' to determine values" +} +else { + Write-Verbose "VenvDir not given as a parameter, using parent directory name as VenvDir." + $VenvDir = $VenvExecDir.Parent.FullName.TrimEnd("\\/") + Write-Verbose "VenvDir=$VenvDir" +} + +# Next, read the `pyvenv.cfg` file to determine any required value such +# as `prompt`. +$pyvenvCfg = Get-PyVenvConfig -ConfigDir $VenvDir + +# Next, set the prompt from the command line, or the config file, or +# just use the name of the virtual environment folder. +if ($Prompt) { + Write-Verbose "Prompt specified as argument, using '$Prompt'" +} +else { + Write-Verbose "Prompt not specified as argument to script, checking pyvenv.cfg value" + if ($pyvenvCfg -and $pyvenvCfg['prompt']) { + Write-Verbose " Setting based on value in pyvenv.cfg='$($pyvenvCfg['prompt'])'" + $Prompt = $pyvenvCfg['prompt']; + } + else { + Write-Verbose " Setting prompt based on parent's directory's name. (Is the directory name passed to venv module when creating the virtual environment)" + Write-Verbose " Got leaf-name of $VenvDir='$(Split-Path -Path $venvDir -Leaf)'" + $Prompt = Split-Path -Path $venvDir -Leaf + } +} + +Write-Verbose "Prompt = '$Prompt'" +Write-Verbose "VenvDir='$VenvDir'" + +# Deactivate any currently active virtual environment, but leave the +# deactivate function in place. +deactivate -nondestructive + +# Now set the environment variable VIRTUAL_ENV, used by many tools to determine +# that there is an activated venv. +$env:VIRTUAL_ENV = $VenvDir + +if (-not $Env:VIRTUAL_ENV_DISABLE_PROMPT) { + + Write-Verbose "Setting prompt to '$Prompt'" + + # Set the prompt to include the env name + # Make sure _OLD_VIRTUAL_PROMPT is global + function global:_OLD_VIRTUAL_PROMPT { "" } + Copy-Item -Path function:prompt -Destination function:_OLD_VIRTUAL_PROMPT + New-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Description "Python virtual environment prompt prefix" -Scope Global -Option ReadOnly -Visibility Public -Value $Prompt + + function global:prompt { + Write-Host -NoNewline -ForegroundColor Green "($_PYTHON_VENV_PROMPT_PREFIX) " + _OLD_VIRTUAL_PROMPT + } + $env:VIRTUAL_ENV_PROMPT = $Prompt +} + +# Clear PYTHONHOME +if (Test-Path -Path Env:PYTHONHOME) { + Copy-Item -Path Env:PYTHONHOME -Destination Env:_OLD_VIRTUAL_PYTHONHOME + Remove-Item -Path Env:PYTHONHOME +} + +# Add the venv to the PATH +Copy-Item -Path Env:PATH -Destination Env:_OLD_VIRTUAL_PATH +$Env:PATH = "$VenvExecDir$([System.IO.Path]::PathSeparator)$Env:PATH" diff --git a/-/bin/activate b/-/bin/activate new file mode 100644 index 000000000..6abe3319b --- /dev/null +++ b/-/bin/activate @@ -0,0 +1,69 @@ +# This file must be used with "source bin/activate" *from bash* +# you cannot run it directly + +deactivate () { + # reset old environment variables + if [ -n "${_OLD_VIRTUAL_PATH:-}" ] ; then + PATH="${_OLD_VIRTUAL_PATH:-}" + export PATH + unset _OLD_VIRTUAL_PATH + fi + if [ -n "${_OLD_VIRTUAL_PYTHONHOME:-}" ] ; then + PYTHONHOME="${_OLD_VIRTUAL_PYTHONHOME:-}" + export PYTHONHOME + unset _OLD_VIRTUAL_PYTHONHOME + fi + + # This should detect bash and zsh, which have a hash command that must + # be called to get it to forget past commands. Without forgetting + # past commands the $PATH changes we made may not be respected + if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then + hash -r 2> /dev/null + fi + + if [ -n "${_OLD_VIRTUAL_PS1:-}" ] ; then + PS1="${_OLD_VIRTUAL_PS1:-}" + export PS1 + unset _OLD_VIRTUAL_PS1 + fi + + unset VIRTUAL_ENV + unset VIRTUAL_ENV_PROMPT + if [ ! "${1:-}" = "nondestructive" ] ; then + # Self destruct! + unset -f deactivate + fi +} + +# unset irrelevant variables +deactivate nondestructive + +VIRTUAL_ENV="/Users/raissa/ada/project/solar-system-api/-" +export VIRTUAL_ENV + +_OLD_VIRTUAL_PATH="$PATH" +PATH="$VIRTUAL_ENV/bin:$PATH" +export PATH + +# unset PYTHONHOME if set +# this will fail if PYTHONHOME is set to the empty string (which is bad anyway) +# could use `if (set -u; : $PYTHONHOME) ;` in bash +if [ -n "${PYTHONHOME:-}" ] ; then + _OLD_VIRTUAL_PYTHONHOME="${PYTHONHOME:-}" + unset PYTHONHOME +fi + +if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT:-}" ] ; then + _OLD_VIRTUAL_PS1="${PS1:-}" + PS1="(-) ${PS1:-}" + export PS1 + VIRTUAL_ENV_PROMPT="(-) " + export VIRTUAL_ENV_PROMPT +fi + +# This should detect bash and zsh, which have a hash command that must +# be called to get it to forget past commands. Without forgetting +# past commands the $PATH changes we made may not be respected +if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then + hash -r 2> /dev/null +fi diff --git a/-/bin/activate.csh b/-/bin/activate.csh new file mode 100644 index 000000000..c501ecd6e --- /dev/null +++ b/-/bin/activate.csh @@ -0,0 +1,26 @@ +# This file must be used with "source bin/activate.csh" *from csh*. +# You cannot run it directly. +# Created by Davide Di Blasi . +# Ported to Python 3.3 venv by Andrew Svetlov + +alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PATH" && unset _OLD_VIRTUAL_PATH; rehash; test $?_OLD_VIRTUAL_PROMPT != 0 && set prompt="$_OLD_VIRTUAL_PROMPT" && unset _OLD_VIRTUAL_PROMPT; unsetenv VIRTUAL_ENV; unsetenv VIRTUAL_ENV_PROMPT; test "\!:*" != "nondestructive" && unalias deactivate' + +# Unset irrelevant variables. +deactivate nondestructive + +setenv VIRTUAL_ENV "/Users/raissa/ada/project/solar-system-api/-" + +set _OLD_VIRTUAL_PATH="$PATH" +setenv PATH "$VIRTUAL_ENV/bin:$PATH" + + +set _OLD_VIRTUAL_PROMPT="$prompt" + +if (! "$?VIRTUAL_ENV_DISABLE_PROMPT") then + set prompt = "(-) $prompt" + setenv VIRTUAL_ENV_PROMPT "(-) " +endif + +alias pydoc python -m pydoc + +rehash diff --git a/-/bin/activate.fish b/-/bin/activate.fish new file mode 100644 index 000000000..19776d333 --- /dev/null +++ b/-/bin/activate.fish @@ -0,0 +1,69 @@ +# This file must be used with "source /bin/activate.fish" *from fish* +# (https://fishshell.com/); you cannot run it directly. + +function deactivate -d "Exit virtual environment and return to normal shell environment" + # reset old environment variables + if test -n "$_OLD_VIRTUAL_PATH" + set -gx PATH $_OLD_VIRTUAL_PATH + set -e _OLD_VIRTUAL_PATH + end + if test -n "$_OLD_VIRTUAL_PYTHONHOME" + set -gx PYTHONHOME $_OLD_VIRTUAL_PYTHONHOME + set -e _OLD_VIRTUAL_PYTHONHOME + end + + if test -n "$_OLD_FISH_PROMPT_OVERRIDE" + set -e _OLD_FISH_PROMPT_OVERRIDE + # prevents error when using nested fish instances (Issue #93858) + if functions -q _old_fish_prompt + functions -e fish_prompt + functions -c _old_fish_prompt fish_prompt + functions -e _old_fish_prompt + end + end + + set -e VIRTUAL_ENV + set -e VIRTUAL_ENV_PROMPT + if test "$argv[1]" != "nondestructive" + # Self-destruct! + functions -e deactivate + end +end + +# Unset irrelevant variables. +deactivate nondestructive + +set -gx VIRTUAL_ENV "/Users/raissa/ada/project/solar-system-api/-" + +set -gx _OLD_VIRTUAL_PATH $PATH +set -gx PATH "$VIRTUAL_ENV/bin" $PATH + +# Unset PYTHONHOME if set. +if set -q PYTHONHOME + set -gx _OLD_VIRTUAL_PYTHONHOME $PYTHONHOME + set -e PYTHONHOME +end + +if test -z "$VIRTUAL_ENV_DISABLE_PROMPT" + # fish uses a function instead of an env var to generate the prompt. + + # Save the current fish_prompt function as the function _old_fish_prompt. + functions -c fish_prompt _old_fish_prompt + + # With the original prompt function renamed, we can override with our own. + function fish_prompt + # Save the return status of the last command. + set -l old_status $status + + # Output the venv prompt; color taken from the blue of the Python logo. + printf "%s%s%s" (set_color 4B8BBE) "(-) " (set_color normal) + + # Restore the return status of the previous command. + echo "exit $old_status" | . + # Output the original/"old" prompt. + _old_fish_prompt + end + + set -gx _OLD_FISH_PROMPT_OVERRIDE "$VIRTUAL_ENV" + set -gx VIRTUAL_ENV_PROMPT "(-) " +end diff --git a/-/bin/pip b/-/bin/pip new file mode 100755 index 000000000..c84dc4257 --- /dev/null +++ b/-/bin/pip @@ -0,0 +1,8 @@ +#!/Users/raissa/ada/project/solar-system-api/-/bin/python3.10 +# -*- coding: utf-8 -*- +import re +import sys +from pip._internal.cli.main import main +if __name__ == '__main__': + sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) + sys.exit(main()) diff --git a/-/bin/pip3 b/-/bin/pip3 new file mode 100755 index 000000000..c84dc4257 --- /dev/null +++ b/-/bin/pip3 @@ -0,0 +1,8 @@ +#!/Users/raissa/ada/project/solar-system-api/-/bin/python3.10 +# -*- coding: utf-8 -*- +import re +import sys +from pip._internal.cli.main import main +if __name__ == '__main__': + sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) + sys.exit(main()) diff --git a/-/bin/pip3.10 b/-/bin/pip3.10 new file mode 100755 index 000000000..c84dc4257 --- /dev/null +++ b/-/bin/pip3.10 @@ -0,0 +1,8 @@ +#!/Users/raissa/ada/project/solar-system-api/-/bin/python3.10 +# -*- coding: utf-8 -*- +import re +import sys +from pip._internal.cli.main import main +if __name__ == '__main__': + sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) + sys.exit(main()) diff --git a/-/bin/python b/-/bin/python new file mode 120000 index 000000000..c3cc99197 --- /dev/null +++ b/-/bin/python @@ -0,0 +1 @@ +python3.10 \ No newline at end of file diff --git a/-/bin/python3 b/-/bin/python3 new file mode 120000 index 000000000..c3cc99197 --- /dev/null +++ b/-/bin/python3 @@ -0,0 +1 @@ +python3.10 \ No newline at end of file diff --git a/-/bin/python3.10 b/-/bin/python3.10 new file mode 120000 index 000000000..76f29a695 --- /dev/null +++ b/-/bin/python3.10 @@ -0,0 +1 @@ +/opt/homebrew/opt/python@3.10/bin/python3.10 \ No newline at end of file diff --git a/-/pyvenv.cfg b/-/pyvenv.cfg new file mode 100644 index 000000000..4ae9770f4 --- /dev/null +++ b/-/pyvenv.cfg @@ -0,0 +1,3 @@ +home = /opt/homebrew/opt/python@3.10/bin +include-system-site-packages = false +version = 3.10.9 diff --git a/app/__init__.py b/app/__init__.py index 490a7a8fe..b0daa9dd4 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,9 +1,23 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +db = SQLAlchemy() +migrate = Migrate() + def create_app(test_config=None): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + + db.init_app(app) + migrate.init_app(app, db) + + + from app.models.planet import Planet + from .routes import planet_bp app.register_blueprint(planet_bp) diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..b44179c79 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,9 @@ +from app import db + + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + description = db.Column(db.String) + diameter= db.Column(db.Float) + __tablename__ = "Planets" \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index a65e5b683..80e07e64c 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,53 +1,117 @@ -from flask import Blueprint -from flask import Blueprint, jsonify, abort, make_response - -class Planet: - def __init__(self, id, name, description, diameter): - self.id = id - self.name = name - self.description = description - self.diameter = diameter - - def make_dict(self): - return dict( - id=self.id, - name=self.name, - description=self.description, - diameter=self.diameter - ) - - -planets = [ - Planet(1, "Mercury", "smallest planet", 3031.9), - Planet(2, "Venus", "hottest planet", 7520.8), - Planet(3, "Earth", "home planet", 7917.5), - Planet(4, "Mars", "red planet", 4212.3), - Planet(5, "Jupiter", "biggest planet", 86881), - Planet(6, "Saturn", "ringed planet", 72367), - Planet(7, "Neptune", "blue planet", 30599), - Planet(8, "Uranus", "furthest planet", 31518) -] +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request planet_bp = Blueprint("planet", __name__, url_prefix="/planets") -@planet_bp.route("", methods=["GET"]) -def read_planets(): - planet_list = [planet.make_dict() for planet in planets] - return jsonify(planet_list) -@planet_bp.route("/", methods=["GET"]) -def handle_planet(planet_id): - planet = validate_planet(planet_id) - return planet -def validate_planet(planet_id): - try: - planet_id = int(planet_id) - except ValueError: - abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) - for planet in planets: - if planet_id == planet.id: - return planet.make_dict() - abort(make_response({"message": f"planet {planet_id} not found"}, 404)) \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + +# @planet_bp.route("", methods=["POST"]) +# def create_planet(): +# request_body = request.get_json() +# new_planet = Planet(name=request_body["name"], +# description=request_body["description"], +# diameter=request_body["diameter"]) + +# db.session.add(new_planet) +# db.session.commit() + +# return make_response(f"Planet {new_planet.name} successfully created", 201) + +# @planet_bp.route("", methods=["GET"]) +# def read_all_planets(): +# planets_response = [] +# planets = Planet.query.all() +# for planet in planets: +# planets_response.append( +# { +# "id": planet.id, +# "title": planet.name, +# "description": planet.description, +# "diameter": planet.diameter +# } +# ) +# return jsonify(planets_response) + + + + + + + + +# class Planet: +# def __init__(self, id, name, description, diameter): +# self.id = id +# self.name = name +# self.description = description +# self.diameter = diameter + +# def make_dict(self): +# return dict( +# id=self.id, +# name=self.name, +# description=self.description, +# diameter=self.diameter +# ) + + +# planets = [ +# Planet(1, "Mercury", "smallest planet", 3031.9), +# Planet(2, "Venus", "hottest planet", 7520.8), +# Planet(3, "Earth", "home planet", 7917.5), +# Planet(4, "Mars", "red planet", 4212.3), +# Planet(5, "Jupiter", "biggest planet", 86881), +# Planet(6, "Saturn", "ringed planet", 72367), +# Planet(7, "Neptune", "blue planet", 30599), +# Planet(8, "Uranus", "furthest planet", 31518) +# ] + +# planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + +# @planet_bp.route("", methods=["GET"]) +# def read_planets(): +# planet_list = [planet.make_dict() for planet in planets] +# return jsonify(planet_list) + +# @planet_bp.route("/", methods=["GET"]) +# def handle_planet(planet_id): +# planet = validate_planet(planet_id) +# return planet + +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except ValueError: +# abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) + +# for planet in planets: +# if planet_id == planet.id: +# return planet.make_dict() + +# abort(make_response({"message": f"planet {planet_id} not found"}, 404)) \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..f8ed4801f --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,45 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..8b3fb3353 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,96 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option( + 'sqlalchemy.url', + str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) +target_metadata = current_app.extensions['migrate'].db.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=target_metadata, literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/migrations/versions/a3873e9e775e_adds_planets_model.py b/migrations/versions/a3873e9e775e_adds_planets_model.py new file mode 100644 index 000000000..c955962e4 --- /dev/null +++ b/migrations/versions/a3873e9e775e_adds_planets_model.py @@ -0,0 +1,34 @@ +"""adds Planets model + +Revision ID: a3873e9e775e +Revises: +Create Date: 2023-04-28 14:08:46.691527 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a3873e9e775e' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('Planets', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('diameter', sa.Numeric(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('Planets') + # ### end Alembic commands ### From 64c462ccbe1462706b81b3a1de627e6e895532b7 Mon Sep 17 00:00:00 2001 From: liz Date: Tue, 2 May 2023 10:48:37 -0700 Subject: [PATCH 03/12] wave 3 & wave 4 --- app/__init__.py | 2 +- app/models/planet.py | 10 +- app/routes.py | 181 +++++++----------- migrations/README | 2 +- migrations/alembic.ini | 7 +- migrations/env.py | 11 +- ...py => 0a6971d40876_create_planet_table.py} | 10 +- 7 files changed, 95 insertions(+), 128 deletions(-) rename migrations/versions/{a3873e9e775e_adds_planets_model.py => 0a6971d40876_create_planet_table.py} (80%) diff --git a/app/__init__.py b/app/__init__.py index b0daa9dd4..76fd77f8d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -11,7 +11,7 @@ def create_app(test_config=None): app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' - + app.config['JSON_SORT_KEYS'] = False db.init_app(app) migrate.init_app(app, db) diff --git a/app/models/planet.py b/app/models/planet.py index b44179c79..e0db101b9 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -6,4 +6,12 @@ class Planet(db.Model): name = db.Column(db.String) description = db.Column(db.String) diameter= db.Column(db.Float) - __tablename__ = "Planets" \ No newline at end of file + __tablename__ = "Planets" + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "diameter": self.diameter + } \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 80e07e64c..c808bc92f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,117 +1,76 @@ from app import db from app.models.planet import Planet -from flask import Blueprint, jsonify, make_response, request +from flask import Blueprint, jsonify, make_response, request, abort planet_bp = Blueprint("planet", __name__, url_prefix="/planets") - - - - - - - - - - - - - - - - - - - - - - - - - - -# @planet_bp.route("", methods=["POST"]) -# def create_planet(): -# request_body = request.get_json() -# new_planet = Planet(name=request_body["name"], -# description=request_body["description"], -# diameter=request_body["diameter"]) - -# db.session.add(new_planet) -# db.session.commit() - -# return make_response(f"Planet {new_planet.name} successfully created", 201) - -# @planet_bp.route("", methods=["GET"]) -# def read_all_planets(): -# planets_response = [] -# planets = Planet.query.all() -# for planet in planets: -# planets_response.append( -# { -# "id": planet.id, -# "title": planet.name, -# "description": planet.description, -# "diameter": planet.diameter -# } -# ) -# return jsonify(planets_response) - - - - - - - - -# class Planet: -# def __init__(self, id, name, description, diameter): -# self.id = id -# self.name = name -# self.description = description -# self.diameter = diameter - -# def make_dict(self): -# return dict( -# id=self.id, -# name=self.name, -# description=self.description, -# diameter=self.diameter -# ) - - -# planets = [ -# Planet(1, "Mercury", "smallest planet", 3031.9), -# Planet(2, "Venus", "hottest planet", 7520.8), -# Planet(3, "Earth", "home planet", 7917.5), -# Planet(4, "Mars", "red planet", 4212.3), -# Planet(5, "Jupiter", "biggest planet", 86881), -# Planet(6, "Saturn", "ringed planet", 72367), -# Planet(7, "Neptune", "blue planet", 30599), -# Planet(8, "Uranus", "furthest planet", 31518) -# ] - -# planet_bp = Blueprint("planet", __name__, url_prefix="/planets") - -# @planet_bp.route("", methods=["GET"]) -# def read_planets(): -# planet_list = [planet.make_dict() for planet in planets] -# return jsonify(planet_list) - -# @planet_bp.route("/", methods=["GET"]) -# def handle_planet(planet_id): -# planet = validate_planet(planet_id) -# return planet - -# def validate_planet(planet_id): -# try: -# planet_id = int(planet_id) -# except ValueError: -# abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) - -# for planet in planets: -# if planet_id == planet.id: -# return planet.make_dict() - -# abort(make_response({"message": f"planet {planet_id} not found"}, 404)) \ No newline at end of file +@planet_bp.route("", methods=["POST"]) +def create_planet(): + data = request.json + + planet = Planet( + name=data['name'], + description=data['description'], + diameter=data['diameter'] + ) + + db.session.add(planet) + db.session.commit() + + return make_response(f"Planet {planet.name} successfully created", 201) + +@planet_bp.route("", methods=['GET']) +def get_planets(): + planets = Planet.query.all() + + planet_list = [planet.to_dict() for planet in planets] + + return jsonify(planet_list) + +def validate_planet(id): + try: + id = int(id) + except: + message = f"planet {id} is invalid" + abort(make_response({"message": message}, 400)) + + planet = Planet.query.get(id) + + if not planet: + message = f"planet {id} not found" + abort(make_response({"message": message}, 404)) + +@planet_bp.route("/", methods=['GET']) +def get_planet(planet_id): + planet = Planet.query.get(planet_id) + if planet: + return planet.to_dict() + else: + return make_response(f"Planet {planet_id} not found", 404) + +@planet_bp.route("/", methods=['PUT']) +def update_planet(planet_id): + planet = Planet.query.get(planet_id) + + if not planet: + return make_response(f"Planet {planet_id} not found", 404) + + data = request.json + planet.name = data['name'] + planet.description = data['description'] + planet.diameter = data['diameter'] + db.session.commit() + + return make_response(f"Planet {planet_id} successfully updated", 200) + +@planet_bp.route("/", methods=['DELETE']) +def delete_planet(planet_id): + planet = Planet.query.get(planet_id) + if not planet: + return make_response(f"Planet {planet_id} not found", 404) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet {planet_id} successfully deleted", 200) \ No newline at end of file diff --git a/migrations/README b/migrations/README index 98e4f9c44..0e0484415 100644 --- a/migrations/README +++ b/migrations/README @@ -1 +1 @@ -Generic single-database configuration. \ No newline at end of file +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini index f8ed4801f..ec9d45c26 100644 --- a/migrations/alembic.ini +++ b/migrations/alembic.ini @@ -11,7 +11,7 @@ # Logging configuration [loggers] -keys = root,sqlalchemy,alembic +keys = root,sqlalchemy,alembic,flask_migrate [handlers] keys = console @@ -34,6 +34,11 @@ level = INFO handlers = qualname = alembic +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + [handler_console] class = StreamHandler args = (sys.stderr,) diff --git a/migrations/env.py b/migrations/env.py index 8b3fb3353..68feded2a 100644 --- a/migrations/env.py +++ b/migrations/env.py @@ -3,8 +3,6 @@ import logging from logging.config import fileConfig -from sqlalchemy import engine_from_config -from sqlalchemy import pool from flask import current_app from alembic import context @@ -24,7 +22,8 @@ # target_metadata = mymodel.Base.metadata config.set_main_option( 'sqlalchemy.url', - str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) + str(current_app.extensions['migrate'].db.get_engine().url).replace( + '%', '%%')) target_metadata = current_app.extensions['migrate'].db.metadata # other values from the config, defined by the needs of env.py, @@ -72,11 +71,7 @@ def process_revision_directives(context, revision, directives): directives[:] = [] logger.info('No changes in schema detected.') - connectable = engine_from_config( - config.get_section(config.config_ini_section), - prefix='sqlalchemy.', - poolclass=pool.NullPool, - ) + connectable = current_app.extensions['migrate'].db.get_engine() with connectable.connect() as connection: context.configure( diff --git a/migrations/versions/a3873e9e775e_adds_planets_model.py b/migrations/versions/0a6971d40876_create_planet_table.py similarity index 80% rename from migrations/versions/a3873e9e775e_adds_planets_model.py rename to migrations/versions/0a6971d40876_create_planet_table.py index c955962e4..49016055b 100644 --- a/migrations/versions/a3873e9e775e_adds_planets_model.py +++ b/migrations/versions/0a6971d40876_create_planet_table.py @@ -1,8 +1,8 @@ -"""adds Planets model +"""Create planet table -Revision ID: a3873e9e775e +Revision ID: 0a6971d40876 Revises: -Create Date: 2023-04-28 14:08:46.691527 +Create Date: 2023-04-29 16:53:27.534489 """ from alembic import op @@ -10,7 +10,7 @@ # revision identifiers, used by Alembic. -revision = 'a3873e9e775e' +revision = '0a6971d40876' down_revision = None branch_labels = None depends_on = None @@ -22,7 +22,7 @@ def upgrade(): sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), sa.Column('name', sa.String(), nullable=True), sa.Column('description', sa.String(), nullable=True), - sa.Column('diameter', sa.Numeric(), nullable=True), + sa.Column('diameter', sa.Float(), nullable=True), sa.PrimaryKeyConstraint('id') ) # ### end Alembic commands ### From af6ace14db66c9045583dce7a741c3da844ee4fc Mon Sep 17 00:00:00 2001 From: Raissa Barbosa Date: Tue, 2 May 2023 13:51:09 -0400 Subject: [PATCH 04/12] my changes --- app/routes.py | 87 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 60 insertions(+), 27 deletions(-) diff --git a/app/routes.py b/app/routes.py index 80e07e64c..7e4ee5787 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,6 +1,6 @@ from app import db from app.models.planet import Planet -from flask import Blueprint, jsonify, make_response, request +from flask import Blueprint, jsonify, make_response, request, abort planet_bp = Blueprint("planet", __name__, url_prefix="/planets") @@ -8,55 +8,88 @@ +@planet_bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planet(name=request_body["name"], + description=request_body["description"], + diameter=request_body["diameter"]) + db.session.add(new_planet) + db.session.commit() + return make_response(f"Planet {new_planet.name} successfully created", 201) +@planet_bp.route("", methods=["GET"]) +def read_all_planets(): + planets_response = [] + planets = Planet.query.all() + for planet in planets: + planets_response.append( + { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter + } + ) + return jsonify(planets_response) +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response(f"Planet {planet_id} invalid", 400)) + planet = Planet.query.get(planet_id) + if not planet: + abort(make_response(f"Planet {planet_id} not found", 404)) + return planet +@planet_bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(planet_id) + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter + } +@planet_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + if "name" not in request_body or "description" not in request_body or "diameter" not in request_body: + return make_response("Incomplete request body", 400) + else: + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.diameter = request_body["diameter"] + db.session.commit() + return make_response(f"Planet #{planet.id} successfully updated", 200) +@planet_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = validate_planet(planet_id) + db.session.delete(planet) + db.session.commit() + return make_response(f"Planet #{planet.id} successfully deleted", 200) -# @planet_bp.route("", methods=["POST"]) -# def create_planet(): -# request_body = request.get_json() -# new_planet = Planet(name=request_body["name"], -# description=request_body["description"], -# diameter=request_body["diameter"]) - -# db.session.add(new_planet) -# db.session.commit() - -# return make_response(f"Planet {new_planet.name} successfully created", 201) - -# @planet_bp.route("", methods=["GET"]) -# def read_all_planets(): -# planets_response = [] -# planets = Planet.query.all() -# for planet in planets: -# planets_response.append( -# { -# "id": planet.id, -# "title": planet.name, -# "description": planet.description, -# "diameter": planet.diameter -# } -# ) -# return jsonify(planets_response) From dabb6aa8db7b79459e66337f881b42eb4c695e8a Mon Sep 17 00:00:00 2001 From: Raissa Barbosa Date: Tue, 2 May 2023 14:09:33 -0400 Subject: [PATCH 05/12] "Changes made" --- app/__init__.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 76fd77f8d..3321b9a39 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -11,7 +11,7 @@ def create_app(test_config=None): app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' - app.config['JSON_SORT_KEYS'] = False + db.init_app(app) migrate.init_app(app, db) @@ -21,4 +21,5 @@ def create_app(test_config=None): from .routes import planet_bp app.register_blueprint(planet_bp) - return app \ No newline at end of file + return app + From 501c97fc6f4a57482256ac3427dcbf9b2f127b5a Mon Sep 17 00:00:00 2001 From: Raissa Barbosa Date: Tue, 2 May 2023 14:18:30 -0400 Subject: [PATCH 06/12] Changed PUT route --- app/routes.py | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/app/routes.py b/app/routes.py index c808bc92f..972fd4389 100644 --- a/app/routes.py +++ b/app/routes.py @@ -49,20 +49,22 @@ def get_planet(planet_id): else: return make_response(f"Planet {planet_id} not found", 404) -@planet_bp.route("/", methods=['PUT']) +@planet_bp.route("/", methods=["PUT"]) def update_planet(planet_id): - planet = Planet.query.get(planet_id) - - if not planet: - return make_response(f"Planet {planet_id} not found", 404) - - data = request.json - planet.name = data['name'] - planet.description = data['description'] - planet.diameter = data['diameter'] - db.session.commit() - - return make_response(f"Planet {planet_id} successfully updated", 200) + planet = validate_planet(planet_id) + request_body = request.get_json() + + if "name" not in request_body or "description" not in \ + request_body or "diameter" not in request_body: + return make_response("Incomplete request body", 400) + else: + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.diameter = request_body["diameter"] + + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully updated", 200) @planet_bp.route("/", methods=['DELETE']) def delete_planet(planet_id): From ef0a78e0348fb9befe05369ed504abe53795e55a Mon Sep 17 00:00:00 2001 From: Raissa Barbosa Date: Wed, 3 May 2023 14:33:37 -0400 Subject: [PATCH 07/12] create env file and test --- app/__init__.py | 15 ++++++++++-- app/routes.py | 8 +++---- app/test/__init__.py | 0 app/test/conftest.py | 45 +++++++++++++++++++++++++++++++++++ app/test/test_routes.py | 52 +++++++++++++++++++++++++++++++++++++++++ requirements.txt | 6 +++++ 6 files changed, 120 insertions(+), 6 deletions(-) create mode 100644 app/test/__init__.py create mode 100644 app/test/conftest.py create mode 100644 app/test/test_routes.py diff --git a/app/__init__.py b/app/__init__.py index 3321b9a39..a62bfed4b 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,16 +1,27 @@ from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate +from dotenv import load_dotenv +import os db = SQLAlchemy() migrate = Migrate() +load_dotenv() def create_app(test_config=None): app = Flask(__name__) - app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + if not test_config: + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "SQLALCHEMY_DATABASE_URI") + + else: + app.config["TESTING"] = True + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( + "SQLALCHEMY_TEST_DATABASE_URI") db.init_app(app) migrate.init_app(app, db) diff --git a/app/routes.py b/app/routes.py index 972fd4389..caadf88b0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -18,7 +18,7 @@ def create_planet(): db.session.add(planet) db.session.commit() - return make_response(f"Planet {planet.name} successfully created", 201) + return make_response(jsonify(f"Planet {planet.name} successfully created", 201)) @planet_bp.route("", methods=['GET']) def get_planets(): @@ -64,15 +64,15 @@ def update_planet(planet_id): db.session.commit() - return make_response(f"Planet #{planet.id} successfully updated", 200) + return make_response(jsonify(f"Planet #{planet.id} successfully updated", 200)) @planet_bp.route("/", methods=['DELETE']) def delete_planet(planet_id): planet = Planet.query.get(planet_id) if not planet: - return make_response(f"Planet {planet_id} not found", 404) + return make_response(jsonify(f"Planet {planet_id} not found", 404)) db.session.delete(planet) db.session.commit() - return make_response(f"Planet {planet_id} successfully deleted", 200) \ No newline at end of file + return make_response(jsonify(f"Planet {planet_id} successfully deleted", 200)) \ No newline at end of file diff --git a/app/test/__init__.py b/app/test/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/test/conftest.py b/app/test/conftest.py new file mode 100644 index 000000000..e50a791f2 --- /dev/null +++ b/app/test/conftest.py @@ -0,0 +1,45 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet + + + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + +@pytest.fixture +def client(app): + return app.test_client() + + +@pytest.fixture +def two_saved_planets(app): + # Arrange + mercury_planet = Planet(name="Mercury", + description="smallest planet", + diameter=3031.9) + jupter_planet = Planet(name="Jupiter", + description="biggest planet", + diameter="86881") + + db.session.add_all([mercury_planet, jupter_planet]) + # Alternatively, we could do + # db.session.add(ocean_book) + # db.session.add(mountain_book) + db.session.commit() + + diff --git a/app/test/test_routes.py b/app/test/test_routes.py new file mode 100644 index 000000000..e657725f8 --- /dev/null +++ b/app/test/test_routes.py @@ -0,0 +1,52 @@ +def test_get_all_planets_with_no_records(client): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + + +def test_get_one_planet(client): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": "", + "name": "", + "description": "", + "diameter": "" + } + + +def test_get_one_planet(client, two_saved_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Mercury", + "description": "smallest planet", + "diameter": 3031.9 + } + + +# def test_create_one_planet(client): +# # Act +# response = client.post("/planets", json={ +# "name": "Jupiter", +# "description": "biggest planet", +# "diameter": 86881 +# }) +# response_body = response.get_json() + +# # Assert +# assert response.status_code == 201 +# assert response_body == "planet Jupiter successfully created" diff --git a/requirements.txt b/requirements.txt index ae59e7b55..966d770b4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,14 +4,19 @@ blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==7.2.3 +exceptiongroup==1.1.1 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 idna==2.10 +iniconfig==2.0.0 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==23.1 +pluggy==1.0.0 psycopg2-binary==2.9.5 pycodestyle==2.6.0 pytest==7.3.1 @@ -23,5 +28,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==1.3.23 toml==0.10.2 +tomli==2.0.1 urllib3==1.26.4 Werkzeug==1.0.1 From 50022536e7e6db37a4a9629f7ca10a2b7100b2d7 Mon Sep 17 00:00:00 2001 From: liz Date: Wed, 3 May 2023 12:31:17 -0700 Subject: [PATCH 08/12] update create_planet() to return correct response --- app/routes.py | 2 +- app/{test => tests}/__init__.py | 0 app/{test => tests}/conftest.py | 0 app/{test => tests}/test_routes.py | 24 ++++++++++++------------ 4 files changed, 13 insertions(+), 13 deletions(-) rename app/{test => tests}/__init__.py (100%) rename app/{test => tests}/conftest.py (100%) rename app/{test => tests}/test_routes.py (70%) diff --git a/app/routes.py b/app/routes.py index caadf88b0..165283f78 100644 --- a/app/routes.py +++ b/app/routes.py @@ -18,7 +18,7 @@ def create_planet(): db.session.add(planet) db.session.commit() - return make_response(jsonify(f"Planet {planet.name} successfully created", 201)) + return make_response(jsonify(f"Planet {planet.name} successfully created")), 201 @planet_bp.route("", methods=['GET']) def get_planets(): diff --git a/app/test/__init__.py b/app/tests/__init__.py similarity index 100% rename from app/test/__init__.py rename to app/tests/__init__.py diff --git a/app/test/conftest.py b/app/tests/conftest.py similarity index 100% rename from app/test/conftest.py rename to app/tests/conftest.py diff --git a/app/test/test_routes.py b/app/tests/test_routes.py similarity index 70% rename from app/test/test_routes.py rename to app/tests/test_routes.py index e657725f8..c4b47fc5b 100644 --- a/app/test/test_routes.py +++ b/app/tests/test_routes.py @@ -38,15 +38,15 @@ def test_get_one_planet(client, two_saved_planets): } -# def test_create_one_planet(client): -# # Act -# response = client.post("/planets", json={ -# "name": "Jupiter", -# "description": "biggest planet", -# "diameter": 86881 -# }) -# response_body = response.get_json() - -# # Assert -# assert response.status_code == 201 -# assert response_body == "planet Jupiter successfully created" +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Jupiter", + "description": "biggest planet", + "diameter": 86881 + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Jupiter successfully created" From 223820eea4c680f36137d45a946c386c6a2c4d60 Mon Sep 17 00:00:00 2001 From: Raissa Barbosa Date: Thu, 4 May 2023 15:49:29 -0400 Subject: [PATCH 09/12] Refactoring --- app/models/planet.py | 10 +++++++ app/routes.py | 61 +++++++++++++++++++--------------------- app/tests/conftest.py | 30 +++++++++++++------- app/tests/test_routes.py | 37 +++++++++++------------- 4 files changed, 76 insertions(+), 62 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index e0db101b9..ea5e07e86 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -8,6 +8,16 @@ class Planet(db.Model): diameter= db.Column(db.Float) __tablename__ = "Planets" + + @classmethod + def from_dict(cls, data_dict): + return cls( + name=data_dict["name"], + description=data_dict["description"], + diameter=data_dict["diameter"] + ) + + def to_dict(self): return { "id": self.id, diff --git a/app/routes.py b/app/routes.py index 165283f78..218552ad3 100644 --- a/app/routes.py +++ b/app/routes.py @@ -7,13 +7,8 @@ @planet_bp.route("", methods=["POST"]) def create_planet(): - data = request.json - - planet = Planet( - name=data['name'], - description=data['description'], - diameter=data['diameter'] - ) + request_body = request.get_json() + planet = Planet.from_dict(request_body) db.session.add(planet) db.session.commit() @@ -22,36 +17,41 @@ def create_planet(): @planet_bp.route("", methods=['GET']) def get_planets(): - planets = Planet.query.all() - - planet_list = [planet.to_dict() for planet in planets] + name_query = request.args.get("name") + + planet_query = Planet.query + + if name_query: + planet_query = planet_query.filter_by(name=name_query) + + planets = planet_query.all() + + planets_response = [planet.to_dict() for planet in planets] + return jsonify(planets_response), 200 - return jsonify(planet_list) -def validate_planet(id): + +def validate_model(cls, model_id): try: - id = int(id) + model_id = int(model_id) except: - message = f"planet {id} is invalid" - abort(make_response({"message": message}, 400)) - - planet = Planet.query.get(id) - - if not planet: - message = f"planet {id} not found" - abort(make_response({"message": message}, 404)) + abort(make_response({"message": f"{cls.__name__} {model_id} invalid"}, 400)) + + model = cls.query.get(model_id) + if not model: + abort(make_response({"message": f"{cls.__name__} {model_id} not found"}, 404)) + + return model + @planet_bp.route("/", methods=['GET']) def get_planet(planet_id): - planet = Planet.query.get(planet_id) - if planet: - return planet.to_dict() - else: - return make_response(f"Planet {planet_id} not found", 404) + planet = validate_model(Planet, planet_id) + return jsonify(planet.to_dict()), 200 @planet_bp.route("/", methods=["PUT"]) def update_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planet, planet_id) request_body = request.get_json() if "name" not in request_body or "description" not in \ @@ -64,14 +64,11 @@ def update_planet(planet_id): db.session.commit() - return make_response(jsonify(f"Planet #{planet.id} successfully updated", 200)) + return make_response(jsonify(f"Planet #{planet.id} successfully updated"), 200) @planet_bp.route("/", methods=['DELETE']) def delete_planet(planet_id): - planet = Planet.query.get(planet_id) - if not planet: - return make_response(jsonify(f"Planet {planet_id} not found", 404)) - + planet = validate_model(Planet, planet_id) db.session.delete(planet) db.session.commit() diff --git a/app/tests/conftest.py b/app/tests/conftest.py index e50a791f2..c2860b540 100644 --- a/app/tests/conftest.py +++ b/app/tests/conftest.py @@ -30,16 +30,26 @@ def client(app): def two_saved_planets(app): # Arrange mercury_planet = Planet(name="Mercury", - description="smallest planet", - diameter=3031.9) - jupter_planet = Planet(name="Jupiter", - description="biggest planet", - diameter="86881") - - db.session.add_all([mercury_planet, jupter_planet]) - # Alternatively, we could do - # db.session.add(ocean_book) - # db.session.add(mountain_book) + description="smallest planet", + diameter=3031.9) + jupiter_planet = Planet(name="Jupiter", + description="biggest planet", + diameter=86881) + + db.session.add_all([mercury_planet, jupiter_planet]) + db.session.commit() + + return [mercury_planet, jupiter_planet] + + + +@pytest.fixture +def one_saved_planet(app): + planet = Planet(name="Uranus", + description="furthest planet", + diameter=31518 ) + db.session.add(planet) db.session.commit() + return planet diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py index c4b47fc5b..c9cc6709f 100644 --- a/app/tests/test_routes.py +++ b/app/tests/test_routes.py @@ -1,3 +1,6 @@ +from app.models.planet import Planet + + def test_get_all_planets_with_no_records(client): # Act response = client.get("/planets") @@ -8,35 +11,21 @@ def test_get_all_planets_with_no_records(client): assert response_body == [] -def test_get_one_planet(client): +def test_get_one_planet(client, one_saved_planet): # Act - response = client.get("/planets/1") + response = client.get(f"/planets/{one_saved_planet.id}") response_body = response.get_json() # Assert assert response.status_code == 200 assert response_body == { - "id": "", - "name": "", - "description": "", - "diameter": "" + "id": one_saved_planet.id, + "name": one_saved_planet.name, + "description": one_saved_planet.description, + "diameter": one_saved_planet.diameter } -def test_get_one_planet(client, two_saved_planets): - # Act - response = client.get("/planets/1") - response_body = response.get_json() - - # Assert - assert response.status_code == 200 - assert response_body == { - "id": 1, - "name": "Mercury", - "description": "smallest planet", - "diameter": 3031.9 - } - def test_create_one_planet(client): # Act @@ -50,3 +39,11 @@ def test_create_one_planet(client): # Assert assert response.status_code == 201 assert response_body == "Planet Jupiter successfully created" + + +def test_get_one_that_dont_exist_and_returns_error_message(client): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body["message"] == "Planet 1 not found" From 96e785f220238c8a460620255705c4bf15fa3e7d Mon Sep 17 00:00:00 2001 From: liz Date: Thu, 4 May 2023 14:30:20 -0700 Subject: [PATCH 10/12] refactoring, adding error checking, adding additional tests --- app/models/planet.py | 11 +- app/routes.py | 134 ++++--- app/tests/test_routes.py | 52 --- {app/tests => tests}/__init__.py | 0 {app/tests => tests}/conftest.py | 6 - tests/test_routes.py | 592 +++++++++++++++++++++++++++++++ 6 files changed, 688 insertions(+), 107 deletions(-) delete mode 100644 app/tests/test_routes.py rename {app/tests => tests}/__init__.py (100%) rename {app/tests => tests}/conftest.py (89%) create mode 100644 tests/test_routes.py diff --git a/app/models/planet.py b/app/models/planet.py index e0db101b9..5512500b7 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -1,6 +1,5 @@ from app import db - class Planet(db.Model): id = db.Column(db.Integer, primary_key=True, autoincrement=True) name = db.Column(db.String) @@ -14,4 +13,12 @@ def to_dict(self): "name": self.name, "description": self.description, "diameter": self.diameter - } \ No newline at end of file + } + + @classmethod + def from_dict(cls, planet_data): + return cls( + name=planet_data['name'], + description=planet_data['description'], + diameter=planet_data['diameter'] + ) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 165283f78..5556ffe78 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,78 +1,118 @@ from app import db from app.models.planet import Planet from flask import Blueprint, jsonify, make_response, request, abort +from sqlalchemy.exc import DataError planet_bp = Blueprint("planet", __name__, url_prefix="/planets") +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + message = f"{cls.__name__} {model_id} invalid" + abort(make_response({"message": message}, 400)) + + model = cls.query.get(model_id) + + if not model: + message = f"{cls.__name__} {model_id} not found" + abort(make_response({"message": message}, 404)) + + return model @planet_bp.route("", methods=["POST"]) def create_planet(): - data = request.json - - planet = Planet( - name=data['name'], - description=data['description'], - diameter=data['diameter'] - ) - - db.session.add(planet) - db.session.commit() - - return make_response(jsonify(f"Planet {planet.name} successfully created")), 201 + request_body = request.get_json() + + try: + new_planet = Planet.from_dict(request_body) + db.session.add(new_planet) + db.session.commit() + + message = f"Planet {new_planet.name} successfully created" + return make_response(jsonify(message)), 201 + except KeyError as e: + expected_keys = ["name", "description", "diameter"] + missing_keys = [key for key in expected_keys if key not in request_body] + + message = 'missing required values' + error_dict = {"message": message, "missing_values": missing_keys} + + abort(make_response(error_dict, 400)) + except (TypeError, DataError) as e: + error_dict = { + "message": "Invalid request body", + "error": str(e) + } + abort(make_response(jsonify(error_dict), 400)) @planet_bp.route("", methods=['GET']) -def get_planets(): - planets = Planet.query.all() - - planet_list = [planet.to_dict() for planet in planets] +def get_all_planets(): + name_query = request.args.get("name") + if name_query: + planets = Planet.query.filter_by(name=name_query) + else: + planets = Planet.query.all() + planet_list = [planet.to_dict() for planet in planets] return jsonify(planet_list) -def validate_planet(id): - try: - id = int(id) - except: - message = f"planet {id} is invalid" - abort(make_response({"message": message}, 400)) - - planet = Planet.query.get(id) - - if not planet: - message = f"planet {id} not found" - abort(make_response({"message": message}, 404)) - @planet_bp.route("/", methods=['GET']) -def get_planet(planet_id): - planet = Planet.query.get(planet_id) - if planet: - return planet.to_dict() - else: - return make_response(f"Planet {planet_id} not found", 404) +def get_one_planet(planet_id): + planet = validate_model(Planet, planet_id) + return planet.to_dict() @planet_bp.route("/", methods=["PUT"]) -def update_planet(planet_id): - planet = validate_planet(planet_id) +def replace_planet(planet_id): + planet = validate_model(Planet, planet_id) request_body = request.get_json() - if "name" not in request_body or "description" not in \ - request_body or "diameter" not in request_body: - return make_response("Incomplete request body", 400) - else: + try: planet.name = request_body["name"] planet.description = request_body["description"] planet.diameter = request_body["diameter"] - db.session.commit() + message = f"Planet #{planet.id} successfully updated" + return make_response(jsonify(message)), 200 + except KeyError as e: + expected_keys = ["name", "description", "diameter"] + missing_keys = [key for key in expected_keys if key not in request_body] + + message = 'missing required values' + error_dict = {"message": message, "missing_values": missing_keys} - return make_response(jsonify(f"Planet #{planet.id} successfully updated", 200)) + abort(make_response(error_dict, 400)) + except (TypeError, DataError) as e: + error_dict = { + "message": "Invalid request body", + "error": str(e) + } + abort(make_response(jsonify(error_dict), 400)) + +@planet_bp.route("/", methods=["PATCH"]) +def update_planet(planet_id): + planet = validate_model(Planet, planet_id) + request_body = request.get_json() + + try: + for key in request_body: + setattr(planet, key, request_body[key]) + db.session.commit() + message = f"Planet #{planet.id} successfully updated" + return make_response(jsonify(message)), 200 + except (TypeError, KeyError, DataError) as e: + error_dict = { + "message": "Invalid request body", + "error": str(e) + } + abort(make_response(jsonify(error_dict), 400)) @planet_bp.route("/", methods=['DELETE']) def delete_planet(planet_id): - planet = Planet.query.get(planet_id) - if not planet: - return make_response(jsonify(f"Planet {planet_id} not found", 404)) + planet = validate_model(Planet, planet_id) db.session.delete(planet) db.session.commit() - return make_response(jsonify(f"Planet {planet_id} successfully deleted", 200)) \ No newline at end of file + message = f"Planet #{planet.id} {planet.name} successfully deleted" + return make_response(jsonify(message)), 200 \ No newline at end of file diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py deleted file mode 100644 index c4b47fc5b..000000000 --- a/app/tests/test_routes.py +++ /dev/null @@ -1,52 +0,0 @@ -def test_get_all_planets_with_no_records(client): - # Act - response = client.get("/planets") - response_body = response.get_json() - - # Assert - assert response.status_code == 200 - assert response_body == [] - - -def test_get_one_planet(client): - # Act - response = client.get("/planets/1") - response_body = response.get_json() - - # Assert - assert response.status_code == 200 - assert response_body == { - "id": "", - "name": "", - "description": "", - "diameter": "" - } - - -def test_get_one_planet(client, two_saved_planets): - # Act - response = client.get("/planets/1") - response_body = response.get_json() - - # Assert - assert response.status_code == 200 - assert response_body == { - "id": 1, - "name": "Mercury", - "description": "smallest planet", - "diameter": 3031.9 - } - - -def test_create_one_planet(client): - # Act - response = client.post("/planets", json={ - "name": "Jupiter", - "description": "biggest planet", - "diameter": 86881 - }) - response_body = response.get_json() - - # Assert - assert response.status_code == 201 - assert response_body == "Planet Jupiter successfully created" diff --git a/app/tests/__init__.py b/tests/__init__.py similarity index 100% rename from app/tests/__init__.py rename to tests/__init__.py diff --git a/app/tests/conftest.py b/tests/conftest.py similarity index 89% rename from app/tests/conftest.py rename to tests/conftest.py index e50a791f2..c8c5fab8d 100644 --- a/app/tests/conftest.py +++ b/tests/conftest.py @@ -4,8 +4,6 @@ from flask.signals import request_finished from app.models.planet import Planet - - @pytest.fixture def app(): app = create_app({"TESTING": True}) @@ -25,7 +23,6 @@ def expire_session(sender, response, **extra): def client(app): return app.test_client() - @pytest.fixture def two_saved_planets(app): # Arrange @@ -37,9 +34,6 @@ def two_saved_planets(app): diameter="86881") db.session.add_all([mercury_planet, jupter_planet]) - # Alternatively, we could do - # db.session.add(ocean_book) - # db.session.add(mountain_book) db.session.commit() diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..ddeb2b66b --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,592 @@ +from werkzeug.exceptions import HTTPException +from app.routes import validate_model +from app.models.planet import Planet +import pytest + +def test_get_all_planets_with_no_records(client): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_all_planets_with_two_records(client, two_saved_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 2 + assert response_body[0] == { + "id": 1, + "name": "Mercury", + "description": "smallest planet", + "diameter": 3031.9 + } + assert response_body[1] == { + "id": 2, + "name": "Jupiter", + "description": "biggest planet", + "diameter": 86881 + } + +def test_get_all_planets_with_title_query_matching_none(client, two_saved_planets): + # Act + data = {'name': 'Dog'} + response = client.get("/planets", query_string = data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_all_planets_with_title_query_matching_one(client, two_saved_planets): + # Act + data = {'name': 'Mercury'} + response = client.get("/planets", query_string = data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 1 + assert response_body[0] == { + "id": 1, + "name": "Mercury", + "description": "smallest planet", + "diameter": 3031.9 + } + +def test_get_one_planet_missing_record(client, two_saved_planets): + # Act + response = client.get("/planets/3") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 3 not found"} + +def test_get_one_planet_invalid_id(client, two_saved_planets): + # Act + response = client.get("/planets/earth") + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message":"Planet earth invalid"} + +def test_get_one_planet(client, two_saved_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Mercury", + "description": "smallest planet", + "diameter": 3031.9 + } + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Pluto", + "description": "dwarf planet", + "diameter": 1473 + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Pluto successfully created" + +def test_create_one_planet_no_name(client): + # Arrange + test_data = {"description": "The Best!", "diameter": 1000} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['name'] + +def test_create_one_planet_no_description(client): + # Arrange + test_data = {"name": "New planet", "diameter": 1000} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + # Act & Assert + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['description'] + +def test_create_one_planet_no_diameter(client): + # Arrange + test_data = {"name": "New planet", "description": "The Best!"} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + # Act & Assert + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['diameter'] + +def test_create_one_planet_no_name_and_no_description(client): + # Arrange + test_data = {"diameter": 1000} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['name', 'description'] + +def test_create_one_planet_no_name_and_no_diameter(client): + # Arrange + test_data = {"description": "The Best!"} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['name', 'diameter'] + +def test_create_one_planet_no_description_and_no_diameter(client): + # Arrange + test_data = {"name": "New planet"} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['description', 'diameter'] + +def test_create_one_planet_with_extra_keys(client, two_saved_planets): + # Arrange + test_data = { + "extra": "some stuff", + "name": "New planet", + "description": "The Best!", + "diameter": 1000, + "another": "last value" + } + + # Act + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet New planet successfully created" + +def test_create_one_planet_with_invalid_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": "dog" + } + + # Act + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["error"] + +def test_replace_planet(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_replace_planet_with_extra_keys(client, two_saved_planets): + # Arrange + test_data = { + "extra": "some stuff", + "name": "New planet", + "description": "The Best!", + "diameter": 1000, + "another": "last value" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_replace_planet_missing_record(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.put("/planets/3", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 3 not found"} + +def test_replace_planet_no_name(client, two_saved_planets): + # Arrange + test_data = { + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["name"] + +def test_replace_planet_no_description(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "diameter": 1000 + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["description"] + +def test_replace_planet_no_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["diameter"] + +def test_replace_planet_no_name_no_description(client, two_saved_planets): + # Arrange + test_data = { + "diameter": 1000 + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["name", "description"] + +def test_replace_planet_no_name_no_diameter(client, two_saved_planets): + # Arrange + test_data = { + "description": "The Best!" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["name", "diameter"] + +def test_replace_planet_no_description_no_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["description", "diameter"] + +def test_replace_planet_invalid_id(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.put("/planets/dog", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message": "Planet dog invalid"} + +def test_replace_planet_invalid_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": "dog" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body['error'] + +def test_update_planet_name_only(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_description_only(client, two_saved_planets): + # Arrange + test_data = { + "description": "The Best!" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_diameter_only(client, two_saved_planets): + # Arrange + test_data = { + "diameter": 1000 + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_name_and_description(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_name_and_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_description_and_diameter(client, two_saved_planets): + # Arrange + test_data = { + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_name_description_and_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_with_extra_keys(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000, + "another": "last value" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_missing_record(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/3", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 3 not found"} + +def test_update_planet_invalid_id(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/dog", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message": "Planet dog invalid"} + +def test_update_planet_invalid_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": "dog" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "Invalid request body" + assert response_body["error"] + +def test_delete_planet(client, two_saved_planets): + # Act + response = client.delete("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 Mercury successfully deleted" + +def test_delete_planet_missing_record(client, two_saved_planets): + # Act + response = client.delete("/planets/3") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 3 not found"} + +def test_delete_planet_invalid_id(client, two_saved_planets): + # Act + response = client.delete("/planets/dog") + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message": "Planet dog invalid"} + +def test_validate_model(two_saved_planets): + # Act + result_planet = validate_model(Planet, 1) + + # Assert + assert result_planet.id == 1 + assert result_planet.name == "Mercury" + assert result_planet.description == "smallest planet" + assert result_planet.diameter == 3031.9 + +def test_validate_model_missing_record(two_saved_planets): + # Act & Assert + with pytest.raises(HTTPException): + result_planet = validate_model(Planet, "3") + +def test_validate_model_invalid_id(two_saved_planets): + # Act & Assert + with pytest.raises(HTTPException): + result_planet = validate_model(Planet, "dog") \ No newline at end of file From bcbf0dcf09f90d0a145f21c486c422a8e4acde46 Mon Sep 17 00:00:00 2001 From: liz Date: Thu, 4 May 2023 15:20:29 -0700 Subject: [PATCH 11/12] remove old tests --- app/tests/test_routes.py | 49 ---------------------------------------- 1 file changed, 49 deletions(-) delete mode 100644 app/tests/test_routes.py diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py deleted file mode 100644 index c9cc6709f..000000000 --- a/app/tests/test_routes.py +++ /dev/null @@ -1,49 +0,0 @@ -from app.models.planet import Planet - - -def test_get_all_planets_with_no_records(client): - # Act - response = client.get("/planets") - response_body = response.get_json() - - # Assert - assert response.status_code == 200 - assert response_body == [] - - -def test_get_one_planet(client, one_saved_planet): - # Act - response = client.get(f"/planets/{one_saved_planet.id}") - response_body = response.get_json() - - # Assert - assert response.status_code == 200 - assert response_body == { - "id": one_saved_planet.id, - "name": one_saved_planet.name, - "description": one_saved_planet.description, - "diameter": one_saved_planet.diameter - } - - - -def test_create_one_planet(client): - # Act - response = client.post("/planets", json={ - "name": "Jupiter", - "description": "biggest planet", - "diameter": 86881 - }) - response_body = response.get_json() - - # Assert - assert response.status_code == 201 - assert response_body == "Planet Jupiter successfully created" - - -def test_get_one_that_dont_exist_and_returns_error_message(client): - response = client.get("/planets/1") - response_body = response.get_json() - - assert response.status_code == 404 - assert response_body["message"] == "Planet 1 not found" From c161afad078d43030cdf5475f286a0d250928400 Mon Sep 17 00:00:00 2001 From: liz Date: Thu, 4 May 2023 15:33:39 -0700 Subject: [PATCH 12/12] finalize project working with Raissa & Sabs --- app/models/planet.py | 10 ---------- app/routes.py | 2 +- tests/test_routes.py | 2 +- 3 files changed, 2 insertions(+), 12 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index ab315bffa..5512500b7 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -7,16 +7,6 @@ class Planet(db.Model): diameter= db.Column(db.Float) __tablename__ = "Planets" - - @classmethod - def from_dict(cls, data_dict): - return cls( - name=data_dict["name"], - description=data_dict["description"], - diameter=data_dict["diameter"] - ) - - def to_dict(self): return { "id": self.id, diff --git a/app/routes.py b/app/routes.py index 3d1e26981..f8a14a4d1 100644 --- a/app/routes.py +++ b/app/routes.py @@ -55,7 +55,7 @@ def get_all_planets(): planets = Planet.query.all() planet_list = [planet.to_dict() for planet in planets] - return jsonify(planet_list) + return make_response(jsonify(planet_list)), 200 @planet_bp.route("/", methods=['GET']) def get_planet(planet_id): diff --git a/tests/test_routes.py b/tests/test_routes.py index ddeb2b66b..1da4a9c89 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -1,7 +1,7 @@ +import pytest from werkzeug.exceptions import HTTPException from app.routes import validate_model from app.models.planet import Planet -import pytest def test_get_all_planets_with_no_records(client): # Act