google-cloud-debugger 0.28.2 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f6c7702998c26106d5d7d8c9da1da90a23a85a9
-  data.tar.gz: 9e792c21da0a3224c17df88921f635eddbdd8b90
+SHA256:
+  metadata.gz: cf39367a4bd468a04d05cb1169183b0929f2f025dc96a26b5b679be501a62eeb
+  data.tar.gz: e17347af976df5273d21140bd2657087de7e057bec738241cc541b074eadba68
 SHA512:
-  metadata.gz: 10b6cf1fbdfa245b73e5d40f83736e5e74444060484d13a18352be3ffcbb14dc0cba4fa9502e845b82874f04bde6ccce2eb52b56e2ebcdb0ee04d57c62526754
-  data.tar.gz: 4e249d586c912cc55b971547268b5ab79fe975892c84ac5e24e46eb29a98749e8b4f21155815f9b735515fbf70f525eb41779c072532e80d4c7f628ab694b3b5
+  metadata.gz: fa34cd85cfdb7c417e0d951ce2b4b401c20939b74f32670718d0ae50ac68d8087ddf257b44c0cbb83538dbd2f2e682364eda16f827ccf8f8ab91a106fcdbdccb
+  data.tar.gz: ec77ef51189b469857211c6b74f2d7eef3084f3cb4f15a0d371a3dde62abbdb7796a7c1954069500db86903b8c16fd47ec81613f4f693cb3fe9379078ca790d9

data/README.md

@@ -28,14 +28,14 @@ gem "google-cloud-debugger"
 $ bundle install
 ```
 
-Alternatively, check out the [`stackdriver`](../stackdriver) gem that includes 
+Alternatively, check out the [`stackdriver`](../stackdriver) gem that includes
 the `google-cloud-debugger` gem.
 
 ## Enable Stackdriver Debugger API
 
-The Stackdriver Debugger agent needs the [Stackdriver Debugger 
-API](https://console.cloud.google.com/apis/library/clouddebugger.googleapis.com) 
-to be enabled on your Google Cloud project. Make sure it's enabled if not 
+The Stackdriver Debugger agent needs the [Stackdriver Debugger
+API](https://console.cloud.google.com/apis/library/clouddebugger.googleapis.com)
+to be enabled on your Google Cloud project. Make sure it's enabled if not
 already.
 
 ## Enabling the Debugger agent
@@ -47,7 +47,7 @@ frameworks, such as Ruby on Rails and Sinatra.
 
 ### With Ruby on Rails
 
-You can load the Railtie that comes with the library into your Ruby 
+You can load the Railtie that comes with the library into your Ruby
 on Rails application by explicitly requiring it during the application startup:
 
 ```ruby
@@ -55,12 +55,12 @@ on Rails application by explicitly requiring it during the application startup:
 require "google/cloud/debugger/rails"
 ```
 
-If you're using the `stackdriver` gem, it automatically loads the Railtie into 
+If you're using the `stackdriver` gem, it automatically loads the Railtie into
 your application when it starts.
 
 ### With other Rack-based frameworks
 
-Other Rack-based frameworks, such as Sinatra, can use the Rack Middleware 
+Other Rack-based frameworks, such as Sinatra, can use the Rack Middleware
 provided by the library:
 
 ```ruby
@@ -80,66 +80,66 @@ Google::Cloud::Debugger.new.start
 
 ### Configuring the agent
 
-You can customize the behavior of the Stackdriver Debugger agent. See the 
-[agent configuration](../stackdriver/docs/configuration.md) for a list of 
+You can customize the behavior of the Stackdriver Debugger agent. See the
+[agent configuration](../stackdriver/docs/configuration.md) for a list of
 possible configuration options.
 
 ## Running on Google Cloud Platform
 
-The Stackdriver Debugger agent should work without you manually providing 
-authentication credentials for instances running on Google Cloud Platform, as 
+The Stackdriver Debugger agent should work without you manually providing
+authentication credentials for instances running on Google Cloud Platform, as
 long as the Stackdriver Debugger API access scope is enabled on that instance.
 
 ### App Engine
 
-On Google App Engine, the Stackdriver Debugger API access scope is enabled by 
-default, and the Stackdriver Debugger agent can be used without providing 
+On Google App Engine, the Stackdriver Debugger API access scope is enabled by
+default, and the Stackdriver Debugger agent can be used without providing
 credentials or a project ID.
 
 ### Container Engine
 
-On Google Container Engine, you must explicitly add the `cloud_debugger` OAuth 
+On Google Container Engine, you must explicitly add the `cloud_debugger` OAuth
 scope when creating the cluster:
 
 ```sh
 $ gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud_debugger
 ```
 
-You can also do this through the Google Cloud Platform Console. Select 
+You can also do this through the Google Cloud Platform Console. Select
 **Enabled** in the Cloud Platform section of **Create a container cluster**.
 
 ### Compute Engine
 
-To use Stackdriver Debugger, Compute Engine VM instances should have one of the 
-following access scopes. These are only relevant when you use Compute Engine's 
+To use Stackdriver Debugger, Compute Engine VM instances should have one of the
+following access scopes. These are only relevant when you use Compute Engine's
 default service account:
 
 * `https://www.googleapis.com/auth/cloud-platform`
 * `https://www.googleapis.com/auth/cloud_debugger`
 
-The `cloud-platform` access scope can be supplied when creating a new instance 
-through the Google Cloud Platform Console. Select **Allow full access to all 
-Cloud APIs** in the **Identity and API access** section of **Create an 
+The `cloud-platform` access scope can be supplied when creating a new instance
+through the Google Cloud Platform Console. Select **Allow full access to all
+Cloud APIs** in the **Identity and API access** section of **Create an
 instance**.
 
-The `cloud_debugger` access scope must be supplied manually using the SDK's 
-`gcloud compute instances create` command or the `gcloud compute instances 
+The `cloud_debugger` access scope must be supplied manually using the SDK's
+`gcloud compute instances create` command or the `gcloud compute instances
 set-service-account` command.
 
 ## Running locally and elsewhere
 
-To run the Stackdriver Debugger agent outside of Google Cloud Platform, you must 
-supply your GCP project ID and appropriate service account credentials directly 
-to the Stackdriver Debugger agent. This applies to running the agent on your own 
-workstation, on your datacenter's computers, or on the VM instances of another 
-cloud provider. See the [Authentication section](#authentication) for 
+To run the Stackdriver Debugger agent outside of Google Cloud Platform, you must
+supply your GCP project ID and appropriate service account credentials directly
+to the Stackdriver Debugger agent. This applies to running the agent on your own
+workstation, on your datacenter's computers, or on the VM instances of another
+cloud provider. See the [Authentication section](#authentication) for
 instructions on how to do so.
 
 ## Authentication
 
 This library uses Service Account credentials to connect to Google Cloud
-services. When running on Compute Engine the credentials will be discovered 
-automatically. When running on other environments the Service Account 
+services. When running on Compute Engine the credentials will be discovered
+automatically. When running on other environments the Service Account
 credentials can be specified by providing in several ways.
 
 The best way to provide authentication information if you're using Ruby on Rails
@@ -159,7 +159,7 @@ end
 
 Other Rack-based applications that are loading the Rack Middleware directly can use
 the configration interface:
- 
+
 ```ruby
 require "google/cloud/debugger"
 Google::Cloud.configure do |config|
@@ -177,11 +177,11 @@ Or provide the parameters to the Stackdriver Debugger agent when it starts:
 ```ruby
 require "google/cloud/debugger"
 Google::Cloud::Debugger.new(project_id: "your-project-id",
-                            keyfile: "/path/to/key.json").start
+                            credentials: "/path/to/key.json").start
 ```
 
-This library also supports the other authentication methods provided by the 
-`google-cloud-ruby` suite. Instructions and configuration options are covered 
+This library also supports the other authentication methods provided by the
+`google-cloud-ruby` suite. Instructions and configuration options are covered
 in the [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-debugger/guides/authentication).
 
 ## Supported Ruby Versions

data/lib/google-cloud-debugger.rb

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 ##
-# This file is here to be autorequired by bundler, so that the .debugger and
-# #debugger methods can be available, but the library and all dependencies won't
-# be loaded until required and used.
+# This file is here to be autorequired by bundler, so that the
+# Google::Cloud.debugger and Google::Cloud#debugger methods can be available,
+# but the library and all dependencies won't be loaded until required and used.
 
 
 gem "google-cloud-core"
@@ -81,10 +81,12 @@ module Google
     # For more information on connecting to Google Cloud see the [Authentication
     # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
     #
-    # @param [String] project Project identifier for the Stackdriver Debugger
-    #   service you are connecting to.
-    # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
-    #   file path the file must be readable.
+    # @param [String] project_id Project identifier for the Stackdriver Debugger
+    #   service you are connecting to. If not present, the default project for
+    #   the credentials is used.
+    # @param [String, Hash, Google::Auth::Credentials] credentials The path to
+    #   the keyfile as a String, the contents of the keyfile as a Hash, or a
+    #   Google::Auth::Credentials object. (See {Debugger::Credentials})
     # @param [String] service_name Name for the debuggee application. Optional.
     # @param [String] service_version Version identifier for the debuggee
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
@@ -108,11 +110,12 @@ module Google
     #
     #   debugger.start
     #
-    def self.debugger project = nil, keyfile = nil, service_name: nil,
+    def self.debugger project_id = nil, credentials = nil, service_name: nil,
                       service_version: nil, scope: nil, timeout: nil,
                       client_config: nil
       require "google/cloud/debugger"
-      Google::Cloud::Debugger.new project: project, keyfile: keyfile,
+      Google::Cloud::Debugger.new project_id: project_id,
+                                  credentials: credentials,
                                   service_name: service_name,
                                   service_version: service_version,
                                   scope: scope, timeout: timeout,

data/lib/google/cloud/debugger.rb

@@ -339,10 +339,12 @@ module Google
       # [Authentication
       # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
       #
-      # @param [String] project Project identifier for the Stackdriver Debugger
-      #   service.
-      # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud:
-      #   either the JSON data or the path to a readable file.
+      # @param [String] project_id Project identifier for the Stackdriver
+      #   Debugger service you are connecting to. If not present, the default
+      #   project for the credentials is used.
+      # @param [String, Hash, Google::Auth::Credentials] credentials The path to
+      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
+      #   Google::Auth::Credentials object. (See {Debugger::Credentials})
       # @param [String] service_name Name for the debuggee application.
       #   Optional.
       # @param [String] service_version Version identifier for the debuggee
@@ -353,6 +355,10 @@ module Google
       #   APIs](https://developers.google.com/identity/protocols/OAuth2).
       #   The default scope is `https://www.googleapis.com/auth/cloud-platform`
       # @param [Integer] timeout Default timeout to use in requests. Optional.
+      # @param [String] project Project identifier for the Stackdriver Debugger
+      #   service.
+      # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud:
+      #   either the JSON data or the path to a readable file.
       #
       # @return [Google::Cloud::Debugger::Project]
       #
@@ -362,32 +368,32 @@ module Google
       #   debugger = Google::Cloud::Debugger.new
       #   debugger.start
       #
-      def self.new project: nil, keyfile: nil, service_name: nil,
+      def self.new project_id: nil, credentials: nil, service_name: nil,
                    service_version: nil, scope: nil, timeout: nil,
-                   client_config: nil
-        project ||= Debugger::Project.default_project
-        project = project.to_s # Always cast to a string
+                   client_config: nil, project: nil, keyfile: nil
+        project_id ||= (project || Debugger::Project.default_project_id)
+        project_id = project_id.to_s # Always cast to a string
         service_name ||= Debugger::Project.default_service_name
         service_name = service_name.to_s
         service_version ||= Debugger::Project.default_service_version
         service_version = service_version.to_s
 
-        fail ArgumentError, "project is missing" if project.empty?
+        fail ArgumentError, "project_id is missing" if project_id.empty?
         fail ArgumentError, "service_name is missing" if service_name.empty?
         fail ArgumentError, "service_version is missing" if service_version.nil?
 
-        credentials = Credentials.credentials_with_scope keyfile, scope
+        credentials ||= (keyfile || Debugger::Credentials.default(scope: scope))
+        unless credentials.is_a? Google::Auth::Credentials
+          credentials = Debugger::Credentials.new credentials, scope: scope
+        end
 
-        Google::Cloud::Debugger::Project.new(
-          Google::Cloud::Debugger::Service.new(
-            project, credentials, timeout: timeout,
-                                  client_config: client_config),
+        Debugger::Project.new(
+          Debugger::Service.new(project_id, credentials,
+                                timeout: timeout, client_config: client_config),
           service_name: service_name,
-          service_version: service_version
-        )
+          service_version: service_version)
       end
 
-
       ##
       # Configure the Stackdriver Debugger agent.
       #

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

@@ -13,29 +13,46 @@
 # limitations under the License.
 
 
-require "google/cloud/credentials"
+require "googleauth"
+require "google/cloud/logging/credentials"
 
 module Google
   module Cloud
     module Debugger
       ##
-      # @private Represents the OAuth 2.0 signing logic for Debugger.
-      class Credentials < Google::Cloud::Credentials
+      # # Credentials
+      #
+      # Represents the authentication and authorization used to connect to the
+      # Stackdriver Debugger service.
+      #
+      # @example
+      #   require "google/cloud/debugger"
+      #
+      #   keyfile = "/path/to/keyfile.json"
+      #   creds = Google::Cloud::Debugger::Credentials.new keyfile
+      #
+      #   debugger = Google::Cloud::Debugger.new(
+      #     project_id: "my-project",
+      #     credentials: creds
+      #   )
+      #
+      #   debugger.project_id #=> "my-project"
+      #
+      class Credentials < Google::Auth::Credentials
         SCOPE = ["https://www.googleapis.com/auth/cloud_debugger"] +
                 Google::Cloud::Logging::Credentials::SCOPE
-        PATH_ENV_VARS = %w(DEBUGGER_KEYFILE GOOGLE_CLOUD_KEYFILE GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(DEBUGGER_KEYFILE_JSON GOOGLE_CLOUD_KEYFILE_JSON
+        PATH_ENV_VARS = %w(DEBUGGER_CREDENTIALS
+                           GOOGLE_CLOUD_CREDENTIALS
+                           DEBUGGER_KEYFILE
+                           GOOGLE_CLOUD_KEYFILE
+                           GCLOUD_KEYFILE)
+        JSON_ENV_VARS = %w(DEBUGGER_CREDENTIALS_JSON
+                           GOOGLE_CLOUD_CREDENTIALS_JSON
+                           DEBUGGER_KEYFILE_JSON
+                           GOOGLE_CLOUD_KEYFILE_JSON
                            GCLOUD_KEYFILE_JSON)
-
-        ##
-        # @private Create credentials with given scope and/or keyfile
-        def self.credentials_with_scope keyfile, scope = nil
-          if keyfile.nil?
-            default(scope: scope)
-          else
-            new(keyfile, scope: scope)
-          end
-        end
+        DEFAULT_PATHS = \
+          ["~/.config/gcloud/application_default_credentials.json"]
       end
     end
   end

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

@@ -17,6 +17,7 @@ require "digest/sha1"
 require "google/cloud/debugger/backoff"
 require "google/cloud/debugger/debuggee/app_uniquifier_generator"
 require "google/cloud/debugger/version"
+require "google/cloud/env"
 require "json"
 
 module Google
@@ -68,6 +69,7 @@ module Google
           @service = service
           @service_name = service_name
           @service_version = service_version
+          @env = Google::Cloud.env
           @computed_uniquifier = nil
           @id = nil
           @register_backoff = Google::Cloud::Debugger::Backoff.new
@@ -123,7 +125,7 @@ module Google
         # @private Build the parameters for this debuggee
         def build_request_arg
           debuggee_args = {
-            project: project_id,
+            project: project_id_for_request_arg,
             description: description,
             labels: labels,
             agent_version: agent_version
@@ -177,6 +179,19 @@ module Google
           service.project
         end
 
+        ##
+        # @private
+        # Get project to send as a debuggee argument. This is the numeric
+        # project ID if available (and if it matches the project set in the
+        # configuration). Otherwise, use the configured project.
+        def project_id_for_request_arg
+          if project_id == @env.project_id
+            numeric_id = @env.numeric_project_id
+            return numeric_id.to_s if numeric_id
+          end
+          project_id
+        end
+
         ##
         # @private Build debuggee agent version identifier
         def agent_version

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

@@ -116,7 +116,7 @@ module Google
         # Fallback to default configuration values if not defined already
         def init_default_config
           configuration.project_id ||= Cloud.configure.project_id ||
-                                       Debugger::Project.default_project
+                                       Debugger::Project.default_project_id
           configuration.keyfile ||= Cloud.configure.keyfile
 
           configuration.service_name ||= Debugger::Project.default_service_name

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

@@ -65,19 +65,20 @@ module Google
         #   require "google/cloud/debugger"
         #
         #   debugger = Google::Cloud::Debugger.new(
-        #     project: "my-project",
-        #     keyfile: "/path/to/keyfile.json"
+        #     project_id: "my-project",
+        #     credentials: "/path/to/keyfile.json"
         #   )
         #
-        #   debugger.project #=> "my-project"
+        #   debugger.project_id #=> "my-project"
         #
-        def project
+        def project_id
           service.project
         end
+        alias_method :project, :project_id
 
         ##
         # @private Default project.
-        def self.default_project
+        def self.default_project_id
           ENV["DEBUGGER_PROJECT"] ||
             ENV["GOOGLE_CLOUD_PROJECT"] ||
             ENV["GCLOUD_PROJECT"] ||

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

@@ -110,16 +110,22 @@ module Google
         # Fallback to default config values if config parameters not provided.
         def self.init_default_config
           config = Debugger.configure
-          config.project_id ||= Debugger::Project.default_project
+          config.project_id ||= Debugger::Project.default_project_id
           config.service_name ||= Debugger::Project.default_service_name
           config.service_version ||= Debugger::Project.default_service_version
         end
 
         ##
         # @private Verify credentials
-        def self.valid_credentials? project_id, keyfile
+        def self.valid_credentials? project_id, credentials
           begin
-            Debugger::Credentials.credentials_with_scope keyfile
+            # if credentials is nil, get default
+            credentials ||= Debugger::Credentials.default(scope: scope)
+            # only create a new Credentials object if the val isn't one already
+            unless credentials.is_a? Google::Auth::Credentials
+              # if credentials is not a Credentials object, create one
+              Debugger::Credentials.new credentials, scope: scope
+            end
           rescue => e
             STDOUT.puts "Note: Google::Cloud::Debugger is disabled because " \
               "it failed to authorize with the service. (#{e.message})"