google-cloud-pubsub 0.33.2 → 0.34.0

data/lib/google-cloud-pubsub.rb

@@ -45,7 +45,7 @@ module Google
     # @param [Hash] client_config A hash of values to override the default
     #   behavior of the API client. Optional.
     #
-    # @return [Google::Cloud::Pubsub::Project]
+    # @return [Google::Cloud::PubSub::Project]
     #
     # @example
     #   require "google/cloud"
@@ -63,8 +63,9 @@ module Google
     #   pubsub = gcloud.pubsub scope: platform_scope
     #
     def pubsub scope: nil, timeout: nil, client_config: nil
-      Google::Cloud.pubsub @project, @keyfile, scope: scope,
-                                               timeout: (timeout || @timeout),
+      timeout ||= @timeout
+      Google::Cloud.pubsub @project, @keyfile, scope:         scope,
+                                               timeout:       timeout,
                                                client_config: client_config
     end
 
@@ -80,7 +81,8 @@ module Google
     #   credentials is used.
     # @param [String, Hash, Google::Auth::Credentials] credentials The path to
     #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-    #   Google::Auth::Credentials object. (See {Pubsub::Credentials})
+    #   Google::Auth::Credentials object.
+    #   (See {Google::Cloud::PubSub::Credentials})
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
     #   set of resources and operations that the connection can access. See
     #   [Using OAuth 2.0 to Access Google
@@ -93,7 +95,7 @@ module Google
     # @param [Hash] client_config A hash of values to override the default
     #   behavior of the API client. Optional.
     #
-    # @return [Google::Cloud::Pubsub::Project]
+    # @return [Google::Cloud::PubSub::Project]
     #
     # @example
     #   require "google/cloud"
@@ -106,7 +108,7 @@ module Google
     def self.pubsub project_id = nil, credentials = nil, scope: nil,
                     timeout: nil, client_config: nil
       require "google/cloud/pubsub"
-      Google::Cloud::Pubsub.new project_id: project_id,
+      Google::Cloud::PubSub.new project_id: project_id,
                                 credentials: credentials,
                                 scope: scope, timeout: timeout,
                                 client_config: client_config
@@ -132,7 +134,7 @@ Google::Cloud.configure.add_config! :pubsub do |config|
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
   config.add_field! :credentials, default_creds,
-                    match: [String, Hash, Google::Auth::Credentials],
+                    match:     [String, Hash, Google::Auth::Credentials],
                     allow_nil: true
   config.add_alias! :keyfile, :credentials
   config.add_field! :scope, nil, match: [String, Array]
@@ -140,4 +142,5 @@ Google::Cloud.configure.add_config! :pubsub do |config|
   config.add_field! :client_config, nil, match: Hash
   config.add_field! :emulator_host, default_emulator,
                     match: String, allow_nil: true
+  config.add_field! :on_error, nil, match: Proc
 end

data/lib/google/cloud/pubsub.rb

@@ -32,7 +32,9 @@ module Google
     #
     # See {file:OVERVIEW.md Google Cloud Pub/Sub Overview}.
     #
-    module Pubsub
+    module PubSub
+      # rubocop:disable Metrics/AbcSize
+
       ##
       # Creates a new object for connecting to the Pub/Sub service.
       # Each call creates a new connection.
@@ -45,7 +47,7 @@ module Google
       #   credentials is used.
       # @param [String, Hash, Google::Auth::Credentials] credentials The path to
       #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-      #   Google::Auth::Credentials object. (See {Pubsub::Credentials})
+      #   Google::Auth::Credentials object. (See {PubSub::Credentials})
       # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       #   See [Using OAuth 2.0 to Access Google
@@ -63,7 +65,7 @@ module Google
       # @param [String] keyfile Alias for the `credentials` argument.
       #   Deprecated.
       #
-      # @return [Google::Cloud::Pubsub::Project]
+      # @return [Google::Cloud::PubSub::Project]
       #
       # @example
       #   require "google/cloud/pubsub"
@@ -76,17 +78,18 @@ module Google
       def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
                    client_config: nil, emulator_host: nil, project: nil,
                    keyfile: nil
-        project_id ||= (project || default_project_id)
-        project_id = project_id.to_s # Always cast to a string
-        raise ArgumentError, "project_id is missing" if project_id.empty?
-
-        scope ||= configure.scope
-        timeout ||= configure.timeout
+        project_id    ||= (project || default_project_id)
+        scope         ||= configure.scope
+        timeout       ||= configure.timeout
         client_config ||= configure.client_config
         emulator_host ||= configure.emulator_host
+
         if emulator_host
-          return Pubsub::Project.new(
-            Pubsub::Service.new(
+          project_id = project_id.to_s # Always cast to a string
+          raise ArgumentError, "project_id is missing" if project_id.empty?
+
+          return PubSub::Project.new(
+            PubSub::Service.new(
               project_id, :this_channel_is_insecure,
               host: emulator_host, timeout: timeout,
               client_config: client_config
@@ -96,27 +99,35 @@ module Google
 
         credentials ||= (keyfile || default_credentials(scope: scope))
         unless credentials.is_a? Google::Auth::Credentials
-          credentials = Pubsub::Credentials.new credentials, scope: scope
+          credentials = PubSub::Credentials.new credentials, scope: scope
         end
 
-        Pubsub::Project.new(
-          Pubsub::Service.new(
-            project_id, credentials, timeout: timeout,
+        if credentials.respond_to? :project_id
+          project_id ||= credentials.project_id
+        end
+        project_id = project_id.to_s # Always cast to a string
+        raise ArgumentError, "project_id is missing" if project_id.empty?
+
+        PubSub::Project.new(
+          PubSub::Service.new(
+            project_id, credentials, timeout:       timeout,
                                      client_config: client_config
           )
         )
       end
 
+      # rubocop:enable Metrics/AbcSize
+
       ##
-      # Configure the Google Cloud Pubsub library.
+      # Configure the Google Cloud PubSub library.
       #
-      # The following Pubsub configuration parameters are supported:
+      # The following PubSub configuration parameters are supported:
       #
-      # * `project_id` - (String) Identifier for a Pubsub project. (The
+      # * `project_id` - (String) Identifier for a PubSub project. (The
       #   parameter `project` is considered deprecated, but may also be used.)
       # * `credentials` - (String, Hash, Google::Auth::Credentials) The path to
       #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-      #   Google::Auth::Credentials object. (See {Pubsub::Credentials}) (The
+      #   Google::Auth::Credentials object. (See {PubSub::Credentials}) (The
       #   parameter `keyfile` is considered deprecated, but may also be used.)
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
@@ -127,9 +138,12 @@ module Google
       #   behavior of the API client.
       # * `emulator_host` - (String) Host name of the emulator. Defaults to
       #   `ENV["PUBSUB_EMULATOR_HOST"]`
+      # * `on_error` - (Proc) A Proc to be run when an error is encountered
+      #   on a background thread. The Proc must take the error object as the
+      #   single argument. (See {Subscriber.on_error}.)
       #
       # @return [Google::Cloud::Config] The configuration object the
-      #   Google::Cloud::Pubsub library uses.
+      #   Google::Cloud::PubSub library uses.
       #
       def self.configure
         yield Google::Cloud.configure.pubsub if block_given?
@@ -150,8 +164,11 @@ module Google
       def self.default_credentials scope: nil
         Google::Cloud.configure.pubsub.credentials ||
           Google::Cloud.configure.credentials ||
-          Pubsub::Credentials.default(scope: scope)
+          PubSub::Credentials.default(scope: scope)
       end
     end
+
+    ## Legacy namespace
+    Pubsub = PubSub unless const_defined? :Pubsub
   end
 end

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

@@ -20,15 +20,15 @@ require "google/cloud/pubsub/service"
 
 module Google
   module Cloud
-    module Pubsub
+    module PubSub
       ##
       # Used to publish multiple messages in batches to a topic. See
-      # {Google::Cloud::Pubsub::Topic#async_publisher}
+      # {Google::Cloud::PubSub::Topic#async_publisher}
       #
       # @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|
@@ -88,7 +88,7 @@ module Google
         ##
         # Add a message to the async publisher to be published to the topic.
         # Messages will be collected in batches and published together.
-        # See {Google::Cloud::Pubsub::Topic#publish_async}
+        # See {Google::Cloud::PubSub::Topic#publish_async}
         def publish data = nil, attributes = {}, &block
           msg = create_pubsub_message data, attributes
 
@@ -281,8 +281,8 @@ module Google
           # Convert attributes to strings to match the protobuf definition
           attributes = Hash[attributes.map { |k, v| [String(k), String(v)] }]
 
-          Google::Pubsub::V1::PubsubMessage.new data: data_bytes,
-                                                attributes: attributes
+          Google::Cloud::PubSub::V1::PubsubMessage.new data:       data_bytes,
+                                                       attributes: attributes
         end
 
         ##
@@ -337,5 +337,7 @@ module Google
         end
       end
     end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
   end
 end

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

@@ -15,7 +15,7 @@
 
 module Google
   module Cloud
-    module Pubsub
+    module PubSub
       ##
       # Topic Batch Publisher object used to publish multiple messages at
       # once.
@@ -23,7 +23,7 @@ module Google
       # @example
       #   require "google/cloud/pubsub"
       #
-      #   pubsub = Google::Cloud::Pubsub.new
+      #   pubsub = Google::Cloud::PubSub.new
       #
       #   topic = pubsub.topic "my-topic"
       #   msgs = topic.publish do |t|
@@ -49,7 +49,7 @@ module Google
         ##
         # Add a message to the batch to be published to the topic.
         # All messages added to the batch will be published at once.
-        # See {Google::Cloud::Pubsub::Topic#publish}
+        # See {Google::Cloud::PubSub::Topic#publish}
         def publish data, attributes = {}
           @messages << create_pubsub_message(data, attributes)
         end
@@ -90,10 +90,12 @@ module Google
           # Convert attributes to strings to match the protobuf definition
           attributes = Hash[attributes.map { |k, v| [String(k), String(v)] }]
 
-          Google::Pubsub::V1::PubsubMessage.new data: data_bytes,
-                                                attributes: attributes
+          Google::Cloud::PubSub::V1::PubsubMessage.new data:       data_bytes,
+                                                       attributes: attributes
         end
       end
     end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
   end
 end

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

@@ -17,7 +17,7 @@ require "time"
 
 module Google
   module Cloud
-    module Pubsub
+    module PubSub
       ##
       # @private Helper module for converting Pub/Sub values.
       module Convert
@@ -30,7 +30,7 @@ module Google
 
             Google::Protobuf::Timestamp.new \
               seconds: time.to_i,
-              nanos: time.nsec
+              nanos:   time.nsec
           end
 
           def timestamp_to_time timestamp
@@ -44,7 +44,7 @@ module Google
 
             Google::Protobuf::Duration.new \
               seconds: number.to_i,
-              nanos: (number.remainder(1) * 1000000000).round
+              nanos:   (number.remainder(1) * 1000000000).round
           end
 
           def duration_to_number duration
@@ -59,5 +59,7 @@ module Google
         extend ClassMethods
       end
     end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
   end
 end

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

@@ -18,7 +18,7 @@ require "google/cloud/pubsub/v1/credentials.rb"
 
 module Google
   module Cloud
-    module Pubsub
+    module PubSub
       ##
       # # Credentials
       #
@@ -29,17 +29,19 @@ module Google
       #   require "google/cloud/pubsub"
       #
       #   keyfile = "/path/to/keyfile.json"
-      #   creds = Google::Cloud::Pubsub::Credentials.new keyfile
+      #   creds = Google::Cloud::PubSub::Credentials.new keyfile
       #
-      #   pubsub = Google::Cloud::Pubsub.new(
+      #   pubsub = Google::Cloud::PubSub.new(
       #     project_id: "my-project",
       #     credentials: creds
       #   )
       #
       #   pubsub.project_id #=> "my-project"
       #
-      class Credentials < Google::Cloud::Pubsub::V1::Credentials
+      class Credentials < Google::Cloud::PubSub::V1::Credentials
       end
     end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
   end
 end

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

@@ -18,7 +18,7 @@ require "google/cloud/errors"
 
 module Google
   module Cloud
-    module Pubsub
+    module PubSub
       ##
       # # Message
       #
@@ -32,7 +32,7 @@ module Google
       # @example
       #   require "google/cloud/pubsub"
       #
-      #   pubsub = Google::Cloud::Pubsub.new
+      #   pubsub = Google::Cloud::PubSub.new
       #
       #   # Publish a message
       #   topic = pubsub.topic "my-topic"
@@ -54,7 +54,7 @@ module Google
       #
       class Message
         ##
-        # @private The gRPC Google::Pubsub::V1::PubsubMessage object.
+        # @private The gRPC Google::Cloud::PubSub::V1::PubsubMessage object.
         attr_accessor :grpc
 
         ##
@@ -64,8 +64,8 @@ module Google
           # 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).dup.force_encoding(Encoding::ASCII_8BIT),
+          @grpc = Google::Cloud::PubSub::V1::PubsubMessage.new(
+            data:       String(data).dup.force_encoding(Encoding::ASCII_8BIT),
             attributes: attributes
           )
         end
@@ -101,7 +101,8 @@ module Google
         alias publish_time published_at
 
         ##
-        # @private New Message from a Google::Pubsub::V1::PubsubMessage object.
+        # @private New Message from a Google::Cloud::PubSub::V1::PubsubMessage
+        # object.
         def self.from_grpc grpc
           new.tap do |m|
             m.instance_variable_set :@grpc, grpc
@@ -109,5 +110,7 @@ module Google
         end
       end
     end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
   end
 end

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

@@ -17,7 +17,7 @@ require "google/cloud/errors"
 
 module Google
   module Cloud
-    module Pubsub
+    module PubSub
       ##
       # # Policy
       #
@@ -27,7 +27,7 @@ module Google
       # is to read the current data from the service, update the data locally,
       # and then send the modified data for writing. This pattern may result in
       # a conflict if two or more processes attempt the sequence simultaneously.
-      # IAM solves this problem with the {Google::Cloud::Pubsub::Policy#etag}
+      # IAM solves this problem with the {Google::Cloud::PubSub::Policy#etag}
       # property, which is used to verify whether the policy has changed since
       # the last request. When you make a request to with an `etag` value, Cloud
       # IAM compares the `etag` value in the request with the existing `etag`
@@ -37,8 +37,8 @@ module Google
       # When you update a policy, first read the policy (and its current `etag`)
       # from the service, then modify the policy locally, and then write the
       # modified policy to the service. See
-      # {Google::Cloud::Pubsub::Topic#policy} and
-      # {Google::Cloud::Pubsub::Topic#policy=}.
+      # {Google::Cloud::PubSub::Topic#policy} and
+      # {Google::Cloud::PubSub::Topic#policy=}.
       #
       # @see https://cloud.google.com/iam/docs/managing-policies Managing
       #   policies
@@ -58,7 +58,7 @@ module Google
       # @example
       #   require "google/cloud/pubsub"
       #
-      #   pubsub = Google::Cloud::Pubsub.new
+      #   pubsub = Google::Cloud::PubSub.new
       #   topic = pubsub.topic "my-topic"
       #
       #   topic.policy do |p|
@@ -93,7 +93,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #   topic = pubsub.topic "my-topic"
         #
         #   topic.policy do |p|
@@ -120,7 +120,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #   topic = pubsub.topic "my-topic"
         #
         #   topic.policy do |p|
@@ -145,7 +145,7 @@ module Google
         # @example
         #   require "google/cloud/pubsub"
         #
-        #   pubsub = Google::Cloud::Pubsub.new
+        #   pubsub = Google::Cloud::PubSub.new
         #   topic = pubsub.topic "my-topic"
         #
         #   topic.policy do |p|
@@ -160,11 +160,11 @@ module Google
         # @private Convert the Policy to a Google::Iam::V1::Policy object.
         def to_grpc
           Google::Iam::V1::Policy.new(
-            etag: etag,
+            etag:     etag,
             bindings: roles.keys.map do |role_name|
               next if roles[role_name].empty?
               Google::Iam::V1::Binding.new(
-                role: role_name,
+                role:    role_name,
                 members: roles[role_name]
               )
             end
@@ -181,5 +181,7 @@ module Google
         end
       end
     end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
   end
 end