deimos-ruby 2.0.16 → 2.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fda90b7f018f9ef696c574248a0bbeabfff39b0d9d6b50fbb0f674e0a46adb83
-  data.tar.gz: ef3134f7e7e30d4caa44537089350a5ce85c9b8db13ed065f69a2723d7a2b943
+  metadata.gz: a6b4516c780cd6c4acfe46092cf4ff7342a3db20b5d259f6fee59e85c2dd6c01
+  data.tar.gz: 02347f3bb35d9cd1c0435f097d453c6f7d90bccee6892d637954c862155164fd
 SHA512:
-  metadata.gz: 31622734e2657cdf5643594a97b5b56d04bd5bdbf9a56aea73c264f8300ecb9993d09491532f636dd71d208b1dd22af3e2cba0fd91c31d682b7b01efc980c9cc
-  data.tar.gz: a4b370d783983c5062a892c408981ebeb28472199be9700c43a5d5871b74f3f90885b9ee8bc8dd9307a7162d512ad69dca2f48311e98a278f28b5d703f07f5dc
+  metadata.gz: 8b1c2de2fa812f2385b07f3e9fde5135e734571f5bb34d96dd31536ebaf7576c3acdccc7df03098632d549e264d8ef1a5d8f2589995287dda4628dbd535a1840
+  data.tar.gz: 600268d4111cb77b2f4c06a6e07ee95d7e7e4387c298a6099c4498f247a64a443426d639c09b1e30455e3f74ebca7a3790ca5b54abcf34d3ab8918811f58a765

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+## 2.0.17 - 2025-07-03
+
+- Feature: Allow producers to specify `:message` and `:key` in the `publish` methods.
+
 ## 2.0.16 - 2025-05-30
 
 - Fix: Send `publish` metric even if the producer was not a Deimos producer.

data/README.md

@@ -259,13 +259,22 @@ If you publish a payload `{ "test_id" => "123", "some_int" => 123 }`, this
 will be turned into a key that looks like `{ "test_id" => "123"}` and schema-encoded
 before being sent to Kafka. 
 
-If you are using `plain` or `schema` as your config, you will need to have a
-special `payload_key` key to your payload hash. This will be extracted and
+If you are using `plain` or `schema` as your config, you can specify the key in two ways:
+
+* Add a special `payload_key` key to your payload hash. This will be extracted and
 used as the key (for `plain`, it will be used directly, while for `schema`
 it will be encoded first against the schema). So your payload would look like
 `{ "test_id" => "123", "some_int" => 123, payload_key: "some_other_key"}`.
 Remember that if you're using `schema`, the `payload_key` must be a *hash*,
 not a plain value.
+* Specify `:message` and `:key` values when producing messages. This can be helpful when using [schema classes](#generated-schema-classes):
+
+```ruby
+MyProducer.publish({
+                     message: MySchema.new("test_id" => "123", "some_int" => 123),
+                     key: MySchemaKey.new("test_id" => "123")
+                   })
+```
 
 ## Instrumentation
 

data/lib/deimos/producer.rb

@@ -111,12 +111,17 @@ module Deimos
         backend = determine_backend_class(sync, force_send)
 
         messages = Array(payloads).map do |p|
-          {
+          m = {
             payload: p&.to_h,
             headers: headers,
             topic: topic,
             partition_key: self.partition_key(p)
           }
+          if m.dig(:payload, :key).present? && m.dig(:payload, :message).present?
+            m[:key] = m[:payload][:key].to_h
+            m[:payload] = m[:payload][:message].to_h
+          end
+          m
         end
         self.produce(messages, backend: backend)
       end

data/lib/deimos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deimos
-  VERSION = '2.0.16'
+  VERSION = '2.0.17'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.16
+  version: 2.0.17
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-30 00:00:00.000000000 Z
+date: 2025-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf