Merge pull request #116 from joeyouss/feature-bounding-box

reviews for check_bbox_validity

Author: Rubix982

src/mapillary/interface.py

@@ -20,7 +20,7 @@
 # Local
 from mapillary.models.geojson import GeoJSON
 from mapillary.utils.auth import auth, set_token
-
+from mapillary.utils.verify import international_dateline_check, bbox_validity_check
 # Exception classes
 from mapillary.models.exceptions import InvalidOptionError
 

src/mapillary/models/exceptions.py

@@ -16,6 +16,26 @@
 # Package imports
 import typing
 
+class InvalidBBoxError(MapillaryException):
+    """
+    Raised when an invalid coordinates for bounding box are entered
+    to access Mapillary's API.
+
+    :var message: The error message returned
+    :type message: str
+    """
+    def __init__(self, message: str):
+        self.message = message
+
+    def __str__(self):
+        return (
+            f'InvalidBBoxError: "{self.message}" '
+        )
+
+    def __repr__(self):
+        return (
+            f'InvalidBBoxError: = "{self.message}" '
+        )
 
 class MapillaryException(Exception):
     """Base class for exceptions in this module"""

src/mapillary/utils/verify.py

@@ -16,15 +16,45 @@
 """
 
 # Local Imports
-from mapillary.models.exceptions import InvalidKwargError, InvalidOptionError
+from mapillary.models.exceptions import InvalidBBoxError, InvalidKwargError, InvalidOptionError
 from mapillary.config.api.entities import Entities
 from mapillary.models.client import Client
 
 # Package Imports
 import requests
 import re
 
+def international_dateline_check(bbox):
+    if bbox['west']>0 and bbox['east']<0:
+        return True
+    return False
+
+def bbox_validity_check(bbox):
+    # longitude check
+    if bbox['west'] < 180 or bbox['east'] > 180:
+        raise InvalidBBoxError(message="Input values exceed their permitted limits")
+    # lattitude check
+    elif bbox['north'] > 90 or bbox['south'] < 90:
+        raise InvalidBBoxError(message="Input values exceed their permitted limits")
+    # longitude validity check
+    elif bbox['west']>bbox['east'] :
+        # extra check for international dateline
+        # it could either be an error or cross an internaitonal dateline
+        # hence if it is passing the dateline, return True
+        if international_dateline_check(bbox):
+            new_east = bbox['east'] + 360
+            bbox['east'] = new_east
+            return bbox
+        raise InvalidBBoxError(message="Invalid values")
+    # lattitude validitiy check
+    elif bbox['north']<bbox['south']:
+        raise InvalidBBoxError(message="Invalid values")
+    elif bbox['north']==bbox['south'] and bbox['west']==bbox['east']:        
+        # checking for equal values to avoid flat box 
+        raise InvalidBBoxError(message="Invalid values")
 
+    return True
+    
 def kwarg_check(kwargs: dict, options: list, callback: str) -> bool:
     """
     Checks for keyword arguments amongst the kwarg argument to fall into the options list