pubsub_client 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03ba6e12917979bfedb1b0d4aeade60f2ce675c561e99d57ace0b0850abb0f24
-  data.tar.gz: e0628ab5d8c8183c95a1a438be7e32964870d891d7ded108bf5ce4eb10f63c5d
+  metadata.gz: 4efa5b8b5abeff4f0dd13ee6d945c8f733b0b3b46dac6528fcf4bd527a5f08a5
+  data.tar.gz: c69aa4f023b2af7fbfe44c7021650026b7a31d2e49f5e543741b213fbb53d005
 SHA512:
-  metadata.gz: 4dafd9b8a6da6055d4d10bba716eb54d72fb6202b84ed693c090a9a53aa16c43ec6306fc641943f207da575bab6922fade8780536392f2f6c5231c7f88dc1558
-  data.tar.gz: 2f975bcc3d71fb66d9031be80929b0e709d0605e7596039274e4591b7ab36f83c5f70b67a49d4aebb2adac1a3d75588595bf787a2c4f7e1fdec45078f708d176
+  metadata.gz: c4d38c468281279004e4504fe4a01b31652937b57270b0d63ce5930da8fefc82ec5d1ad2c12f5d0921001e12c460d0fe9e808c5fdaf1c790f47d4556ee7ed4b7
+  data.tar.gz: a7586ca0100862cb137627e110ffcae41e46d775645ef88622c6e594746eac636f7e7be67cb68ebffebfd0c899a5e7bd9bd79281e72a2ed3534fd3b49c7817df

data/CHANGELOG.txt

@@ -1,3 +1,8 @@
+Version 2.0.0 2021-03-30
+------------------------
+172dc19 Add support for multiple clients
+3525193 Update subscriber example to include name of subscription instead of …
+
 Version 1.5.0 2020-11-05
 ------------------------
 6cab366 Do not require GAC when stubbed

data/README.md

@@ -22,11 +22,13 @@ Or install it yourself as:
 
 In order to use this gem, the environment variable `GOOGLE_APPLICATION_CREDENTIALS` must be set and point to the credentials JSON file.
 
-If there are environments where setting up credentials is too burdensome and/or publishing messages is not desired, `PubsubClient` can be stubbed out with `PubsubClient.stub!`, e.g.
+If there are environments where setting up credentials is too burdensome and/or publishing messages is not desired, `PubsubClient` can be stubbed out with `.stub!`, e.g.
 
 ```ruby
+@client = PubsubClient.new
+
 if test_env?
-  PubsubClient.stub!
+   @client.stub!
 end
 ```
 
@@ -34,11 +36,11 @@ end
 
 ### Publishing
 
-To publish a message to Pub/Sub, call `PubsubClient.publish(message, 'the-topic')`. This method takes any serializable object as an argument and yields a result object to a block. The `result` object has a method `#succeeded?` that returns `true` if the message was successfully published, otherwise `false`. In the latter case, there is a method `#error` that returns the error.
+To publish a message to Pub/Sub, call `@client.publish(message, 'the-topic')`. This method takes any serializable object as an argument and yields a result object to a block. The `result` object has a method `#succeeded?` that returns `true` if the message was successfully published, otherwise `false`. In the latter case, there is a method `#error` that returns the error.
 
 #### Example
 ```ruby
-PubsubClient.publish(message, 'some-topic') do |result|
+@client.publish(message, 'some-topic') do |result|
   if result.succeeded?
     puts 'yay!'
   else
@@ -55,7 +57,7 @@ Optionally, a client can choose to handle exceptions raised by the subscriber. I
 
 #### Example
 ```ruby
-subscriber = PubsubClient.subscriber('some-topic')
+subscriber = @client.subscriber('some-subscription')
 
 subscriber.listener(concurrency: 4, auto_ack: false) do |data, received_message|
   # Most clients will only need the first yielded arg.

data/lib/pubsub_client.rb

@@ -1,48 +1,50 @@
+# frozen_string_literal: true
+
 require 'pubsub_client/version'
 require 'pubsub_client/null_publisher_factory'
 require 'pubsub_client/null_subscriber_factory'
 require 'pubsub_client/publisher_factory'
 require 'pubsub_client/subscriber_factory'
 
-module PubsubClient
+class PubsubClient
   Error = Class.new(StandardError)
   ConfigurationError = Class.new(Error)
   CredentialsError = Class.new(Error)
   InvalidTopicError = Class.new(Error)
   InvalidSubscriptionError = Class.new(Error)
 
-  class << self
-    def stub!
-      raise ConfigurationError, 'PubsubClient is already configured' if @publisher_factory || @subscriber_factory
-      @publisher_factory = NullPublisherFactory.new
-      @subscriber_factory = NullSubscriberFactory.new
-      @stubbed = true
-    end
+  def stub!
+    raise ConfigurationError, 'PubsubClient is already configured' if @publisher_factory || @subscriber_factory
 
-    # @param message [String] The message to publish.
-    # @param topic [String] The name of the topic to publish to.
-    def publish(message, topic, attributes = {}, &block)
-      ensure_credentials!
+    @publisher_factory = NullPublisherFactory.new
+    @subscriber_factory = NullSubscriberFactory.new
+    @stubbed = true
+  end
 
-      @publisher_factory ||= PublisherFactory.new
-      @publisher_factory.build(topic).publish(message, attributes, &block)
-    end
+  # @param subscription [String] - The name of the subscription to subscribe to.
+  def subscriber(subscription)
+    ensure_credentials!
+
+    @subscriber_factory ||= SubscriberFactory.new
+    @subscriber_factory.build(subscription)
+  end
 
-    # @param subscription [String] - The name of the topic to subscribe to.
-    def subscriber(subscription)
-      ensure_credentials!
+  def publish(message, topic, attributes = {}, &block)
+    ensure_credentials!
 
-      @subscriber_factory ||= SubscriberFactory.new
-      @subscriber_factory.build(subscription)
-    end
+    @publisher_factory ||= PublisherFactory.new
+    @publisher_factory.build(topic).publish(message, attributes, &block)
+  end
+
+  private
+
+  attr_reader :stubbed, :publisher_factory, :subscriber_factory
 
-    private
+  def ensure_credentials!
+    return if defined?(stubbed) && stubbed
 
-    def ensure_credentials!
-      return if defined?(@stubbed) && @stubbed
-      unless ENV['GOOGLE_APPLICATION_CREDENTIALS']
-        raise CredentialsError, 'GOOGLE_APPLICATION_CREDENTIALS must be set'
-      end
+    unless ENV['GOOGLE_APPLICATION_CREDENTIALS']
+      raise CredentialsError, 'GOOGLE_APPLICATION_CREDENTIALS must be set'
     end
   end
 end

data/lib/pubsub_client/null_publisher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module PubsubClient
+class PubsubClient
   # A null object to act as a publisher when clients are in dev or test
   class NullPublisher
     # This is required so that this publisher maintains the same contract

data/lib/pubsub_client/null_publisher_factory.rb

@@ -2,7 +2,7 @@
 
 require_relative 'null_publisher'
 
-module PubsubClient
+class PubsubClient
   # A null object to act as a publisher factory when clients are in dev or test
   class NullPublisherFactory
     def build(*)

data/lib/pubsub_client/null_subscriber.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module PubsubClient
+class PubsubClient
   # A null object to act as a subscriber when clients are in dev or test
   class NullSubscriber
     # This adds a subset of the available methods on the

data/lib/pubsub_client/null_subscriber_factory.rb

@@ -2,7 +2,7 @@
 
 require_relative 'null_subscriber'
 
-module PubsubClient
+class PubsubClient
   # A null object to act as a subscriber factory when clients are in dev or test
   class NullSubscriberFactory
     def build(*)

data/lib/pubsub_client/publisher.rb

@@ -2,7 +2,7 @@
 
 require 'google/cloud/pubsub'
 
-module PubsubClient
+class PubsubClient
   class Publisher
     # @param topic [Google::Cloud::PubSub::Topic]
     def initialize(topic)

data/lib/pubsub_client/publisher_factory.rb

@@ -2,7 +2,7 @@
 
 require_relative 'publisher'
 
-module PubsubClient
+class PubsubClient
   # Build and memoize the Publisher, accounting for GRPC's requirements around forking.
   class PublisherFactory
     def initialize

data/lib/pubsub_client/subscriber.rb

@@ -2,7 +2,7 @@
 
 require 'google/cloud/pubsub'
 
-module PubsubClient
+class PubsubClient
   class Subscriber
     DEFAULT_CONCURRENCY = 8
 

data/lib/pubsub_client/subscriber_factory.rb

@@ -2,7 +2,7 @@
 
 require_relative 'subscriber'
 
-module PubsubClient
+class PubsubClient
   class SubscriberFactory
     def initialize
       @subscribers = {}

data/lib/pubsub_client/version.rb

@@ -1,3 +1,3 @@
-module PubsubClient
-  VERSION = '1.5.0'
+class PubsubClient
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubsub_client
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Apartment List Platforms
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake