Source code for inspirehep.modules.records.serializers.response

# -*- coding: utf-8 -*-
#
# This file is part of INSPIRE.
# Copyright (C) 2014-2017 CERN.
#
# INSPIRE is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# INSPIRE is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with INSPIRE. If not, see <http://www.gnu.org/licenses/>.
#
# In applying this license, CERN does not waive the privileges and immunities
# granted to it by virtue of its status as an Intergovernmental Organization
# or submit itself to any jurisdiction.

"""Serialization response factories.

Responsible for creating a HTTP response given the output of a serializer.
"""

from __future__ import absolute_import, division, print_function

from flask import current_app


def record_responsify_nocache(serializer, mimetype):
    """Create a Records-REST response serializer with no cache.

    This is useful for formats such as bibtex where the code that generates
    the format might change so we don't want to use caching

    :param serializer: Serializer instance.
    :param mimetype: MIME type of response.
    """
    def view(pid, record, code=200, headers=None, links_factory=None):
        response = current_app.response_class(
            serializer.serialize(pid, record, links_factory=links_factory),
            mimetype=mimetype)
        response.status_code = code
        if headers is not None:
            response.headers.extend(headers)
        return response
    return view


def facets_responsify(serializer, mimetype):
    """Create a Facets serializer

    As aggregations were removed from search query,
    now second call to the server is required to acquire data for Facets

    Args:
        serializer: Serializer instance.
        mimetype: MIME type of response.

    """

    def view(query_results, code=200, headers=None, links_factory=None):
        response = current_app.response_class(
            serializer.serialize_facets(query_results),
            mimetype=mimetype)
        response.status_code = code
        if headers is not None:
            response.headers.extend(headers)
        return response
    return view