Merge pull request #30 from sbarbett/pr-backlog

Functionalities from PR backlog - PRs# 6, 7, 8 - Proxy support, resign zones, RD pool support

Author: stevedejong

.plugin-version

@@ -1 +1 @@
-v2.2.4
+v2.2.5

README.md

@@ -115,6 +115,45 @@ Headers can also be modified after instantiation using the `set_custom_headers()
 client.rest_api_connection.set_custom_headers({"boo":"far","user-agent":"goodbye"})
 ```
 
+### Proxying Requests
+
+In situations where the client needs to send requests from an application behind a proxy, proxy details can be supplied as part of the constructor:
+
+```python
+# Define proxy settings using the format required by the `requests` library
+proxy_dict = {
+    "http": "http://proxy.example.com:8080",
+    "https": "http://proxy.example.com:8080"
+}
+
+# Initialize the client with a proxy
+client = RestApiClient(
+    "username",
+    "password",
+    proxy=proxy_dict
+)
+
+# Make an API request with the proxy enabled
+response = client.create_primary_zone("my_account", "example.com")
+
+# Update the proxy dynamically if needed
+client.rest_api_connection.set_proxy({
+    "http": "http://newproxy.example.com:8080",
+    "https": "http://newproxy.example.com:8080"
+})
+```
+
+If desired, TLS validation may be disabled using the `verify_https` flag.
+
+```python
+client = RestApiClient(
+    "username",
+    "password",
+    proxy=proxy_dict,
+    verify_https=False
+)
+```
+
 ### Quick Examples
 This example shows a complete working python file which will create a primary zone in UltraDNS. This example highlights how to get services using client and make requests.
 
@@ -161,6 +200,26 @@ def create_cname_record(client, domain):
     """
     return client.create_rrset(domain, "CNAME", f"www.{domain}", 300, [domain])
 
+def create_rd_pool(client, domain):
+    """Create a pool of A records in UltraDNS. This function will create an RD pool within the specified domain.
+
+    Args:
+    - client (RestApiClient): An instance of the RestApiClient class.
+    - domain (str): The domain name.
+
+    Returns:
+    - dict: The response body.
+    """
+    return client.create_rd_pool(
+        domain, 
+        "pool",
+        300,
+        [
+            "192.0.2.2",
+            "192.0.2.3"
+        ]
+    )
+
 def delete_zone(client, domain):
     """Delete the zone from UltraDNS.
 

src/ultra_rest_client/about.py

@@ -1,4 +1,4 @@
-__version__ = "2.2.4"
+__version__ = "0.0.0"
 PREFIX = "udns-python-rest-client-"
 
 def get_client_user_agent():

src/ultra_rest_client/connection.py

@@ -9,6 +9,8 @@
 import requests
 import time
 from .about import get_client_user_agent
+import urllib3
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
 class AuthError(Exception):
     def __init__(self, message):
@@ -30,30 +32,14 @@ class RestApiConnection:
     # Don't let users set these headers
     FORBIDDEN_HEADERS = {"Authorization", "Content-Type", "Accept"}
 
-    def __init__(self, use_http=False, host="api.ultradns.com", access_token: str = "", refresh_token: str = "", custom_headers=None):
+    def __init__(self, use_http=False, host="api.ultradns.com", access_token: str = "", refresh_token: str = "", custom_headers=None, proxy=None, verify_https=True):
         self.use_http = use_http
         self.host = host
         self.access_token = access_token
         self.refresh_token = refresh_token
         self.custom_headers = custom_headers or {}
-
-    def _validate_custom_headers(self, headers):
-        """Ensure no forbidden headers are being set by the user."""
-        for header in headers.keys():
-            if header in self.FORBIDDEN_HEADERS:
-                raise ValueError(f"Custom headers cannot include '{header}'.")
-
-    def set_custom_headers(self, headers):
-        """Update custom headers after instantiation."""
-        self._validate_custom_headers(headers)
-        self.custom_headers.update(headers)
-
-    def _get_connection(self):
-        if self.host.startswith("https://") or self.host.startswith("http://"):
-            return self.host
-        else:
-            protocol = "http://" if self.use_http else "https://"
-            return protocol + self.host
+        self.proxy = proxy
+        self.verify_https = verify_https
 
     # Authentication
     # We need the ability to take in a username and password and get
@@ -69,7 +55,12 @@ def auth(self, username, password):
             "username":username,
             "password":password
         }
-        response = requests.post(f"{host}/v1/authorization/token", data=payload)
+        response = requests.post(
+            f"{host}/v1/authorization/token", 
+            data=payload,
+            proxies=self.proxy,
+            verify=self.verify_https
+        )
         if response.status_code == requests.codes.OK:
             json_body = response.json()
             self.access_token = json_body.get('accessToken')
@@ -83,14 +74,27 @@ def _refresh(self):
             "grant_type":"refresh_token",
             "refresh_token":self.refresh_token
         }
-        response = requests.post(f"{host}/v1/authorization/token", data=payload)
+        response = requests.post(
+            f"{host}/v1/authorization/token", 
+            data=payload,
+            proxies=self.proxy,
+            verify=self.verify_https
+        )
         if response.status_code == requests.codes.OK:
             json_body = response.json()
             self.access_token = json_body.get('accessToken')
             self.refresh_token = json_body.get('refreshToken')
         else:
             raise AuthError(response.json())
 
+    # Private Utility Methods
+
+    def _validate_custom_headers(self, headers):
+        """Ensure no forbidden headers are being set by the user."""
+        for header in headers.keys():
+            if header in self.FORBIDDEN_HEADERS:
+                raise ValueError(f"Custom headers cannot include '{header}'.")
+
     def _build_headers(self, content_type):
         """Construct headers by merging default, custom, and per-request headers."""
         headers = {
@@ -105,25 +109,14 @@ def _build_headers(self, content_type):
 
         return headers
 
-    def get(self, uri, params=None):
-        params = params or {}
-        return self._do_call(uri, "GET", params=params)
-
-    def post_multi_part(self, uri, files):
-        #use empty string for content type so we don't set it
-        return self._do_call(uri, "POST", files=files, content_type=None)
-
-    def post(self, uri, json=None):
-        return self._do_call(uri, "POST", body=json) if json is not None else self._do_call(uri, "POST")
-
-    def put(self, uri, json):
-        return self._do_call(uri, "PUT", body=json)
+    def _get_connection(self):
+        if self.host.startswith("https://") or self.host.startswith("http://"):
+            return self.host
+        else:
+            protocol = "http://" if self.use_http else "https://"
+            return protocol + self.host
 
-    def patch(self, uri, json):
-        return self._do_call(uri, "PATCH", body=json)
-
-    def delete(self, uri):
-        return self._do_call(uri, "DELETE")
+    # Main Request Method
 
     def _do_call(self, uri, method, params=None, body=None, retry=True, files=None, content_type="application/json"):
         host = self._get_connection()
@@ -133,7 +126,9 @@ def _do_call(self, uri, method, params=None, body=None, retry=True, files=None,
             params=params,
             data=body,
             headers=self._build_headers(content_type),
-            files=files
+            files=files,
+            proxies=self.proxy,
+            verify=self.verify_https
         )
         if response.status_code == requests.codes.NO_CONTENT:
             return {}
@@ -171,3 +166,36 @@ def _do_call(self, uri, method, params=None, body=None, retry=True, files=None,
             return self._do_call(uri, method, params, body, False)
 
         return json_body
+
+    # Public HTTP Methods
+
+    def get(self, uri, params=None):
+        params = params or {}
+        return self._do_call(uri, "GET", params=params)
+
+    def post_multi_part(self, uri, files):
+        #use empty string for content type so we don't set it
+        return self._do_call(uri, "POST", files=files, content_type=None)
+
+    def post(self, uri, json=None):
+        return self._do_call(uri, "POST", body=json) if json is not None else self._do_call(uri, "POST")
+
+    def put(self, uri, json):
+        return self._do_call(uri, "PUT", body=json)
+
+    def patch(self, uri, json):
+        return self._do_call(uri, "PATCH", body=json)
+
+    def delete(self, uri):
+        return self._do_call(uri, "DELETE")
+    
+    # Public Utility Methods
+    
+    def set_custom_headers(self, headers):
+        """Update custom headers after instantiation."""
+        self._validate_custom_headers(headers)
+        self.custom_headers.update(headers)
+
+    def set_proxy(self, proxy):
+        """Update the proxy configuration."""
+        self.proxy = proxy