pubsub_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2508e7f65206f72e0092d048d71416a77bf1391fcda8a13e43fbd50c2a4ae561
+  data.tar.gz: 7d1f9e9b1e0f9e6af43d732da015a08cb04cc7983237fd6ed4e5a24cd94f58c9
+SHA512:
+  metadata.gz: 016b31843467a3de64bf9331650ce2ca371fd11c3ebe19e6c2b99e905407ad745e793c56ec08831e20e173f45e4cc13f89eb36a07f5eae33669fc4488c2acbc0
+  data.tar.gz: d07b99e406fe71164285e94624b53c0355ad8c9ac9c2fd2cbc2738f38fd19a3b1baef6845053000bf20cd21aa4ca4cc723c1d1e006da4b2a9c15859aad9145bb

data/.ci

@@ -0,0 +1,133 @@
+properties([
+  buildDiscarder(
+    logRotator(
+      artifactDaysToKeepStr: '',
+      artifactNumToKeepStr: '',
+      daysToKeepStr: '30',
+      numToKeepStr: '100'
+    )
+  )
+])
+
+def k8s_label = "${UUID.randomUUID().toString()}"
+
+pipeline {
+
+  environment {
+    APP_NAME = 'pubsub_client'
+    CLOUDSDK_CORE_DISABLE_PROMPTS = '1'
+    GIT_COMMIT_SHORT = sh(script: "printf \$(git rev-parse --short ${GIT_COMMIT})", returnStdout: true)
+    APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE = "true"
+    LANG = "en_US.UTF-8"
+    LANGUAGE = "en_US:en"
+    LC_ALL = "en_US.UTF-8"
+  }
+
+  agent {
+    kubernetes {
+      label k8s_label
+      defaultContainer 'jnlp'
+      yaml """
+apiVersion: v1
+kind: Pod
+spec:
+  containers:
+  - name: gcc
+    image: gcc:9.3
+    command:
+    - "tail"
+    - "-f"
+    - "/dev/null"
+    imagePullPolicy: Always
+    resources:
+      requests:
+        memory: "512Mi"
+        cpu: "500m"
+      limits:
+      requests:
+        memory: "512Mi"
+        cpu: "500m"
+  - name: ruby25
+    image: gcr.io/al-development/ruby:2.5.8
+    imagePullPolicy: Always
+    resources:
+      requests:
+        memory: "2048Mi"
+        cpu: "2"
+      requests:
+        memory: "2048Mi"
+        cpu: "2"
+    command:
+    - "tail"
+    - "-f"
+    - "/dev/null"
+  - name: ruby26
+    image: gcr.io/al-development/ruby:2.6.6
+    imagePullPolicy: Always
+    resources:
+      requests:
+        memory: "2048Mi"
+        cpu: "2"
+      requests:
+        memory: "2048Mi"
+        cpu: "2"
+    command:
+    - "tail"
+    - "-f"
+    - "/dev/null"
+  - name: ruby27
+    image: gcr.io/al-development/ruby:2.7.1
+    imagePullPolicy: Always
+    resources:
+      requests:
+        memory: "2048Mi"
+        cpu: "2"
+      requests:
+        memory: "2048Mi"
+        cpu: "2"
+    command:
+    - "tail"
+    - "-f"
+    - "/dev/null"
+"""
+    }
+  }
+
+  options {
+    timestamps()
+    timeout(time: 15, unit: 'MINUTES')
+  }
+
+  stages {
+    stage('Unit Tests') {
+      parallel {
+        stage('PubsubClient gem ruby 2.5') {
+          steps {
+            container('ruby25') {
+              sh script: 'gem install bundler:2.1.4 && bundle install', label: 'install'
+              sh script: 'bundle exec rake', label: 'test'
+            } //container
+          } //steps
+        }//stage
+
+        stage('PubsubClient gem ruby 2.6') {
+          steps {
+            container('ruby26') {
+              sh script: 'gem install bundler:2.1.4 && bundle install', label: 'install'
+              sh script: 'bundle exec rake', label: 'test'
+            } //container
+          } //steps
+        }//stage
+
+        stage('PubsubClient gem ruby 2.7') {
+          steps {
+            container('ruby27') {
+              sh script: 'gem install bundler:2.1.4 && bundle install', label: 'install'
+              sh script: 'bundle exec rake', label: 'test'
+            } //container
+          } //steps
+        }//stage
+      } //parallel
+    } //stage
+  }
+}

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODEOWNERS

@@ -0,0 +1 @@
+* @apartmentlist/platforms

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ssanchez@apartmentlist.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pubsub_client.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Simon Sanchez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# PubsubClient
+
+This is a wrapper around the `google-cloud-pubsub` gem. There are times when it is useful to stub out these resources while in development or test environment. This will allow clients to do just that. Additionally, this gem also handles proper memoization of these resources even in forked and/or multi-threaded environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pubsub_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pubsub_client
+
+## 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.
+
+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.
+
+### Example
+```ruby
+PubsubClient.publish(message) do |result|
+  if result.succeeded?
+    puts 'yay!'
+  else
+    puts result.error
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pubsub_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pubsub_client/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PubsubClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pubsub_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pubsub_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pubsub_client.rb

@@ -0,0 +1,43 @@
+require 'pubsub_client/version'
+require 'pubsub_client/null_publisher_factory'
+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)
+    end
+  end
+end

data/lib/pubsub_client/null_publisher.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module 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
+    # as a real publisher.
+    NullResult = Struct.new(:error) do
+      def succeeded?
+        true
+      end
+    end
+
+    def publish(*, &block)
+      yield NullResult.new
+    end
+  end
+end

data/lib/pubsub_client/null_publisher_factory.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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
+      NullPublisher.new
+    end
+  end
+end

data/lib/pubsub_client/publisher.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'google/cloud/pubsub'
+
+module PubsubClient
+  class Publisher
+    def initialize(topic)
+      @topic = topic
+    end
+
+    def publish(message, &block)
+      topic.publish_async(message, &block)
+    end
+
+    def flush
+      return unless topic.async_publisher
+      topic.async_publisher.stop.wait!
+    end
+
+    private
+
+    attr_reader :topic
+  end
+end

data/lib/pubsub_client/publisher_factory.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+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
+      @mutex = Mutex.new
+    end
+
+    def build
+      # GRPC fails when attempting to use a connection created in a process that gets
+      # forked with the message
+      #
+      #  "grpc cannot be used before and after forking"
+      #
+      # Also creating a new publsher incurs significant overhead as it connects to
+      # PubSub.
+      #
+      # To prevent incurring overhead, memoize the publisher per process.
+      return @publisher if @publisher_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
+        # 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
+        end
+      end
+
+      @publisher
+    end
+
+    private
+
+    attr_reader :mutex, :topic_name
+
+    # Used for testing to simulate when a process is forked. In those cases,
+    # this helps us test that the `.build` method creates different publishers.
+    def current_pid
+      Process.pid
+    end
+
+    def build_publisher
+      pubsub = Google::Cloud::PubSub.new
+      topic = pubsub.topic(topic_name)
+      publisher = Publisher.new(topic)
+
+      at_exit { publisher.flush }
+
+      publisher
+    end
+  end
+end

data/lib/pubsub_client/version.rb

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

data/pubsub_client.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/pubsub_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pubsub_client'
+  spec.version       = PubsubClient::VERSION
+  spec.authors       = ['Apartment List Platforms']
+  spec.email         = ['platforms@apartmentlist.com']
+
+  spec.summary       = %q{Google Pub/Sub Wrapper}
+  spec.homepage      = 'https://github.com/apartmentlist/pubsub_client'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/apartmentlist/pubsub_client/blob/main/CHANGELOG.txt'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+
+  spec.add_runtime_dependency 'google-cloud-pubsub', '~> 2.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: pubsub_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Apartment List Platforms
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: google-cloud-pubsub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- platforms@apartmentlist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ci"
+- ".gitignore"
+- ".rspec"
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pubsub_client.rb
+- lib/pubsub_client/null_publisher.rb
+- lib/pubsub_client/null_publisher_factory.rb
+- lib/pubsub_client/publisher.rb
+- lib/pubsub_client/publisher_factory.rb
+- lib/pubsub_client/version.rb
+- pubsub_client.gemspec
+homepage: https://github.com/apartmentlist/pubsub_client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/apartmentlist/pubsub_client
+  source_code_uri: https://github.com/apartmentlist/pubsub_client
+  changelog_uri: https://github.com/apartmentlist/pubsub_client/blob/main/CHANGELOG.txt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Google Pub/Sub Wrapper
+test_files: []