google-cloud-dlp 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcc81bb0a2b4753432c038d93307838dc545cdabdda2544beb78320d3922cbc3
-  data.tar.gz: 2a15cabe4ab989bc69861b25b5032fc98bed56b7babc4995347451a7d2503471
+  metadata.gz: 559657b5842795388714a124ef772a8ed27dfa5ba29e83825e67ddc34c50f58e
+  data.tar.gz: 06dcee2a5d5074147f2d414454fe7e067d28db8f123c8b0b80c4e40398ad65b2
 SHA512:
-  metadata.gz: 4a1eff0b603412e445ff882053ac8bda3770990d58e60e91ba0f42cfc882063aa91ca6eab8ff2f292c71b0b9c2b7d44d7133f6c242d672bc7d6c05d4abc469a4
-  data.tar.gz: a064b60fa58be23da0d4b9ecb13db8bf186af68b1aee94f6a7cba4db6e0a4aea1e44e993d5f9df7663ab71d19a04167939c412bb78ff93df2787fddf85a60a39
+  metadata.gz: e7c7a8631d727a848f421e29597969a91417a9cd027bd6f8ef3933f38f995dc7af7b948c8e313f789ec8f663d6ad38f92a1a23be827c4471876d8e92b6bf06e9
+  data.tar.gz: f43f65d72a13dd210906412363127f2bbec6ea868a683760e615af16aae2a047a48c2ea25451438e3d1b1b64ca85db4dfb3c0da5886921057deaec226fc2ba8c

data/.yardopts

@@ -7,3 +7,5 @@
 ./lib/**/*.rb
 -
 README.md
+AUTHENTICATION.md
+LICENSE

data/AUTHENTICATION.md

@@ -0,0 +1,199 @@
+# Authentication
+
+In general, the google-cloud-dlp library uses [Service
+Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+credentials to connect to Google Cloud services. When running within [Google
+Cloud Platform environments](#google-cloud-platform-environments)
+the credentials will be discovered automatically. When running on other
+environments, the Service Account credentials can be specified by providing the
+path to the [JSON
+keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
+the account (or the JSON itself) in [environment
+variables](#environment-variables). Additionally, Cloud SDK credentials can also
+be discovered automatically, but this is only recommended during development.
+
+## Quickstart
+
+1. [Create a service account and credentials](#creating-a-service-account).
+2. Set the [environment variable](#environment-variables).
+
+```sh
+export DLP_CREDENTIALS=/path/to/json`
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/dlp"
+
+client = Google::Cloud::Dlp.new
+```
+
+## Project and Credential Lookup
+
+The google-cloud-dlp library aims to make authentication
+as simple as possible, and provides several mechanisms to configure your system
+without providing **Project ID** and **Service Account Credentials** directly in
+code.
+
+**Project ID** is discovered in the following order:
+
+1. Specify project ID in method arguments
+2. Specify project ID in configuration
+3. Discover project ID in environment variables
+4. Discover GCE project ID
+5. Discover project ID in credentials JSON
+
+**Credentials** are discovered in the following order:
+
+1. Specify credentials in method arguments
+2. Specify credentials in configuration
+3. Discover credentials path in environment variables
+4. Discover credentials JSON in environment variables
+5. Discover credentials file in the Cloud SDK's path
+6. Discover GCE credentials
+
+### Google Cloud Platform environments
+
+While running on Google Cloud Platform environments such as Google Compute
+Engine, Google App Engine and Google Kubernetes Engine, no extra work is needed.
+The **Project ID** and **Credentials** and are discovered automatically. Code
+should be written as if already authenticated. Just be sure when you [set up the
+GCE instance][gce-how-to], you add the correct scopes for the APIs you want to
+access. For example:
+
+  * **All APIs**
+    * `https://www.googleapis.com/auth/cloud-platform`
+    * `https://www.googleapis.com/auth/cloud-platform.read-only`
+  * **BigQuery**
+    * `https://www.googleapis.com/auth/bigquery`
+    * `https://www.googleapis.com/auth/bigquery.insertdata`
+  * **Compute Engine**
+    * `https://www.googleapis.com/auth/compute`
+  * **Datastore**
+    * `https://www.googleapis.com/auth/datastore`
+    * `https://www.googleapis.com/auth/userinfo.email`
+  * **DNS**
+    * `https://www.googleapis.com/auth/ndev.clouddns.readwrite`
+  * **Pub/Sub**
+    * `https://www.googleapis.com/auth/pubsub`
+  * **Storage**
+    * `https://www.googleapis.com/auth/devstorage.full_control`
+    * `https://www.googleapis.com/auth/devstorage.read_only`
+    * `https://www.googleapis.com/auth/devstorage.read_write`
+
+### Environment Variables
+
+The **Project ID** and **Credentials JSON** can be placed in environment
+variables instead of declaring them directly in code. Each service has its own
+environment variable, allowing for different service accounts to be used for
+different services. (See the READMEs for the individual service gems for
+details.) The path to the **Credentials JSON** file can be stored in the
+environment variable, or the **Credentials JSON** itself can be stored for
+environments such as Docker containers where writing files is difficult or not
+encouraged.
+
+The environment variables that google-cloud-dlp checks for project ID are:
+
+1. `DLP_PROJECT`
+2. `GOOGLE_CLOUD_PROJECT`
+
+The environment variables that google-cloud-dlp checks for credentials are configured on {Google::Cloud::Dlp::V2::Credentials}:
+
+1. `DLP_CREDENTIALS` - Path to JSON file, or JSON contents
+2. `DLP_KEYFILE` - Path to JSON file, or JSON contents
+3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/cloud/dlp"
+
+ENV["DLP_PROJECT"]     = "my-project-id"
+ENV["DLP_CREDENTIALS"] = "path/to/keyfile.json"
+
+client = Google::Cloud::Dlp.new
+```
+
+### Configuration
+
+The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+
+```ruby
+require "google/cloud/dlp"
+
+Google::Cloud::Dlp.configure do |config|
+  config.project_id  = "my-project-id"
+  config.credentials = "path/to/keyfile.json"
+end
+
+client = Google::Cloud::Dlp.new
+```
+
+### Cloud SDK
+
+This option allows for an easy way to authenticate during development. If
+credentials are not provided in code or in environment variables, then Cloud SDK
+credentials are discovered.
+
+To configure your system for this, simply:
+
+1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
+2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+3. Write code as if already authenticated.
+
+**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
+*should* only be used during development.
+
+[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
+[dev-console]: https://console.cloud.google.com/project
+
+[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
+
+[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
+[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
+[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
+
+## Creating a Service Account
+
+Google Cloud requires a **Project ID** and **Service Account Credentials** to
+connect to the APIs. You will use the **Project ID** and **JSON key file** to
+connect to most services with google-cloud-dlp.
+
+If you are not running this client within [Google Cloud Platform
+environments](#google-cloud-platform-environments), you need a Google
+Developers service account.
+
+1. Visit the [Google Developers Console][dev-console].
+1. Create a new project or click on an existing project.
+1. Activate the slide-out navigation tray and select **API Manager**. From
+   here, you will enable the APIs that your application requires.
+
+   ![Enable the APIs that your application requires][enable-apis]
+
+   *Note: You may need to enable billing in order to use these services.*
+
+1. Select **Credentials** from the side navigation.
+
+   You should see a screen like one of the following.
+
+   ![Create a new service account][create-new-service-account]
+
+   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
+
+   Find the "Add credentials" drop down and select "Service account" to be
+   guided through downloading a new JSON key file.
+
+   If you want to re-use an existing service account, you can easily generate a
+   new key file. Just select the account you wish to re-use, and click "Generate
+   new JSON key":
+
+   ![Re-use an existing service account][reuse-service-account]
+
+   The key file you download will be used by this library to authenticate API
+   requests and should be stored in a secure location.
+
+## Troubleshooting
+
+If you're having trouble authenticating you can ask for help by following the
+{file:TROUBLESHOOTING.md Troubleshooting Guide}.

data/lib/google/cloud/dlp/v2/dlp_service_client.rb

@@ -91,6 +91,12 @@ module Google
           ].freeze
 
 
+          DLP_JOB_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/dlpJobs/{dlp_job}"
+          )
+
+          private_constant :DLP_JOB_PATH_TEMPLATE
+
           ORGANIZATION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "organizations/{organization}"
           )
@@ -103,29 +109,17 @@ module Google
 
           private_constant :ORGANIZATION_DEIDENTIFY_TEMPLATE_PATH_TEMPLATE
 
-          PROJECT_DEIDENTIFY_TEMPLATE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/deidentifyTemplates/{deidentify_template}"
-          )
-
-          private_constant :PROJECT_DEIDENTIFY_TEMPLATE_PATH_TEMPLATE
-
           ORGANIZATION_INSPECT_TEMPLATE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "organizations/{organization}/inspectTemplates/{inspect_template}"
           )
 
           private_constant :ORGANIZATION_INSPECT_TEMPLATE_PATH_TEMPLATE
 
-          PROJECT_INSPECT_TEMPLATE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/inspectTemplates/{inspect_template}"
-          )
-
-          private_constant :PROJECT_INSPECT_TEMPLATE_PATH_TEMPLATE
-
-          PROJECT_JOB_TRIGGER_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/jobTriggers/{job_trigger}"
+          ORGANIZATION_STORED_INFO_TYPE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "organizations/{organization}/storedInfoTypes/{stored_info_type}"
           )
 
-          private_constant :PROJECT_JOB_TRIGGER_PATH_TEMPLATE
+          private_constant :ORGANIZATION_STORED_INFO_TYPE_PATH_TEMPLATE
 
           PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}"
@@ -133,17 +127,23 @@ module Google
 
           private_constant :PROJECT_PATH_TEMPLATE
 
-          DLP_JOB_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/dlpJobs/{dlp_job}"
+          PROJECT_DEIDENTIFY_TEMPLATE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/deidentifyTemplates/{deidentify_template}"
           )
 
-          private_constant :DLP_JOB_PATH_TEMPLATE
+          private_constant :PROJECT_DEIDENTIFY_TEMPLATE_PATH_TEMPLATE
 
-          ORGANIZATION_STORED_INFO_TYPE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "organizations/{organization}/storedInfoTypes/{stored_info_type}"
+          PROJECT_INSPECT_TEMPLATE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/inspectTemplates/{inspect_template}"
           )
 
-          private_constant :ORGANIZATION_STORED_INFO_TYPE_PATH_TEMPLATE
+          private_constant :PROJECT_INSPECT_TEMPLATE_PATH_TEMPLATE
+
+          PROJECT_JOB_TRIGGER_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/jobTriggers/{job_trigger}"
+          )
+
+          private_constant :PROJECT_JOB_TRIGGER_PATH_TEMPLATE
 
           PROJECT_STORED_INFO_TYPE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}/storedInfoTypes/{stored_info_type}"
@@ -151,6 +151,17 @@ module Google
 
           private_constant :PROJECT_STORED_INFO_TYPE_PATH_TEMPLATE
 
+          # Returns a fully-qualified dlp_job resource name string.
+          # @param project [String]
+          # @param dlp_job [String]
+          # @return [String]
+          def self.dlp_job_path project, dlp_job
+            DLP_JOB_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"dlp_job" => dlp_job
+            )
+          end
+
           # Returns a fully-qualified organization resource name string.
           # @param organization [String]
           # @return [String]
@@ -171,17 +182,6 @@ module Google
             )
           end
 
-          # Returns a fully-qualified project_deidentify_template resource name string.
-          # @param project [String]
-          # @param deidentify_template [String]
-          # @return [String]
-          def self.project_deidentify_template_path project, deidentify_template
-            PROJECT_DEIDENTIFY_TEMPLATE_PATH_TEMPLATE.render(
-              :"project" => project,
-              :"deidentify_template" => deidentify_template
-            )
-          end
-
           # Returns a fully-qualified organization_inspect_template resource name string.
           # @param organization [String]
           # @param inspect_template [String]
@@ -193,56 +193,56 @@ module Google
             )
           end
 
-          # Returns a fully-qualified project_inspect_template resource name string.
-          # @param project [String]
-          # @param inspect_template [String]
+          # Returns a fully-qualified organization_stored_info_type resource name string.
+          # @param organization [String]
+          # @param stored_info_type [String]
           # @return [String]
-          def self.project_inspect_template_path project, inspect_template
-            PROJECT_INSPECT_TEMPLATE_PATH_TEMPLATE.render(
-              :"project" => project,
-              :"inspect_template" => inspect_template
+          def self.organization_stored_info_type_path organization, stored_info_type
+            ORGANIZATION_STORED_INFO_TYPE_PATH_TEMPLATE.render(
+              :"organization" => organization,
+              :"stored_info_type" => stored_info_type
             )
           end
 
-          # Returns a fully-qualified project_job_trigger resource name string.
+          # Returns a fully-qualified project resource name string.
           # @param project [String]
-          # @param job_trigger [String]
           # @return [String]
-          def self.project_job_trigger_path project, job_trigger
-            PROJECT_JOB_TRIGGER_PATH_TEMPLATE.render(
-              :"project" => project,
-              :"job_trigger" => job_trigger
+          def self.project_path project
+            PROJECT_PATH_TEMPLATE.render(
+              :"project" => project
             )
           end
 
-          # Returns a fully-qualified project resource name string.
+          # Returns a fully-qualified project_deidentify_template resource name string.
           # @param project [String]
+          # @param deidentify_template [String]
           # @return [String]
-          def self.project_path project
-            PROJECT_PATH_TEMPLATE.render(
-              :"project" => project
+          def self.project_deidentify_template_path project, deidentify_template
+            PROJECT_DEIDENTIFY_TEMPLATE_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"deidentify_template" => deidentify_template
             )
           end
 
-          # Returns a fully-qualified dlp_job resource name string.
+          # Returns a fully-qualified project_inspect_template resource name string.
           # @param project [String]
-          # @param dlp_job [String]
+          # @param inspect_template [String]
           # @return [String]
-          def self.dlp_job_path project, dlp_job
-            DLP_JOB_PATH_TEMPLATE.render(
+          def self.project_inspect_template_path project, inspect_template
+            PROJECT_INSPECT_TEMPLATE_PATH_TEMPLATE.render(
               :"project" => project,
-              :"dlp_job" => dlp_job
+              :"inspect_template" => inspect_template
             )
           end
 
-          # Returns a fully-qualified organization_stored_info_type resource name string.
-          # @param organization [String]
-          # @param stored_info_type [String]
+          # Returns a fully-qualified project_job_trigger resource name string.
+          # @param project [String]
+          # @param job_trigger [String]
           # @return [String]
-          def self.organization_stored_info_type_path organization, stored_info_type
-            ORGANIZATION_STORED_INFO_TYPE_PATH_TEMPLATE.render(
-              :"organization" => organization,
-              :"stored_info_type" => stored_info_type
+          def self.project_job_trigger_path project, job_trigger
+            PROJECT_JOB_TRIGGER_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"job_trigger" => job_trigger
             )
           end
 

data/lib/google/cloud/dlp/v2/doc/google/protobuf/any.rb

@@ -97,7 +97,8 @@ module Google
     # @!attribute [rw] type_url
     #   @return [String]
     #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. The last segment of the URL's path must represent
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
     #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).

data/lib/google/cloud/dlp/v2/doc/google/protobuf/field_mask.rb

@@ -83,57 +83,49 @@ module Google
     # describe the updated values, the API ignores the values of all
     # fields not covered by the mask.
     #
-    # If a repeated field is specified for an update operation, the existing
-    # repeated values in the target resource will be overwritten by the new values.
-    # Note that a repeated field is only allowed in the last position of a `paths`
-    # string.
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
     #
     # If a sub-message is specified in the last position of the field mask for an
-    # update operation, then the existing sub-message in the target resource is
-    # overwritten. Given the target message:
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
     #
     #     f {
     #       b {
-    #         d : 1
-    #         x : 2
+    #         d: 1
+    #         x: 2
     #       }
-    #       c : 1
+    #       c: [1]
     #     }
     #
     # And an update message:
     #
     #     f {
     #       b {
-    #         d : 10
+    #         d: 10
     #       }
+    #       c: [2]
     #     }
     #
     # then if the field mask is:
     #
-    #  paths: "f.b"
+    #  paths: ["f.b", "f.c"]
     #
     # then the result will be:
     #
     #     f {
     #       b {
-    #         d : 10
+    #         d: 10
+    #         x: 2
     #       }
-    #       c : 1
+    #       c: [1, 2]
     #     }
     #
-    # However, if the update mask was:
-    #
-    #  paths: "f.b.d"
-    #
-    # then the result would be:
-    #
-    #     f {
-    #       b {
-    #         d : 10
-    #         x : 2
-    #       }
-    #       c : 1
-    #     }
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
     #
     # In order to reset a field's value to the default, the field must
     # be in the mask and set to the default value in the provided resource.

data/lib/google/cloud/dlp/v2/doc/google/protobuf/timestamp.rb

@@ -15,17 +15,19 @@
 
 module Google
   module Protobuf
-    # A Timestamp represents a point in time independent of any time zone
-    # or calendar, represented as seconds and fractions of seconds at
-    # nanosecond resolution in UTC Epoch time. It is encoded using the
-    # Proleptic Gregorian Calendar which extends the Gregorian calendar
-    # backwards to year one. It is encoded assuming all minutes are 60
-    # seconds long, i.e. leap seconds are "smeared" so that no leap second
-    # table is needed for interpretation. Range is from
-    # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
-    # By restricting to that range, we ensure that we can convert to
-    # and from  RFC 3339 date strings.
-    # See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
+    # A Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+    # restricting to that range, we ensure that we can convert to and from [RFC
+    # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
     #
     # = Examples
     #
@@ -86,12 +88,12 @@ module Google
     # 01:30 UTC on January 15, 2017.
     #
     # In JavaScript, one can convert a Date object to this format using the
-    # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
+    # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
     # method. In Python, a standard `datetime.datetime` object can be converted
     # to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
     # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
     # can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
-    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
+    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
     # ) to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds
     #   @return [Integer]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dlp
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-gax
@@ -122,6 +122,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- AUTHENTICATION.md
 - LICENSE
 - README.md
 - lib/google/cloud/dlp.rb