Merge pull request #10 from prodigyeducation/take-headers

Allow overriding headers when making requests

Author: DaleSeo

docs/CONTRIBUTING.md

@@ -28,7 +28,7 @@ git clone git@github.com:prodigyeducation/python-graphql-client.git
 After that you'll need to install the required python dependencies as well as development dependencies for linting the project.
 
 ```bash
-pip install -e .["dev"]
+pip install -e ."[dev]"
 ```
 
 Finally, you should make sure `pre-commit` has setup the git hooks on your machine by running the following command. This will run the automated checks every time you commit.

python_graphql_client/graphql_client.py

@@ -25,18 +25,34 @@ def __request_body(
 
         return json
 
-    def execute(self, query: str, variables: dict = None, operation_name: str = None):
+    def __request_headers(self, headers: dict = None) -> dict:
+        return {**self.headers, **headers} if headers else self.headers
+
+    def execute(
+        self,
+        query: str,
+        variables: dict = None,
+        operation_name: str = None,
+        headers: dict = None,
+    ):
         """Make synchronous request to graphQL server."""
         request_body = self.__request_body(
             query=query, variables=variables, operation_name=operation_name
         )
 
-        result = requests.post(self.endpoint, json=request_body, headers=self.headers)
+        result = requests.post(
+            self.endpoint, json=request_body, headers=self.__request_headers(headers),
+        )
+
         result.raise_for_status()
         return result.json()
 
     async def execute_async(
-        self, query: str, variables: dict = None, operation_name: str = None
+        self,
+        query: str,
+        variables: dict = None,
+        operation_name: str = None,
+        headers: dict = None,
     ):
         """Make asynchronous request to graphQL server."""
         request_body = self.__request_body(
@@ -45,6 +61,8 @@ async def execute_async(
 
         async with aiohttp.ClientSession() as session:
             async with session.post(
-                self.endpoint, json=request_body, headers=self.headers
+                self.endpoint,
+                json=request_body,
+                headers=self.__request_headers(headers),
             ) as response:
                 return await response.json()

tests/test_graphql_client.py

@@ -83,13 +83,21 @@ def test_raises_http_errors_as_exceptions(self, post_mock):
     @patch("python_graphql_client.graphql_client.requests.post")
     def test_execute_query_with_headers(self, post_mock):
         """Sends a graphql POST request with headers."""
-        headers = {"Content-Type": "application/json"}
-        client = GraphqlClient(endpoint="http://www.test-api.com/", headers=headers)
+        client = GraphqlClient(
+            endpoint="http://www.test-api.com/",
+            headers={"Content-Type": "application/json", "Existing": "123",},
+        )
         query = ""
-        client.execute(query)
+        client.execute(query=query, headers={"Existing": "456", "New": "foo"})
 
         post_mock.assert_called_once_with(
-            "http://www.test-api.com/", json={"query": query}, headers=headers
+            "http://www.test-api.com/",
+            json={"query": query},
+            headers={
+                "Content-Type": "application/json",
+                "Existing": "456",
+                "New": "foo",
+            },
         )
 
     @patch("python_graphql_client.graphql_client.requests.post")
@@ -176,14 +184,22 @@ async def test_execute_query_with_variables(self, mock_post):
     async def test_execute_query_with_headers(self, mock_post):
         """Sends a graphql POST request with headers."""
         mock_post.return_value.__aenter__.return_value.json = CoroutineMock()
-        headers = {"Content-Type": "application/json"}
-        client = GraphqlClient(endpoint="http://www.test-api.com/", headers=headers)
+        client = GraphqlClient(
+            endpoint="http://www.test-api.com/",
+            headers={"Content-Type": "application/json", "Existing": "123",},
+        )
         query = ""
 
-        await client.execute_async(query)
+        await client.execute_async("", headers={"Existing": "456", "New": "foo"})
 
         mock_post.assert_called_once_with(
-            "http://www.test-api.com/", json={"query": query}, headers=headers
+            "http://www.test-api.com/",
+            json={"query": query},
+            headers={
+                "Content-Type": "application/json",
+                "Existing": "456",
+                "New": "foo",
+            },
         )
 
     @unittest_run_loop