google-cloud-error_reporting 0.31.3 → 0.31.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eb6ccf8aaf40df2e771dba9a082d755f3b790dfe506322a0a0470bb7f7c3b2d
-  data.tar.gz: 1a2501e0f238dd91f43bb1e5698dcc7d797fdfd5950c3411447bfd77c00cab18
+  metadata.gz: b04d4011c2d0cf6a81432db4dbbc4de6dde79a5b97aadaca31e8ca211ba8a1cc
+  data.tar.gz: 658a0a43042377d9c6d960774848b90a74d90a0945efd766534d0e2de0c75080
 SHA512:
-  metadata.gz: f41bd7899f505f6e646a6fdf26ef0d4222d54276c880f8c29d85e98feccf363dc526d3adad15f149fd03af9eaa7e3247b95f5151c202f60b2879bcebfbfc530f
-  data.tar.gz: 28944bbf6588ee39f5126d51e03d567f789afaaf60df6c9e3680fc03c4a0215986956e5867c1afba46438a103e937f3d6f35b25ecbd0cf19538c2102050faf55
+  metadata.gz: 66a9368231038722509e06c61f5ee0554d9a8170ad4727e91e33d412ac58913c43a9994f744239767eda6e2f7ef3066afb0efc6a38cdfc067caf5bfe4142d557
+  data.tar.gz: a912d0edb55a20440ddcfd5a939af78812f0121ee54e38800aa0ee5f2c4b3cd685aed5a6a078e291a1a3c65660b798e828840850ccfd744915986c6bf80bcdd4

data/AUTHENTICATION.md

@@ -1,21 +1,40 @@
-Error Reporting# Authentication
+# Authentication
 
 In general, the google-cloud-error_reporting library uses [Service
 Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running on Compute Engine
+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. Additionally, Cloud
-SDK credentials can also be discovered automatically, but this is only
-recommended during development.
+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 ERROR_REPORTING_CREDENTIALS=/path/to/json`
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/error_reporting"
+
+client = Google::Cloud::ErrorReporting.new
+```
 
 ## Project and Credential Lookup
 
-The google-cloud-error_reporting 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.
+The google-cloud-error_reporting 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:
 
@@ -23,6 +42,7 @@ providing **Project ID** and **Service Account Credentials** directly in code.
 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:
 
@@ -73,13 +93,12 @@ 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 Error Reporting checks for project ID are:
+The environment variables that google-cloud-error_reporting checks for project ID are:
 
 1. `ERROR_REPORTING_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that Error Reporting checks for credentials are
-configured on {Google::Cloud::ErrorReporting::V1beta1::Credentials}:
+The environment variables that google-cloud-error_reporting checks for credentials are configured on {Google::Cloud::ErrorReporting::V1beta1::Credentials}:
 
 1. `ERROR_REPORTING_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `ERROR_REPORTING_KEYFILE` - Path to JSON file, or JSON contents
@@ -93,13 +112,12 @@ require "google/cloud/error_reporting"
 ENV["ERROR_REPORTING_PROJECT"]     = "my-project-id"
 ENV["ERROR_REPORTING_CREDENTIALS"] = "path/to/keyfile.json"
 
-error_reporting = Google::Cloud::ErrorReporting.new
+client = Google::Cloud::ErrorReporting.new
 ```
 
 ### Configuration
 
-The **Project ID** and **Credentials JSON** can be configured instead of placing
-them in environment variables or providing them as arguments.
+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/error_reporting"
@@ -109,7 +127,7 @@ Google::Cloud::ErrorReporting.configure do |config|
   config.credentials = "path/to/keyfile.json"
 end
 
-error_reporting = Google::Cloud::ErrorReporting.new
+client = Google::Cloud::ErrorReporting.new
 ```
 
 ### Cloud SDK
@@ -142,7 +160,8 @@ 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-error_reporting.
 
-If you are not running this client on Google Compute Engine, you need a Google
+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].

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History
 
+### 0.31.4 / 2019-04-29
+
+* Add AUTHENTICATION.md guide.
+* Update documentation for common types.
+* Update generated code examples.
+* Extract gRPC header values from request.
+
 ### 0.31.3 / 2019-02-13
 
 * Fix bug (typo) in retrieving default on_error proc.

data/lib/google/cloud/error_reporting/async_error_reporter.rb

@@ -34,7 +34,7 @@ module Google
         attr_reader :error_event
 
         def initialize message, error_event = nil
-          super(message)
+          super message
           @error_event = error_event
         end
       end
@@ -53,7 +53,7 @@ module Google
         attr_reader :error_event
 
         def initialize message, error_event = nil
-          super(message)
+          super message
           @error_event = error_event
         end
       end
@@ -91,7 +91,7 @@ module Google
         # Add the error event to the queue. This will raise if there are no
         # resources available to make the API call.
         def report error_event
-          Concurrent::Promises.future_on(@thread_pool, error_event) do |error|
+          Concurrent::Promises.future_on @thread_pool, error_event do |error|
             report_sync error
           end
         rescue Concurrent::RejectedExecutionError => e

data/lib/google/cloud/error_reporting/error_event.rb

@@ -220,7 +220,7 @@ module Google
 
             message = "#{error_location}: #{message}\n\t" +
                       backtrace.drop(1).join("\n\t")
-            file_path, line_number, function_name = error_location.split(":")
+            file_path, line_number, function_name = error_location.split ":"
             function_name = function_name.to_s[/`(.*)'/, 1]
           end
 

data/lib/google/cloud/error_reporting/middleware.rb

@@ -147,7 +147,7 @@ module Google
           error_event.http_url = rack_request.url
           error_event.http_user_agent = rack_request.user_agent
           error_event.http_referrer = rack_request.referrer
-          error_event.http_status = http_status(exception)
+          error_event.http_status = http_status exception
           error_event.http_remote_ip = rack_request.ip
 
           error_event

data/lib/google/cloud/error_reporting/v1beta1/doc/google/devtools/clouderrorreporting/v1beta1/report_errors_service.rb

@@ -22,8 +22,9 @@ module Google
         #   @return [String]
         #     [Required] The resource name of the Google Cloud Platform project. Written
         #     as `projects/` plus the
-        #     [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).
-        #     Example: `projects/my-project-123`.
+        #     [Google Cloud Platform project
+        #     ID](https://support.google.com/cloud/answer/6158840). Example:
+        #     `projects/my-project-123`.
         # @!attribute [rw] event
         #   @return [Google::Devtools::Clouderrorreporting::V1beta1::ReportedErrorEvent]
         #     [Required] The error event to be reported.

data/lib/google/cloud/error_reporting/v1beta1/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]

data/lib/google/cloud/error_reporting/v1beta1/error_group_service_client.rb

@@ -180,12 +180,18 @@ module Google
             @get_group = Google::Gax.create_api_call(
               @error_group_service_stub.method(:get_group),
               defaults["get_group"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'group_name' => request.group_name}
+              end
             )
             @update_group = Google::Gax.create_api_call(
               @error_group_service_stub.method(:update_group),
               defaults["update_group"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'group.name' => request.group.name}
+              end
             )
           end
 
@@ -213,9 +219,9 @@ module Google
           # @example
           #   require "google/cloud/error_reporting"
           #
-          #   error_group_service_client = Google::Cloud::ErrorReporting::ErrorGroup.new(version: :v1beta1)
+          #   error_group_client = Google::Cloud::ErrorReporting::ErrorGroup.new(version: :v1beta1)
           #   formatted_group_name = Google::Cloud::ErrorReporting::V1beta1::ErrorGroupServiceClient.group_path("[PROJECT]", "[GROUP]")
-          #   response = error_group_service_client.get_group(formatted_group_name)
+          #   response = error_group_client.get_group(formatted_group_name)
 
           def get_group \
               group_name,
@@ -246,11 +252,11 @@ module Google
           # @example
           #   require "google/cloud/error_reporting"
           #
-          #   error_group_service_client = Google::Cloud::ErrorReporting::ErrorGroup.new(version: :v1beta1)
+          #   error_group_client = Google::Cloud::ErrorReporting::ErrorGroup.new(version: :v1beta1)
           #
           #   # TODO: Initialize `group`:
           #   group = {}
-          #   response = error_group_service_client.update_group(group)
+          #   response = error_group_client.update_group(group)
 
           def update_group \
               group,

data/lib/google/cloud/error_reporting/v1beta1/error_stats_service_client.rb

@@ -193,17 +193,26 @@ module Google
             @list_group_stats = Google::Gax.create_api_call(
               @error_stats_service_stub.method(:list_group_stats),
               defaults["list_group_stats"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_name' => request.project_name}
+              end
             )
             @list_events = Google::Gax.create_api_call(
               @error_stats_service_stub.method(:list_events),
               defaults["list_events"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_name' => request.project_name}
+              end
             )
             @delete_events = Google::Gax.create_api_call(
               @error_stats_service_stub.method(:delete_events),
               defaults["delete_events"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_name' => request.project_name}
+              end
             )
           end
 
@@ -273,19 +282,19 @@ module Google
           # @example
           #   require "google/cloud/error_reporting"
           #
-          #   error_stats_service_client = Google::Cloud::ErrorReporting::ErrorStats.new(version: :v1beta1)
+          #   error_stats_client = Google::Cloud::ErrorReporting::ErrorStats.new(version: :v1beta1)
           #   formatted_project_name = Google::Cloud::ErrorReporting::V1beta1::ErrorStatsServiceClient.project_path("[PROJECT]")
           #
           #   # TODO: Initialize `time_range`:
           #   time_range = {}
           #
           #   # Iterate over all results.
-          #   error_stats_service_client.list_group_stats(formatted_project_name, time_range).each do |element|
+          #   error_stats_client.list_group_stats(formatted_project_name, time_range).each do |element|
           #     # Process element.
           #   end
           #
           #   # Or iterate over results one page at a time.
-          #   error_stats_service_client.list_group_stats(formatted_project_name, time_range).each_page do |page|
+          #   error_stats_client.list_group_stats(formatted_project_name, time_range).each_page do |page|
           #     # Process each page at a time.
           #     page.each do |element|
           #       # Process element.
@@ -362,19 +371,19 @@ module Google
           # @example
           #   require "google/cloud/error_reporting"
           #
-          #   error_stats_service_client = Google::Cloud::ErrorReporting::ErrorStats.new(version: :v1beta1)
+          #   error_stats_client = Google::Cloud::ErrorReporting::ErrorStats.new(version: :v1beta1)
           #   formatted_project_name = Google::Cloud::ErrorReporting::V1beta1::ErrorStatsServiceClient.project_path("[PROJECT]")
           #
           #   # TODO: Initialize `group_id`:
           #   group_id = ''
           #
           #   # Iterate over all results.
-          #   error_stats_service_client.list_events(formatted_project_name, group_id).each do |element|
+          #   error_stats_client.list_events(formatted_project_name, group_id).each do |element|
           #     # Process element.
           #   end
           #
           #   # Or iterate over results one page at a time.
-          #   error_stats_service_client.list_events(formatted_project_name, group_id).each_page do |page|
+          #   error_stats_client.list_events(formatted_project_name, group_id).each_page do |page|
           #     # Process each page at a time.
           #     page.each do |element|
           #       # Process element.
@@ -419,9 +428,9 @@ module Google
           # @example
           #   require "google/cloud/error_reporting"
           #
-          #   error_stats_service_client = Google::Cloud::ErrorReporting::ErrorStats.new(version: :v1beta1)
+          #   error_stats_client = Google::Cloud::ErrorReporting::ErrorStats.new(version: :v1beta1)
           #   formatted_project_name = Google::Cloud::ErrorReporting::V1beta1::ErrorStatsServiceClient.project_path("[PROJECT]")
-          #   response = error_stats_service_client.delete_events(formatted_project_name)
+          #   response = error_stats_client.delete_events(formatted_project_name)
 
           def delete_events \
               project_name,

data/lib/google/cloud/error_reporting/v1beta1/report_errors_service_client.rb

@@ -178,7 +178,10 @@ module Google
             @report_error_event = Google::Gax.create_api_call(
               @report_errors_service_stub.method(:report_error_event),
               defaults["report_error_event"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_name' => request.project_name}
+              end
             )
           end
 
@@ -191,13 +194,15 @@ module Google
           # <a href="https://support.google.com/cloud/answer/6158862">API key</a>
           # for authentication. To use an API key, append it to the URL as the value of
           # a `key` parameter. For example:
-          # <pre>POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>
+          # <pre>POST
+          # https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>
           #
           # @param project_name [String]
           #   [Required] The resource name of the Google Cloud Platform project. Written
           #   as `projects/` plus the
-          #   [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).
-          #   Example: `projects/my-project-123`.
+          #   [Google Cloud Platform project
+          #   ID](https://support.google.com/cloud/answer/6158840). Example:
+          #   `projects/my-project-123`.
           # @param event [Google::Devtools::Clouderrorreporting::V1beta1::ReportedErrorEvent | Hash]
           #   [Required] The error event to be reported.
           #   A hash of the same form as `Google::Devtools::Clouderrorreporting::V1beta1::ReportedErrorEvent`
@@ -213,12 +218,12 @@ module Google
           # @example
           #   require "google/cloud/error_reporting"
           #
-          #   report_errors_service_client = Google::Cloud::ErrorReporting::ReportErrors.new(version: :v1beta1)
+          #   report_errors_client = Google::Cloud::ErrorReporting::ReportErrors.new(version: :v1beta1)
           #   formatted_project_name = Google::Cloud::ErrorReporting::V1beta1::ReportErrorsServiceClient.project_path("[PROJECT]")
           #
           #   # TODO: Initialize `event`:
           #   event = {}
-          #   response = report_errors_service_client.report_error_event(formatted_project_name, event)
+          #   response = report_errors_client.report_error_event(formatted_project_name, event)
 
           def report_error_event \
               project_name,

data/lib/google/cloud/error_reporting/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module ErrorReporting
-      VERSION = "0.31.3".freeze
+      VERSION = "0.31.4".freeze
     end
   end
 end

data/lib/google/devtools/clouderrorreporting/v1beta1/report_errors_service_services_pb.rb

@@ -41,7 +41,8 @@ module Google
             # <a href="https://support.google.com/cloud/answer/6158862">API key</a>
             # for authentication. To use an API key, append it to the URL as the value of
             # a `key` parameter. For example:
-            # <pre>POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>
+            # <pre>POST
+            # https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>
             rpc :ReportErrorEvent, ReportErrorEventRequest, ReportErrorEventResponse
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-error_reporting
 version: !ruby/object:Gem::Version
-  version: 0.31.3
+  version: 0.31.4
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: 0.64.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: 0.64.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -288,8 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: API Client library for Stackdriver Error Reporting