From 65d7293865e8dd5f74a0315c6a15cefca9047d85 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 23 Jul 2021 21:01:07 +0000 Subject: [PATCH 1/2] fix: enable self signed jwt for grpc chore: use gapic-generator-python 0.50.5 PiperOrigin-RevId: 386504689 Source-Link: https://github.com/googleapis/googleapis/commit/762094a99ac6e03a17516b13dfbef37927267a70 Source-Link: https://github.com/googleapis/googleapis-gen/commit/6bfc480e1a161d5de121c2bcc3745885d33b265a --- owl-bot-staging/v1/.coveragerc | 17 + owl-bot-staging/v1/MANIFEST.in | 2 + owl-bot-staging/v1/README.rst | 49 + owl-bot-staging/v1/docs/conf.py | 376 +++ owl-bot-staging/v1/docs/index.rst | 7 + .../recaptcha_enterprise_service.rst | 10 + .../docs/recaptchaenterprise_v1/services.rst | 6 + .../v1/docs/recaptchaenterprise_v1/types.rst | 7 + .../cloud/recaptchaenterprise/__init__.py | 57 + .../google/cloud/recaptchaenterprise/py.typed | 2 + .../cloud/recaptchaenterprise_v1/__init__.py | 58 + .../gapic_metadata.json | 93 + .../cloud/recaptchaenterprise_v1/py.typed | 2 + .../services/__init__.py | 15 + .../recaptcha_enterprise_service/__init__.py | 22 + .../async_client.py | 614 +++++ .../recaptcha_enterprise_service/client.py | 819 ++++++ .../recaptcha_enterprise_service/pagers.py | 140 + .../transports/__init__.py | 33 + .../transports/base.py | 253 ++ .../transports/grpc.py | 413 +++ .../transports/grpc_asyncio.py | 417 +++ .../recaptchaenterprise_v1/types/__init__.py | 54 + .../types/recaptchaenterprise.py | 568 ++++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 132 + .../fixup_recaptchaenterprise_v1_keywords.py | 182 ++ owl-bot-staging/v1/setup.py | 54 + owl-bot-staging/v1/tests/__init__.py | 16 + owl-bot-staging/v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../gapic/recaptchaenterprise_v1/__init__.py | 16 + .../test_recaptcha_enterprise_service.py | 2381 +++++++++++++++++ 33 files changed, 6850 insertions(+) create mode 100644 owl-bot-staging/v1/.coveragerc create mode 100644 owl-bot-staging/v1/MANIFEST.in create mode 100644 owl-bot-staging/v1/README.rst create mode 100644 owl-bot-staging/v1/docs/conf.py create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst create mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py create mode 100644 owl-bot-staging/v1/mypy.ini create mode 100644 owl-bot-staging/v1/noxfile.py create mode 100644 owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py create mode 100644 owl-bot-staging/v1/setup.py create mode 100644 owl-bot-staging/v1/tests/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 0000000..f984736 --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/recaptchaenterprise/__init__.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore pkg_resources exceptions. + # This is added at the module level as a safeguard for if someone + # generates the code and tries to run it without pip installing. This + # makes it virtually impossible to test properly. + except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 0000000..2ebaff4 --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/recaptchaenterprise *.py +recursive-include google/cloud/recaptchaenterprise_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..dd39e48 --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Recaptchaenterprise API +================================================= + +Quick Start +----------- + +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 Google Cloud Recaptchaenterprise API. +4. `Setup 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 +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 0000000..122a4d2 --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- 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. +# +# +# google-cloud-recaptchaenterprise documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "1.6.3" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = u"google-cloud-recaptchaenterprise" +copyright = u"2020, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-recaptchaenterprise-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + master_doc, + "google-cloud-recaptchaenterprise.tex", + u"google-cloud-recaptchaenterprise Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + master_doc, + "google-cloud-recaptchaenterprise", + u"Google Cloud Recaptchaenterprise Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "google-cloud-recaptchaenterprise", + u"google-cloud-recaptchaenterprise Documentation", + author, + "google-cloud-recaptchaenterprise", + "GAPIC library for Google Cloud Recaptchaenterprise API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 0000000..35c60ea --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + recaptchaenterprise_v1/services + recaptchaenterprise_v1/types diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst new file mode 100644 index 0000000..5031186 --- /dev/null +++ b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst @@ -0,0 +1,10 @@ +RecaptchaEnterpriseService +-------------------------------------------- + +.. automodule:: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service + :members: + :inherited-members: + +.. automodule:: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst new file mode 100644 index 0000000..4211502 --- /dev/null +++ b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Recaptchaenterprise v1 API +==================================================== +.. toctree:: + :maxdepth: 2 + + recaptcha_enterprise_service diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst new file mode 100644 index 0000000..a3967e8 --- /dev/null +++ b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Recaptchaenterprise v1 API +================================================= + +.. automodule:: google.cloud.recaptchaenterprise_v1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py new file mode 100644 index 0000000..cad6ead --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py @@ -0,0 +1,57 @@ +# -*- 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. +# + +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.client import RecaptchaEnterpriseServiceClient +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.async_client import RecaptchaEnterpriseServiceAsyncClient + +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AndroidKeySettings +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AnnotateAssessmentRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AnnotateAssessmentResponse +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Assessment +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import CreateAssessmentRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import CreateKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import DeleteKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Event +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import GetKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import IOSKeySettings +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Key +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListKeysRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListKeysResponse +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RiskAnalysis +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TokenProperties +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import UpdateKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import WebKeySettings + +__all__ = ('RecaptchaEnterpriseServiceClient', + 'RecaptchaEnterpriseServiceAsyncClient', + 'AndroidKeySettings', + 'AnnotateAssessmentRequest', + 'AnnotateAssessmentResponse', + 'Assessment', + 'CreateAssessmentRequest', + 'CreateKeyRequest', + 'DeleteKeyRequest', + 'Event', + 'GetKeyRequest', + 'IOSKeySettings', + 'Key', + 'ListKeysRequest', + 'ListKeysResponse', + 'RiskAnalysis', + 'TokenProperties', + 'UpdateKeyRequest', + 'WebKeySettings', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed new file mode 100644 index 0000000..2d367bf --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-recaptchaenterprise package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py new file mode 100644 index 0000000..95f9284 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py @@ -0,0 +1,58 @@ +# -*- 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. +# + +from .services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceClient +from .services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceAsyncClient + +from .types.recaptchaenterprise import AndroidKeySettings +from .types.recaptchaenterprise import AnnotateAssessmentRequest +from .types.recaptchaenterprise import AnnotateAssessmentResponse +from .types.recaptchaenterprise import Assessment +from .types.recaptchaenterprise import CreateAssessmentRequest +from .types.recaptchaenterprise import CreateKeyRequest +from .types.recaptchaenterprise import DeleteKeyRequest +from .types.recaptchaenterprise import Event +from .types.recaptchaenterprise import GetKeyRequest +from .types.recaptchaenterprise import IOSKeySettings +from .types.recaptchaenterprise import Key +from .types.recaptchaenterprise import ListKeysRequest +from .types.recaptchaenterprise import ListKeysResponse +from .types.recaptchaenterprise import RiskAnalysis +from .types.recaptchaenterprise import TokenProperties +from .types.recaptchaenterprise import UpdateKeyRequest +from .types.recaptchaenterprise import WebKeySettings + +__all__ = ( + 'RecaptchaEnterpriseServiceAsyncClient', +'AndroidKeySettings', +'AnnotateAssessmentRequest', +'AnnotateAssessmentResponse', +'Assessment', +'CreateAssessmentRequest', +'CreateKeyRequest', +'DeleteKeyRequest', +'Event', +'GetKeyRequest', +'IOSKeySettings', +'Key', +'ListKeysRequest', +'ListKeysResponse', +'RecaptchaEnterpriseServiceClient', +'RiskAnalysis', +'TokenProperties', +'UpdateKeyRequest', +'WebKeySettings', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json new file mode 100644 index 0000000..49c568a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json @@ -0,0 +1,93 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.recaptchaenterprise_v1", + "protoPackage": "google.cloud.recaptchaenterprise.v1", + "schema": "1.0", + "services": { + "RecaptchaEnterpriseService": { + "clients": { + "grpc": { + "libraryClient": "RecaptchaEnterpriseServiceClient", + "rpcs": { + "AnnotateAssessment": { + "methods": [ + "annotate_assessment" + ] + }, + "CreateAssessment": { + "methods": [ + "create_assessment" + ] + }, + "CreateKey": { + "methods": [ + "create_key" + ] + }, + "DeleteKey": { + "methods": [ + "delete_key" + ] + }, + "GetKey": { + "methods": [ + "get_key" + ] + }, + "ListKeys": { + "methods": [ + "list_keys" + ] + }, + "UpdateKey": { + "methods": [ + "update_key" + ] + } + } + }, + "grpc-async": { + "libraryClient": "RecaptchaEnterpriseServiceAsyncClient", + "rpcs": { + "AnnotateAssessment": { + "methods": [ + "annotate_assessment" + ] + }, + "CreateAssessment": { + "methods": [ + "create_assessment" + ] + }, + "CreateKey": { + "methods": [ + "create_key" + ] + }, + "DeleteKey": { + "methods": [ + "delete_key" + ] + }, + "GetKey": { + "methods": [ + "get_key" + ] + }, + "ListKeys": { + "methods": [ + "list_keys" + ] + }, + "UpdateKey": { + "methods": [ + "update_key" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed new file mode 100644 index 0000000..2d367bf --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-recaptchaenterprise package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- 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. +# diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py new file mode 100644 index 0000000..9396f24 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py @@ -0,0 +1,22 @@ +# -*- 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. +# +from .client import RecaptchaEnterpriseServiceClient +from .async_client import RecaptchaEnterpriseServiceAsyncClient + +__all__ = ( + 'RecaptchaEnterpriseServiceClient', + 'RecaptchaEnterpriseServiceAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py new file mode 100644 index 0000000..c79c583 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py @@ -0,0 +1,614 @@ +# -*- 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. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_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 as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport +from .client import RecaptchaEnterpriseServiceClient + + +class RecaptchaEnterpriseServiceAsyncClient: + """Service to determine the likelihood an event is legitimate.""" + + _client: RecaptchaEnterpriseServiceClient + + DEFAULT_ENDPOINT = RecaptchaEnterpriseServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = RecaptchaEnterpriseServiceClient.DEFAULT_MTLS_ENDPOINT + + assessment_path = staticmethod(RecaptchaEnterpriseServiceClient.assessment_path) + parse_assessment_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_assessment_path) + key_path = staticmethod(RecaptchaEnterpriseServiceClient.key_path) + parse_key_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_key_path) + common_billing_account_path = staticmethod(RecaptchaEnterpriseServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(RecaptchaEnterpriseServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(RecaptchaEnterpriseServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_organization_path) + common_project_path = staticmethod(RecaptchaEnterpriseServiceClient.common_project_path) + parse_common_project_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_project_path) + common_location_path = staticmethod(RecaptchaEnterpriseServiceClient.common_location_path) + parse_common_location_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_location_path) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + RecaptchaEnterpriseServiceAsyncClient: The constructed client. + """ + return RecaptchaEnterpriseServiceClient.from_service_account_info.__func__(RecaptchaEnterpriseServiceAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + RecaptchaEnterpriseServiceAsyncClient: The constructed client. + """ + return RecaptchaEnterpriseServiceClient.from_service_account_file.__func__(RecaptchaEnterpriseServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> RecaptchaEnterpriseServiceTransport: + """Returns the transport used by the client instance. + + Returns: + RecaptchaEnterpriseServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(RecaptchaEnterpriseServiceClient).get_transport_class, type(RecaptchaEnterpriseServiceClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, RecaptchaEnterpriseServiceTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the recaptcha enterprise service client. + + Args: + 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. + transport (Union[str, ~.RecaptchaEnterpriseServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = RecaptchaEnterpriseServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def create_assessment(self, + request: recaptchaenterprise.CreateAssessmentRequest = None, + *, + parent: str = None, + assessment: recaptchaenterprise.Assessment = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Assessment: + r"""Creates an Assessment of the likelihood an event is + legitimate. + + Args: + request (:class:`google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest`): + The request object. The create assessment request + message. + parent (:class:`str`): + Required. The name of the project in + which the assessment will be created, in + the format "projects/{project}". + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + assessment (:class:`google.cloud.recaptchaenterprise_v1.types.Assessment`): + Required. The assessment details. + This corresponds to the ``assessment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.Assessment: + A recaptcha assessment resource. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, assessment]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = recaptchaenterprise.CreateAssessmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if assessment is not None: + request.assessment = assessment + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_assessment, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def annotate_assessment(self, + request: recaptchaenterprise.AnnotateAssessmentRequest = None, + *, + name: str = None, + annotation: recaptchaenterprise.AnnotateAssessmentRequest.Annotation = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.AnnotateAssessmentResponse: + r"""Annotates a previously created Assessment to provide + additional information on whether the event turned out + to be authentic or fradulent. + + Args: + request (:class:`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest`): + The request object. The request message to annotate an + Assessment. + name (:class:`str`): + Required. The resource name of the + Assessment, in the format + "projects/{project}/assessments/{assessment}". + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + annotation (:class:`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation`): + Required. The annotation that will be + assigned to the Event. + + This corresponds to the ``annotation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse: + Empty response for + AnnotateAssessment. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name, annotation]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = recaptchaenterprise.AnnotateAssessmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if annotation is not None: + request.annotation = annotation + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.annotate_assessment, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_key(self, + request: recaptchaenterprise.CreateKeyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Creates a new reCAPTCHA Enterprise key. + + Args: + request (:class:`google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest`): + The request object. The create key request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # Create or coerce a protobuf request object. + request = recaptchaenterprise.CreateKeyRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_key, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_keys(self, + request: recaptchaenterprise.ListKeysRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListKeysAsyncPager: + r"""Returns the list of all keys that belong to a + project. + + Args: + request (:class:`google.cloud.recaptchaenterprise_v1.types.ListKeysRequest`): + The request object. The list keys request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager: + Response to request to list keys in a + project. + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + request = recaptchaenterprise.ListKeysRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_keys, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListKeysAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_key(self, + request: recaptchaenterprise.GetKeyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Returns the specified key. + + Args: + request (:class:`google.cloud.recaptchaenterprise_v1.types.GetKeyRequest`): + The request object. The get key request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # Create or coerce a protobuf request object. + request = recaptchaenterprise.GetKeyRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_key, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_key(self, + request: recaptchaenterprise.UpdateKeyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Updates the specified key. + + Args: + request (:class:`google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest`): + The request object. The update key request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # Create or coerce a protobuf request object. + request = recaptchaenterprise.UpdateKeyRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_key, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("key.name", request.key.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_key(self, + request: recaptchaenterprise.DeleteKeyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the specified key. + + Args: + request (:class:`google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest`): + The request object. The delete key request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + request = recaptchaenterprise.DeleteKeyRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_key, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-recaptchaenterprise", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "RecaptchaEnterpriseServiceAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py new file mode 100644 index 0000000..20b6027 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py @@ -0,0 +1,819 @@ +# -*- 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. +# +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_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 as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import RecaptchaEnterpriseServiceGrpcTransport +from .transports.grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport + + +class RecaptchaEnterpriseServiceClientMeta(type): + """Metaclass for the RecaptchaEnterpriseService client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + _transport_registry = OrderedDict() # type: Dict[str, Type[RecaptchaEnterpriseServiceTransport]] + _transport_registry["grpc"] = RecaptchaEnterpriseServiceGrpcTransport + _transport_registry["grpc_asyncio"] = RecaptchaEnterpriseServiceGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[RecaptchaEnterpriseServiceTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class RecaptchaEnterpriseServiceClient(metaclass=RecaptchaEnterpriseServiceClientMeta): + """Service to determine the likelihood an event is legitimate.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "recaptchaenterprise.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + RecaptchaEnterpriseServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + RecaptchaEnterpriseServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file( + filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> RecaptchaEnterpriseServiceTransport: + """Returns the transport used by the client instance. + + Returns: + RecaptchaEnterpriseServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def assessment_path(project: str,assessment: str,) -> str: + """Returns a fully-qualified assessment string.""" + return "projects/{project}/assessments/{assessment}".format(project=project, assessment=assessment, ) + + @staticmethod + def parse_assessment_path(path: str) -> Dict[str,str]: + """Parses a assessment path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/assessments/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def key_path(project: str,key: str,) -> str: + """Returns a fully-qualified key string.""" + return "projects/{project}/keys/{key}".format(project=project, key=key, ) + + @staticmethod + def parse_key_path(path: str) -> Dict[str,str]: + """Parses a key path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/keys/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, RecaptchaEnterpriseServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the recaptcha enterprise service client. + + Args: + 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. + transport (Union[str, RecaptchaEnterpriseServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + 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. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, RecaptchaEnterpriseServiceTransport): + # transport is a RecaptchaEnterpriseServiceTransport instance. + if credentials or client_options.credentials_file: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=( + Transport == type(self).get_transport_class("grpc") + or Transport == type(self).get_transport_class("grpc_asyncio") + ), + ) + + def create_assessment(self, + request: recaptchaenterprise.CreateAssessmentRequest = None, + *, + parent: str = None, + assessment: recaptchaenterprise.Assessment = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Assessment: + r"""Creates an Assessment of the likelihood an event is + legitimate. + + Args: + request (google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest): + The request object. The create assessment request + message. + parent (str): + Required. The name of the project in + which the assessment will be created, in + the format "projects/{project}". + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + assessment (google.cloud.recaptchaenterprise_v1.types.Assessment): + Required. The assessment details. + This corresponds to the ``assessment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.Assessment: + A recaptcha assessment resource. + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, assessment]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a recaptchaenterprise.CreateAssessmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.CreateAssessmentRequest): + request = recaptchaenterprise.CreateAssessmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if assessment is not None: + request.assessment = assessment + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_assessment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def annotate_assessment(self, + request: recaptchaenterprise.AnnotateAssessmentRequest = None, + *, + name: str = None, + annotation: recaptchaenterprise.AnnotateAssessmentRequest.Annotation = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.AnnotateAssessmentResponse: + r"""Annotates a previously created Assessment to provide + additional information on whether the event turned out + to be authentic or fradulent. + + Args: + request (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest): + The request object. The request message to annotate an + Assessment. + name (str): + Required. The resource name of the + Assessment, in the format + "projects/{project}/assessments/{assessment}". + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation): + Required. The annotation that will be + assigned to the Event. + + This corresponds to the ``annotation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse: + Empty response for + AnnotateAssessment. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name, annotation]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a recaptchaenterprise.AnnotateAssessmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.AnnotateAssessmentRequest): + request = recaptchaenterprise.AnnotateAssessmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if annotation is not None: + request.annotation = annotation + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.annotate_assessment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_key(self, + request: recaptchaenterprise.CreateKeyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Creates a new reCAPTCHA Enterprise key. + + Args: + request (google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest): + The request object. The create key request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a recaptchaenterprise.CreateKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.CreateKeyRequest): + request = recaptchaenterprise.CreateKeyRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_keys(self, + request: recaptchaenterprise.ListKeysRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListKeysPager: + r"""Returns the list of all keys that belong to a + project. + + Args: + request (google.cloud.recaptchaenterprise_v1.types.ListKeysRequest): + The request object. The list keys request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager: + Response to request to list keys in a + project. + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a recaptchaenterprise.ListKeysRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.ListKeysRequest): + request = recaptchaenterprise.ListKeysRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_keys] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListKeysPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_key(self, + request: recaptchaenterprise.GetKeyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Returns the specified key. + + Args: + request (google.cloud.recaptchaenterprise_v1.types.GetKeyRequest): + The request object. The get key request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a recaptchaenterprise.GetKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.GetKeyRequest): + request = recaptchaenterprise.GetKeyRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_key(self, + request: recaptchaenterprise.UpdateKeyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Updates the specified key. + + Args: + request (google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest): + The request object. The update key request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a recaptchaenterprise.UpdateKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.UpdateKeyRequest): + request = recaptchaenterprise.UpdateKeyRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("key.name", request.key.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_key(self, + request: recaptchaenterprise.DeleteKeyRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the specified key. + + Args: + request (google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest): + The request object. The delete key request message. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a recaptchaenterprise.DeleteKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.DeleteKeyRequest): + request = recaptchaenterprise.DeleteKeyRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-recaptchaenterprise", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "RecaptchaEnterpriseServiceClient", +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py new file mode 100644 index 0000000..59cad30 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py @@ -0,0 +1,140 @@ +# -*- 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. +# +from typing import Any, AsyncIterable, Awaitable, Callable, Iterable, Sequence, Tuple, Optional + +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise + + +class ListKeysPager: + """A pager for iterating through ``list_keys`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` object, and + provides an ``__iter__`` method to iterate through its + ``keys`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListKeys`` requests and continue to iterate + through the ``keys`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., recaptchaenterprise.ListKeysResponse], + request: recaptchaenterprise.ListKeysRequest, + response: recaptchaenterprise.ListKeysResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.recaptchaenterprise_v1.types.ListKeysRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = recaptchaenterprise.ListKeysRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[recaptchaenterprise.ListKeysResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[recaptchaenterprise.Key]: + for page in self.pages: + yield from page.keys + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListKeysAsyncPager: + """A pager for iterating through ``list_keys`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``keys`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListKeys`` requests and continue to iterate + through the ``keys`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[recaptchaenterprise.ListKeysResponse]], + request: recaptchaenterprise.ListKeysRequest, + response: recaptchaenterprise.ListKeysResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.recaptchaenterprise_v1.types.ListKeysRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = recaptchaenterprise.ListKeysRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[recaptchaenterprise.ListKeysResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[recaptchaenterprise.Key]: + async def async_generator(): + async for page in self.pages: + for response in page.keys: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py new file mode 100644 index 0000000..4370808 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- 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. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import RecaptchaEnterpriseServiceTransport +from .grpc import RecaptchaEnterpriseServiceGrpcTransport +from .grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[RecaptchaEnterpriseServiceTransport]] +_transport_registry['grpc'] = RecaptchaEnterpriseServiceGrpcTransport +_transport_registry['grpc_asyncio'] = RecaptchaEnterpriseServiceGrpcAsyncIOTransport + +__all__ = ( + 'RecaptchaEnterpriseServiceTransport', + 'RecaptchaEnterpriseServiceGrpcTransport', + 'RecaptchaEnterpriseServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py new file mode 100644 index 0000000..563f205 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py @@ -0,0 +1,253 @@ +# -*- 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 +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_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 as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import empty_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-recaptchaenterprise', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + + +class RecaptchaEnterpriseServiceTransport(abc.ABC): + """Abstract transport class for RecaptchaEnterpriseService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'recaptchaenterprise.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **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. + scopes (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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # If the credentials is service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_assessment: gapic_v1.method.wrap_method( + self.create_assessment, + default_timeout=600.0, + client_info=client_info, + ), + self.annotate_assessment: gapic_v1.method.wrap_method( + self.annotate_assessment, + default_timeout=600.0, + client_info=client_info, + ), + self.create_key: gapic_v1.method.wrap_method( + self.create_key, + default_timeout=600.0, + client_info=client_info, + ), + self.list_keys: gapic_v1.method.wrap_method( + self.list_keys, + default_timeout=600.0, + client_info=client_info, + ), + self.get_key: gapic_v1.method.wrap_method( + self.get_key, + default_timeout=600.0, + client_info=client_info, + ), + self.update_key: gapic_v1.method.wrap_method( + self.update_key, + default_timeout=600.0, + client_info=client_info, + ), + self.delete_key: gapic_v1.method.wrap_method( + self.delete_key, + default_timeout=600.0, + client_info=client_info, + ), + } + + @property + def create_assessment(self) -> Callable[ + [recaptchaenterprise.CreateAssessmentRequest], + Union[ + recaptchaenterprise.Assessment, + Awaitable[recaptchaenterprise.Assessment] + ]]: + raise NotImplementedError() + + @property + def annotate_assessment(self) -> Callable[ + [recaptchaenterprise.AnnotateAssessmentRequest], + Union[ + recaptchaenterprise.AnnotateAssessmentResponse, + Awaitable[recaptchaenterprise.AnnotateAssessmentResponse] + ]]: + raise NotImplementedError() + + @property + def create_key(self) -> Callable[ + [recaptchaenterprise.CreateKeyRequest], + Union[ + recaptchaenterprise.Key, + Awaitable[recaptchaenterprise.Key] + ]]: + raise NotImplementedError() + + @property + def list_keys(self) -> Callable[ + [recaptchaenterprise.ListKeysRequest], + Union[ + recaptchaenterprise.ListKeysResponse, + Awaitable[recaptchaenterprise.ListKeysResponse] + ]]: + raise NotImplementedError() + + @property + def get_key(self) -> Callable[ + [recaptchaenterprise.GetKeyRequest], + Union[ + recaptchaenterprise.Key, + Awaitable[recaptchaenterprise.Key] + ]]: + raise NotImplementedError() + + @property + def update_key(self) -> Callable[ + [recaptchaenterprise.UpdateKeyRequest], + Union[ + recaptchaenterprise.Key, + Awaitable[recaptchaenterprise.Key] + ]]: + raise NotImplementedError() + + @property + def delete_key(self) -> Callable[ + [recaptchaenterprise.DeleteKeyRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'RecaptchaEnterpriseServiceTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py new file mode 100644 index 0000000..da58ca9 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py @@ -0,0 +1,413 @@ +# -*- 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 warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import gapic_v1 # type: ignore +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import empty_pb2 # type: ignore +from .base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO + + +class RecaptchaEnterpriseServiceGrpcTransport(RecaptchaEnterpriseServiceTransport): + """gRPC backend transport for RecaptchaEnterpriseService. + + Service to determine the likelihood an event is legitimate. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'recaptchaenterprise.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> 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. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + 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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'recaptchaenterprise.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this 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. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def create_assessment(self) -> Callable[ + [recaptchaenterprise.CreateAssessmentRequest], + recaptchaenterprise.Assessment]: + r"""Return a callable for the create assessment method over gRPC. + + Creates an Assessment of the likelihood an event is + legitimate. + + Returns: + Callable[[~.CreateAssessmentRequest], + ~.Assessment]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_assessment' not in self._stubs: + self._stubs['create_assessment'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateAssessment', + request_serializer=recaptchaenterprise.CreateAssessmentRequest.serialize, + response_deserializer=recaptchaenterprise.Assessment.deserialize, + ) + return self._stubs['create_assessment'] + + @property + def annotate_assessment(self) -> Callable[ + [recaptchaenterprise.AnnotateAssessmentRequest], + recaptchaenterprise.AnnotateAssessmentResponse]: + r"""Return a callable for the annotate assessment method over gRPC. + + Annotates a previously created Assessment to provide + additional information on whether the event turned out + to be authentic or fradulent. + + Returns: + Callable[[~.AnnotateAssessmentRequest], + ~.AnnotateAssessmentResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'annotate_assessment' not in self._stubs: + self._stubs['annotate_assessment'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/AnnotateAssessment', + request_serializer=recaptchaenterprise.AnnotateAssessmentRequest.serialize, + response_deserializer=recaptchaenterprise.AnnotateAssessmentResponse.deserialize, + ) + return self._stubs['annotate_assessment'] + + @property + def create_key(self) -> Callable[ + [recaptchaenterprise.CreateKeyRequest], + recaptchaenterprise.Key]: + r"""Return a callable for the create key method over gRPC. + + Creates a new reCAPTCHA Enterprise key. + + Returns: + Callable[[~.CreateKeyRequest], + ~.Key]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_key' not in self._stubs: + self._stubs['create_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateKey', + request_serializer=recaptchaenterprise.CreateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['create_key'] + + @property + def list_keys(self) -> Callable[ + [recaptchaenterprise.ListKeysRequest], + recaptchaenterprise.ListKeysResponse]: + r"""Return a callable for the list keys method over gRPC. + + Returns the list of all keys that belong to a + project. + + Returns: + Callable[[~.ListKeysRequest], + ~.ListKeysResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_keys' not in self._stubs: + self._stubs['list_keys'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListKeys', + request_serializer=recaptchaenterprise.ListKeysRequest.serialize, + response_deserializer=recaptchaenterprise.ListKeysResponse.deserialize, + ) + return self._stubs['list_keys'] + + @property + def get_key(self) -> Callable[ + [recaptchaenterprise.GetKeyRequest], + recaptchaenterprise.Key]: + r"""Return a callable for the get key method over gRPC. + + Returns the specified key. + + Returns: + Callable[[~.GetKeyRequest], + ~.Key]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_key' not in self._stubs: + self._stubs['get_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetKey', + request_serializer=recaptchaenterprise.GetKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['get_key'] + + @property + def update_key(self) -> Callable[ + [recaptchaenterprise.UpdateKeyRequest], + recaptchaenterprise.Key]: + r"""Return a callable for the update key method over gRPC. + + Updates the specified key. + + Returns: + Callable[[~.UpdateKeyRequest], + ~.Key]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_key' not in self._stubs: + self._stubs['update_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/UpdateKey', + request_serializer=recaptchaenterprise.UpdateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['update_key'] + + @property + def delete_key(self) -> Callable[ + [recaptchaenterprise.DeleteKeyRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete key method over gRPC. + + Deletes the specified key. + + Returns: + Callable[[~.DeleteKeyRequest], + ~.Empty]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_key' not in self._stubs: + self._stubs['delete_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/DeleteKey', + request_serializer=recaptchaenterprise.DeleteKeyRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_key'] + + +__all__ = ( + 'RecaptchaEnterpriseServiceGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..1ce2152 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py @@ -0,0 +1,417 @@ +# -*- 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 warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import empty_pb2 # type: ignore +from .base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import RecaptchaEnterpriseServiceGrpcTransport + + +class RecaptchaEnterpriseServiceGrpcAsyncIOTransport(RecaptchaEnterpriseServiceTransport): + """gRPC AsyncIO backend transport for RecaptchaEnterpriseService. + + Service to determine the likelihood an event is legitimate. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'recaptchaenterprise.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this 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 ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'recaptchaenterprise.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> 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. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + 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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def create_assessment(self) -> Callable[ + [recaptchaenterprise.CreateAssessmentRequest], + Awaitable[recaptchaenterprise.Assessment]]: + r"""Return a callable for the create assessment method over gRPC. + + Creates an Assessment of the likelihood an event is + legitimate. + + Returns: + Callable[[~.CreateAssessmentRequest], + Awaitable[~.Assessment]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_assessment' not in self._stubs: + self._stubs['create_assessment'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateAssessment', + request_serializer=recaptchaenterprise.CreateAssessmentRequest.serialize, + response_deserializer=recaptchaenterprise.Assessment.deserialize, + ) + return self._stubs['create_assessment'] + + @property + def annotate_assessment(self) -> Callable[ + [recaptchaenterprise.AnnotateAssessmentRequest], + Awaitable[recaptchaenterprise.AnnotateAssessmentResponse]]: + r"""Return a callable for the annotate assessment method over gRPC. + + Annotates a previously created Assessment to provide + additional information on whether the event turned out + to be authentic or fradulent. + + Returns: + Callable[[~.AnnotateAssessmentRequest], + Awaitable[~.AnnotateAssessmentResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'annotate_assessment' not in self._stubs: + self._stubs['annotate_assessment'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/AnnotateAssessment', + request_serializer=recaptchaenterprise.AnnotateAssessmentRequest.serialize, + response_deserializer=recaptchaenterprise.AnnotateAssessmentResponse.deserialize, + ) + return self._stubs['annotate_assessment'] + + @property + def create_key(self) -> Callable[ + [recaptchaenterprise.CreateKeyRequest], + Awaitable[recaptchaenterprise.Key]]: + r"""Return a callable for the create key method over gRPC. + + Creates a new reCAPTCHA Enterprise key. + + Returns: + Callable[[~.CreateKeyRequest], + Awaitable[~.Key]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_key' not in self._stubs: + self._stubs['create_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateKey', + request_serializer=recaptchaenterprise.CreateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['create_key'] + + @property + def list_keys(self) -> Callable[ + [recaptchaenterprise.ListKeysRequest], + Awaitable[recaptchaenterprise.ListKeysResponse]]: + r"""Return a callable for the list keys method over gRPC. + + Returns the list of all keys that belong to a + project. + + Returns: + Callable[[~.ListKeysRequest], + Awaitable[~.ListKeysResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_keys' not in self._stubs: + self._stubs['list_keys'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListKeys', + request_serializer=recaptchaenterprise.ListKeysRequest.serialize, + response_deserializer=recaptchaenterprise.ListKeysResponse.deserialize, + ) + return self._stubs['list_keys'] + + @property + def get_key(self) -> Callable[ + [recaptchaenterprise.GetKeyRequest], + Awaitable[recaptchaenterprise.Key]]: + r"""Return a callable for the get key method over gRPC. + + Returns the specified key. + + Returns: + Callable[[~.GetKeyRequest], + Awaitable[~.Key]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_key' not in self._stubs: + self._stubs['get_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetKey', + request_serializer=recaptchaenterprise.GetKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['get_key'] + + @property + def update_key(self) -> Callable[ + [recaptchaenterprise.UpdateKeyRequest], + Awaitable[recaptchaenterprise.Key]]: + r"""Return a callable for the update key method over gRPC. + + Updates the specified key. + + Returns: + Callable[[~.UpdateKeyRequest], + Awaitable[~.Key]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_key' not in self._stubs: + self._stubs['update_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/UpdateKey', + request_serializer=recaptchaenterprise.UpdateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['update_key'] + + @property + def delete_key(self) -> Callable[ + [recaptchaenterprise.DeleteKeyRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete key method over gRPC. + + Deletes the specified key. + + Returns: + Callable[[~.DeleteKeyRequest], + Awaitable[~.Empty]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_key' not in self._stubs: + self._stubs['delete_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/DeleteKey', + request_serializer=recaptchaenterprise.DeleteKeyRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_key'] + + +__all__ = ( + 'RecaptchaEnterpriseServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py new file mode 100644 index 0000000..1e9aa69 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py @@ -0,0 +1,54 @@ +# -*- 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. +# +from .recaptchaenterprise import ( + AndroidKeySettings, + AnnotateAssessmentRequest, + AnnotateAssessmentResponse, + Assessment, + CreateAssessmentRequest, + CreateKeyRequest, + DeleteKeyRequest, + Event, + GetKeyRequest, + IOSKeySettings, + Key, + ListKeysRequest, + ListKeysResponse, + RiskAnalysis, + TokenProperties, + UpdateKeyRequest, + WebKeySettings, +) + +__all__ = ( + 'AndroidKeySettings', + 'AnnotateAssessmentRequest', + 'AnnotateAssessmentResponse', + 'Assessment', + 'CreateAssessmentRequest', + 'CreateKeyRequest', + 'DeleteKeyRequest', + 'Event', + 'GetKeyRequest', + 'IOSKeySettings', + 'Key', + 'ListKeysRequest', + 'ListKeysResponse', + 'RiskAnalysis', + 'TokenProperties', + 'UpdateKeyRequest', + 'WebKeySettings', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py new file mode 100644 index 0000000..e5f917f --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py @@ -0,0 +1,568 @@ +# -*- 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 proto # type: ignore + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.recaptchaenterprise.v1', + manifest={ + 'CreateAssessmentRequest', + 'AnnotateAssessmentRequest', + 'AnnotateAssessmentResponse', + 'Assessment', + 'Event', + 'RiskAnalysis', + 'TokenProperties', + 'CreateKeyRequest', + 'ListKeysRequest', + 'ListKeysResponse', + 'GetKeyRequest', + 'UpdateKeyRequest', + 'DeleteKeyRequest', + 'Key', + 'WebKeySettings', + 'AndroidKeySettings', + 'IOSKeySettings', + }, +) + + +class CreateAssessmentRequest(proto.Message): + r"""The create assessment request message. + Attributes: + parent (str): + Required. The name of the project in which + the assessment will be created, in the format + "projects/{project}". + assessment (google.cloud.recaptchaenterprise_v1.types.Assessment): + Required. The assessment details. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + assessment = proto.Field( + proto.MESSAGE, + number=2, + message='Assessment', + ) + + +class AnnotateAssessmentRequest(proto.Message): + r"""The request message to annotate an Assessment. + Attributes: + name (str): + Required. The resource name of the + Assessment, in the format + "projects/{project}/assessments/{assessment}". + annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation): + Required. The annotation that will be + assigned to the Event. + """ + class Annotation(proto.Enum): + r"""Enum that reprensents the types of annotations.""" + ANNOTATION_UNSPECIFIED = 0 + LEGITIMATE = 1 + FRAUDULENT = 2 + PASSWORD_CORRECT = 3 + PASSWORD_INCORRECT = 4 + + name = proto.Field( + proto.STRING, + number=1, + ) + annotation = proto.Field( + proto.ENUM, + number=2, + enum=Annotation, + ) + + +class AnnotateAssessmentResponse(proto.Message): + r"""Empty response for AnnotateAssessment. """ + + +class Assessment(proto.Message): + r"""A recaptcha assessment resource. + Attributes: + name (str): + Output only. The resource name for the + Assessment in the format + "projects/{project}/assessments/{assessment}". + event (google.cloud.recaptchaenterprise_v1.types.Event): + The event being assessed. + risk_analysis (google.cloud.recaptchaenterprise_v1.types.RiskAnalysis): + Output only. The risk analysis result for the + event being assessed. + token_properties (google.cloud.recaptchaenterprise_v1.types.TokenProperties): + Output only. Properties of the provided event + token. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + event = proto.Field( + proto.MESSAGE, + number=2, + message='Event', + ) + risk_analysis = proto.Field( + proto.MESSAGE, + number=3, + message='RiskAnalysis', + ) + token_properties = proto.Field( + proto.MESSAGE, + number=4, + message='TokenProperties', + ) + + +class Event(proto.Message): + r""" + Attributes: + token (str): + Optional. The user response token provided by + the reCAPTCHA client-side integration on your + site. + site_key (str): + Optional. The site key that was used to + invoke reCAPTCHA on your site and generate the + token. + user_agent (str): + Optional. The user agent present in the + request from the user's device related to this + event. + user_ip_address (str): + Optional. The IP address in the request from + the user's device related to this event. + expected_action (str): + Optional. The expected action for this type + of event. This should be the same action + provided at token generation time on client-side + platforms already integrated with recaptcha + enterprise. + """ + + token = proto.Field( + proto.STRING, + number=1, + ) + site_key = proto.Field( + proto.STRING, + number=2, + ) + user_agent = proto.Field( + proto.STRING, + number=3, + ) + user_ip_address = proto.Field( + proto.STRING, + number=4, + ) + expected_action = proto.Field( + proto.STRING, + number=5, + ) + + +class RiskAnalysis(proto.Message): + r"""Risk analysis result for an event. + Attributes: + score (float): + Legitimate event score from 0.0 to 1.0. + (1.0 means very likely legitimate traffic while + 0.0 means very likely non-legitimate traffic). + reasons (Sequence[google.cloud.recaptchaenterprise_v1.types.RiskAnalysis.ClassificationReason]): + Reasons contributing to the risk analysis + verdict. + """ + class ClassificationReason(proto.Enum): + r"""LINT.IfChange(classification_reason) Reasons contributing to the + risk analysis verdict. + """ + CLASSIFICATION_REASON_UNSPECIFIED = 0 + AUTOMATION = 1 + UNEXPECTED_ENVIRONMENT = 2 + TOO_MUCH_TRAFFIC = 3 + UNEXPECTED_USAGE_PATTERNS = 4 + LOW_CONFIDENCE_SCORE = 5 + + score = proto.Field( + proto.FLOAT, + number=1, + ) + reasons = proto.RepeatedField( + proto.ENUM, + number=2, + enum=ClassificationReason, + ) + + +class TokenProperties(proto.Message): + r""" + Attributes: + valid (bool): + Whether the provided user response token is valid. When + valid = false, the reason could be specified in + invalid_reason or it could also be due to a user failing to + solve a challenge or a sitekey mismatch (i.e the sitekey + used to generate the token was different than the one + specified in the assessment). + invalid_reason (google.cloud.recaptchaenterprise_v1.types.TokenProperties.InvalidReason): + Reason associated with the response when + valid = false. + create_time (google.protobuf.timestamp_pb2.Timestamp): + The timestamp corresponding to the generation + of the token. + hostname (str): + The hostname of the page on which the token + was generated. + action (str): + Action name provided at token generation. + """ + class InvalidReason(proto.Enum): + r"""LINT.IfChange + Enum that represents the types of invalid token reasons. + """ + INVALID_REASON_UNSPECIFIED = 0 + UNKNOWN_INVALID_REASON = 1 + MALFORMED = 2 + EXPIRED = 3 + DUPE = 4 + MISSING = 5 + + valid = proto.Field( + proto.BOOL, + number=1, + ) + invalid_reason = proto.Field( + proto.ENUM, + number=2, + enum=InvalidReason, + ) + create_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + hostname = proto.Field( + proto.STRING, + number=4, + ) + action = proto.Field( + proto.STRING, + number=5, + ) + + +class CreateKeyRequest(proto.Message): + r"""The create key request message. + Attributes: + parent (str): + Required. The name of the project in which + the key will be created, in the format + "projects/{project}". + key (google.cloud.recaptchaenterprise_v1.types.Key): + Required. Information to create a reCAPTCHA + Enterprise key. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + key = proto.Field( + proto.MESSAGE, + number=2, + message='Key', + ) + + +class ListKeysRequest(proto.Message): + r"""The list keys request message. + Attributes: + parent (str): + Required. The name of the project that + contains the keys that will be listed, in the + format "projects/{project}". + page_size (int): + Optional. The maximum number of keys to + return. Default is 10. Max limit is 1000. + page_token (str): + Optional. The next_page_token value returned from a + previous. ListKeysRequest, if any. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + + +class ListKeysResponse(proto.Message): + r"""Response to request to list keys in a project. + Attributes: + keys (Sequence[google.cloud.recaptchaenterprise_v1.types.Key]): + Key details. + next_page_token (str): + Token to retrieve the next page of results. + It is set to empty if no keys remain in results. + """ + + @property + def raw_page(self): + return self + + keys = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Key', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetKeyRequest(proto.Message): + r"""The get key request message. + Attributes: + name (str): + Required. The name of the requested key, in + the format "projects/{project}/keys/{key}". + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateKeyRequest(proto.Message): + r"""The update key request message. + Attributes: + key (google.cloud.recaptchaenterprise_v1.types.Key): + Required. The key to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. The mask to control which field of + the key get updated. If the mask is not present, + all fields will be updated. + """ + + key = proto.Field( + proto.MESSAGE, + number=1, + message='Key', + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class DeleteKeyRequest(proto.Message): + r"""The delete key request message. + Attributes: + name (str): + Required. The name of the key to be deleted, + in the format "projects/{project}/keys/{key}". + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class Key(proto.Message): + r"""A key used to identify and configure applications (web and/or + mobile) that use reCAPTCHA Enterprise. + + Attributes: + name (str): + The resource name for the Key in the format + "projects/{project}/keys/{key}". + display_name (str): + Human-readable display name of this key. + Modifiable by user. + web_settings (google.cloud.recaptchaenterprise_v1.types.WebKeySettings): + Settings for keys that can be used by + websites. + android_settings (google.cloud.recaptchaenterprise_v1.types.AndroidKeySettings): + Settings for keys that can be used by Android + apps. + ios_settings (google.cloud.recaptchaenterprise_v1.types.IOSKeySettings): + Settings for keys that can be used by iOS + apps. + labels (Sequence[google.cloud.recaptchaenterprise_v1.types.Key.LabelsEntry]): + Optional. See Creating and managing + labels. + create_time (google.protobuf.timestamp_pb2.Timestamp): + The timestamp corresponding to the creation + of this Key. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + display_name = proto.Field( + proto.STRING, + number=2, + ) + web_settings = proto.Field( + proto.MESSAGE, + number=3, + oneof='platform_settings', + message='WebKeySettings', + ) + android_settings = proto.Field( + proto.MESSAGE, + number=4, + oneof='platform_settings', + message='AndroidKeySettings', + ) + ios_settings = proto.Field( + proto.MESSAGE, + number=5, + oneof='platform_settings', + message='IOSKeySettings', + ) + labels = proto.MapField( + proto.STRING, + proto.STRING, + number=6, + ) + create_time = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, + ) + + +class WebKeySettings(proto.Message): + r"""Settings specific to keys that can be used by websites. + Attributes: + allow_all_domains (bool): + If set to true, it means allowed_domains will not be + enforced. + allowed_domains (Sequence[str]): + Domains or subdomains of websites allowed to + use the key. All subdomains of an allowed domain + are automatically allowed. A valid domain + requires a host and must not include any path, + port, query or fragment. Examples: 'example.com' + or 'subdomain.example.com' + allow_amp_traffic (bool): + Required. Whether this key can be used on AMP + (Accelerated Mobile Pages) websites. + integration_type (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.IntegrationType): + Required. Describes how this key is + integrated with the website. + challenge_security_preference (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.ChallengeSecurityPreference): + Settings for the frequency and difficulty at + which this key triggers captcha challenges. This + should only be specified for IntegrationTypes + CHECKBOX and INVISIBLE. + """ + class IntegrationType(proto.Enum): + r"""Enum that represents the integration types for web keys.""" + INTEGRATION_TYPE_UNSPECIFIED = 0 + SCORE = 1 + CHECKBOX = 2 + INVISIBLE = 3 + + class ChallengeSecurityPreference(proto.Enum): + r"""Enum that represents the possible challenge frequency and + difficulty configurations for a web key. + """ + CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0 + USABILITY = 1 + BALANCE = 2 + SECURITY = 3 + + allow_all_domains = proto.Field( + proto.BOOL, + number=3, + ) + allowed_domains = proto.RepeatedField( + proto.STRING, + number=1, + ) + allow_amp_traffic = proto.Field( + proto.BOOL, + number=2, + ) + integration_type = proto.Field( + proto.ENUM, + number=4, + enum=IntegrationType, + ) + challenge_security_preference = proto.Field( + proto.ENUM, + number=5, + enum=ChallengeSecurityPreference, + ) + + +class AndroidKeySettings(proto.Message): + r"""Settings specific to keys that can be used by Android apps. + Attributes: + allowed_package_names (Sequence[str]): + Android package names of apps allowed to use + the key. Example: 'com.companyname.appname' + """ + + allowed_package_names = proto.RepeatedField( + proto.STRING, + number=1, + ) + + +class IOSKeySettings(proto.Message): + r"""Settings specific to keys that can be used by iOS apps. + Attributes: + allowed_bundle_ids (Sequence[str]): + iOS bundle ids of apps allowed to use the + key. Example: + 'com.companyname.productname.appname' + """ + + allowed_bundle_ids = proto.RepeatedField( + proto.STRING, + number=1, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini new file mode 100644 index 0000000..4505b48 --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py new file mode 100644 index 0000000..d868346 --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,132 @@ +# -*- 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 os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", +] + +@nox.session(python=['3.6', '3.7', '3.8', '3.9']) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/recaptchaenterprise_v1/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python='3.7') +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=['3.6', '3.7']) +def mypy(session): + """Run the type checker.""" + session.install('mypy', 'types-pkg_resources') + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python='3.6') +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx<3.0.0", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) diff --git a/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py new file mode 100644 index 0000000..9fe41bb --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py @@ -0,0 +1,182 @@ +#! /usr/bin/env python3 +# -*- 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 argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class recaptchaenterpriseCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'annotate_assessment': ('name', 'annotation', ), + 'create_assessment': ('parent', 'assessment', ), + 'create_key': ('parent', 'key', ), + 'delete_key': ('name', ), + 'get_key': ('name', ), + 'list_keys': ('parent', 'page_size', 'page_token', ), + 'update_key': ('key', 'update_mask', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: not a.keyword.value in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=recaptchaenterpriseCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the recaptchaenterprise client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py new file mode 100644 index 0000000..c85c9f2 --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,54 @@ +# -*- 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 io +import os +import setuptools # type: ignore + +version = '0.1.0' + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, 'README.rst') +with io.open(readme_filename, encoding='utf-8') as readme_file: + readme = readme_file.read() + +setuptools.setup( + name='google-cloud-recaptchaenterprise', + version=version, + long_description=readme, + packages=setuptools.PEP420PackageFinder.find(), + namespace_packages=('google', 'google.cloud'), + platforms='Posix; MacOS X; Windows', + include_package_data=True, + install_requires=( + 'google-api-core[grpc] >= 1.27.0, < 3.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + 'packaging >= 14.3', ), + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- 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. +# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- 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. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- 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. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- 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. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py new file mode 100644 index 0000000..ebf590f --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py @@ -0,0 +1,2381 @@ +# -*- 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 os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceAsyncClient +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceClient +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import transports +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(None) is None + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + RecaptchaEnterpriseServiceClient, + RecaptchaEnterpriseServiceAsyncClient, +]) +def test_recaptcha_enterprise_service_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'recaptchaenterprise.googleapis.com:443' + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), + (transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recaptcha_enterprise_service_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class", [ + RecaptchaEnterpriseServiceClient, + RecaptchaEnterpriseServiceAsyncClient, +]) +def test_recaptcha_enterprise_service_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'recaptchaenterprise.googleapis.com:443' + + +def test_recaptcha_enterprise_service_client_get_transport_class(): + transport = RecaptchaEnterpriseServiceClient.get_transport_class() + available_transports = [ + transports.RecaptchaEnterpriseServiceGrpcTransport, + ] + assert transport in available_transports + + transport = RecaptchaEnterpriseServiceClient.get_transport_class("grpc") + assert transport == transports.RecaptchaEnterpriseServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) +@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) +def test_recaptcha_enterprise_service_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(RecaptchaEnterpriseServiceClient, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(RecaptchaEnterpriseServiceClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class() + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class() + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", "true"), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", "false"), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) +@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_recaptcha_enterprise_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recaptcha_enterprise_service_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recaptcha_enterprise_service_client_client_options_credentials_file(client_class, transport_class, transport_name): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_recaptcha_enterprise_service_client_client_options_from_dict(): + with mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = RecaptchaEnterpriseServiceClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_create_assessment(transport: str = 'grpc', request_type=recaptchaenterprise.CreateAssessmentRequest): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Assessment( + name='name_value', + ) + response = client.create_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateAssessmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Assessment) + assert response.name == 'name_value' + + +def test_create_assessment_from_dict(): + test_create_assessment(request_type=dict) + + +def test_create_assessment_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + client.create_assessment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateAssessmentRequest() + + +@pytest.mark.asyncio +async def test_create_assessment_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.CreateAssessmentRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment( + name='name_value', + )) + response = await client.create_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateAssessmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Assessment) + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_create_assessment_async_from_dict(): + await test_create_assessment_async(request_type=dict) + + +def test_create_assessment_field_headers(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.CreateAssessmentRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + call.return_value = recaptchaenterprise.Assessment() + client.create_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_assessment_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.CreateAssessmentRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment()) + await client.create_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +def test_create_assessment_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Assessment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_assessment( + parent='parent_value', + assessment=recaptchaenterprise.Assessment(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].assessment == recaptchaenterprise.Assessment(name='name_value') + + +def test_create_assessment_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_assessment( + recaptchaenterprise.CreateAssessmentRequest(), + parent='parent_value', + assessment=recaptchaenterprise.Assessment(name='name_value'), + ) + + +@pytest.mark.asyncio +async def test_create_assessment_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Assessment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_assessment( + parent='parent_value', + assessment=recaptchaenterprise.Assessment(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].assessment == recaptchaenterprise.Assessment(name='name_value') + + +@pytest.mark.asyncio +async def test_create_assessment_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_assessment( + recaptchaenterprise.CreateAssessmentRequest(), + parent='parent_value', + assessment=recaptchaenterprise.Assessment(name='name_value'), + ) + + +def test_annotate_assessment(transport: str = 'grpc', request_type=recaptchaenterprise.AnnotateAssessmentRequest): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.AnnotateAssessmentResponse( + ) + response = client.annotate_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.AnnotateAssessmentResponse) + + +def test_annotate_assessment_from_dict(): + test_annotate_assessment(request_type=dict) + + +def test_annotate_assessment_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + client.annotate_assessment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() + + +@pytest.mark.asyncio +async def test_annotate_assessment_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.AnnotateAssessmentRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse( + )) + response = await client.annotate_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.AnnotateAssessmentResponse) + + +@pytest.mark.asyncio +async def test_annotate_assessment_async_from_dict(): + await test_annotate_assessment_async(request_type=dict) + + +def test_annotate_assessment_field_headers(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.AnnotateAssessmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() + client.annotate_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_annotate_assessment_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.AnnotateAssessmentRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse()) + await client.annotate_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +def test_annotate_assessment_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.annotate_assessment( + name='name_value', + annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + assert args[0].annotation == recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE + + +def test_annotate_assessment_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.annotate_assessment( + recaptchaenterprise.AnnotateAssessmentRequest(), + name='name_value', + annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, + ) + + +@pytest.mark.asyncio +async def test_annotate_assessment_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.annotate_assessment( + name='name_value', + annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + assert args[0].annotation == recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE + + +@pytest.mark.asyncio +async def test_annotate_assessment_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.annotate_assessment( + recaptchaenterprise.AnnotateAssessmentRequest(), + name='name_value', + annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, + ) + + +def test_create_key(transport: str = 'grpc', request_type=recaptchaenterprise.CreateKeyRequest): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), + ) + response = client.create_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +def test_create_key_from_dict(): + test_create_key(request_type=dict) + + +def test_create_key_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_key), + '__call__') as call: + client.create_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateKeyRequest() + + +@pytest.mark.asyncio +async def test_create_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.CreateKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + )) + response = await client.create_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +@pytest.mark.asyncio +async def test_create_key_async_from_dict(): + await test_create_key_async(request_type=dict) + + +def test_create_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.CreateKeyRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_key), + '__call__') as call: + call.return_value = recaptchaenterprise.Key() + client.create_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.CreateKeyRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + await client.create_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +def test_list_keys(transport: str = 'grpc', request_type=recaptchaenterprise.ListKeysRequest): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListKeysResponse( + next_page_token='next_page_token_value', + ) + response = client.list_keys(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListKeysRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListKeysPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_keys_from_dict(): + test_list_keys(request_type=dict) + + +def test_list_keys_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + client.list_keys() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListKeysRequest() + + +@pytest.mark.asyncio +async def test_list_keys_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.ListKeysRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_keys(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListKeysRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListKeysAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_keys_async_from_dict(): + await test_list_keys_async(request_type=dict) + + +def test_list_keys_field_headers(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.ListKeysRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + call.return_value = recaptchaenterprise.ListKeysResponse() + client.list_keys(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_keys_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.ListKeysRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse()) + await client.list_keys(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +def test_list_keys_pager(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListKeysResponse( + keys=[], + next_page_token='def', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_keys(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, recaptchaenterprise.Key) + for i in results) + +def test_list_keys_pages(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListKeysResponse( + keys=[], + next_page_token='def', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + ), + RuntimeError, + ) + pages = list(client.list_keys(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_keys_async_pager(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListKeysResponse( + keys=[], + next_page_token='def', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_keys(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, recaptchaenterprise.Key) + for i in responses) + +@pytest.mark.asyncio +async def test_list_keys_async_pages(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListKeysResponse( + keys=[], + next_page_token='def', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_keys(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_get_key(transport: str = 'grpc', request_type=recaptchaenterprise.GetKeyRequest): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), + ) + response = client.get_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.GetKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +def test_get_key_from_dict(): + test_get_key(request_type=dict) + + +def test_get_key_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_key), + '__call__') as call: + client.get_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.GetKeyRequest() + + +@pytest.mark.asyncio +async def test_get_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.GetKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + )) + response = await client.get_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.GetKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +@pytest.mark.asyncio +async def test_get_key_async_from_dict(): + await test_get_key_async(request_type=dict) + + +def test_get_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.GetKeyRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_key), + '__call__') as call: + call.return_value = recaptchaenterprise.Key() + client.get_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.GetKeyRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + await client.get_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +def test_update_key(transport: str = 'grpc', request_type=recaptchaenterprise.UpdateKeyRequest): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), + ) + response = client.update_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.UpdateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +def test_update_key_from_dict(): + test_update_key(request_type=dict) + + +def test_update_key_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_key), + '__call__') as call: + client.update_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.UpdateKeyRequest() + + +@pytest.mark.asyncio +async def test_update_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.UpdateKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + )) + response = await client.update_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.UpdateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +@pytest.mark.asyncio +async def test_update_key_async_from_dict(): + await test_update_key_async(request_type=dict) + + +def test_update_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.UpdateKeyRequest() + + request.key.name = 'key.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_key), + '__call__') as call: + call.return_value = recaptchaenterprise.Key() + client.update_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'key.name=key.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.UpdateKeyRequest() + + request.key.name = 'key.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + await client.update_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'key.name=key.name/value', + ) in kw['metadata'] + + +def test_delete_key(transport: str = 'grpc', request_type=recaptchaenterprise.DeleteKeyRequest): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.DeleteKeyRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_key_from_dict(): + test_delete_key(request_type=dict) + + +def test_delete_key_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_key), + '__call__') as call: + client.delete_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.DeleteKeyRequest() + + +@pytest.mark.asyncio +async def test_delete_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.DeleteKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.DeleteKeyRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_key_async_from_dict(): + await test_delete_key_async(request_type=dict) + + +def test_delete_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.DeleteKeyRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_key), + '__call__') as call: + call.return_value = None + client.delete_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recaptchaenterprise.DeleteKeyRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecaptchaEnterpriseServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecaptchaEnterpriseServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = RecaptchaEnterpriseServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.RecaptchaEnterpriseServiceGrpcTransport, + transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.RecaptchaEnterpriseServiceGrpcTransport, + ) + +def test_recaptcha_enterprise_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.RecaptchaEnterpriseServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_recaptcha_enterprise_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.RecaptchaEnterpriseServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_assessment', + 'annotate_assessment', + 'create_key', + 'list_keys', + 'get_key', + 'update_key', + 'delete_key', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + +@requires_google_auth_gte_1_25_0 +def test_recaptcha_enterprise_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecaptchaEnterpriseServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_recaptcha_enterprise_service_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecaptchaEnterpriseServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + quota_project_id="octopus", + ) + + +def test_recaptcha_enterprise_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecaptchaEnterpriseServiceTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_recaptcha_enterprise_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + RecaptchaEnterpriseServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_recaptcha_enterprise_service_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + RecaptchaEnterpriseServiceClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.RecaptchaEnterpriseServiceGrpcTransport, + transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_recaptcha_enterprise_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.RecaptchaEnterpriseServiceGrpcTransport, + transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_recaptcha_enterprise_service_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.RecaptchaEnterpriseServiceGrpcTransport, grpc_helpers), + (transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_recaptcha_enterprise_service_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "recaptchaenterprise.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="recaptchaenterprise.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) +def test_recaptcha_enterprise_service_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +def test_recaptcha_enterprise_service_host_no_port(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='recaptchaenterprise.googleapis.com'), + ) + assert client.transport._host == 'recaptchaenterprise.googleapis.com:443' + + +def test_recaptcha_enterprise_service_host_with_port(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='recaptchaenterprise.googleapis.com:8000'), + ) + assert client.transport._host == 'recaptchaenterprise.googleapis.com:8000' + +def test_recaptcha_enterprise_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_recaptcha_enterprise_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) +def test_recaptcha_enterprise_service_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) +def test_recaptcha_enterprise_service_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_assessment_path(): + project = "squid" + assessment = "clam" + expected = "projects/{project}/assessments/{assessment}".format(project=project, assessment=assessment, ) + actual = RecaptchaEnterpriseServiceClient.assessment_path(project, assessment) + assert expected == actual + + +def test_parse_assessment_path(): + expected = { + "project": "whelk", + "assessment": "octopus", + } + path = RecaptchaEnterpriseServiceClient.assessment_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_assessment_path(path) + assert expected == actual + +def test_key_path(): + project = "oyster" + key = "nudibranch" + expected = "projects/{project}/keys/{key}".format(project=project, key=key, ) + actual = RecaptchaEnterpriseServiceClient.key_path(project, key) + assert expected == actual + + +def test_parse_key_path(): + expected = { + "project": "cuttlefish", + "key": "mussel", + } + path = RecaptchaEnterpriseServiceClient.key_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_key_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "winkle" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = RecaptchaEnterpriseServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nautilus", + } + path = RecaptchaEnterpriseServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "scallop" + expected = "folders/{folder}".format(folder=folder, ) + actual = RecaptchaEnterpriseServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "abalone", + } + path = RecaptchaEnterpriseServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "squid" + expected = "organizations/{organization}".format(organization=organization, ) + actual = RecaptchaEnterpriseServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "clam", + } + path = RecaptchaEnterpriseServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "whelk" + expected = "projects/{project}".format(project=project, ) + actual = RecaptchaEnterpriseServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "octopus", + } + path = RecaptchaEnterpriseServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "oyster" + location = "nudibranch" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = RecaptchaEnterpriseServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "cuttlefish", + "location": "mussel", + } + path = RecaptchaEnterpriseServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.RecaptchaEnterpriseServiceTransport, '_prep_wrapped_messages') as prep: + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.RecaptchaEnterpriseServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = RecaptchaEnterpriseServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) From 7e157be9e1560dac23f59ff06196041a50e21d06 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 23 Jul 2021 21:02:21 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/master/packages/owl-bot/README.md --- .../recaptcha_enterprise_service/client.py | 4 + owl-bot-staging/v1/.coveragerc | 17 - owl-bot-staging/v1/MANIFEST.in | 2 - owl-bot-staging/v1/README.rst | 49 - owl-bot-staging/v1/docs/conf.py | 376 --- owl-bot-staging/v1/docs/index.rst | 7 - .../recaptcha_enterprise_service.rst | 10 - .../docs/recaptchaenterprise_v1/services.rst | 6 - .../v1/docs/recaptchaenterprise_v1/types.rst | 7 - .../cloud/recaptchaenterprise/__init__.py | 57 - .../google/cloud/recaptchaenterprise/py.typed | 2 - .../cloud/recaptchaenterprise_v1/__init__.py | 58 - .../gapic_metadata.json | 93 - .../cloud/recaptchaenterprise_v1/py.typed | 2 - .../services/__init__.py | 15 - .../recaptcha_enterprise_service/__init__.py | 22 - .../async_client.py | 614 ----- .../recaptcha_enterprise_service/client.py | 819 ------ .../recaptcha_enterprise_service/pagers.py | 140 - .../transports/__init__.py | 33 - .../transports/base.py | 253 -- .../transports/grpc.py | 413 --- .../transports/grpc_asyncio.py | 417 --- .../recaptchaenterprise_v1/types/__init__.py | 54 - .../types/recaptchaenterprise.py | 568 ---- owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 132 - .../fixup_recaptchaenterprise_v1_keywords.py | 182 -- owl-bot-staging/v1/setup.py | 54 - owl-bot-staging/v1/tests/__init__.py | 16 - owl-bot-staging/v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../gapic/recaptchaenterprise_v1/__init__.py | 16 - .../test_recaptcha_enterprise_service.py | 2381 ----------------- .../test_recaptcha_enterprise_service.py | 34 +- 35 files changed, 22 insertions(+), 6866 deletions(-) delete mode 100644 owl-bot-staging/v1/.coveragerc delete mode 100644 owl-bot-staging/v1/MANIFEST.in delete mode 100644 owl-bot-staging/v1/README.rst delete mode 100644 owl-bot-staging/v1/docs/conf.py delete mode 100644 owl-bot-staging/v1/docs/index.rst delete mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst delete mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py delete mode 100644 owl-bot-staging/v1/mypy.ini delete mode 100644 owl-bot-staging/v1/noxfile.py delete mode 100644 owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py delete mode 100644 owl-bot-staging/v1/setup.py delete mode 100644 owl-bot-staging/v1/tests/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py diff --git a/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py b/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py index a7e1031..946f2c3 100644 --- a/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py +++ b/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py @@ -359,6 +359,10 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, + always_use_jwt_access=( + Transport == type(self).get_transport_class("grpc") + or Transport == type(self).get_transport_class("grpc_asyncio") + ), ) def create_assessment( diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc deleted file mode 100644 index f984736..0000000 --- a/owl-bot-staging/v1/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/recaptchaenterprise/__init__.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ - # Ignore pkg_resources exceptions. - # This is added at the module level as a safeguard for if someone - # generates the code and tries to run it without pip installing. This - # makes it virtually impossible to test properly. - except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in deleted file mode 100644 index 2ebaff4..0000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/recaptchaenterprise *.py -recursive-include google/cloud/recaptchaenterprise_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index dd39e48..0000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Recaptchaenterprise API -================================================= - -Quick Start ------------ - -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 Google Cloud Recaptchaenterprise API. -4. `Setup 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 -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py deleted file mode 100644 index 122a4d2..0000000 --- a/owl-bot-staging/v1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- 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. -# -# -# google-cloud-recaptchaenterprise documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "1.6.3" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = "index" - -# General information about the project. -project = u"google-cloud-recaptchaenterprise" -copyright = u"2020, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Cloud Client Libraries for Python", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-cloud-recaptchaenterprise-doc" - -# -- Options for warnings ------------------------------------------------------ - - -suppress_warnings = [ - # Temporarily suppress this to avoid "more than one target found for - # cross-reference" warning, which are intractable for us to avoid while in - # a mono-repo. - # See https://github.com/sphinx-doc/sphinx/blob - # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 - "ref.python" -] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - master_doc, - "google-cloud-recaptchaenterprise.tex", - u"google-cloud-recaptchaenterprise Documentation", - author, - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ( - master_doc, - "google-cloud-recaptchaenterprise", - u"Google Cloud Recaptchaenterprise Documentation", - [author], - 1, - ) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "google-cloud-recaptchaenterprise", - u"google-cloud-recaptchaenterprise Documentation", - author, - "google-cloud-recaptchaenterprise", - "GAPIC library for Google Cloud Recaptchaenterprise API", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "python": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst deleted file mode 100644 index 35c60ea..0000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - recaptchaenterprise_v1/services - recaptchaenterprise_v1/types diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst deleted file mode 100644 index 5031186..0000000 --- a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst +++ /dev/null @@ -1,10 +0,0 @@ -RecaptchaEnterpriseService --------------------------------------------- - -.. automodule:: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service - :members: - :inherited-members: - -.. automodule:: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst deleted file mode 100644 index 4211502..0000000 --- a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Recaptchaenterprise v1 API -==================================================== -.. toctree:: - :maxdepth: 2 - - recaptcha_enterprise_service diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst deleted file mode 100644 index a3967e8..0000000 --- a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Recaptchaenterprise v1 API -================================================= - -.. automodule:: google.cloud.recaptchaenterprise_v1.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py deleted file mode 100644 index cad6ead..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py +++ /dev/null @@ -1,57 +0,0 @@ -# -*- 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. -# - -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.client import RecaptchaEnterpriseServiceClient -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.async_client import RecaptchaEnterpriseServiceAsyncClient - -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AndroidKeySettings -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AnnotateAssessmentRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AnnotateAssessmentResponse -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Assessment -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import CreateAssessmentRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import CreateKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import DeleteKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Event -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import GetKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import IOSKeySettings -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Key -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListKeysRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListKeysResponse -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RiskAnalysis -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TokenProperties -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import UpdateKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import WebKeySettings - -__all__ = ('RecaptchaEnterpriseServiceClient', - 'RecaptchaEnterpriseServiceAsyncClient', - 'AndroidKeySettings', - 'AnnotateAssessmentRequest', - 'AnnotateAssessmentResponse', - 'Assessment', - 'CreateAssessmentRequest', - 'CreateKeyRequest', - 'DeleteKeyRequest', - 'Event', - 'GetKeyRequest', - 'IOSKeySettings', - 'Key', - 'ListKeysRequest', - 'ListKeysResponse', - 'RiskAnalysis', - 'TokenProperties', - 'UpdateKeyRequest', - 'WebKeySettings', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed deleted file mode 100644 index 2d367bf..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-recaptchaenterprise package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py deleted file mode 100644 index 95f9284..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py +++ /dev/null @@ -1,58 +0,0 @@ -# -*- 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. -# - -from .services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceClient -from .services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceAsyncClient - -from .types.recaptchaenterprise import AndroidKeySettings -from .types.recaptchaenterprise import AnnotateAssessmentRequest -from .types.recaptchaenterprise import AnnotateAssessmentResponse -from .types.recaptchaenterprise import Assessment -from .types.recaptchaenterprise import CreateAssessmentRequest -from .types.recaptchaenterprise import CreateKeyRequest -from .types.recaptchaenterprise import DeleteKeyRequest -from .types.recaptchaenterprise import Event -from .types.recaptchaenterprise import GetKeyRequest -from .types.recaptchaenterprise import IOSKeySettings -from .types.recaptchaenterprise import Key -from .types.recaptchaenterprise import ListKeysRequest -from .types.recaptchaenterprise import ListKeysResponse -from .types.recaptchaenterprise import RiskAnalysis -from .types.recaptchaenterprise import TokenProperties -from .types.recaptchaenterprise import UpdateKeyRequest -from .types.recaptchaenterprise import WebKeySettings - -__all__ = ( - 'RecaptchaEnterpriseServiceAsyncClient', -'AndroidKeySettings', -'AnnotateAssessmentRequest', -'AnnotateAssessmentResponse', -'Assessment', -'CreateAssessmentRequest', -'CreateKeyRequest', -'DeleteKeyRequest', -'Event', -'GetKeyRequest', -'IOSKeySettings', -'Key', -'ListKeysRequest', -'ListKeysResponse', -'RecaptchaEnterpriseServiceClient', -'RiskAnalysis', -'TokenProperties', -'UpdateKeyRequest', -'WebKeySettings', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json deleted file mode 100644 index 49c568a..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json +++ /dev/null @@ -1,93 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.recaptchaenterprise_v1", - "protoPackage": "google.cloud.recaptchaenterprise.v1", - "schema": "1.0", - "services": { - "RecaptchaEnterpriseService": { - "clients": { - "grpc": { - "libraryClient": "RecaptchaEnterpriseServiceClient", - "rpcs": { - "AnnotateAssessment": { - "methods": [ - "annotate_assessment" - ] - }, - "CreateAssessment": { - "methods": [ - "create_assessment" - ] - }, - "CreateKey": { - "methods": [ - "create_key" - ] - }, - "DeleteKey": { - "methods": [ - "delete_key" - ] - }, - "GetKey": { - "methods": [ - "get_key" - ] - }, - "ListKeys": { - "methods": [ - "list_keys" - ] - }, - "UpdateKey": { - "methods": [ - "update_key" - ] - } - } - }, - "grpc-async": { - "libraryClient": "RecaptchaEnterpriseServiceAsyncClient", - "rpcs": { - "AnnotateAssessment": { - "methods": [ - "annotate_assessment" - ] - }, - "CreateAssessment": { - "methods": [ - "create_assessment" - ] - }, - "CreateKey": { - "methods": [ - "create_key" - ] - }, - "DeleteKey": { - "methods": [ - "delete_key" - ] - }, - "GetKey": { - "methods": [ - "get_key" - ] - }, - "ListKeys": { - "methods": [ - "list_keys" - ] - }, - "UpdateKey": { - "methods": [ - "update_key" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed deleted file mode 100644 index 2d367bf..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-recaptchaenterprise package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py deleted file mode 100644 index 4de6597..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- 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. -# diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py deleted file mode 100644 index 9396f24..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- 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. -# -from .client import RecaptchaEnterpriseServiceClient -from .async_client import RecaptchaEnterpriseServiceAsyncClient - -__all__ = ( - 'RecaptchaEnterpriseServiceClient', - 'RecaptchaEnterpriseServiceAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py deleted file mode 100644 index c79c583..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py +++ /dev/null @@ -1,614 +0,0 @@ -# -*- 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. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Sequence, Tuple, Type, Union -import pkg_resources - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions as core_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 as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport -from .client import RecaptchaEnterpriseServiceClient - - -class RecaptchaEnterpriseServiceAsyncClient: - """Service to determine the likelihood an event is legitimate.""" - - _client: RecaptchaEnterpriseServiceClient - - DEFAULT_ENDPOINT = RecaptchaEnterpriseServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = RecaptchaEnterpriseServiceClient.DEFAULT_MTLS_ENDPOINT - - assessment_path = staticmethod(RecaptchaEnterpriseServiceClient.assessment_path) - parse_assessment_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_assessment_path) - key_path = staticmethod(RecaptchaEnterpriseServiceClient.key_path) - parse_key_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_key_path) - common_billing_account_path = staticmethod(RecaptchaEnterpriseServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(RecaptchaEnterpriseServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(RecaptchaEnterpriseServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_organization_path) - common_project_path = staticmethod(RecaptchaEnterpriseServiceClient.common_project_path) - parse_common_project_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_project_path) - common_location_path = staticmethod(RecaptchaEnterpriseServiceClient.common_location_path) - parse_common_location_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_location_path) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - RecaptchaEnterpriseServiceAsyncClient: The constructed client. - """ - return RecaptchaEnterpriseServiceClient.from_service_account_info.__func__(RecaptchaEnterpriseServiceAsyncClient, info, *args, **kwargs) # type: ignore - - @classmethod - def from_service_account_file(cls, filename: str, *args, **kwargs): - """Creates an instance of this client using the provided credentials - file. - - Args: - filename (str): The path to the service account private key json - file. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - RecaptchaEnterpriseServiceAsyncClient: The constructed client. - """ - return RecaptchaEnterpriseServiceClient.from_service_account_file.__func__(RecaptchaEnterpriseServiceAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> RecaptchaEnterpriseServiceTransport: - """Returns the transport used by the client instance. - - Returns: - RecaptchaEnterpriseServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(RecaptchaEnterpriseServiceClient).get_transport_class, type(RecaptchaEnterpriseServiceClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, RecaptchaEnterpriseServiceTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the recaptcha enterprise service client. - - Args: - 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. - transport (Union[str, ~.RecaptchaEnterpriseServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (ClientOptions): Custom options for the client. It - won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client = RecaptchaEnterpriseServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def create_assessment(self, - request: recaptchaenterprise.CreateAssessmentRequest = None, - *, - parent: str = None, - assessment: recaptchaenterprise.Assessment = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Assessment: - r"""Creates an Assessment of the likelihood an event is - legitimate. - - Args: - request (:class:`google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest`): - The request object. The create assessment request - message. - parent (:class:`str`): - Required. The name of the project in - which the assessment will be created, in - the format "projects/{project}". - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - assessment (:class:`google.cloud.recaptchaenterprise_v1.types.Assessment`): - Required. The assessment details. - This corresponds to the ``assessment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.Assessment: - A recaptcha assessment resource. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, assessment]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = recaptchaenterprise.CreateAssessmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if assessment is not None: - request.assessment = assessment - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.create_assessment, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def annotate_assessment(self, - request: recaptchaenterprise.AnnotateAssessmentRequest = None, - *, - name: str = None, - annotation: recaptchaenterprise.AnnotateAssessmentRequest.Annotation = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.AnnotateAssessmentResponse: - r"""Annotates a previously created Assessment to provide - additional information on whether the event turned out - to be authentic or fradulent. - - Args: - request (:class:`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest`): - The request object. The request message to annotate an - Assessment. - name (:class:`str`): - Required. The resource name of the - Assessment, in the format - "projects/{project}/assessments/{assessment}". - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - annotation (:class:`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation`): - Required. The annotation that will be - assigned to the Event. - - This corresponds to the ``annotation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse: - Empty response for - AnnotateAssessment. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name, annotation]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = recaptchaenterprise.AnnotateAssessmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if annotation is not None: - request.annotation = annotation - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.annotate_assessment, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_key(self, - request: recaptchaenterprise.CreateKeyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Creates a new reCAPTCHA Enterprise key. - - Args: - request (:class:`google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest`): - The request object. The create key request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # Create or coerce a protobuf request object. - request = recaptchaenterprise.CreateKeyRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.create_key, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_keys(self, - request: recaptchaenterprise.ListKeysRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListKeysAsyncPager: - r"""Returns the list of all keys that belong to a - project. - - Args: - request (:class:`google.cloud.recaptchaenterprise_v1.types.ListKeysRequest`): - The request object. The list keys request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager: - Response to request to list keys in a - project. - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - request = recaptchaenterprise.ListKeysRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_keys, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListKeysAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_key(self, - request: recaptchaenterprise.GetKeyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Returns the specified key. - - Args: - request (:class:`google.cloud.recaptchaenterprise_v1.types.GetKeyRequest`): - The request object. The get key request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # Create or coerce a protobuf request object. - request = recaptchaenterprise.GetKeyRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_key, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_key(self, - request: recaptchaenterprise.UpdateKeyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Updates the specified key. - - Args: - request (:class:`google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest`): - The request object. The update key request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # Create or coerce a protobuf request object. - request = recaptchaenterprise.UpdateKeyRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.update_key, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("key.name", request.key.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_key(self, - request: recaptchaenterprise.DeleteKeyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the specified key. - - Args: - request (:class:`google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest`): - The request object. The delete key request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - # Create or coerce a protobuf request object. - request = recaptchaenterprise.DeleteKeyRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.delete_key, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-recaptchaenterprise", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "RecaptchaEnterpriseServiceAsyncClient", -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py deleted file mode 100644 index 20b6027..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py +++ /dev/null @@ -1,819 +0,0 @@ -# -*- 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. -# -from collections import OrderedDict -from distutils import util -import os -import re -from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib # type: ignore -from google.api_core import exceptions as core_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 as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import RecaptchaEnterpriseServiceGrpcTransport -from .transports.grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport - - -class RecaptchaEnterpriseServiceClientMeta(type): - """Metaclass for the RecaptchaEnterpriseService client. - - This provides class-level methods for building and retrieving - support objects (e.g. transport) without polluting the client instance - objects. - """ - _transport_registry = OrderedDict() # type: Dict[str, Type[RecaptchaEnterpriseServiceTransport]] - _transport_registry["grpc"] = RecaptchaEnterpriseServiceGrpcTransport - _transport_registry["grpc_asyncio"] = RecaptchaEnterpriseServiceGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[RecaptchaEnterpriseServiceTransport]: - """Returns an appropriate transport class. - - Args: - label: The name of the desired transport. If none is - provided, then the first transport in the registry is used. - - Returns: - The transport class to use. - """ - # If a specific transport is requested, return that one. - if label: - return cls._transport_registry[label] - - # No transport is requested; return the default (that is, the first one - # in the dictionary). - return next(iter(cls._transport_registry.values())) - - -class RecaptchaEnterpriseServiceClient(metaclass=RecaptchaEnterpriseServiceClientMeta): - """Service to determine the likelihood an event is legitimate.""" - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "recaptchaenterprise.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - RecaptchaEnterpriseServiceClient: The constructed client. - """ - credentials = service_account.Credentials.from_service_account_info(info) - kwargs["credentials"] = credentials - return cls(*args, **kwargs) - - @classmethod - def from_service_account_file(cls, filename: str, *args, **kwargs): - """Creates an instance of this client using the provided credentials - file. - - Args: - filename (str): The path to the service account private key json - file. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - RecaptchaEnterpriseServiceClient: The constructed client. - """ - credentials = service_account.Credentials.from_service_account_file( - filename) - kwargs["credentials"] = credentials - return cls(*args, **kwargs) - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> RecaptchaEnterpriseServiceTransport: - """Returns the transport used by the client instance. - - Returns: - RecaptchaEnterpriseServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def assessment_path(project: str,assessment: str,) -> str: - """Returns a fully-qualified assessment string.""" - return "projects/{project}/assessments/{assessment}".format(project=project, assessment=assessment, ) - - @staticmethod - def parse_assessment_path(path: str) -> Dict[str,str]: - """Parses a assessment path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/assessments/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def key_path(project: str,key: str,) -> str: - """Returns a fully-qualified key string.""" - return "projects/{project}/keys/{key}".format(project=project, key=key, ) - - @staticmethod - def parse_key_path(path: str) -> Dict[str,str]: - """Parses a key path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/keys/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, RecaptchaEnterpriseServiceTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the recaptcha enterprise service client. - - Args: - 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. - transport (Union[str, RecaptchaEnterpriseServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - 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. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - - # Create SSL credentials for mutual TLS if needed. - use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) - - client_cert_source_func = None - is_mtls = False - if use_client_cert: - if client_options.client_cert_source: - is_mtls = True - client_cert_source_func = client_options.client_cert_source - else: - is_mtls = mtls.has_default_client_cert_source() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = None - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - else: - use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_mtls_env == "never": - api_endpoint = self.DEFAULT_ENDPOINT - elif use_mtls_env == "always": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - elif use_mtls_env == "auto": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = self.DEFAULT_ENDPOINT - else: - raise MutualTLSChannelError( - "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " - "values: never, auto, always" - ) - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, RecaptchaEnterpriseServiceTransport): - # transport is a RecaptchaEnterpriseServiceTransport instance. - if credentials or client_options.credentials_file: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), - ) - - def create_assessment(self, - request: recaptchaenterprise.CreateAssessmentRequest = None, - *, - parent: str = None, - assessment: recaptchaenterprise.Assessment = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Assessment: - r"""Creates an Assessment of the likelihood an event is - legitimate. - - Args: - request (google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest): - The request object. The create assessment request - message. - parent (str): - Required. The name of the project in - which the assessment will be created, in - the format "projects/{project}". - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - assessment (google.cloud.recaptchaenterprise_v1.types.Assessment): - Required. The assessment details. - This corresponds to the ``assessment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.Assessment: - A recaptcha assessment resource. - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, assessment]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a recaptchaenterprise.CreateAssessmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.CreateAssessmentRequest): - request = recaptchaenterprise.CreateAssessmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if assessment is not None: - request.assessment = assessment - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_assessment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def annotate_assessment(self, - request: recaptchaenterprise.AnnotateAssessmentRequest = None, - *, - name: str = None, - annotation: recaptchaenterprise.AnnotateAssessmentRequest.Annotation = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.AnnotateAssessmentResponse: - r"""Annotates a previously created Assessment to provide - additional information on whether the event turned out - to be authentic or fradulent. - - Args: - request (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest): - The request object. The request message to annotate an - Assessment. - name (str): - Required. The resource name of the - Assessment, in the format - "projects/{project}/assessments/{assessment}". - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation): - Required. The annotation that will be - assigned to the Event. - - This corresponds to the ``annotation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse: - Empty response for - AnnotateAssessment. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name, annotation]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a recaptchaenterprise.AnnotateAssessmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.AnnotateAssessmentRequest): - request = recaptchaenterprise.AnnotateAssessmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if annotation is not None: - request.annotation = annotation - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.annotate_assessment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_key(self, - request: recaptchaenterprise.CreateKeyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Creates a new reCAPTCHA Enterprise key. - - Args: - request (google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest): - The request object. The create key request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a recaptchaenterprise.CreateKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.CreateKeyRequest): - request = recaptchaenterprise.CreateKeyRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_keys(self, - request: recaptchaenterprise.ListKeysRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListKeysPager: - r"""Returns the list of all keys that belong to a - project. - - Args: - request (google.cloud.recaptchaenterprise_v1.types.ListKeysRequest): - The request object. The list keys request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager: - Response to request to list keys in a - project. - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a recaptchaenterprise.ListKeysRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.ListKeysRequest): - request = recaptchaenterprise.ListKeysRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_keys] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__iter__` convenience method. - response = pagers.ListKeysPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_key(self, - request: recaptchaenterprise.GetKeyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Returns the specified key. - - Args: - request (google.cloud.recaptchaenterprise_v1.types.GetKeyRequest): - The request object. The get key request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a recaptchaenterprise.GetKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.GetKeyRequest): - request = recaptchaenterprise.GetKeyRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_key(self, - request: recaptchaenterprise.UpdateKeyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Updates the specified key. - - Args: - request (google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest): - The request object. The update key request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a recaptchaenterprise.UpdateKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.UpdateKeyRequest): - request = recaptchaenterprise.UpdateKeyRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("key.name", request.key.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_key(self, - request: recaptchaenterprise.DeleteKeyRequest = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the specified key. - - Args: - request (google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest): - The request object. The delete key request message. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a recaptchaenterprise.DeleteKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.DeleteKeyRequest): - request = recaptchaenterprise.DeleteKeyRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.delete_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-recaptchaenterprise", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "RecaptchaEnterpriseServiceClient", -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py deleted file mode 100644 index 59cad30..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py +++ /dev/null @@ -1,140 +0,0 @@ -# -*- 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. -# -from typing import Any, AsyncIterable, Awaitable, Callable, Iterable, Sequence, Tuple, Optional - -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise - - -class ListKeysPager: - """A pager for iterating through ``list_keys`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` object, and - provides an ``__iter__`` method to iterate through its - ``keys`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListKeys`` requests and continue to iterate - through the ``keys`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., recaptchaenterprise.ListKeysResponse], - request: recaptchaenterprise.ListKeysRequest, - response: recaptchaenterprise.ListKeysResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.recaptchaenterprise_v1.types.ListKeysRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = recaptchaenterprise.ListKeysRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[recaptchaenterprise.ListKeysResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterable[recaptchaenterprise.Key]: - for page in self.pages: - yield from page.keys - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListKeysAsyncPager: - """A pager for iterating through ``list_keys`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``keys`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListKeys`` requests and continue to iterate - through the ``keys`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., Awaitable[recaptchaenterprise.ListKeysResponse]], - request: recaptchaenterprise.ListKeysRequest, - response: recaptchaenterprise.ListKeysResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.recaptchaenterprise_v1.types.ListKeysRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = recaptchaenterprise.ListKeysRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[recaptchaenterprise.ListKeysResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - - def __aiter__(self) -> AsyncIterable[recaptchaenterprise.Key]: - async def async_generator(): - async for page in self.pages: - for response in page.keys: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py deleted file mode 100644 index 4370808..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- 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. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import RecaptchaEnterpriseServiceTransport -from .grpc import RecaptchaEnterpriseServiceGrpcTransport -from .grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[RecaptchaEnterpriseServiceTransport]] -_transport_registry['grpc'] = RecaptchaEnterpriseServiceGrpcTransport -_transport_registry['grpc_asyncio'] = RecaptchaEnterpriseServiceGrpcAsyncIOTransport - -__all__ = ( - 'RecaptchaEnterpriseServiceTransport', - 'RecaptchaEnterpriseServiceGrpcTransport', - 'RecaptchaEnterpriseServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py deleted file mode 100644 index 563f205..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py +++ /dev/null @@ -1,253 +0,0 @@ -# -*- 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 -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union -import packaging.version -import pkg_resources - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_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 as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import empty_pb2 # type: ignore - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-recaptchaenterprise', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - -try: - # google.auth.__version__ was added in 1.26.0 - _GOOGLE_AUTH_VERSION = google.auth.__version__ -except AttributeError: - try: # try pkg_resources if it is available - _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version - except pkg_resources.DistributionNotFound: # pragma: NO COVER - _GOOGLE_AUTH_VERSION = None - - -class RecaptchaEnterpriseServiceTransport(abc.ABC): - """Abstract transport class for RecaptchaEnterpriseService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'recaptchaenterprise.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - **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. - scopes (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. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - - # If the credentials is service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is increased. - - # TODO: Remove this function once google-auth >= 1.25.0 is required - @classmethod - def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: - """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" - - scopes_kwargs = {} - - if _GOOGLE_AUTH_VERSION and ( - packaging.version.parse(_GOOGLE_AUTH_VERSION) - >= packaging.version.parse("1.25.0") - ): - scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} - else: - scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} - - return scopes_kwargs - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.create_assessment: gapic_v1.method.wrap_method( - self.create_assessment, - default_timeout=600.0, - client_info=client_info, - ), - self.annotate_assessment: gapic_v1.method.wrap_method( - self.annotate_assessment, - default_timeout=600.0, - client_info=client_info, - ), - self.create_key: gapic_v1.method.wrap_method( - self.create_key, - default_timeout=600.0, - client_info=client_info, - ), - self.list_keys: gapic_v1.method.wrap_method( - self.list_keys, - default_timeout=600.0, - client_info=client_info, - ), - self.get_key: gapic_v1.method.wrap_method( - self.get_key, - default_timeout=600.0, - client_info=client_info, - ), - self.update_key: gapic_v1.method.wrap_method( - self.update_key, - default_timeout=600.0, - client_info=client_info, - ), - self.delete_key: gapic_v1.method.wrap_method( - self.delete_key, - default_timeout=600.0, - client_info=client_info, - ), - } - - @property - def create_assessment(self) -> Callable[ - [recaptchaenterprise.CreateAssessmentRequest], - Union[ - recaptchaenterprise.Assessment, - Awaitable[recaptchaenterprise.Assessment] - ]]: - raise NotImplementedError() - - @property - def annotate_assessment(self) -> Callable[ - [recaptchaenterprise.AnnotateAssessmentRequest], - Union[ - recaptchaenterprise.AnnotateAssessmentResponse, - Awaitable[recaptchaenterprise.AnnotateAssessmentResponse] - ]]: - raise NotImplementedError() - - @property - def create_key(self) -> Callable[ - [recaptchaenterprise.CreateKeyRequest], - Union[ - recaptchaenterprise.Key, - Awaitable[recaptchaenterprise.Key] - ]]: - raise NotImplementedError() - - @property - def list_keys(self) -> Callable[ - [recaptchaenterprise.ListKeysRequest], - Union[ - recaptchaenterprise.ListKeysResponse, - Awaitable[recaptchaenterprise.ListKeysResponse] - ]]: - raise NotImplementedError() - - @property - def get_key(self) -> Callable[ - [recaptchaenterprise.GetKeyRequest], - Union[ - recaptchaenterprise.Key, - Awaitable[recaptchaenterprise.Key] - ]]: - raise NotImplementedError() - - @property - def update_key(self) -> Callable[ - [recaptchaenterprise.UpdateKeyRequest], - Union[ - recaptchaenterprise.Key, - Awaitable[recaptchaenterprise.Key] - ]]: - raise NotImplementedError() - - @property - def delete_key(self) -> Callable[ - [recaptchaenterprise.DeleteKeyRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'RecaptchaEnterpriseServiceTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py deleted file mode 100644 index da58ca9..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py +++ /dev/null @@ -1,413 +0,0 @@ -# -*- 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 warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers # type: ignore -from google.api_core import gapic_v1 # type: ignore -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import empty_pb2 # type: ignore -from .base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO - - -class RecaptchaEnterpriseServiceGrpcTransport(RecaptchaEnterpriseServiceTransport): - """gRPC backend transport for RecaptchaEnterpriseService. - - Service to determine the likelihood an event is legitimate. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - _stubs: Dict[str, Callable] - - def __init__(self, *, - host: str = 'recaptchaenterprise.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> 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. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - 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. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'recaptchaenterprise.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this 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. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def create_assessment(self) -> Callable[ - [recaptchaenterprise.CreateAssessmentRequest], - recaptchaenterprise.Assessment]: - r"""Return a callable for the create assessment method over gRPC. - - Creates an Assessment of the likelihood an event is - legitimate. - - Returns: - Callable[[~.CreateAssessmentRequest], - ~.Assessment]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_assessment' not in self._stubs: - self._stubs['create_assessment'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateAssessment', - request_serializer=recaptchaenterprise.CreateAssessmentRequest.serialize, - response_deserializer=recaptchaenterprise.Assessment.deserialize, - ) - return self._stubs['create_assessment'] - - @property - def annotate_assessment(self) -> Callable[ - [recaptchaenterprise.AnnotateAssessmentRequest], - recaptchaenterprise.AnnotateAssessmentResponse]: - r"""Return a callable for the annotate assessment method over gRPC. - - Annotates a previously created Assessment to provide - additional information on whether the event turned out - to be authentic or fradulent. - - Returns: - Callable[[~.AnnotateAssessmentRequest], - ~.AnnotateAssessmentResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'annotate_assessment' not in self._stubs: - self._stubs['annotate_assessment'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/AnnotateAssessment', - request_serializer=recaptchaenterprise.AnnotateAssessmentRequest.serialize, - response_deserializer=recaptchaenterprise.AnnotateAssessmentResponse.deserialize, - ) - return self._stubs['annotate_assessment'] - - @property - def create_key(self) -> Callable[ - [recaptchaenterprise.CreateKeyRequest], - recaptchaenterprise.Key]: - r"""Return a callable for the create key method over gRPC. - - Creates a new reCAPTCHA Enterprise key. - - Returns: - Callable[[~.CreateKeyRequest], - ~.Key]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_key' not in self._stubs: - self._stubs['create_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateKey', - request_serializer=recaptchaenterprise.CreateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['create_key'] - - @property - def list_keys(self) -> Callable[ - [recaptchaenterprise.ListKeysRequest], - recaptchaenterprise.ListKeysResponse]: - r"""Return a callable for the list keys method over gRPC. - - Returns the list of all keys that belong to a - project. - - Returns: - Callable[[~.ListKeysRequest], - ~.ListKeysResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_keys' not in self._stubs: - self._stubs['list_keys'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListKeys', - request_serializer=recaptchaenterprise.ListKeysRequest.serialize, - response_deserializer=recaptchaenterprise.ListKeysResponse.deserialize, - ) - return self._stubs['list_keys'] - - @property - def get_key(self) -> Callable[ - [recaptchaenterprise.GetKeyRequest], - recaptchaenterprise.Key]: - r"""Return a callable for the get key method over gRPC. - - Returns the specified key. - - Returns: - Callable[[~.GetKeyRequest], - ~.Key]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_key' not in self._stubs: - self._stubs['get_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetKey', - request_serializer=recaptchaenterprise.GetKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['get_key'] - - @property - def update_key(self) -> Callable[ - [recaptchaenterprise.UpdateKeyRequest], - recaptchaenterprise.Key]: - r"""Return a callable for the update key method over gRPC. - - Updates the specified key. - - Returns: - Callable[[~.UpdateKeyRequest], - ~.Key]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_key' not in self._stubs: - self._stubs['update_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/UpdateKey', - request_serializer=recaptchaenterprise.UpdateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['update_key'] - - @property - def delete_key(self) -> Callable[ - [recaptchaenterprise.DeleteKeyRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete key method over gRPC. - - Deletes the specified key. - - Returns: - Callable[[~.DeleteKeyRequest], - ~.Empty]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_key' not in self._stubs: - self._stubs['delete_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/DeleteKey', - request_serializer=recaptchaenterprise.DeleteKeyRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_key'] - - -__all__ = ( - 'RecaptchaEnterpriseServiceGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py deleted file mode 100644 index 1ce2152..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,417 +0,0 @@ -# -*- 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 warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 # type: ignore -from google.api_core import grpc_helpers_async # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -import packaging.version - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import empty_pb2 # type: ignore -from .base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import RecaptchaEnterpriseServiceGrpcTransport - - -class RecaptchaEnterpriseServiceGrpcAsyncIOTransport(RecaptchaEnterpriseServiceTransport): - """gRPC AsyncIO backend transport for RecaptchaEnterpriseService. - - Service to determine the likelihood an event is legitimate. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - - _grpc_channel: aio.Channel - _stubs: Dict[str, Callable] = {} - - @classmethod - def create_channel(cls, - host: str = 'recaptchaenterprise.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this 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 ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'recaptchaenterprise.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> 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. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - 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. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def create_assessment(self) -> Callable[ - [recaptchaenterprise.CreateAssessmentRequest], - Awaitable[recaptchaenterprise.Assessment]]: - r"""Return a callable for the create assessment method over gRPC. - - Creates an Assessment of the likelihood an event is - legitimate. - - Returns: - Callable[[~.CreateAssessmentRequest], - Awaitable[~.Assessment]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_assessment' not in self._stubs: - self._stubs['create_assessment'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateAssessment', - request_serializer=recaptchaenterprise.CreateAssessmentRequest.serialize, - response_deserializer=recaptchaenterprise.Assessment.deserialize, - ) - return self._stubs['create_assessment'] - - @property - def annotate_assessment(self) -> Callable[ - [recaptchaenterprise.AnnotateAssessmentRequest], - Awaitable[recaptchaenterprise.AnnotateAssessmentResponse]]: - r"""Return a callable for the annotate assessment method over gRPC. - - Annotates a previously created Assessment to provide - additional information on whether the event turned out - to be authentic or fradulent. - - Returns: - Callable[[~.AnnotateAssessmentRequest], - Awaitable[~.AnnotateAssessmentResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'annotate_assessment' not in self._stubs: - self._stubs['annotate_assessment'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/AnnotateAssessment', - request_serializer=recaptchaenterprise.AnnotateAssessmentRequest.serialize, - response_deserializer=recaptchaenterprise.AnnotateAssessmentResponse.deserialize, - ) - return self._stubs['annotate_assessment'] - - @property - def create_key(self) -> Callable[ - [recaptchaenterprise.CreateKeyRequest], - Awaitable[recaptchaenterprise.Key]]: - r"""Return a callable for the create key method over gRPC. - - Creates a new reCAPTCHA Enterprise key. - - Returns: - Callable[[~.CreateKeyRequest], - Awaitable[~.Key]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_key' not in self._stubs: - self._stubs['create_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateKey', - request_serializer=recaptchaenterprise.CreateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['create_key'] - - @property - def list_keys(self) -> Callable[ - [recaptchaenterprise.ListKeysRequest], - Awaitable[recaptchaenterprise.ListKeysResponse]]: - r"""Return a callable for the list keys method over gRPC. - - Returns the list of all keys that belong to a - project. - - Returns: - Callable[[~.ListKeysRequest], - Awaitable[~.ListKeysResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_keys' not in self._stubs: - self._stubs['list_keys'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListKeys', - request_serializer=recaptchaenterprise.ListKeysRequest.serialize, - response_deserializer=recaptchaenterprise.ListKeysResponse.deserialize, - ) - return self._stubs['list_keys'] - - @property - def get_key(self) -> Callable[ - [recaptchaenterprise.GetKeyRequest], - Awaitable[recaptchaenterprise.Key]]: - r"""Return a callable for the get key method over gRPC. - - Returns the specified key. - - Returns: - Callable[[~.GetKeyRequest], - Awaitable[~.Key]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_key' not in self._stubs: - self._stubs['get_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetKey', - request_serializer=recaptchaenterprise.GetKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['get_key'] - - @property - def update_key(self) -> Callable[ - [recaptchaenterprise.UpdateKeyRequest], - Awaitable[recaptchaenterprise.Key]]: - r"""Return a callable for the update key method over gRPC. - - Updates the specified key. - - Returns: - Callable[[~.UpdateKeyRequest], - Awaitable[~.Key]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_key' not in self._stubs: - self._stubs['update_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/UpdateKey', - request_serializer=recaptchaenterprise.UpdateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['update_key'] - - @property - def delete_key(self) -> Callable[ - [recaptchaenterprise.DeleteKeyRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete key method over gRPC. - - Deletes the specified key. - - Returns: - Callable[[~.DeleteKeyRequest], - Awaitable[~.Empty]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_key' not in self._stubs: - self._stubs['delete_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/DeleteKey', - request_serializer=recaptchaenterprise.DeleteKeyRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_key'] - - -__all__ = ( - 'RecaptchaEnterpriseServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py deleted file mode 100644 index 1e9aa69..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- 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. -# -from .recaptchaenterprise import ( - AndroidKeySettings, - AnnotateAssessmentRequest, - AnnotateAssessmentResponse, - Assessment, - CreateAssessmentRequest, - CreateKeyRequest, - DeleteKeyRequest, - Event, - GetKeyRequest, - IOSKeySettings, - Key, - ListKeysRequest, - ListKeysResponse, - RiskAnalysis, - TokenProperties, - UpdateKeyRequest, - WebKeySettings, -) - -__all__ = ( - 'AndroidKeySettings', - 'AnnotateAssessmentRequest', - 'AnnotateAssessmentResponse', - 'Assessment', - 'CreateAssessmentRequest', - 'CreateKeyRequest', - 'DeleteKeyRequest', - 'Event', - 'GetKeyRequest', - 'IOSKeySettings', - 'Key', - 'ListKeysRequest', - 'ListKeysResponse', - 'RiskAnalysis', - 'TokenProperties', - 'UpdateKeyRequest', - 'WebKeySettings', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py deleted file mode 100644 index e5f917f..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py +++ /dev/null @@ -1,568 +0,0 @@ -# -*- 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 proto # type: ignore - -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.recaptchaenterprise.v1', - manifest={ - 'CreateAssessmentRequest', - 'AnnotateAssessmentRequest', - 'AnnotateAssessmentResponse', - 'Assessment', - 'Event', - 'RiskAnalysis', - 'TokenProperties', - 'CreateKeyRequest', - 'ListKeysRequest', - 'ListKeysResponse', - 'GetKeyRequest', - 'UpdateKeyRequest', - 'DeleteKeyRequest', - 'Key', - 'WebKeySettings', - 'AndroidKeySettings', - 'IOSKeySettings', - }, -) - - -class CreateAssessmentRequest(proto.Message): - r"""The create assessment request message. - Attributes: - parent (str): - Required. The name of the project in which - the assessment will be created, in the format - "projects/{project}". - assessment (google.cloud.recaptchaenterprise_v1.types.Assessment): - Required. The assessment details. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - assessment = proto.Field( - proto.MESSAGE, - number=2, - message='Assessment', - ) - - -class AnnotateAssessmentRequest(proto.Message): - r"""The request message to annotate an Assessment. - Attributes: - name (str): - Required. The resource name of the - Assessment, in the format - "projects/{project}/assessments/{assessment}". - annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation): - Required. The annotation that will be - assigned to the Event. - """ - class Annotation(proto.Enum): - r"""Enum that reprensents the types of annotations.""" - ANNOTATION_UNSPECIFIED = 0 - LEGITIMATE = 1 - FRAUDULENT = 2 - PASSWORD_CORRECT = 3 - PASSWORD_INCORRECT = 4 - - name = proto.Field( - proto.STRING, - number=1, - ) - annotation = proto.Field( - proto.ENUM, - number=2, - enum=Annotation, - ) - - -class AnnotateAssessmentResponse(proto.Message): - r"""Empty response for AnnotateAssessment. """ - - -class Assessment(proto.Message): - r"""A recaptcha assessment resource. - Attributes: - name (str): - Output only. The resource name for the - Assessment in the format - "projects/{project}/assessments/{assessment}". - event (google.cloud.recaptchaenterprise_v1.types.Event): - The event being assessed. - risk_analysis (google.cloud.recaptchaenterprise_v1.types.RiskAnalysis): - Output only. The risk analysis result for the - event being assessed. - token_properties (google.cloud.recaptchaenterprise_v1.types.TokenProperties): - Output only. Properties of the provided event - token. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - event = proto.Field( - proto.MESSAGE, - number=2, - message='Event', - ) - risk_analysis = proto.Field( - proto.MESSAGE, - number=3, - message='RiskAnalysis', - ) - token_properties = proto.Field( - proto.MESSAGE, - number=4, - message='TokenProperties', - ) - - -class Event(proto.Message): - r""" - Attributes: - token (str): - Optional. The user response token provided by - the reCAPTCHA client-side integration on your - site. - site_key (str): - Optional. The site key that was used to - invoke reCAPTCHA on your site and generate the - token. - user_agent (str): - Optional. The user agent present in the - request from the user's device related to this - event. - user_ip_address (str): - Optional. The IP address in the request from - the user's device related to this event. - expected_action (str): - Optional. The expected action for this type - of event. This should be the same action - provided at token generation time on client-side - platforms already integrated with recaptcha - enterprise. - """ - - token = proto.Field( - proto.STRING, - number=1, - ) - site_key = proto.Field( - proto.STRING, - number=2, - ) - user_agent = proto.Field( - proto.STRING, - number=3, - ) - user_ip_address = proto.Field( - proto.STRING, - number=4, - ) - expected_action = proto.Field( - proto.STRING, - number=5, - ) - - -class RiskAnalysis(proto.Message): - r"""Risk analysis result for an event. - Attributes: - score (float): - Legitimate event score from 0.0 to 1.0. - (1.0 means very likely legitimate traffic while - 0.0 means very likely non-legitimate traffic). - reasons (Sequence[google.cloud.recaptchaenterprise_v1.types.RiskAnalysis.ClassificationReason]): - Reasons contributing to the risk analysis - verdict. - """ - class ClassificationReason(proto.Enum): - r"""LINT.IfChange(classification_reason) Reasons contributing to the - risk analysis verdict. - """ - CLASSIFICATION_REASON_UNSPECIFIED = 0 - AUTOMATION = 1 - UNEXPECTED_ENVIRONMENT = 2 - TOO_MUCH_TRAFFIC = 3 - UNEXPECTED_USAGE_PATTERNS = 4 - LOW_CONFIDENCE_SCORE = 5 - - score = proto.Field( - proto.FLOAT, - number=1, - ) - reasons = proto.RepeatedField( - proto.ENUM, - number=2, - enum=ClassificationReason, - ) - - -class TokenProperties(proto.Message): - r""" - Attributes: - valid (bool): - Whether the provided user response token is valid. When - valid = false, the reason could be specified in - invalid_reason or it could also be due to a user failing to - solve a challenge or a sitekey mismatch (i.e the sitekey - used to generate the token was different than the one - specified in the assessment). - invalid_reason (google.cloud.recaptchaenterprise_v1.types.TokenProperties.InvalidReason): - Reason associated with the response when - valid = false. - create_time (google.protobuf.timestamp_pb2.Timestamp): - The timestamp corresponding to the generation - of the token. - hostname (str): - The hostname of the page on which the token - was generated. - action (str): - Action name provided at token generation. - """ - class InvalidReason(proto.Enum): - r"""LINT.IfChange - Enum that represents the types of invalid token reasons. - """ - INVALID_REASON_UNSPECIFIED = 0 - UNKNOWN_INVALID_REASON = 1 - MALFORMED = 2 - EXPIRED = 3 - DUPE = 4 - MISSING = 5 - - valid = proto.Field( - proto.BOOL, - number=1, - ) - invalid_reason = proto.Field( - proto.ENUM, - number=2, - enum=InvalidReason, - ) - create_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - hostname = proto.Field( - proto.STRING, - number=4, - ) - action = proto.Field( - proto.STRING, - number=5, - ) - - -class CreateKeyRequest(proto.Message): - r"""The create key request message. - Attributes: - parent (str): - Required. The name of the project in which - the key will be created, in the format - "projects/{project}". - key (google.cloud.recaptchaenterprise_v1.types.Key): - Required. Information to create a reCAPTCHA - Enterprise key. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - key = proto.Field( - proto.MESSAGE, - number=2, - message='Key', - ) - - -class ListKeysRequest(proto.Message): - r"""The list keys request message. - Attributes: - parent (str): - Required. The name of the project that - contains the keys that will be listed, in the - format "projects/{project}". - page_size (int): - Optional. The maximum number of keys to - return. Default is 10. Max limit is 1000. - page_token (str): - Optional. The next_page_token value returned from a - previous. ListKeysRequest, if any. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - - -class ListKeysResponse(proto.Message): - r"""Response to request to list keys in a project. - Attributes: - keys (Sequence[google.cloud.recaptchaenterprise_v1.types.Key]): - Key details. - next_page_token (str): - Token to retrieve the next page of results. - It is set to empty if no keys remain in results. - """ - - @property - def raw_page(self): - return self - - keys = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Key', - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class GetKeyRequest(proto.Message): - r"""The get key request message. - Attributes: - name (str): - Required. The name of the requested key, in - the format "projects/{project}/keys/{key}". - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateKeyRequest(proto.Message): - r"""The update key request message. - Attributes: - key (google.cloud.recaptchaenterprise_v1.types.Key): - Required. The key to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Optional. The mask to control which field of - the key get updated. If the mask is not present, - all fields will be updated. - """ - - key = proto.Field( - proto.MESSAGE, - number=1, - message='Key', - ) - update_mask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class DeleteKeyRequest(proto.Message): - r"""The delete key request message. - Attributes: - name (str): - Required. The name of the key to be deleted, - in the format "projects/{project}/keys/{key}". - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class Key(proto.Message): - r"""A key used to identify and configure applications (web and/or - mobile) that use reCAPTCHA Enterprise. - - Attributes: - name (str): - The resource name for the Key in the format - "projects/{project}/keys/{key}". - display_name (str): - Human-readable display name of this key. - Modifiable by user. - web_settings (google.cloud.recaptchaenterprise_v1.types.WebKeySettings): - Settings for keys that can be used by - websites. - android_settings (google.cloud.recaptchaenterprise_v1.types.AndroidKeySettings): - Settings for keys that can be used by Android - apps. - ios_settings (google.cloud.recaptchaenterprise_v1.types.IOSKeySettings): - Settings for keys that can be used by iOS - apps. - labels (Sequence[google.cloud.recaptchaenterprise_v1.types.Key.LabelsEntry]): - Optional. See Creating and managing - labels. - create_time (google.protobuf.timestamp_pb2.Timestamp): - The timestamp corresponding to the creation - of this Key. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - display_name = proto.Field( - proto.STRING, - number=2, - ) - web_settings = proto.Field( - proto.MESSAGE, - number=3, - oneof='platform_settings', - message='WebKeySettings', - ) - android_settings = proto.Field( - proto.MESSAGE, - number=4, - oneof='platform_settings', - message='AndroidKeySettings', - ) - ios_settings = proto.Field( - proto.MESSAGE, - number=5, - oneof='platform_settings', - message='IOSKeySettings', - ) - labels = proto.MapField( - proto.STRING, - proto.STRING, - number=6, - ) - create_time = proto.Field( - proto.MESSAGE, - number=7, - message=timestamp_pb2.Timestamp, - ) - - -class WebKeySettings(proto.Message): - r"""Settings specific to keys that can be used by websites. - Attributes: - allow_all_domains (bool): - If set to true, it means allowed_domains will not be - enforced. - allowed_domains (Sequence[str]): - Domains or subdomains of websites allowed to - use the key. All subdomains of an allowed domain - are automatically allowed. A valid domain - requires a host and must not include any path, - port, query or fragment. Examples: 'example.com' - or 'subdomain.example.com' - allow_amp_traffic (bool): - Required. Whether this key can be used on AMP - (Accelerated Mobile Pages) websites. - integration_type (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.IntegrationType): - Required. Describes how this key is - integrated with the website. - challenge_security_preference (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.ChallengeSecurityPreference): - Settings for the frequency and difficulty at - which this key triggers captcha challenges. This - should only be specified for IntegrationTypes - CHECKBOX and INVISIBLE. - """ - class IntegrationType(proto.Enum): - r"""Enum that represents the integration types for web keys.""" - INTEGRATION_TYPE_UNSPECIFIED = 0 - SCORE = 1 - CHECKBOX = 2 - INVISIBLE = 3 - - class ChallengeSecurityPreference(proto.Enum): - r"""Enum that represents the possible challenge frequency and - difficulty configurations for a web key. - """ - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0 - USABILITY = 1 - BALANCE = 2 - SECURITY = 3 - - allow_all_domains = proto.Field( - proto.BOOL, - number=3, - ) - allowed_domains = proto.RepeatedField( - proto.STRING, - number=1, - ) - allow_amp_traffic = proto.Field( - proto.BOOL, - number=2, - ) - integration_type = proto.Field( - proto.ENUM, - number=4, - enum=IntegrationType, - ) - challenge_security_preference = proto.Field( - proto.ENUM, - number=5, - enum=ChallengeSecurityPreference, - ) - - -class AndroidKeySettings(proto.Message): - r"""Settings specific to keys that can be used by Android apps. - Attributes: - allowed_package_names (Sequence[str]): - Android package names of apps allowed to use - the key. Example: 'com.companyname.appname' - """ - - allowed_package_names = proto.RepeatedField( - proto.STRING, - number=1, - ) - - -class IOSKeySettings(proto.Message): - r"""Settings specific to keys that can be used by iOS apps. - Attributes: - allowed_bundle_ids (Sequence[str]): - iOS bundle ids of apps allowed to use the - key. Example: - 'com.companyname.productname.appname' - """ - - allowed_bundle_ids = proto.RepeatedField( - proto.STRING, - number=1, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini deleted file mode 100644 index 4505b48..0000000 --- a/owl-bot-staging/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py deleted file mode 100644 index d868346..0000000 --- a/owl-bot-staging/v1/noxfile.py +++ /dev/null @@ -1,132 +0,0 @@ -# -*- 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 os -import pathlib -import shutil -import subprocess -import sys - - -import nox # type: ignore - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", -] - -@nox.session(python=['3.6', '3.7', '3.8', '3.9']) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/recaptchaenterprise_v1/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python='3.7') -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=['3.6', '3.7']) -def mypy(session): - """Run the type checker.""" - session.install('mypy', 'types-pkg_resources') - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - 'google', - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'update', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'check', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - -@nox.session(python='3.6') -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx<3.0.0", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) diff --git a/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py deleted file mode 100644 index 9fe41bb..0000000 --- a/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py +++ /dev/null @@ -1,182 +0,0 @@ -#! /usr/bin/env python3 -# -*- 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 argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class recaptchaenterpriseCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'annotate_assessment': ('name', 'annotation', ), - 'create_assessment': ('parent', 'assessment', ), - 'create_key': ('parent', 'key', ), - 'delete_key': ('name', ), - 'get_key': ('name', ), - 'list_keys': ('parent', 'page_size', 'page_token', ), - 'update_key': ('key', 'update_mask', ), - } - - def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: - try: - key = original.func.attr.value - kword_params = self.METHOD_TO_PARAMS[key] - except (AttributeError, KeyError): - # Either not a method from the API or too convoluted to be sure. - return updated - - # If the existing code is valid, keyword args come after positional args. - # Therefore, all positional args must map to the first parameters. - args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) - if any(k.keyword.value == "request" for k in kwargs): - # We've already fixed this file, don't fix it again. - return updated - - kwargs, ctrl_kwargs = partition( - lambda a: not a.keyword.value in self.CTRL_PARAMS, - kwargs - ) - - args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] - ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) - for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) - - request_arg = cst.Arg( - value=cst.Dict([ - cst.DictElement( - cst.SimpleString("'{}'".format(name)), -cst.Element(value=arg.value) - ) - # Note: the args + kwargs looks silly, but keep in mind that - # the control parameters had to be stripped out, and that - # those could have been passed positionally or by keyword. - for name, arg in zip(kword_params, args + kwargs)]), - keyword=cst.Name("request") - ) - - return updated.with_changes( - args=[request_arg] + ctrl_kwargs - ) - - -def fix_files( - in_dir: pathlib.Path, - out_dir: pathlib.Path, - *, - transformer=recaptchaenterpriseCallTransformer(), -): - """Duplicate the input dir to the output dir, fixing file method calls. - - Preconditions: - * in_dir is a real directory - * out_dir is a real, empty directory - """ - pyfile_gen = ( - pathlib.Path(os.path.join(root, f)) - for root, _, files in os.walk(in_dir) - for f in files if os.path.splitext(f)[1] == ".py" - ) - - for fpath in pyfile_gen: - with open(fpath, 'r') as f: - src = f.read() - - # Parse the code and insert method call fixes. - tree = cst.parse_module(src) - updated = tree.visit(transformer) - - # Create the path and directory structure for the new file. - updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) - updated_path.parent.mkdir(parents=True, exist_ok=True) - - # Generate the updated source file at the corresponding path. - with open(updated_path, 'w') as f: - f.write(updated.code) - - -if __name__ == '__main__': - parser = argparse.ArgumentParser( - description="""Fix up source that uses the recaptchaenterprise client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py deleted file mode 100644 index c85c9f2..0000000 --- a/owl-bot-staging/v1/setup.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- 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 io -import os -import setuptools # type: ignore - -version = '0.1.0' - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, 'README.rst') -with io.open(readme_filename, encoding='utf-8') as readme_file: - readme = readme_file.read() - -setuptools.setup( - name='google-cloud-recaptchaenterprise', - version=version, - long_description=readme, - packages=setuptools.PEP420PackageFinder.find(), - namespace_packages=('google', 'google.cloud'), - platforms='Posix; MacOS X; Windows', - include_package_data=True, - install_requires=( - 'google-api-core[grpc] >= 1.27.0, < 3.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.15.0', - 'packaging >= 14.3', ), - python_requires='>=3.6', - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Topic :: Internet', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - zip_safe=False, -) diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- 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. -# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- 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. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- 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. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- 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. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py deleted file mode 100644 index ebf590f..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py +++ /dev/null @@ -1,2381 +0,0 @@ -# -*- 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 os -import mock -import packaging.version - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceAsyncClient -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceClient -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import transports -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise -from google.oauth2 import service_account -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the auth "less than" test cases -# - Delete these pytest markers (Make the "greater than or equal to" tests the default). -requires_google_auth_lt_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), - reason="This test requires google-auth < 1.25.0", -) -requires_google_auth_gte_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), - reason="This test requires google-auth >= 1.25.0", -) - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(None) is None - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - RecaptchaEnterpriseServiceClient, - RecaptchaEnterpriseServiceAsyncClient, -]) -def test_recaptcha_enterprise_service_client_from_service_account_info(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'recaptchaenterprise.googleapis.com:443' - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), - (transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recaptcha_enterprise_service_client_service_account_always_use_jwt(transport_class, transport_name): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=True) - use_jwt.assert_called_once_with(True) - - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=False) - use_jwt.assert_not_called() - - -@pytest.mark.parametrize("client_class", [ - RecaptchaEnterpriseServiceClient, - RecaptchaEnterpriseServiceAsyncClient, -]) -def test_recaptcha_enterprise_service_client_from_service_account_file(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'recaptchaenterprise.googleapis.com:443' - - -def test_recaptcha_enterprise_service_client_get_transport_class(): - transport = RecaptchaEnterpriseServiceClient.get_transport_class() - available_transports = [ - transports.RecaptchaEnterpriseServiceGrpcTransport, - ] - assert transport in available_transports - - transport = RecaptchaEnterpriseServiceClient.get_transport_class("grpc") - assert transport == transports.RecaptchaEnterpriseServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) -@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) -def test_recaptcha_enterprise_service_client_client_options(client_class, transport_class, transport_name): - # Check that if channel is provided we won't create a new one. - with mock.patch.object(RecaptchaEnterpriseServiceClient, 'get_transport_class') as gtc: - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ) - client = client_class(transport=transport) - gtc.assert_not_called() - - # Check that if channel is provided via str we will create a new one. - with mock.patch.object(RecaptchaEnterpriseServiceClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class() - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class() - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", "true"), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", "false"), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) -@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_recaptcha_enterprise_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recaptcha_enterprise_service_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recaptcha_enterprise_service_client_client_options_credentials_file(client_class, transport_class, transport_name): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -def test_recaptcha_enterprise_service_client_client_options_from_dict(): - with mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = RecaptchaEnterpriseServiceClient( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -def test_create_assessment(transport: str = 'grpc', request_type=recaptchaenterprise.CreateAssessmentRequest): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Assessment( - name='name_value', - ) - response = client.create_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateAssessmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Assessment) - assert response.name == 'name_value' - - -def test_create_assessment_from_dict(): - test_create_assessment(request_type=dict) - - -def test_create_assessment_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - client.create_assessment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateAssessmentRequest() - - -@pytest.mark.asyncio -async def test_create_assessment_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.CreateAssessmentRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment( - name='name_value', - )) - response = await client.create_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateAssessmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Assessment) - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_create_assessment_async_from_dict(): - await test_create_assessment_async(request_type=dict) - - -def test_create_assessment_field_headers(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.CreateAssessmentRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - call.return_value = recaptchaenterprise.Assessment() - client.create_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_create_assessment_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.CreateAssessmentRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment()) - await client.create_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -def test_create_assessment_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Assessment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_assessment( - parent='parent_value', - assessment=recaptchaenterprise.Assessment(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].assessment == recaptchaenterprise.Assessment(name='name_value') - - -def test_create_assessment_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_assessment( - recaptchaenterprise.CreateAssessmentRequest(), - parent='parent_value', - assessment=recaptchaenterprise.Assessment(name='name_value'), - ) - - -@pytest.mark.asyncio -async def test_create_assessment_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Assessment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_assessment( - parent='parent_value', - assessment=recaptchaenterprise.Assessment(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].assessment == recaptchaenterprise.Assessment(name='name_value') - - -@pytest.mark.asyncio -async def test_create_assessment_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_assessment( - recaptchaenterprise.CreateAssessmentRequest(), - parent='parent_value', - assessment=recaptchaenterprise.Assessment(name='name_value'), - ) - - -def test_annotate_assessment(transport: str = 'grpc', request_type=recaptchaenterprise.AnnotateAssessmentRequest): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.AnnotateAssessmentResponse( - ) - response = client.annotate_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.AnnotateAssessmentResponse) - - -def test_annotate_assessment_from_dict(): - test_annotate_assessment(request_type=dict) - - -def test_annotate_assessment_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - client.annotate_assessment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() - - -@pytest.mark.asyncio -async def test_annotate_assessment_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.AnnotateAssessmentRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse( - )) - response = await client.annotate_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.AnnotateAssessmentResponse) - - -@pytest.mark.asyncio -async def test_annotate_assessment_async_from_dict(): - await test_annotate_assessment_async(request_type=dict) - - -def test_annotate_assessment_field_headers(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.AnnotateAssessmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() - client.annotate_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_annotate_assessment_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.AnnotateAssessmentRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse()) - await client.annotate_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -def test_annotate_assessment_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.annotate_assessment( - name='name_value', - annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].annotation == recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE - - -def test_annotate_assessment_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.annotate_assessment( - recaptchaenterprise.AnnotateAssessmentRequest(), - name='name_value', - annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, - ) - - -@pytest.mark.asyncio -async def test_annotate_assessment_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.annotate_assessment( - name='name_value', - annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].annotation == recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE - - -@pytest.mark.asyncio -async def test_annotate_assessment_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.annotate_assessment( - recaptchaenterprise.AnnotateAssessmentRequest(), - name='name_value', - annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, - ) - - -def test_create_key(transport: str = 'grpc', request_type=recaptchaenterprise.CreateKeyRequest): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), - ) - response = client.create_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -def test_create_key_from_dict(): - test_create_key(request_type=dict) - - -def test_create_key_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_key), - '__call__') as call: - client.create_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateKeyRequest() - - -@pytest.mark.asyncio -async def test_create_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.CreateKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - )) - response = await client.create_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -@pytest.mark.asyncio -async def test_create_key_async_from_dict(): - await test_create_key_async(request_type=dict) - - -def test_create_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.CreateKeyRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_key), - '__call__') as call: - call.return_value = recaptchaenterprise.Key() - client.create_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_create_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.CreateKeyRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - await client.create_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -def test_list_keys(transport: str = 'grpc', request_type=recaptchaenterprise.ListKeysRequest): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListKeysResponse( - next_page_token='next_page_token_value', - ) - response = client.list_keys(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListKeysRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListKeysPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_keys_from_dict(): - test_list_keys(request_type=dict) - - -def test_list_keys_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - client.list_keys() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListKeysRequest() - - -@pytest.mark.asyncio -async def test_list_keys_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.ListKeysRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_keys(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListKeysRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListKeysAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_keys_async_from_dict(): - await test_list_keys_async(request_type=dict) - - -def test_list_keys_field_headers(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.ListKeysRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - call.return_value = recaptchaenterprise.ListKeysResponse() - client.list_keys(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_keys_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.ListKeysRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse()) - await client.list_keys(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -def test_list_keys_pager(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListKeysResponse( - keys=[], - next_page_token='def', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_keys(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, recaptchaenterprise.Key) - for i in results) - -def test_list_keys_pages(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListKeysResponse( - keys=[], - next_page_token='def', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - ), - RuntimeError, - ) - pages = list(client.list_keys(request={}).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.asyncio -async def test_list_keys_async_pager(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListKeysResponse( - keys=[], - next_page_token='def', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_keys(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, recaptchaenterprise.Key) - for i in responses) - -@pytest.mark.asyncio -async def test_list_keys_async_pages(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListKeysResponse( - keys=[], - next_page_token='def', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_keys(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_get_key(transport: str = 'grpc', request_type=recaptchaenterprise.GetKeyRequest): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), - ) - response = client.get_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.GetKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -def test_get_key_from_dict(): - test_get_key(request_type=dict) - - -def test_get_key_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_key), - '__call__') as call: - client.get_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.GetKeyRequest() - - -@pytest.mark.asyncio -async def test_get_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.GetKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - )) - response = await client.get_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.GetKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -@pytest.mark.asyncio -async def test_get_key_async_from_dict(): - await test_get_key_async(request_type=dict) - - -def test_get_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.GetKeyRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_key), - '__call__') as call: - call.return_value = recaptchaenterprise.Key() - client.get_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.GetKeyRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - await client.get_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -def test_update_key(transport: str = 'grpc', request_type=recaptchaenterprise.UpdateKeyRequest): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), - ) - response = client.update_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.UpdateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -def test_update_key_from_dict(): - test_update_key(request_type=dict) - - -def test_update_key_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_key), - '__call__') as call: - client.update_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.UpdateKeyRequest() - - -@pytest.mark.asyncio -async def test_update_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.UpdateKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - )) - response = await client.update_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.UpdateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -@pytest.mark.asyncio -async def test_update_key_async_from_dict(): - await test_update_key_async(request_type=dict) - - -def test_update_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.UpdateKeyRequest() - - request.key.name = 'key.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_key), - '__call__') as call: - call.return_value = recaptchaenterprise.Key() - client.update_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'key.name=key.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.UpdateKeyRequest() - - request.key.name = 'key.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - await client.update_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'key.name=key.name/value', - ) in kw['metadata'] - - -def test_delete_key(transport: str = 'grpc', request_type=recaptchaenterprise.DeleteKeyRequest): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.DeleteKeyRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_key_from_dict(): - test_delete_key(request_type=dict) - - -def test_delete_key_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_key), - '__call__') as call: - client.delete_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.DeleteKeyRequest() - - -@pytest.mark.asyncio -async def test_delete_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.DeleteKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.DeleteKeyRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_key_async_from_dict(): - await test_delete_key_async(request_type=dict) - - -def test_delete_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.DeleteKeyRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_key), - '__call__') as call: - call.return_value = None - client.delete_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recaptchaenterprise.DeleteKeyRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecaptchaEnterpriseServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecaptchaEnterpriseServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = RecaptchaEnterpriseServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.RecaptchaEnterpriseServiceGrpcTransport, - transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.RecaptchaEnterpriseServiceGrpcTransport, - ) - -def test_recaptcha_enterprise_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.RecaptchaEnterpriseServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_recaptcha_enterprise_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.RecaptchaEnterpriseServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'create_assessment', - 'annotate_assessment', - 'create_key', - 'list_keys', - 'get_key', - 'update_key', - 'delete_key', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - -@requires_google_auth_gte_1_25_0 -def test_recaptcha_enterprise_service_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecaptchaEnterpriseServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@requires_google_auth_lt_1_25_0 -def test_recaptcha_enterprise_service_base_transport_with_credentials_file_old_google_auth(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecaptchaEnterpriseServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - quota_project_id="octopus", - ) - - -def test_recaptcha_enterprise_service_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecaptchaEnterpriseServiceTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_recaptcha_enterprise_service_auth_adc(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - RecaptchaEnterpriseServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@requires_google_auth_lt_1_25_0 -def test_recaptcha_enterprise_service_auth_adc_old_google_auth(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - RecaptchaEnterpriseServiceClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.RecaptchaEnterpriseServiceGrpcTransport, - transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_recaptcha_enterprise_service_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.RecaptchaEnterpriseServiceGrpcTransport, - transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_recaptcha_enterprise_service_transport_auth_adc_old_google_auth(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.RecaptchaEnterpriseServiceGrpcTransport, grpc_helpers), - (transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_recaptcha_enterprise_service_transport_create_channel(transport_class, grpc_helpers): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( - grpc_helpers, "create_channel", autospec=True - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - adc.return_value = (creds, None) - transport_class( - quota_project_id="octopus", - scopes=["1", "2"] - ) - - create_channel.assert_called_with( - "recaptchaenterprise.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="recaptchaenterprise.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) -def test_recaptcha_enterprise_service_grpc_transport_client_cert_source_for_mtls( - transport_class -): - cred = ga_credentials.AnonymousCredentials() - - # Check ssl_channel_credentials is used if provided. - with mock.patch.object(transport_class, "create_channel") as mock_create_channel: - mock_ssl_channel_creds = mock.Mock() - transport_class( - host="squid.clam.whelk", - credentials=cred, - ssl_channel_credentials=mock_ssl_channel_creds - ) - mock_create_channel.assert_called_once_with( - "squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - - -def test_recaptcha_enterprise_service_host_no_port(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='recaptchaenterprise.googleapis.com'), - ) - assert client.transport._host == 'recaptchaenterprise.googleapis.com:443' - - -def test_recaptcha_enterprise_service_host_with_port(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='recaptchaenterprise.googleapis.com:8000'), - ) - assert client.transport._host == 'recaptchaenterprise.googleapis.com:8000' - -def test_recaptcha_enterprise_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - host="squid.clam.whelk", - channel=channel, - ) - assert transport.grpc_channel == channel - assert transport._host == "squid.clam.whelk:443" - assert transport._ssl_channel_credentials == None - - -def test_recaptcha_enterprise_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport( - host="squid.clam.whelk", - channel=channel, - ) - assert transport.grpc_channel == channel - assert transport._host == "squid.clam.whelk:443" - assert transport._ssl_channel_credentials == None - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) -def test_recaptcha_enterprise_service_transport_channel_mtls_with_client_cert_source( - transport_class -): - with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_ssl_cred = mock.Mock() - grpc_ssl_channel_cred.return_value = mock_ssl_cred - - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - - cred = ga_credentials.AnonymousCredentials() - with pytest.warns(DeprecationWarning): - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (cred, None) - transport = transport_class( - host="squid.clam.whelk", - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=client_cert_source_callback, - ) - adc.assert_called_once() - - grpc_ssl_channel_cred.assert_called_once_with( - certificate_chain=b"cert bytes", private_key=b"key bytes" - ) - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - assert transport._ssl_channel_credentials == mock_ssl_cred - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) -def test_recaptcha_enterprise_service_transport_channel_mtls_with_adc( - transport_class -): - mock_ssl_cred = mock.Mock() - with mock.patch.multiple( - "google.auth.transport.grpc.SslCredentials", - __init__=mock.Mock(return_value=None), - ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), - ): - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - mock_cred = mock.Mock() - - with pytest.warns(DeprecationWarning): - transport = transport_class( - host="squid.clam.whelk", - credentials=mock_cred, - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=None, - ) - - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=mock_cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - - -def test_assessment_path(): - project = "squid" - assessment = "clam" - expected = "projects/{project}/assessments/{assessment}".format(project=project, assessment=assessment, ) - actual = RecaptchaEnterpriseServiceClient.assessment_path(project, assessment) - assert expected == actual - - -def test_parse_assessment_path(): - expected = { - "project": "whelk", - "assessment": "octopus", - } - path = RecaptchaEnterpriseServiceClient.assessment_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_assessment_path(path) - assert expected == actual - -def test_key_path(): - project = "oyster" - key = "nudibranch" - expected = "projects/{project}/keys/{key}".format(project=project, key=key, ) - actual = RecaptchaEnterpriseServiceClient.key_path(project, key) - assert expected == actual - - -def test_parse_key_path(): - expected = { - "project": "cuttlefish", - "key": "mussel", - } - path = RecaptchaEnterpriseServiceClient.key_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_key_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "winkle" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = RecaptchaEnterpriseServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "nautilus", - } - path = RecaptchaEnterpriseServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "scallop" - expected = "folders/{folder}".format(folder=folder, ) - actual = RecaptchaEnterpriseServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "abalone", - } - path = RecaptchaEnterpriseServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "squid" - expected = "organizations/{organization}".format(organization=organization, ) - actual = RecaptchaEnterpriseServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "clam", - } - path = RecaptchaEnterpriseServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "whelk" - expected = "projects/{project}".format(project=project, ) - actual = RecaptchaEnterpriseServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "octopus", - } - path = RecaptchaEnterpriseServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "oyster" - location = "nudibranch" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = RecaptchaEnterpriseServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "cuttlefish", - "location": "mussel", - } - path = RecaptchaEnterpriseServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_withDEFAULT_CLIENT_INFO(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.RecaptchaEnterpriseServiceTransport, '_prep_wrapped_messages') as prep: - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.RecaptchaEnterpriseServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = RecaptchaEnterpriseServiceClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) diff --git a/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py b/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py index 7b19d1d..c597810 100644 --- a/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py +++ b/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py @@ -132,21 +132,6 @@ def test_recaptcha_enterprise_service_client_from_service_account_info(client_cl assert client.transport._host == "recaptchaenterprise.googleapis.com:443" -@pytest.mark.parametrize( - "client_class", - [RecaptchaEnterpriseServiceClient, RecaptchaEnterpriseServiceAsyncClient,], -) -def test_recaptcha_enterprise_service_client_service_account_always_use_jwt( - client_class, -): - with mock.patch.object( - service_account.Credentials, "with_always_use_jwt_access", create=True - ) as use_jwt: - creds = service_account.Credentials(None, None, None) - client = client_class(credentials=creds) - use_jwt.assert_not_called() - - @pytest.mark.parametrize( "transport_class,transport_name", [ @@ -154,7 +139,7 @@ def test_recaptcha_enterprise_service_client_service_account_always_use_jwt( (transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), ], ) -def test_recaptcha_enterprise_service_client_service_account_always_use_jwt_true( +def test_recaptcha_enterprise_service_client_service_account_always_use_jwt( transport_class, transport_name ): with mock.patch.object( @@ -164,6 +149,13 @@ def test_recaptcha_enterprise_service_client_service_account_always_use_jwt_true transport = transport_class(credentials=creds, always_use_jwt_access=True) use_jwt.assert_called_once_with(True) + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + @pytest.mark.parametrize( "client_class", @@ -253,6 +245,7 @@ def test_recaptcha_enterprise_service_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is @@ -269,6 +262,7 @@ def test_recaptcha_enterprise_service_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is @@ -285,6 +279,7 @@ def test_recaptcha_enterprise_service_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has @@ -313,6 +308,7 @@ def test_recaptcha_enterprise_service_client_client_options( client_cert_source_for_mtls=None, quota_project_id="octopus", client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -389,6 +385,7 @@ def test_recaptcha_enterprise_service_client_mtls_env_auto( client_cert_source_for_mtls=expected_client_cert_source, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case ADC client cert is provided. Whether client cert is used depends on @@ -422,6 +419,7 @@ def test_recaptcha_enterprise_service_client_mtls_env_auto( client_cert_source_for_mtls=expected_client_cert_source, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case client_cert_source and ADC client cert are not provided. @@ -443,6 +441,7 @@ def test_recaptcha_enterprise_service_client_mtls_env_auto( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -477,6 +476,7 @@ def test_recaptcha_enterprise_service_client_client_options_scopes( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -511,6 +511,7 @@ def test_recaptcha_enterprise_service_client_client_options_credentials_file( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -530,6 +531,7 @@ def test_recaptcha_enterprise_service_client_client_options_from_dict(): client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, )