twingly-amqp 4.3.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4db0f7716677c33ee82f1fc7b0530aa99a9c704b
-  data.tar.gz: a392bce55f82c6f07c39a6df3788bc8c918af654
+SHA256:
+  metadata.gz: 9addd8c457e9a56236f8e77d5c8a695859b39c8e2f77660e5cea41d66b515095
+  data.tar.gz: e9c37097b065eeb9a60f25f659597975452a7b26c643d8fd81bd165bf2b6fa0a
 SHA512:
-  metadata.gz: e8831829877ca9fa5ac54f2ab7cba84f91b33b3e7fe280c0c47b214dcf7365b15b80e37fc330fe5c3433de5e4ab5cf6808802ea272b79d71e54d9997fe139d21
-  data.tar.gz: 83cb819bd56f5a9737129f00bb406d977aa3386a10c0a620188b9f7521dcf7463e535db38b95aa0e06cd227d91264164ce55d9711484d219afcfce13a4804d9d
+  metadata.gz: eebc4870eeca8f9c58298b5f839569338da8e1e862b785512babd5f7fa28492a40a069762c136d65d4c31142d1360b27cf23e5b1044dc3b4f9feac8b1ace623e
+  data.tar.gz: bfbd5d0598e5ba0abbf2d292ef4bee8847ee67dfd1e2d67f9a5c4b8a64a2e2131aa73c91267b9088ee5fa36162f3e7138be0b22c8c081205f290ca8de68cb035

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.
 
@@ -55,11 +54,11 @@ end
 ```ruby
 subscription = Twingly::AMQP::Subscription.new(
   queue_name:       "crawler-urls",
-  exchange_topic:   "url-exchange", # Optional, uses the default exchange if omitted
-  routing_key:      "url.blog",     # Optional, uses the default exchange if omitted
-  consumer_threads: 4,              # Optional
-  prefetch:         20,             # Optional
-  max_length:       10_000,         # Optional
+  exchange_topic:   "url-exchange",        # Optional, uses the default exchange if omitted
+  routing_keys:     %w(url.blog url.post), # Optional, uses the default exchange if omitted
+  consumer_threads: 4,                     # Optional
+  prefetch:         20,                    # Optional
+  max_length:       10_000,                # Optional
 )
 
 subscription.on_exception { |exception| puts "Oh noes! #{exception.message}" }
@@ -133,6 +132,22 @@ 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,
+)
+
+# 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
@@ -145,9 +160,11 @@ pinger = Twingly::AMQP::Pinger.new(
 
 # Optional, options can also be given to #ping
 pinger.default_ping_options do |options|
-  options.provider_name = "TestProvider"
-  options.source_ip     = "?.?.?.?"
-  options.priority      = 1
+  options.provider_name  = "TestProvider"
+  options.source_ip      = "?.?.?.?"
+  options.priority       = 1
+  # Optional keys/values that will be included in each ping message
+  options.custom_options = { my_option: "This is my own option" }
 end
 
 urls = [
@@ -155,10 +172,12 @@ urls = [
 ]
 
 # Optional, is merged with the default options above
+#   options given to #ping takes precedence over the default options
 options = {
   provider_name: "a-provider-name",
   source_ip:     "?.?.?.?",
   priority:      1,
+  custom_options: { my_other_option: "Another option" },
 }
 
 pinger.ping(urls, options) do |pinged_url|
@@ -195,6 +214,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
@@ -211,10 +236,12 @@ bundle exec rake spec:unit
 
 To run static code analysis:
 
-  bundle exec rubocop
+    gem install rubocop
+
+    rubocop
 
-  # optionally on single file(s)
-  bundle exec rubocop lib/twingly/amqp/*
+    # optionally on single file(s)
+    rubocop lib/twingly/amqp/*
 
 ## Release workflow
 
@@ -224,7 +251,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.rb

@@ -1,13 +1,18 @@
 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"
+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

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,47 +1,28 @@
-require "twingly/amqp/connection"
-require "json"
-require "ostruct"
-
 module Twingly
   module AMQP
     class DefaultExchangePublisher
-      def initialize(queue_name:, connection: nil)
-        options.routing_key = queue_name
+      include Publisher
 
-        connection ||= Connection.instance
-        @exchange = connection.create_channel.default_exchange
-      end
-
-      def publish(message)
-        raise ArgumentError unless message.respond_to?(:to_h)
-
-        payload = message.to_h.to_json
-        opts    = options.to_h
-        @exchange.publish(payload, opts)
-      end
+      DEFAULT_EXCHANGE = ""
 
-      # only used by tests to avoid sleeping
-      def publish_with_confirm(message)
-        channel = @exchange.channel
-        channel.confirm_select unless channel.using_publisher_confirmations?
-
-        publish(message)
-
-        @exchange.wait_for_confirms
-      end
+      def initialize(queue_name:, connection: Connection.instance)
+        options.routing_key = queue_name
 
-      def configure_publish_options
-        yield options
+        @exchange = connection.create_channel.default_exchange
       end
 
-      private
-
-      def options
-        @options ||=
-          OpenStruct.new(
-            content_type: "application/json",
-            persistent: true,
-          )
+      def self.delayed(delay_queue_name:, target_queue_name:, delay_ms:, connection: Connection.instance)
+        Utilities.create_queue(delay_queue_name,
+                               arguments: {
+                                 "x-dead-letter-exchange":    DEFAULT_EXCHANGE,
+                                 "x-dead-letter-routing-key": target_queue_name,
+                               })
+
+        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

data/lib/twingly/amqp/message.rb

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

data/lib/twingly/amqp/ping_options.rb

@@ -3,25 +3,40 @@ module Twingly
     class PingOptions
       attr_accessor :provider_name, :source_ip, :priority
 
-      def initialize(provider_name: nil, source_ip: nil, priority: nil)
-        self.provider_name = provider_name
-        self.source_ip     = source_ip
-        self.priority      = priority
+      attr_reader :custom_options
+
+      def initialize(provider_name: nil, source_ip: nil, priority: nil,
+                     custom_options: {})
+        self.provider_name  = provider_name
+        self.source_ip      = source_ip
+        self.priority       = priority
+        self.custom_options = custom_options
 
         yield self if block_given?
       end
 
+      def custom_options=(options)
+        unless options.respond_to?(:to_h)
+          raise ArgumentError, "custom_options must respond to 'to_h'"
+        end
+
+        @custom_options = options.to_h
+      end
+
       def to_h
         {
-          automatic_ping: false,
           provider_name:  provider_name,
           source_ip:      source_ip,
           priority:       priority,
+          custom_options: custom_options,
         }
       end
 
       def validate
-        missing_keys = to_h.select { |_, value| value.to_s.empty? }.keys
+        missing_keys = to_h.select do |key, value|
+          key != :custom_options && value.to_s.empty?
+        end.keys
+
         if missing_keys.any?
           raise ArgumentError, "Required options not set: #{missing_keys}"
         end
@@ -29,9 +44,10 @@ module Twingly
 
       def merge(other)
         PingOptions.new do |options|
-          options.provider_name = other.provider_name || provider_name
-          options.source_ip     = other.source_ip     || source_ip
-          options.priority      = other.priority      || priority
+          options.provider_name  = other.provider_name || provider_name
+          options.source_ip      = other.source_ip     || source_ip
+          options.priority       = other.priority      || priority
+          options.custom_options = custom_options.merge(other.custom_options)
         end
       end
     end

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|
@@ -20,18 +14,17 @@ module Twingly
       end
 
       def ping(urls, options_hash = {})
-        options = PingOptions.new(options_hash)
+        options = PingOptions.new(**options_hash)
         options = @default_ping_options.merge(options)
 
         options.validate
 
         Array(urls).each do |url|
-          unless cached?(url)
-            publish(url, options)
-            cache!(url)
+          next if cached?(url)
+          publish(url, options)
+          cache!(url)
 
-            yield url if block_given?
-          end
+          yield url if block_given?
         end
       end
 
@@ -67,7 +60,7 @@ module Twingly
       end
 
       class NullCache
-        def self.cached?(url)
+        def self.cached?(_url)
           false
         end
 

data/lib/twingly/amqp/publisher.rb

@@ -0,0 +1,44 @@
+module Twingly
+  module AMQP
+    module Publisher
+      def publish(message)
+        payload =
+          if message.kind_of?(Array)
+            message
+          elsif message.respond_to?(:to_h)
+            message.to_h
+          else
+            raise ArgumentError
+          end
+
+        json_payload = payload.to_json
+        opts         = options.to_h
+        @exchange.publish(json_payload, opts)
+      end
+
+      # only used by tests to avoid sleeping
+      def publish_with_confirm(message)
+        channel = @exchange.channel
+        channel.confirm_select unless channel.using_publisher_confirmations?
+
+        publish(message)
+
+        @exchange.wait_for_confirms
+      end
+
+      def configure_publish_options
+        yield options
+      end
+
+      private
+
+      def options
+        @options ||=
+          OpenStruct.new(
+            content_type: "application/json",
+            persistent: true,
+          )
+      end
+    end
+  end
+end

data/lib/twingly/amqp/session.rb

@@ -1,5 +1,3 @@
-require "bunny"
-
 module Twingly
   module AMQP
     class Session
@@ -27,10 +25,6 @@ module Twingly
         options[:pass]  ||= password_from_env
         options[:hosts] ||= hosts_from_env
 
-        # Used as a workaround for
-        # https://github.com/ruby-amqp/bunny/issues/446
-        options[:hosts] = options.fetch(:hosts).dup
-
         default_connection_options.merge(options)
       end
 

data/lib/twingly/amqp/subscription.rb

@@ -1,26 +1,31 @@
-require "twingly/amqp/connection"
-require "twingly/amqp/message"
-
 module Twingly
   module AMQP
     class Subscription
       def initialize(queue_name:, exchange_topic: nil, routing_key: nil,
-                     consumer_threads: 4, prefetch: 20, connection: nil,
-                     max_length: nil)
+                     routing_keys: nil, consumer_threads: 1, prefetch: 20,
+                     connection: Connection.instance, max_length: nil)
         @queue_name       = queue_name
         @exchange_topic   = exchange_topic
-        @routing_key      = routing_key
+        @routing_keys     = Array(routing_keys || routing_key)
         @consumer_threads = consumer_threads
         @prefetch         = prefetch
         @max_length       = max_length
+        @cancel           = 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)
 
-        if @exchange_topic && @routing_key
+        if @exchange_topic && @routing_keys.any?
           exchange = @channel.topic(@exchange_topic, durable: true)
-          @queue.bind(exchange, routing_key: @routing_key)
+
+          @routing_keys.each do |routing_key|
+            @queue.bind(exchange, routing_key: routing_key)
+          end
         end
 
         @before_handle_message_callback = proc {}
@@ -63,7 +68,7 @@ module Twingly
 
       private
 
-      def create_consumer(&block)
+      def create_consumer
         @queue.subscribe(subscribe_options) do |delivery_info, metadata, payload|
           @before_handle_message_callback.call(payload)
 
@@ -74,7 +79,7 @@ module Twingly
             channel:       @channel,
           )
 
-          block.call(message)
+          yield message
         end
       end
 
@@ -112,18 +117,6 @@ module Twingly
         tag_name = Socket.gethostname
         @channel.generate_consumer_tag(tag_name)
       end
-
-      def setup_traps
-        [:INT, :TERM].each do |signal|
-          Signal.trap(signal) do
-            # Exit fast if we've already got a signal since before
-            exit!(true) if cancel?
-
-            # Set cancel flag, cancels consumers
-            cancel!
-          end
-        end
-      end
     end
   end
 end

data/lib/twingly/amqp/topic_exchange_publisher.rb

@@ -1,48 +1,13 @@
-require "twingly/amqp/connection"
-require "json"
-require "ostruct"
-
 module Twingly
   module AMQP
     class TopicExchangePublisher
-      def initialize(exchange_name:, routing_key: nil, connection: nil, opts: {})
+      include Publisher
+
+      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
-
-      def publish(message)
-        raise ArgumentError unless message.respond_to?(:to_h)
-
-        payload = message.to_h.to_json
-        opts    = options.to_h
-        @exchange.publish(payload, opts)
-      end
-
-      # only used by tests to avoid sleeping
-      def publish_with_confirm(message)
-        channel = @exchange.channel
-        channel.confirm_select unless channel.using_publisher_confirmations?
-
-        publish(message)
-
-        @exchange.wait_for_confirms
-      end
-
-      def configure_publish_options
-        yield options
-      end
-
-      private
-
-      def options
-        @options ||=
-          OpenStruct.new(
-            content_type: "application/json",
-            persistent: true,
-          )
-      end
     end
   end
 end

data/lib/twingly/amqp/utilities.rb

@@ -0,0 +1,15 @@
+module Twingly
+  module AMQP
+    module Utilities
+      def self.create_queue(queue_name, durable: true, arguments: {}, connection: Connection.instance)
+        connection.with_channel do |channel|
+          return channel.queue(
+            queue_name,
+            durable: durable,
+            arguments: arguments,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/twingly/amqp/version.rb

@@ -1,5 +1,5 @@
 module Twingly
   module Amqp
-    VERSION = "4.3.0".freeze
+    VERSION = "5.2.0".freeze
   end
 end

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: twingly-amqp
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Twingly AB
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
+        version: 2.7.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: Publish and subscribe to messages via RabbitMQ
 email:
 - support@twingly.com
@@ -81,14 +67,16 @@ files:
 - lib/twingly/amqp/null_logger.rb
 - lib/twingly/amqp/ping_options.rb
 - lib/twingly/amqp/pinger.rb
+- lib/twingly/amqp/publisher.rb
 - 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: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,9 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby library for talking to RabbitMQ
 test_files: []