google-cloud-pubsub 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ed97e68a23ababe3268559effcac9c99bfcd390
-  data.tar.gz: 35e382342f920445a7b58e13e9c32ba0c96b0cc4
+  metadata.gz: 0fbe44f633b537eb6bc83e65289dd8245e2cf1f4
+  data.tar.gz: d3dde42ddf39bea98fdacda63376344b62abcd03
 SHA512:
-  metadata.gz: a3799ef6da67d6870fb2054da570540ebef4d51f0ea56932d35a6d5bd7404a4777e87002420a68f6f2c2dd3e17973f8c6e2a45a6b672e3e77c5573b26d1851fb
-  data.tar.gz: 3a51da97b7c25e7c9819a7f56e1836f6e8fbe61d953cdb4e74bf407148514923f69437d03df899e1505b27c32f4bfa4131713f7ae4c856398f0993c17d494f4b
+  metadata.gz: 3ed85872dd67b6a401a67ef656a056271ed0231500d7e589d3f3b9b8d3b381e5a74d612392639c95c7f3f1039b8226f410009a3dd5843ece2c9b5d02a7efe9b0
+  data.tar.gz: 673fb489421513dd5a9e63cef35c28536e1ba8fa0cf442c9c7b1d7db072bdee624c97cdb9d164a8fbe8b0ebaf484b0fcad58301163b9e0e5b1295efc38628e74

data/lib/google-cloud-pubsub.rb

@@ -38,9 +38,9 @@ module Google
     #   The default scope is:
     #
     #   * `https://www.googleapis.com/auth/pubsub`
-    # @param [Integer] retries Number of times to retry requests on server
-    #   error. The default value is `3`. Optional.
     # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [Hash] client_config A hash of values to override the default
+    #   behavior of the API client. Optional.
     #
     # @return [Google::Cloud::Pubsub::Project]
     #
@@ -59,10 +59,10 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   pubsub = gcloud.pubsub scope: platform_scope
     #
-    def pubsub scope: nil, retries: nil, timeout: nil
+    def pubsub scope: nil, timeout: nil, client_config: nil
       Google::Cloud.pubsub @project, @keyfile, scope: scope,
-                                               retries: (retries || @retries),
-                                               timeout: (timeout || @timeout)
+                                               timeout: (timeout || @timeout),
+                                               client_config: client_config
     end
 
     ##
@@ -84,39 +84,26 @@ module Google
     #   The default scope is:
     #
     #   * `https://www.googleapis.com/auth/pubsub`
-    # @param [Integer] retries Number of times to retry requests on server
-    #   error. The default value is `3`. Optional.
     # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [Hash] client_config A hash of values to override the default
+    #   behavior of the API client. Optional.
     #
     # @return [Google::Cloud::Pubsub::Project]
     #
     # @example
-    #   require "google/cloud/pubsub"
+    #   require "google/cloud"
     #
     #   pubsub = Google::Cloud.pubsub
     #
     #   topic = pubsub.topic "my-topic"
     #   topic.publish "task completed"
     #
-    def self.pubsub project = nil, keyfile = nil, scope: nil, retries: nil,
-                    timeout: nil
+    def self.pubsub project = nil, keyfile = nil, scope: nil, timeout: nil,
+                    client_config: nil
       require "google/cloud/pubsub"
-      project ||= Google::Cloud::Pubsub::Project.default_project
-      if ENV["PUBSUB_EMULATOR_HOST"]
-        ps = Google::Cloud::Pubsub::Project.new(
-          project, :this_channel_is_insecure)
-        ps.service.host = ENV["PUBSUB_EMULATOR_HOST"]
-        return ps
-      end
-      if keyfile.nil?
-        credentials = Google::Cloud::Pubsub::Credentials.default scope: scope
-      else
-        credentials = Google::Cloud::Pubsub::Credentials.new(
-          keyfile, scope: scope)
-      end
-      Google::Cloud::Pubsub::Project.new(
-        Google::Cloud::Pubsub::Service.new(
-          project, credentials, retries: retries, timeout: timeout))
+      Google::Cloud::Pubsub.new project: project, keyfile: keyfile,
+                                scope: scope, timeout: timeout,
+                                client_config: client_config
     end
   end
 end

data/lib/google/cloud/pubsub.rb

@@ -35,10 +35,9 @@ module Google
     # is taken care of for you.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # topic = pubsub.topic "my-topic"
     # topic.publish "task completed"
@@ -53,10 +52,9 @@ module Google
     # A Topic is found by its name. (See {Google::Cloud::Pubsub::Project#topic})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     # topic = pubsub.topic "my-topic"
     # ```
     #
@@ -66,10 +64,9 @@ module Google
     # {Google::Cloud::Pubsub::Project#create_topic})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     # topic = pubsub.create_topic "my-topic"
     # ```
     #
@@ -81,10 +78,9 @@ module Google
     # {Google::Cloud::Pubsub::Topic#subscription})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # topic = pubsub.topic "my-topic"
     # subscription = topic.subscription "my-topic-subscription"
@@ -98,10 +94,9 @@ module Google
     # {Google::Cloud::Pubsub::Project#subscribe})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # topic = pubsub.topic "my-topic"
     # sub = topic.subscribe "my-topic-sub"
@@ -113,10 +108,9 @@ module Google
     # to:
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # topic = pubsub.topic "my-topic"
     # sub = topic.subscribe "my-topic-sub",
@@ -132,10 +126,9 @@ module Google
     # {Google::Cloud::Pubsub::Project#publish})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # topic = pubsub.topic "my-topic"
     # msg = topic.publish "new-message"
@@ -144,10 +137,9 @@ module Google
     # Messages can also be published with attributes:
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # topic = pubsub.topic "my-topic"
     # msg = topic.publish "new-message",
@@ -158,10 +150,9 @@ module Google
     # Multiple messages can be published at the same time by passing a block:
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # topic = pubsub.topic "my-topic"
     # msgs = topic.publish do |batch|
@@ -177,10 +168,9 @@ module Google
     # {Google::Cloud::Pubsub::Subscription#pull})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # msgs = sub.pull
@@ -189,10 +179,9 @@ module Google
     # A maximum number of messages returned can also be specified:
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub", max: 10
     # msgs = sub.pull
@@ -202,10 +191,9 @@ module Google
     # (See {Google::Cloud::Pubsub::Subscription#wait_for_messages})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # msgs = sub.wait_for_messages
@@ -221,10 +209,9 @@ module Google
     # (See {Google::Cloud::Pubsub::ReceivedMessage#acknowledge!})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # sub.pull.each { |msg| msg.acknowledge! }
@@ -234,10 +221,9 @@ module Google
     # (See {Google::Cloud::Pubsub::Subscription#acknowledge})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # received_messages = sub.pull
@@ -253,10 +239,9 @@ module Google
     # {Google::Cloud::Pubsub::ReceivedMessage#delay!})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # received_message = sub.pull.first
@@ -270,10 +255,9 @@ module Google
     # The message can also be made available for immediate redelivery:
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # received_message = sub.pull.first
@@ -288,10 +272,9 @@ module Google
     # redelivery: (See {Google::Cloud::Pubsub::Subscription#delay})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # received_messages = sub.pull
@@ -305,10 +288,9 @@ module Google
     # {Google::Cloud::Pubsub::Subscription#listen})
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # sub.listen do |msg|
@@ -320,10 +302,9 @@ module Google
     # pulled per batch can be limited with the `max` option:
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # sub.listen max: 20 do |msg|
@@ -336,10 +317,9 @@ module Google
     # `autoack` option:
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new
     #
     # sub = pubsub.subscription "my-topic-sub"
     # sub.listen autoack: true do |msg|
@@ -347,29 +327,16 @@ module Google
     # end
     # ```
     #
-    # ## Configuring retries and timeout
+    # ## Configuring timeout
     #
-    # You can configure how many times API requests may be automatically
-    # retried. When an API request fails, the response will be inspected to see
-    # if the request meets criteria indicating that it may succeed on retry,
-    # such as `500` and `503` status codes or a specific internal error code
-    # such as `rateLimitExceeded`. If it meets the criteria, the request will be
-    # retried after a delay. If another error occurs, the delay will be
-    # increased before a subsequent attempt, until the `retries` limit is
-    # reached.
-    #
-    # You can also set the request `timeout` value in seconds.
+    # You can configure the request `timeout` value in seconds.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new
-    # pubsub = gcloud.pubsub retries: 10, timeout: 120
+    # pubsub = Google::Cloud::Pubsub.new timeout: 120
     # ```
     #
-    # See the [Pub/Sub error codes](https://cloud.google.com/pubsub/error-codes)
-    # for a list of error conditions.
-    #
     # ## Working Across Projects
     #
     # All calls to the Pub/Sub service use the same project and credentials
@@ -379,10 +346,9 @@ module Google
     # to the topics and subscriptions in other projects.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new # my-project-id
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new # my-project-id
     #
     # # Get a topic in the current project
     # my_topic = pubsub.topic "my-topic"
@@ -396,10 +362,9 @@ module Google
     # from a topic in another project:
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
-    # gcloud = Google::Cloud.new # my-project-id
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new # my-project-id
     #
     # # Get a topic in another project
     # topic = pubsub.topic "other-topic", project: "other-project-id"
@@ -426,13 +391,12 @@ module Google
     # as shown below.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/pubsub"
     #
     # # Make Pub/Sub use the emulator
     # ENV["PUBSUB_EMULATOR_HOST"] = "localhost:8918"
     #
-    # gcloud = Google::Cloud.new "emulator-project-id"
-    # pubsub = gcloud.pubsub
+    # pubsub = Google::Cloud::Pubsub.new "emulator-project-id"
     #
     # # Get a topic in the current project
     # my_topic = pubsub.new_topic "my-topic"
@@ -440,6 +404,62 @@ module Google
     # ```
     #
     module Pubsub
+      ##
+      # Creates a new object for connecting to the Pub/Sub service.
+      # Each call creates a new connection.
+      #
+      # For more information on connecting to Google Cloud see the
+      # [Authentication
+      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+      #
+      # @param [String] project Project identifier for the Pub/Sub service you
+      #   are connecting to.
+      # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
+      #   file path the file must be readable.
+      # @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
+      #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+      #
+      #   The default scope is:
+      #
+      #   * `https://www.googleapis.com/auth/pubsub`
+      # @param [Integer] timeout Default timeout to use in requests. Optional.
+      # @param [Hash] client_config A hash of values to override the default
+      #   behavior of the API client. Optional.
+      #
+      # @return [Google::Cloud::Pubsub::Project]
+      #
+      # @example
+      #   require "google/cloud/pubsub"
+      #
+      #   pubsub = Google::Cloud.pubsub
+      #
+      #   topic = pubsub.topic "my-topic"
+      #   topic.publish "task completed"
+      #
+      def self.new project: nil, keyfile: nil, scope: nil, timeout: nil,
+                   client_config: nil
+        project ||= Google::Cloud::Pubsub::Project.default_project
+        project = project.to_s # Always cast to a string
+        if ENV["PUBSUB_EMULATOR_HOST"]
+          ps = Google::Cloud::Pubsub::Project.new(
+            Google::Cloud::Pubsub::Service.new(
+              project, :this_channel_is_insecure))
+          ps.service.host = ENV["PUBSUB_EMULATOR_HOST"]
+          return ps
+        end
+        if keyfile.nil?
+          credentials = Google::Cloud::Pubsub::Credentials.default scope: scope
+        else
+          credentials = Google::Cloud::Pubsub::Credentials.new \
+            keyfile, scope: scope
+        end
+        Google::Cloud::Pubsub::Project.new(
+          Google::Cloud::Pubsub::Service.new(
+            project, credentials, timeout: timeout,
+                                  client_config: client_config))
+      end
     end
   end
 end