google-cloud-debugger 0.33.3 → 0.33.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 103303faa6ff1e2f4f9430dbccf2c29697a2dfae72f168b62d7c41cebd90d7fb
-  data.tar.gz: 87c61393cd2f11c21bf07a0f714e68794556b962bd1ba49b361920815b9955fb
+  metadata.gz: 7955a6715c284e4a6b252821d10a171eddeffaa4b3a25aa52b3b2b2ad9908206
+  data.tar.gz: 325b388efb06877c49cecf2fa75dd72f5b64c0b4855b417b2268b111af82c29a
 SHA512:
-  metadata.gz: 0402a9658bc51cce79d3a8b3d96bb44f27052ff53d9c6e93b970fcd230f98652325cb5ffe9cbcc58225328ddce886b7fa168326f7bfb5298bb3c443490da0984
-  data.tar.gz: 75c271adff64edbcc9479ec461bc8b6c5174b2d463f31fd1b1c4e9436e8b6e0b590c300ce56fcd1416e0a0728ded29c47a24cb66d0b9af34a9e65c44cc4ac369
+  metadata.gz: c629a0e11f230080a491860ffd13a68489f2397b6c051a64b81fba092c91610c80f13e9f638c54cdd3932ca6240f31671a6fdc88e4d87661fc0d1dfe38dec694
+  data.tar.gz: 15b17570618bee28d9122a001f80056719bad4c8a5565f0e21e932fdf0d777edd920235ac2278f265543e69fec5aca429bb1643e2c6bd0a568b35f95999c60fb

data/AUTHENTICATION.md

@@ -2,20 +2,39 @@
 
 In general, the google-cloud-debugger 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 DEBUGGER_CREDENTIALS=/path/to/json`
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/debugger"
+
+client = Google::Cloud::Debugger.new
+```
 
 ## Project and Credential Lookup
 
-The google-cloud-debugger 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-debugger 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,12 +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 Debugger checks for project ID are:
+The environment variables that google-cloud-debugger checks for project ID are:
 
 1. `DEBUGGER_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that 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::Credentials}:
 
 1. `DEBUGGER_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `DEBUGGER_KEYFILE` - Path to JSON file, or JSON contents
@@ -92,7 +112,7 @@ require "google/cloud/debugger"
 ENV["DEBUGGER_PROJECT"]     = "my-project-id"
 ENV["DEBUGGER_CREDENTIALS"] = "path/to/keyfile.json"
 
-debugger = Google::Cloud::Debugger.new
+client = Google::Cloud::Debugger.new
 ```
 
 ### Configuration
@@ -107,7 +127,7 @@ Google::Cloud::Debugger.configure do |config|
   config.credentials = "path/to/keyfile.json"
 end
 
-debugger = Google::Cloud::Debugger.new
+client = Google::Cloud::Debugger.new
 ```
 
 ### Cloud SDK
@@ -140,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-debugger.
 
-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,11 @@
 # Release History
 
+### 0.33.4 / 2019-04-29
+
+* Add AUTHENTICATION.md guide.
+* Update documentation for common types.
+* Extract gRPC header values from request.
+
 ### 0.33.3 / 2019-02-13
 
 * Fix bug (typo) in retrieving default on_error proc.

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

@@ -823,7 +823,7 @@ module Google
           #
           def readonly_eval_expression binding, expression
             compilation_result = validate_compiled_expression expression
-            return compilation_result if compilation_result.is_a?(Exception)
+            return compilation_result if compilation_result.is_a? Exception
 
             readonly_eval_expression_exec binding, expression
           rescue StandardError => e
@@ -1080,7 +1080,7 @@ module Google
 
         def initialize msg = nil, mutation_cause = UNKNOWN_CAUSE
           @mutation_cause = mutation_cause
-          super(msg)
+          super msg
         end
 
         def inspect

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

@@ -354,7 +354,7 @@ module Google
           # compound variables.
           def self.add_member_vars var, members, limit: nil
             members.each_with_index do |member, i|
-              member_var = yield(member, i, limit)
+              member_var = yield member, i, limit
 
               limit = deduct_limit limit, member_var.total_size
 
@@ -491,7 +491,7 @@ module Google
             unless @total_size
               vars = [self, *(unique_members || [])]
 
-              @total_size = vars.inject(payload_size) do |sum, var|
+              @total_size = vars.inject payload_size do |sum, var|
                 if var.var_table && var.var_table_index
                   sum + var.var_table[var.var_table_index].total_size
                 else
@@ -515,7 +515,7 @@ module Google
                               value.to_s.bytesize
 
               unless members.nil?
-                @payload_size = members.inject(@payload_size) do |sum, member|
+                @payload_size = members.inject @payload_size do |sum, member|
                   sum + member.payload_size
                 end
               end

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

@@ -132,7 +132,7 @@ module Google
               !new_breakpoints.empty? ||
               (before_breakpoints_count != after_breakpoints_acount)
 
-            on_breakpoints_change.call(@active_breakpoints) if
+            on_breakpoints_change.call @active_breakpoints if
               on_breakpoints_change.respond_to?(:call) && breakpoints_updated
           end
         end

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

@@ -123,7 +123,7 @@ module Google
               Google::Cloud::Debugger::RequestQuotaManager.new
           end
 
-          Middleware.deferred_start(@debugger)
+          Middleware.deferred_start @debugger
         end
 
         ##

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

@@ -169,17 +169,17 @@ module Google
         # @private Compute the total size of all the evaluated variables in
         # this breakpoint.
         def calculate_total_size
-          result = evaluated_expressions.inject(0) do |sum, exp|
+          result = evaluated_expressions.inject 0 do |sum, exp|
             sum + exp.payload_size
           end
 
           stack_frames.each do |stack_frame|
-            result = stack_frame.locals.inject(result) do |sum, local|
+            result = stack_frame.locals.inject result do |sum, local|
               sum + local.payload_size
             end
           end
 
-          result = variable_table.variables.inject(result) do |sum, var|
+          result = variable_table.variables.inject result do |sum, var|
             sum + var.payload_size
           end
 

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

@@ -34,7 +34,7 @@ module Google
         attr_reader :breakpoint
 
         def initialize message, breakpoint = nil
-          super(message)
+          super message
           @breakpoint = breakpoint
         end
       end
@@ -93,7 +93,7 @@ module Google
         # @raise [TransmitterError] if there are no resources available to make
         #   queue the API call on the thread pool.
         def submit breakpoint
-          Concurrent::Promises.future_on(@thread_pool, breakpoint) do |bp|
+          Concurrent::Promises.future_on @thread_pool, breakpoint do |bp|
             submit_sync bp
           end
         rescue Concurrent::RejectedExecutionError => e

data/lib/google/cloud/debugger/v2/controller2_client.rb

@@ -188,7 +188,10 @@ module Google
             @list_active_breakpoints = Google::Gax.create_api_call(
               @controller2_stub.method(:list_active_breakpoints),
               defaults["list_active_breakpoints"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'debuggee_id' => request.debuggee_id}
+              end
             )
             @update_active_breakpoint = Google::Gax.create_api_call(
               @controller2_stub.method(:update_active_breakpoint),

data/lib/google/cloud/debugger/v2/debugger2_client.rb

@@ -175,7 +175,10 @@ module Google
             @set_breakpoint = Google::Gax.create_api_call(
               @debugger2_stub.method(:set_breakpoint),
               defaults["set_breakpoint"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'debuggee_id' => request.debuggee_id}
+              end
             )
             @get_breakpoint = Google::Gax.create_api_call(
               @debugger2_stub.method(:get_breakpoint),
@@ -190,7 +193,10 @@ module Google
             @list_breakpoints = Google::Gax.create_api_call(
               @debugger2_stub.method(:list_breakpoints),
               defaults["list_breakpoints"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'debuggee_id' => request.debuggee_id}
+              end
             )
             @list_debuggees = Google::Gax.create_api_call(
               @debugger2_stub.method(:list_debuggees),

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Debugger
-      VERSION = "0.33.3".freeze
+      VERSION = "0.33.4".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-debugger
 version: !ruby/object:Gem::Version
-  version: 0.33.3
+  version: 0.33.4
 platform: ruby
 authors:
 - Heng Xiong
 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: binding_of_caller
@@ -184,14 +184,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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -364,8 +364,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 and instrumentation library for Stackdriver Debugger