Merge pull request #280 from EasyPost/tie_a_bow

Type Hints, Docstrings, and Missing Tests for v8

Author: Justintime50

Makefile

@@ -27,7 +27,7 @@ clean:
 
 ## coverage - Test the project and generate an HTML coverage report
 coverage:
-	$(VIRTUAL_BIN)/pytest --cov=$(PROJECT_NAME) --cov-branch --cov-report=html --cov-report=lcov --cov-report=term-missing --cov-fail-under=88
+	$(VIRTUAL_BIN)/pytest --cov=$(PROJECT_NAME) --cov-branch --cov-report=html --cov-report=lcov --cov-report=term-missing --cov-fail-under=90
 
 ## docs - Generates docs for the library
 docs:

README.md

@@ -127,3 +127,14 @@ Some tests may require an EasyPost user with a particular set of enabled feature
 - `USPS_CARRIER_ACCOUNT_ID` (eg: one-call buying a shipment for non-EasyPost employees)
 - `PARTNER_USER_PROD_API_KEY` (eg: creating a referral user)
 - `REFERRAL_CUSTOMER_PROD_API_KEY` (eg: adding a credit card to a referral user)
+
+#### Google Cloud SDK
+
+To run the test suite with the Google Cloud SDK (`urlfetch` instead of the `requests` library), you'll need the following:
+
+1. Install the appengine Python package to this virtual environment: `venv/bin/pip install appengine-python-standard`
+1. Install the Google Cloud SDK
+   - [Direct Download](https://cloud.google.com/sdk/docs/install)
+   - [Homebrew](https://formulae.brew.sh/cask/google-cloud-sdk)
+1. Point the `PYTHONPATH` environment variable to the path of the newly installed `google-cloud-sdk` directory. For Homebrew, this is `"$(brew --prefix)/share/google-cloud-sdk"`
+1. Run the test suite with the commands listed in this README

easypost/__init__.py

@@ -1,5 +1,6 @@
 # flake8: noqa
 from easypost.constant import (
+    AUTHOR,
     VERSION,
     VERSION_INFO,
 )
@@ -13,6 +14,6 @@
 )
 
 
-__author__ = "EasyPost <[email protected]>"
+__author__ = AUTHOR
 __version__ = VERSION
 version_info = VERSION_INFO

easypost/constant.py

@@ -6,6 +6,7 @@
 # Client defaults
 API_BASE = "https://api.easypost.com"
 API_VERSION = "v2"
+AUTHOR = "EasyPost <[email protected]>"
 SUPPORT_EMAIL = "[email protected]"
 TIMEOUT = 60
 
@@ -21,12 +22,12 @@
 INVALID_SIGNATURE_ERROR = "Webhook received does not contain an HMAC signature."
 INVALID_WEBHOOK_VALIDATION_ERROR = "Webhook received did not originate from EasyPost or had a webhook secret mismatch."
 MISSING_PARAMETER_ERROR = "Missing required parameter: {}"
-NO_API_KEY_ERROR = "No API key provided. Set an API key via \"EasyPostClient('EASYPOST_API_KEY')\". Your API keys can be found in your EasyPost dashboard, or you can email us at {} for assistance."
 NO_ATTRIBUTE_ERROR = "{} object has no attribute {}"
 NO_BILLING_ERROR = "Billing has not been setup for this user. Please add a payment method."
 NO_MORE_PAGES_ERROR = "There are no more pages to retrieve."
 NO_RATES_ERROR = "No rates found."
-SEND_STRIPE_DETAILS_ERROR = "Could not send card details to Stripe, please try again later"
+SEND_STRIPE_DETAILS_ERROR = "Could not send card details to Stripe, please try again later."
+TIMEOUT_ERROR = "Request timed out."
 
 # Internal constants (user's should not use these)
 _TEST_FAILED_INTENTIONALLY_ERROR = "Test failed intentionally."

easypost/easypost_client.py

@@ -2,11 +2,9 @@
     API_BASE,
     API_VERSION,
     INVALID_REQUESTS_VERSION_ERROR,
-    NO_API_KEY_ERROR,
     SUPPORT_EMAIL,
     TIMEOUT,
 )
-from easypost.errors import MissingParameterError
 from easypost.services import (
     AddressService,
     BatchService,
@@ -75,9 +73,6 @@ def __init__(
         self.user = UserService(self)
         self.webhook = WebhookService(self)
 
-        if self.api_key is None:
-            raise MissingParameterError(NO_API_KEY_ERROR.format(SUPPORT_EMAIL))
-
         # use urlfetch as request_lib on google app engine, otherwise use requests
         self._request_lib = None
         try:

easypost/errors/api/encoding_error.py

@@ -1,29 +1,5 @@
-from typing import (
-    Any,
-    Dict,
-    List,
-    Optional,
-    Union,
-)
-
 from easypost.errors.api.api_error import ApiError
 
 
 class EncodingError(ApiError):
-    def __init__(
-        self,
-        message: Union[
-            Dict[str, Any], list, str
-        ],  # message should be a string but can sometimes incorrectly come back as a list or object
-        errors: Optional[List[str]] = None,
-        code: Optional[str] = None,
-        http_status: Optional[int] = None,
-        http_body: Optional[Union[str, bytes]] = None,
-    ):
-        super().__init__(
-            message=message,
-            errors=errors,
-            code=code,
-            http_status=http_status,
-            http_body=http_body,
-        )
+    pass

easypost/errors/api/external_api_error.py

@@ -1,29 +1,5 @@
-from typing import (
-    Any,
-    Dict,
-    List,
-    Optional,
-    Union,
-)
-
 from easypost.errors.api.api_error import ApiError
 
 
 class ExternalApiError(ApiError):
-    def __init__(
-        self,
-        message: Union[
-            Dict[str, Any], list, str
-        ],  # message should be a string but can sometimes incorrectly come back as a list or object
-        errors: Optional[List[str]] = None,
-        code: Optional[str] = None,
-        http_status: Optional[int] = None,
-        http_body: Optional[Union[str, bytes]] = None,
-    ):
-        super().__init__(
-            message=message,
-            errors=errors,
-            code=code,
-            http_status=http_status,
-            http_body=http_body,
-        )
+    pass

easypost/errors/api/forbidden_error.py

@@ -1,29 +1,5 @@
-from typing import (
-    Any,
-    Dict,
-    List,
-    Optional,
-    Union,
-)
-
 from easypost.errors.api.api_error import ApiError
 
 
 class ForbiddenError(ApiError):
-    def __init__(
-        self,
-        message: Union[
-            Dict[str, Any], list, str
-        ],  # message should be a string but can sometimes incorrectly come back as a list or object
-        errors: Optional[List[str]] = None,
-        code: Optional[str] = None,
-        http_status: Optional[int] = None,
-        http_body: Optional[Union[str, bytes]] = None,
-    ):
-        super().__init__(
-            message=message,
-            errors=errors,
-            code=code,
-            http_status=http_status,
-            http_body=http_body,
-        )
+    pass

easypost/errors/api/gateway_timeout_error.py

@@ -1,29 +1,5 @@
-from typing import (
-    Any,
-    Dict,
-    List,
-    Optional,
-    Union,
-)
-
 from easypost.errors.api.api_error import ApiError
 
 
 class GatewayTimeoutError(ApiError):
-    def __init__(
-        self,
-        message: Union[
-            Dict[str, Any], list, str
-        ],  # message should be a string but can sometimes incorrectly come back as a list or object
-        errors: Optional[List[str]] = None,
-        code: Optional[str] = None,
-        http_status: Optional[int] = None,
-        http_body: Optional[Union[str, bytes]] = None,
-    ):
-        super().__init__(
-            message=message,
-            errors=errors,
-            code=code,
-            http_status=http_status,
-            http_body=http_body,
-        )
+    pass

easypost/errors/api/http_error.py

@@ -1,29 +1,5 @@
-from typing import (
-    Any,
-    Dict,
-    List,
-    Optional,
-    Union,
-)
-
 from easypost.errors.api.api_error import ApiError
 
 
 class HttpError(ApiError):
-    def __init__(
-        self,
-        message: Union[
-            Dict[str, Any], list, str
-        ],  # message should be a string but can sometimes incorrectly come back as a list or object
-        errors: Optional[List[str]] = None,
-        code: Optional[str] = None,
-        http_status: Optional[int] = None,
-        http_body: Optional[Union[str, bytes]] = None,
-    ):
-        super().__init__(
-            message=message,
-            errors=errors,
-            code=code,
-            http_status=http_status,
-            http_body=http_body,
-        )
+    pass