Komplettes Profil zurückgeben #19

Merged
weeman merged 3 commits from feature-return-entire-profile into main 2021-06-27 09:44:59 +02:00
10 changed files with 237 additions and 78 deletions

3
.style.yapf Normal file
View File

@ -0,0 +1,3 @@
[style]
based_on_style = pep8
allow_split_before_dict_value = 0
Review

Das hat mich verrückt gemacht. Ich würde das ausschalten wollen.

Das hat mich verrückt gemacht. Ich würde das ausschalten wollen.

View File

@ -23,7 +23,7 @@ cp env.dev .env
pipenv install --dev pipenv install --dev
pipenv shell pipenv shell
flask db upgrade flask db upgrade
flask seed flask seed --dev
Review

Die Idee: --dev legt mehr an, wie zum Beispiel den Peter.
Damit man beim Entwickeln direkt loslegen kann.

Die Idee: `--dev` legt mehr an, wie zum Beispiel den Peter. Damit man beim Entwickeln direkt loslegen kann.
flask run flask run
``` ```

1
ki/actions/__init__.py Normal file
View File

@ -0,0 +1 @@
from ki.actions.seed import seed # noqa

83
ki/actions/seed.py Normal file
View File

@ -0,0 +1,83 @@
import csv
import logging
from app import app, db
from ki.models import Address, Contact, ContactType, Language, Skill, Profile, ProfileLanguage, ProfileSkill, User
def seed(dev: bool):
skill_seed_file_path = app.config["KI_DATA_DIR"] + "/seed_data/skills.csv"
logging.info("importing skills")
with open(skill_seed_file_path) as skills_file:
skills_csv_reader = csv.DictReader(skills_file)
for skill in skills_csv_reader:
id = int(skill["id"])
db_skill = Skill.query.get(id)
if db_skill is None:
db.session.add(Skill(id=int(skill["id"]), name=skill["name"]))
logging.info("importing languages")
iso_seed_file_path = app.config["KI_DATA_DIR"] + "/seed_data/iso_639_1.csv"
with open(iso_seed_file_path) as iso_file:
iso_csv_reader = csv.DictReader(iso_file)
for iso in iso_csv_reader:
id = iso["639-1"]
db_language = Language.query.get(id)
if db_language is None:
db.session.add(Language(id=iso["639-1"], name=iso["Sprache"]))
if dev:
logging.info("seeding peter :)")
peter = User(auth_id="peter")
db.session.add(peter)
peters_profile = Profile(nickname="peternichtlustig",
pronouns="Herr Dr. Dr.",
volunteerwork="Gartenverein",
freetext="Ich mag Kaffee",
user=peter)
db.session.add(peters_profile)
matrix_type = ContactType(name="Matrix")
db.session.add(matrix_type)
matrix_contact = Contact(profile=peters_profile,
contacttype=matrix_type,
content="@peter:wtf-eg.de")
db.session.add(matrix_contact)
peters_address = Address(name="Peter Nichtlustig",
street="Waldweg",
house_number="23i",
additional="Hinterhaus",
postcode="13337",
city="Bielefeld",
country="Deutschland",
profile=peters_profile)
db.session.add(peters_address)
peters_python_skill = ProfileSkill(profile=peters_profile,
skill_id=3,
level=5)
db.session.add(peters_python_skill)
peter_de = ProfileLanguage(profile=peters_profile,
language_id="de",
level=5)
db.session.add(peter_de)
peter_fr = ProfileLanguage(profile=peters_profile,
language_id="fr",
level=3)
db.session.add(peter_fr)
db.session.commit()

View File

@ -1,39 +1,10 @@
import csv import click
from ki.models import Language, Skill from app import app
from app import app, db from ki.actions import seed
def seed():
skill_seed_file_path = app.config["KI_DATA_DIR"] + "/seed_data/skills.csv"
print("importing skills")
with open(skill_seed_file_path) as skills_file:
skills_csv_reader = csv.DictReader(skills_file)
for skill in skills_csv_reader:
id = int(skill["id"])
db_skill = Skill.query.get(id)
if db_skill is None:
db.session.add(Skill(id=int(skill["id"]), name=skill["name"]))
iso_seed_file_path = app.config["KI_DATA_DIR"] + "/seed_data/iso_639_1.csv"
with open(iso_seed_file_path) as iso_file:
iso_csv_reader = csv.DictReader(iso_file)
for iso in iso_csv_reader:
id = iso["639-1"]
db_language = Language.query.get(id)
if db_language is None:
db.session.add(Language(id=iso["639-1"], name=iso["Sprache"]))
db.session.commit()
@app.cli.command("seed") @app.cli.command("seed")
def seed_command(): @click.option("--dev", is_flag=True)
seed() def seed_command(dev):
seed(dev)

View File

@ -42,10 +42,17 @@ class Profile(db.Model):
def to_dict(self): def to_dict(self):
return { return {
"user_id": self.user.id,
"nickname": self.nickname, "nickname": self.nickname,
"pronouns": self.pronouns, "pronouns": self.pronouns,
"volunteerwork": self.volunteerwork, "volunteerwork": self.volunteerwork,
"freetext": self.freetext "freetext": self.freetext,
"address": self.address.to_dict(),
"contacts": list(
map(lambda contact: contact.to_dict(), self.contacts)),
"skills": list(map(lambda skill: skill.to_dict(), self.skills)),
"languages": list(
map(lambda language: language.to_dict(), self.languages))
} }
@ -58,6 +65,9 @@ class Token(db.Model):
user = relationship("User", back_populates="tokens") user = relationship("User", back_populates="tokens")
def to_dict(self):
return {"user_id": self.user_id, "token": self.token}
class Contact(db.Model): class Contact(db.Model):
__tablename__ = "contact" __tablename__ = "contact"
@ -71,6 +81,14 @@ class Contact(db.Model):
contacttype = relationship("ContactType") contacttype = relationship("ContactType")
content = Column(String(200), nullable=False) content = Column(String(200), nullable=False)
def to_dict(self):
return {
"id": self.id,
"profile_id": self.profile_id,
"contacttype": self.contacttype.to_dict(),
"content": self.content
}
class ContactType(db.Model): class ContactType(db.Model):
__tablename__ = "contacttype" __tablename__ = "contacttype"
@ -78,6 +96,9 @@ class ContactType(db.Model):
id = Column(Integer, primary_key=True) id = Column(Integer, primary_key=True)
name = Column(String(25), nullable=False) name = Column(String(25), nullable=False)
def to_dict(self):
return {"id": self.id, "name": self.name}
class Address(db.Model): class Address(db.Model):
__tablename__ = "address" __tablename__ = "address"
@ -94,6 +115,19 @@ class Address(db.Model):
profile_id = Column(Integer, ForeignKey("profile.id"), nullable=False) profile_id = Column(Integer, ForeignKey("profile.id"), nullable=False)
profile = relationship("Profile", back_populates="address") profile = relationship("Profile", back_populates="address")
def to_dict(self):
return {
"id": self.id,
"name": self.name,
"street": self.street,
"house_number": self.house_number,
"additional": self.additional,
"postcode": self.postcode,
"city": self.city,
"country": self.country,
"profile_id": self.profile_id
}
class Skill(db.Model): class Skill(db.Model):
__tablename__ = "skill" __tablename__ = "skill"
@ -104,7 +138,11 @@ class Skill(db.Model):
profiles = relationship("ProfileSkill", back_populates="skill") profiles = relationship("ProfileSkill", back_populates="skill")
def to_dict(self): def to_dict(self):
return {"id": self.id, "name": self.name} return {
"id": self.id,
"name": self.name,
"icon_url": "/skills/{}/icon".format(self.id)
}
class ProfileSkill(db.Model): class ProfileSkill(db.Model):
@ -117,6 +155,13 @@ class ProfileSkill(db.Model):
profile = relationship("Profile", back_populates="skills") profile = relationship("Profile", back_populates="skills")
skill = relationship("Skill", back_populates="profiles") skill = relationship("Skill", back_populates="profiles")
def to_dict(self):
return {
"profile_id": self.profile_id,
"skill": self.skill.to_dict(),
"level": self.level
}
class Language(db.Model): class Language(db.Model):
__tablename__ = "language" __tablename__ = "language"
@ -127,7 +172,11 @@ class Language(db.Model):
profiles = relationship("ProfileLanguage", back_populates="language") profiles = relationship("ProfileLanguage", back_populates="language")
def to_dict(self): def to_dict(self):
return {"id": self.id, "name": self.name} return {
"id": self.id,
"name": self.name,
"icon_url": "/languages/{}/icon".format(self.id)
}
class ProfileLanguage(db.Model): class ProfileLanguage(db.Model):
@ -139,3 +188,10 @@ class ProfileLanguage(db.Model):
profile = relationship("Profile", back_populates="languages") profile = relationship("Profile", back_populates="languages")
language = relationship("Language", back_populates="profiles") language = relationship("Language", back_populates="profiles")
def to_dict(self):
return {
"profile_id": self.profile_id,
"language": self.language.to_dict(),
"level": self.level
}

View File

@ -115,7 +115,9 @@ def get_user_profile(user_id):
if profile is None: if profile is None:
return make_response({}, 404) return make_response({}, 404)
return make_response({"profile": profile.to_dict()}) return make_response({
"profile": profile.to_dict(),
})
@app.route("/users/<user_id>/profile", methods=["POST"]) @app.route("/users/<user_id>/profile", methods=["POST"])

View File

@ -2,8 +2,8 @@ from alembic import command
import json import json
import unittest import unittest
from app import app, migrate from app import app, db, migrate
from ki.commands import seed from ki.actions import seed
class TestLoginEndpoint(unittest.TestCase): class TestLoginEndpoint(unittest.TestCase):
@ -16,7 +16,11 @@ class TestLoginEndpoint(unittest.TestCase):
config = migrate.get_config() config = migrate.get_config()
command.upgrade(config, "head") command.upgrade(config, "head")
seed() seed(True)
def tearDown(self):
db.drop_all()
db.engine.dispose()
def test_login(self): def test_login(self):
response1_data = self.login() response1_data = self.login()

View File

@ -3,11 +3,13 @@ import unittest
import json import json
from app import app, db, migrate from app import app, db, migrate
from ki.commands import seed from ki.actions import seed
from ki.models import Profile, User from ki.models import User
class TestProfileEndpoint(unittest.TestCase): class TestProfileEndpoint(unittest.TestCase):
maxDiff = None
def setUp(self): def setUp(self):
app.debug = True app.debug = True
app.config["TESTING"] = True app.config["TESTING"] = True
@ -15,22 +17,16 @@ class TestProfileEndpoint(unittest.TestCase):
self.client = app.test_client() self.client = app.test_client()
with app.app_context(): with app.app_context():
db.drop_all()
db.engine.dispose()
config = migrate.get_config() config = migrate.get_config()
command.upgrade(config, "head") command.upgrade(config, "head")
seed() seed(True)
def tearDown(self): def tearDown(self):
db.drop_all() db.drop_all()
db.engine.dispose() db.engine.dispose()
def test_create_profile(self): def test_update_profile(self):
user = User(auth_id="peter")
db.session.add(user)
db.session.commit()
login_data = {"username": "peter", "password": "geheim"} login_data = {"username": "peter", "password": "geheim"}
login_response = self.client.post("/users/login", login_response = self.client.post("/users/login",
data=json.dumps(login_data), data=json.dumps(login_data),
@ -40,7 +36,7 @@ class TestProfileEndpoint(unittest.TestCase):
self.assertIn("token", login_response.json) self.assertIn("token", login_response.json)
data = { data = {
"pronouns": "Herr Dr. Dr.", "pronouns": "Monsieur",
"volunteerwork": "ja", "volunteerwork": "ja",
"freetext": "Hallo", "freetext": "Hallo",
} }
@ -48,8 +44,7 @@ class TestProfileEndpoint(unittest.TestCase):
data=json.dumps(data), data=json.dumps(data),
content_type="application/json", content_type="application/json",
headers={ headers={
"Authorization": "Authorization": "Bearer " +
"Bearer " +
login_response.json["token"] login_response.json["token"]
}) })
@ -57,20 +52,11 @@ class TestProfileEndpoint(unittest.TestCase):
with app.app_context(): with app.app_context():
user = User.query.filter(User.id == 1).first() user = User.query.filter(User.id == 1).first()
profile = user.profile profile = user.profile
self.assertEqual("Herr Dr. Dr.", profile.pronouns) self.assertEqual("Monsieur", profile.pronouns)
self.assertEqual("ja", profile.volunteerwork) self.assertEqual("ja", profile.volunteerwork)
self.assertEqual("Hallo", profile.freetext) self.assertEqual("Hallo", profile.freetext)
def test_get_profile(self): def test_get_profile(self):
user = User(auth_id="peter")
db.session.add(user)
profile = Profile(user=user)
profile.nickname = "Popeter"
db.session.add(profile)
db.session.commit()
login_data = {"username": "peter", "password": "geheim"} login_data = {"username": "peter", "password": "geheim"}
login_response = self.client.post("/users/login", login_response = self.client.post("/users/login",
data=json.dumps(login_data), data=json.dumps(login_data),
@ -81,18 +67,65 @@ class TestProfileEndpoint(unittest.TestCase):
response = self.client.get("/users/1/profile", response = self.client.get("/users/1/profile",
headers={ headers={
"Authorization": "Authorization": "Bearer " +
"Bearer " + login_response.json["token"] login_response.json["token"]
}) })
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual( self.assertDictEqual(
response.json, { response.json, {
"profile": { "profile": {
Review

@scammo das ist ein Beispiel für eine vollständige Profil-Response, wie sie dann über die API rausgeht.

@scammo das ist ein Beispiel für eine vollständige Profil-Response, wie sie dann über die API rausgeht.
"freetext": "", "user_id": 1,
"nickname": "Popeter", "nickname": "peternichtlustig",
"pronouns": "", "pronouns": "Herr Dr. Dr.",
"volunteerwork": "" "freetext": "Ich mag Kaffee",
"volunteerwork": "Gartenverein",
"address": {
"additional": "Hinterhaus",
"city": "Bielefeld",
"country": "Deutschland",
"house_number": "23i",
"id": 1,
"name": "Peter Nichtlustig",
"postcode": "13337",
"profile_id": 1,
"street": "Waldweg"
},
"contacts": [{
"id": 1,
"profile_id": 1,
"contacttype": {
"id": 1,
"name": "Matrix"
},
"content": "@peter:wtf-eg.de"
}],
"skills": [{
"profile_id": 1,
"skill": {
"id": 3,
"name": "Python",
"icon_url": "/skills/3/icon"
},
"level": 5
}],
"languages": [{
"profile_id": 1,
"language": {
"id": "de",
"name": "Deutsch",
"icon_url": "/languages/de/icon"
},
"level": 5
}, {
"profile_id": 1,
"language": {
"id": "fr",
"name": "Französisch",
"icon_url": "/languages/fr/icon"
},
"level": 3
}]
} }
}) })

View File

@ -1,8 +1,8 @@
from alembic import command from alembic import command
import unittest import unittest
from app import app, migrate from app import app, db, migrate
from ki.commands import seed from ki.actions import seed
class TestSkillsEndpoint(unittest.TestCase): class TestSkillsEndpoint(unittest.TestCase):
@ -15,7 +15,11 @@ class TestSkillsEndpoint(unittest.TestCase):
config = migrate.get_config() config = migrate.get_config()
command.upgrade(config, "head") command.upgrade(config, "head")
seed() seed(True)
def tearDown(self):
db.drop_all()
db.engine.dispose()
def test_skills_options(self): def test_skills_options(self):
response = self.client.options("/skills") response = self.client.options("/skills")
@ -30,10 +34,12 @@ class TestSkillsEndpoint(unittest.TestCase):
{ {
"skills": [{ "skills": [{
"id": 1, "id": 1,
"name": "PHP" "name": "PHP",
"icon_url": "/skills/1/icon"
}, { }, {
"id": 3, "id": 3,
"name": "Python" "name": "Python",
"icon_url": "/skills/3/icon"
}] }]
}, response.json) }, response.json)
self.assertIn("Access-Control-Allow-Origin", response.headers) self.assertIn("Access-Control-Allow-Origin", response.headers)