gcp_data 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 520c99905f33a6488c28287cff6c17066f2872ca0dd6a1e77d3aae4e22fc772e
-  data.tar.gz: 1b5db4f3582ee307b18185a3c9fc1bbaf5e4fc08995b47c475040939cbb1baa1
+  metadata.gz: 398e39c8a777684e03619a5941d86c1f2b683093919d5c8d3bf14a411078b375
+  data.tar.gz: f1ffef56aa9e2281c0415f161b30542dd21c1fdfa73356f5a21e4bf1a4f230bc
 SHA512:
-  metadata.gz: b5c972fe8d61620b514ae343c06965fde8f3ae210a3c0e9afd6fd55ed99169163904fd9d251302af4e1c95ae2767401a1feb896bfd06ef70c3c53fc819bdfec6
-  data.tar.gz: f98fa34a9db7daf5cd2213fe818938f8a21816c0375afe67663e54f11d015a89b7ac889c38eb91a879390d07c88d6edb1d350aed286f95419e881d45cfcb8813
+  metadata.gz: 84e03b633b383e974a172816f417d7aa3b748d579ae0c9f03ee258b0f2828e9ff42da2b167afb4c076f7fcc97bd626c5cf5845096ddac277274073ee60872ccf
+  data.tar.gz: 21fa79d030a23a613707f842144e21bbbeba9d3b97cb855ff5062a95af3f655670bf4161a76e78fe54cf6ecf7597f40d544d89d27ed6eccbc9f6ff9808556425

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -3,8 +3,11 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [0.2.0]
+- #1 additional precedence lookups
+
 ## [0.1.1]
-- remote puts hello debug
+- remove puts hello debug
 
 ## [0.1.0]
 - Initial release

data/README.md

@@ -18,19 +18,61 @@ Or install it yourself as:
 
     $ gem install gcp_data
 
-Currently, requires the `gcloud` command to be installed.
+This library can rely on the `gcloud` command, so it should be installed.
 
 ## Usage
 
-```
+```ruby
 GcpData.project
 GcpData.region
 ```
 
-## Contributing
+## Precedence
+
+This library will return prjoect and region info using different sources with this precedence:
+
+1. Environment variables: GOOGLE_PROJECT, GOOGLE_REGION, GOOGLE_ZONE
+2. Google Credentials file: only project id available from the GOOGLE\_APPLICATION_CREDENTIALS file
+3. CLI: gcloud
+4. Defaults: region=us-central1 and zone==us-central1a
+
+### 1. Environment variables
+
+The environment variables take the highest precedence: GOOGLE_PROJECT, GOOGLE_REGION, GOOGLE_ZONE
+
+### 2. Google credentials file
+
+You can also authenticate to the Google API by setting a GOOGLE\_APPLICATION_CREDENTIALS env var that points to file a JSON file on your system. Example: `GOOGLE_APPLICATION_CREDENTIALS=~/.gcp/credentials.json`. More info at google docs: [Getting Started with Authentication](https://cloud.google.com/docs/authentication/getting-started).
+
+This file contains a project_id key. So if you have set the GOOGLE\_APPLICATION_CREDENTIALS and not set the GOOGLE_PROJECT var, then this library will use the project_id from the GOOGLE\_APPLICATION_CREDENTIALS file.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gcp_data.
+### 3. CLI: gcloud
 
-## License
+The gcloud cli can also be used to set and get google project and region info. Here's a cheatsheet of the commands:
+
+    gcloud config list
+    gcloud config set project project-123
+    gcloud config set compute/region us-central1
+    gcloud config set compute/zone us-central1-b
+
+The commands saves to a file in ~/.config/gcloud. The file looks something like this:
+
+~/.config/gcloud/configurations/config_default
+
+    [core]
+    project = project-12345
+
+    [compute]
+    region = us-central1
+    zone   = us-central1-a
+
+### 4. Defaults
+
+The library will fallback to default values when it's unable to lookup the region and zone. The default values are:
+
+    region=us-central1
+    zone==us-central1a
+
+## Contributing
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Bug reports and pull requests are welcome on GitHub at https://github.com/tongueroo/gcp_data.

data/lib/gcp_data.rb

@@ -1,3 +1,4 @@
+require "json"
 require "memoist"
 
 module GcpData
@@ -5,18 +6,34 @@ module GcpData
   extend Memoist
 
   def project
-    gcloud_config("core/project")
+    ENV['GOOGLE_PROJECT'] || creds("project_id") || gcloud_config("core/project") || raise("Unable to look up google project_id")
   end
   memoize :project
 
   def region
-    gcloud_config("compute/region")
+    ENV['GOOGLE_REGION'] || gcloud_config("compute/region") || 'us-central1'
   end
   memoize :region
 
+  def zone
+    ENV['GOOGLE_ZONE'] || gcloud_config("compute/zone") || 'us-central1a'
+  end
+  memoize :zone
+
+  def creds(name)
+    credentials[name] if credentials
+  end
+
+  def credentials
+    path = ENV['GOOGLE_APPLICATION_CREDENTIALS']
+    JSON.load(IO.read(path)) if path && File.exist?(path)
+  end
+  memoize :credentials
+
   def gcloud_config(key)
     check_gcloud_installed!
-    `gcloud config get-value #{key}`.strip
+    val = `gcloud config get-value #{key}`.strip
+    val unless val == ''
   end
 
   def check_gcloud_installed!

data/lib/gcp_data/version.rb

@@ -1,3 +1,3 @@
 module GcpData
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gcp_data
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoist
@@ -36,7 +36,6 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,36 +0,0 @@
-PATH
-  remote: .
-  specs:
-    gcp_data (0.1.0)
-      memoist
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    memoist (0.16.2)
-    rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  gcp_data!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.1.4