update to follow Node.js samples

Author: alixhami

dlp/dlp_inspect_image_file.py

@@ -0,0 +1,64 @@
+# Copyright 2018 Google Inc.
+#
+# 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 sys
+
+# [START dlp_inspect_text_file]
+# Import the Google Cloud Data Loss Prevention library
+import google.cloud.dlp
+
+
+def inspect_image_file(project_id='YOUR_PROJECT_ID',
+                       filepath='path/to/image.png'):
+    # Instantiate a client
+    dlp = google.cloud.dlp.DlpServiceClient()
+
+    # Get the bytes of the file
+    with open(filepath, mode='rb') as f:
+        item = {'byte_item': {'type': 'IMAGE', 'data': f.read()}}
+
+    # Construct the configuration
+    inspect_config = {
+        # The infoTypes of information to match
+        'info_types': [
+            {'name': 'PHONE_NUMBER'},
+            {'name': 'EMAIL_ADDRESS'},
+            {'name': 'CREDIT_CARD_NUMBER'},
+        ],
+        # Whether to include the matching string
+        'include_quote': True,
+    }
+
+    # Convert the project id into a full resource id
+    parent = dlp.project_path(project_id)
+
+    # Call the API
+    response = dlp.inspect_content(parent, inspect_config, item)
+
+    # Print out the results
+    if response.result.findings:
+        for finding in response.result.findings:
+            try:
+                if finding.quote:
+                    print('Quote: {}'.format(finding.quote))
+            except AttributeError:
+                pass
+            print('Info type: {}'.format(finding.info_type.name))
+            print('Likelihood: {}'.format(finding.likelihood))
+    else:
+        print('No findings.')
+# [END dlp_inspect_text_file]
+
+
+if __name__ == '__main__':
+    inspect_image_file(project_id=sys.argv[1], filepath=sys.argv[2])

dlp/dlp_inspect_file_test.py dlp/dlp_inspect_image_file_test.pydlp/dlp_inspect_file_test.py renamed to dlp/dlp_inspect_image_file_test.py

@@ -11,11 +11,18 @@
 # 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 subprocess
+import sys
 
 
-def test_inspect_file(capsys):
-    import dlp_inspect_file
+def test_inspect_image_file():
+    base_filepath = os.path.dirname(__file__)
+    snippet_filepath = os.path.join(base_filepath, 'dlp_inspect_image_file.py')
+    resource_filepath = os.path.join(base_filepath, 'resources', 'test.png')
+    project_id = os.getenv('GOOGLE_CLOUD_PROJECT')
 
-    dlp_inspect_file.inspect_file()
-    out, _ = capsys.readouterr()
-    assert 'Info type: EMAIL_ADDRESS' in out
+    out = subprocess.check_output(
+        [sys.executable, snippet_filepath, project_id, resource_filepath])
+
+    assert 'Info type: EMAIL_ADDRESS' in str(out)

dlp/dlp_inspect_string.py

@@ -11,18 +11,18 @@
 # 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 sys
 
 # [START dlp_inspect_string]
-import os
-
-# Import the client library.
+# Import the Google Cloud Data Loss Prevention library
 import google.cloud.dlp
 
 
-def inspect_string():
-    # Instantiate a client.
+def inspect_string(project_id='YOUR_PROJECT_ID'):
+    # Instantiate a client
     dlp = google.cloud.dlp.DlpServiceClient()
 
+    # Construct the configuration
     inspect_config = {
         # The infoTypes of information to match
         'info_types': [
@@ -34,20 +34,16 @@ def inspect_string():
         'include_quote': True,
     }
 
-    # Construct the `item`.
-    content_string = 'My name is Gary Smith and my email is [email protected]'
-    item = {'value': content_string}
+    # Construct the `item`
+    item = {'value': 'My name is Gary Smith and my email is [email protected]'}
 
-    # Convert the project id into a full resource id.
-    # Before running this code, replace 'YOUR_PROJECT_ID' with your project ID
-    # or set the GOOGLE_CLOUD_PROJECT environment variable to your project ID.
-    project_id = os.getenv('GOOGLE_CLOUD_PROJECT') or 'YOUR_PROJECT_ID'
+    # Convert the project id into a full resource id
     parent = dlp.project_path(project_id)
 
-    # Call the API.
+    # Call the API
     response = dlp.inspect_content(parent, inspect_config, item)
 
-    # Print out the results.
+    # Print out the results
     if response.result.findings:
         for finding in response.result.findings:
             try:
@@ -63,4 +59,4 @@ def inspect_string():
 
 
 if __name__ == '__main__':
-    inspect_string()
+    inspect_string(project_id=sys.argv[1])

dlp/dlp_inspect_string_test.py

@@ -11,11 +11,17 @@
 # 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 subprocess
+import sys
 
 
-def test_inspect_file(capsys):
-    import dlp_inspect_string
+def test_inspect_string():
+    snippet_filepath = os.path.join(
+        os.path.dirname(__file__), 'dlp_inspect_string.py')
+    project_id = os.getenv('GOOGLE_CLOUD_PROJECT')
 
-    dlp_inspect_string.inspect_string()
-    out, _ = capsys.readouterr()
-    assert 'Info type: EMAIL_ADDRESS' in out
+    out = subprocess.check_output(
+        [sys.executable, snippet_filepath, project_id])
+
+    assert 'Info type: EMAIL_ADDRESS' in str(out)

dlp/dlp_inspect_file.py dlp/dlp_inspect_text_file.pydlp/dlp_inspect_file.py renamed to dlp/dlp_inspect_text_file.py

@@ -11,18 +11,23 @@
 # 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 sys
 
-# [START dlp_inspect_string]
-import os
-
-# Import the client library.
+# [START dlp_inspect_text_file]
+# Import the Google Cloud Data Loss Prevention library
 import google.cloud.dlp
 
 
-def inspect_file():
-    # Instantiate a client.
+def inspect_text_file(project_id='YOUR_PROJECT_ID',
+                      filepath='path/to/file.txt'):
+    # Instantiate a client
     dlp = google.cloud.dlp.DlpServiceClient()
 
+    # Get the bytes of the file
+    with open(filepath, mode='rb') as f:
+        item = {'byte_item': {'type': 'TEXT_UTF8', 'data': f.read()}}
+
+    # Construct the configuration
     inspect_config = {
         # The infoTypes of information to match
         'info_types': [
@@ -34,23 +39,13 @@ def inspect_file():
         'include_quote': True,
     }
 
-    # Construct the item, containing the file's byte data.
-    # Before running this code, replace the filename with your filepath
-    filename = os.path.join(
-        os.path.dirname(__file__), 'resources', 'test.txt')
-    with open(filename, mode='rb') as f:
-        item = {'byte_item': {'type': 'TEXT_UTF8', 'data': f.read()}}
-
-    # Convert the project id into a full resource id.
-    # Before running this code, replace 'YOUR_PROJECT_ID' with your project ID
-    # or set the GOOGLE_CLOUD_PROJECT environment variable to your project ID.
-    project_id = os.getenv('GOOGLE_CLOUD_PROJECT') or 'YOUR_PROJECT_ID'
+    # Convert the project id into a full resource id
     parent = dlp.project_path(project_id)
 
-    # Call the API.
+    # Call the API
     response = dlp.inspect_content(parent, inspect_config, item)
 
-    # Print out the results.
+    # Print out the results
     if response.result.findings:
         for finding in response.result.findings:
             try:
@@ -62,8 +57,8 @@ def inspect_file():
             print('Likelihood: {}'.format(finding.likelihood))
     else:
         print('No findings.')
-# [END dlp_inspect_string]
+# [END dlp_inspect_text_file]
 
 
 if __name__ == '__main__':
-    inspect_file()
+    inspect_text_file(project_id=sys.argv[1], filepath=sys.argv[2])

dlp/dlp_inspect_text_file_test.py

@@ -0,0 +1,29 @@
+# Copyright 2018 Google Inc.
+#
+# 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 subprocess
+import sys
+
+
+def test_inspect_text_file():
+    base_filepath = os.path.dirname(__file__)
+    snippet_filepath = os.path.join(base_filepath, 'dlp_inspect_text_file.py')
+    resource_filepath = os.path.join(base_filepath, 'resources', 'test.txt')
+    project_id = os.getenv('GOOGLE_CLOUD_PROJECT')
+
+    out = subprocess.check_output(
+        [sys.executable, snippet_filepath, project_id, resource_filepath])
+
+    assert 'Info type: PHONE_NUMBER' in str(out)
+    assert 'Info type: EMAIL_ADDRESS' in str(out)