google-cloud-env 1.2.0 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ef4d05db69a9e9b94528892fdbc6290b465ac045b1ab140c43682d8a0c96606
-  data.tar.gz: 76d191dc0d86415f21383217be630c81cb2ddd76cc091c65c17a72eb6e51aaaf
+  metadata.gz: 6cc1587d2fad1a7c47c154488e76f4441d4dbb2a4c9a56826f0a18d2027d3e5d
+  data.tar.gz: '0998d2e1d9568e680b87f6da44e892c3c2d800ee6e6f17e562f6855c9f5813b8'
 SHA512:
-  metadata.gz: 331c0562ed88b3e9cb0252e01c8b6126d20f714b329a16c1afdb8d26e2902682c4b577f8f1d3721300ab27a4c223ab11720a1afc5b92862594798fcc25895686
-  data.tar.gz: 5fdf10aa396e7d58396bc238f4888fe26f06d9dcd3254475f7bc9bf6aeb7fcf7568af0c7f46764e3dcda25c164ed9e712d8ea514ed71ca4674099f0005d9f69e
+  metadata.gz: f1d417ccdc7fc15e61cdc13a1493f406b0f2437738b5afd51eb00cc8b48e331a1e1145d9debb2246945a3dab38b808f478ad9499da313a901ab7358bc9c404f5
+  data.tar.gz: 40a8fb198fc780aa6057e4e56d420b12021f7c401a52765a591f7b761019f1f52ddcea9411659def21c9f704748f8cf69a8dadbded7d22e86cbddbf74d182cb2

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Release History
 
+### 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
+
+* Send Metadata-Flavor header when testing the metadata server root
+
+#### Documentation
+
+* Update documentation
+
 ### 1.2.0 / 2019-06-19
 
 * Support separate timeout for connecting to the metadata server vs the entire request

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

@@ -3,15 +3,15 @@
 This library provides information on the application hosting environment for
 apps running on Google Cloud Platform.
 
-- [google-cloud-env API documentation](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-env/latest)
+- [google-cloud-env API documentation](https://googleapis.dev/ruby/google-cloud-env/latest)
 
 ## 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.
@@ -28,18 +28,18 @@ change at any time and the public API should not be considered stable.
 Contributions to this library are always welcome and highly encouraged.
 
 See the [Contributing
-Guide](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-env/latest/file.CONTRIBUTING)
+Guide](https://googleapis.dev/ruby/google-cloud-env/latest/file.CONTRIBUTING.html)
 for more information on how to get started.
 
 Please note that this project is released with a Contributor Code of Conduct. By
 participating in this project you agree to abide by its terms. See [Code of
-Conduct](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-env/latest/file.CODE_OF_CONDUCT)
+Conduct](https://googleapis.dev/ruby/google-cloud-env/latest/file.CODE_OF_CONDUCT.html)
 for more information.
 
 ## License
 
 This library is licensed under Apache 2.0. Full license text is available in
-[LICENSE](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-env/latest/file.LICENSE).
+[LICENSE](https://googleapis.dev/ruby/google-cloud-env/latest/file.LICENSE.html).
 
 ## Support
 

data/lib/google/cloud/env.rb

@@ -114,8 +114,17 @@ 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)
+        @connection = connection || ::Faraday.new(url: METADATA_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 +136,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 +200,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 +210,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 +315,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 +345,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 +393,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
@@ -356,7 +408,9 @@ module Google
         path = METADATA_ROOT_PATH
         if @disable_metadata_cache || !metadata_cache.include?(path)
           metadata_cache[path] = retry_or_fail_with false do
-            resp = connection.get path
+            resp = connection.get path do |req|
+              req.headers = { "Metadata-Flavor" => "Google" }
+            end
             resp.status == 200 && resp.headers["Metadata-Flavor"] == "Google"
           end
         end
@@ -413,9 +467,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.0".freeze
+      VERSION = "1.3.3".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.0
+  version: 1.3.3
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2020-07-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.3
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Google Cloud Platform hosting environment information.