def flush_entities(db_conn, descs):
"""
Given a list of kinds and entity_ids,
return a list filled out with entities.
"""
output = []
for desc in descs:
if desc['kind'] == 'card':
card = Card.get_latest_accepted(db_conn, entity_id=desc['id'])
card = flip_card_into_kind(card)
if card:
output.append(card)
elif desc['kind'] == 'unit':
output.append(Unit.get_latest_accepted(
db_conn,
entity_id=desc['id']
))
elif desc['kind'] == 'subject':
output.append(Subject.get_latest_accepted(
db_conn,
entity_id=desc['id']
))
else:
output.append(None)
return output
def get_card_route(request, card_id):
"""
Get a specific card given an ID. Show all relevant data, but
not used for the learning interface.
"""
card = get_card_by_kind(card_id)
if not card:
return abort(404)
unit = Unit.get_latest_accepted(entity_id=card['unit_id'])
if not unit:
return abort(404)
# TODO-2 SPLITUP create new endpoints for these instead
topics = Topic.list_by_entity_id(entity_id=card_id)
versions = Card.get_versions(entity_id=card_id)
requires = Card.list_requires(entity_id=card_id)
required_by = Card.list_required_by(entity_id=card_id)
params = CardParameters.get(entity_id=card_id)
return 200, {
'card': card.deliver(access='view'),
'card_parameters': params.get_values(),
'unit': unit.deliver(),
'topics': [topic.deliver() for topic in topics],
'versions': [version.deliver() for version in versions],
'requires': [require.deliver() for require in requires],
'required_by': [require.deliver() for require in required_by],
}
def flush_entities(db_conn, descs):
"""
Given a list of kinds and entity_ids,
return a list filled out with entities.
"""
output = []
for desc in descs:
if desc['kind'] == 'card':
card = Card.get_latest_accepted(db_conn, entity_id=desc['id'])
card = flip_card_into_kind(card)
if card:
output.append(card)
elif desc['kind'] == 'unit':
output.append(Unit.get_latest_accepted(
db_conn,
entity_id=desc['id']
))
elif desc['kind'] == 'set':
output.append(Set.get_latest_accepted(
db_conn,
entity_id=desc['id']
))
else:
output.append(None)
return output
def get_unit_route(request, unit_id):
"""
Get a specific unit given an ID.
"""
db_conn = request['db_conn']
unit = Unit.get_latest_accepted(db_conn, unit_id)
if not unit:
return abort(404)
# TODO-2 SPLITUP create new endpoints for these instead
topics = list_topics_by_entity_id(unit_id, {}, db_conn)
versions = Unit.get_versions(db_conn, unit_id)
requires = Unit.list_requires(db_conn, unit_id)
required_by = Unit.list_required_by(db_conn, unit_id)
sets = Set.list_by_unit_id(db_conn, unit_id)
return 200, {
'unit': unit.deliver(),
# 'unit_parameters': unit.fetch_parameters(),
'topics': [deliver_topic(topic) for topic in topics],
'versions': [version.deliver() for version in versions],
'requires': [require.deliver() for require in requires],
'required_by': [require.deliver() for require in required_by],
'belongs_to': [set_.deliver() for set_ in sets],
}
def get_unit_route(request, unit_id):
"""
Get a specific unit given an ID.
"""
unit = Unit.get_latest_accepted(unit_id)
if not unit:
return abort(404)
# TODO-2 SPLITUP create new endpoints for these instead
topics = Topic.list_by_entity_id(unit_id)
versions = Unit.get_versions(unit_id)
requires = Unit.list_requires(unit_id)
required_by = Unit.list_required_by(unit_id)
sets = Set.list_by_unit_id(unit_id)
return 200, {
'unit': unit.deliver(),
# 'unit_parameters': unit.fetch_parameters(),
'topics': [topic.deliver() for topic in topics],
'versions': [version.deliver() for version in versions],
'requires': [require.deliver() for require in requires],
'required_by': [require.deliver() for require in required_by],
'belongs_to': [set_.deliver() for set_ in sets],
}
def get_card_route(request, card_id):
"""
Get a specific card given an ID. Show all relevant data, but
not used for the learning interface.
"""
card = get_card_by_kind(card_id)
if not card:
return abort(404)
unit = Unit.get_latest_accepted(entity_id=card['unit_id'])
if not unit:
return abort(404)
# TODO-2 SPLITUP create new endpoints for these instead
topics = Topic.list_by_entity_id(entity_id=card_id)
versions = Card.get_versions(entity_id=card_id)
requires = Card.list_requires(entity_id=card_id)
required_by = Card.list_required_by(entity_id=card_id)
params = CardParameters.get(entity_id=card_id)
return 200, {
'card': card.deliver(access='view'),
'card_parameters': params.get_values(),
'unit': unit.deliver(),
'topics': [topic.deliver() for topic in topics],
'versions': [version.deliver() for version in versions],
'requires': [require.deliver() for require in requires],
'required_by': [require.deliver() for require in required_by],
}
def get_card_route(request, card_id):
"""
Get a specific card given an ID. Show all relevant data, but
not used for the learning interface.
"""
db_conn = request['db_conn']
card = get_card_by_kind(db_conn, card_id)
if not card:
return abort(404)
unit = Unit.get_latest_accepted(db_conn, entity_id=card['unit_id'])
if not unit:
return abort(404)
# TODO-2 SPLITUP create new endpoints for these instead
topics = list_topics_by_entity_id(card_id, {}, db_conn)
versions = Card.get_versions(db_conn, entity_id=card_id)
requires = Card.list_requires(db_conn, entity_id=card_id)
required_by = Card.list_required_by(db_conn, entity_id=card_id)
params = get_card_parameters({'entity_id': card_id}, db_conn)
return 200, {
'card': card.deliver(access='view'),
'card_parameters':
(get_card_parameters_values(params) if params else None),
'unit': unit.deliver(),
'topics': [deliver_topic(topic) for topic in topics],
'versions': [version.deliver() for version in versions],
'requires': [require.deliver() for require in requires],
'required_by': [require.deliver() for require in required_by],
}
def get_unit_route(request, unit_id):
"""
Get a specific unit given an ID.
"""
db_conn = request["db_conn"]
unit = Unit.get_latest_accepted(db_conn, unit_id)
if not unit:
return abort(404)
# TODO-2 SPLITUP create new endpoints for these instead
topics = Topic.list_by_entity_id(db_conn, unit_id)
versions = Unit.get_versions(db_conn, unit_id)
requires = Unit.list_requires(db_conn, unit_id)
required_by = Unit.list_required_by(db_conn, unit_id)
sets = Set.list_by_unit_id(db_conn, unit_id)
return (
200,
{
"unit": unit.deliver(),
# 'unit_parameters': unit.fetch_parameters(),
"topics": [topic.deliver() for topic in topics],
"versions": [version.deliver() for version in versions],
"requires": [require.deliver() for require in requires],
"required_by": [require.deliver() for require in required_by],
"belongs_to": [set_.deliver() for set_ in sets],
},
)
def choose_unit_route(request, subject_id, unit_id):
"""
Updates the learner's information based on the unit they have chosen.
NEXT STATE
POST Chosen Unit
-> GET Learn Card
"""
# TODO-3 simplify this method. should it be broken up or moved to model?
db_conn = request['db_conn']
current_user = get_current_user(request)
if not current_user:
return abort(401)
unit = Unit.get_latest_accepted(db_conn, unit_id)
if not unit:
return abort(404)
# If the unit isn't in the subject...
context = get_learning_context(current_user)
subject_ids = [
subject['entity_id']
for subject in Subject.list_by_unit_id(db_conn, unit_id)
]
if context.get('subject', {}).get('entity_id') not in subject_ids:
return abort(400)
status = judge(db_conn, unit, current_user)
# Or, the unit doesn't need to be learned...
if status == "done":
return abort(400)
# Choose a card for the learner to learn
card = choose_card(db_conn, current_user, unit)
if card:
next_ = {
'method': 'GET',
'path':
'/s/cards/{card_id}/learn'.format(card_id=card['entity_id']),
}
else:
next_ = {}
set_learning_context(current_user,
unit=unit.data,
card=card.data if card else None,
next=next_)
return 200, {'next': next_}
def choose_unit_route(request, set_id, unit_id):
"""
Updates the learner's information based on the unit they have chosen.
NEXT STATE
POST Chosen Unit
-> GET Learn Card
"""
# TODO-3 simplify this method. should it be broken up or moved to model?
db_conn = request['db_conn']
current_user = get_current_user(request)
if not current_user:
return abort(401)
unit = Unit.get_latest_accepted(db_conn, unit_id)
if not unit:
return abort(404)
# If the unit isn't in the set...
context = get_learning_context(current_user)
set_ids = [set_['entity_id']
for set_ in Set.list_by_unit_id(db_conn, unit_id)]
if context.get('set', {}).get('entity_id') not in set_ids:
return abort(400)
status = judge(db_conn, unit, current_user)
# Or, the unit doesn't need to be learned...
if status == "done":
return abort(400)
# Choose a card for the learner to learn
card = choose_card(db_conn, current_user, unit)
if card:
next_ = {
'method': 'GET',
'path': '/s/cards/{card_id}/learn'
.format(card_id=card['entity_id']),
}
else:
next_ = {}
set_learning_context(
current_user,
unit=unit.data,
card=card.data if card else None,
next=next_
)
return 200, {'next': next_}
def get_latest_accepted(kind, entity_id):
"""
Given a kind and an entity_id, pull the latest accepted
version out of the database.
"""
if kind == 'card':
return Card.get_latest_accepted(entity_id)
# TODO-1 This needs to also get the right card kind...
elif kind == 'unit':
return Unit.get_latest_accepted(entity_id)
elif kind == 'set':
return Set.get_latest_accepted(entity_id)
def get_latest_accepted(db_conn, kind, entity_id):
"""
Given a kind and an entity_id, pull the latest accepted
version out of the database.
"""
if kind == 'card':
card = Card.get_latest_accepted(db_conn, entity_id)
return flip_card_into_kind(card)
elif kind == 'unit':
return Unit.get_latest_accepted(db_conn, entity_id)
elif kind == 'set':
return Set.get_latest_accepted(db_conn, entity_id)
def get_latest_accepted(db_conn, kind, entity_id):
"""
Given a kind and an entity_id, pull the latest accepted
version out of the database.
"""
if kind == 'card':
card = Card.get_latest_accepted(db_conn, entity_id)
return flip_card_into_kind(card)
elif kind == 'unit':
return Unit.get_latest_accepted(db_conn, entity_id)
elif kind == 'set':
return Set.get_latest_accepted(db_conn, entity_id)
def get_latest_accepted(kind, entity_id):
"""
Given a kind and an entity_id, pull the latest accepted
version out of the database.
"""
if kind == 'card':
return Card.get_latest_accepted(entity_id)
# TODO-1 This needs to also get the right card kind...
elif kind == 'unit':
return Unit.get_latest_accepted(entity_id)
elif kind == 'set':
return Set.get_latest_accepted(entity_id)
def flush_entities(descs):
"""
Given a list of kinds and entity_ids,
return a list filled out with entities.
"""
output = []
for desc in descs:
if desc['kind'] == 'card':
output.append(Card.get_latest_accepted(entity_id=desc['id']))
# TODO-1 This needs to also get the right card kind...
elif desc['kind'] == 'unit':
output.append(Unit.get_latest_accepted(entity_id=desc['id']))
elif desc['kind'] == 'set':
output.append(Set.get_latest_accepted(entity_id=desc['id']))
else:
output.append(None)
return output
def flush_entities(descs):
"""
Given a list of kinds and entity_ids,
return a list filled out with entities.
"""
output = []
for desc in descs:
if desc['kind'] == 'card':
output.append(Card.get_latest_accepted(entity_id=desc['id']))
# TODO-1 This needs to also get the right card kind...
elif desc['kind'] == 'unit':
output.append(Unit.get_latest_accepted(entity_id=desc['id']))
elif desc['kind'] == 'set':
output.append(Set.get_latest_accepted(entity_id=desc['id']))
else:
output.append(None)
return output
def test_latest_accepted(db_conn, units_table):
"""
Expect to get the latest accepted unit version.
"""
units_table.insert([{
'id': 'A1',
'entity_id': 'A',
'created': r.time(2004, 11, 3, 'Z'),
'status': 'accepted',
}, {
'id': 'B2',
'entity_id': 'A',
'created': r.time(2005, 11, 3, 'Z'),
'status': 'accepted',
}, {
'id': 'C3',
'entity_id': 'B',
'created': r.time(2006, 11, 3, 'Z'),
'status': 'accepted',
}]).run(db_conn)
unit = Unit.get_latest_accepted(db_conn, 'A')
assert unit['id'] == 'B2'
def test_latest_accepted(db_conn, units_table):
"""
Expect to get the latest accepted unit version.
"""
units_table.insert([{
'id': 'A1',
'entity_id': 'A',
'created': r.time(2004, 11, 3, 'Z'),
'status': 'accepted',
}, {
'id': 'B2',
'entity_id': 'A',
'created': r.time(2005, 11, 3, 'Z'),
'status': 'accepted',
}, {
'id': 'C3',
'entity_id': 'B',
'created': r.time(2006, 11, 3, 'Z'),
'status': 'accepted',
}]).run(db_conn)
unit = Unit.get_latest_accepted(db_conn, 'A')
assert unit['id'] == 'B2'
