delivery_boy 0.2.8 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d1d10c8e6cf173eeca342252bf3e47327f08200fd6e34207e803d6ef490ead7
-  data.tar.gz: 4e7d841926323cc46aefec6cdf93812796ae2a454a562e4ad0c6d02eb79b229e
+  metadata.gz: a12782da215edcc91544e184fd5804b2c21fb4a4be180f69addd0e2f7787884e
+  data.tar.gz: 6de9279ba3441524aceef6091a4feaf57d67a8623499779877b39ed9a11edad9
 SHA512:
-  metadata.gz: 6388bf8cadefd13a20ceabb7e887171e0f6c8dc42cb5f31a5370da7578bb5e5913192a20161d0370af43cc3a88798f74417886657f887e636fec2586dddfd27a
-  data.tar.gz: e1cbea934e040fcea51b9730e0340376aef0f59ede9c8d82199bba3b0adc60c309ef87a86ade3b7a6bb1d9f7136403dfb6d64408693974f4832f85a04ce24500
+  metadata.gz: 6787bea888f6a2db4bb0d66eaad3c2234c9b6e4482c81ec69e43c27960b4c4a191ec553c0a24c87a46c5067811e2b9eb85265b34fc9457692465dfa8d902c5af
+  data.tar.gz: e10d3020dbaedfe5608fab51e6e1d343341919aab23b905766cdc386e2b844d5177d464fba93d69b79cc6d3704a5ad703ca97464f5754a363a9d362fecec2559

data/CHANGELOG

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## v1.1.0
+
+* Support for `ssl_client_cert_key_password` in the configuration (#52)
+* Add `DeliveryBoy.buffer_size` to return the number of messages in the buffer
+* Add `DeliveryBoy::Fake#clear_buffer` and `DeliveryBoy::Fake#buffer_size` to
+support the public API when using the test helper.
+* Support for `sasl_oauth_token_provider` in the configuration. (#55)
+
+## v1.0.1
+
+* Require ruby-kafka v1.0 or higher.
+
+## v1.0.0
+
+* Add `DeliveryBoy.clear_buffer` method.
+* Support exactly once delivery and transactional messaging (#50)
+* Check that Rails::Railtie is defined (#48)
+
 ## v0.2.8
 
 * Support `log_level` config option.

data/README.md

@@ -66,7 +66,7 @@ A third method is to produce messages first (without delivering the messages to
  class CommentsController < ApplicationController
    def create
      @comment = Comment.create!(params)
-     
+
      event = {
        name: "comment_created",
        data: {
@@ -74,13 +74,13 @@ A third method is to produce messages first (without delivering the messages to
          user_id: current_user.id
        }
      }
-     
+
      # This will queue the two messages in the internal buffer.
      DeliveryBoy.produce(comment.to_json, topic: "comments")
      DeliveryBoy.produce(event.to_json, topic: "activity")
-     
+
      # This will deliver all messages in the buffer to Kafka.
-     # This call is blocking. 
+     # This call is blocking.
      DeliveryBoy.deliver_messages
    end
  end
@@ -220,11 +220,15 @@ A PEM encoded client cert to use with an SSL connection. Must be used in combina
 
 A PEM encoded client cert key to use with an SSL connection. Must be used in combination with `ssl_client_cert`.
 
+##### `ssl_client_cert_key_password`
+
+The password required to read the ssl_client_cert_key. Must be used in combination with ssl_client_cert_key.
+
 #### SASL Authentication and authorization
 
 See [ruby-kafka](https://github.com/zendesk/ruby-kafka#authentication-using-sasl) for more information.
 
-Use either `sasl_gssapi_*` _or_ `sasl_plain_*`, not both.
+Use it through `GSSAPI`, `PLAIN` _or_ `OAUTHBEARER`.
 
 ##### `sasl_gssapi_principal`
 
@@ -246,6 +250,25 @@ The username used to authenticate.
 
 The password used to authenticate.
 
+##### `sasl_oauth_token_provider`
+
+A instance of a class which implements the `token` method.
+As described in [ruby-kafka](https://github.com/zendesk/ruby-kafka/tree/c3e90bc355fad1e27b9af1048966ff08d3d5735b#oauthbearer)
+
+```ruby
+class TokenProvider
+  def token
+    "oauth-token"
+  end
+end
+
+DeliveryBoy.configure do |config|
+  config.sasl_oauth_token_provider = TokenProvider.new
+  config.ssl_ca_certs_from_system = true
+end
+```
+
+
 ### Testing
 
 DeliveryBoy provides a test mode out of the box. When this mode is enabled, messages will be stored in memory rather than being sent to Kafka. If you use RSpec, enabling test mode is as easy as adding this to your spec helper:

data/delivery_boy.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "ruby-kafka", "~> 0.7.8"
-  spec.add_runtime_dependency "king_konf", "~> 0.3"
+  spec.add_runtime_dependency "ruby-kafka", "~> 1.0"
+  spec.add_runtime_dependency "king_konf", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/delivery_boy/config.rb

@@ -25,6 +25,9 @@ module DeliveryBoy
     integer :max_retries, default: 2
     integer :required_acks, default: -1
     integer :retry_backoff, default: 1
+    boolean :idempotent, default: false
+    boolean :transactional, default: false
+    integer :transactional_timeout, default: 60
 
     # Compression
     integer :compression_threshold, default: 1
@@ -35,6 +38,7 @@ module DeliveryBoy
     string :ssl_ca_cert_file_path
     string :ssl_client_cert, default: nil
     string :ssl_client_cert_key, default: nil
+    string :ssl_client_cert_key_password, default: nil
     boolean :ssl_ca_certs_from_system, default: false
     boolean :ssl_verify_hostname, default: true
 
@@ -49,6 +53,9 @@ module DeliveryBoy
     string :sasl_scram_mechanism
     boolean :sasl_over_ssl, default: true
 
+    # SASL OAUTHBEARER
+    attr_accessor :sasl_oauth_token_provider
+
     # Datadog monitoring
     boolean :datadog_enabled
     string :datadog_host

data/lib/delivery_boy/fake.rb

@@ -2,7 +2,7 @@ module DeliveryBoy
 
   # A fake implementation that is useful for testing.
   class Fake
-    FakeMessage = Struct.new(:value, :topic, :key, :offset, :partition, :partition_key, :create_time) do
+    FakeMessage = Struct.new(:value, :topic, :key, :headers, :offset, :partition, :partition_key, :create_time) do
       def bytesize
         key.to_s.bytesize + value.to_s.bytesize
       end
@@ -14,10 +14,10 @@ module DeliveryBoy
       @delivery_lock = Mutex.new
     end
 
-    def deliver(value, topic:, key: nil, partition: nil, partition_key: nil, create_time: Time.now)
+    def deliver(value, topic:, key: nil, headers: {}, partition: nil, partition_key: nil, create_time: Time.now)
       @delivery_lock.synchronize do
         offset = @messages[topic].count
-        message = FakeMessage.new(value, topic, key, offset, partition, partition_key, create_time)
+        message = FakeMessage.new(value, topic, key, headers, offset, partition, partition_key, create_time)
 
         @messages[topic] << message
       end
@@ -27,10 +27,10 @@ module DeliveryBoy
 
     alias deliver_async! deliver
 
-    def produce(value, topic:, key: nil, partition: nil, partition_key: nil, create_time: Time.now)
+    def produce(value, topic:, key: nil, headers: {}, partition: nil, partition_key: nil, create_time: Time.now)
       @delivery_lock.synchronize do
         offset = @buffer[topic].count
-        message = FakeMessage.new(value, topic, key, offset, partition, partition_key, create_time)
+        message = FakeMessage.new(value, topic, key, headers, offset, partition, partition_key, create_time)
 
         @buffer[topic] << message
       end
@@ -51,6 +51,18 @@ module DeliveryBoy
       clear
     end
 
+    def clear_buffer
+      @delivery_lock.synchronize do
+        @buffer.clear
+      end
+    end
+
+    def buffer_size
+      @delivery_lock.synchronize do
+        @buffer.values.flatten.size
+      end
+    end
+
     # Clear all messages stored in memory.
     def clear
       @delivery_lock.synchronize do

data/lib/delivery_boy/instance.rb

@@ -14,7 +14,7 @@ module DeliveryBoy
       sync_producer.deliver_messages
     rescue
       # Make sure to clear any buffered messages if there's an error.
-      sync_producer.clear_buffer
+      clear_buffer
 
       raise
     end
@@ -36,6 +36,14 @@ module DeliveryBoy
       sync_producer.deliver_messages
     end
 
+    def clear_buffer
+      sync_producer.clear_buffer
+    end
+
+    def buffer_size
+      sync_producer.buffer_size
+    end
+
     private
 
     attr_reader :config, :logger
@@ -76,6 +84,7 @@ module DeliveryBoy
         ssl_ca_cert_file_path: config.ssl_ca_cert_file_path,
         ssl_client_cert: config.ssl_client_cert,
         ssl_client_cert_key: config.ssl_client_cert_key,
+        ssl_client_cert_key_password: config.ssl_client_cert_key_password,
         ssl_ca_certs_from_system: config.ssl_ca_certs_from_system,
         ssl_verify_hostname: config.ssl_verify_hostname,
         sasl_gssapi_principal: config.sasl_gssapi_principal,
@@ -86,7 +95,8 @@ module DeliveryBoy
         sasl_scram_username: config.sasl_scram_username,
         sasl_scram_password: config.sasl_scram_password,
         sasl_scram_mechanism: config.sasl_scram_mechanism,
-        sasl_over_ssl: config.sasl_over_ssl
+        sasl_over_ssl: config.sasl_over_ssl,
+        sasl_oauth_token_provider: config.sasl_oauth_token_provider
       )
     end
 
@@ -101,6 +111,9 @@ module DeliveryBoy
         max_buffer_bytesize: config.max_buffer_bytesize,
         compression_codec: (config.compression_codec.to_sym if config.compression_codec),
         compression_threshold: config.compression_threshold,
+        idempotent: config.idempotent,
+        transactional: config.transactional,
+        transactional_timeout: config.transactional_timeout,
       }
     end
   end

data/lib/delivery_boy/version.rb

@@ -1,3 +1,3 @@
 module DeliveryBoy
-  VERSION = "0.2.8"
+  VERSION = "1.1.0"
 end

data/lib/delivery_boy.rb

@@ -4,7 +4,8 @@ require "delivery_boy/version"
 require "delivery_boy/instance"
 require "delivery_boy/fake"
 require "delivery_boy/config"
-require "delivery_boy/railtie" if defined?(Rails)
+require "delivery_boy/config_error"
+require "delivery_boy/railtie" if defined?(Rails::Railtie)
 
 module DeliveryBoy
   class << self
@@ -80,6 +81,16 @@ module DeliveryBoy
       instance.deliver_messages
     end
 
+    # Clear any buffered messages generated by {.produce} or {.produce!} methods.
+    def clear_buffer
+      instance.clear_buffer
+    end
+
+    # Return the number of messages in the buffer
+    def buffer_size
+      instance.buffer_size
+    end
+
     # Shut down DeliveryBoy.
     #
     # Automatically called when the process exits.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery_boy
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-kafka
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.8
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.8
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: king_konf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A simple way to produce messages to Kafka from Ruby applications