smartystreets-python-sdk 6.2.0__tar.gz → 7.0.0__tar.gz

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: smartystreets_python_sdk
-Version: 6.2.0
+Version: 7.0.0
 Summary: An official library to help Python developers easily access the SmartyStreets APIs
 Home-page: https://github.com/smartystreets/smartystreets-python-sdk
-Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/6.2.0
+Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/7.0.0
 Author: SmartyStreets SDK Team
 Author-email: support@smartystreets.com
 License: Apache 2

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/README.md

@@ -2,7 +2,7 @@
 
 # SmartyStreets Python SDK
 
-The official client libraries for accessing SmartyStreets APIs from Python 2.7 and 3.5
+The official client libraries for accessing SmartyStreets APIs from Python 3.10 and later.
 
 You may have noticed this page is curiously sparse. Don't panic, there's [documentation](https://smartystreets.com/docs/sdk/python) and [examples](examples).
 

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/errors.py

@@ -4,20 +4,24 @@ BAD_CREDENTIALS = "Unauthorized: The credentials were provided incorrectly or di
 PAYMENT_REQUIRED = "Payment Required: There is no active subscription\
  for the account associated with the credentials submitted with the request."
 
-FORBIDDEN = "Because the international service is currently in a limited release phase, only approved accounts" \
-            " may access the service."
+FORBIDDEN = "Forbidden: The request contained valid data and was understood by the server, but the server is\
+ refusing action."
+
+REQUEST_TIMEOUT = "Request timeout error."
 
 REQUEST_ENTITY_TOO_LARGE = "Request Entity Too Large: The request body has exceeded the maximum size."
 
-BAD_REQUEST = "Bad Request (Malformed Payload): A GET request lacked a street field or the request body of a\
+BAD_REQUEST = "Bad Request (Malformed Payload): A GET request lacked a required field or the request body of a\
  POST request contained malformed JSON."
 
 UNPROCESSABLE_ENTITY = "GET request lacked required fields."
 
-TOO_MANY_REQUESTS = "The rate limit has been exceeded."
+TOO_MANY_REQUESTS = "Too Many Requests: The rate limit for your account has been exceeded."
 
 INTERNAL_SERVER_ERROR = "Internal Server Error."
 
+BAD_GATEWAY = "Bad Gateway error."
+
 SERVICE_UNAVAILABLE = "Service Unavailable. Try again later."
 
 GATEWAY_TIMEOUT = "The upstream data provider did not respond in a timely fashion and the request failed. " \

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/exceptions.py

@@ -22,6 +22,14 @@ class BadRequestError(SmartyException):
     pass
 
 
+class RequestTimeoutError(SmartyException):
+    pass
+
+
+class BadGatewayError(SmartyException):
+    pass
+
+
 class UnprocessableEntityError(SmartyException):
     pass
 

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/international_street/components.py

@@ -7,8 +7,7 @@ class Components:
         self.super_administrative_area = obj.get("super_administrative_area", None)
         self.administrative_area = obj.get("administrative_area", None)
         self.administrative_area_iso2 = obj.get("administrative_area_iso2", None)
-        self.administrative_area_short = obj.get("administrative_area_short", None)
-        self.administrative_area_long = obj.get("administrative_area_long", None)
+        self.attention = obj.get("attention", None)
         self.sub_administrative_area = obj.get("sub_administrative_area", None)
         self.dependent_locality= obj.get("dependent_locality", None)
         self.dependent_locality_name = obj.get("dependent_locality_name", None)
@@ -22,6 +21,11 @@ class Components:
         self.premise_number = obj.get("premise_number", None)
         self.premise_prefix_number = obj.get("premise_prefix_number", None)
         self.premise_type = obj.get("premise_type", None)
+        self.short_address_code = obj.get("short_address_code", None)
+        self.sub_building_leading_type = obj.get("sub_building_leading_type", None)
+        self.sub_building_block = obj.get("sub_building_block", None)
+        self.sub_building_door = obj.get("sub_building_door", None)
+        self.sub_building_staircase = obj.get("sub_building_staircase", None)
         self.thoroughfare = obj.get("thoroughfare", None)
         self.thoroughfare_predirection = obj.get("thoroughfare_predirection", None)
         self.thoroughfare_postdirection = obj.get("thoroughfare_postdirection", None)

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/international_street/rootlevel.py

@@ -9,8 +9,4 @@ class RootLevel:
         self.address5 = obj.get("address5", None)
         self.address6 = obj.get("address6", None)
         self.address7 = obj.get("address7", None)
-        self.address8 = obj.get("address8", None)
-        self.address9 = obj.get("address9", None)
-        self.address10 = obj.get("address10", None)
-        self.address11 = obj.get("address11", None)
-        self.address12 = obj.get("address12", None)
+        self.address8 = obj.get("address8", None)

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/native_serializer.py

@@ -9,4 +9,6 @@ class NativeSerializer:
         return json.dumps(obj).encode("UTF-8")
 
     def deserialize(self, payload):
+        if not payload:
+            return {}
         return json.loads(payload)

smartystreets_python_sdk-7.0.0/smartystreets_python_sdk/status_code_sender.py

@@ -0,0 +1,121 @@
+import json
+
+from smartystreets_python_sdk import errors, exceptions
+
+
+class StatusCodeSender:
+    def __init__(self, inner):
+        self.inner = inner
+
+    def parse_rate_limit_response(self, response):
+        return messageFrom(response, exceptions.TooManyRequestsError(errors.TOO_MANY_REQUESTS))
+
+    def send(self, request):
+        response = self.inner.send(request)
+
+        if not response.error:
+            if response.status_code == 429:
+                response.error = self.parse_rate_limit_response(response)
+            elif response.status_code not in (200, 304):
+                response.error = messageFrom(response, fallback_error(response.status_code))
+
+        return response
+
+def fallback_error(status_code):
+    error = statuses.get(status_code)
+    if error is None:
+        error = exceptions.SmartyException(
+            'The server returned an unexpected HTTP status code: {}'.format(status_code))
+    return error
+
+
+def messageFrom(response, fallback):
+    message = extract_message(response)
+    if message:
+        return type(fallback)(message)
+    return type(fallback)('{} Body: {}'.format(fallback, unused_body(response)).rstrip())
+
+
+def unused_body(response):
+    payload = response.payload
+    if payload is None:
+        return ''
+    if isinstance(payload, bytes):
+        payload = payload.decode('utf-8', 'replace')
+    return str(payload).strip()
+
+
+def extract_message(response):
+    try:
+        response_json = json.loads(response.payload)
+    except (ValueError, TypeError):
+        return ''
+    if response_json is None:
+        return ''
+    errors_json = response_json.get('errors')
+    if errors_json is None:
+        return ''
+    message = ''
+    for current_error in errors_json:
+        current_message = current_error.get('message')
+        if current_message is not None:
+            message = message + current_message + ' '
+    return message.rstrip()
+
+
+def bad_credentials():
+    return exceptions.BadCredentialsError(errors.BAD_CREDENTIALS)
+
+
+def payment_required():
+    return exceptions.PaymentRequiredError(errors.PAYMENT_REQUIRED)
+
+
+def forbidden():
+    return exceptions.ForbiddenError(errors.FORBIDDEN)
+
+
+def request_timeout():
+    return exceptions.RequestTimeoutError(errors.REQUEST_TIMEOUT)
+
+
+def request_entity_too_large():
+    return exceptions.RequestEntityTooLargeError(errors.REQUEST_ENTITY_TOO_LARGE)
+
+
+def bad_request():
+    return exceptions.BadRequestError(errors.BAD_REQUEST)
+
+
+def unprocessable_entity():
+    return exceptions.UnprocessableEntityError(errors.UNPROCESSABLE_ENTITY)
+
+
+def internal_server_error():
+    return exceptions.InternalServerError(errors.INTERNAL_SERVER_ERROR)
+
+
+def bad_gateway():
+    return exceptions.BadGatewayError(errors.BAD_GATEWAY)
+
+
+def service_unavailable():
+    return exceptions.ServiceUnavailableError(errors.SERVICE_UNAVAILABLE)
+
+
+def gateway_timeout():
+    return exceptions.GatewayTimeoutError(errors.GATEWAY_TIMEOUT)
+
+
+statuses = {401: bad_credentials(),
+            402: payment_required(),
+            403: forbidden(),
+            408: request_timeout(),
+            413: request_entity_too_large(),
+            400: bad_request(),
+            422: unprocessable_entity(),
+            500: internal_server_error(),
+            502: bad_gateway(),
+            503: service_unavailable(),
+            504: gateway_timeout()
+            }

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/us_autocomplete_pro/__init__.py

@@ -1,3 +1,4 @@
 from .suggestion import Suggestion
 from .lookup import Lookup
 from .client import Client
+from .source import Source

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/us_autocomplete_pro/client.py

@@ -1,3 +1,5 @@
+from enum import Enum
+
 from smartystreets_python_sdk import Request
 from smartystreets_python_sdk.exceptions import SmartyException
 from smartystreets_python_sdk.us_autocomplete_pro import Suggestion, geolocation_type
@@ -64,4 +66,4 @@ class Client:
     @staticmethod
     def add_parameter(request, key, value):
         if value and value != 'none':
-            request.parameters[key] = value
+            request.parameters[key] = value.value if isinstance(value, Enum) else value

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/us_autocomplete_pro/lookup.py

@@ -1,6 +1,5 @@
 from smartystreets_python_sdk.us_autocomplete_pro import geolocation_type
 
-
 class Lookup:
     def __init__(self, search=None, max_results=None, city_filter=None, state_filter=None, zip_filter=None,
                  exclude=None, prefer_cities=None, prefer_states=None, prefer_zips=None, prefer_ratio=None,
@@ -32,10 +31,8 @@ class Lookup:
                             meaning that if it is not set to none, you may see addresses from the customer's area
                             when you may not desire it
         :param selected: Used by UI components to request a list of secondaries (up to 100) for the specified address
-        :param source: Include results from alternate data sources. If no value is passed, the default will be `postal`. 
-                            Allowed values are:
-                            all - will include non-postal addresses in the results
-                            postal - will limit the results to postal addresses only
+        :param source: Include results from alternate data sources. Defaults to None (API default: postal).
+                            Use Source.ALL to include non-postal addresses, Source.POSTAL to limit to postal only.
         """
         self.result = []
         self.custom_parameter_array = {}

smartystreets_python_sdk-7.0.0/smartystreets_python_sdk/us_autocomplete_pro/source.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class Source(str, Enum):
+    ALL = "all"
+    POSTAL = "postal"

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/us_enrichment/client.py

@@ -107,11 +107,14 @@ def send_lookup(client: Client, lookup, response_class=Response):
         _is_blank(getattr(lookup, 'smartykey', None))
         and _is_blank(getattr(lookup, 'street', None))
         and _is_blank(getattr(lookup, 'freeform', None))
+        and _is_blank(getattr(lookup, 'business_name', None))
     ):
-        raise SmartyException("Lookup requires one of 'smartykey', 'street', or 'freeform' to be set")
+        raise SmartyException("Lookup requires one of 'smartykey', 'street', 'freeform', or 'business_name' to be set")
 
     request = build_request(lookup)
     raw = _dispatch(client, request, lookup)
+    if raw is None:
+        return lookup.result
     lookup.result = [response_class(candidate) for candidate in raw]
     return lookup.result
 
@@ -126,6 +129,8 @@ def send_business_detail_lookup(client: Client, lookup):
     _apply_etag_header(request, lookup)
 
     raw = _dispatch(client, request, lookup)
+    if raw is None:
+        return lookup.result
     if not raw:
         lookup.result = None
     elif len(raw) > 1:
@@ -158,7 +163,7 @@ def _url_components(lookup):
 
 def _address_parameters(lookup):
     params = {}
-    for key in ('freeform', 'street', 'city', 'state', 'zipcode', 'features'):
+    for key in ('freeform', 'street', 'city', 'state', 'zipcode', 'features', 'business_name'):
         value = getattr(lookup, key, None)
         if value:
             params[key] = value
@@ -184,6 +189,8 @@ def _apply_etag_header(request, lookup):
 def _dispatch(client, request, lookup):
     response = client.sender.send(request)
     lookup.response_etag = response.find_header('etag')
+    if response.status_code == 304:
+        return None
     if response.error:
         raise response.error
     raw = client.serializer.deserialize(response.payload)

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/us_enrichment/lookup.py

@@ -28,7 +28,7 @@ class LookupBase:
 
 
 class Lookup(LookupBase):
-    def __init__(self, smartykey=None, dataset=None, dataSubset=None, features=None, freeform=None, street=None, city=None, state=None, zipcode=None):
+    def __init__(self, smartykey=None, dataset=None, dataSubset=None, features=None, freeform=None, street=None, city=None, state=None, zipcode=None, business_name=None):
         super().__init__()
         self.smartykey = smartykey
         self.dataset = dataset
@@ -40,6 +40,7 @@ class Lookup(LookupBase):
         self.state = state
         self.zipcode = zipcode
         self.result = []
+        self.business_name = business_name
 
 
 class PrincipalLookup(Lookup):

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/us_reverse_geo/__init__.py

@@ -4,3 +4,4 @@ from .result import Result
 from .address import Address
 from .coordinate import Coordinate
 from .client import Client
+from .source import Source

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk/us_reverse_geo/client.py

@@ -1,3 +1,5 @@
+from enum import Enum
+
 from smartystreets_python_sdk import Request
 from smartystreets_python_sdk.us_reverse_geo import Response
 
@@ -41,4 +43,4 @@ class Client:
     @staticmethod
     def add_parameter(request, key, value):
         if value and value != 'none':
-            request.parameters[key] = value
+            request.parameters[key] = value.value if isinstance(value, Enum) else value

smartystreets_python_sdk-7.0.0/smartystreets_python_sdk/us_reverse_geo/source.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class Source(str, Enum):
+    ALL = "all"
+    POSTAL = "postal"

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: smartystreets_python_sdk
-Version: 6.2.0
+Version: 7.0.0
 Summary: An official library to help Python developers easily access the SmartyStreets APIs
 Home-page: https://github.com/smartystreets/smartystreets-python-sdk
-Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/6.2.0
+Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/7.0.0
 Author: SmartyStreets SDK Team
 Author-email: support@smartystreets.com
 License: Apache 2

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk.egg-info/SOURCES.txt

@@ -49,6 +49,7 @@ smartystreets_python_sdk/us_autocomplete_pro/__init__.py
 smartystreets_python_sdk/us_autocomplete_pro/client.py
 smartystreets_python_sdk/us_autocomplete_pro/geolocation_type.py
 smartystreets_python_sdk/us_autocomplete_pro/lookup.py
+smartystreets_python_sdk/us_autocomplete_pro/source.py
 smartystreets_python_sdk/us_autocomplete_pro/suggestion.py
 smartystreets_python_sdk/us_enrichment/__init__.py
 smartystreets_python_sdk/us_enrichment/client.py
@@ -70,6 +71,7 @@ smartystreets_python_sdk/us_reverse_geo/coordinate.py
 smartystreets_python_sdk/us_reverse_geo/lookup.py
 smartystreets_python_sdk/us_reverse_geo/response.py
 smartystreets_python_sdk/us_reverse_geo/result.py
+smartystreets_python_sdk/us_reverse_geo/source.py
 smartystreets_python_sdk/us_street/__init__.py
 smartystreets_python_sdk/us_street/analysis.py
 smartystreets_python_sdk/us_street/candidate.py

{smartystreets_python_sdk-6.2.0 → smartystreets_python_sdk-7.0.0}/smartystreets_python_sdk_version/__init__.py

@@ -1,2 +1,2 @@
 __version__ = '0.0.0'  # DO NOT EDIT (this is updated by a build job when a new release is published)
-__version__="6.2.0"
+__version__="7.0.0"

smartystreets_python_sdk-6.2.0/smartystreets_python_sdk/status_code_sender.py

@@ -1,88 +0,0 @@
-import json
-
-from smartystreets_python_sdk import errors, exceptions
-
-
-class StatusCodeSender:
-    def __init__(self, inner):
-        self.inner = inner
-
-    def parse_rate_limit_response(self, response):
-        error_message = exceptions.TooManyRequestsError(errors.TOO_MANY_REQUESTS)
-        response_json = json.loads(response.payload)
-        if response_json is not None:
-            errors_json = response_json.get('errors')
-            if errors_json is not None:
-                message = ''
-                for current_error in errors_json:
-                    current_message = current_error.get('message')
-                    if current_message is not None:
-                        message = message + current_message + ' '
-                error_message = exceptions.TooManyRequestsError(message.rstrip())
-        return error_message
-
-    def send(self, request):
-        response = self.inner.send(request)
-
-        if not response.error:
-            if response.status_code == 304:
-                response.error = exceptions.NotModifiedError(errors.NOT_MODIFIED, response.find_header('etag'))
-            elif response.status_code == 429:
-                response.error = self.parse_rate_limit_response(response)
-            else:
-                response.error = statuses.get(response.status_code)
-
-        return response
-
-
-def ok():
-    return None
-
-
-def bad_credentials():
-    return exceptions.BadCredentialsError(errors.BAD_CREDENTIALS)
-
-
-def payment_required():
-    return exceptions.PaymentRequiredError(errors.PAYMENT_REQUIRED)
-
-
-def forbidden():
-    return exceptions.ForbiddenError(errors.FORBIDDEN)
-
-
-def request_entity_too_large():
-    return exceptions.RequestEntityTooLargeError(errors.REQUEST_ENTITY_TOO_LARGE)
-
-
-def bad_request():
-    return exceptions.BadRequestError(errors.BAD_REQUEST)
-
-
-def unprocessable_entity():
-    return exceptions.UnprocessableEntityError(errors.UNPROCESSABLE_ENTITY)
-
-
-def internal_server_error():
-    return exceptions.InternalServerError(errors.INTERNAL_SERVER_ERROR)
-
-
-def service_unavailable():
-    return exceptions.ServiceUnavailableError(errors.SERVICE_UNAVAILABLE)
-
-
-def gateway_timeout():
-    return exceptions.GatewayTimeoutError(errors.GATEWAY_TIMEOUT)
-
-
-statuses = {200: ok(),
-            401: bad_credentials(),
-            402: payment_required(),
-            403: forbidden(),
-            413: request_entity_too_large(),
-            400: bad_request(),
-            422: unprocessable_entity(),
-            500: internal_server_error(),
-            503: service_unavailable(),
-            504: gateway_timeout()
-            }