google-cloud-pubsub 0.33.2 → 0.34.0

data/lib/google/cloud/pubsub/subscription/list.rb

@@ -17,7 +17,7 @@ require "delegate"
 
 module Google
   module Cloud
-    module Pubsub
+    module PubSub
       class Subscription
         ##
         # Subscription::List is a special case Array with additional values.
@@ -25,7 +25,7 @@ module Google
           ##
           # If not empty, indicates that there are more subscriptions
           # that match the request and this value should be passed to
-          # the next {Google::Cloud::Pubsub::Topic#subscriptions} to continue.
+          # the next {Google::Cloud::PubSub::Topic#subscriptions} to continue.
           attr_accessor :token
 
           ##
@@ -46,7 +46,7 @@ module Google
           # @example
           #   require "google/cloud/pubsub"
           #
-          #   pubsub = Google::Cloud::Pubsub.new
+          #   pubsub = Google::Cloud::PubSub.new
           #
           #   subscriptions = pubsub.subscriptions
           #   if subscriptions.next?
@@ -65,7 +65,7 @@ module Google
           # @example
           #   require "google/cloud/pubsub"
           #
-          #   pubsub = Google::Cloud::Pubsub.new
+          #   pubsub = Google::Cloud::PubSub.new
           #
           #   subscriptions = pubsub.subscriptions
           #   if subscriptions.next?
@@ -103,7 +103,7 @@ module Google
           # @example Iterating each subscription by passing a block:
           #   require "google/cloud/pubsub"
           #
-          #   pubsub = Google::Cloud::Pubsub.new
+          #   pubsub = Google::Cloud::PubSub.new
           #
           #   subscriptions = pubsub.subscriptions
           #   subscriptions.all do |subscription|
@@ -113,7 +113,7 @@ module Google
           # @example Using the enumerator by not passing a block:
           #   require "google/cloud/pubsub"
           #
-          #   pubsub = Google::Cloud::Pubsub.new
+          #   pubsub = Google::Cloud::PubSub.new
           #
           #   subscriptions = pubsub.subscriptions
           #   all_names = subscriptions.all.map do |subscription|
@@ -123,7 +123,7 @@ module Google
           # @example Limit the number of API calls made:
           #   require "google/cloud/pubsub"
           #
-          #   pubsub = Google::Cloud::Pubsub.new
+          #   pubsub = Google::Cloud::PubSub.new
           #
           #   subscriptions = pubsub.subscriptions
           #   subscriptions.all(request_limit: 10) do |subscription|
@@ -149,7 +149,7 @@ module Google
 
           ##
           # @private New Subscriptions::List from a
-          # Google::Pubsub::V1::ListSubscriptionsRequest object.
+          # Google::Cloud::PubSub::V1::ListSubscriptionsRequest object.
           def self.from_grpc grpc_list, service, max = nil
             subs = new(Array(grpc_list.subscriptions).map do |grpc|
               Subscription.from_grpc grpc, service
@@ -164,10 +164,10 @@ module Google
 
           ##
           # @private New Subscriptions::List from a
-          # Google::Pubsub::V1::ListTopicSubscriptionsResponse object.
+          # Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse object.
           def self.from_topic_grpc grpc_list, service, topic, max = nil
             subs = new(Array(grpc_list.subscriptions).map do |grpc|
-              Subscription.new_lazy grpc, service
+              Subscription.from_name grpc, service
             end)
             token = grpc_list.next_page_token
             token = nil if token == "".freeze
@@ -201,5 +201,7 @@ module Google
         end
       end
     end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
   end
 end

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

@@ -22,7 +22,7 @@ require "google/cloud/pubsub/policy"
 
 module Google
   module Cloud
-    module Pubsub
+    module PubSub
       ##
       # # Topic
       #
@@ -33,7 +33,7 @@ module Google
       # @example
       #   require "google/cloud/pubsub"
       #
-      #   pubsub = Google::Cloud::Pubsub.new
+      #   pubsub = Google::Cloud::PubSub.new
       #
       #   topic = pubsub.topic "my-topic"
       #   topic.publish "task completed"
@@ -44,7 +44,7 @@ module Google
         attr_accessor :service
 
         ##
-        # @private The Google::Pubsub::V1::Topic object.
+        # @private The Google::Cloud::PubSub::V1::Topic object.
         attr_accessor :grpc
 
         ##
@@ -52,7 +52,7 @@ module Google
         def initialize
           @service = nil
           @grpc = nil
-          @lazy = nil
+          @resource_name = nil
           @exists = nil
           @async_opts = {}
         end
@@ -66,7 +66,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   topic.publish_async "task completed" do |result|
@@ -90,6 +90,7 @@ module Google
         # @return [String]
         #
         def name
+          return @resource_name if reference?
           @grpc.name
         end
 
@@ -101,9 +102,13 @@ module Google
         # The returned hash is frozen and changes are not allowed. Use
         # {#labels=} to update the labels for this topic.
         #
+        # Makes an API call to retrieve the labels values when called on a
+        # reference object. See {#reference?}.
+        #
         # @return [Hash] The frozen labels hash.
         #
         def labels
+          ensure_grpc!
           @grpc.labels.to_h.freeze
         end
 
@@ -121,12 +126,10 @@ module Google
         #
         def labels= new_labels
           raise ArgumentError, "Value must be a Hash" if new_labels.nil?
-          labels_map = Google::Protobuf::Map.new(:string, :string)
-          Hash(new_labels).each { |k, v| labels_map[String(k)] = String(v) }
-          update_grpc = @grpc.dup
-          update_grpc.labels = labels_map
+          update_grpc = Google::Cloud::PubSub::V1::Topic.new \
+            name: name, labels: new_labels
           @grpc = service.update_topic update_grpc, :labels
-          @lazy = nil
+          @resource_name = nil
         end
 
         ##
@@ -137,7 +140,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   topic.delete
@@ -181,12 +184,12 @@ module Google
         #   label in the list must have a different key. See [Creating and
         #   Managing Labels](https://cloud.google.com/pubsub/docs/labels).
         #
-        # @return [Google::Cloud::Pubsub::Subscription]
+        # @return [Google::Cloud::PubSub::Subscription]
         #
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   sub = topic.subscribe "my-topic-sub"
@@ -195,7 +198,7 @@ module Google
         # @example Wait 2 minutes for acknowledgement and push all to endpoint:
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   sub = topic.subscribe "my-topic-sub",
@@ -222,13 +225,13 @@ module Google
         #   service. Calls made on this object will raise errors if the service
         #   resource does not exist. Default is `false`.
         #
-        # @return [Google::Cloud::Pubsub::Subscription, nil] Returns `nil` if
+        # @return [Google::Cloud::PubSub::Subscription, nil] Returns `nil` if
         #   the subscription does not exist.
         #
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #
@@ -238,7 +241,7 @@ module Google
         # @example Skip the lookup against the service with `skip_lookup`:
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #
@@ -248,7 +251,9 @@ module Google
         #
         def subscription subscription_name, skip_lookup: nil
           ensure_service!
-          return Subscription.new_lazy subscription_name, service if skip_lookup
+          if skip_lookup
+            return Subscription.from_name subscription_name, service
+          end
           grpc = service.get_subscription subscription_name
           Subscription.from_grpc grpc, service
         rescue Google::Cloud::NotFoundError
@@ -270,7 +275,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   subscriptions = topic.subscriptions
@@ -281,7 +286,7 @@ module Google
         # @example Retrieve all subscriptions: (See {Subscription::List#all})
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   subscriptions = topic.subscriptions
@@ -319,7 +324,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   msg = topic.publish "task completed"
@@ -327,7 +332,7 @@ module Google
         # @example A message can be published using a File object:
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   file = File.open "message.txt", mode: "rb"
@@ -336,7 +341,7 @@ module Google
         # @example Additionally, a message can be published with attributes:
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   msg = topic.publish "task completed",
@@ -346,7 +351,7 @@ module Google
         # @example Multiple messages can be sent at the same time using a block:
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   msgs = topic.publish do |t|
@@ -379,7 +384,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   topic.publish_async "task completed" do |result|
@@ -395,7 +400,7 @@ module Google
         # @example A message can be published using a File object:
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   file = File.open "message.txt", mode: "rb"
@@ -406,7 +411,7 @@ module Google
         # @example Additionally, a message can be published with attributes:
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   topic.publish_async "task completed",
@@ -440,7 +445,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #   topic = pubsub.topic "my-topic"
         #
         #   policy = topic.policy
@@ -448,7 +453,7 @@ module Google
         # @example Update the policy by passing a block:
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #   topic = pubsub.topic "my-topic"
         #
         #   topic.policy do |p|
@@ -467,7 +472,7 @@ module Google
         ##
         # Updates the [Cloud IAM](https://cloud.google.com/iam/) access control
         # policy for this topic. The policy should be read from {#policy}. See
-        # {Google::Cloud::Pubsub::Policy} for an explanation of the policy
+        # {Google::Cloud::PubSub::Policy} for an explanation of the policy
         # `etag` property and how to modify policies.
         #
         # You can also update the policy by passing a block to {#policy}, which
@@ -484,7 +489,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #   topic = pubsub.topic "my-topic"
         #
         #   policy = topic.policy # API call
@@ -526,7 +531,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #   topic = pubsub.topic "my-topic"
         #   perms = topic.test_permissions "pubsub.topics.get",
         #                                  "pubsub.topics.publish"
@@ -547,14 +552,14 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   topic.exists? #=> true
         #
         def exists?
-          # Always true if the object is not set as lazy
-          return true unless lazy?
+          # Always true if the object is not set as reference
+          return true unless reference?
           # If we have a value, return it
           return @exists unless @exists.nil?
           ensure_grpc!
@@ -564,23 +569,45 @@ module Google
         end
 
         ##
-        # @private
-        # Determines whether the topic object was created with an HTTP call.
+        # Determines whether the topic object was created without retrieving the
+        # resource representation from the Pub/Sub service.
+        #
+        # @return [Boolean] `true` when the topic was created without a resource
+        #   representation, `false` otherwise.
         #
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
+        #
+        #   topic = pubsub.topic "my-topic", skip_lookup: true
+        #   topic.reference? #=> true
+        #
+        def reference?
+          @grpc.nil?
+        end
+
+        ##
+        # Determines whether the topic object was created with a resource
+        # representation from the Pub/Sub service.
+        #
+        # @return [Boolean] `true` when the topic was created with a resource
+        #   representation, `false` otherwise.
+        #
+        # @example
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
-        #   topic.lazy? #=> nil
+        #   topic.resource? #=> true
         #
-        def lazy?
-          @lazy
+        def resource?
+          !@grpc.nil?
         end
 
         ##
-        # @private New Topic from a Google::Pubsub::V1::Topic object.
+        # @private New Topic from a Google::Cloud::PubSub::V1::Topic object.
         def self.from_grpc grpc, service, async: nil
           new.tap do |t|
             t.grpc = grpc
@@ -590,12 +617,11 @@ module Google
         end
 
         ##
-        # @private New lazy {Topic} object without making an HTTP request.
-        def self.new_lazy name, service, options = {}
-          lazy_grpc = Google::Pubsub::V1::Topic.new \
-            name: service.topic_path(name, options)
-          from_grpc(lazy_grpc, service).tap do |t|
-            t.instance_variable_set :@lazy, true
+        # @private New reference {Topic} object without making an HTTP request.
+        def self.from_name name, service, options = {}
+          name = service.topic_path name, options
+          from_grpc(nil, service).tap do |t|
+            t.instance_variable_set :@resource_name, name
           end
         end
 
@@ -609,11 +635,11 @@ module Google
         end
 
         ##
-        # Ensures a Google::Pubsub::V1::Topic object exists.
+        # Ensures a Google::Cloud::PubSub::V1::Topic object exists.
         def ensure_grpc!
           ensure_service!
-          @grpc = service.get_topic name if lazy?
-          @lazy = nil
+          @grpc = service.get_topic name if reference?
+          @resource_name = nil
         end
 
         ##
@@ -624,5 +650,7 @@ module Google
         end
       end
     end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
   end
 end