Provide response text passthrough for GPX-formatted requests (#67)

Author: jayaddison

openrouteservice/client.py

@@ -20,6 +20,7 @@
 
 from datetime import datetime
 from datetime import timedelta
+import cgi
 import functools
 import requests
 import json
@@ -257,10 +258,15 @@ def req(self):
     @staticmethod
     def _get_body(response):
         """Returns the body of a response object, raises status code exceptions if necessary."""
-        try:
-            body = response.json()
-        except json.JSONDecodeError:  # pragma: no cover
-            raise exceptions.HTTPError(response.status_code)
+        content_type = response.headers["Content-Type"]
+        mime_type, _ = cgi.parse_header(content_type)
+        if mime_type == "application/gpx+xml":
+            body = response.text
+        else:
+            try:
+                body = response.json()
+            except json.JSONDecodeError:  # pragma: no cover
+                raise exceptions.HTTPError(response.status_code)
 
         # error = body.get('error')
         status_code = response.status_code

openrouteservice/directions.py

@@ -71,7 +71,7 @@ def directions(
     :param format: Specifies the response format. One of ['json', 'geojson', 'gpx']. Default "json".
         Geometry format for "json" is Google's encodedpolyline. The GPX schema the response is validated
         against can be found here:
-        https://raw.githubusercontent.com/GIScience/openrouteservice-schema/master/gpx/v1/ors-gpx.xsd.
+        https://raw.githubusercontent.com/GIScience/openrouteservice-schema/master/gpx/v2/ors-gpx.xsd.
     :type format: str
 
     :param format_out: DEPRECATED.

test/test_directions.py

@@ -25,7 +25,7 @@
 from copy import deepcopy
 
 from openrouteservice import exceptions
-from test.test_helper import ENDPOINT_DICT
+from test.test_helper import ENDPOINT_DICT, GPX_RESPONSE
 
 
 class DirectionsTest(_test.TestCase):
@@ -48,6 +48,26 @@ def test_directions(self):
         self.assertEqual(resp, self.valid_query)
         self.assertIn("sample_key", responses.calls[0].request.headers.values())
 
+    @responses.activate
+    def test_directions_gpx(self):
+        query = deepcopy(self.valid_query)
+        query["format"] = "gpx"
+
+        responses.add(
+            responses.POST,
+            "https://api.openrouteservice.org/v2/directions/{}/gpx".format(
+                self.valid_query["profile"]
+            ),
+            body=GPX_RESPONSE,
+            status=200,
+            content_type="application/gpx+xml;charset=UTF-8",
+        )
+
+        resp = self.client.directions(**query)
+
+        self.assertEqual(resp, GPX_RESPONSE)
+        self.assertIn("sample_key", responses.calls[0].request.headers.values())
+
     @responses.activate
     def test_directions_incompatible_parameters(self):
         self.valid_query["optimized"] = True

test/test_helper.py

@@ -225,3 +225,29 @@
         "matrix": PARAM_LIST_TWO,
     },
 }
+
+GPX_RESPONSE = """
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<gpx version="1.0" creator="openrouteservice" xmlns="https://raw.githubusercontent.com/GIScience/openrouteservice-schema/master/gpx/v2/ors-gpx.xsd">
+  <metadata>
+    <name>openrouteservice directions</name>
+    <desc>This is a directions instructions file as GPX, generated from openrouteservice</desc>
+    <author><name>openrouteservice</name>
+      <email id="support" domain="openrouteservice.heigit.org"/>
+      <link href="https://openrouteservice.org/">
+        <text>https://openrouteservice.org/</text>
+        <type>text/html</type>
+      </link>
+    </author>
+    <copyright author="openrouteservice.org | OpenStreetMap contributors">
+      <year>2021</year>
+      <license>LGPL 3.0</license>
+    </copyright>
+    <time>2021-07-25T17:26:59.023Z</time>
+    <bounds maxLat="51.501602" maxLon="0.147508" minLat="51.185303" minLon="-0.076743"/>
+    <extensions>
+      <system-message></system-message>
+    </extensions>
+  </metadata>
+</gpx>
+"""