gcloud 0.12.2 → 0.20.0

data/lib/gcloud/gce.rb

@@ -1,56 +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 Gcloud
-  ##
-  # @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

data/lib/gcloud/grpc_utils.rb

@@ -1,87 +0,0 @@
-# Copyright 2016 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 "gcloud"
-require "google/protobuf/struct"
-
-module Gcloud
-  ##
-  # @private Conversion to/from GRPC objects.
-  module GRPCUtils
-    ##
-    # @private Convert a Hash to a Google::Protobuf::Struct.
-    def self.hash_to_struct hash
-      # TODO: ArgumentError if hash is not a Hash
-      Google::Protobuf::Struct.new fields:
-        Hash[hash.map { |k, v| [String(k), object_to_value(v)] }]
-    end
-
-    ##
-    # @private Convert a Google::Protobuf::Struct to a Hash.
-    def self.struct_to_hash struct
-      # TODO: ArgumentError if struct is not a Google::Protobuf::Struct
-      Hash[struct.fields.map { |k, v| [k, value_to_object(v)] }]
-    end
-
-    ##
-    # @private Convert a Google::Protobuf::Value to an Object.
-    def self.value_to_object value
-      # TODO: ArgumentError if struct is not a Google::Protobuf::Value
-      if value.null_value
-        nil
-      elsif value.number_value
-        value.number_value
-      elsif value.struct_value
-        struct_to_hash value.struct_value
-      elsif value.list_value
-        value.list_value.values.map { |v| value_to_object(v) }
-      elsif !value.bool_value.nil? # Make sure its a bool, not nil
-        value.bool_value
-      else
-        nil # just in case
-      end
-    end
-
-    ##
-    # @private Convert an Object to a Google::Protobuf::Value.
-    def self.object_to_value obj
-      case obj
-      when String then Google::Protobuf::Value.new string_value: obj
-      when Array then Google::Protobuf::ListValue.new(values:
-        obj.map { |o| object_to_value(o) })
-      when Hash then Google::Protobuf::Value.new struct_value:
-        hash_to_struct(obj)
-      when Numeric then Google::Protobuf::Value.new number_value: obj
-      when TrueClass then Google::Protobuf::Value.new bool_value: true
-      when FalseClass then Google::Protobuf::Value.new bool_value: false
-      when NilClass then Google::Protobuf::Value.new null_value: :NULL_VALUE
-      else
-        # We could raise ArgumentError here, or we could convert to a string...
-        Google::Protobuf::Value.new string_value: obj.to_s
-      end
-    end
-
-    ##
-    # @private Convert a Google::Protobuf::Map to a Hash
-    def self.map_to_hash map
-      if map.respond_to? :to_h
-        map.to_h
-      else
-        # Enumerable doesn't have to_h on ruby 2.0...
-        Hash[map.to_a]
-      end
-    end
-  end
-end

data/lib/gcloud/logging/credentials.rb

@@ -1,29 +0,0 @@
-# Copyright 2016 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 "gcloud/credentials"
-
-module Gcloud
-  module Logging
-    ##
-    # @private Represents the OAuth 2.0 signing logic for Logging.
-    class Credentials < Gcloud::Credentials
-      SCOPE = ["https://www.googleapis.com/auth/logging.admin"]
-      PATH_ENV_VARS = %w(LOGGING_KEYFILE GCLOUD_KEYFILE GOOGLE_CLOUD_KEYFILE)
-      JSON_ENV_VARS = %w(LOGGING_KEYFILE_JSON GCLOUD_KEYFILE_JSON
-                         GOOGLE_CLOUD_KEYFILE_JSON)
-    end
-  end
-end

data/lib/gcloud/logging/entry.rb

@@ -1,465 +0,0 @@
-# Copyright 2016 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 "gcloud/logging/resource"
-require "gcloud/logging/entry/http_request"
-require "gcloud/logging/entry/operation"
-require "gcloud/logging/entry/list"
-require "gcloud/grpc_utils"
-
-module Gcloud
-  module Logging
-    ##
-    # # Entry
-    #
-    # An individual entry in a log.
-    #
-    # Each log entry is composed of metadata and a payload. The metadata
-    # includes standard information used by Stackdriver Logging, such as when
-    # the entry was created and where it came from. The payload is the event
-    # record. Traditionally this is a message string, but in Stackdriver Logging
-    # it can also be a JSON or protocol buffer object. A single log can have
-    # entries with different payload types.
-    #
-    # A log is a named collection of entries. Logs can be produced by Google
-    # Cloud Platform services, by third-party services, or by your applications.
-    # For example, the log `compute.googleapis.com/activity_log` is produced by
-    # Google Compute Engine. Logs are simply referenced by name in gcloud-ruby.
-    # There is no `Log` type in gcloud-ruby or `Log` resource in the Cloud
-    # Logging API.
-    #
-    # @see https://cloud.google.com/logging/docs/view/logs_index List of Log
-    #   Types
-    #
-    # @example
-    #   require "gcloud"
-    #
-    #   gcloud = Gcloud.new
-    #   logging = gcloud.logging
-    #
-    #   entry = logging.entry payload: "Job started.", log_name: "my_app_log"
-    #   entry.resource.type = "gae_app"
-    #   entry.resource.labels[:module_id] = "1"
-    #   entry.resource.labels[:version_id] = "20150925t173233"
-    #
-    #   logging.write_entries entry
-    #
-    class Entry
-      ##
-      # Create a new Entry instance. The {#resource} attribute is
-      # pre-populated with a new {Gcloud::Logging::Resource} instance. See also
-      # {Gcloud::Logging::Project#entry}.
-      def initialize
-        @labels = {}
-        @resource = Resource.new
-        @http_request = HttpRequest.new
-        @operation = Operation.new
-        @severity = :DEFAULT
-      end
-
-      ##
-      # The resource name of the log to which this log entry belongs. The format
-      # of the name is `projects/<project-id>/logs/<log-id>`. e.g.
-      # `projects/my-projectid/logs/my_app_log` and
-      # `projects/1234567890/logs/library.googleapis.com%2Fbook_log`
-      #
-      # The log ID part of resource name must be less than 512 characters long
-      # and can only include the following characters: upper and lower case
-      # alphanumeric characters: `[A-Za-z0-9]`; and punctuation characters:
-      # forward-slash (`/`), underscore (`_`), hyphen (`-`), and period (`.`).
-      # Forward-slash (`/`) characters in the log ID must be URL-encoded.
-      attr_accessor :log_name
-
-      ##
-      # The monitored resource associated with this log entry. Example: a log
-      # entry that reports a database error would be associated with the
-      # monitored resource designating the particular database that reported the
-      # error.
-      # @return [Gcloud::Logging::Resource]
-      attr_accessor :resource
-
-      ##
-      # The time the event described by the log entry occurred. If omitted,
-      # Stackdriver Logging will use the time the log entry is written.
-      # @return [Time]
-      attr_accessor :timestamp
-
-      ##
-      # The severity level of the log entry. The default value is `:DEFAULT`.
-      # @return [Symbol]
-      attr_accessor :severity
-
-      ##
-      # Returns `true` if the severity level is `:DEFAULT`.
-      def default?
-        severity == :DEFAULT
-      end
-
-      ##
-      # Sets the severity level to `:DEFAULT`.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #
-      #   entry = logging.entry
-      #   entry.severity = :DEBUG
-      #   entry.default!
-      #   entry.default? #=> true
-      #   entry.severity #=> :DEFAULT
-      #
-      def default!
-        self.severity = :DEFAULT
-      end
-
-      ##
-      # Returns `true` if the severity level is `:DEBUG`.
-      def debug?
-        severity == :DEBUG
-      end
-
-      ##
-      # Sets the severity level to `:DEBUG`.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #
-      #   entry = logging.entry
-      #   entry.severity #=> :DEFAULT
-      #   entry.debug!
-      #   entry.debug? #=> true
-      #   entry.severity #=> :DEBUG
-      #
-      def debug!
-        self.severity = :DEBUG
-      end
-
-      ##
-      # Returns `true` if the severity level is `:INFO`.
-      def info?
-        severity == :INFO
-      end
-
-      ##
-      # Sets the severity level to `:INFO`.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #
-      #   entry = logging.entry
-      #   entry.severity #=> :DEFAULT
-      #   entry.info!
-      #   entry.info? #=> true
-      #   entry.severity #=> :INFO
-      #
-      def info!
-        self.severity = :INFO
-      end
-
-      ##
-      # Returns `true` if the severity level is `:NOTICE`.
-      def notice?
-        severity == :NOTICE
-      end
-
-      ##
-      # Sets the severity level to `:NOTICE`.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #
-      #   entry = logging.entry
-      #   entry.severity #=> :DEFAULT
-      #   entry.notice!
-      #   entry.notice? #=> true
-      #   entry.severity #=> :NOTICE
-      #
-      def notice!
-        self.severity = :NOTICE
-      end
-
-      ##
-      # Returns `true` if the severity level is `:WARNING`.
-      def warning?
-        severity == :WARNING
-      end
-
-      ##
-      # Sets the severity level to `:WARNING`.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #
-      #   entry = logging.entry
-      #   entry.severity #=> :DEFAULT
-      #   entry.warning!
-      #   entry.warning? #=> true
-      #   entry.severity #=> :WARNING
-      #
-      def warning!
-        self.severity = :WARNING
-      end
-
-      ##
-      # Returns `true` if the severity level is `:ERROR`.
-      def error?
-        severity == :ERROR
-      end
-
-      ##
-      # Sets the severity level to `:ERROR`.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #
-      #   entry = logging.entry
-      #   entry.severity #=> :DEFAULT
-      #   entry.error!
-      #   entry.error? #=> true
-      #   entry.severity #=> :ERROR
-      #
-      def error!
-        self.severity = :ERROR
-      end
-
-      ##
-      # Returns `true` if the severity level is `:CRITICAL`.
-      def critical?
-        severity == :CRITICAL
-      end
-
-      ##
-      # Sets the severity level to `:CRITICAL`.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #
-      #   entry = logging.entry
-      #   entry.severity #=> :DEFAULT
-      #   entry.critical!
-      #   entry.critical? #=> true
-      #   entry.severity #=> :CRITICAL
-      #
-      def critical!
-        self.severity = :CRITICAL
-      end
-
-      ##
-      # Returns `true` if the severity level is `:ALERT`.
-      def alert?
-        severity == :ALERT
-      end
-
-      ##
-      # Sets the severity level to `:ALERT`.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #
-      #   entry = logging.entry
-      #   entry.severity #=> :DEFAULT
-      #   entry.alert!
-      #   entry.alert? #=> true
-      #   entry.severity #=> :ALERT
-      #
-      def alert!
-        self.severity = :ALERT
-      end
-
-      ##
-      # Returns `true` if the severity level is `:EMERGENCY`.
-      def emergency?
-        severity == :EMERGENCY
-      end
-
-      ##
-      # Sets the severity level to `:EMERGENCY`.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #
-      #   entry = logging.entry
-      #   entry.severity #=> :DEFAULT
-      #   entry.emergency!
-      #   entry.emergency? #=> true
-      #   entry.severity #=> :EMERGENCY
-      #
-      def emergency!
-        self.severity = :EMERGENCY
-      end
-
-      ##
-      # A unique ID for the log entry. If you provide this field, the logging
-      # service considers other log entries in the same log with the same ID as
-      # duplicates which can be removed. If omitted, Stackdriver Logging will
-      # generate a unique ID for this log entry.
-      # @return [String]
-      attr_accessor :insert_id
-
-      ##
-      # A set of user-defined data that provides additional information about
-      # the log entry.
-      # @return [Hash]
-      attr_accessor :labels
-
-      ##
-      # The log entry payload, represented as either a string, a hash (JSON), or
-      # a hash (protocol buffer).
-      # @return [String, Hash]
-      attr_accessor :payload
-
-      ##
-      # Information about the HTTP request associated with this log entry, if
-      # applicable.
-      # @return [Gcloud::Logging::Entry::HttpRequest]
-      attr_reader :http_request
-
-      ##
-      # Information about an operation associated with the log entry, if
-      # applicable.
-      # @return [Gcloud::Logging::Entry::Operation]
-      attr_reader :operation
-
-      ##
-      # @private Determines if the Entry has any data.
-      def empty?
-        log_name.nil? &&
-          timestamp.nil? &&
-          insert_id.nil? &&
-          (labels.nil? || labels.empty?) &&
-          payload.nil? &&
-          resource.empty? &&
-          http_request.empty? &&
-          operation.empty?
-      end
-
-      ##
-      # @private Exports the Entry to a Google::Logging::V2::LogEntry object.
-      def to_grpc
-        grpc = Google::Logging::V2::LogEntry.new(
-          log_name: log_name.to_s,
-          timestamp: timestamp_grpc,
-          # TODO: verify severity is the correct type?
-          severity: severity,
-          insert_id: insert_id.to_s,
-          labels: labels_grpc,
-          resource: resource.to_grpc,
-          http_request: http_request.to_grpc,
-          operation: operation.to_grpc
-        )
-        # Add payload
-        append_payload grpc
-        grpc
-      end
-
-      ##
-      # @private New Entry from a Google::Logging::V2::LogEntry object.
-      def self.from_grpc grpc
-        return new if grpc.nil?
-        new.tap do |e|
-          e.log_name = grpc.log_name
-          e.timestamp = extract_timestamp(grpc)
-          e.severity = grpc.severity
-          e.insert_id = grpc.insert_id
-          e.labels = GRPCUtils.map_to_hash(grpc.labels)
-          e.payload = extract_payload(grpc)
-          e.instance_variable_set "@resource", Resource.from_grpc(grpc.resource)
-          e.instance_variable_set "@http_request",
-                                  HttpRequest.from_grpc(grpc.http_request)
-          e.instance_variable_set "@operation",
-                                  Operation.from_grpc(grpc.operation)
-        end
-      end
-
-      ##
-      # @private Formats the timestamp as a Google::Protobuf::Timestamp object.
-      def timestamp_grpc
-        return nil if timestamp.nil?
-        # TODO: ArgumentError if timestamp is not a Time object?
-        Google::Protobuf::Timestamp.new(
-          seconds: timestamp.to_i,
-          nanos: timestamp.nsec
-        )
-      end
-
-      ##
-      # @private Formats the labels so they can be saved to a
-      # Google::Logging::V2::LogEntry object.
-      def labels_grpc
-        # Coerce symbols to strings
-        Hash[labels.map do |k, v|
-          v = String(v) if v.is_a? Symbol
-          [String(k), v]
-        end]
-      end
-
-      ##
-      # @private Adds the payload data to a Google::Logging::V2::LogEntry
-      # object.
-      def append_payload grpc
-        grpc.proto_payload = nil
-        grpc.json_payload  = nil
-        grpc.text_payload  = nil
-
-        if payload.is_a? Google::Protobuf::Any
-          grpc.proto_payload = payload
-        elsif payload.respond_to? :to_hash
-          grpc.json_payload = GRPCUtils.hash_to_struct payload.to_hash
-        else
-          grpc.text_payload = payload.to_s
-        end
-      end
-
-      ##
-      # @private Extract payload data from Google API Client object.
-      def self.extract_payload grpc
-        grpc.proto_payload || grpc.json_payload || grpc.text_payload
-      end
-
-      ##
-      # @private Get a Time object from a Google::Protobuf::Timestamp object.
-      def self.extract_timestamp grpc
-        return nil if grpc.timestamp.nil?
-        Time.at grpc.timestamp.seconds, grpc.timestamp.nanos/1000.0
-      end
-    end
-  end
-end