google-cloud-debugger 0.36.3 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f48f60bfac19b01bf730298af7c8b9aa4b69904ceef59e701425e0968243a7e0
-  data.tar.gz: 3bb6fb7c0ecb3c8dc171a12e1c42f5fb42da135362d3579658682f018b3b8a17
+  metadata.gz: 1b4ce08aa3118de8cc2a1afe7874ca26f6d97a7922f84471caef85fe0aed3640
+  data.tar.gz: a6bc54a758686120fe5898e69179994e3325e72adf5c9e3b8ef4b0b010a5c9d6
 SHA512:
-  metadata.gz: d01a4be423f55a36ff6793884a03759392e60654a9c99d282ed18266c74dbd64767c7f4cc80ed7e010a15634bf0cfdf02c9cb1337392cc4d95cbadb77a7849f3
-  data.tar.gz: 2151bda590cd1406d3e7746e6823ec0e0d3f13f31e41a437c1d92c7c67050a6b4f8d823efc978135062b2eb97b8fe9f0bfb9e7fa175e3b36ebb2e390eb2c6d0b
+  metadata.gz: 150edcd3b7d9c16480900ac16d22925eaf08c1629ac40c601d308da5e3db74237dbacd6510c9357861650d8fe519239c53c361448e3f6d005058313c1e442909
+  data.tar.gz: ce89d0b2545e87b7587b8887a6eafe1dead96614616437ce2709f60a83780a38607990687caf74398a219093d019f68bcd615aac469e1b35efec732c71141508

data/AUTHENTICATION.md

@@ -76,7 +76,8 @@ The environment variables that google-cloud-debugger checks for project ID are:
 1. `DEBUGGER_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-debugger checks for credentials are configured on {Google::Cloud::Debugger::V2::Credentials}:
+The environment variables that google-cloud-debugger checks for credentials are
+configured on `Google::Cloud::Debugger::V2::Debugger::Credentials`:
 
 1. `DEBUGGER_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `DEBUGGER_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Release History
 
+### 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-debugger-v2` gem as a dependency.
+The new dependency 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-debugger-v2`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::Debugger::V2` module,
+please review the docs for the new `google-cloud-debugger-v2` 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.36.3 / 2020-07-06
 
 #### Bug Fixes

data/OVERVIEW.md

@@ -147,12 +147,9 @@ For further information on the Debugger API, see
 ```ruby
 require "google/cloud/debugger/v2"
 
-Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
-Debuggee = Google::Devtools::Clouddebugger::V2::Debuggee
-
-controller2_client = Controller2Client.new
-debuggee = Debuggee.new
-response = controller2_client.register_debuggee(debuggee)
+controller_client = Google::Cloud::Debugger::V2::Controller::Client.new
+debuggee = Google::Cloud::Debugger::V2::Debuggee.new
+response = controller_client.register_debuggee debuggee: debuggee
 debuggee_id = response.debuggee.id
 ```
 See [Stackdriver Debugger Debuggee
@@ -163,23 +160,18 @@ Upon successful registration, the response debuggee object will contain a
 debuggee_id that's later needed to interact with the other Stackdriver Debugger
 API.
 
-See {Google::Cloud::Debugger::V2::Controller2Client} for details.
-
 ### List Active Breakpoints
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
-controller2_client = Controller2Client.new
+controller_client = Google::Cloud::Debugger::V2::Controller::Client.new
 
 debuggee_id = ''
-response = controller2_client.list_active_breakpoints(debuggee_id)
+response = controller_client.list_active_breakpoints debuggee_id: debuggee_id
 breakpoints = response.breakpoints
 ```
 
-See {Google::Cloud::Debugger::V2::Controller2Client} for details.
-
 ### Update Active Breakpoint
 
 Users can send custom snapshots for active breakpoints using this API.
@@ -187,110 +179,87 @@ Users can send custom snapshots for active breakpoints using this API.
 ```ruby
 require "google/cloud/debugger/v2"
 
-Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint
-Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
-
-controller2_client = Controller2Client.new
+controller_client = Google::Cloud::Debugger::V2::Controller::Client.new
 debuggee_id = ''
-breakpoint = Breakpoint.new
-response =
-  controller2_client.update_active_breakpoint(debuggee_id, breakpoint)
+breakpoint = Google::Cloud::Debugger::V2::Breakpoint.new
+response = controller_client.update_active_breakpoint(
+  debuggee_id: debuggee_id, breakpoint: breakpoint)
 ```
 
 See [Stackdriver Debugger Breakpoint
 doc](https://cloud.google.com/debugger/api/reference/rpc/google.devtools.clouddebugger.v2#google.devtools.clouddebugger.v2.Breakpoint)
 for all available fields for breakpoint.
 
-See {Google::Cloud::Debugger::V2::Controller2Client} for details.
-
 ### Set Breakpoint
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 debuggee_id = ''
-breakpoint = Breakpoint.new
+breakpoint = Google::Cloud::Debugger::V2::Breakpoint.new
 client_version = ''
-response = debugger2_client.set_breakpoint(
-             debuggee_id, breakpoint, client_version)
+response = debugger_client.set_breakpoint(
+  debuggee_id: debuggee_id, breakpoint: breakpoint,
+  client_version: client_version)
 ```
 
 See [Stackdriver Debugger Breakpoint
 doc](https://cloud.google.com/debugger/api/reference/rpc/google.devtools.clouddebugger.v2#google.devtools.clouddebugger.v2.Breakpoint)
 for fields needed to specify breakpoint location.
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ### Get Breakpoint
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 debuggee_id = ''
 breakpoint_id = ''
 client_version = ''
-response = debugger2_client.get_breakpoint(
-             debuggee_id, breakpoint_id, client_version)
+response = debugger_client.get_breakpoint(
+  debuggee_id: debuggee_id, breakpoint_id: breakpoint_id,
+  client_version: client_version)
 ```
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ### Delete Breakpoint
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 debuggee_id = ''
 breakpoint_id = ''
 client_version = ''
-debugger2_client.delete_breakpoint(
-  debuggee_id, breakpoint_id, client_version)
+debugger_client.delete_breakpoint(
+  debuggee_id: debuggee_id, breakpoint_id: breakpoint_id,
+  client_version: client_version)
 ```
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ### List Breakpoints
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 debuggee_id = ''
 client_version = ''
-response = debugger2_client.list_breakpoints(debuggee_id, client_version)
+response = debugger_client.list_breakpoints(
+  debuggee_id: debuggee_id, client_version: client_version)
 ```
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ### List Debuggees
 
 ```ruby
 require "google/cloud/debugger/v2"
 
-Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-
-debugger2_client = Debugger2Client.new
+debugger_client = Google::Cloud::Debugger::V2::Debugger::Client.new
 project = ''
 client_version = ''
-response = debugger2_client.list_debuggees(project, client_version)
+response = debugger_client.list_debuggees(
+  project: project, client_version: client_version)
 ```
 
-See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-
 ## Additional information
 
 Stackdriver Debugger can be configured to use gRPC's logging. To learn more, see

data/lib/google-cloud-debugger.rb

@@ -48,8 +48,6 @@ module Google
     #   * `https://www.googleapis.com/auth/logging.admin`
     #
     # @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::Debugger::Project]
     #
@@ -68,14 +66,12 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   debugger = gcloud.debugger scope: platform_scope
     #
-    def debugger service_name: nil, service_version: nil, scope: nil,
-                 timeout: nil, client_config: nil
+    def debugger service_name: nil, service_version: nil, scope: nil, timeout: nil
       Google::Cloud.debugger @project, @keyfile,
                              service_name: service_name,
                              service_version: service_version,
                              scope: scope,
-                             timeout: (timeout || @timeout),
-                             client_config: client_config
+                             timeout: (timeout || @timeout)
     end
 
     ##
@@ -105,8 +101,6 @@ module Google
     #   * `https://www.googleapis.com/auth/logging.admin`
     #
     # @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::Debugger::Project]
     #
@@ -118,15 +112,13 @@ module Google
     #   debugger.start
     #
     def self.debugger project_id = nil, credentials = nil, service_name: nil,
-                      service_version: nil, scope: nil, timeout: nil,
-                      client_config: nil
+                      service_version: nil, scope: nil, timeout: nil
       require "google/cloud/debugger"
       Google::Cloud::Debugger.new project_id: project_id,
                                   credentials: credentials,
                                   service_name: service_name,
                                   service_version: service_version,
-                                  scope: scope, timeout: timeout,
-                                  client_config: client_config
+                                  scope: scope, timeout: timeout
     end
   end
 end
@@ -160,6 +152,13 @@ Google::Cloud.configure.add_config! :debugger do |config|
   default_version = Google::Cloud::Config.deferred do
     ENV["DEBUGGER_SERVICE_VERSION"]
   end
+  default_scopes = [
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/cloud_debugger",
+    "https://www.googleapis.com/auth/logging.admin",
+    "https://www.googleapis.com/auth/logging.read",
+    "https://www.googleapis.com/auth/logging.write"
+  ]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
@@ -173,10 +172,9 @@ Google::Cloud.configure.add_config! :debugger do |config|
                     match: String, allow_nil: true
   config.add_field! :app_root, nil, match: String
   config.add_field! :root, nil, match: String
-  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :scope, default_scopes, match: [String, Array]
   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, "clouddebugger.googleapis.com", match: String
   config.add_field! :allow_mutating_methods, false
   config.add_field! :evaluation_time_limit, 0.05, match: Numeric
   config.add_field! :on_error, nil, match: Proc

data/lib/google/cloud/debugger.rb

@@ -67,8 +67,6 @@ module Google
       #   * `https://www.googleapis.com/auth/logging.admin`
       #
       # @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 Project identifier for the Stackdriver Debugger
@@ -84,15 +82,20 @@ module Google
       #   debugger = Google::Cloud::Debugger.new
       #   debugger.start
       #
-      def self.new project_id: nil, credentials: nil, service_name: nil,
-                   service_version: nil, scope: nil, timeout: nil,
-                   client_config: nil, endpoint: nil, project: nil, keyfile: nil
+      def self.new project_id: nil,
+                   credentials: nil,
+                   service_name: nil,
+                   service_version: nil,
+                   scope: nil,
+                   timeout: nil,
+                   endpoint: nil,
+                   project: nil,
+                   keyfile: nil
         project_id      ||= (project || default_project_id)
         service_name    ||= default_service_name
         service_version ||= default_service_version
         scope           ||= configure.scope
         timeout         ||= configure.timeout
-        client_config   ||= configure.client_config
         endpoint        ||= configure.endpoint
 
         service_name = service_name.to_s
@@ -114,14 +117,8 @@ module Google
         project_id = project_id.to_s # Always cast to a string
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        Debugger::Project.new(
-          Debugger::Service.new(
-            project_id, credentials,
-            host: endpoint, timeout: timeout, client_config: client_config
-          ),
-          service_name: service_name,
-          service_version: service_version
-        )
+        service = Debugger::Service.new project_id, credentials, host: endpoint, timeout: timeout
+        Debugger::Project.new service, service_name: service_name, service_version: service_version
       end
 
       # rubocop:enable all
@@ -147,8 +144,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.
       # * `allow_mutating_methods` - (boolean) Whether expressions and
@@ -254,4 +249,11 @@ module Google
       end
     end
   end
+
+  # Aliases for compatibility with older spellings.
+  # @private
+  module Devtools
+    # @private
+    Clouddebugger = ::Google::Cloud::Debugger unless const_defined? :Clouddebugger
+  end
 end

data/lib/google/cloud/debugger/breakpoint.rb

@@ -30,7 +30,7 @@ module Google
       #
       # Abstract class that represents a breakpoint, which can be set and
       # triggered in a debuggee application. Maps to gRPC struct
-      # {Google::Devtools::Clouddebugger::V2::Breakpoint}.
+      # {Google::Cloud::Debugger::V2::Breakpoint}.
       #
       class Breakpoint
         include MonitorMixin
@@ -174,7 +174,7 @@ module Google
 
         ##
         # @private New Google::Cloud::Debugger::Breakpoint
-        # from a Google::Devtools::Clouddebugger::V2::Breakpoint object.
+        # from a Google::Cloud::Debugger::V2::Breakpoint object.
         def self.from_grpc grpc
           return new if grpc.nil?
 
@@ -337,9 +337,9 @@ module Google
 
         ##
         # @private Exports the Breakpoint to a
-        # Google::Devtools::Clouddebugger::V2::Breakpoint object.
+        # Google::Cloud::Debugger::V2::Breakpoint object.
         def to_grpc
-          Google::Devtools::Clouddebugger::V2::Breakpoint.new(
+          Google::Cloud::Debugger::V2::Breakpoint.new(
             id: id.to_s,
             location: location.to_grpc,
             condition: condition.to_s,
@@ -398,7 +398,7 @@ module Google
 
         ##
         # @private Formats the labels so they can be saved to a
-        # Google::Devtools::Clouddebugger::V2::Breakpoint object.
+        # Google::Cloud::Debugger::V2::Breakpoint object.
         def labels_to_grpc
           # Coerce symbols to strings
           Hash[labels.map do |k, v|
@@ -408,21 +408,21 @@ module Google
 
         ##
         # @private Exports the Breakpoint stack_frames to an array of
-        # Google::Devtools::Clouddebugger::V2::StackFrame objects.
+        # Google::Cloud::Debugger::V2::StackFrame objects.
         def stack_frames_to_grpc
           stack_frames.nil? ? [] : stack_frames.map(&:to_grpc)
         end
 
         ##
         # @private Exports the Breakpoint stack_frames to an array of
-        # Google::Devtools::Clouddebugger::V2::Variable objects.
+        # Google::Cloud::Debugger::V2::Variable objects.
         def evaluated_expressions_to_grpc
           evaluated_expressions.nil? ? [] : evaluated_expressions.map(&:to_grpc)
         end
 
         ##
         # @private Exports Breakpoint status to
-        # Google::Devtools::Clouddebugger::V2::StatusMessage object
+        # Google::Cloud::Debugger::V2::StatusMessage object
         def status_to_grpc
           status.nil? ? nil : status.to_grpc
         end

data/lib/google/cloud/debugger/breakpoint/source_location.rb

@@ -41,7 +41,7 @@ module Google
 
           ##
           # @private New Google::Cloud::Debugger::Breakpoint::SourceLocation
-          # from a Google::Devtools::Clouddebugger::V2::SourceLocation object.
+          # from a Google::Cloud::Debugger::V2::SourceLocation object.
           def self.from_grpc grpc
             return new if grpc.nil?
             new.tap do |o|
@@ -59,10 +59,10 @@ module Google
 
           ##
           # @private Exports the SourceLocation to a
-          # Google::Devtools::Clouddebugger::V2::SourceLocation object.
+          # Google::Cloud::Debugger::V2::SourceLocation object.
           def to_grpc
             return nil if empty?
-            Google::Devtools::Clouddebugger::V2::SourceLocation.new(
+            Google::Cloud::Debugger::V2::SourceLocation.new(
               path: path.to_s,
               line: line
             )