artsy-event_publisher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0ab4a82306ab2003e5ddcba9a9ee1007e169e3062fd9dc5e430902609005ea3
+  data.tar.gz: c7d0a36f257d85966a9ba93820846b5d1b75e9def88d0da63ac01fdeffc1908b
+SHA512:
+  metadata.gz: 6d08aad5664fd481332252f2cd2c5829c9ce2213493600cbe4b4d061994cedc01c4f89bc9d5d0274dc01e2cd5d7a24eca171dc1e2338181f175d3dbafb683b2f
+  data.tar.gz: ece529b1f0f3e650761e204c5fdb31e481161e53ef26f7f7836ad35218f42c0f96adf8a82b8589261b9bf5b6c366f9856e9c317cc5fd4ce78c952d63d834102e

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Joey Aghion
+
+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,51 @@
+# Artsy::EventPublisher
+
+Lightweight helper for publishing events to rabbitmq in a pattern consistent with Artsy's ecosystem.
+
+## Installation
+
+Add following line to your Gemfile
+
+```ruby
+gem "artsy-event_publisher"
+```
+
+## Usage
+
+Example initialization:
+
+```ruby
+# config/initializers/artsy_event-publisher.rb
+Artsy::EventPublisher.configure do |config|
+  config.app_id = "my-app" # identifies RabbitMQ connection
+  config.enabled = true # enable/disable publishing events
+  config.rabbitmq_url = "amqp(s)://<user>:<pass>@<host>:<port>/<vhost>" # required
+  config.logger = Rails.logger
+end
+```
+
+Publishing a sample event:
+
+```ruby
+Artsy::EventPublisher.publish(
+  "auctions",
+  "bidder.pending_approval",
+  verb: "pending_approval",
+  subject: {id: bidder.id.to_s, root_type: "Bidder", display: bidder.name},
+  object: {id: sale.id.to_s, root_type: "Sale", display: sale.name}
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem on 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 the created tag, 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/artsy/artsy-event_publisher.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/artsy/event_publisher/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Artsy
+  module EventPublisher
+    VERSION = "0.1.0"
+  end
+end

data/lib/artsy/event_publisher.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "event_publisher/version"
+require "json"
+require "bunny"
+
+module Artsy
+  module EventPublisher
+    class Error < StandardError; end
+
+    def self.publish(topic, routing_key = "", subject: nil, verb: nil, object: nil, properties: nil)
+      return unless Config.enabled
+
+      data = {
+        subject: subject,
+        verb: verb,
+        object: object,
+        properties: properties
+      }.compact
+      payload = data.to_json
+      Connection.publish(topic: topic, routing_key: routing_key, payload: payload)
+      Config.logger&.debug("[event] #{payload}")
+      data
+    end
+
+    def self.configure
+      yield Config if block_given?
+      Config
+    end
+
+    module Config
+      extend self
+
+      attr_accessor :app_id
+      attr_accessor :enabled
+      attr_accessor :rabbitmq_url
+      attr_accessor :logger
+    end
+
+    class Connection
+      OPTIONS = {
+        persistent: true,
+        content_type: "application/json",
+        headers: {}
+      }
+      @connection = nil
+      @mutex = Mutex.new
+
+      def self.publish(topic:, routing_key:, payload:)
+        with_channel do |channel|
+          options = OPTIONS.merge(routing_key: routing_key, app_id: Config.app_id)
+          channel.topic(topic, durable: true).publish(payload, options)
+          raise Error, "Publishing failed" unless channel.wait_for_confirms
+        end
+      end
+
+      def self.with_channel
+        channel = get_connection.create_channel
+        channel.confirm_select
+        yield channel if block_given?
+      ensure
+        channel.close if channel&.open?
+      end
+
+      # Synchronized access to the connection
+      def self.get_connection
+        @mutex.synchronize do
+          @connection ||= build_connection
+          @connection = build_connection if @connection.closed?
+          @connection
+        end
+      end
+
+      def self.build_connection
+        Bunny.new(Config.rabbitmq_url).tap(&:start)
+      end
+    end
+  end
+end

data/sig/artsy/event_publisher.rbs

@@ -0,0 +1,6 @@
+module Artsy
+  module EventPublisher
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: artsy-event_publisher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joey Aghion
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- joey@aghion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- ".tool-versions"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/artsy/event_publisher.rb
+- lib/artsy/event_publisher/version.rb
+- sig/artsy/event_publisher.rbs
+homepage: https://github.com/artsy/artsy-event_publisher
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/artsy/artsy-event_publisher
+  source_code_uri: https://github.com/artsy/artsy-event_publisher
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Simple library for consistent publishing of RabbitMQ events at Artsy.
+test_files: []