google-maps-routeoptimization 0.1.7__tar.gz → 0.1.8__tar.gz

{google_maps_routeoptimization-0.1.7/google_maps_routeoptimization.egg-info → google_maps_routeoptimization-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: google-maps-routeoptimization
-Version: 0.1.7
+Version: 0.1.8
 Summary: Google Maps Routeoptimization API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-routeoptimization
 Author: Google LLC
@@ -57,12 +57,12 @@ In order to use this library, you first need to go through the following steps:
 1. `Select or create a Cloud Platform project.`_
 2. `Enable billing for your project.`_
 3. `Enable the Route Optimization API.`_
-4. `Setup Authentication.`_
+4. `Set up Authentication.`_
 
 .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
 .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
 .. _Enable the Route Optimization API.:  https://developers.google.com/maps/documentation/route-optimization
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 Installation
 ~~~~~~~~~~~~

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.8}/README.rst

@@ -26,12 +26,12 @@ In order to use this library, you first need to go through the following steps:
 1. `Select or create a Cloud Platform project.`_
 2. `Enable billing for your project.`_
 3. `Enable the Route Optimization API.`_
-4. `Setup Authentication.`_
+4. `Set up Authentication.`_
 
 .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
 .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
 .. _Enable the Route Optimization API.:  https://developers.google.com/maps/documentation/route-optimization
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 Installation
 ~~~~~~~~~~~~

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.8}/google/maps/routeoptimization/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.7"  # {x-release-please-version}
+__version__ = "0.1.8"  # {x-release-please-version}

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.8}/google/maps/routeoptimization_v1/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.7"  # {x-release-please-version}
+__version__ = "0.1.8"  # {x-release-please-version}

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.8}/google/maps/routeoptimization_v1/services/route_optimization/client.py

@@ -14,6 +14,8 @@
 # limitations under the License.
 #
 from collections import OrderedDict
+from http import HTTPStatus
+import json
 import logging as std_logging
 import os
 import re
@@ -488,6 +490,33 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
         # NOTE (b/349488459): universe validation is disabled until further notice.
         return True
 
+    def _add_cred_info_for_auth_errors(
+        self, error: core_exceptions.GoogleAPICallError
+    ) -> None:
+        """Adds credential info string to error details for 401/403/404 errors.
+
+        Args:
+            error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info.
+        """
+        if error.code not in [
+            HTTPStatus.UNAUTHORIZED,
+            HTTPStatus.FORBIDDEN,
+            HTTPStatus.NOT_FOUND,
+        ]:
+            return
+
+        cred = self._transport._credentials
+
+        # get_cred_info is only available in google-auth>=2.35.0
+        if not hasattr(cred, "get_cred_info"):
+            return
+
+        # ignore the type check since pypy test fails when get_cred_info
+        # is not available
+        cred_info = cred.get_cred_info()  # type: ignore
+        if cred_info and hasattr(error._details, "append"):
+            error._details.append(json.dumps(cred_info))
+
     @property
     def api_endpoint(self):
         """Return the API endpoint used by the client instance.
@@ -991,16 +1020,20 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
         # Validate the universe domain.
         self._validate_universe_domain()
 
-        # Send the request.
-        response = rpc(
-            request,
-            retry=retry,
-            timeout=timeout,
-            metadata=metadata,
-        )
+        try:
+            # Send the request.
+            response = rpc(
+                request,
+                retry=retry,
+                timeout=timeout,
+                metadata=metadata,
+            )
 
-        # Done; return the response.
-        return response
+            # Done; return the response.
+            return response
+        except core_exceptions.GoogleAPICallError as e:
+            self._add_cred_info_for_auth_errors(e)
+            raise e
 
 
 DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.8}/google/maps/routeoptimization_v1/services/route_optimization/transports/rest.py

@@ -111,12 +111,35 @@ class RouteOptimizationRestInterceptor:
     ) -> operations_pb2.Operation:
         """Post-rpc interceptor for batch_optimize_tours
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_batch_optimize_tours_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the RouteOptimization server but before
-        it is returned to user code.
+        it is returned to user code. This `post_batch_optimize_tours` interceptor runs
+        before the `post_batch_optimize_tours_with_metadata` interceptor.
         """
         return response
 
+    def post_batch_optimize_tours_with_metadata(
+        self,
+        response: operations_pb2.Operation,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]],
+    ) -> Tuple[operations_pb2.Operation, Sequence[Tuple[str, Union[str, bytes]]]]:
+        """Post-rpc interceptor for batch_optimize_tours
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the RouteOptimization server but before it is returned to user code.
+
+        We recommend only using this `post_batch_optimize_tours_with_metadata`
+        interceptor in new development instead of the `post_batch_optimize_tours` interceptor.
+        When both interceptors are used, this `post_batch_optimize_tours_with_metadata` interceptor runs after the
+        `post_batch_optimize_tours` interceptor. The (possibly modified) response returned by
+        `post_batch_optimize_tours` will be passed to
+        `post_batch_optimize_tours_with_metadata`.
+        """
+        return response, metadata
+
     def pre_optimize_tours(
         self,
         request: route_optimization_service.OptimizeToursRequest,
@@ -137,12 +160,38 @@ class RouteOptimizationRestInterceptor:
     ) -> route_optimization_service.OptimizeToursResponse:
         """Post-rpc interceptor for optimize_tours
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_optimize_tours_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the RouteOptimization server but before
-        it is returned to user code.
+        it is returned to user code. This `post_optimize_tours` interceptor runs
+        before the `post_optimize_tours_with_metadata` interceptor.
         """
         return response
 
+    def post_optimize_tours_with_metadata(
+        self,
+        response: route_optimization_service.OptimizeToursResponse,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]],
+    ) -> Tuple[
+        route_optimization_service.OptimizeToursResponse,
+        Sequence[Tuple[str, Union[str, bytes]]],
+    ]:
+        """Post-rpc interceptor for optimize_tours
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the RouteOptimization server but before it is returned to user code.
+
+        We recommend only using this `post_optimize_tours_with_metadata`
+        interceptor in new development instead of the `post_optimize_tours` interceptor.
+        When both interceptors are used, this `post_optimize_tours_with_metadata` interceptor runs after the
+        `post_optimize_tours` interceptor. The (possibly modified) response returned by
+        `post_optimize_tours` will be passed to
+        `post_optimize_tours_with_metadata`.
+        """
+        return response, metadata
+
     def pre_get_operation(
         self,
         request: operations_pb2.GetOperationRequest,
@@ -445,6 +494,10 @@ class RouteOptimizationRestTransport(_BaseRouteOptimizationRestTransport):
             json_format.Parse(response.content, resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_batch_optimize_tours(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_batch_optimize_tours_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER
@@ -600,6 +653,10 @@ class RouteOptimizationRestTransport(_BaseRouteOptimizationRestTransport):
             json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_optimize_tours(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_optimize_tours_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.8/google_maps_routeoptimization.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: google-maps-routeoptimization
-Version: 0.1.7
+Version: 0.1.8
 Summary: Google Maps Routeoptimization API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-routeoptimization
 Author: Google LLC
@@ -57,12 +57,12 @@ In order to use this library, you first need to go through the following steps:
 1. `Select or create a Cloud Platform project.`_
 2. `Enable billing for your project.`_
 3. `Enable the Route Optimization API.`_
-4. `Setup Authentication.`_
+4. `Set up Authentication.`_
 
 .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
 .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
 .. _Enable the Route Optimization API.:  https://developers.google.com/maps/documentation/route-optimization
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 Installation
 ~~~~~~~~~~~~

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.8}/tests/unit/gapic/routeoptimization_v1/test_route_optimization.py

@@ -72,6 +72,13 @@ from google.maps.routeoptimization_v1.services.route_optimization import (
 )
 from google.maps.routeoptimization_v1.types import route_optimization_service
 
+CRED_INFO_JSON = {
+    "credential_source": "/path/to/file",
+    "credential_type": "service account credentials",
+    "principal": "service-account@example.com",
+}
+CRED_INFO_STRING = json.dumps(CRED_INFO_JSON)
+
 
 async def mock_async_gen(data, chunk_size=1):
     for i in range(0, len(data)):  # pragma: NO COVER
@@ -339,6 +346,49 @@ def test__get_universe_domain():
     assert str(excinfo.value) == "Universe Domain cannot be an empty string."
 
 
+@pytest.mark.parametrize(
+    "error_code,cred_info_json,show_cred_info",
+    [
+        (401, CRED_INFO_JSON, True),
+        (403, CRED_INFO_JSON, True),
+        (404, CRED_INFO_JSON, True),
+        (500, CRED_INFO_JSON, False),
+        (401, None, False),
+        (403, None, False),
+        (404, None, False),
+        (500, None, False),
+    ],
+)
+def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info):
+    cred = mock.Mock(["get_cred_info"])
+    cred.get_cred_info = mock.Mock(return_value=cred_info_json)
+    client = RouteOptimizationClient(credentials=cred)
+    client._transport._credentials = cred
+
+    error = core_exceptions.GoogleAPICallError("message", details=["foo"])
+    error.code = error_code
+
+    client._add_cred_info_for_auth_errors(error)
+    if show_cred_info:
+        assert error.details == ["foo", CRED_INFO_STRING]
+    else:
+        assert error.details == ["foo"]
+
+
+@pytest.mark.parametrize("error_code", [401, 403, 404, 500])
+def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code):
+    cred = mock.Mock([])
+    assert not hasattr(cred, "get_cred_info")
+    client = RouteOptimizationClient(credentials=cred)
+    client._transport._credentials = cred
+
+    error = core_exceptions.GoogleAPICallError("message", details=[])
+    error.code = error_code
+
+    client._add_cred_info_for_auth_errors(error)
+    assert error.details == []
+
+
 @pytest.mark.parametrize(
     "client_class,transport_name",
     [
@@ -2178,10 +2228,13 @@ def test_optimize_tours_rest_interceptors(null_interceptor):
     ) as transcode, mock.patch.object(
         transports.RouteOptimizationRestInterceptor, "post_optimize_tours"
     ) as post, mock.patch.object(
+        transports.RouteOptimizationRestInterceptor, "post_optimize_tours_with_metadata"
+    ) as post_with_metadata, mock.patch.object(
         transports.RouteOptimizationRestInterceptor, "pre_optimize_tours"
     ) as pre:
         pre.assert_not_called()
         post.assert_not_called()
+        post_with_metadata.assert_not_called()
         pb_message = route_optimization_service.OptimizeToursRequest.pb(
             route_optimization_service.OptimizeToursRequest()
         )
@@ -2207,6 +2260,10 @@ def test_optimize_tours_rest_interceptors(null_interceptor):
         ]
         pre.return_value = request, metadata
         post.return_value = route_optimization_service.OptimizeToursResponse()
+        post_with_metadata.return_value = (
+            route_optimization_service.OptimizeToursResponse(),
+            metadata,
+        )
 
         client.optimize_tours(
             request,
@@ -2218,6 +2275,7 @@ def test_optimize_tours_rest_interceptors(null_interceptor):
 
         pre.assert_called_once()
         post.assert_called_once()
+        post_with_metadata.assert_called_once()
 
 
 def test_batch_optimize_tours_rest_bad_request(
@@ -2298,10 +2356,14 @@ def test_batch_optimize_tours_rest_interceptors(null_interceptor):
     ), mock.patch.object(
         transports.RouteOptimizationRestInterceptor, "post_batch_optimize_tours"
     ) as post, mock.patch.object(
+        transports.RouteOptimizationRestInterceptor,
+        "post_batch_optimize_tours_with_metadata",
+    ) as post_with_metadata, mock.patch.object(
         transports.RouteOptimizationRestInterceptor, "pre_batch_optimize_tours"
     ) as pre:
         pre.assert_not_called()
         post.assert_not_called()
+        post_with_metadata.assert_not_called()
         pb_message = route_optimization_service.BatchOptimizeToursRequest.pb(
             route_optimization_service.BatchOptimizeToursRequest()
         )
@@ -2325,6 +2387,7 @@ def test_batch_optimize_tours_rest_interceptors(null_interceptor):
         ]
         pre.return_value = request, metadata
         post.return_value = operations_pb2.Operation()
+        post_with_metadata.return_value = operations_pb2.Operation(), metadata
 
         client.batch_optimize_tours(
             request,
@@ -2336,6 +2399,7 @@ def test_batch_optimize_tours_rest_interceptors(null_interceptor):
 
         pre.assert_called_once()
         post.assert_called_once()
+        post_with_metadata.assert_called_once()
 
 
 def test_get_operation_rest_bad_request(