Merge pull request #192 from smart-on-fhir/mikix/headers

server: send correct Accept=application/fhir+json HTTP headers

Author: mikix

README.md

@@ -53,7 +53,7 @@ patient = Patient.read('2cda5aad-e409-4070-9a15-e1c35c46ed5a', smart.server)
 print(patient.birthDate.isostring)
 # '1992-07-03'
 print(smart.human_name(patient.name[0]))
-# 'Mr. Geoffrey Abbott'
+# 'Mr. steve Smith'
 ```
 If this is a protected server, you will first have to send your user to the authorization endpoint to log in.
 Just call `smart.authorize_url` to obtain the correct URL.
@@ -90,7 +90,7 @@ from fhirclient.models.patient import Patient
 smart = server.FHIRServer(None, 'https://r4.smarthealthit.org')
 patient = Patient.read('2cda5aad-e409-4070-9a15-e1c35c46ed5a', smart)
 print(patient.name[0].given)
-# ['Geoffrey']
+# ['steve']
 ```
 
 ##### Search Records on Server

docs/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "SMART on FHIR Python Client"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 4.3.1
+PROJECT_NUMBER         = 4.3.2
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

fhirclient/client.py

@@ -1,7 +1,7 @@
 import logging
 from .server import FHIRServer, FHIRUnauthorizedException, FHIRNotFoundException
 
-__version__ = '4.3.1'
+__version__ = '4.3.2'  # Update docs/Doxyfile too when you bump this
 __author__ = 'SMART Platforms Team'
 __license__ = 'APACHE2'
 __copyright__ = "Copyright 2017 Boston Children's Hospital"

fhirclient/server.py

@@ -159,19 +159,18 @@ def request_json(self, path, nosign=False):
         :throws: Exception on HTTP status >= 400
         :returns: Decoded JSON response
         """
-        headers = {'Accept': 'application/json'}
-        res = self._get(path, headers, nosign)
+        res = self._get(path, nosign=nosign)
 
         return res.json()
 
-    def request_data(self, path, headers={}, nosign=False):
+    def request_data(self, path, headers=None, nosign=False):
         """ Perform a data request data against the server's base with the
         given relative path.
         """
-        res = self._get(path, headers, nosign)
+        res = self._get(path, headers=headers, nosign=nosign)
         return res.content
 
-    def _get(self, path, headers={}, nosign=False):
+    def _get(self, path, headers=None, nosign=False):
         """ Issues a GET request.
         
         :returns: The response object
@@ -184,7 +183,8 @@ def _get(self, path, headers={}, nosign=False):
             'Accept-Charset': 'UTF-8',
         }
         # merge in user headers with defaults
-        header_defaults.update(headers)
+        if headers:
+            header_defaults.update(headers)
         # use the merged headers in the request
         headers = header_defaults
         if not nosign and self.auth is not None and self.auth.can_sign_headers():
@@ -251,10 +251,6 @@ def post_as_form(self, url, formdata, auth=None):
         :throws: Exception on HTTP status >= 400
         :returns: The response object
         """
-        headers = {
-            'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8',
-            'Accept': 'application/json',
-        }
         res = self.session.post(url, data=formdata, auth=auth)
         self.raise_for_status(res)
         return res
@@ -276,7 +272,7 @@ def delete_json(self, path, nosign=False):
             headers = self.auth.signed_headers(headers)
 
         # perform the request but intercept 401 responses, raising our own Exception
-        res = self.session.delete(url)
+        res = self.session.delete(url, headers=headers)
         self.raise_for_status(res)
         return res
 

tests/server_test.py

@@ -5,6 +5,9 @@
 import tempfile
 import unittest
 
+import requests
+import responses
+
 from fhirclient import server
 
 
@@ -17,6 +20,24 @@ def copy_metadata(filename: str, tmpdir: str) -> None:
             os.path.join(tmpdir, 'metadata')
         )
 
+    @staticmethod
+    def create_server() -> server.FHIRServer:
+        return server.FHIRServer(None, state={
+            'base_uri': "https://example.invalid/",
+            "auth_type": "oauth2",
+            "auth": {
+                "aud": "https://example.invalid/",
+                "registration_uri": "https://example.invalid/o2/registration",
+                "authorize_uri": "https://example.invalid/o2/authorize",
+                "redirect_uri": "https://example.invalid/o2/redirect",
+                "token_uri": "https://example.invalid/o2/token",
+                "auth_state": "931f4c31-73e2-4c04-bf6b-b7c9800312ea",
+                "app_secret": "my-secret",
+                "access_token": "my-access-token",
+                "refresh_token": "my-refresh-token",
+            },
+        })
+
     def testValidCapabilityStatement(self):
         with tempfile.TemporaryDirectory() as tmpdir:
             self.copy_metadata('test_metadata_valid.json', tmpdir)
@@ -59,6 +80,49 @@ def testInvalidCapabilityStatement(self):
                 self.assertEqual("Superfluous entry \"systems\"", str(e.errors[2].errors[1].errors[0].errors[0].errors[0])[:27])
                 self.assertEqual("Superfluous entry \"formats\"", str(e.errors[3])[:27])
 
+    @responses.activate
+    def testRequestJson(self):
+        fhir = self.create_server()
+        fhir.prepare()
+
+        bin1 = {"resourceType": "Binary", "id": "bin1"}
+        mock = responses.add("GET", f"{fhir.base_uri}Binary/bin1", json=bin1)
+
+        resp = fhir.request_json("Binary/bin1")
+        self.assertEqual(resp, bin1)
+        self.assertEqual(mock.calls[0].request.headers["Accept"], "application/fhir+json")
+        self.assertEqual(mock.calls[0].request.headers["Accept-Charset"], "UTF-8")
+        self.assertEqual(mock.calls[0].request.headers["Authorization"], "Bearer my-access-token")
+
+        resp = fhir.request_json("Binary/bin1", nosign=True)
+        self.assertEqual(resp, bin1)
+        self.assertEqual(mock.calls[1].request.headers["Accept"], "application/fhir+json")
+        self.assertEqual(mock.calls[1].request.headers["Accept-Charset"], "UTF-8")
+        self.assertNotIn("Authorization", mock.calls[1].request.headers)
+
+        self.assertEqual(mock.call_count, 2)
+
+    @responses.activate
+    def testDeleteJson(self):
+        fhir = self.create_server()
+        fhir.prepare()
+
+        mock = responses.add("DELETE", f"{fhir.base_uri}Binary/bin1")
+
+        resp = fhir.delete_json("Binary/bin1")
+        self.assertIsInstance(resp, requests.Response)
+        self.assertEqual(mock.calls[0].request.headers["Accept"], "application/fhir+json")
+        self.assertEqual(mock.calls[0].request.headers["Accept-Charset"], "UTF-8")
+        self.assertEqual(mock.calls[0].request.headers["Authorization"], "Bearer my-access-token")
+
+        resp = fhir.delete_json("Binary/bin1", nosign=True)
+        self.assertIsInstance(resp, requests.Response)
+        self.assertEqual(mock.calls[1].request.headers["Accept"], "application/fhir+json")
+        self.assertEqual(mock.calls[1].request.headers["Accept-Charset"], "UTF-8")
+        self.assertNotIn("Authorization", mock.calls[1].request.headers)
+
+        self.assertEqual(mock.call_count, 2)
+
 
 class MockServer(server.FHIRServer):
     """ Reads local files.