Embed the code from the negotiate package in the sources

so that we do have to manage yet another dependecy; the code is small and has
not been modified for years.

requirements.txt

@@ -8,4 +8,4 @@ PyYAML
 requests
 Flask
 systemd-python
-negotiate
+decorator

swh/core/api/__init__.py

@@ -12,16 +12,39 @@ import pickle
 import requests
 import datetime
 
-from flask import Flask, Request, Response
+from flask import Flask, Request, Response, request, abort
 from .serializers import (decode_response,
                           encode_data_client as encode_data,
                           msgpack_dumps, msgpack_loads, SWHJSONDecoder)
 
-from negotiate.flask import Formatter
+from .negotiate import (Formatter as FormatterBase,
+                        Negotiator as NegotiatorBase,
+                        negotiate as _negotiate)
+
 
 logger = logging.getLogger(__name__)
 
 
+# support for content negotation
+
+class Negotiator(NegotiatorBase):
+    def best_mimetype(self):
+        return request.accept_mimetypes.best_match(
+            self.accept_mimetypes, 'text/html')
+
+    def _abort(self, status_code, err=None):
+        return abort(status_code, err)
+
+
+def negotiate(formatter_cls, *args, **kwargs):
+    return _negotiate(Negotiator, formatter_cls, *args, **kwargs)
+
+
+class Formatter(FormatterBase):
+    def _make_response(self, body, content_type):
+        return Response(body, content_type=content_type)
+
+
 class SWHJSONEncoder(json.JSONEncoder):
     def default(self, obj):
         if isinstance(obj, (datetime.datetime, datetime.date)):
@@ -48,6 +71,8 @@ class MsgpackFormatter(Formatter):
         return msgpack_dumps(obj)
 
 
+# base API classes
+
 class RemoteException(Exception):
     pass
 

swh/core/api/negotiate.py

+# This code is a partial and adapted copy of
+#   https://github.com/nickstenning/negotiate
+#
+# Copyright 2012-2013 Nick Stenning
+#           2019 The Software Heritage developers
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+from collections import defaultdict
+from decorator import decorator
+
+from inspect import getcallargs
+
+
+class FormatterNotFound(Exception):
+    pass
+
+
+class Formatter:
+    format = None
+    mimetypes = []
+
+    def __init__(self, request_mimetype=None):
+        if request_mimetype is None or request_mimetype not in self.mimetypes:
+            try:
+                self.response_mimetype = self.mimetypes[0]
+            except IndexError:
+                raise NotImplementedError(
+                    "%s.mimetypes should be a non-empty list" %
+                    self.__class__.__name__)
+        else:
+            self.response_mimetype = request_mimetype
+
+    def configure(self):
+        pass
+
+    def render(self, obj):
+        raise NotImplementedError(
+            "render() should be implemented by Formatter subclasses")
+
+    def __call__(self, obj):
+        return self._make_response(
+            self.render(obj), content_type=self.response_mimetype)
+
+    def _make_response(self, body, content_type):
+        raise NotImplementedError(
+            "_make_response() should be implemented by "
+            "framework-specific subclasses of Formatter"
+        )
+
+
+class Negotiator:
+
+    def __init__(self, func):
+        self.func = func
+        self._formatters = []
+        self._formatters_by_format = defaultdict(list)
+        self._formatters_by_mimetype = defaultdict(list)
+
+    def __call__(self, *args, **kwargs):
+        result = self.func(*args, **kwargs)
+        format = getcallargs(self.func, *args, **kwargs).get('format')
+        mimetype = self.best_mimetype()
+
+        try:
+            formatter = self.get_formatter(format, mimetype)
+        except FormatterNotFound as e:
+            return self._abort(404, str(e))
+
+        return formatter(result)
+
+    def register_formatter(self, formatter, *args, **kwargs):
+        self._formatters.append(formatter)
+        self._formatters_by_format[formatter.format].append(
+            (formatter, args, kwargs))
+        for mimetype in formatter.mimetypes:
+            self._formatters_by_mimetype[mimetype].append(
+                (formatter, args, kwargs))
+
+    def get_formatter(self, format=None, mimetype=None):
+        if format is None and mimetype is None:
+            raise TypeError(
+                "get_formatter expects one of the 'format' or 'mimetype' "
+                "kwargs to be set")
+
+        if format is not None:
+            try:
+                # the first added will be the most specific
+                formatter_cls, args, kwargs = (
+                    self._formatters_by_format[format][0])
+            except IndexError:
+                raise FormatterNotFound(
+                    "Formatter for format '%s' not found!" % format)
+        elif mimetype is not None:
+            try:
+                # the first added will be the most specific
+                formatter_cls, args, kwargs = (
+                    self._formatters_by_mimetype[mimetype][0])
+            except IndexError:
+                raise FormatterNotFound(
+                    "Formatter for mimetype '%s' not found!" % mimetype)
+
+        formatter = formatter_cls(request_mimetype=mimetype)
+        formatter.configure(*args, **kwargs)
+        return formatter
+
+    @property
+    def accept_mimetypes(self):
+        return [m for f in self._formatters for m in f.mimetypes]
+
+    def best_mimetype(self):
+        raise NotImplementedError(
+            "best_mimetype() should be implemented in "
+            "framework-specific subclasses of Negotiator"
+        )
+
+    def _abort(self, status_code, err=None):
+        raise NotImplementedError(
+            "_abort() should be implemented in framework-specific "
+            "subclasses of Negotiator"
+        )
+
+
+def negotiate(negotiator_cls, formatter_cls, *args, **kwargs):
+    def _negotiate(f, *args, **kwargs):
+        return f.negotiator(*args, **kwargs)
+
+    def decorate(f):
+        if not hasattr(f, 'negotiator'):
+            f.negotiator = negotiator_cls(f)
+
+        f.negotiator.register_formatter(formatter_cls, *args, **kwargs)
+        return decorator(_negotiate, f)
+
+    return decorate