Source code for taxonomy.api

"""APIs for lore taxonomy application"""
from __future__ import unicode_literals

from taxonomy.models import (
    Vocabulary,
    Term,
)
from learningresources.api import (
    get_repo,
    NotFound,
)


[docs]def get_vocabulary(repo_slug, user_id, vocab_slug):
    """
    Lookup vocabulary given its slug, using repo_slug to validate ownership.

    Args:
        repo_id (int): Repository id
        user_id (int): User id
        vocab_slug (unicode): Vocabulary slug

    Returns:
        Vocabulary (Vocabulary): The vocabulary from the database
    """
    repo = get_repo(repo_slug, user_id)
    try:
        return repo.vocabulary_set.get(slug=vocab_slug)
    except Vocabulary.DoesNotExist:
        raise NotFound()


[docs]def get_term(repo_slug, user_id, vocab_slug, term_slug):
    """
    Get Term with existing slug, validating ownership for repo_slug
    and vocab_slug.

    Args:
        term_id (int): Term slug

    Returns:
        Term (Term): The Term with the id
    """
    repo = get_repo(repo_slug, user_id)
    try:
        return repo.vocabulary_set.get(
            slug=vocab_slug
        ).term_set.get(
            slug=term_slug
        )
    except Vocabulary.DoesNotExist:
        raise NotFound()
    except Term.DoesNotExist:
        raise NotFound()