outboxer 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 020ece7302e6b90b26324561e37c0527e4158df1c5587d651fbe61a83703cbfe
-  data.tar.gz: 745ae13e8adffe84a0b9656caba022ebece21d3ca03b28cc809044ff56bbf461
+  metadata.gz: f881a119f2c2123b34c0a7153590c2eab9907b44045e64d51e16ce914e731bb6
+  data.tar.gz: d30a09f38f02fea3bce19895922d294e40dfb25555e1fcf4fd06b33560d1e2db
 SHA512:
-  metadata.gz: cd880961d6f47f62b0a728684a11af3ffd47390f0620ea0fc8869903fdc35de6fd470c6538a2b52c009902134c3065e27fa262fc8df495ef3db0b0ea93e5829b
-  data.tar.gz: 59836e830ccc65e075dad400d56be7c6db9b36584522091f68c9a0983a07ff5bdc392679b231f1442f40e830919bd552d9d2d4f843db10d852405b536c330673
+  metadata.gz: df0a95d0f24b7ff85038711be1acd4aec4dc5760accb390fb40fdf07342d911b5b07373c4eacbc2e05e25a7a89137ef26c20e201b556c6e07973469806eddaff
+  data.tar.gz: 1d329faae4668703b51cd5becdce8215e4251e1217d9c8311795ab602d71e140511b79874908963a947c24939025bd2dbcd8af0497aa985d9478f7919d7602d7

data/README.md

@@ -1,5 +1,8 @@
 # Outboxer
 
+[![Gem Version](https://badge.fury.io/rb/outboxer.svg)](https://badge.fury.io/rb/outboxer)
+![Ruby](https://github.com/fast-programmer/outboxer/actions/workflows/master.yml/badge.svg)
+
 ## Background
 
 Typically in event driven Ruby on Rails applications:
@@ -50,12 +53,11 @@ end
 #### 2. Update the generated bin/publish block e.g.
 
 ```ruby
-Outboxer::Publisher.publish do |args|
-  logger = args.logger
-  message = args.message
-
+Outboxer::Publisher.publish do |message:, logger:|
   logger.info("[#{message.id}] publishing")
+
   HardJob.perform_async({ "message_id" => message.id })
+
   logger.info("[#{message.id}] published")
 end
 ```
@@ -85,11 +87,13 @@ To see all the parts working together in a single place, check out the [publishe
 
 ## Motivation
 
-Outboxer was created with 4 key benefits in mind:
+Outboxer was created to help high growth SAAS companies transition to event driven architecture quickly.
+
+Specifically this means:
 
-1. speed of integration into existing Ruby on Rails applications (< 1 hour)
-2. comprehensive documentation that is easy to understand
-3. high reliability in production environments (100% code coverage)
+1. fast integration into existing Ruby on Rails applications (< 1 hour)
+2. comprehensive documentation
+3. high reliability in production environments
 4. forever free to use in commerical applications (MIT licence)
 
 ## Contributing

data/Rakefile

@@ -1,5 +1,3 @@
-# require "bundler/gem_tasks"
-# require "bundler/setup"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)

data/lib/outboxer/publisher.rb

@@ -7,19 +7,36 @@ module Outboxer
     @publishing = false
     @logger = Logger.new($stdout)
 
-    Args = Struct.new(:message, :logger)
-
-    # This method initiates the publishing process. It dequeues the messages one by one
-    # and yields to a block that should contain the publishing logic.
+    # Publishes messages from the Outboxer queue.
+    #
+    # This method will continue to publish messages from the queue as long
+    # as @publishing is set to true. It uses an ActiveRecord connection to
+    # handle database interactions.
+    #
+    # @param poll [Integer] the interval (in seconds) at which the method
+    #   should poll the database for new messages.
+    # @param backoff [Proc] a callable object that defines how to increase the
+    #   backoff time when an error occurs. It should accept the current backoff
+    #   time as a parameter and return the new backoff time.
+    #
+    # @yield [Hash] once a message is dequeued, the method yields a hash to
+    #   the given block. The hash contains the :message (the dequeued message)
+    #   and :logger (the logger object).
+    #
+    # @yieldparam message [Message] the dequeued message from the Outboxer queue.
+    # @yieldparam logger [Logger] the logger instance to log any information or errors.
     #
-    # @param [Integer] poll
-    #   Sleep time in seconds between polling the queue when it's empty.
+    # @raise [StandardError] if an error occurs during the yield, it is rescued,
+    #   logged, and then the failed method is invoked to handle the error. The
+    #   method then moves on to the next message in the queue.
     #
-    # @param [Proc] backoff
-    #   A Proc that takes the current backoff time and returns the new backoff time.
+    # @return [void] This method does not have a meaningful return value.
     #
-    # @yieldparam [Args] args
-    #   An Args object containing the message to publish and a logger.
+    # @example Basic usage
+    #   Outboxer::Publisher.publish(poll: 1) do |hash|
+    #     puts hash[:message]
+    #     puts hash[:logger]
+    #   end
     def publish(poll: 1, backoff: ->(current_backoff) { [current_backoff * 2, 5 * 60].min })
       @publishing = true
 
@@ -34,7 +51,7 @@ module Outboxer
           end
 
           begin
-            yield Args.new(outboxer_message.message, @logger)
+            yield message: outboxer_message.message, logger: @logger
           rescue StandardError => exception
             failed(
               outboxer_message: outboxer_message,

data/lib/outboxer/version.rb

@@ -1,3 +1,3 @@
 module Outboxer
-  VERSION = "0.1.10".freeze
+  VERSION = "0.1.11".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outboxer
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Adam Mikulasev