sanger_warren 0.3.0.pre.rc1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 142ece2de33d995ad8eb33759edcefe6b265bd42ac71d0a13617a926a7cf0842
-  data.tar.gz: bdee8b37ee9b8b5dd8e3659f23ad129b1fb020d23c767458502eea5940672ac9
+  metadata.gz: 07d40b65d949f1c9fe0a1622faab1cfc6e64483ef498400daae60d7dd17d4897
+  data.tar.gz: badadcd8587f75dd72cc240df07947a39a222741043525ed204efb7738b13511
 SHA512:
-  metadata.gz: fb6414532226afc214ba4d79e757315fe177d50e6ac94516d5e891fc86321fdafd301c08134846e83edf7ebaf5885eab6b0d43f2fd149b1cc7ca18e72f3e8c61
-  data.tar.gz: 318bd13ea663117d972f6351fcbcb2cd2758e0059d3e19828a2bf70a90575bcf38fd393038878d5fd253a6224ee3d8f14597843a252d14087097081ad13aeba2
+  metadata.gz: 333c5cb6382e1ac5cdf475a66e541afcaa0ca5698105cf8e62d435c8bbf2171e59f165875597d507c75b2b8a4eff8504a96f7d6295cf24f05a5393ac55c01716
+  data.tar.gz: de3d17ae3bdeaf272ca52a3f5170187efb570709ca77f77a657221400d1fcf50706d8d48c6aa48118bfb3f67276925412baaf4fe7fb250ef64abe1da02134267

data/.yardopts

@@ -0,0 +1,3 @@
+-
+LICENSE.txt
+CHANGELOG.md

data/CHANGELOG.md

@@ -5,6 +5,8 @@ Unreleased section to make new releases easy.
 
 ## [Unreleased]
 
+## [0.3.0] - 2021-06-04
+
 ### Added
 
 - Added support for delay exchanges to process messages after a fixed delay
@@ -19,8 +21,9 @@ Unreleased section to make new releases easy.
 
 ## Changed
 
-- Messages must now implement {#headers}, although simply returning an empty
+- Messages must now implement `#headers`, although simply returning an empty
   hash is sufficient.
+  See {Warren::Message::Simple#headers} for example
 - Subscriber templates now use the path 'app/warren/subscriber' rather than
   'app/warren/subscribers' to correctly match class namespacing.
 - 3 consumer worker threads will be spun up by default

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sanger_warren (0.3.0.pre.rc1)
+    sanger_warren (0.3.0)
       bunny (~> 2.17.0)
       connection_pool (~> 2.2.0)
       multi_json (~> 1.0)

data/README.md

@@ -104,6 +104,28 @@ These options can be over-ridden in the warren_consumers.yml file if necessary.
 If you wish to completely disable dead-letter queue configuration, such as when
 using policies, then you can set dead_letters to false.
 
+#### Delayed messaged
+
+Warren uses a delay exchange / queue approach for delaying the redelivery of messages.
+We don't currently support the
+[delayed message exchange plugin](https://github.com/rabbitmq/rabbitmq-delayed-message-exchange)
+
+The way this works:
+
+- Consumers with a delay option will automatically register an exchange and a queue
+- By default both of these will be named '<consumer_name>.delay' although you can
+  override this by updating `warren_consumers.yml`
+- The '<consumer_name>.delay' queue will have a time-to-live (ttl) set, after
+  which any messages on the queue will be dead-lettered
+- The dead-letter exchange for this queue is configured to an empty string `''`
+  which corresponds to the 'default exchange', and the routing key is set to
+  match the original queue name.
+- This exchange is a little bit special, and automatically routes messages to
+  any queue on the host where the queue name matches the message routing key.
+
+This approach avoids repeat delivery of the message to any other queues bound
+to the original exchange, and avoids the need for further exchanges or bindings.
+
 ### Running consumers
 
 To run all configure consumers use:

data/lib/warren/delay_exchange.rb

@@ -13,7 +13,7 @@ module Warren
     attr_reader :channel
 
     #
-    # Great a new delay exchange. Handles queue creation, binding and attaching
+    # Create a new delay exchange. Handles queue creation, binding and attaching
     # consumers to the queues
     #
     # @param channel [Warren::Handler::Broadcast::Channel] A channel on which to register queues

data/lib/warren/den.rb

@@ -7,8 +7,9 @@ require 'warren/delay_exchange'
 
 module Warren
   # A Den is in charge of creating a Fox from a consumer configuration
-  # Currently its pretty simple, but in future will also handle registration of
-  # delay and dead-letter queues/exchanges.
+  # It handles the registration of dead-letter queues, and configuration of
+  # {Warren::Subscription subscriptions} and
+  # {Warren::DelayExchange delay exchanges}
   class Den
     # The number of simultaneous workers generated by default
     DEFAULT_WORKER_COUNT = 3

data/lib/warren/framework_adaptor/rails_adaptor.rb

@@ -2,30 +2,31 @@
 
 module Warren
   # Namespace for framework adaptors.
+  #
   # A FrameworkAdaptor should implement the following instance methods:
   #
-  ## recovered? => Bool
+  # == recovered? => Bool
   # Indicates that any temporary issues (such as database connectivity problems)
   # are resolved and consumers may restart.
   #
-  ## handle
+  # == handle
   #
   # Wraps the processing of each message, is expected to `yield` to allow
   # processing. May be responsible for handling connection pools, and
   # framework-specific exceptions. Raising {Warren::Exceptions::TemporaryIssue}
   # here will cause consumers to sleep until `recovered?` returns true.
   #
-  ## env => String
+  # == env => String
   #
   # Returns the current environment of the application.
   #
-  ## logger => Logger
+  # == logger => Logger
   #
   # Returns your application logger. Is expected to be compatible with the
   # standard library Logger class.
   # @see https://ruby-doc.org/stdlib-2.7.0/libdoc/logger/rdoc/Logger.html
   #
-  ## load_application
+  # == load_application
   #
   # Called upon running `warren consumer start`. Should ensure your application
   # is correctly loaded sufficiently for processing messages

data/lib/warren/message/simple.rb

@@ -4,6 +4,12 @@ module Warren
   # Namespace for Warren message wrappers.
   module Message
     # A simple message simply wraps the routing key and payload together
+    # @!attribute [rw] routing_key
+    #   @return [String] The routing key of the message
+    # @!attribute [rw] payload
+    #   @return [String] The payload of the message
+    # @!attribute [rw] headers
+    #   @return [Hash] Hash of header attributes. Can be empty hash.
     Simple = Struct.new(:routing_key, :payload, :headers)
   end
 end

data/lib/warren/version.rb

@@ -2,5 +2,5 @@
 
 module Warren
   # Gem version number. Bump prior to release of new version
-  VERSION = '0.3.0-rc1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanger_warren
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.rc1
+  version: 0.3.0
 platform: ruby
 authors:
 - James Glover
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -80,6 +80,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -150,9 +151,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: