Merge pull request #33 from prodigyeducation/support-options

Support Advanced Usages

Author: DaleSeo

.pre-commit-config.yaml

@@ -1,11 +1,11 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: stable
+    rev: 20.8b1
     hooks:
       - id: black
-        language_version: python3.8
+        language_version: python3
   - repo: https://gitlab.com/pycqa/flake8
-    rev: ""
+    rev: "3.8.4"
     hooks:
       - id: flake8
         additional_dependencies: [flake8-docstrings, flake8-isort]

README.md

@@ -18,7 +18,7 @@ pip install python-graphql-client
 
 - Query/Mutation
 
-```python
+```py
 from python_graphql_client import GraphqlClient
 
 # Instantiate the client with an endpoint.
@@ -49,7 +49,7 @@ print(data)  # => {'data': {'country': {'code': 'CA', 'name': 'Canada'}}}
 
 - Subscription
 
-```python
+```py
 from python_graphql_client import GraphqlClient
 
 # Instantiate the client with a websocket endpoint.
@@ -72,6 +72,37 @@ asyncio.run(client.subscribe(query=query, handle=print))
 # ...
 ```
 
+## Advanced Usage
+
+### Disable SSL verification
+
+Set the keyword argument `verify=False` ether when instantiating the `GraphqlClient` class.
+
+```py
+from python_graphql_client import GraphqlClient
+
+client = GraphqlClient(endpoint="wss://www.your-api.com/graphql", verify=False)
+```
+
+Alternatively, you can set it when calling the `execute` method.
+
+```py
+from python_graphql_client import GraphqlClient
+
+client = GraphqlClient(endpoint="wss://www.your-api.com/graphql"
+client.execute(query="<Your Query>", verify=False)
+```
+
+### Custom Authentication
+
+```py
+from requests.auth import HTTPBasicAuth
+from python_graphql_client import GraphqlClient
+
+auth = HTTPBasicAuth('fake@example.com', 'not_a_real_password')
+client = GraphqlClient(endpoint="wss://www.your-api.com/graphql", auth=auth)
+```
+
 ## Roadmap
 
 To start we'll try and use a Github project board for listing current work and updating priorities of upcoming features.

python_graphql_client/graphql_client.py

@@ -1,7 +1,7 @@
 """Module containing graphQL client."""
 import json
 import logging
-from typing import Callable
+from typing import Any, Callable
 
 import aiohttp
 import requests
@@ -13,10 +13,11 @@
 class GraphqlClient:
     """Class which represents the interface to make graphQL requests through."""
 
-    def __init__(self, endpoint: str, headers: dict = None):
+    def __init__(self, endpoint: str, headers: dict = {}, **kwargs: Any):
         """Insantiate the client."""
         self.endpoint = endpoint
-        self.headers = headers or {}
+        self.headers = headers
+        self.options = kwargs
 
     def __request_body(
         self, query: str, variables: dict = None, operation_name: str = None
@@ -31,15 +32,13 @@ def __request_body(
 
         return json
 
-    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,
+        headers: dict = {},
+        **kwargs: Any,
     ):
         """Make synchronous request to graphQL server."""
         request_body = self.__request_body(
@@ -49,7 +48,8 @@ def execute(
         result = requests.post(
             self.endpoint,
             json=request_body,
-            headers=self.__request_headers(headers),
+            headers={**self.headers, **headers},
+            **{**self.options, **kwargs},
         )
 
         result.raise_for_status()
@@ -60,7 +60,7 @@ async def execute_async(
         query: str,
         variables: dict = None,
         operation_name: str = None,
-        headers: dict = None,
+        headers: dict = {},
     ):
         """Make asynchronous request to graphQL server."""
         request_body = self.__request_body(
@@ -71,7 +71,7 @@ async def execute_async(
             async with session.post(
                 self.endpoint,
                 json=request_body,
-                headers=self.__request_headers(headers),
+                headers={**self.headers, **headers},
             ) as response:
                 return await response.json()
 
@@ -81,7 +81,7 @@ async def subscribe(
         handle: Callable,
         variables: dict = None,
         operation_name: str = None,
-        headers: dict = None,
+        headers: dict = {},
     ):
         """Make asynchronous request for GraphQL subscription."""
         connection_init_message = json.dumps({"type": "connection_init", "payload": {}})
@@ -96,7 +96,7 @@ async def subscribe(
         async with websockets.connect(
             self.endpoint,
             subprotocols=["graphql-ws"],
-            extra_headers=self.__request_headers(headers),
+            extra_headers={**self.headers, **headers},
         ) as websocket:
             await websocket.send(connection_init_message)
             await websocket.send(request_message)

tests/test_graphql_client.py

@@ -4,6 +4,7 @@
 from unittest.mock import AsyncMock, MagicMock, call, patch
 
 from aiohttp import web
+from requests.auth import HTTPBasicAuth
 from requests.exceptions import HTTPError
 
 from python_graphql_client import GraphqlClient
@@ -98,6 +99,25 @@ def test_execute_query_with_headers(self, post_mock):
             },
         )
 
+    @patch("python_graphql_client.graphql_client.requests.post")
+    def test_execute_query_with_options(self, post_mock):
+        """Sends a graphql POST request with headers."""
+        auth = HTTPBasicAuth("fake@example.com", "not_a_real_password")
+        client = GraphqlClient(
+            endpoint="http://www.test-api.com/",
+            auth=auth,
+        )
+        query = ""
+        client.execute(query=query, verify=False)
+
+        post_mock.assert_called_once_with(
+            "http://www.test-api.com/",
+            json={"query": query},
+            headers={},
+            auth=HTTPBasicAuth("fake@example.com", "not_a_real_password"),
+            verify=False,
+        )
+
     @patch("python_graphql_client.graphql_client.requests.post")
     def test_execute_query_with_operation_name(self, post_mock):
         """Sends a graphql POST request with the operationName key set."""
@@ -302,8 +322,4 @@ async def test_headers_passed_to_websocket_connect(self, mock_connect):
             extra_headers=expected_headers,
         )
 
-        mock_handle.assert_has_calls(
-            [
-                call({"data": {"messageAdded": "one"}}),
-            ]
-        )
+        mock_handle.assert_has_calls([call({"data": {"messageAdded": "one"}})])