google-cloud-env 1.1.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf38fd3f5bb159512f455fde243bd4c6f120535533c5762b92ba28f107fb69ca
-  data.tar.gz: e989ea213443a933d3fa824fb23dc1a0c2e02e613936fe4e135aebc568aa1109
+  metadata.gz: 0ee42ea850521061d3f1a6c8de4205c5d546a84d5e7329c6537856087e809f89
+  data.tar.gz: d7f27f16c341483065e6345d04138a3ae0789e650856d351e909dcef439c9e48
 SHA512:
-  metadata.gz: f0ce4b36dae87c5229eae4210e63487da960033430b47e11280cb4752da742d39d7dd3d24ed3cc7ea710124f75da0dbb7b8fa4e36a1ae29cce9f052e77c34100
-  data.tar.gz: d24d266602fa82aba6a6a050f049470c9c85cf937b6e0bd58d804135881b889451219e90f2058b88a74cb67ca1b5741d9df31eeeff8ee8f56a601c82bdd4b4a6
+  metadata.gz: f1d4cf238414e5cc08e3ca994a35d15b2912b0358c7de4d33f23a61d7bfeeb93d661bb2ec68d6f8a8a3178e72285a571bf2a44ea0f98ed46f72764a6ae983110
+  data.tar.gz: 755c1039f5af08315f5e3ce2df79942651d07a82ba059e06c29a45d19971c11c7dcf7182e4e0115b2974a14fbdb9c17f2a321bb1ca6d1bb4416fa73b261a8606

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Release History
 
+### 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
+
 ### 1.1.0 / 2019-05-29
 
 * Support disabling of the metadata cache

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

@@ -78,14 +78,17 @@ module Google
       # Create a new instance of the environment information.
       # Most client should not need to call this directly. Obtain a singleton
       # instance of the information from `Google::Cloud.env`. This constructor
-      # is provided for internal testing and allows mocking of the data.
+      # is provided to allow customization of the timeout/retry settings, as
+      # well as mocking for testing.
       #
       # @param [Hash] env Mock environment variables.
       # @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.
-      # @param [Numeric] request_timeout Timeout for each http request.
+      # @param [Numeric] open_timeout Timeout for opening http connections.
       #     Defaults to 0.1.
+      # @param [Numeric] request_timeout Timeout for entire http requests.
+      #     Defaults to 1.0.
       # @param [Integer] retry_count Number of times to retry http requests.
       #     Defaults to 1. Note that retry remains in effect even if a custom
       #     `connection` is provided.
@@ -96,10 +99,12 @@ module Google
       # @param [Numeric] retry_max_interval Maximum time between retries in
       #     seconds. Defaults to 0.5.
       # @param [Faraday::Connection] connection Faraday connection to use.
-      #     If specified, overrides the `request_timeout` setting.
+      #     If specified, overrides the `request_timeout` and `open_timeout`
+      #     settings.
       #
       def initialize env: nil, connection: nil, metadata_cache: nil,
-                     request_timeout: 0.1, retry_count: 2, retry_interval: 0.1,
+                     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
         @disable_metadata_cache = metadata_cache == false
         @metadata_cache = metadata_cache || {}
@@ -108,9 +113,18 @@ module Google
         @retry_interval = retry_interval
         @retry_backoff_factor = retry_backoff_factor
         @retry_max_interval = retry_max_interval
-        @connection = connection ||
-                      ::Faraday.new(url: METADATA_HOST,
-                                    request: { timeout: request_timeout })
+        request_opts = { timeout: request_timeout, open_timeout: open_timeout }
+        @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
 
       ##
@@ -122,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).
@@ -166,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
 
       ##
@@ -176,8 +210,7 @@ module Google
       # @return [String,nil]
       #
       def project_id
-        env["GCLOUD_PROJECT"] || env["DEVSHELL_PROJECT_ID"] ||
-          lookup_metadata("project", "project-id")
+        env["GCLOUD_PROJECT"] || env["DEVSHELL_PROJECT_ID"] || lookup_metadata("project", "project-id")
       end
 
       ##
@@ -279,6 +312,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.
@@ -288,6 +342,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
@@ -335,8 +390,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
@@ -351,7 +405,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
@@ -408,9 +464,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.1.0".freeze
+      VERSION = "1.3.2".freeze
     end
   end
 end

metadata

@@ -1,87 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-env
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2020-05-28 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.0.6
 signing_key: 
 specification_version: 4
 summary: Google Cloud Platform hosting environment information.