google-cloud-env 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5882fde9edf76ee2c9f1e0d0f778009a9e7e5ddb60b770cc2e33c80c527debc
-  data.tar.gz: e86f1d130b57000bdd80b34b0c04dd2849af88827e78ad10b4c884914c221389
+  metadata.gz: 98da1b266783f22f91d9f220cb311a35d3955d7f638e67aaa77d60e3ace6e58e
+  data.tar.gz: 39386abb55069149c081132808a85fc14a2b23285e3371b7632bbb1e7337815f
 SHA512:
-  metadata.gz: 44a6feec89cef1114361b03118f64b3af679ac5ab2048a51407a9767ba4d9d7898cfaa1c15f4bc1c971cb015b9fe42f8d8bda780ef76881df6e374725552e67a
-  data.tar.gz: 99dafff56a0b4e4ab6c82f0413c342f3bbecd3e13a8016efb87a88ba222de292976c2e8256c8d1bc672a4433a1ab500b6e9e856c48049296b42fe3ecc6f27cc8
+  metadata.gz: 40ed7fab707ea30a4fa993d3c0560ef05ee9362c666191a5fe3f47a0edbac5e770fec6b5941be1c33d92b068e31fb1a094a3d34009b17b186ff60aaaf3707641
+  data.tar.gz: 7a4165816c410b2d8f0bf044b4d8c65f9bb4960dc8a976a97621ac7bcb424795b58863a2a8668b81a87b4081c82adf74e51e8c5705ef7f5c0094ced2de411028

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Release History
 
+### 1.4.0 / 2020-10-12
+
+#### Features
+
+* Honor GCE_METADATA_HOST environment variable
+
+### 1.3.3 / 2020-07-10
+
+#### Bug Fixes
+
+* Project ID logic honors GOOGLE_CLOUD_PROJECT
+
+### 1.3.2 / 2020-05-28
+
+#### Documentation
+
+* Fix a few broken links
+
+### 1.3.1 / 2020-03-02
+
+#### Bug Fixes
+
+* support faraday 1.x
+
+### 1.3.0 / 2019-10-23
+
+Now requires Ruby 2.4 or later.
+
+#### Features
+
+* Recognize App Engine Standard and Knative
+
 ### 1.2.1 / 2019-08-23
 
 #### Bug Fixes

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud-env console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-env requires Ruby 2.3+. You may choose to
+1. Install Ruby. google-cloud-env requires Ruby 2.4+. 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).
@@ -48,19 +48,6 @@ there is a small amount of setup:
    $ bundle exec rake bundleupdate
    ```
 
-## Console
-
-In order to run code interactively, you can automatically load
-google-cloud-env and its dependencies in IRB. This requires that your
-developer environment has already been configured by following the steps
-described in the {file:AUTHENTICATION.md Authentication Guide}. An IRB console
-can be created with:
-
-```sh
-$ cd google-cloud-env/
-$ bundle exec rake console
-```
-
 ## hosting environment Tests
 
 Tests are very important part of google-cloud-env. All contributions

data/README.md

@@ -7,11 +7,11 @@ apps running on Google Cloud Platform.
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.3+.
+This library is supported on Ruby 2.4+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
-security maintenance, and not end of life. Currently, this means Ruby 2.3 and
+security maintenance, and not end of life. Currently, this means Ruby 2.4 and
 later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.

data/lib/google/cloud/env.rb

@@ -82,6 +82,9 @@ module Google
       # well as mocking for testing.
       #
       # @param [Hash] env Mock environment variables.
+      # @param [String] host The hostname or IP address of the metadata server.
+      #     Optional. If not specified, uses the `GCE_METADATA_HOST`,
+      #     environment variable or falls back to `169.254.167.254`.
       # @param [Hash,false] metadata_cache The metadata cache. You may pass
       #     a prepopuated cache, an empty cache (the default) or `false` to
       #     disable the cache completely.
@@ -102,7 +105,7 @@ module Google
       #     If specified, overrides the `request_timeout` and `open_timeout`
       #     settings.
       #
-      def initialize env: nil, connection: nil, metadata_cache: nil,
+      def initialize env: nil, host: nil, connection: nil, metadata_cache: nil,
                      open_timeout: 0.1, request_timeout: 1.0,
                      retry_count: 2, retry_interval: 0.1,
                      retry_backoff_factor: 1.5, retry_max_interval: 0.5
@@ -114,8 +117,19 @@ module Google
         @retry_backoff_factor = retry_backoff_factor
         @retry_max_interval = retry_max_interval
         request_opts = { timeout: request_timeout, open_timeout: open_timeout }
-        @connection = connection ||
-                      ::Faraday.new(url: METADATA_HOST, request: request_opts)
+        host ||= @env["GCE_METADATA_HOST"] || METADATA_HOST
+        host = "http://#{host}" unless host.start_with? "http://"
+        @connection = connection || ::Faraday.new(url: host, request: request_opts)
+      end
+
+      ##
+      # Determine whether the application is running on a Knative-based
+      # hosting platform, such as Cloud Run or Cloud Functions.
+      #
+      # @return [Boolean]
+      #
+      def knative?
+        env["K_SERVICE"] ? true : false
       end
 
       ##
@@ -127,6 +141,26 @@ module Google
         env["GAE_INSTANCE"] ? true : false
       end
 
+      ##
+      # Determine whether the application is running on Google App Engine
+      # Flexible Environment.
+      #
+      # @return [Boolean]
+      #
+      def app_engine_flexible?
+        app_engine? && env["GAE_ENV"] != "standard"
+      end
+
+      ##
+      # Determine whether the application is running on Google App Engine
+      # Standard Environment.
+      #
+      # @return [Boolean]
+      #
+      def app_engine_standard?
+        app_engine? && env["GAE_ENV"] == "standard"
+      end
+
       ##
       # Determine whether the application is running on Google Kubernetes
       # Engine (GKE).
@@ -171,7 +205,7 @@ module Google
       # @return [Boolean]
       #
       def raw_compute_engine?
-        !app_engine? && !cloud_shell? && metadata? && !kubernetes_engine?
+        !knative? && !app_engine? && !cloud_shell? && metadata? && !kubernetes_engine?
       end
 
       ##
@@ -181,7 +215,9 @@ module Google
       # @return [String,nil]
       #
       def project_id
-        env["GCLOUD_PROJECT"] || env["DEVSHELL_PROJECT_ID"] ||
+        env["GOOGLE_CLOUD_PROJECT"] ||
+          env["GCLOUD_PROJECT"] ||
+          env["DEVSHELL_PROJECT_ID"] ||
           lookup_metadata("project", "project-id")
       end
 
@@ -284,6 +320,27 @@ module Google
         lookup_metadata "instance", "attributes/#{key}"
       end
 
+      ##
+      # Returns the name of the running Knative service, or `nil` if the
+      # current code is not running on Knative.
+      #
+      # @return [String,nil]
+      #
+      def knative_service_id
+        env["K_SERVICE"]
+      end
+      alias knative_service_name knative_service_id
+
+      ##
+      # Returns the revision of the running Knative service, or `nil` if the
+      # current code is not running on Knative.
+      #
+      # @return [String,nil]
+      #
+      def knative_service_revision
+        env["K_REVISION"]
+      end
+
       ##
       # Returns the name of the running App Engine service, or `nil` if the
       # current code is not running in App Engine.
@@ -293,6 +350,7 @@ module Google
       def app_engine_service_id
         env["GAE_SERVICE"]
       end
+      alias app_engine_service_name app_engine_service_id
 
       ##
       # Returns the version of the running App Engine service, or `nil` if the
@@ -340,8 +398,7 @@ module Google
         # below is set in some older versions of GKE, and the file below is
         # present in Kubernetes as of version 1.9, but it is possible that
         # alternatives will need to be found in the future.
-        env["GKE_NAMESPACE_ID"] ||
-          ::IO.read("/var/run/secrets/kubernetes.io/serviceaccount/namespace")
+        env["GKE_NAMESPACE_ID"] || ::IO.read("/var/run/secrets/kubernetes.io/serviceaccount/namespace")
       rescue SystemCallError
         nil
       end
@@ -415,9 +472,7 @@ module Google
           if retries_remaining >= 0
             sleep retry_interval
             retry_interval *= @retry_backoff_factor
-            if retry_interval > @retry_max_interval
-              retry_interval = @retry_max_interval
-            end
+            retry_interval = @retry_max_interval if retry_interval > @retry_max_interval
             retry
           end
           error_result

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     class Env
-      VERSION = "1.2.1".freeze
+      VERSION = "1.4.0".freeze
     end
   end
 end

metadata

@@ -1,87 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-env
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-23 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.17.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: autotest-suffix
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: minitest-autotest
+  name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
-  name: minitest-focus
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: autotest-suffix
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -95,33 +101,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.64.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.64.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -195,14 +201,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Google Cloud Platform hosting environment information.