Merge pull request #18 from kimcharli/master

Added socks5 proxy support

Author: dariomi

README.md

@@ -30,7 +30,12 @@ import logging
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
-aciclient = aciClient.ACI(apic_hostname, apic_username, apic_password, refresh=False)
+proxies = {
+    'http': 'socks5://127.0.0.1:1080',
+    'https': 'socks5://127.0.0.1:1080'
+}
+
+aciclient = aciClient.ACI(apic_hostname, apic_username, apic_password, refresh=False, proxies=proxies)
 try:
     aciclient.login()
 

aciClient/aci.py

@@ -31,11 +31,12 @@ class ACI:
     # ==============================================================================
     # constructor
     # ==============================================================================
-    def __init__(self, apicIp, apicUser, apicPasword, refresh=False):
+    def __init__(self, apicIp, apicUser, apicPasword, refresh=False, proxies=None):
         self.__logger.debug('Constructor called')
         self.apicIp = apicIp
         self.apicUser = apicUser
         self.apicPassword = apicPasword
+        self.proxies = proxies
 
         self.baseUrl = 'https://' + self.apicIp + '/api/'
         self.__logger.debug(f'BaseUrl set to: {self.baseUrl}')
@@ -75,6 +76,9 @@ def login(self) -> bool:
         self.session.mount('https://', adapter)
         self.__logger.debug('Session Object Created')
 
+        if self.proxies is not None:
+            self.session.proxies = self.proxies
+
         # create credentials structure
         userPass = json.dumps({'aaaUser': {'attributes': {'name': self.apicUser, 'pwd': self.apicPassword}}})
 

requirements.txt

@@ -1,5 +1,6 @@
 pyOpenSSL>=23.0.0, <26
-requests>=2.26.0 , <3
+requests[socks]>=2.26.0 , <3
 requests-mock
 pytest
 flake8
+pysocks==1.7.1

setup.py

@@ -14,7 +14,7 @@
       author_email='nc_dev@netcloud.ch',
       license='MIT',
       packages=['aciClient'],
-      install_requires=['requests>=2.26.0 , <3', 'pyOpenSSL>=23.0.0, <26'],
+      install_requires=['requests[socks]>=2.26.0 , <3', 'pyOpenSSL>=23.0.0, <26', 'PySocks>=1.7.1, <2'],
       long_description=long_description,
       long_description_content_type='text/markdown',
       python_requires=">=3.6",