gcloud 0.12.2 → 0.20.0

data/lib/gcloud/logging/sink.rb

@@ -1,227 +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/sink/list"
-
-module Gcloud
-  module Logging
-    ##
-    # # Sink
-    #
-    # Used to export log entries outside Stackdriver Logging. When you create a
-    # sink, new log entries are exported. Stackdriver Logging does not send
-    # previously-ingested log entries to the sink's destination.
-    #
-    # Before creating the sink, ensure that you have granted
-    # `cloud-logs@google.com` permission to write logs to the destination. See
-    # [Permissions for writing exported
-    # logs](https://cloud.google.com/logging/docs/export/configure_export#setting_product_name_short_permissions_for_writing_exported_logs).
-    #
-    # You can retrieve an existing sink with {Project#sink}.
-    #
-    # @see https://cloud.google.com/logging/docs/api/tasks/exporting-logs
-    #   Exporting Logs With Sinks
-    # @see https://cloud.google.com/logging/docs/api/introduction_v2#kinds_of_log_sinks
-    #   Kinds of log sinks (API V2)
-    # @see https://cloud.google.com/logging/docs/api/#sinks Sinks (API V1)
-    # @see https://cloud.google.com/logging/docs/export/configure_export#setting_product_name_short_permissions_for_writing_exported_logs
-    #   Permissions for writing exported logs
-    #
-    # @example
-    #   require "gcloud"
-    #
-    #   gcloud = Gcloud.new
-    #   logging = gcloud.logging
-    #   storage = gcloud.storage
-    #
-    #   bucket = storage.create_bucket "my-logs-bucket"
-    #
-    #   # Grant owner permission to Stackdriver Logging service
-    #   email = "cloud-logs@google.com"
-    #   bucket.acl.add_owner "group-#{email}"
-    #
-    #   sink = logging.create_sink "my-sink",
-    #                              "storage.googleapis.com/#{bucket.id}"
-    #
-    class Sink
-      ##
-      # @private The gRPC Service object.
-      attr_accessor :service
-
-      ##
-      # @private The Google API Client object.
-      attr_accessor :grpc
-
-      ##
-      # @private Create an empty Sink object.
-      def initialize
-        @service = nil
-        @grpc = Google::Logging::V2::LogSink.new
-      end
-
-      ##
-      # The client-assigned sink identifier. Sink identifiers are limited to
-      # 1000 characters and can include only the following characters: `A-Z`,
-      # `a-z`, `0-9`, and the special characters `_-.`.
-      def name
-        @grpc.name
-      end
-
-      ##
-      # The export destination. See [Exporting Logs With
-      # Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
-      def destination
-        @grpc.destination
-      end
-
-      ##
-      # Updates the export destination. See [Exporting Logs With
-      # Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
-      def destination= destination
-        @grpc.destination = destination
-      end
-
-      ##
-      # An [advanced logs
-      # filter](https://cloud.google.com/logging/docs/view/advanced_filters)
-      # that defines the log entries to be exported. The filter must be
-      # consistent with the log entry format designed by the `version`
-      # parameter, regardless of the format of the log entry that was originally
-      # written to Stackdriver Logging.
-      def filter
-        @grpc.filter
-      end
-
-      ##
-      # Updates the [advanced logs
-      # filter](https://cloud.google.com/logging/docs/view/advanced_filters)
-      # that defines the log entries to be exported. The filter must be
-      # consistent with the log entry format designed by the `version`
-      # parameter, regardless of the format of the log entry that was originally
-      # written to Stackdriver Logging.
-      def filter= filter
-        @grpc.filter = filter
-      end
-
-      ##
-      # The log entry version used when exporting log entries from this sink.
-      # This version does not have to correspond to the version of the log entry
-      # when it was written to Stackdriver Logging.
-      def version
-        @grpc.output_version_format
-      end
-
-      ##
-      # Updates the log entry version used when exporting log entries from this
-      # sink. This version does not have to correspond to the version of the log
-      # entry when it was written to Stackdriver Logging. Accepted values are
-      # `:VERSION_FORMAT_UNSPECIFIED`, `:V2`, and `:V1`.
-      def version= version
-        @grpc.output_version_format = self.class.resolve_version(version)
-      end
-
-      ##
-      # Helper to determine if the sink's version is
-      # `VERSION_FORMAT_UNSPECIFIED`.
-      def unspecified?
-        !(v1? || v2?)
-      end
-
-      ##
-      # Helper to determine if the sink's version is `V2`.
-      def v2?
-        version == :V2
-      end
-
-      ##
-      # Helper to determine if the sink's version is `V1`.
-      def v1?
-        version == :V1
-      end
-
-      ##
-      # Updates the logs-based sink.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #   sink = logging.sink "severe_errors"
-      #   sink.filter = "logName:syslog AND severity>=ERROR"
-      #   sink.save
-      #
-      def save
-        ensure_service!
-        @grpc = service.update_sink name, destination, filter, version
-      end
-
-      ##
-      # Reloads the logs-based sink with current data from the Logging
-      # service.
-      def reload!
-        ensure_service!
-        @grpc = service.get_sink name
-      end
-      alias_method :refresh!, :reload!
-
-      ##
-      # Permanently deletes the logs-based sink.
-      #
-      # @return [Boolean] Returns `true` if the sink was deleted.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   logging = gcloud.logging
-      #   sink = logging.sink "severe_errors"
-      #   sink.delete
-      #
-      def delete
-        ensure_service!
-        service.delete_sink name
-        true
-      end
-
-      ##
-      # @private New Sink from a Google::Logging::V2::LogSink object.
-      def self.from_grpc grpc, service
-        new.tap do |f|
-          f.grpc = grpc
-          f.service = service
-        end
-      end
-
-      ##
-      # @private Convert a version value to the gRPC enum value.
-      def self.resolve_version version
-        ver = version.to_s.upcase.to_sym
-        ver = Google::Logging::V2::LogSink::VersionFormat.resolve ver
-        return ver if ver
-        Google::Logging::V2::LogSink::VersionFormat::VERSION_FORMAT_UNSPECIFIED
-      end
-
-      protected
-
-      ##
-      # @private Raise an error unless an active connection to the service is
-      # available.
-      def ensure_service!
-        fail "Must have active connection to service" unless service
-      end
-    end
-  end
-end

data/lib/gcloud/logging/sink/list.rb

@@ -1,171 +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 "delegate"
-
-module Gcloud
-  module Logging
-    class Sink
-      ##
-      # Sink::List is a special case Array with additional values.
-      class List < DelegateClass(::Array)
-        ##
-        # If not empty, indicates that there are more records that match
-        # the request and this value should be passed to continue.
-        attr_accessor :token
-
-        ##
-        # @private Create a new Sink::List with an array of Sink instances.
-        def initialize arr = []
-          super arr
-        end
-
-        ##
-        # Whether there is a next page of sinks.
-        #
-        # @return [Boolean]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   logging = gcloud.logging
-        #
-        #   sinks = logging.sinks
-        #   if sinks.next?
-        #     next_sinks = sinks.next
-        #   end
-        #
-        def next?
-          !token.nil?
-        end
-
-        ##
-        # Retrieve the next page of sinks.
-        #
-        # @return [Sink::List]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   logging = gcloud.logging
-        #
-        #   sinks = dataset.sinks
-        #   if sinks.next?
-        #     next_sinks = sinks.next
-        #   end
-        #
-        def next
-          return nil unless next?
-          ensure_service!
-          list_grpc = @service.list_sinks token: token, max: @max
-          self.class.from_grpc list_grpc, @service
-        end
-
-        ##
-        # Retrieves all sinks by repeatedly loading {#next} until {#next?}
-        # returns `false`. Calls the given block once for each sink, which is
-        # passed as the parameter.
-        #
-        # An Enumerator is returned if no block is given.
-        #
-        # This method may make several API calls until all sinks are retrieved.
-        # Be sure to use as narrow a search criteria as possible. Please use
-        # with caution.
-        #
-        # @param [Integer] request_limit The upper limit of API requests to make
-        #   to load all sinks. Default is no limit.
-        # @yield [sink] The block for accessing each sink.
-        # @yieldparam [Sink] sink The sink object.
-        #
-        # @return [Enumerator]
-        #
-        # @example Iterating each sink by passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   logging = gcloud.logging
-        #   sinks = logging.sinks
-        #
-        #   sinks.all do |sink|
-        #     puts "#{sink.name}: #{sink.filter} -> #{sink.destination}"
-        #   end
-        #
-        # @example Using the enumerator by not passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   logging = gcloud.logging
-        #   sinks = logging.sinks
-        #
-        #   all_names = sinks.all.map do |sink|
-        #     sink.name
-        #   end
-        #
-        # @example Limit the number of API calls made:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   logging = gcloud.logging
-        #   sinks = logging.sinks
-        #
-        #   sinks.all(request_limit: 10) do |sink|
-        #     puts "#{sink.name}: #{sink.filter} -> #{sink.destination}"
-        #   end
-        #
-        def all request_limit: nil
-          request_limit = request_limit.to_i if request_limit
-          unless block_given?
-            return enum_for(:all, request_limit: request_limit)
-          end
-          results = self
-          loop do
-            results.each { |r| yield r }
-            if request_limit
-              request_limit -= 1
-              break if request_limit < 0
-            end
-            break unless results.next?
-            results = results.next
-          end
-        end
-
-        ##
-        # @private New Sink::List from a Google::Logging::V2::ListSinksResponse
-        # object.
-        def self.from_grpc grpc_list, service, max = nil
-          sinks = new(Array(grpc_list.sinks).map do |grpc|
-            Sink.from_grpc grpc, service
-          end)
-          token = grpc_list.next_page_token
-          token = nil if token == ""
-          sinks.instance_variable_set "@token", token
-          sinks.instance_variable_set "@service", service
-          sinks.instance_variable_set "@max", max
-          sinks
-        end
-
-        protected
-
-        ##
-        # Raise an error unless an active service is available.
-        def ensure_service!
-          fail "Must have active service" unless @service
-        end
-      end
-    end
-  end
-end

data/lib/gcloud/pubsub/credentials.rb

@@ -1,29 +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 "gcloud/credentials"
-
-module Gcloud
-  module Pubsub
-    ##
-    # @private Represents the OAuth 2.0 signing logic for Pub/Sub.
-    class Credentials < Gcloud::Credentials
-      SCOPE = ["https://www.googleapis.com/auth/pubsub"]
-      PATH_ENV_VARS = %w(PUBSUB_KEYFILE GCLOUD_KEYFILE GOOGLE_CLOUD_KEYFILE)
-      JSON_ENV_VARS = %w(PUBSUB_KEYFILE_JSON GCLOUD_KEYFILE_JSON
-                         GOOGLE_CLOUD_KEYFILE_JSON)
-    end
-  end
-end

data/lib/gcloud/pubsub/message.rb

@@ -1,94 +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 "gcloud/errors"
-
-module Gcloud
-  module Pubsub
-    ##
-    # # Message
-    #
-    # Represents a Pub/Sub Message.
-    #
-    # Message objects are created by {Topic#publish}.
-    # {Subscription#pull} returns an array of {ReceivedMessage} objects, each of
-    # which contains a Message object. Each {ReceivedMessage} object can be
-    # acknowledged and/or delayed.
-    #
-    # @example
-    #   require "gcloud"
-    #
-    #   gcloud = Gcloud.new
-    #   pubsub = gcloud.pubsub
-    #
-    #   # Publish a message
-    #   topic = pubsub.topic "my-topic"
-    #   message = topic.publish "new-message"
-    #   puts message.data #=>  "new-message"
-    #
-    #   # Pull a message
-    #   sub = pubsub.subscription "my-topic-sub"
-    #   received_message = sub.pull.first
-    #   puts received_message.message.data #=>  "new-message"
-    #
-    class Message
-      ##
-      # @private The gRPC Google::Pubsub::V1::PubsubMessage object.
-      attr_accessor :grpc
-
-      ##
-      # Create an empty Message object.
-      # This can be used to publish several messages in bulk.
-      def initialize data = nil, attributes = {}
-        # Convert attributes to strings to match the protobuf definition
-        attributes = Hash[attributes.map { |k, v| [String(k), String(v)] }]
-
-        @grpc = Google::Pubsub::V1::PubsubMessage.new(
-          data: String(data).encode("ASCII-8BIT"),
-          attributes: attributes)
-      end
-
-      ##
-      # The received data.
-      def data
-        @grpc.data
-      end
-
-      ##
-      # The received attributes.
-      def attributes
-        return @grpc.attributes.to_h if @grpc.attributes.respond_to? :to_h
-        # Enumerable doesn't have to_h on Ruby 2.0, so fallback to this
-        Hash[@grpc.attributes.to_a]
-      end
-
-      ##
-      # The ID of this message, assigned by the server at publication time.
-      # Guaranteed to be unique within the topic.
-      def message_id
-        @grpc.message_id
-      end
-      alias_method :msg_id, :message_id
-
-      ##
-      # @private New Message from a Google::Pubsub::V1::PubsubMessage object.
-      def self.from_grpc grpc
-        new.tap do |m|
-          m.instance_variable_set "@grpc", grpc
-        end
-      end
-    end
-  end
-end