advanced-sneakers-activejob 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1a41d60fe8a0f6041331ada53384c54f3316a3f9c08fd94cf21949fd5467073
-  data.tar.gz: 16f1bd88c90e7edde21a1231420f0415c8e07d466226b51270ae4085f6d3b215
+  metadata.gz: d0b44d61ffa5b78273ecb535f48c3281be398c0c8d5fc89a11fd64b5937482cf
+  data.tar.gz: cf00f7567d031d06f0554f64aa23ca4cade11eb815c44973d4baa90cfb661a30
 SHA512:
-  metadata.gz: c68cc556832c0433e137a399e43011b7e9e884ca50c12beed290b1cc065d84c31ba5e9fe620527c1b6adfb6eca49b251d4e5c4322b6dd34186194283b7ffcee2
-  data.tar.gz: 5b18d980cf4ee656803dfafb82213fb9a1edb91ba283228a375d963cc8ea5cc5fc93a790472f6d10d37731df6be86b36595fda34f07bf7521564ea8c046f9338
+  metadata.gz: 12aab9b5cf9d2f9ce26512873cb510f1aa9a63dc29b118f1722a5e72c1690d34fefeead42b44d96a20192279c4880f274b712be9fbd5542540983195c5942b24
+  data.tar.gz: 8e63c9501b05e295004de85bc518883ae3c44dfbbf1067c67b9239a8adeadb39ee15be987dc704e4122f516e0f9a88722ff52ccb1a28698f3a1fbc94fc70d9d9

data/CHANGELOG.md

@@ -1 +1,7 @@
+## Changes Between 0.1.0 and 0.2.0
+
+### `message_options` https://github.com/veeqo/advanced-sneakers-activejob/pull/1
+
+Customizable options for message publishing (`routing_key`, `headers`, etc)
+
 ## Original Release: 0.1.0

data/README.md

@@ -1,10 +1,11 @@
-# `:advanced_sneakers` adapter for ActiveJob [![Build Status](https://travis-ci.com/veeqo/advanced-sneakers-activejob.svg?branch=master)](https://travis-ci.com/veeqo/advanced-sneakers-activejob)
+# `:advanced_sneakers` adapter for ActiveJob
+[![Build Status](https://travis-ci.com/veeqo/advanced-sneakers-activejob.svg?branch=master)](https://travis-ci.com/veeqo/advanced-sneakers-activejob) [![Gem Version](https://badge.fury.io/rb/advanced-sneakers-activejob.svg)](https://badge.fury.io/rb/advanced-sneakers-activejob)
 
 Drop-in replacement for `:sneakers` adapter of ActiveJob. Extra features:
 
 1. Tries to [handle unrouted messages](#unrouted-messages)
 2. Respects `queue_as` of ActiveJob and defines consumer class per RabbitMQ queue
-3. Supports [custom routing keys](#custom-routing-keys)
+3. Supports [custom message options](#custom-message-options)
 4. Allows to run ActiveJob consumers [separately](#how-to-separate-activejob-consumers) from native Sneakers consumers
 5. Support for [`delayed jobs`](https://edgeguides.rubyonrails.org/active_job_basics.html#enqueue-the-job) `GuestsCleanupJob.set(wait: 1.week).perform_later(guest)`
 6. [Exponential backoff\*](#exponential-backoff)
@@ -52,27 +53,40 @@ Take into accout that **this process is asynchronous**. It means that in case of
 
 **Delayed messages are not handled!** If job is delayed `GuestsCleanupJob.set(wait: 1.week).perform_later(guest)` and there is no proper routing defined at the moment of job execution, it would be lost.
 
-## Custom routing keys
+## Custom message options
 
-Advanced sneakers adapter supports customizable [routing keys](https://www.rabbitmq.com/tutorials/tutorial-four-ruby.html).
+Advanced sneakers adapter allows to set custom message options (e.g. [routing keys](https://www.rabbitmq.com/tutorials/tutorial-four-ruby.html)).
 
 ```ruby
 class MyJob < ActiveJob::Base
 
   queue_as :some_name
 
+  message_options routing_key: 'my.custom.routing.key',
+                  headers: { 'foo' => 'bar' }
+
   def perform(params)
     # ProcessData.new(params).call
   end
+end
+```
+
+Procs are also supported
+```ruby
+class MyJob < ActiveJob::Base
+
+  queue_as :some_name
 
-  def routing_key
-    # we have instance of job here (including #arguments)
-    'my.custom.routing.key'
+  message_options routing_key: ->(job) { "process_user_data.#{job.arguments.first.vip? ? 'urgent' : 'regular' }" }
+
+  def perform(user)
+    # ProcessUserData.new(user).call
   end
 end
 ```
 
-Take into accout that **custom routing key is used for publishing only**.
+
+Take into accout that **custom message options are used for publishing only**.
 
 ## How to separate ActiveJob consumers
 

data/lib/active_job/queue_adapters/advanced_sneakers_adapter.rb

@@ -38,14 +38,23 @@ module ActiveJob
           @monitor.synchronize do
             [
               Sneakers::ContentType.serialize(job.serialize, AdvancedSneakersActiveJob::CONTENT_TYPE),
-              { routing_key: routing_key(job) }
+              build_publish_params(job)
             ]
           end
         end
 
-        def routing_key(job)
-          queue_name = job.queue_name.respond_to?(:call) ? job.queue_name.call : job.queue_name
-          job.respond_to?(:routing_key) ? job.routing_key : queue_name
+        def build_publish_params(job)
+          params = job.class.publish_options.dup || {}
+
+          params.each do |key, value|
+            params[key] = value.call(job) if value.respond_to?(:call)
+          end
+
+          unless params.key?(:routing_key)
+            params[:routing_key] = job.queue_name.respond_to?(:call) ? job.queue_name.call : job.queue_name
+          end
+
+          params
         end
       end
 

data/lib/advanced_sneakers_activejob/active_job_patch.rb

@@ -7,6 +7,8 @@ module AdvancedSneakersActiveJob
     included do
       # AMQP message contains metadata which might be helpful for consumer (e.g. job.delivery_info.routing_key)
       attr_accessor :delivery_info, :headers
+
+      class_attribute :publish_options, instance_accessor: false
     end
 
     module ClassMethods
@@ -22,6 +24,12 @@ module AdvancedSneakersActiveJob
         define_consumer
       end
 
+      def message_options(options)
+        raise ArgumentError, 'message_options accepts Hash argument only' unless options.is_a?(Hash)
+
+        self.publish_options = options.symbolize_keys
+      end
+
       private
 
       def define_consumer

data/lib/advanced_sneakers_activejob/publisher.rb

@@ -20,7 +20,7 @@ module AdvancedSneakersActiveJob
       at_exit { wait_for_unrouted_messages_processing(timeout: WAIT_FOR_UNROUTED_MESSAGES_AT_EXIT_TIMEOUT) }
     end
 
-    def publish(message, routing_key:, headers: {}, **properties)
+    def publish(message, routing_key: nil, headers: {}, **properties)
       ensure_connection!
 
       logger.debug "Publishing <#{message}> to [#{publish_exchange.name}] with routing_key [#{routing_key}]"
@@ -35,7 +35,7 @@ module AdvancedSneakersActiveJob
       publish_exchange.publish(message, params)
     end
 
-    def publish_delayed(message, routing_key:, delay:, headers: {}, **properties)
+    def publish_delayed(message, delay:, routing_key: nil, headers: {}, **properties)
       ensure_connection!
 
       logger.debug "Publishing <#{message}> to [#{publish_delayed_exchange.name}] with routing_key [#{routing_key}] and delay [#{delay}]"

data/lib/advanced_sneakers_activejob/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdvancedSneakersActiveJob
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: advanced-sneakers-activejob
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rustam Sharshenov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob