google-cloud-core 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29d08e42cbb895f42a47e1eedcd28c7b15dd77fa
-  data.tar.gz: f5808aba10c3cf10fd76786e774b878f7ee9925f
+  metadata.gz: c54259c5d0a2e13f518a15f3a1a4b485cb4ac16b
+  data.tar.gz: 86286197809cef4e199315bfd94852aca25b402e
 SHA512:
-  metadata.gz: 9e6c3fcc7b93a69cf29254ccef9c5c7b404743cdbc6e05ea1d08ace3a2c79c884c97e9d536e9e99d5259ca441d5e2d72c1df2af1af7df8557ea6cda3ca96b2c2
-  data.tar.gz: ef9af1e66e014e1f92922e6c869798a27294cb11f0b7d2402780603a80a3a1a327ad883c4ec9f4ab63ced13af05740cf105f466c75eb6b5e7ca395e1c4ebc6cf
+  metadata.gz: 0e14f448eb90a2365ade333f56e5c6b85859de19ee13664b6f1f10cb7c914de0900ddc5add35551ed1164780429686962f86f7766e9edad626515ceec1f6fa15
+  data.tar.gz: 8b62a8873b893455fa9936ff35c77fc7d49c17df451d1e35e8240f0d690673fae1c1b6d7540693a524af510d1d7b653132226fa15f7f70d34b26eee63c150d7a

data/lib/google/cloud/core/environment.rb

@@ -0,0 +1,145 @@
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     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,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "faraday"
+
+module Google
+  module Cloud
+    module Core
+      ##
+      # @private
+      # Represents the Google Cloud Platform environments.
+      module Environment
+        CHECK_URI = "http://169.254.169.254"
+        PROJECT_URI = "#{CHECK_URI}/computeMetadata/v1/project"
+        INSTANCE_METADATA_URI = "#{CHECK_URI}/computeMetadata/v1/instance"
+
+        ##
+        # Check if running from a gce vm, which actually hosts GCE, GKE, and
+        # GAE environments.
+        def self.gce_vm? connection: nil
+          @metadata ||= {}
+          return @metadata[:gce_vm] if @metadata.key? :gce_vm
+
+          conn = connection || Faraday.default_connection
+          resp = conn.get CHECK_URI do |req|
+            req.options.timeout = 0.1
+          end
+          @metadata[:gce_vm] = if resp.status != 200 ||
+                                  !resp.headers.key?("Metadata-Flavor")
+                                 false
+                               else
+                                 resp.headers["Metadata-Flavor"] == "Google"
+                               end
+        rescue Faraday::TimeoutError, Faraday::ConnectionFailed
+          @metadata ||= {}
+          @metadata[:gce_vm] = false
+        end
+
+        ##
+        # Check if running from Google Compute Engine, and not using GAE or GKE
+        #
+        # @return [Boolean] True if running from GCE and not GAE or GKE
+        def self.gce?
+          gce_vm? && !gae? && !gke?
+        end
+
+        ##
+        # Check if running from Google Container Engine by querying for
+        # GKE cluster name and VM instance_zone
+        #
+        # @return [Boolean] True if self.gke_cluster_name() and
+        # self.instance_zone() both return true values
+        def self.gke?
+          gke_cluster_name && instance_zone
+        end
+
+        ##
+        # Check if running from Google App Engine by checking existance of
+        # GAE_VM, GAE_MODULE_NAME, GAE_MODULE_VERSION environment variables.
+        #
+        # @return [Boolean] True if all three GAE environment variables are
+        #   defined
+        def self.gae?
+          ENV["GAE_VM"] && gae_module_id && gae_module_version
+        end
+
+        def self.project_id
+          uri = "#{PROJECT_URI}/project-id"
+          get_metadata_attribute uri, :project_id
+        end
+
+        ##
+        # Retrieve GAE module name
+        def self.gae_module_id
+          ENV["GAE_MODULE_NAME"]
+        end
+
+        ##
+        # Retrieve GAE module version
+        def self.gae_module_version
+          ENV["GAE_MODULE_VERSION"]
+        end
+
+        ##
+        # Retrieve GKE cluster name
+        def self.gke_cluster_name
+          uri = "#{INSTANCE_METADATA_URI}/attributes/cluster-name"
+          get_metadata_attribute uri, :cluster_name
+        end
+
+        ##
+        # Retrieve GKE namespace id
+        def self.gke_namespace_id
+          ENV["GKE_NAMESPACE_ID"]
+        end
+
+        ##
+        # Retrieve GCE VM zone
+        def self.instance_zone
+          uri = "#{INSTANCE_METADATA_URI}/zone"
+          full_zone = get_metadata_attribute uri, :zone
+          full_zone.nil? ? nil : full_zone.split(%r{/}).last
+        end
+
+        ##
+        # Retrieve GCE VM instance_id
+        def self.instance_id
+          uri = "#{INSTANCE_METADATA_URI}/id"
+          get_metadata_attribute uri, :instance_id
+        end
+
+        ##
+        # Helper method to send HTTP request to GCP metadata service and
+        # retrieve environment information
+        def self.get_metadata_attribute uri, attr_name, connection: nil
+          @metadata ||= {}
+          return @metadata[attr_name] if @metadata.key? attr_name
+
+          conn = connection || Faraday.default_connection
+          conn.headers = { "Metadata-Flavor" => "Google" }
+          resp = conn.get uri do |req|
+            req.options.timeout = 0.1
+          end
+
+          @metadata[attr_name] = resp.status == 200 ? resp.body : nil
+        rescue Faraday::TimeoutError, Faraday::ConnectionFailed
+          @metadata ||= {}
+          @metadata[attr_name] = nil
+        end
+      end
+    end
+  end
+end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Core
-      VERSION = "0.20.1"
+      VERSION = "0.21.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-core
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.21.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-27 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
 description: google-cloud-core is the internal shared library for google-cloud-ruby.
 email:
 - mike@blowmage.com
@@ -132,9 +146,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/google/cloud.rb
-- lib/google/cloud/core/backoff.rb
-- lib/google/cloud/core/gce.rb
-- lib/google/cloud/core/grpc_backoff.rb
+- lib/google/cloud/core/environment.rb
 - lib/google/cloud/core/grpc_utils.rb
 - lib/google/cloud/core/version.rb
 - lib/google/cloud/credentials.rb

data/lib/google/cloud/core/backoff.rb

@@ -1,89 +0,0 @@
-# Copyright 2014 Google Inc. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     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,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Google
-  module Cloud
-    module Core
-      ##
-      # @private
-      # Backoff allows users to control how Google API calls are retried.
-      # If an API call fails the response will be checked to see if the
-      # call can be retried. If the response matches the criteria, then it
-      # will be retried with an incremental backoff. This means that an
-      # increasing delay will be added between each retried call. The first
-      # retry will be delayed one second, the second retry will be delayed
-      # two seconds, and so on.
-      class GrpcBackoff
-        class << self
-          ##
-          # The number of times a retriable API call should be retried.
-          #
-          # The default value is `3`.
-          attr_reader :retries
-          def retries= new_retries
-            @retries = new_retries
-          end
-
-          ##
-          # The GRPC Status Codes that should be retried.
-          #
-          # The default values are `14`.
-          attr_accessor :grpc_codes
-
-          ##
-          # The code to run when a backoff is handled.
-          # This must be a Proc and must take the number of
-          # retries as an argument.
-          #
-          # Note: This method is undocumented and may change.
-          attr_accessor :backoff # :nodoc:
-        end
-        # Set the default values
-        self.retries = 3
-        self.grpc_codes = [14]
-        self.backoff = ->(retries) { sleep retries.to_i }
-
-        ##
-        # @private
-        # Creates a new GrpcBackoff object to catch common errors when calling
-        # the Google API and handle the error by retrying the call.
-        #
-        #   Google::Cloud::Core::GrpcBackoff.new(options).execute do
-        #     datastore.lookup lookup_req
-        #   end
-        def initialize options = {}
-          @retries    = (options[:retries]    || GrpcBackoff.retries).to_i
-          @grpc_codes = (options[:grpc_codes] || GrpcBackoff.grpc_codes).to_a
-          @backoff    =  options[:backoff]    || GrpcBackoff.backoff
-        end
-
-        # @private
-        def execute
-          current_retries = 0
-          loop do
-            begin
-              return yield
-            rescue GRPC::BadStatus => e
-              raise e unless @grpc_codes.include?(e.code) &&
-                             (current_retries < @retries)
-              current_retries += 1
-              @backoff.call current_retries
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/core/gce.rb

@@ -1,60 +0,0 @@
-# Copyright 2015 Google Inc. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     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,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-require "faraday"
-
-module Google
-  module Cloud
-    module Core
-      ##
-      # @private
-      # Represents the Google Compute Engine environment.
-      module GCE
-        CHECK_URI = "http://169.254.169.254"
-        PROJECT_URI = "#{CHECK_URI}/computeMetadata/v1/project/project-id"
-
-        def self.gce? options = {}
-          conn = options[:connection] || Faraday.default_connection
-          resp = conn.get CHECK_URI do |req|
-            req.options.timeout = 0.1
-          end
-          return false unless resp.status == 200
-          return false unless resp.headers.key? "Metadata-Flavor"
-          return resp.headers["Metadata-Flavor"] == "Google"
-        rescue Faraday::TimeoutError, Faraday::ConnectionFailed
-          return false
-        end
-
-        def self.project_id options = {}
-          @gce ||= {}
-          return @gce[:project_id] if @gce.key? :project_id
-          conn = options[:connection] || Faraday.default_connection
-          conn.headers = { "Metadata-Flavor" => "Google" }
-          resp = conn.get PROJECT_URI do |req|
-            req.options.timeout = 0.1
-          end
-          if resp.status == 200
-            @gce[:project_id] = resp.body
-          else
-            @gce[:project_id] = nil
-          end
-        rescue Faraday::TimeoutError, Faraday::ConnectionFailed
-          @gce ||= {}
-          @gce[:project_id] = nil
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/core/grpc_backoff.rb

@@ -1,89 +0,0 @@
-# Copyright 2014 Google Inc. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     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,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Google
-  module Cloud
-    module Core
-      ##
-      # @private
-      # Backoff allows users to control how Google API calls are retried.
-      # If an API call fails the response will be checked to see if the
-      # call can be retried. If the response matches the criteria, then it
-      # will be retried with an incremental backoff. This means that an
-      # increasing delay will be added between each retried call. The first
-      # retry will be delayed one second, the second retry will be delayed
-      # two seconds, and so on.
-      class GrpcBackoff
-        class << self
-          ##
-          # The number of times a retriable API call should be retried.
-          #
-          # The default value is `3`.
-          attr_reader :retries
-          def retries= new_retries
-            @retries = new_retries
-          end
-
-          ##
-          # The GRPC Status Codes that should be retried.
-          #
-          # The default values are `14`.
-          attr_accessor :grpc_codes
-
-          ##
-          # The code to run when a backoff is handled.
-          # This must be a Proc and must take the number of
-          # retries as an argument.
-          #
-          # Note: This method is undocumented and may change.
-          attr_accessor :backoff # :nodoc:
-        end
-        # Set the default values
-        self.retries = 3
-        self.grpc_codes = [14]
-        self.backoff = ->(retries) { sleep retries.to_i }
-
-        ##
-        # @private
-        # Creates a new Backoff object to catch common errors when calling
-        # the Google API and handle the error by retrying the call.
-        #
-        #   Google::Cloud::Core::GrpcBackoff.new(options).execute do
-        #     datastore.lookup lookup_ref
-        #   end
-        def initialize options = {}
-          @retries    = (options[:retries]    || GrpcBackoff.retries).to_i
-          @grpc_codes = (options[:grpc_codes] || GrpcBackoff.grpc_codes).to_a
-          @backoff    =  options[:backoff]    || GrpcBackoff.backoff
-        end
-
-        # @private
-        def execute
-          current_retries = 0
-          loop do
-            begin
-              return yield
-            rescue GRPC::BadStatus => e
-              raise e unless @grpc_codes.include?(e.code) &&
-                             (current_retries < @retries)
-              current_retries += 1
-              @backoff.call current_retries
-            end
-          end
-        end
-      end
-    end
-  end
-end