google-cloud-env 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fe4fb0b390a089e7efb8cde45fb7f6df9e86b25ab81b84292a67fe481341137
-  data.tar.gz: 5efcbb333c4796812b99332cfc9919ae00f1e39104f092edc1392ba558d40caf
+  metadata.gz: 3cc8828b19648ebf3ddbf107e0752ca0dfec854602d7f295ee5a96a3f9a87552
+  data.tar.gz: 4cd7a33f479ea15c423695b4652ce82f1f411d33954b8102dea32aef19ee7b6e
 SHA512:
-  metadata.gz: b74d450efba00970ed06f659dbedca0391f3128bb9ce6e0abb7d5580c18d55fd58a65ac81ffb6be5a10bc4b07ca41c9121f32df1ef87de455b96993d716150f0
-  data.tar.gz: 2dde707316115cda0096dbc949d8a6f8dae5f4110540a986bcb89aa1cbd258aebc496ca159b4a47f17fc2dda4277ac0d83c332a9519186451ec027f67633ca0d
+  metadata.gz: a2ec60debebb19dfb788b07124fec5855ce2baf795f7d97a9e2d0c43bbcc0a3f599d8a84e85592283dda5a1b735c170fbfd702fb48fdd5645e469340a684c864
+  data.tar.gz: 1615868a96d4f5d3ebbc064b99e29b79cc3446a253c1becd94abe27c71a6e60c1e59b4b2b3ec9a5c4bff52ff1f1c6fbd4acaf60a9b55ea7c4aa5e4310b633630

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Release History
 
+### 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
+
+* 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.

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,118 +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.
 
-## 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
-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 [Code of Conduct](CODE_OF_CONDUCT.md) 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/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
 
       ##
@@ -210,7 +215,10 @@ module Google
       # @return [String,nil]
       #
       def project_id
-        env["GCLOUD_PROJECT"] || env["DEVSHELL_PROJECT_ID"] || lookup_metadata("project", "project-id")
+        env["GOOGLE_CLOUD_PROJECT"] ||
+          env["GCLOUD_PROJECT"] ||
+          env["DEVSHELL_PROJECT_ID"] ||
+          lookup_metadata("project", "project-id")
       end
 
       ##

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

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

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-env
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2021-03-08 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.17.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: autotest-suffix
   requirement: !ruby/object:Gem::Requirement
@@ -44,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
@@ -195,14 +201,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.0.6
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: Google Cloud Platform hosting environment information.