smartystreets-python-sdk 5.0.0__tar.gz → 5.2.0__tar.gz

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: smartystreets_python_sdk
-Version: 5.0.0
+Version: 5.2.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/5.0.0
+Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/5.2.0
 Author: SmartyStreets SDK Team
 Author-email: support@smartystreets.com
 License: Apache 2

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.0}/smartystreets_python_sdk/client_builder.py

@@ -27,6 +27,7 @@ class ClientBuilder:
         self.ip = None
         self.debug = None
         self.header = None
+        self.append_headers = {}
         self.licenses = []
         self.pool_size = None
         self.custom_queries = None
@@ -113,13 +114,36 @@ class ClientBuilder:
 
     def with_custom_header(self, custom_header):
         """
-        Create custom headers when necessary.
+        Create custom headers when necessary. Headers are merged with any existing custom headers.
         :param custom_header: Input your custom headers
         :return: Returns self to accommodate method chaining
         """
-        self.header = custom_header
+        if self.header is None:
+            self.header = {}
+        self.header.update(custom_header)
         return self
-    
+
+    def with_appended_header(self, key, value, separator):
+        """
+        Appends the provided value to the existing header value using the specified separator,
+        rather than adding a separate header value. This is useful for single-value headers like User-Agent.
+        :param key: The header key
+        :param value: The header value to append
+        :param separator: The separator to use when joining values
+        :return: Returns self to accommodate method chaining
+        """
+        self.append_headers[key] = separator
+        if self.header is None:
+            self.header = {}
+        if key in self.header:
+            if isinstance(self.header[key], list):
+                self.header[key].append(value)
+            else:
+                self.header[key] = [self.header[key], value]
+        else:
+            self.header[key] = [value]
+        return self
+
     def with_x_forwarded_for(self, ip):
         """
         Add and X-Forwarded-For header when necessary.
@@ -235,7 +259,7 @@ class ClientBuilder:
         sender = smarty.StatusCodeSender(sender)
 
         if self.header is not None:
-            sender = smarty.CustomHeaderSender(self.header, sender)
+            sender = smarty.CustomHeaderSender(self.header, sender, self.append_headers)
 
         if self.custom_queries is not None:
             sender = smarty.CustomQuerySender(self.custom_queries, sender)

smartystreets_python_sdk-5.2.0/smartystreets_python_sdk/custom_header_sender.py

@@ -0,0 +1,35 @@
+from requests import Request
+
+
+class CustomHeaderSender:
+    def __init__(self, headers, inner, append_headers=None):
+        self.headers = headers
+        self.inner = inner
+        self.append_headers = append_headers or {}
+
+    def send(self, smarty_request):
+        request = self.build_request(smarty_request)
+        return self.inner.send(request)
+
+    def build_request(self, smarty_request):
+        request = Request(url=smarty_request.url_prefix, params=smarty_request.parameters)
+        request.headers = self.apply_headers()
+        if smarty_request.payload:
+            request.data = smarty_request.payload
+            request.method = 'POST'
+        else:
+            request.method = 'GET'
+        return request
+
+    def apply_headers(self):
+        result = {}
+        for key, value in self.headers.items():
+            if key in self.append_headers:
+                separator = self.append_headers[key]
+                if isinstance(value, list):
+                    result[key] = separator.join(value)
+                else:
+                    result[key] = value
+            else:
+                result[key] = value
+        return result

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.0}/smartystreets_python_sdk/us_street/analysis.py

@@ -19,3 +19,22 @@ class Analysis:
         self.enhanced_match = obj.get('enhanced_match', None)
         components_obj = obj.get("components", None)
         self.components = ComponentAnalysis(components_obj) if components_obj else None
+
+    def to_dict(self):
+        components_dict = self.components.to_dict() if self.components else None
+
+        result = {
+            "dpv_match_code": self.dpv_match_code,
+            "dpv_footnotes": self.dpv_footnotes,
+            "dpv_cmra": self.cmra,
+            "dpv_vacant": self.vacant,
+            "active": self.active,
+            "dpv_no_stat": self.dpv_no_stat,
+            "footnotes": self.footnotes,
+            "lacslink_code": self.lacs_link_code,
+            "lacslink_indicator": self.lacs_link_indicator,
+            "suitelink_match": self.is_suite_link_match,
+            "enhanced_match": self.enhanced_match,
+            "components": components_dict or None
+        }
+        return {k: v for k, v in result.items() if v is not None}

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.0}/smartystreets_python_sdk/us_street/candidate.py

@@ -1,3 +1,5 @@
+import json
+
 from .components import Components
 from .metadata import Metadata
 from .analysis import Analysis
@@ -24,3 +26,27 @@ class Candidate:
         self.components = Components(obj.get('components', {}))
         self.metadata = Metadata(obj.get('metadata', {}))
         self.analysis = Analysis(obj.get('analysis', {}))
+
+    def to_dict(self):
+        components_dict = self.components.to_dict() if self.components else None
+        metadata_dict = self.metadata.to_dict() if self.metadata else None
+        analysis_dict = self.analysis.to_dict() if self.analysis else None
+
+        result = {
+            "input_id": self.input_id,
+            "input_index": self.input_index,
+            "candidate_index": self.candidate_index,
+            "addressee": self.addressee,
+            "delivery_line_1": self.delivery_line_1,
+            "delivery_line_2": self.delivery_line_2,
+            "last_line": self.last_line,
+            "delivery_point_barcode": self.delivery_point_barcode,
+            "smarty_key": self.smarty_key,
+            "components": components_dict or None,
+            "metadata": metadata_dict or None,
+            "analysis": analysis_dict or None
+        }
+        return {k: v for k, v in result.items() if v is not None}
+
+    def to_json(self):
+        return json.dumps(self.to_dict())

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.0}/smartystreets_python_sdk/us_street/component_analysis.py

@@ -18,4 +18,23 @@ class ComponentAnalysis:
         self.state_abbreviation = MatchInfo(obj['state_abbreviation']) if 'state_abbreviation' in obj else None
         self.zipcode = MatchInfo(obj['zipcode']) if 'zipcode' in obj else None
         self.plus4_code = MatchInfo(obj['plus4_code']) if 'plus4_code' in obj else None
-        self.urbanization = MatchInfo(obj['urbanization']) if 'urbanization' in obj else None
+        self.urbanization = MatchInfo(obj['urbanization']) if 'urbanization' in obj else None
+
+    def to_dict(self):
+        result = {
+            'primary_number': self.primary_number.to_dict() if self.primary_number else None,
+            'street_predirection': self.street_predirection.to_dict() if self.street_predirection else None,
+            'street_name': self.street_name.to_dict() if self.street_name else None,
+            'street_postdirection': self.street_postdirection.to_dict() if self.street_postdirection else None,
+            'street_suffix': self.street_suffix.to_dict() if self.street_suffix else None,
+            'secondary_number': self.secondary_number.to_dict() if self.secondary_number else None,
+            'secondary_designator': self.secondary_designator.to_dict() if self.secondary_designator else None,
+            'extra_secondary_number': self.extra_secondary_number.to_dict() if self.extra_secondary_number else None,
+            'extra_secondary_designator': self.extra_secondary_designator.to_dict() if self.extra_secondary_designator else None,
+            'city_name': self.city_name.to_dict() if self.city_name else None,
+            'state_abbreviation': self.state_abbreviation.to_dict() if self.state_abbreviation else None,
+            'zipcode': self.zipcode.to_dict() if self.zipcode else None,
+            'plus4_code': self.plus4_code.to_dict() if self.plus4_code else None,
+            'urbanization': self.urbanization.to_dict() if self.urbanization else None,
+        }
+        return {k: v for k, v in result.items() if v is not None}

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.0}/smartystreets_python_sdk/us_street/components.py

@@ -24,3 +24,27 @@ class Components:
         self.plus4_code = obj.get('plus4_code', None)
         self.delivery_point = obj.get('delivery_point', None)
         self.delivery_point_check_digit = obj.get('delivery_point_check_digit', None)
+
+    def to_dict(self):
+        result = {
+            "urbanization": self.urbanization,
+            "primary_number": self.primary_number,
+            "street_name": self.street_name,
+            "street_predirection": self.street_predirection,
+            "street_postdirection": self.street_postdirection,
+            "street_suffix": self.street_suffix,
+            "secondary_number": self.secondary_number,
+            "secondary_designator": self.secondary_designator,
+            "extra_secondary_number": self.extra_secondary_number,
+            "extra_secondary_designator": self.extra_secondary_designator,
+            "pmb_designator": self.pmb_designator,
+            "pmb_number": self.pmb_number,
+            "city_name": self.city_name,
+            "default_city_name": self.default_city_name,
+            "state_abbreviation": self.state_abbreviation,
+            "zipcode": self.zipcode,
+            "plus4_code": self.plus4_code,
+            "delivery_point": self.delivery_point,
+            "delivery_point_check_digit": self.delivery_point_check_digit
+        }
+        return {k: v for k, v in result.items() if v is not None}

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.0}/smartystreets_python_sdk/us_street/lookup.py

@@ -1,5 +1,6 @@
 from smartystreets_python_sdk.us_street.match_type import MatchType
 from smartystreets_python_sdk.us_street.output_format import OutputFormat
+import json
 
 
 class Lookup:
@@ -31,3 +32,27 @@ class Lookup:
 
     def add_custom_parameter(self, parameter, value):
         self.custom_parameter_array[parameter] = value
+
+    def to_dict(self):
+        result =  {
+            "input_id": self.input_id,
+            "street": self.street,
+            "street2": self.street2,
+            "secondary": self.secondary,
+            "city": self.city,
+            "state": self.state,
+            "zipcode": self.zipcode,
+            "lastline": self.lastline,
+            "addressee": self.addressee,
+            "urbanization": self.urbanization,
+            "match": self.match,
+            "candidates": self.candidates,
+            "outputformat": self.outputformat,
+            "county_source": self.county_source,
+            "result": [candidate.to_dict() for candidate in self.result],
+            "custom_parameter_array": self.custom_parameter_array
+        }
+        return {k: v for k, v in result.items() if v is not None}
+
+    def to_json(self):
+        return json.dumps(self.to_dict())

smartystreets_python_sdk-5.2.0/smartystreets_python_sdk/us_street/match_info.py

@@ -0,0 +1,14 @@
+class MatchInfo:
+    def __init__(self, obj):
+        """
+        Holds matching status and change information for an address component.
+        """
+        self.status = obj.get('status', None)
+        self.change = obj.get('change', None)
+
+    def to_dict(self):
+        result = {
+            "status": self.status,
+            "change": self.change
+        }
+        return {k: v for k, v in result.items() if v is not None}

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.0}/smartystreets_python_sdk/us_street/metadata.py

@@ -21,3 +21,26 @@ class Metadata:
         self.utc_offset = obj.get('utc_offset', None)
         self.obeys_dst = obj.get('dst', None)
         self.is_ews_match = obj.get('ews_match', None)
+
+    def to_dict(self):
+        result = {
+            "record_type": self.record_type,
+            "zip_type": self.zip_type,
+            "county_fips": self.county_fips,
+            "county_name": self.county_name,
+            "carrier_route": self.carrier_route,
+            "congressional_district": self.congressional_district,
+            "building_default_indicator": self.building_default_indicator,
+            "rdi": self.rdi,
+            "elot_sequence": self.elot_sequence,
+            "elot_sort": self.elot_sort,
+            "latitude": self.latitude,
+            "longitude": self.longitude,
+            "coordinate_license": self.coordinate_license,
+            "precision": self.precision,
+            "time_zone": self.time_zone,
+            "utc_offset": self.utc_offset,
+            "dst": self.obeys_dst,
+            "ews_match": self.is_ews_match
+        }
+        return {k: v for k, v in result.items() if v is not None}

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.0}/smartystreets_python_sdk.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: smartystreets_python_sdk
-Version: 5.0.0
+Version: 5.2.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/5.0.0
+Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/5.2.0
 Author: SmartyStreets SDK Team
 Author-email: support@smartystreets.com
 License: Apache 2

{smartystreets_python_sdk-5.0.0 → smartystreets_python_sdk-5.2.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__="5.0.0"
+__version__="5.2.0"

smartystreets_python_sdk-5.0.0/smartystreets_python_sdk/custom_header_sender.py

@@ -1,21 +0,0 @@
-from requests import Request
-
-
-class CustomHeaderSender:
-    def __init__(self, headers, inner):
-        self.headers = headers
-        self.inner = inner
-
-    def send(self, smarty_request):
-        request = self.build_request(smarty_request)
-        return self.inner.send(request)
-
-    def build_request(self, smarty_request):
-        request = Request(url=smarty_request.url_prefix, params=smarty_request.parameters)
-        request.headers = self.headers
-        if smarty_request.payload:
-            request.data = smarty_request.payload
-            request.method = 'POST'
-        else:
-            request.method = 'GET'
-        return request

smartystreets_python_sdk-5.0.0/smartystreets_python_sdk/us_street/match_info.py

@@ -1,7 +0,0 @@
-class MatchInfo:
-    def __init__(self, obj):
-        """
-        Holds matching status and change information for an address component.
-        """
-        self.status = obj.get('status', None)
-        self.change = obj.get('change', None)