google-cloud-error_reporting 0.35.0 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14b7376e46c49c261ee4387207a28bbe055c6f248559e7fae9c91eb8a23c92d5
-  data.tar.gz: 2e276f3374ca544e9518d64ec22ebd296717cc29a22a21f6beb6fd586fc79df2
+  metadata.gz: 9d0236b7db5323c5ab86adccc9a0fcad7db65080f4a7ff47142fd6645cc50008
+  data.tar.gz: bda4d6819f6a6063097a4874b80a939dbc13afe32531cac53488a3f5019a7045
 SHA512:
-  metadata.gz: 81ce022171fa09fe64c7ef5a8104fd5b179408bbf108e59c9242195c50874c8a71bc4cccf7a955da5d4c6a9cc6d6ca84ac519d0821486a692bc8680959e3f936
-  data.tar.gz: a18c83dc1b646173cc4910f37729193e2edd18be0123dc127ed298228ca3719d9f2a7fce5c34a5e669e5a4d4e3ba78bd57ddedd1c027afb943707fe2c60d7840
+  metadata.gz: 70094df759c28f7ce883dc90d35bd1a820171ce41ddc03ea06f4b8f504f3f43891ecfb10e225d11d5de9224842e243c4f14e0b980f035a1e70edc2032ba98352
+  data.tar.gz: 4a2c39a5ee27364915bd340296f52dc5554c7e8f8a703c0bd3922b3b711e6ae87e9f44df0837bdb41bf7980c1377a0261624fac8723dc4f4c4ff24a475d3007d

data/AUTHENTICATION.md

@@ -76,7 +76,8 @@ The environment variables that google-cloud-error_reporting checks for project I
 1. `ERROR_REPORTING_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-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::Credentials}:
 
 1. `ERROR_REPORTING_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `ERROR_REPORTING_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Release History
 
+### 0.42.0 / 2021-03-10
+
+#### Features
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
+
+### 0.41.0 / 2020-09-16
+
+#### Features
+
+* quota_project can be set via library configuration
+
+### 0.40.0 / 2020-07-21
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new `google-cloud-error_reporting-v1beta1` gem as a dependency.
+This is a rewritten low-level client produced by a next-generation client code
+generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in `google-cloud-error_reporting-v1beta1`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::ErrorReporting::V1beta1`
+module, please review the docs for the new `google-cloud-error_reporting-v1beta1`
+gem. In particular:
+
+* Some classes have been renamed, notably the client class itself.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
+### 0.35.2 / 2020-06-08
+
+#### Documentation
+
+* Fixed broken links in the reference documentation
+
+### 0.35.1 / 2020-05-19
+
+#### Bug Fixes
+
+* Adjusted some default timeout and retry settings
+
 ### 0.35.0 / 2020-03-11
 
 #### Features

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud-error_reporting console and run the project's
 tests, there is a small amount of setup:
 
-1. Install Ruby. google-cloud-error_reporting requires Ruby 2.4+. You may choose
+1. Install Ruby. google-cloud-error_reporting requires Ruby 2.5+. You may choose
    to manage your Ruby and gem installations with [RVM](https://rvm.io/),
    [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).
@@ -45,7 +45,7 @@ tests, there is a small amount of setup:
 
    ```sh
    $ cd google-cloud-error_reporting/
-   $ bundle exec rake bundleupdate
+   $ bundle install
    ```
 
 ## Console

data/LOGGING.md

@@ -3,7 +3,7 @@
 To enable logging for this library, set the logger for the underlying
 [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger
 that you set may be a Ruby stdlib
-[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
+[`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
 [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Stackdriver

data/TROUBLESHOOTING.md

@@ -24,14 +24,8 @@ improved, *please* create a new issue on GitHub so we can talk about it.
 
   - [New issue][gh-ruby]
 
-Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
-can use the "ruby" channel for general Ruby questions, or use the
-"google-cloud-ruby" channel if you have questions about this gem in particular.
-
 [so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+errorreporting
 
-[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+error+reporting%22
-
-[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
+[gh-search-ruby]: https://github.com/googleapis/google-cloud-ruby/issues?q=label%3A%22api%3A+error+reporting%22
 
-[slack-ruby]: https://gcp-slack.appspot.com/
+[gh-ruby]: https://github.com/googleapis/google-cloud-ruby/issues/new

data/lib/google-cloud-error_reporting.rb

@@ -41,8 +41,6 @@ module Google
     #   * `https://www.googleapis.com/auth/cloud-platform`
     #
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     #
     # @return [Google::Cloud::ErrorReporting::Project]
     #
@@ -59,11 +57,10 @@ module Google
     #                                             service_version: "v8"
     #   error_reporting.report error_event
     #
-    def error_reporting scope: nil, timeout: nil, client_config: nil
+    def error_reporting scope: nil, timeout: nil
       Google::Cloud.error_reporting @project, @keyfile,
                                     scope: scope,
-                                    timeout: (timeout || @timeout),
-                                    client_config: client_config
+                                    timeout: (timeout || @timeout)
     end
 
     ##
@@ -89,8 +86,6 @@ module Google
     #   * `https://www.googleapis.com/auth/cloud-platform`
     #
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     #
     # @return [Google::Cloud::ErrorReporting::Project]
     #
@@ -107,13 +102,11 @@ module Google
     #                                             service_version: "v8"
     #   error_reporting.report error_event
     #
-    def self.error_reporting project_id = nil, credentials = nil, scope: nil,
-                             timeout: nil, client_config: nil
+    def self.error_reporting project_id = nil, credentials = nil, scope: nil, timeout: nil
       require "google/cloud/error_reporting"
       Google::Cloud::ErrorReporting.new project_id: project_id,
                                         credentials: credentials,
-                                        scope: scope, timeout: timeout,
-                                        client_config: client_config
+                                        scope: scope, timeout: timeout
     end
   end
 end
@@ -148,6 +141,7 @@ Google::Cloud.configure.add_config! :error_reporting do |config|
   default_version = Google::Cloud::Config.deferred do
     ENV["ERROR_REPORTING_VERSION"]
   end
+  default_scopes = ["https://www.googleapis.com/auth/cloud-platform"]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
@@ -155,10 +149,10 @@ Google::Cloud.configure.add_config! :error_reporting do |config|
                     match: [String, Hash, Google::Auth::Credentials],
                     allow_nil: true
   config.add_alias! :keyfile, :credentials
-  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :scope, default_scopes, match: [String, Array]
+  config.add_field! :quota_project, nil, match: String
   config.add_field! :timeout, nil, match: Integer
-  config.add_field! :client_config, nil, match: Hash
-  config.add_field! :endpoint, nil, match: String
+  config.add_field! :endpoint, "clouderrorreporting.googleapis.com", match: String
   config.add_field! :service_name, default_service,
                     match: String, allow_nil: true
   config.add_field! :service_version, default_version,

data/lib/google/cloud/error_reporting.rb

@@ -62,8 +62,6 @@ module Google
       #   * `https://www.googleapis.com/auth/cloud-platform`
       #
       # @param [Integer] timeout Default timeout to use in requests. Optional.
-      # @param [Hash] client_config A hash of values to override the default
-      #   behavior of the API client. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
       # @param [String] project Alias for the `project_id` argument. Deprecated.
@@ -78,25 +76,25 @@ module Google
       #   error_reporting = Google::Cloud::ErrorReporting.new
       #   # ...
       #
-      def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
-                   client_config: nil, endpoint: nil, project: nil, keyfile: nil
+      def self.new project_id: nil,
+                   credentials: nil,
+                   scope: nil,
+                   timeout: nil,
+                   endpoint: nil,
+                   project: nil,
+                   keyfile: nil
         project_id    ||= project
         project_id    ||= ErrorReporting::Project.default_project_id
         scope         ||= configure.scope
         timeout       ||= configure.timeout
-        client_config ||= configure.client_config
         endpoint      ||= configure.endpoint
         credentials   ||= (keyfile || default_credentials(scope: scope))
 
         credentials = resolve_credentials credentials, scope
         project_id = resolve_project_id project_id, credentials
 
-        ErrorReporting::Project.new(
-          ErrorReporting::Service.new(
-            project_id, credentials,
-            host: endpoint, timeout: timeout, client_config: client_config
-          )
-        )
+        service = ErrorReporting::Service.new project_id, credentials, host: endpoint, timeout: timeout
+        ErrorReporting::Project.new service
       end
 
       ##
@@ -118,8 +116,6 @@ module Google
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `client_config` - (Hash) A hash of values to override the default
-      #   behavior of the API client.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.
       # * `service_name` - (String) Name for the application.
@@ -292,4 +288,11 @@ module Google
       private_class_method :default_credentials
     end
   end
+
+  # Aliases for compatibility with older spellings.
+  # @private
+  module Devtools
+    # @private
+    Clouderrorreporting = ::Google::Cloud::ErrorReporting unless const_defined? :Clouderrorreporting
+  end
 end

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

@@ -108,7 +108,7 @@ module Google
         #
         # @return [AsyncErrorReporter] returns self so calls can be chained.
         def stop
-          @thread_pool.shutdown if @thread_pool
+          @thread_pool&.shutdown
 
           self
         end
@@ -145,7 +145,7 @@ module Google
         # @return [boolean] `true` when started, `false` otherwise.
         #
         def started?
-          @thread_pool.running? if @thread_pool
+          @thread_pool&.running?
         end
 
         ##

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

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/error_reporting/v1beta1/credentials"
+require "google/cloud/error_reporting/v1beta1/report_errors_service/credentials"
 
 module Google
   module Cloud
@@ -37,7 +37,7 @@ module Google
       #
       #   error_reporting.project_id #=> "my-project"
       #
-      class Credentials < Google::Cloud::ErrorReporting::V1beta1::Credentials
+      class Credentials < Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Credentials
       end
     end
   end

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

@@ -23,8 +23,7 @@ module Google
       # service.
       #
       # Google::Cloud::ErrorReporting::ErrorEvent is able to be transformed
-      # into
-      # {Google::Devtools::Clouderrorreporting::V1beta1::ReportedErrorEvent}
+      # into the `Google::Cloud::ErrorReporting::V1beta1::ReportedErrorEvent`
       # gRPC structure. Once an error event is reported, the GCP
       # Stackdriver ErrorReporting service is able to parse the message and
       # backtrace, then group the error events by content.
@@ -119,13 +118,10 @@ module Google
 
         ##
         # Build a new ErrorEvent from a
-        # Google::Devtools::Clouderrorreporting::V1beta1::ReportedErrorEvent
-        # object.
+        # `Google::Cloud::ErrorReporting::V1beta1::ReportedErrorEvent` object.
         #
-        # @param [
-        #   Google::Devtools::Clouderrorreporting::V1beta1::ReportedErrorEvent]
-        #   grpc A
-        #   Google::Devtools::Clouderrorreporting::V1beta1::ReportedErrorEvent
+        # @param [Google::Cloud::ErrorReporting::V1beta1::ReportedErrorEvent]
+        #   grpc A `Google::Cloud::ErrorReporting::V1beta1::ReportedErrorEvent`
         #   object
         #
         # @return [ErrorEvent] A new ErrorEvent instance derived from given grpc
@@ -233,10 +229,10 @@ module Google
         ##
         # Convert ErrorEvent object to gRPC struct.
         #
-        # @return [Devtools::Clouderrorreporting::V1beta1::ReportedErrorEvent]
+        # @return [Google::Cloud::ErrorReporting::V1beta1::ReportedErrorEvent]
         #   gRPC struct that represent an ErrorEvent.
         def to_grpc
-          Devtools::Clouderrorreporting::V1beta1::ReportedErrorEvent.new(
+          Google::Cloud::ErrorReporting::V1beta1::ReportedErrorEvent.new(
             event_time: event_time_grpc,
             message: message.to_s,
             service_context: service_context_grpc,
@@ -259,11 +255,11 @@ module Google
 
         ##
         # @private Formats the service_name and service_version as a
-        # Google::Devtools::Clouderrorreporting::V1beta1::ServiceContext.
+        # Google::Cloud::ErrorReporting::V1beta1::ServiceContext.
         #
         def service_context_grpc
           return nil if !service_name && !service_version
-          Devtools::Clouderrorreporting::V1beta1::ServiceContext.new(
+          Google::Cloud::ErrorReporting::V1beta1::ServiceContext.new(
             service: service_name.to_s,
             version: service_version.to_s
           )
@@ -271,12 +267,12 @@ module Google
 
         ##
         # @private Formats the http request context as a
-        # Google::Devtools::Clouderrorreporting::V1beta1::HttpRequestContext
+        # Google::Cloud::ErrorReporting::V1beta1::HttpRequestContext
         #
         def http_request_grpc
           return nil if !http_method && !http_url && !http_user_agent &&
                         !http_referrer && !http_status && !http_remote_ip
-          Devtools::Clouderrorreporting::V1beta1::HttpRequestContext.new(
+          Google::Cloud::ErrorReporting::V1beta1::HttpRequestContext.new(
             method: http_method.to_s,
             url: http_url.to_s,
             user_agent: http_user_agent.to_s,
@@ -288,11 +284,11 @@ module Google
 
         ##
         # @private Formats the source location as a
-        # Google::Devtools::Clouderrorreporting::V1beta1::SourceLocation
+        # Google::Cloud::ErrorReporting::V1beta1::SourceLocation
         #
         def source_location_grpc
           return nil if !file_path && !line_number && !function_name
-          Devtools::Clouderrorreporting::V1beta1::SourceLocation.new(
+          Google::Cloud::ErrorReporting::V1beta1::SourceLocation.new(
             file_path: file_path.to_s,
             line_number: line_number.to_i,
             function_name: function_name.to_s
@@ -301,13 +297,13 @@ module Google
 
         ##
         # @private Formats the error context info as a
-        # Google::Devtools::Clouderrorreporting::V1beta1::ErrorContext
+        # Google::Cloud::ErrorReporting::V1beta1::ErrorContext
         #
         def error_context_grpc
           http_request = http_request_grpc
           source_location = source_location_grpc
           return nil if !http_request && !source_location && !user
-          Devtools::Clouderrorreporting::V1beta1::ErrorContext.new(
+          Google::Cloud::ErrorReporting::V1beta1::ErrorContext.new(
             http_request: http_request,
             user: user.to_s,
             report_location: source_location

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

@@ -50,7 +50,7 @@ module Google
           require "rack/request"
           @app = app
 
-          load_config kwargs
+          load_config(**kwargs)
 
           @error_reporting =
             error_reporting ||
@@ -86,11 +86,11 @@ module Google
           end
 
           response
-        rescue Exception => exception
-          report_exception env, exception
+        rescue Exception => e
+          report_exception env, e
 
           # Always raise exception backup
-          raise exception
+          raise e
         end
 
         ##
@@ -112,7 +112,7 @@ module Google
           # If this exception maps to a HTTP status code less than 500, do
           # not report it.
           status_code = error_event.http_status.to_i
-          return if status_code > 0 && status_code < 500
+          return if status_code.positive? && status_code < 500
 
           error_reporting.report error_event
         end

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

@@ -151,13 +151,13 @@ module Google
               ErrorReporting::Credentials.new credentials
             end
           rescue StandardError => e
-            STDOUT.puts "Note: Google::Cloud::ErrorReporting is disabled " \
+            $stdout.puts "Note: Google::Cloud::ErrorReporting is disabled " \
               "because it failed to authorize with the service. (#{e.message})"
             return false
           end
 
           if project_id.to_s.empty?
-            STDOUT.puts "Note: Google::Cloud::ErrorReporting is disabled " \
+            $stdout.puts "Note: Google::Cloud::ErrorReporting is disabled " \
               "because the project ID could not be determined."
             return false
           end

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

@@ -16,7 +16,6 @@
 require "google/cloud/errors"
 require "google/cloud/error_reporting/version"
 require "google/cloud/error_reporting/v1beta1"
-require "google/gax/errors"
 require "uri"
 
 module Google
@@ -26,31 +25,30 @@ module Google
       # @private Represents the gRPC Error Reporting service, including all the
       #   API methods.
       class Service
-        attr_accessor :project, :credentials, :timeout, :client_config, :host
+        attr_accessor :project
+        attr_accessor :credentials
+        attr_accessor :timeout
+        attr_accessor :host
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials, timeout: nil, client_config: nil,
-                       host: nil
+        def initialize project, credentials, timeout: nil, host: nil
           @project = project
           @credentials = credentials
           @timeout = timeout
-          @client_config = client_config || {}
-          @host = host || V1beta1::ReportErrorsServiceClient::SERVICE_ADDRESS
+          @host = host
         end
 
         def error_reporting
           return mocked_error_reporting if mocked_error_reporting
           @error_reporting ||= \
-            V1beta1::ReportErrorsServiceClient.new(
-              credentials: credentials,
-              timeout: timeout,
-              client_config: client_config,
-              service_address: service_address,
-              service_port: service_port,
-              lib_name: "gccl",
-              lib_version: Google::Cloud::ErrorReporting::VERSION
-            )
+            V1beta1::ReportErrorsService::Client.new do |config|
+              config.credentials = credentials if credentials
+              config.timeout = timeout if timeout
+              config.endpoint = host if host
+              config.lib_name = "gccl"
+              config.lib_version = Google::Cloud::ErrorReporting::VERSION
+            end
         end
         attr_accessor :mocked_error_reporting
 
@@ -81,32 +79,13 @@ module Google
 
           error_event_grpc = error_event.to_grpc
 
-          execute do
-            error_reporting.report_error_event project_path, error_event_grpc
-          end
+          error_reporting.report_error_event project_name: project_path, event: error_event_grpc
         end
 
         protected
 
-        def service_address
-          return nil if host.nil?
-          URI.parse("//#{host}").host
-        end
-
-        def service_port
-          return nil if host.nil?
-          URI.parse("//#{host}").port
-        end
-
         def project_path
-          V1beta1::ReportErrorsServiceClient.project_path project
-        end
-
-        def execute
-          yield
-        rescue Google::Gax::GaxError => e
-          # GaxError wraps BadStatus, but exposes it as #cause
-          raise Google::Cloud::Error.from_error(e.cause)
+          V1beta1::ReportErrorsService::Paths.project_path project: project
         end
       end
     end