Updated with 1.0.0b5 & 0.110.2 releases

Author: Shiyue Cheng

meraki/__init__.py

@@ -81,14 +81,14 @@
 from .api.wireless_health import WirelessHealth
 from .api.wireless_settings import WirelessSettings
 from .config import (
-    API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, WAIT_ON_RATE_LIMIT,
-    NGINX_429_RETRY_WAIT_TIME, ACTION_BATCH_RETRY_WAIT_TIME, RETRY_4XX_ERROR, RETRY_4XX_ERROR_WAIT_TIME,
-    MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE, SUPPRESS_LOGGING, SIMULATE_API_CALLS,
-    BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
+    API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, REQUESTS_PROXY,
+    WAIT_ON_RATE_LIMIT, NGINX_429_RETRY_WAIT_TIME, ACTION_BATCH_RETRY_WAIT_TIME, RETRY_4XX_ERROR,
+    RETRY_4XX_ERROR_WAIT_TIME, MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE,
+    SUPPRESS_LOGGING, SIMULATE_API_CALLS, BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
 )
 
 
-__version__ = '0.110.1'
+__version__ = '0.110.2'
 
 
 class DashboardAPI(object):
@@ -99,6 +99,7 @@ class DashboardAPI(object):
     - base_url (string): preceding all endpoint resources
     - single_request_timeout (integer): maximum number of seconds for each API call
     - certificate_path (string): path for TLS/SSL certificate verification if behind local proxy
+    - requests_proxy (string): proxy server and port, if needed, for HTTPS
     - wait_on_rate_limit (boolean): retry if 429 rate limit error encountered?
     - nginx_429_retry_wait_time (integer): Nginx 429 retry wait time
     - action_batch_retry_wait_time (integer): action batch concurrency error retry wait time
@@ -116,13 +117,13 @@ class DashboardAPI(object):
     """
 
     def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeout=SINGLE_REQUEST_TIMEOUT,
-                 certificate_path=CERTIFICATE_PATH, wait_on_rate_limit=WAIT_ON_RATE_LIMIT,
-                 nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
-                 action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME,
-                 retry_4xx_error=RETRY_4XX_ERROR, retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME,
-                 maximum_retries=MAXIMUM_RETRIES, output_log=OUTPUT_LOG, log_path=LOG_PATH,
-                 log_file_prefix=LOG_FILE_PREFIX, print_console=PRINT_TO_CONSOLE, suppress_logging=SUPPRESS_LOGGING,
-                 simulate=SIMULATE_API_CALLS, be_geo_id=BE_GEO_ID, caller=MERAKI_PYTHON_SDK_CALLER):
+                 certificate_path=CERTIFICATE_PATH, requests_proxy=REQUESTS_PROXY,
+                 wait_on_rate_limit=WAIT_ON_RATE_LIMIT, nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
+                 action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME, retry_4xx_error=RETRY_4XX_ERROR,
+                 retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME, maximum_retries=MAXIMUM_RETRIES,
+                 output_log=OUTPUT_LOG, log_path=LOG_PATH, log_file_prefix=LOG_FILE_PREFIX,
+                 print_console=PRINT_TO_CONSOLE, suppress_logging=SUPPRESS_LOGGING, simulate=SIMULATE_API_CALLS,
+                 be_geo_id=BE_GEO_ID, caller=MERAKI_PYTHON_SDK_CALLER):
         # Check API key
         api_key = api_key or os.environ.get(API_KEY_ENVIRONMENT_VARIABLE)
         if not api_key:
@@ -167,6 +168,7 @@ def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeo
             base_url=base_url,
             single_request_timeout=single_request_timeout,
             certificate_path=certificate_path,
+            requests_proxy=requests_proxy,
             wait_on_rate_limit=wait_on_rate_limit,
             nginx_429_retry_wait_time=nginx_429_retry_wait_time,
             action_batch_retry_wait_time=action_batch_retry_wait_time,

meraki/aio/__init__.py

@@ -80,10 +80,10 @@
 from .api.wireless_health import AsyncWirelessHealth
 from .api.wireless_settings import AsyncWirelessSettings
 from ..config import (
-    API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, WAIT_ON_RATE_LIMIT,
-    NGINX_429_RETRY_WAIT_TIME, ACTION_BATCH_RETRY_WAIT_TIME, RETRY_4XX_ERROR, RETRY_4XX_ERROR_WAIT_TIME,
-    MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE, SUPPRESS_LOGGING, SIMULATE_API_CALLS,
-    AIO_MAXIMUM_CONCURRENT_REQUESTS, BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
+    API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, REQUESTS_PROXY,
+    WAIT_ON_RATE_LIMIT, NGINX_429_RETRY_WAIT_TIME, ACTION_BATCH_RETRY_WAIT_TIME, RETRY_4XX_ERROR,
+    RETRY_4XX_ERROR_WAIT_TIME, MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE,
+    SUPPRESS_LOGGING, SIMULATE_API_CALLS, AIO_MAXIMUM_CONCURRENT_REQUESTS, BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
 )
 
 
@@ -95,6 +95,7 @@ class AsyncDashboardAPI:
     - base_url (string): preceding all endpoint resources
     - single_request_timeout (integer): maximum number of seconds for each API call
     - certificate_path (string): path for TLS/SSL certificate verification if behind local proxy
+    - requests_proxy (string): proxy server and port, if needed, for HTTPS
     - wait_on_rate_limit (boolean): retry if 429 rate limit error encountered?
     - nginx_429_retry_wait_time (integer): Nginx 429 retry wait time
     - action_batch_retry_wait_time (integer): action batch concurrency error retry wait time
@@ -113,14 +114,13 @@ class AsyncDashboardAPI:
     """
 
     def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeout=SINGLE_REQUEST_TIMEOUT,
-                 certificate_path=CERTIFICATE_PATH, wait_on_rate_limit=WAIT_ON_RATE_LIMIT,
-                 nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
-                 action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME,
-                 retry_4xx_error=RETRY_4XX_ERROR, retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME,
-                 maximum_retries=MAXIMUM_RETRIES, output_log=OUTPUT_LOG, log_path=LOG_PATH,
-                 log_file_prefix=LOG_FILE_PREFIX, print_console=PRINT_TO_CONSOLE, suppress_logging=SUPPRESS_LOGGING,
-                 simulate=SIMULATE_API_CALLS, maximum_concurrent_requests=AIO_MAXIMUM_CONCURRENT_REQUESTS,
-                 be_geo_id=BE_GEO_ID, caller=MERAKI_PYTHON_SDK_CALLER):
+                 certificate_path=CERTIFICATE_PATH, requests_proxy=REQUESTS_PROXY,
+                 wait_on_rate_limit=WAIT_ON_RATE_LIMIT, nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
+                 action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME, retry_4xx_error=RETRY_4XX_ERROR,
+                 retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME, maximum_retries=MAXIMUM_RETRIES,
+                 output_log=OUTPUT_LOG, log_path=LOG_PATH, log_file_prefix=LOG_FILE_PREFIX,
+                 print_console=PRINT_TO_CONSOLE, suppress_logging=SUPPRESS_LOGGING, simulate=SIMULATE_API_CALLS,
+                 maximum_concurrent_requests=AIO_MAXIMUM_CONCURRENT_REQUESTS, be_geo_id=BE_GEO_ID, caller=MERAKI_PYTHON_SDK_CALLER):
         # Check API key
         api_key = api_key or os.environ.get(API_KEY_ENVIRONMENT_VARIABLE)
         if not api_key:
@@ -165,6 +165,7 @@ def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeo
             base_url=base_url,
             single_request_timeout=single_request_timeout,
             certificate_path=certificate_path,
+            requests_proxy=requests_proxy,
             wait_on_rate_limit=wait_on_rate_limit,
             nginx_429_retry_wait_time=nginx_429_retry_wait_time,
             action_batch_retry_wait_time=action_batch_retry_wait_time,

meraki/aio/rest_session.py

@@ -64,6 +64,7 @@ def __init__(
         base_url=DEFAULT_BASE_URL,
         single_request_timeout=SINGLE_REQUEST_TIMEOUT,
         certificate_path=CERTIFICATE_PATH,
+        requests_proxy=REQUESTS_PROXY,
         wait_on_rate_limit=WAIT_ON_RATE_LIMIT,
         nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
         action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME,
@@ -82,6 +83,7 @@ def __init__(
         self._base_url = str(base_url)
         self._single_request_timeout = single_request_timeout
         self._certificate_path = certificate_path
+        self._requests_proxy = requests_proxy
         self._wait_on_rate_limit = wait_on_rate_limit
         self._nginx_429_retry_wait_time = nginx_429_retry_wait_time
         self._action_batch_retry_wait_time = action_batch_retry_wait_time
@@ -142,6 +144,8 @@ async def _request(self, metadata, method, url, **kwargs):
         # Update request kwargs with session defaults
         if self._certificate_path:
             kwargs.setdefault("ssl", self._sslcontext)
+        if self._requests_proxy:
+            kwargs.setdefault("proxy", self._requests_proxy)
         kwargs.setdefault("timeout", self._single_request_timeout)
 
         # Ensure proper base URL
@@ -268,26 +272,15 @@ async def get_pages(
 
         # Get additional pages if more than one requested
         while total_pages != 1:
-            # Parse Link from headers
-            links = response.headers["Link"].split(",")
-            first = prev = next = last = None
-            for l in links:
-                if "rel=first" in l:
-                    first = l[l.find("<") + 1 : l.find(">")]
-                elif "rel=prev" in l:
-                    prev = l[l.find("<") + 1 : l.find(">")]
-                elif "rel=next" in l:
-                    next = l[l.find("<") + 1 : l.find(">")]
-                elif "rel=last" in l:
-                    last = l[l.find("<") + 1 : l.find(">")]
+            links = response.links
 
             # GET the subsequent page
-            if direction == "next" and next:
+            if direction == 'next' and "next" in links:
                 metadata["page"] += 1
-                response = await self.request(metadata, "GET", next)
-            elif direction == "prev" and prev:
-                metadata["page"] += 1
-                response = await self.request(metadata, "GET", prev)
+                response = await self.request(metadata, "GET", links["next"]["url"])
+            elif direction == 'prev' and "prev" in links:
+                metadata['page'] += 1
+                response = await self.request(metadata, 'GET', links["prev"]["url"])
             else:
                 break
 

meraki/config.py

@@ -12,6 +12,9 @@
 # Path for TLS/SSL certificate verification if behind local proxy
 CERTIFICATE_PATH = ''
 
+# Proxy server and port, if needed, for HTTPS
+REQUESTS_PROXY = ''
+
 # Retry if 429 rate limit error encountered?
 WAIT_ON_RATE_LIMIT = True
 

meraki/rest_session.py

@@ -63,6 +63,7 @@ def __init__(
         base_url=DEFAULT_BASE_URL,
         single_request_timeout=SINGLE_REQUEST_TIMEOUT,
         certificate_path=CERTIFICATE_PATH,
+        requests_proxy=REQUESTS_PROXY,
         wait_on_rate_limit=WAIT_ON_RATE_LIMIT,
         nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
         action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME,
@@ -80,6 +81,7 @@ def __init__(
         self._base_url = str(base_url)
         self._single_request_timeout = single_request_timeout
         self._certificate_path = certificate_path
+        self._requests_proxy = requests_proxy
         self._wait_on_rate_limit = wait_on_rate_limit
         self._nginx_429_retry_wait_time = nginx_429_retry_wait_time
         self._action_batch_retry_wait_time = action_batch_retry_wait_time
@@ -123,6 +125,8 @@ def request(self, metadata, method, url, **kwargs):
         # Update request kwargs with session defaults
         if self._certificate_path:
             kwargs.setdefault('verify', self._certificate_path)
+        if self._requests_proxy:
+            kwargs.setdefault('proxies', {'https': self._requests_proxy})
         kwargs.setdefault('timeout', self._single_request_timeout)
 
         # Ensure proper base URL
@@ -271,29 +275,17 @@ def get_pages(self, metadata, url, params=None, total_pages=-1, direction='next'
 
         # Get additional pages if more than one requested
         while total_pages != 1:
-            # Parse Link from headers
-            links = response.headers['Link'].split(',')
-            first = prev = next = last = None
-            for l in links:
-                if 'rel=first' in l:
-                    first = l[l.find('<')+1:l.find('>')]
-                elif 'rel=prev' in l:
-                    prev = l[l.find('<')+1:l.find('>')]
-                elif 'rel=next' in l:
-                    next = l[l.find('<')+1:l.find('>')]
-                elif 'rel=last' in l:
-                    last = l[l.find('<')+1:l.find('>')]
-
+            links = response.links
             response.close()
             response = None
 
             # GET the subsequent page
-            if direction == 'next' and next:
+            if direction == 'next' and 'next' in links:
                 metadata['page'] += 1
-                response = self.request(metadata, 'GET', next)
-            elif direction == 'prev' and prev:
+                response = self.request(metadata, 'GET', links['next']['url'])
+            elif direction == 'prev' and 'prev' in links:
                 metadata['page'] += 1
-                response = self.request(metadata, 'GET', prev)
+                response = self.request(metadata, 'GET', links['prev']['url'])
             else:
                 break
 

meraki_v1/__init__.py

@@ -7,21 +7,21 @@
 from .api.organizations import Organizations
 from .api.networks import Networks
 from .api.devices import Devices
-from .api.insight import Insight
-from .api.wireless import Wireless
-from .api.camera import Camera
 from .api.appliance import Appliance
-from .api.switch import Switch
+from .api.camera import Camera
 from .api.cellular_gateway import CellularGateway
+from .api.insight import Insight
 from .api.sm import Sm
+from .api.switch import Switch
+from .api.wireless import Wireless
 from .config import (
-    API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, WAIT_ON_RATE_LIMIT,
-    NGINX_429_RETRY_WAIT_TIME, ACTION_BATCH_RETRY_WAIT_TIME, RETRY_4XX_ERROR, RETRY_4XX_ERROR_WAIT_TIME,
-    MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE, SUPPRESS_LOGGING, SIMULATE_API_CALLS,
-    BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
+    API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, REQUESTS_PROXY,
+    WAIT_ON_RATE_LIMIT, NGINX_429_RETRY_WAIT_TIME, ACTION_BATCH_RETRY_WAIT_TIME, RETRY_4XX_ERROR,
+    RETRY_4XX_ERROR_WAIT_TIME, MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE,
+    SUPPRESS_LOGGING, SIMULATE_API_CALLS, BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
 )
 
-__version__ = '1.0.0b4'
+__version__ = '1.0.0b5'
 
 class DashboardAPI(object):
     """
@@ -31,6 +31,7 @@ class DashboardAPI(object):
     - base_url (string): preceding all endpoint resources
     - single_request_timeout (integer): maximum number of seconds for each API call
     - certificate_path (string): path for TLS/SSL certificate verification if behind local proxy
+    - requests_proxy (string): proxy server and port, if needed, for HTTPS
     - wait_on_rate_limit (boolean): retry if 429 rate limit error encountered?
     - nginx_429_retry_wait_time (integer): Nginx 429 retry wait time
     - action_batch_retry_wait_time (integer): action batch concurrency error retry wait time
@@ -48,13 +49,13 @@ class DashboardAPI(object):
     """
 
     def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeout=SINGLE_REQUEST_TIMEOUT,
-                 certificate_path=CERTIFICATE_PATH, wait_on_rate_limit=WAIT_ON_RATE_LIMIT,
-                 nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
-                 action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME,
-                 retry_4xx_error=RETRY_4XX_ERROR, retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME,
-                 maximum_retries=MAXIMUM_RETRIES, output_log=OUTPUT_LOG, log_path=LOG_PATH,
-                 log_file_prefix=LOG_FILE_PREFIX, print_console=PRINT_TO_CONSOLE, suppress_logging=SUPPRESS_LOGGING,
-                 simulate=SIMULATE_API_CALLS, be_geo_id=BE_GEO_ID, caller=MERAKI_PYTHON_SDK_CALLER):
+                 certificate_path=CERTIFICATE_PATH, requests_proxy=REQUESTS_PROXY,
+                 wait_on_rate_limit=WAIT_ON_RATE_LIMIT, nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
+                 action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME, retry_4xx_error=RETRY_4XX_ERROR,
+                 retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME, maximum_retries=MAXIMUM_RETRIES,
+                 output_log=OUTPUT_LOG, log_path=LOG_PATH, log_file_prefix=LOG_FILE_PREFIX,
+                 print_console=PRINT_TO_CONSOLE, suppress_logging=SUPPRESS_LOGGING, simulate=SIMULATE_API_CALLS,
+                 be_geo_id=BE_GEO_ID, caller=MERAKI_PYTHON_SDK_CALLER):
         # Check API key
         api_key = api_key or os.environ.get(API_KEY_ENVIRONMENT_VARIABLE)
         if not api_key:
@@ -99,6 +100,7 @@ def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeo
             base_url=base_url,
             single_request_timeout=single_request_timeout,
             certificate_path=certificate_path,
+            requests_proxy=requests_proxy,
             wait_on_rate_limit=wait_on_rate_limit,
             nginx_429_retry_wait_time=nginx_429_retry_wait_time,
             action_batch_retry_wait_time=action_batch_retry_wait_time,
@@ -114,10 +116,10 @@ def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeo
         self.organizations = Organizations(self._session)
         self.networks = Networks(self._session)
         self.devices = Devices(self._session)
-        self.insight = Insight(self._session)
-        self.wireless = Wireless(self._session)
-        self.camera = Camera(self._session)
         self.appliance = Appliance(self._session)
-        self.switch = Switch(self._session)
+        self.camera = Camera(self._session)
         self.cellulargateway = CellularGateway(self._session)
+        self.insight = Insight(self._session)
         self.sm = Sm(self._session)
+        self.switch = Switch(self._session)
+        self.wireless = Wireless(self._session)