google-cloud-env 1.3.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cc1587d2fad1a7c47c154488e76f4441d4dbb2a4c9a56826f0a18d2027d3e5d
-  data.tar.gz: '0998d2e1d9568e680b87f6da44e892c3c2d800ee6e6f17e562f6855c9f5813b8'
+  metadata.gz: c1d6be34c567d4881e2f9e841727cbde968ae37bfd41b5d27bcd3c7b21840d8c
+  data.tar.gz: 7aa6c6c1805fb4f51e1b76685740c47a8017629447ab0d7f91f602761e0b7c89
 SHA512:
-  metadata.gz: f1d417ccdc7fc15e61cdc13a1493f406b0f2437738b5afd51eb00cc8b48e331a1e1145d9debb2246945a3dab38b808f478ad9499da313a901ab7358bc9c404f5
-  data.tar.gz: 40a8fb198fc780aa6057e4e56d420b12021f7c401a52765a591f7b761019f1f52ddcea9411659def21c9f704748f8cf69a8dadbded7d22e86cbddbf74d182cb2
+  metadata.gz: 85b70ad063ca34727e9838b78933231c7181b8d82cd3c12fd69a199da4af7d24655700147277a9dea7cab575f5d90b1007337a2bfbde24f087e573f8bd77c57b
+  data.tar.gz: dc25667e37ffd201c6000542e2f4fcba4f2f1466bd7f6167932322cb0fd40a9fbbfbb42033ed836f1db98f836b6cdd4e1ce345b362cf746b0ba86019e43d2631

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Release History
 
+## [1.6.0](https://www.github.com/googleapis/ruby-cloud-env/compare/google-cloud-env/v1.5.0...google-cloud-env/v1.6.0) (2022-03-21)
+
+
+### Features
+
+* **deps:** update actions/setup-node action to v3 ([#27](https://www.github.com/googleapis/ruby-cloud-env/issues/27)) ([ffb9430](https://www.github.com/googleapis/ruby-cloud-env/commit/ffb9430e67bc4504d8c4f69203a0f911a90bff5a))
+
+### 1.5.0 (2021-03-08)
+
+#### Features
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
+
+### 1.4.0 / 2020-10-12
+
+#### Features
+
+* Honor GCE_METADATA_HOST environment variable
+
 ### 1.3.3 / 2020-07-10
 
 #### Bug Fixes

data/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to Google Cloud hosting environment
+# Contributing to Google Cloud Ruby Client
 
 1. **Sign one of the contributor license agreements below.**
 2. Fork the repo, develop and test your code changes.
@@ -6,105 +6,66 @@
 
 ## Contributor License Agreements
 
-Before we can accept your pull requests you'll need to sign a Contributor
-License Agreement (CLA):
+Before we can accept your pull requests you'll need to sign a Contributor License Agreement (CLA):
 
-- **If you are an individual writing original source code** and **you own the
-  intellectual property**, then you'll need to sign an [individual
-  CLA](https://developers.google.com/open-source/cla/individual).
-- **If you work for a company that wants to allow you to contribute your work**,
-  then you'll need to sign a [corporate
-  CLA](https://developers.google.com/open-source/cla/corporate).
+- **If you are an individual writing original source code** and **you own the intellectual property**, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
+- **If you work for a company that wants to allow you to contribute your work**, then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).
 
-You can sign these electronically (just scroll to the bottom). After that, we'll
-be able to accept your pull requests.
+You can sign these electronically (just scroll to the bottom). After that, we'll be able to accept your pull requests.
 
 ## Setup
 
-In order to use the google-cloud-env console and run the project's tests,
-there is a small amount of setup:
+In order to use the google-cloud-ruby console and run the project's tests, there is a
+small amount of setup:
 
-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).
+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).
 
-2. Install [Bundler](http://bundler.io/).
+2.  Install [Bundler](http://bundler.io/).
 
-   ```sh
-   $ gem install bundler
-   ```
+    ```sh
+    $ gem install bundler
+    ```
 
-3. Install the top-level project dependencies.
+3.  Install the project dependencies.
 
-   ```sh
-   $ bundle install
-   ```
+    ```sh
+    $ bundle install
+    ```
 
-4. Install the hosting environment dependencies.
+## Tests
 
-   ```sh
-   $ cd google-cloud-env/
-   $ bundle exec rake bundleupdate
-   ```
+All contributions should include tests that ensure the contributed code behaves as expected.
 
-## hosting environment Tests
-
-Tests are very important part of google-cloud-env. All contributions
-should include tests that ensure the contributed code behaves as expected.
-
-To run the unit tests, documentation tests, and code style checks together for a
-package:
+To run the tests and code style checks together:
 
 ``` sh
-$ cd google-cloud-env/
 $ bundle exec rake ci
 ```
 
-To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
-its handy alias, `rake ci:a`.
-
-### hosting environment Unit Tests
+### Unit Tests
 
+The project uses the [minitest](https://github.com/seattlerb/minitest) library, including [specs](https://github.com/seattlerb/minitest#specs), [mocks](https://github.com/seattlerb/minitest#mocks) and [minitest-autotest](https://github.com/seattlerb/minitest-autotest).
 
-The project uses the [minitest](https://github.com/seattlerb/minitest) library,
-including [specs](https://github.com/seattlerb/minitest#specs),
-[mocks](https://github.com/seattlerb/minitest#mocks) and
-[minitest-autotest](https://github.com/seattlerb/minitest-autotest).
-
-To run the hosting environment unit tests:
+To run the unit tests for a package:
 
 ``` sh
-$ cd google-cloud-env/
 $ bundle exec rake test
 ```
 
-### hosting environment Documentation Tests
+### Coding Style
 
-The project tests the code examples in the gem's
-[YARD](https://github.com/lsegal/yard)-based documentation.
+Please follow the established coding style in the library. The style is is largely based on [The Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based on seattle-style:
 
-The example testing functions in a way that is very similar to unit testing, and
-in fact the library providing it,
-[yard-doctest](https://github.com/p0deje/yard-doctest), is based on the
-project's unit test library, [minitest](https://github.com/seattlerb/minitest).
+* Avoid parenthesis when possible, including in method definitions.
+* Always use double quotes strings. ([Option B](https://github.com/bbatsov/ruby-style-guide#strings))
 
-To run the hosting environment documentation tests:
+You can check your code against these rules by running Rubocop like so:
 
-``` sh
-$ cd google-cloud-env/
-$ bundle exec rake doctest
+```sh
+$ bundle exec rake rubocop
 ```
 
-If you add, remove or modify documentation examples when working on a pull
-request, you may need to update the setup for the tests. The stubs and mocks
-required to run the tests are located in `support/doctest_helper.rb`. Please
-note that much of the setup is matched by the title of the
-[`@example`](http://www.rubydoc.info/gems/yard/file/docs/Tags.md#example) tag.
-If you alter an example's title, you may encounter breaking tests.
-
 ## Code of Conduct
 
-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
-{file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
+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 {file:CODE_OF_CONDUCT.md Code of Conduct} for more information.

data/LICENSE

@@ -1,6 +1,6 @@
                                  Apache License
                            Version 2.0, January 2004
-                        https://www.apache.org/licenses/
+                        http://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
@@ -192,7 +192,7 @@
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
-       https://www.apache.org/licenses/LICENSE-2.0
+       http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,

data/README.md

@@ -7,11 +7,11 @@ apps running on Google Cloud Platform.
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.4+.
+This library is supported on Ruby 2.5+.
 
 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.4 and
+security maintenance, and not end of life. Currently, this means Ruby 2.5 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/SECURITY.md

@@ -0,0 +1,7 @@
+# Security Policy
+
+To report a security issue, please use [g.co/vulnz](https://g.co/vulnz).
+
+The Google Security Team will respond within 5 working days of your report on g.co/vulnz.
+
+We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue.

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

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

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,7 +117,9 @@ 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
 
       ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-env
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,7 +19,7 @@ dependencies:
         version: 0.17.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.17.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: autotest-suffix
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -186,13 +186,18 @@ files:
 - CONTRIBUTING.md
 - LICENSE
 - README.md
+- SECURITY.md
 - lib/google-cloud-env.rb
 - lib/google/cloud/env.rb
 - lib/google/cloud/env/version.rb
-homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-env
+homepage: https://github.com/googleapis/ruby-cloud-env
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://googleapis.dev/ruby/google-cloud-env/v1.6.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/googleapis/ruby-cloud-env
+  bug_tracker_uri: https://github.com/googleapis/ruby-cloud-env/issues
+  documentation_uri: https://googleapis.dev/ruby/google-cloud-env/v1.6.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -201,14 +206,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Google Cloud Platform hosting environment information.