google-cloud-error_reporting 0.27.0 → 0.28.0

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

@@ -25,41 +25,22 @@ module Google
       # @private Represents the gRPC Error Reporting service, including all the
       #   API methods.
       class Service
-        attr_accessor :project, :credentials, :host, :timeout, :client_config
+        attr_accessor :project, :credentials, :timeout, :client_config
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials,
-                       host: nil, timeout: nil, client_config: nil
+        def initialize project, credentials, timeout: nil, client_config: nil
           @project = project
           @credentials = credentials
-          @host = host || V1beta1::ReportErrorsServiceClient::SERVICE_ADDRESS
           @timeout = timeout
           @client_config = client_config || {}
         end
 
-        def channel
-          require "grpc"
-          GRPC::Core::Channel.new host, nil, chan_creds
-        end
-
-        def chan_creds
-          require "grpc"
-          return credentials if insecure?
-          GRPC::Core::ChannelCredentials.new.compose \
-            GRPC::Core::CallCredentials.new credentials.client.updater_proc
-        end
-
-        def insecure?
-          credentials == :this_channel_is_insecure
-        end
-
         def error_reporting
           return mocked_error_reporting if mocked_error_reporting
           @error_reporting ||= \
             V1beta1::ReportErrorsServiceClient.new(
-              service_path: host,
-              channel: channel,
+              credentials: credentials,
               timeout: timeout,
               client_config: client_config,
               lib_name: "gccl",

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

@@ -15,6 +15,21 @@
 module Google
   module Devtools
     module Clouderrorreporting
+      ##
+      # # Stackdriver Error Reporting API Contents
+      #
+      # | Class | Description |
+      # | ----- | ----------- |
+      # | [ErrorGroupServiceClient][] | Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors. |
+      # | [ErrorStatsServiceClient][] | Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors. |
+      # | [ReportErrorsServiceClient][] | Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors. |
+      # | [Data Types][] | Data types for Google::Cloud::ErrorReporting::V1beta1 |
+      #
+      # [ErrorGroupServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-error_reporting/latest/google/devtools/clouderrorreporting/v1beta1/errorgroupserviceclient
+      # [ErrorStatsServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-error_reporting/latest/google/devtools/clouderrorreporting/v1beta1/errorstatsserviceclient
+      # [ReportErrorsServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-error_reporting/latest/google/devtools/clouderrorreporting/v1beta1/reporterrorsserviceclient
+      # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-error_reporting/latest/google/devtools/clouderrorreporting/v1beta1/datatypes
+      #
       module V1beta1
         # Specifies a set of +ErrorGroupStats+ to return.
         # @!attribute [rw] project_name
@@ -114,9 +129,9 @@ module Google
         #     Approximate number of occurrences over time.
         #     Timed counts returned by ListGroups are guaranteed to be:
         #
-        #     - Inside the requested time interval
-        #     - Non-overlapping, and
-        #     - Ordered by ascending time.
+        #     * Inside the requested time interval
+        #     * Non-overlapping, and
+        #     * Ordered by ascending time.
         # @!attribute [rw] first_seen_time
         #   @return [Google::Protobuf::Timestamp]
         #     Approximate first occurrence that was ever seen for this group
@@ -164,8 +179,8 @@ 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].
+        #     [Google Cloud Platform project
+        #     ID](https://support.google.com/cloud/answer/6158840).
         #     Example: +projects/my-project-123+.
         # @!attribute [rw] group_id
         #   @return [String]
@@ -242,15 +257,15 @@ module Google
         # @!attribute [rw] service
         #   @return [String]
         #     [Optional] The exact value to match against
-        #     {+ServiceContext.service+}[https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service].
+        #     [+ServiceContext.service+](https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
         # @!attribute [rw] version
         #   @return [String]
         #     [Optional] The exact value to match against
-        #     {+ServiceContext.version+}[https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version].
+        #     [+ServiceContext.version+](https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
         # @!attribute [rw] resource_type
         #   @return [String]
         #     [Optional] The exact value to match against
-        #     {+ServiceContext.resource_type+}[https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type].
+        #     [+ServiceContext.resource_type+](https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
         class ServiceContextFilter; end
 
         # Deletes all events in the project.
@@ -258,8 +273,8 @@ 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].
+        #     [Google Cloud Platform project
+        #     ID](https://support.google.com/cloud/answer/6158840).
         #     Example: +projects/my-project-123+.
         class DeleteEventsRequest; end
 

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

@@ -15,13 +15,28 @@
 module Google
   module Devtools
     module Clouderrorreporting
+      ##
+      # # Stackdriver Error Reporting API Contents
+      #
+      # | Class | Description |
+      # | ----- | ----------- |
+      # | [ErrorGroupServiceClient][] | Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors. |
+      # | [ErrorStatsServiceClient][] | Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors. |
+      # | [ReportErrorsServiceClient][] | Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors. |
+      # | [Data Types][] | Data types for Google::Cloud::ErrorReporting::V1beta1 |
+      #
+      # [ErrorGroupServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-error_reporting/latest/google/devtools/clouderrorreporting/v1beta1/errorgroupserviceclient
+      # [ErrorStatsServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-error_reporting/latest/google/devtools/clouderrorreporting/v1beta1/errorstatsserviceclient
+      # [ReportErrorsServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-error_reporting/latest/google/devtools/clouderrorreporting/v1beta1/reporterrorsserviceclient
+      # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-error_reporting/latest/google/devtools/clouderrorreporting/v1beta1/datatypes
+      #
       module V1beta1
         # A request for reporting an individual error event.
         # @!attribute [rw] project_name
         #   @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].
+        #     [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]

data/lib/google/cloud/error_reporting/v1beta1/doc/google/protobuf/duration.rb

@@ -21,6 +21,8 @@ module Google
     # two Timestamp values is a Duration and it can be added or subtracted
     # from a Timestamp. Range is approximately +-10,000 years.
     #
+    # = Examples
+    #
     # Example 1: Compute Duration from two Timestamps in pseudo code.
     #
     #     Timestamp start = ...;
@@ -60,10 +62,21 @@ module Google
     #     td = datetime.timedelta(days=3, minutes=10)
     #     duration = Duration()
     #     duration.FromTimedelta(td)
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
     # @!attribute [rw] seconds
     #   @return [Integer]
     #     Signed seconds of the span of time. Must be from -315,576,000,000
-    #     to +315,576,000,000 inclusive.
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
     # @!attribute [rw] nanos
     #   @return [Integer]
     #     Signed fractions of a second at nanosecond resolution of the span

data/lib/google/cloud/error_reporting/v1beta1/doc/google/protobuf/timestamp.rb

@@ -24,7 +24,9 @@ module Google
     # 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].
+    # See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
+    #
+    # = Examples
     #
     # Example 1: Compute Timestamp from POSIX +time()+.
     #
@@ -65,6 +67,29 @@ module Google
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Timestamp type is encoded as a string in the
+    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+    # format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
+    # where {year} is always expressed using four digits while {month}, {day},
+    # {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+    # is required, though only UTC (as indicated by "Z") is presently supported.
+    #
+    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+    # 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]
+    # 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://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime())
+    # to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds
     #   @return [Integer]
     #     Represents seconds of UTC time since Unix epoch

data/lib/google/cloud/error_reporting/v1beta1/doc/overview.rb

@@ -0,0 +1,82 @@
+# Copyright 2017, 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.
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Stackdriver Error Reporting API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Stackdriver Error Reporting API][Product Documentation]:
+    # Stackdriver Error Reporting groups and counts similar errors from cloud
+    # services. The Stackdriver Error Reporting API provides a way to report new
+    # errors and read access to error groups and their associated errors.
+    # - [Product Documentation][]
+    #
+    # ## 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.](https://console.cloud.google.com/project)
+    # 2. [Enable the Stackdriver Error Reporting API.](https://console.cloud.google.com/apis/api/error-reporting)
+    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-cloud-error_reporting
+    # ```
+    #
+    # ### Preview
+    # #### ReportErrorsServiceClient
+    # ```rb
+    # require "google/cloud/error_reporting"
+    #
+    # report_errors_service_client = Google::Cloud::ErrorReporting::ReportErrors.new
+    # formatted_project_name = Google::Cloud::ErrorReporting::V1beta1::ReportErrorsServiceClient.project_path(project_id)
+    # message = "[MESSAGE]"
+    # service = "[SERVICE]"
+    # service_context = { service: service }
+    # file_path = "path/to/file.lang"
+    # line_number = 42
+    # function_name = "meaningOfLife"
+    # report_location = {
+    #   file_path: file_path,
+    #   line_number: line_number,
+    #   function_name: function_name
+    # }
+    # context = { report_location: report_location }
+    # event = {
+    #   message: message,
+    #   service_context: service_context,
+    #   context: context
+    # }
+    # response = report_errors_service_client.report_error_event(formatted_project_name, event)
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Stackdriver Error Reporting API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/error-reporting
+    #
+    #
+    module ErrorReporting
+      module V1beta1
+      end
+    end
+  end
+end

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

@@ -28,6 +28,7 @@ require "pathname"
 require "google/gax"
 
 require "google/devtools/clouderrorreporting/v1beta1/error_group_service_pb"
+require "google/cloud/error_reporting/credentials"
 
 module Google
   module Cloud
@@ -71,29 +72,24 @@ module Google
             )
           end
 
-          # Parses the project from a group resource.
-          # @param group_name [String]
-          # @return [String]
-          def self.match_project_from_group_name group_name
-            GROUP_PATH_TEMPLATE.match(group_name)["project"]
-          end
-
-          # Parses the group from a group resource.
-          # @param group_name [String]
-          # @return [String]
-          def self.match_group_from_group_name group_name
-            GROUP_PATH_TEMPLATE.match(group_name)["group"]
-          end
-
-          # @param service_path [String]
-          #   The domain name of the API remote host.
-          # @param port [Integer]
-          #   The port on which to connect to the remote host.
-          # @param channel [Channel]
-          #   A Channel object through which to make calls.
-          # @param chan_creds [Grpc::ChannelCredentials]
-          #   A ChannelCredentials for the setting up the RPC client.
-          # @param client_config[Hash]
+          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+          #   Provides the means for authenticating requests made by the client. This parameter can
+          #   be many types.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
+          # @param client_config [Hash]
           #   A Hash for call options for each method. See
           #   Google::Gax#construct_settings for the structure of
           #   this data. Falls back to the default config if not specified
@@ -105,11 +101,11 @@ module Google
               port: DEFAULT_SERVICE_PORT,
               channel: nil,
               chan_creds: nil,
+              updater_proc: nil,
+              credentials: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
-              app_name: nil,
-              app_version: nil,
               lib_name: nil,
               lib_version: ""
             # These require statements are intentionally placed here to initialize
@@ -118,14 +114,38 @@ module Google
             require "google/gax/grpc"
             require "google/devtools/clouderrorreporting/v1beta1/error_group_service_services_pb"
 
+            if channel || chan_creds || updater_proc
+              warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
+                "on 2017/09/08"
+              credentials ||= channel
+              credentials ||= chan_creds
+              credentials ||= updater_proc
+            end
+            if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
+              warn "`service_path` and `port` parameters are deprecated and will be removed"
+            end
+
+            credentials ||= Google::Cloud::ErrorReporting::Credentials.default
 
-            if app_name || app_version
-              warn "`app_name` and `app_version` are no longer being used in the request headers."
+            if credentials.is_a?(String) || credentials.is_a?(Hash)
+              updater_proc = Google::Cloud::ErrorReporting::Credentials.new(credentials).updater_proc
+            end
+            if credentials.is_a?(GRPC::Core::Channel)
+              channel = credentials
+            end
+            if credentials.is_a?(GRPC::Core::ChannelCredentials)
+              chan_creds = credentials
+            end
+            if credentials.is_a?(Proc)
+              updater_proc = credentials
+            end
+            if credentials.is_a?(Google::Auth::Credentials)
+              updater_proc = credentials.updater_proc
             end
 
             google_api_client = "gl-ruby/#{RUBY_VERSION}"
             google_api_client << " #{lib_name}/#{lib_version}" if lib_name
-            google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
+            google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
             google_api_client << " grpc/#{GRPC::VERSION}"
             google_api_client.freeze
 
@@ -149,6 +169,7 @@ module Google
               port,
               chan_creds: chan_creds,
               channel: channel,
+              updater_proc: updater_proc,
               scopes: scopes,
               &Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroupService::Stub.method(:new)
             )
@@ -182,49 +203,48 @@ module Google
           # @return [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/error_reporting/v1beta1/error_group_service_client"
+          #   require "google/cloud/error_reporting/v1beta1"
           #
-          #   ErrorGroupServiceClient = Google::Cloud::ErrorReporting::V1beta1::ErrorGroupServiceClient
-          #
-          #   error_group_service_client = ErrorGroupServiceClient.new
-          #   formatted_group_name = ErrorGroupServiceClient.group_path("[PROJECT]", "[GROUP]")
+          #   error_group_service_client = Google::Cloud::ErrorReporting::V1beta1::ErrorGroup.new
+          #   formatted_group_name = Google::Cloud::ErrorReporting::V1beta1::ErrorGroupServiceClient.group_path("[PROJECT]", "[GROUP]")
           #   response = error_group_service_client.get_group(formatted_group_name)
 
           def get_group \
               group_name,
               options: nil
-            req = Google::Devtools::Clouderrorreporting::V1beta1::GetGroupRequest.new({
+            req = {
               group_name: group_name
-            }.delete_if { |_, v| v.nil? })
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Devtools::Clouderrorreporting::V1beta1::GetGroupRequest)
             @get_group.call(req, options)
           end
 
           # Replace the data for the specified group.
           # Fails if the group does not exist.
           #
-          # @param group [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup]
+          # @param group [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup | Hash]
           #   [Required] The group which replaces the resource on the server.
+          #   A hash of the same form as `Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup`
+          #   can also be provided.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
           # @return [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/error_reporting/v1beta1/error_group_service_client"
-          #
-          #   ErrorGroup = Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup
-          #   ErrorGroupServiceClient = Google::Cloud::ErrorReporting::V1beta1::ErrorGroupServiceClient
+          #   require "google/cloud/error_reporting/v1beta1"
           #
-          #   error_group_service_client = ErrorGroupServiceClient.new
-          #   group = ErrorGroup.new
+          #   error_group_service_client = Google::Cloud::ErrorReporting::V1beta1::ErrorGroup.new
+          #   group = {}
           #   response = error_group_service_client.update_group(group)
 
           def update_group \
               group,
               options: nil
-            req = Google::Devtools::Clouderrorreporting::V1beta1::UpdateGroupRequest.new({
+            req = {
               group: group
-            }.delete_if { |_, v| v.nil? })
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Devtools::Clouderrorreporting::V1beta1::UpdateGroupRequest)
             @update_group.call(req, options)
           end
         end