add client portal file

Author: areed1192

ibw/client.py

@@ -16,6 +16,7 @@
 from typing import Dict
 
 from urllib3.exceptions import InsecureRequestWarning
+from ibw.clientportal import ClientPortal
 
 urllib3.disable_warnings(category=InsecureRequestWarning)
 # http = urllib3.PoolManager(cert_reqs='CERT_REQUIRED', ca_certs=certifi.where())
@@ -67,6 +68,7 @@ def __init__(self, username: str, account: str, client_gateway_path: str = None)
 
         self.account = account
         self.username = username
+        self.client_portal_client = ClientPortal()
 
         self.api_version = 'v1/'
         self._operating_system = sys.platform
@@ -80,15 +82,17 @@ def __init__(self, username: str, account: str, client_gateway_path: str = None)
         self.backup_gateway_path = r"https://cdcdyn.interactivebrokers.com/portal.proxy"     
 
         if client_gateway_path is None:
-            try:
-                # Grab the Client Portal Path.
-                self.client_portal_folder = pathlib.Path(__file__).parents[1].joinpath(
-                    'resources/clientportal.beta.gw'
-                ).resolve()
-            except FileNotFoundError:
-                raise FileNotFoundError(
-                        "The Client Portal Gateway doesn't exist. You need to download it before using the Library."
-                    )
+
+            # Grab the Client Portal Path.
+            self.client_portal_folder: pathlib.Path = pathlib.Path(__file__).parents[1].joinpath(
+                'resources/clientportal.beta.gw'
+            ).resolve()
+
+            # See if it exists.
+            if not self.client_portal_folder.exists():
+                print("The Client Portal Gateway doesn't exist. You need to download it before using the Library.")
+                print("Downloading the Client Portal file...")
+                self.client_portal_client.download_and_extract()
 
         else:
             self.client_portal_folder = client_gateway_path

ibw/clientportal.py

@@ -0,0 +1,101 @@
+import io
+import pathlib
+import requests
+import zipfile
+
+class ClientPortal():
+
+    def does_resources_directory_exist(self) -> bool:
+        """Used to determine if the resources folder exist.
+
+        Returns:
+        bool: `True` if it exists, `False` otherwise.
+        """        
+        
+        # Grab the resources folder.
+        resoruces_folder: pathlib.Path = pathlib.Path(__file__).parent.joinpath(
+            'resources'
+        ).resolve
+
+        return resoruces_folder.exists()
+
+    def make_resources_directory(self) -> None:
+        """Makes the resource folder if it doesn't exist."""        
+
+        if not self.does_resources_directory_exist:
+            resoruces_folder: pathlib.Path = pathlib.Path(__file__).parent.joinpath(
+                'resources'
+            ).resolve
+            resoruces_folder.mkdir(parents=True)
+
+    def download_folder(self) -> str:
+        """Defines the folder to download the Client Portal to.
+
+        Returns:
+        str: The path to the folder.
+        """        
+
+        # Define the download folder.
+        download_folder = pathlib.Path(__file__).parent.joinpath(
+            'resources/clientportal.beta.gw'
+        ).resolve()
+
+        return download_folder
+
+    def download_client_portal(self) -> requests.Response:
+        """Downloads the Client Portal from Interactive Brokers.
+
+        Returns:
+        requests.Response: A response object with clientportal content.
+        """        
+
+        # Request the Client Portal
+        response = requests.get(
+            url='https://download2.interactivebrokers.com/portal/clientportal.beta.gw.zip'
+        )
+
+        return response
+
+    def create_zip_file(self, response_content: requests.Response) -> zipfile.ZipFile:
+        """Creates a zip file to house the client portal content.
+
+        Arguments:
+        ----
+        response_content (requests.Response): The response object with the 
+            client portal content.
+
+        Returns:
+        ----
+        zipfile.ZipFile: A zip file object with the Client Portal.
+        """        
+
+        # Download the Zip File.
+        zip_file_content = zipfile.ZipFile(io.BytesIO(response_content.content))
+
+        return zip_file_content
+
+    def extract_zip_file(self, zip_file: zipfile.ZipFile) -> None:
+        """Extracts the Zip File.
+
+        Arguments:
+        ----
+        zip_file (zipfile.ZipFile): The client portal zip file to be extracted.
+        """        
+
+        # Extract the Content to the new folder.
+        zip_file.extractall(path="resources/clientportal.beta.gw")
+
+    def download_and_extract(self) -> None:
+        """Downloads and extracts the client portal object."""
+
+        # Make the resource directory if needed.
+        self.make_resources_directory()        
+        
+        # Download it.
+        client_portal_response = self.download_client_portal()
+
+        # Create a zip file.
+        client_portal_zip = self.create_zip_file(response_content=client_portal_response)
+
+        # Extract it.
+        self.extract_zip_file(zip_file=client_portal_zip)

setup.py

@@ -17,7 +17,7 @@
 
       # I'm in alpha development still, so a compliant version number is a1.
       # read this as MAJOR VERSION 0, MINOR VERSION 1, MAINTENANCE VERSION 0
-      version='0.1.0',
+      version='0.1.2',
       description='A python client library for the Interactive Broker Web API.',
 
       # I have a long description but that will just be my README file.