google-cloud-debugger 0.28.2 → 0.29.0

data/lib/google/cloud/debugger/v2/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/debugger/v2/doc/overview.rb

@@ -0,0 +1,54 @@
+# 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 Debugger API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Stackdriver Debugger API][Product Documentation]:
+    # Examines the call stack and variables of a running application
+    # without stopping or slowing it down.
+    # - [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 Debugger API.](https://console.cloud.google.com/apis/api/debugger)
+    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-cloud-debugger
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Stackdriver Debugger 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/debugger
+    #
+    #
+    module Debugger
+      module V2
+      end
+    end
+  end
+end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Debugger
-      VERSION = "0.28.2"
+      VERSION = "0.29.0"
     end
   end
 end

data/lib/google/devtools/clouddebugger/v2/controller_services_pb.rb

@@ -54,18 +54,18 @@ module Google
 
             # Registers the debuggee with the controller service.
             #
-            # All agents attached to the same application should call this method with
-            # the same request content to get back the same stable `debuggee_id`. Agents
-            # should call this method again whenever `google.rpc.Code.NOT_FOUND` is
-            # returned from any controller method.
+            # All agents attached to the same application must call this method with
+            # exactly the same request content to get back the same stable `debuggee_id`.
+            # Agents should call this method again whenever `google.rpc.Code.NOT_FOUND`
+            # is returned from any controller method.
             #
-            # This allows the controller service to disable the agent or recover from any
-            # data loss. If the debuggee is disabled by the server, the response will
-            # have `is_disabled` set to `true`.
+            # This protocol allows the controller service to disable debuggees, recover
+            # from data loss, or change the `debuggee_id` format. Agents must handle
+            # `debuggee_id` value changing upon re-registration.
             rpc :RegisterDebuggee, RegisterDebuggeeRequest, RegisterDebuggeeResponse
             # Returns the list of all active breakpoints for the debuggee.
             #
-            # The breakpoint specification (location, condition, and expression
+            # The breakpoint specification (`location`, `condition`, and `expressions`
             # fields) is semantically immutable, although the field values may
             # change. For example, an agent may update the location line number
             # to reflect the actual line where the breakpoint was set, but this
@@ -78,12 +78,11 @@ module Google
             # setting those breakpoints again.
             rpc :ListActiveBreakpoints, ListActiveBreakpointsRequest, ListActiveBreakpointsResponse
             # Updates the breakpoint state or mutable fields.
-            # The entire Breakpoint message must be sent back to the controller
-            # service.
+            # The entire Breakpoint message must be sent back to the controller service.
             #
             # Updates to active breakpoint fields are only allowed if the new value
             # does not change the breakpoint specification. Updates to the `location`,
-            # `condition` and `expression` fields should not alter the breakpoint
+            # `condition` and `expressions` fields should not alter the breakpoint
             # semantics. These may only make changes such as canonicalizing a value
             # or snapping the location to the correct line of code.
             rpc :UpdateActiveBreakpoint, UpdateActiveBreakpointRequest, UpdateActiveBreakpointResponse

data/lib/google/devtools/clouddebugger/v2/debugger_services_pb.rb

@@ -29,9 +29,9 @@ module Google
           # and without modifying its state.  An application may include one or
           # more replicated processes performing the same work.
           #
-          # The application is represented using the Debuggee concept. The Debugger
-          # service provides a way to query for available Debuggees, but does not
-          # provide a way to create one.  A debuggee is created using the Controller
+          # A debugged application is represented using the Debuggee concept. The
+          # Debugger service provides a way to query for available debuggees, but does
+          # not provide a way to create one.  A debuggee is created using the Controller
           # service, usually by running a debugger agent with the application.
           #
           # The Debugger service enables the client to set one or more Breakpoints on a
@@ -52,7 +52,7 @@ module Google
             rpc :DeleteBreakpoint, DeleteBreakpointRequest, Google::Protobuf::Empty
             # Lists all breakpoints for the debuggee.
             rpc :ListBreakpoints, ListBreakpointsRequest, ListBreakpointsResponse
-            # Lists all the debuggees that the user can set breakpoints to.
+            # Lists all the debuggees that the user has access to.
             rpc :ListDebuggees, ListDebuggeesRequest, ListDebuggeesResponse
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-debugger
 version: !ruby/object:Gem::Version
-  version: 0.28.2
+  version: 0.29.0
 platform: ruby
 authors:
 - Heng Xiong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: google-cloud-logging
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: stackdriver-core
   requirement: !ruby/object:Gem::Requirement
@@ -300,6 +300,7 @@ files:
 - lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/debugger.rb
 - lib/google/cloud/debugger/v2/doc/google/devtools/source/v1/source_context.rb
 - lib/google/cloud/debugger/v2/doc/google/protobuf/timestamp.rb
+- lib/google/cloud/debugger/v2/doc/overview.rb
 - lib/google/cloud/debugger/version.rb
 - lib/google/devtools/clouddebugger/v2/controller_pb.rb
 - lib/google/devtools/clouddebugger/v2/controller_services_pb.rb
@@ -327,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: API Client and instrumentation library for Stackdriver Debugger