docs(samples): add reCAPTCHA Enterprise code samples (#112)

Sita04 · busunkim96 · parthea · web-flow · commit b3672ed54b13 · 2021-10-13T07:33:00.000-04:00
* docs(samples): added samples and tests for site key CRUD operation * docs(samples): added samples and tests for create assessment * docs(samples): modified requirements and test inputs * docs(samples): lint fix - adding copyright * fix(samples): added nox config and modified requirements-test * docs(samples): lint fix * refactor(samples): updated nox file * docs(samples): lint fix * docs(samples): added nox config * docs(samples): lint fix; modified nox config * refactor(samples): incorporated review comments * refactor(samples): lint fix * refactor(samples): lint fix * refactor(samples): lint fix * docs(samples): updated to use latest chrome version and lint fix * fix(samples): updated selenium to use chrome browser and added display name to update key * build: add placeholder dockerfile, update kokoro configs * Adding chrome installation in docker * refactor(samples): removed webdriver manager dependency. Included commands to install binary file in docker. * fix(samples): changed the chromedriver version to latest release. * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * refactor(samples): included review comments Co-authored-by: Bu Sun Kim <busunkim@google.com> Co-authored-by: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/recaptcha_enterprise/snippets/create_assessment.py b/recaptcha_enterprise/snippets/create_assessment.py
@@ -0,0 +1,82 @@
+# Copyright 2021 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# [START recaptcha_enterprise_create_assessment]
+from google.cloud import recaptchaenterprise_v1
+
+
+def create_assessment(
+    project_id: str, recaptcha_site_key: str, token: str, recaptcha_action: str
+) -> None:
+    """ Create an assessment to analyze the risk of a UI action.
+    Args:
+        project_id: GCloud Project ID
+        recaptcha_site_key: Site key obtained by registering a domain/app to use recaptcha services.
+        token: The token obtained from the client on passing the recaptchaSiteKey.
+        recaptcha_action: Action name corresponding to the token.
+    """
+
+    # TODO(developer): Replace these variables before running the sample.
+    # Specify a name for this assessment.
+    assessment_name = "assessment_name"
+
+    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()
+
+    # Set the properties of the event to be tracked.
+    event = recaptchaenterprise_v1.Event()
+    event.site_key = recaptcha_site_key
+    event.token = token
+
+    assessment = recaptchaenterprise_v1.Assessment()
+    assessment.event = event
+    assessment.name = assessment_name
+
+    project_name = f"projects/{project_id}"
+
+    # Build the assessment request.
+    request = recaptchaenterprise_v1.CreateAssessmentRequest()
+    request.assessment = assessment
+    request.parent = project_name
+
+    response = client.create_assessment(request)
+
+    # Check if the token is valid.
+    if not response.token_properties.valid:
+        print(
+            "The CreateAssessment call failed because the token was "
+            + "invalid for for the following reasons: "
+            + str(response.token_properties.invalid_reason)
+        )
+        return
+
+    # Check if the expected action was executed.
+    if response.token_properties.action != recaptcha_action:
+        print(
+            "The action attribute in your reCAPTCHA tag does"
+            + "not match the action you are expecting to score"
+        )
+        return
+    else:
+        # Get the risk score and the reason(s)
+        # For more information on interpreting the assessment,
+        # see: https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment
+        for reason in response.risk_analysis.reasons:
+            print(reason)
+        print(
+            "The reCAPTCHA score for this token is: "
+            + str(response.risk_analysis.score)
+        )
+
+
+# [END recaptcha_enterprise_create_assessment]
diff --git a/recaptcha_enterprise/snippets/create_site_key.py b/recaptcha_enterprise/snippets/create_site_key.py
@@ -0,0 +1,66 @@
+# Copyright 2021 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# [START recaptcha_enterprise_create_site_key]
+from google.cloud import recaptchaenterprise_v1
+
+
+def create_site_key(project_id: str, domain_name: str) -> str:
+    """Create reCAPTCHA Site key which binds a domain name to a unique key.
+    Args:
+    project_id : GCloud Project ID.
+    domain_name: Specify the domain name in which the reCAPTCHA should be activated.
+    """
+    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()
+
+    # Set the type of the reCAPTCHA to be displayed.
+    # For different types, see: https://cloud.google.com/recaptcha-enterprise/docs/keys
+    web_settings = recaptchaenterprise_v1.WebKeySettings()
+    web_settings.allowed_domains.append(domain_name)
+    web_settings.allow_amp_traffic = False
+    web_settings.integration_type = web_settings.IntegrationType.SCORE
+
+    key = recaptchaenterprise_v1.Key()
+    key.display_name = "any descriptive name for the key"
+    key.web_settings = web_settings
+
+    # Create the request.
+    request = recaptchaenterprise_v1.CreateKeyRequest()
+    request.parent = f"projects/{project_id}"
+    request.key = key
+
+    # Get the name of the created reCAPTCHA site key.
+    response = client.create_key(request)
+    recaptcha_site_key = response.name.rsplit("/", maxsplit=1)[1]
+    print("reCAPTCHA Site key created successfully. Site Key: " + recaptcha_site_key)
+    return recaptcha_site_key
+
+
+# [END recaptcha_enterprise_create_site_key]
+
+if __name__ == "__main__":
+    import google.auth
+    import google.auth.exceptions
+
+    # TODO(developer): Replace the below variables before running
+    try:
+        default_project_id = google.auth.default()[1]
+        domain_name = "localhost"
+    except google.auth.exceptions.DefaultCredentialsError:
+        print(
+            "Please use `gcloud auth application-default login` "
+            "or set GOOGLE_APPLICATION_CREDENTIALS to use this script."
+        )
+    else:
+        create_site_key(default_project_id, domain_name)
diff --git a/recaptcha_enterprise/snippets/delete_site_key.py b/recaptcha_enterprise/snippets/delete_site_key.py
@@ -0,0 +1,57 @@
+# Copyright 2021 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# [START recaptcha_enterprise_delete_site_key]
+from google.cloud import recaptchaenterprise_v1
+
+
+def delete_site_key(project_id: str, recaptcha_site_key: str) -> None:
+    """ Delete the given reCAPTCHA site key present under the project ID.
+
+    Args:
+    project_id : GCloud Project ID.
+    recaptcha_site_key: Specify the key ID to be deleted.
+    """
+
+    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()
+
+    # Construct the key details.
+    key_name = f"projects/{project_id}/keys/{recaptcha_site_key}"
+
+    # Set the project ID and reCAPTCHA site key.
+    request = recaptchaenterprise_v1.DeleteKeyRequest()
+    request.name = key_name
+
+    client.delete_key(request)
+    print("reCAPTCHA Site key deleted successfully ! ")
+
+
+# [END recaptcha_enterprise_delete_site_key]
+
+
+if __name__ == "__main__":
+    import google.auth
+    import google.auth.exceptions
+
+    # TODO(developer): Replace the below variables before running
+    try:
+        default_project_id = google.auth.default()[1]
+        recaptcha_site_key = "recaptcha_site_key"
+    except google.auth.exceptions.DefaultCredentialsError:
+        print(
+            "Please use `gcloud auth application-default login` "
+            "or set GOOGLE_APPLICATION_CREDENTIALS to use this script."
+        )
+    else:
+        delete_site_key(default_project_id, recaptcha_site_key)
diff --git a/recaptcha_enterprise/snippets/get_site_key.py b/recaptcha_enterprise/snippets/get_site_key.py
@@ -0,0 +1,57 @@
+# Copyright 2021 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# [START recaptcha_enterprise_get_site_key]
+from google.cloud import recaptchaenterprise_v1
+
+
+def get_site_key(project_id: str, recaptcha_site_key: str) -> None:
+    """
+    Get the reCAPTCHA site key present under the project ID.
+
+    Args:
+    project_id: GCloud Project ID.
+    recaptcha_site_key: Specify the site key to get the details.
+    """
+
+    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()
+
+    # Construct the key details.
+    key_name = f"projects/{project_id}/keys/{recaptcha_site_key}"
+
+    request = recaptchaenterprise_v1.GetKeyRequest()
+    request.name = key_name
+
+    key = client.get_key(request)
+    print("Successfully obtained the key !" + key.name)
+
+
+# [END recaptcha_enterprise_get_site_key]
+
+
+if __name__ == "__main__":
+    import google.auth
+    import google.auth.exceptions
+
+    # TODO(developer): Replace the below variables before running
+    try:
+        default_project_id = google.auth.default()[1]
+        recaptcha_site_key = "recaptcha_site_key"
+    except google.auth.exceptions.DefaultCredentialsError:
+        print(
+            "Please use `gcloud auth application-default login` "
+            "or set GOOGLE_APPLICATION_CREDENTIALS to use this script."
+        )
+    else:
+        get_site_key(default_project_id, recaptcha_site_key)
diff --git a/recaptcha_enterprise/snippets/list_site_keys.py b/recaptcha_enterprise/snippets/list_site_keys.py
@@ -0,0 +1,56 @@
+# Copyright 2021 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# [START recaptcha_enterprise_list_site_keys]
+from google.cloud import recaptchaenterprise_v1
+
+
+def list_site_keys(project_id: str) -> None:
+    """ List all keys present under the given project ID.
+
+    Args:
+    project_id: GCloud Project ID.
+    """
+
+    project_name = f"projects/{project_id}"
+
+    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()
+
+    # Set the project id to list the keys present in it.
+    request = recaptchaenterprise_v1.ListKeysRequest()
+    request.parent = project_name
+
+    response = client.list_keys(request)
+    print("Listing reCAPTCHA site keys: ")
+    for i, key in enumerate(response):
+        print(f"{str(i)}. {key.name}")
+
+
+# [END recaptcha_enterprise_list_site_keys]
+
+
+if __name__ == "__main__":
+    import google.auth
+    import google.auth.exceptions
+
+    # TODO(developer): Replace the below variables before running
+    try:
+        default_project_id = google.auth.default()[1]
+    except google.auth.exceptions.DefaultCredentialsError:
+        print(
+            "Please use `gcloud auth application-default login` "
+            "or set GOOGLE_APPLICATION_CREDENTIALS to use this script."
+        )
+    else:
+        list_site_keys(default_project_id)
diff --git a/recaptcha_enterprise/snippets/noxfile_config.py b/recaptcha_enterprise/snippets/noxfile_config.py
@@ -0,0 +1,38 @@
+# Copyright 2021 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.
+
+# Default TEST_CONFIG_OVERRIDE for python repos.
+
+# You can copy this file into your directory, then it will be imported from
+# the noxfile.py.
+
+# The source of truth:
+# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/noxfile_config.py
+
+TEST_CONFIG_OVERRIDE = {
+    # You can opt out from the test for specific Python versions.
+    "ignored_versions": ["2.7"],
+    # Old samples are opted out of enforcing Python type hints
+    # All new samples should feature them
+    "enforce_type_hints": True,
+    # An envvar key for determining the project id to use. Change it
+    # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
+    # build specific Cloud project. You can also use your own string
+    # to use your own Cloud project.
+    # "gcloud_project_env": "GOOGLE_CLOUD_PROJECT",
+    "gcloud_project_env": "BUILD_SPECIFIC_GCLOUD_PROJECT",
+    # A dictionary you want to inject into your test. Don't put any
+    # secrets here. These values will override predefined values.
+    "envs": {},
+}
diff --git a/recaptcha_enterprise/snippets/requirements-test.txt b/recaptcha_enterprise/snippets/requirements-test.txt
@@ -0,0 +1,4 @@
+selenium==3.141.0
+Flask==2.0.1
+pytest==6.2.4
+pytest-flask==1.2.0
diff --git a/recaptcha_enterprise/snippets/requirements.txt b/recaptcha_enterprise/snippets/requirements.txt
@@ -0,0 +1 @@
+google-cloud-recaptcha-enterprise==1.0.0
diff --git a/recaptcha_enterprise/snippets/templates/index.html b/recaptcha_enterprise/snippets/templates/index.html
diff --git a/recaptcha_enterprise/snippets/test_create_assessment.py b/recaptcha_enterprise/snippets/test_create_assessment.py
diff --git a/recaptcha_enterprise/snippets/test_site_key.py b/recaptcha_enterprise/snippets/test_site_key.py
diff --git a/recaptcha_enterprise/snippets/update_site_key.py b/recaptcha_enterprise/snippets/update_site_key.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+google-cloud-recaptcha-enterprise==1.0.0`