twingly-amqp 5.0.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c61cf032af90e6b91d1c690ad02f89c6a46e3cc7879813e47f1ee89a1367609a
-  data.tar.gz: 6508f9911ef9dcb8c64854522915129878905e62620dbf022ec104e8a911354a
+  metadata.gz: 2cfce02de5ea28c844564b13473a31afd438dbc2001392092902666da3a8721a
+  data.tar.gz: 05db74046a863f23a0e541cc60402e0f3ae91e5ca6e01131e8aa16c0cc15fc29
 SHA512:
-  metadata.gz: 0f66b4eda7c713585780fa20f1bae2948b3251f00929f16fd01273f3298a32fb921eaa334e5814f464eac85446bdc17be227e9f850293a0bb753131f061a6f37
-  data.tar.gz: 87c30a0c5e817ea29be19da7b99e3d156f4ba6ca303abd63ebb265827673c90ac3b64ca22bd9d3e5df355163fb29b888931e41d6637282460d598c2bff4114b4
+  metadata.gz: 556a43b0b4229225828678fe9f23f3912e39e7a8ec72f6fd2a549cfbd6db7dfa6043aa1f3e0f23998a5fea38f329fb110a3904db84ddd16a8657aad21a3a2d1a
+  data.tar.gz: fb0b7fa69facd940accfabbab125ae116d20101f9e33e87b010087d800687c21953a52983035c66bcc95e58fae2ba0ba78b529ba7d398680b56e405129d82b19

data/README.md

@@ -1,7 +1,6 @@
 # Twingly::AMQP
 
-[![Build Status](https://travis-ci.org/twingly/twingly-amqp.svg?branch=master)](https://travis-ci.org/twingly/twingly-amqp)
-
+[![GitHub Build Status](https://github.com/twingly/twingly-amqp/workflows/CI/badge.svg?branch=master)](https://github.com/twingly/twingly-amqp/actions)
 
 A gem for subscribing and publishing messages via RabbitMQ.
 
@@ -60,6 +59,8 @@ subscription = Twingly::AMQP::Subscription.new(
   consumer_threads: 4,                     # Optional
   prefetch:         20,                    # Optional
   max_length:       10_000,                # Optional
+  queue_type:       :quorum,               # Optional, which type of queue to create,
+                                           # possible values are :quorum (default) or :classic
 )
 
 subscription.on_exception { |exception| puts "Oh noes! #{exception.message}" }
@@ -133,6 +134,24 @@ end
 publisher.publish({ my: "data" })
 ```
 
+### Publish delayed messages
+
+```ruby
+publisher = Twingly::AMQP::DefaultExchangePublisher.delayed(
+  delay_queue_name:  "my_queue.delayed", # Queue where delayed messages will
+                                         #   wait until delay_ms has passed
+  target_queue_name: "my_queue",         # Queue which delayed messages will be
+                                         #   published to after the delay has elapsed
+  delay_ms:          60_000,
+  delay_queue_type:  :quorum,            # Optional. Which type of queue to define the delay queue
+                                         # as. Possible values are :quorum (default) or :classic
+)
+
+# Publishes message to the delay queue. After delay_ms has passed,
+#   the message will be rerouted to the target queue specified above
+publisher.publish({ my: "data" })
+```
+
 ### Ping urls
 
 ```ruby
@@ -199,6 +218,12 @@ connection = Twingly::AMQP::Connection.instance
 
 The integration tests run by default and require a local RabbitMQ server to run.
 
+Start RabbitMQ server with
+
+```shell
+docker-compose up
+```
+
 Run tests with
 
 ```shell
@@ -230,7 +255,7 @@ To run static code analysis:
 
         bundle exec rake release
 
-    * If you are not logged in as [twingly][twingly-rubygems] with ruby gems, the rake task will fail and tell you to set credentials via `gem push`, do that and run the `release` task again. It will be okay.
+    * If you are not logged in as [twingly][twingly-rubygems] with ruby gems, the rake task will fail. Login using `gem signin` and run the `release` task again. It will be okay.
 
 * Update the changelog with [GitHub Changelog Generator](https://github.com/skywinder/github-changelog-generator/) (`gem install github_changelog_generator` if you don't have it, set `CHANGELOG_GITHUB_TOKEN` to a personal access token to avoid rate limiting by GitHub). This command will update `CHANGELOG.md`, commit and push manually.
 

data/lib/twingly/amqp/connection.rb

@@ -1,5 +1,3 @@
-require "twingly/amqp"
-
 module Twingly
   module AMQP
     class Connection

data/lib/twingly/amqp/default_exchange_publisher.rb

@@ -1,17 +1,31 @@
-require "twingly/amqp/publisher"
-require "twingly/amqp/connection"
-
 module Twingly
   module AMQP
     class DefaultExchangePublisher
       include Publisher
 
-      def initialize(queue_name:, connection: nil)
+      DEFAULT_EXCHANGE = ""
+
+      def initialize(queue_name:, connection: Connection.instance)
         options.routing_key = queue_name
 
-        connection ||= Connection.instance
         @exchange = connection.create_channel.default_exchange
       end
+
+      def self.delayed(delay_queue_name:, target_queue_name:, delay_ms:, delay_queue_type: :quorum,
+                       connection: Connection.instance)
+        Utilities.create_queue(delay_queue_name,
+                               arguments: {
+                                 "x-dead-letter-exchange":    DEFAULT_EXCHANGE,
+                                 "x-dead-letter-routing-key": target_queue_name,
+                               },
+                               queue_type: delay_queue_type)
+
+        new(queue_name: delay_queue_name, connection: connection).tap do |publisher|
+          publisher.configure_publish_options do |options|
+            options.expiration = delay_ms
+          end
+        end
+      end
     end
   end
 end

data/lib/twingly/amqp/message.rb

@@ -1,5 +1,3 @@
-require "json"
-
 module Twingly
   module AMQP
     class Message

data/lib/twingly/amqp/pinger.rb

@@ -1,14 +1,8 @@
-require "twingly/amqp/connection"
-require "twingly/amqp/ping_options"
-require "twingly/amqp/default_exchange_publisher"
-require "json"
-
 module Twingly
   module AMQP
     class Pinger
-      def initialize(queue_name:, ping_expiration: nil, url_cache: NullCache, connection: nil, confirm_publish: false)
+      def initialize(queue_name:, ping_expiration: nil, url_cache: NullCache, connection: Connection.instance, confirm_publish: false)
         @url_cache = url_cache
-        connection ||= Connection.instance
 
         @publisher = DefaultExchangePublisher.new(queue_name: queue_name, connection: connection)
         @publisher.configure_publish_options do |options|

data/lib/twingly/amqp/publisher.rb

@@ -1,6 +1,3 @@
-require "json"
-require "ostruct"
-
 module Twingly
   module AMQP
     module Publisher
@@ -19,7 +16,7 @@ module Twingly
         @exchange.publish(json_payload, opts)
       end
 
-      # only used by tests to avoid sleeping
+      # Only used by tests to lessen the time we need to sleep
       def publish_with_confirm(message)
         channel = @exchange.channel
         channel.confirm_select unless channel.using_publisher_confirmations?

data/lib/twingly/amqp/session.rb

@@ -1,5 +1,3 @@
-require "bunny"
-
 module Twingly
   module AMQP
     class Session

data/lib/twingly/amqp/subscription.rb

@@ -1,27 +1,28 @@
-require "twingly/amqp/connection"
-require "twingly/amqp/message"
-
 module Twingly
   module AMQP
     class Subscription
       def initialize(queue_name:, exchange_topic: nil, routing_key: nil,
                      routing_keys: nil, consumer_threads: 1, prefetch: 20,
-                     connection: nil, max_length: nil)
+                     connection: Connection.instance, max_length: nil,
+                     queue_type: :quorum)
         @queue_name       = queue_name
         @exchange_topic   = exchange_topic
         @routing_keys     = Array(routing_keys || routing_key)
         @consumer_threads = consumer_threads
         @prefetch         = prefetch
         @max_length       = max_length
+        @queue_type       = queue_type
+        @cancel           = false
+        @consumer         = nil
+        @blocking         = false
 
         if routing_key
           warn "[DEPRECATION] `routing_key` is deprecated. "\
                "Please use `routing_keys` instead."
         end
 
-        connection ||= Connection.instance
         @channel = create_channel(connection)
-        @queue   = @channel.queue(@queue_name, queue_options)
+        @queue   = create_queue
 
         if @exchange_topic && @routing_keys.any?
           exchange = @channel.topic(@exchange_topic, durable: true)
@@ -36,12 +37,13 @@ module Twingly
       end
 
       def each_message(blocking: true, &block)
-        consumer = create_consumer(&block)
+        @blocking = blocking
+        @consumer = create_consumer(&block)
 
-        if blocking
+        if @blocking
           sleep 0.01 until cancel?
 
-          consumer.cancel
+          @consumer.cancel
         end
       end
 
@@ -66,6 +68,7 @@ module Twingly
       end
 
       def cancel!
+        @consumer.cancel unless @blocking
         @cancel = true
       end
 
@@ -96,6 +99,17 @@ module Twingly
         channel
       end
 
+      def create_queue
+        case @queue_type
+        when :quorum
+          @channel.quorum_queue(@queue_name, queue_options)
+        when :classic
+          @channel.queue(@queue_name, queue_options)
+        else
+          raise ArgumentError, "Unknown queue type #{@queue_type}"
+        end
+      end
+
       def queue_options
         {
           durable: true,

data/lib/twingly/amqp/topic_exchange_publisher.rb

@@ -1,15 +1,11 @@
-require "twingly/amqp/publisher"
-require "twingly/amqp/connection"
-
 module Twingly
   module AMQP
     class TopicExchangePublisher
       include Publisher
 
-      def initialize(exchange_name:, routing_key: nil, connection: nil, opts: {})
+      def initialize(exchange_name:, routing_key: nil, connection: Connection.instance, opts: {})
         options.routing_key = routing_key
 
-        connection ||= Connection.instance
         @exchange = connection.create_channel.topic(exchange_name, opts)
       end
     end

data/lib/twingly/amqp/utilities.rb

@@ -0,0 +1,21 @@
+module Twingly
+  module AMQP
+    module Utilities
+      def self.create_queue(queue_name, durable: true, arguments: {}, queue_type: :quorum, connection: Connection.instance)
+        connection.with_channel do |channel|
+          case queue_type
+          when :quorum
+            # Quorum queues are always durable, see https://www.rabbitmq.com/quorum-queues.html#feature-matrix
+            raise ArgumentError, "durable: false is not supported by quorum queues" unless durable
+
+            return channel.quorum_queue(queue_name, arguments: arguments)
+          when :classic
+            return channel.queue(queue_name, durable: durable, arguments: arguments)
+          else
+            raise ArgumentError, "Unknown queue type '#{queue_type}'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twingly/amqp/version.rb

@@ -1,5 +1,5 @@
 module Twingly
   module Amqp
-    VERSION = "5.0.1".freeze
+    VERSION = "6.0.0".freeze
   end
 end

data/lib/twingly/amqp.rb

@@ -1,6 +1,7 @@
 require "twingly/amqp/version"
 require "twingly/amqp/session"
 require "twingly/amqp/connection"
+require "twingly/amqp/utilities"
 require "twingly/amqp/subscription"
 require "twingly/amqp/ping_options"
 require "twingly/amqp/pinger"
@@ -8,7 +9,10 @@ require "twingly/amqp/publisher"
 require "twingly/amqp/default_exchange_publisher"
 require "twingly/amqp/topic_exchange_publisher"
 require "twingly/amqp/null_logger"
+require "twingly/amqp/message"
 
+require "bunny"
+require "json"
 require "ostruct"
 
 module Twingly

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: twingly-amqp
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 6.0.0
 platform: ruby
 authors:
 - Twingly AB
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.2
+        version: 2.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.2
+        version: 2.20.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +71,7 @@ files:
 - lib/twingly/amqp/session.rb
 - lib/twingly/amqp/subscription.rb
 - lib/twingly/amqp/topic_exchange_publisher.rb
+- lib/twingly/amqp/utilities.rb
 - lib/twingly/amqp/version.rb
 homepage: https://github.com/twingly/twingly-amqp
 licenses: []
@@ -96,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.4
 signing_key:
 specification_version: 4
 summary: Ruby library for talking to RabbitMQ