pubsub_client 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2508e7f65206f72e0092d048d71416a77bf1391fcda8a13e43fbd50c2a4ae561
-  data.tar.gz: 7d1f9e9b1e0f9e6af43d732da015a08cb04cc7983237fd6ed4e5a24cd94f58c9
+  metadata.gz: 13c10d53daf5538c3aca168f2cee4ba8926bc6796bf77653fb9b9a87d2b26f72
+  data.tar.gz: eb7a89953c274694319285cb9350803d7b13f31a99e2bd1d365e074460ab06ce
 SHA512:
-  metadata.gz: 016b31843467a3de64bf9331650ce2ca371fd11c3ebe19e6c2b99e905407ad745e793c56ec08831e20e173f45e4cc13f89eb36a07f5eae33669fc4488c2acbc0
-  data.tar.gz: d07b99e406fe71164285e94624b53c0355ad8c9ac9c2fd2cbc2738f38fd19a3b1baef6845053000bf20cd21aa4ca4cc723c1d1e006da4b2a9c15859aad9145bb
+  metadata.gz: 81e5cbdad71787603ab5d5a6d2ac7802a7cc8e9bb40fe4414d5c87a4935ca266ad0afa0efb0fa48b03b2f8ccdaefe3963054614e6b25db359381758849e82e60
+  data.tar.gz: 289d015b198b809a9683b5d7594ffcbd98a70ce964a2ab4471ab42bba3f83e0de1dbe0a3bd29cbd19ea5498e6f4e85a171658a7a60f326393d019361125dd7f6

data/CHANGELOG.txt

@@ -0,0 +1,7 @@
+Version 1.0.0 2020-09-24
+------------------------
+396f5f8 Allow publishing to any topic
+
+Version 0.1.0 2020-08-25
+------------------------
+92a2e7a Initial release

data/README.md

@@ -20,30 +20,23 @@ Or install it yourself as:
 
 ## Configuration
 
-In order to use this gem, the environment variable `GOOGLE_APPLICATION_CREDENTIALS` must be set and point to the credentials JSON file. Additionally, here are configuration settings that may need to be set:
-- `topic_name` (required unless stubbed) - name of the Google Cloud Pub/Sub topic to publish messages to.
+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 `PubsubClient.stub!`, e.g.
 
 ```ruby
 if test_env?
   PubsubClient.stub!
-else
-  PubsubClient.configure do |config|
-    config.topic_name = 'some-topic'
-  end
 end
 ```
 
 ## Usage
 
-To publish a message to Pub/Sub, call `PubsubClient.publish(message)`. 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 `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.
 
 ### Example
 ```ruby
-PubsubClient.publish(message) do |result|
+PubsubClient.publish(message, 'some-topic') do |result|
   if result.succeeded?
     puts 'yay!'
   else

data/lib/pubsub_client.rb

@@ -4,40 +4,17 @@ require 'pubsub_client/publisher_factory'
 
 module PubsubClient
   Error = Class.new(StandardError)
-  CredentialsError = Class.new(Error)
   ConfigurationError = Class.new(Error)
 
-  Config = Struct.new(:topic_name)
-
   class << self
-    def configure(&block)
-      raise ConfigurationError, 'PubsubClient is already configured' if @publisher_factory
-
-      unless ENV['GOOGLE_APPLICATION_CREDENTIALS']
-        raise CredentialsError, 'GOOGLE_APPLICATION_CREDENTIALS must be set.'
-      end
-
-      config = Config.new
-      yield config
-
-      unless config.topic_name
-        raise ConfigurationError, 'The topic_name must be configured.'
-      end
-
-      @publisher_factory = PublisherFactory.new(config.topic_name)
-    end
-
     def stub!
       raise ConfigurationError, 'PubsubClient is already configured' if @publisher_factory
       @publisher_factory = NullPublisherFactory.new
     end
 
-    def publish(message, &block)
-      unless @publisher_factory
-        raise ConfigurationError, 'PubsubClient must be configured or stubbed'
-      end
-
-      @publisher_factory.build.publish(message, &block)
+    def publish(message, topic, &block)
+      @publisher_factory ||= PublisherFactory.new
+      @publisher_factory.build(topic).publish(message, &block)
     end
   end
 end

data/lib/pubsub_client/null_publisher_factory.rb

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

data/lib/pubsub_client/publisher_factory.rb

@@ -5,12 +5,12 @@ require_relative 'publisher'
 module PubsubClient
   # Build and memoize the Publisher, accounting for GRPC's requirements around forking.
   class PublisherFactory
-    def initialize(topic_name)
-      @topic_name = topic_name
+    def initialize
       @mutex = Mutex.new
+      @publishers = {}
     end
 
-    def build
+    def build(topic_name)
       # GRPC fails when attempting to use a connection created in a process that gets
       # forked with the message
       #
@@ -20,27 +20,28 @@ module PubsubClient
       # PubSub.
       #
       # To prevent incurring overhead, memoize the publisher per process.
-      return @publisher if @publisher_pid == current_pid
+      return publishers[topic_name].publisher if publishers[topic_name]&.pid == current_pid
 
       # We are in a multi-threaded world and need to be careful not to build the publisher
       # in multiple threads. Lock the mutex so that only one thread can enter this block
       # at a time.
-      mutex.synchronize do
+      @mutex.synchronize do
         # It's possible two threads made it to this point, but since we have a lock we
         # know that one will have built the publisher before the second is able to enter.
         # If we detect that case, then bail out so as to not rebuild the publisher.
-        unless @publisher_pid == current_pid
-          @publisher = build_publisher
-          @publisher_pid = Process.pid
+        unless publishers[topic_name]&.pid == current_pid
+          publishers[topic_name] = Memo.new(build_publisher(topic_name), Process.pid)
         end
       end
 
-      @publisher
+      publishers[topic_name].publisher
     end
 
     private
 
-    attr_reader :mutex, :topic_name
+    attr_accessor :publishers
+
+    Memo = Struct.new(:publisher, :pid)
 
     # Used for testing to simulate when a process is forked. In those cases,
     # this helps us test that the `.build` method creates different publishers.
@@ -48,7 +49,7 @@ module PubsubClient
       Process.pid
     end
 
-    def build_publisher
+    def build_publisher(topic_name)
       pubsub = Google::Cloud::PubSub.new
       topic = pubsub.topic(topic_name)
       publisher = Publisher.new(topic)

data/lib/pubsub_client/version.rb

@@ -1,3 +1,3 @@
 module PubsubClient
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubsub_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Apartment List Platforms
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,6 +76,7 @@ files:
 - ".ci"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.txt
 - CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: Google Pub/Sub Wrapper