Merge pull request #203 from EasyPost/backport_user_agent

chore: backports user-agent
EasyPost · Jul 1, 2022 · a6031f9 · a6031f9
2 parents 012232f + a58ad8b
commit a6031f9
Show file tree

Hide file tree

Showing 26 changed files with 42 additions and 203 deletions.
diff --git a/easypost/__init__.py b/easypost/__init__.py
@@ -2,7 +2,6 @@
 import json
 import platform
 import re
-import ssl
 import time
 
 import six
@@ -65,9 +64,6 @@
 timeout = min(60, _max_timeout)
 
 
-USER_AGENT = "EasyPost/v2 PythonClient/{0}".format(VERSION)
-
-
 class Error(Exception):
     def __init__(self, message=None, http_status=None, http_body=None, original_exception=None):
         super(Error, self).__init__(message)
@@ -223,31 +219,49 @@ def request_raw(self, method, url, params=None, apiKeyRequired=True):
         abs_url = "%s%s" % (api_base, url or "")
         params = self._objects_to_ids(params)
 
-        ua = {
+        # Fallback values for the user-agent header
+        user_agent = {
             "client_version": VERSION,
-            "lang": "python",
-            "publisher": "easypost",
-            "request_lib": request_lib,
+            "implementation": "NA",
+            "os_arch": "NA",
+            "os_version": "NA",
+            "os": "NA",
+            "python_version": "NA",
         }
+
+        # Attempt to populate the user-agent header
         for attr, func in (
-            ("lang_version", platform.python_version),
-            ("platform", platform.platform),
-            ("uname", lambda: " ".join(platform.uname())),
+            ("implementation", platform.python_implementation),
+            ("os_details", platform.uname),
+            ("python_version", platform.python_version),
         ):
             try:
                 val = func()
-            except Exception as e:
-                val = "!! %s" % e
-            ua[attr] = val
-
-        if hasattr(ssl, "OPENSSL_VERSION"):
-            ua["openssl_version"] = ssl.OPENSSL_VERSION
+                if attr == "os_details":
+                    user_agent["os"] = val[0]
+                    user_agent["os_version"] = val[2]
+                    user_agent["os_arch"] = val[4]
+                else:
+                    user_agent[attr] = val
+            except Exception:
+                # If we fail to get OS info, do nothing as we already set fallbacks for these values
+                pass
+
+        user_agent = (
+            "EasyPost/v2 PythonClient/{0} Python/{1} OS/{2} OSVersion/{3} OSArch/{4} Implementation/{5}".format(
+                VERSION,
+                user_agent["python_version"],
+                user_agent["os"],
+                user_agent["os_version"],
+                user_agent["os_arch"],
+                user_agent["implementation"],
+            )
+        )
 
         headers = {
-            "X-Client-User-Agent": json.dumps(ua),
-            "User-Agent": USER_AGENT,
             "Authorization": "Bearer %s" % my_api_key,
             "Content-type": "application/json",
+            "User-Agent": user_agent,
         }
 
         if timeout > _max_timeout:

diff --git a/examples/unicode.py b/examples/unicode.py
@@ -3,7 +3,9 @@
 easypost.api_key = "API_KEY"
 
 # unicode
+# fmt: off
 state = u"DELEGACI\xf3N BENITO JU\xe1REZ"
+# fmt: on
 
 address = easypost.Address.create(state=state)
 

diff --git a/tests/cassettes/test_address_bytestring.yaml b/tests/cassettes/test_address_bytestring.yaml
@@ -14,8 +14,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/addresses
   response:

diff --git a/tests/cassettes/test_address_creation_verification.yaml b/tests/cassettes/test_address_creation_verification.yaml
@@ -16,8 +16,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/addresses
   response:
@@ -92,8 +90,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: GET
     uri: https://api.easypost.com/v2/addresses/adr_e18d7993d8494cff94be285e1fbc6a41/verify
   response:
@@ -170,8 +166,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: GET
     uri: https://api.easypost.com/v2/addresses/adr_e18d7993d8494cff94be285e1fbc6a41
   response:

diff --git a/tests/cassettes/test_address_creation_with_verify.yaml b/tests/cassettes/test_address_creation_with_verify.yaml
@@ -16,8 +16,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/addresses
   response:

diff --git a/tests/cassettes/test_address_creation_with_verify_bool.yaml b/tests/cassettes/test_address_creation_with_verify_bool.yaml
@@ -16,8 +16,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/addresses
   response:

diff --git a/tests/cassettes/test_address_creation_with_verify_failure.yaml b/tests/cassettes/test_address_creation_with_verify_failure.yaml
@@ -16,8 +16,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/addresses
   response:

diff --git a/tests/cassettes/test_address_creation_with_verify_strict_failure.yaml b/tests/cassettes/test_address_creation_with_verify_strict_failure.yaml
@@ -16,8 +16,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/addresses
   response:

diff --git a/tests/cassettes/test_address_unicode.yaml b/tests/cassettes/test_address_unicode.yaml
@@ -14,8 +14,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/addresses
   response:

diff --git a/tests/cassettes/test_batch_create_and_buy.yaml b/tests/cassettes/test_batch_create_and_buy.yaml
@@ -16,8 +16,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/addresses
   response:
@@ -95,8 +93,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/parcels
   response:
@@ -175,8 +171,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/batches/create_and_buy
   response:
@@ -250,8 +244,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: GET
     uri: https://api.easypost.com/v2/batches/batch_e018ee73541a430dbd5b7ab19377543b
   response:
@@ -326,8 +318,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/shipments/shp_d1db138265b8426283c4580b60618aad/insure
   response:

diff --git a/tests/cassettes/test_carrier_types.yaml b/tests/cassettes/test_carrier_types.yaml
@@ -12,8 +12,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: GET
     uri: https://api.easypost.com/v2/carrier_types
   response:

diff --git a/tests/cassettes/test_child_user_create.yaml b/tests/cassettes/test_child_user_create.yaml
@@ -14,8 +14,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/users
   response:
@@ -91,8 +89,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/users
   response:
@@ -159,8 +155,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: GET
     uri: https://api.easypost.com/v2/users/user_99a72f96c77c4a9fa1d7c268b663ea4b
   response:
@@ -232,8 +226,7 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
+
     method: PUT
     uri: https://api.easypost.com/v2/users/user_99a72f96c77c4a9fa1d7c268b663ea4b
   response:
@@ -303,8 +296,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: GET
     uri: https://api.easypost.com/v2/users/user_99a72f96c77c4a9fa1d7c268b663ea4b
   response:

diff --git a/tests/cassettes/test_insurance_creation.yaml b/tests/cassettes/test_insurance_creation.yaml
@@ -21,8 +21,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/insurances
   response:
@@ -99,8 +97,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: GET
     uri: https://api.easypost.com/v2/insurances/ins_2a5732bf515349e59c883da5eb1a8e14
   response:
@@ -183,8 +179,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: GET
     uri: https://api.easypost.com/v2/insurances?page_size=5
   response:

diff --git a/tests/cassettes/test_order_create_then_buy.yaml b/tests/cassettes/test_order_create_then_buy.yaml
@@ -21,8 +21,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/orders
   response:
@@ -115,8 +113,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: GET
     uri: https://api.easypost.com/v2/orders/order_4a7076406aa8477bb66e619f354c99ce/rates
   response:
@@ -211,8 +207,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/orders/order_4a7076406aa8477bb66e619f354c99ce/buy
   response:
@@ -318,8 +312,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/shipments/shp_53f2547d3c0f409ab51a48d97295b898/insure
   response:
@@ -421,8 +413,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/shipments/shp_843facf0843a4a04ad9cb1449cc5b5c5/insure
   response:

diff --git a/tests/cassettes/test_parcel_creation.yaml b/tests/cassettes/test_parcel_creation.yaml
@@ -15,8 +15,6 @@ interactions:
       - EZTK-NONE
       user-agent:
       - easypost/v2 pythonclient/suppressed
-      x-client-user-agent:
-      - suppressed
     method: POST
     uri: https://api.easypost.com/v2/parcels
   response: