base.py

# -*- coding: utf-8 -*-

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

import abc
import typing
import pkg_resources

from google import auth  # type: ignore
from google.api_core import exceptions  # type: ignore
from google.api_core import gapic_v1  # type: ignore
from google.api_core import retry as retries  # type: ignore
from google.auth import credentials  # type: ignore

from google.analytics.data_v1alpha.types import analytics_data_api


try:
    DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
        gapic_version=pkg_resources.get_distribution("google-analytics-data",).version,
    )
except pkg_resources.DistributionNotFound:
    DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo()


class AlphaAnalyticsDataTransport(abc.ABC):
    """Abstract transport class for AlphaAnalyticsData."""

    AUTH_SCOPES = (
        "https://www.googleapis.com/auth/analytics",
        "https://www.googleapis.com/auth/analytics.readonly",
    )

    def __init__(
        self,
        *,
        host: str = "analyticsdata.googleapis.com",
        credentials: credentials.Credentials = None,
        credentials_file: typing.Optional[str] = None,
        scopes: typing.Optional[typing.Sequence[str]] = AUTH_SCOPES,
        quota_project_id: typing.Optional[str] = None,
        client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
        **kwargs,
    ) -> None:
        """Instantiate the transport.

        Args:
            host (Optional[str]): The hostname to connect to.
            credentials (Optional[google.auth.credentials.Credentials]): The
                authorization credentials to attach to requests. These
                credentials identify the application to the service; if none
                are specified, the client will attempt to ascertain the
                credentials from the environment.
            credentials_file (Optional[str]): A file with credentials that can
                be loaded with :func:`google.auth.load_credentials_from_file`.
                This argument is mutually exclusive with credentials.
            scope (Optional[Sequence[str]]): A list of scopes.
            quota_project_id (Optional[str]): An optional project to use for billing
                and quota.
            client_info (google.api_core.gapic_v1.client_info.ClientInfo):
                The client info used to send a user-agent string along with
                API requests. If ``None``, then default info will be used.
                Generally, you only need to set this if you're developing
                your own client library.
        """
        # Save the hostname. Default to port 443 (HTTPS) if none is specified.
        if ":" not in host:
            host += ":443"
        self._host = host

        # Save the scopes.
        self._scopes = scopes or self.AUTH_SCOPES

        # If no credentials are provided, then determine the appropriate
        # defaults.
        if credentials and credentials_file:
            raise exceptions.DuplicateCredentialArgs(
                "'credentials_file' and 'credentials' are mutually exclusive"
            )

        if credentials_file is not None:
            credentials, _ = auth.load_credentials_from_file(
                credentials_file, scopes=self._scopes, quota_project_id=quota_project_id
            )

        elif credentials is None:
            credentials, _ = auth.default(
                scopes=self._scopes, quota_project_id=quota_project_id
            )

        # Save the credentials.
        self._credentials = credentials

    def _prep_wrapped_messages(self, client_info):
        # Precompute the wrapped methods.
        self._wrapped_methods = {
            self.run_report: gapic_v1.method.wrap_method(
                self.run_report, default_timeout=60.0, client_info=client_info,
            ),
            self.run_pivot_report: gapic_v1.method.wrap_method(
                self.run_pivot_report, default_timeout=60.0, client_info=client_info,
            ),
            self.batch_run_reports: gapic_v1.method.wrap_method(
                self.batch_run_reports, default_timeout=60.0, client_info=client_info,
            ),
            self.batch_run_pivot_reports: gapic_v1.method.wrap_method(
                self.batch_run_pivot_reports,
                default_timeout=60.0,
                client_info=client_info,
            ),
            self.get_metadata: gapic_v1.method.wrap_method(
                self.get_metadata, default_timeout=None, client_info=client_info,
            ),
            self.run_realtime_report: gapic_v1.method.wrap_method(
                self.run_realtime_report, default_timeout=None, client_info=client_info,
            ),
        }

    @property
    def run_report(
        self,
    ) -> typing.Callable[
        [analytics_data_api.RunReportRequest],
        typing.Union[
            analytics_data_api.RunReportResponse,
            typing.Awaitable[analytics_data_api.RunReportResponse],
        ],
    ]:
        raise NotImplementedError()

    @property
    def run_pivot_report(
        self,
    ) -> typing.Callable[
        [analytics_data_api.RunPivotReportRequest],
        typing.Union[
            analytics_data_api.RunPivotReportResponse,
            typing.Awaitable[analytics_data_api.RunPivotReportResponse],
        ],
    ]:
        raise NotImplementedError()

    @property
    def batch_run_reports(
        self,
    ) -> typing.Callable[
        [analytics_data_api.BatchRunReportsRequest],
        typing.Union[
            analytics_data_api.BatchRunReportsResponse,
            typing.Awaitable[analytics_data_api.BatchRunReportsResponse],
        ],
    ]:
        raise NotImplementedError()

    @property
    def batch_run_pivot_reports(
        self,
    ) -> typing.Callable[
        [analytics_data_api.BatchRunPivotReportsRequest],
        typing.Union[
            analytics_data_api.BatchRunPivotReportsResponse,
            typing.Awaitable[analytics_data_api.BatchRunPivotReportsResponse],
        ],
    ]:
        raise NotImplementedError()

    @property
    def get_metadata(
        self,
    ) -> typing.Callable[
        [analytics_data_api.GetMetadataRequest],
        typing.Union[
            analytics_data_api.Metadata, typing.Awaitable[analytics_data_api.Metadata]
        ],
    ]:
        raise NotImplementedError()

    @property
    def run_realtime_report(
        self,
    ) -> typing.Callable[
        [analytics_data_api.RunRealtimeReportRequest],
        typing.Union[
            analytics_data_api.RunRealtimeReportResponse,
            typing.Awaitable[analytics_data_api.RunRealtimeReportResponse],
        ],
    ]:
        raise NotImplementedError()


__all__ = ("AlphaAnalyticsDataTransport",)