google-cloud-pubsub 0.26.0 → 2.6.1

data/lib/google/cloud/pubsub/topic/publisher.rb

@@ -1,86 +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.
-
-
-module Google
-  module Cloud
-    module Pubsub
-      class Topic
-        ##
-        # Topic Publisher object used to publish multiple messages at once.
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::Pubsub.new
-        #
-        #   topic = pubsub.topic "my-topic"
-        #   msgs = topic.publish do |t|
-        #     t.publish "task 1 completed", foo: :bar
-        #     t.publish "task 2 completed", foo: :baz
-        #     t.publish "task 3 completed", foo: :bif
-        #   end
-        class Publisher
-          ##
-          # @private The messages to publish
-          attr_reader :messages
-
-          ##
-          # @private Create a new instance of the object.
-          def initialize data = nil, attributes = {}
-            @messages = []
-            @mode = :batch
-            return if data.nil?
-            @mode = :single
-            publish data, attributes
-          end
-
-          ##
-          # Add multiple messages to the topic.
-          # All messages added will be published at once.
-          # See {Google::Cloud::Pubsub::Topic#publish}
-          def publish data, attributes = {}
-            # Convert IO-ish objects to strings
-            if data.respond_to?(:read) && data.respond_to?(:rewind)
-              data.rewind
-              data = data.read
-            end
-            # Convert data to encoded byte array to match the protobuf defn
-            data = String(data).force_encoding("ASCII-8BIT")
-            # Convert attributes to strings to match the protobuf definition
-            attributes = Hash[attributes.map { |k, v| [String(k), String(v)] }]
-            @messages << [data, attributes]
-          end
-
-          ##
-          # @private Create Message objects with message ids.
-          def to_gcloud_messages message_ids
-            msgs = @messages.zip(Array(message_ids)).map do |arr, id|
-              Message.from_grpc(
-                Google::Pubsub::V1::PubsubMessage.new(
-                  data: arr[0], attributes: arr[1], message_id: id))
-            end
-            # Return just one Message if a single publish,
-            # otherwise return the array of Messages.
-            if @mode == :single && msgs.count <= 1
-              msgs.first
-            else
-              msgs
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/pubsub/v1/doc/google/protobuf/duration.rb

@@ -1,77 +0,0 @@
-# Copyright 2017, 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 Protobuf
-    # A Duration represents a signed, fixed-length span of time represented
-    # as a count of seconds and fractions of seconds at nanosecond
-    # resolution. It is independent of any calendar and concepts like "day"
-    # or "month". It is related to Timestamp in that the difference between
-    # two Timestamp values is a Duration and it can be added or subtracted
-    # from a Timestamp. Range is approximately +-10,000 years.
-    #
-    # Example 1: Compute Duration from two Timestamps in pseudo code.
-    #
-    #     Timestamp start = ...;
-    #     Timestamp end = ...;
-    #     Duration duration = ...;
-    #
-    #     duration.seconds = end.seconds - start.seconds;
-    #     duration.nanos = end.nanos - start.nanos;
-    #
-    #     if (duration.seconds < 0 && duration.nanos > 0) {
-    #       duration.seconds += 1;
-    #       duration.nanos -= 1000000000;
-    #     } else if (durations.seconds > 0 && duration.nanos < 0) {
-    #       duration.seconds -= 1;
-    #       duration.nanos += 1000000000;
-    #     }
-    #
-    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
-    #
-    #     Timestamp start = ...;
-    #     Duration duration = ...;
-    #     Timestamp end = ...;
-    #
-    #     end.seconds = start.seconds + duration.seconds;
-    #     end.nanos = start.nanos + duration.nanos;
-    #
-    #     if (end.nanos < 0) {
-    #       end.seconds -= 1;
-    #       end.nanos += 1000000000;
-    #     } else if (end.nanos >= 1000000000) {
-    #       end.seconds += 1;
-    #       end.nanos -= 1000000000;
-    #     }
-    #
-    # Example 3: Compute Duration from datetime.timedelta in Python.
-    #
-    #     td = datetime.timedelta(days=3, minutes=10)
-    #     duration = Duration()
-    #     duration.FromTimedelta(td)
-    # @!attribute [rw] seconds
-    #   @return [Integer]
-    #     Signed seconds of the span of time. Must be from -315,576,000,000
-    #     to +315,576,000,000 inclusive.
-    # @!attribute [rw] nanos
-    #   @return [Integer]
-    #     Signed fractions of a second at nanosecond resolution of the span
-    #     of time. Durations less than one second are represented with a 0
-    #     +seconds+ field and a positive or negative +nanos+ field. For durations
-    #     of one second or more, a non-zero value for the +nanos+ field must be
-    #     of the same sign as the +seconds+ field. Must be from -999,999,999
-    #     to +999,999,999 inclusive.
-    class Duration; end
-  end
-end

data/lib/google/cloud/pubsub/v1/doc/google/protobuf/field_mask.rb

@@ -1,223 +0,0 @@
-# Copyright 2017, 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 Protobuf
-    # +FieldMask+ represents a set of symbolic field paths, for example:
-    #
-    #     paths: "f.a"
-    #     paths: "f.b.d"
-    #
-    # Here +f+ represents a field in some root message, +a+ and +b+
-    # fields in the message found in +f+, and +d+ a field found in the
-    # message in +f.b+.
-    #
-    # Field masks are used to specify a subset of fields that should be
-    # returned by a get operation or modified by an update operation.
-    # Field masks also have a custom JSON encoding (see below).
-    #
-    # = Field Masks in Projections
-    #
-    # When used in the context of a projection, a response message or
-    # sub-message is filtered by the API to only contain those fields as
-    # specified in the mask. For example, if the mask in the previous
-    # example is applied to a response message as follows:
-    #
-    #     f {
-    #       a : 22
-    #       b {
-    #         d : 1
-    #         x : 2
-    #       }
-    #       y : 13
-    #     }
-    #     z: 8
-    #
-    # The result will not contain specific values for fields x,y and z
-    # (their value will be set to the default, and omitted in proto text
-    # output):
-    #
-    #
-    #     f {
-    #       a : 22
-    #       b {
-    #         d : 1
-    #       }
-    #     }
-    #
-    # A repeated field is not allowed except at the last position of a
-    # paths string.
-    #
-    # If a FieldMask object is not present in a get operation, the
-    # operation applies to all fields (as if a FieldMask of all fields
-    # had been specified).
-    #
-    # Note that a field mask does not necessarily apply to the
-    # top-level response message. In case of a REST get operation, the
-    # field mask applies directly to the response, but in case of a REST
-    # list operation, the mask instead applies to each individual message
-    # in the returned resource list. In case of a REST custom method,
-    # other definitions may be used. Where the mask applies will be
-    # clearly documented together with its declaration in the API.  In
-    # any case, the effect on the returned resource/resources is required
-    # behavior for APIs.
-    #
-    # = Field Masks in Update Operations
-    #
-    # A field mask in update operations specifies which fields of the
-    # targeted resource are going to be updated. The API is required
-    # to only change the values of the fields as specified in the mask
-    # and leave the others untouched. If a resource is passed in to
-    # describe the updated values, the API ignores the values of all
-    # fields not covered by the mask.
-    #
-    # If a repeated field is specified for an update operation, the existing
-    # repeated values in the target resource will be overwritten by the new values.
-    # Note that a repeated field is only allowed in the last position of a +paths+
-    # string.
-    #
-    # If a sub-message is specified in the last position of the field mask for an
-    # update operation, then the existing sub-message in the target resource is
-    # overwritten. Given the target message:
-    #
-    #     f {
-    #       b {
-    #         d : 1
-    #         x : 2
-    #       }
-    #       c : 1
-    #     }
-    #
-    # And an update message:
-    #
-    #     f {
-    #       b {
-    #         d : 10
-    #       }
-    #     }
-    #
-    # then if the field mask is:
-    #
-    #  paths: "f.b"
-    #
-    # then the result will be:
-    #
-    #     f {
-    #       b {
-    #         d : 10
-    #       }
-    #       c : 1
-    #     }
-    #
-    # However, if the update mask was:
-    #
-    #  paths: "f.b.d"
-    #
-    # then the result would be:
-    #
-    #     f {
-    #       b {
-    #         d : 10
-    #         x : 2
-    #       }
-    #       c : 1
-    #     }
-    #
-    # In order to reset a field's value to the default, the field must
-    # be in the mask and set to the default value in the provided resource.
-    # Hence, in order to reset all fields of a resource, provide a default
-    # instance of the resource and set all fields in the mask, or do
-    # not provide a mask as described below.
-    #
-    # If a field mask is not present on update, the operation applies to
-    # all fields (as if a field mask of all fields has been specified).
-    # Note that in the presence of schema evolution, this may mean that
-    # fields the client does not know and has therefore not filled into
-    # the request will be reset to their default. If this is unwanted
-    # behavior, a specific service may require a client to always specify
-    # a field mask, producing an error if not.
-    #
-    # As with get operations, the location of the resource which
-    # describes the updated values in the request message depends on the
-    # operation kind. In any case, the effect of the field mask is
-    # required to be honored by the API.
-    #
-    # == Considerations for HTTP REST
-    #
-    # The HTTP kind of an update operation which uses a field mask must
-    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
-    # (PUT must only be used for full updates).
-    #
-    # = JSON Encoding of Field Masks
-    #
-    # In JSON, a field mask is encoded as a single string where paths are
-    # separated by a comma. Fields name in each path are converted
-    # to/from lower-camel naming conventions.
-    #
-    # As an example, consider the following message declarations:
-    #
-    #     message Profile {
-    #       User user = 1;
-    #       Photo photo = 2;
-    #     }
-    #     message User {
-    #       string display_name = 1;
-    #       string address = 2;
-    #     }
-    #
-    # In proto a field mask for +Profile+ may look as such:
-    #
-    #     mask {
-    #       paths: "user.display_name"
-    #       paths: "photo"
-    #     }
-    #
-    # In JSON, the same mask is represented as below:
-    #
-    #     {
-    #       mask: "user.displayName,photo"
-    #     }
-    #
-    # = Field Masks and Oneof Fields
-    #
-    # Field masks treat fields in oneofs just as regular fields. Consider the
-    # following message:
-    #
-    #     message SampleMessage {
-    #       oneof test_oneof {
-    #         string name = 4;
-    #         SubMessage sub_message = 9;
-    #       }
-    #     }
-    #
-    # The field mask can be:
-    #
-    #     mask {
-    #       paths: "name"
-    #     }
-    #
-    # Or:
-    #
-    #     mask {
-    #       paths: "sub_message"
-    #     }
-    #
-    # Note that oneof type names ("test_oneof" in this case) cannot be used in
-    # paths.
-    # @!attribute [rw] paths
-    #   @return [Array<String>]
-    #     The set of field mask paths.
-    class FieldMask; end
-  end
-end

data/lib/google/cloud/pubsub/v1/doc/google/protobuf/timestamp.rb

@@ -1,81 +0,0 @@
-# Copyright 2017, 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 Protobuf
-    # A Timestamp represents a point in time independent of any time zone
-    # or calendar, represented as seconds and fractions of seconds at
-    # nanosecond resolution in UTC Epoch time. It is encoded using the
-    # Proleptic Gregorian Calendar which extends the Gregorian calendar
-    # backwards to year one. It is encoded assuming all minutes are 60
-    # seconds long, i.e. leap seconds are "smeared" so that no leap second
-    # table is needed for interpretation. Range is from
-    # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
-    # By restricting to that range, we ensure that we can convert to
-    # and from  RFC 3339 date strings.
-    # See {https://www.ietf.org/rfc/rfc3339.txt}[https://www.ietf.org/rfc/rfc3339.txt].
-    #
-    # Example 1: Compute Timestamp from POSIX +time()+.
-    #
-    #     Timestamp timestamp;
-    #     timestamp.set_seconds(time(NULL));
-    #     timestamp.set_nanos(0);
-    #
-    # Example 2: Compute Timestamp from POSIX +gettimeofday()+.
-    #
-    #     struct timeval tv;
-    #     gettimeofday(&tv, NULL);
-    #
-    #     Timestamp timestamp;
-    #     timestamp.set_seconds(tv.tv_sec);
-    #     timestamp.set_nanos(tv.tv_usec * 1000);
-    #
-    # Example 3: Compute Timestamp from Win32 +GetSystemTimeAsFileTime()+.
-    #
-    #     FILETIME ft;
-    #     GetSystemTimeAsFileTime(&ft);
-    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
-    #
-    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
-    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
-    #     Timestamp timestamp;
-    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
-    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
-    #
-    # Example 4: Compute Timestamp from Java +System.currentTimeMillis()+.
-    #
-    #     long millis = System.currentTimeMillis();
-    #
-    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
-    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
-    #
-    #
-    # Example 5: Compute Timestamp from current time in Python.
-    #
-    #     timestamp = Timestamp()
-    #     timestamp.GetCurrentTime()
-    # @!attribute [rw] seconds
-    #   @return [Integer]
-    #     Represents seconds of UTC time since Unix epoch
-    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
-    #     9999-12-31T23:59:59Z inclusive.
-    # @!attribute [rw] nanos
-    #   @return [Integer]
-    #     Non-negative fractions of a second at nanosecond resolution. Negative
-    #     second values with fractions must still have non-negative nanos values
-    #     that count forward in time. Must be from 0 to 999,999,999
-    #     inclusive.
-    class Timestamp; end
-  end
-end