delivery_boy 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0625c454e902fb754978710dae81fa1ae823a06b
-  data.tar.gz: 8c37651745002d2c847b55d0185d95e3c9514c4a
+  metadata.gz: b22537575f9af9b44a9a9f285e74d073b48bec92
+  data.tar.gz: 2505ca15d3d2b60a94fb4c88f1a959803d334c44
 SHA512:
-  metadata.gz: 0a73aefdb9f2688ca34314c81ef499a42f29996594229f99263cb3acbc584258b93016c1c4d03e3c3839dcc29ccfcd0bc85cef26e22bea2b4e19f01e6c6d7f98
-  data.tar.gz: 60a3f71a92629f2470ab40f15a097e73f0b6b63437c2cb43fdfc8f4c3eb5a9aa6a56cf987c449eee1231767573595b98aafb43ae4c3ccf142c4ed6d4744d02bf
+  metadata.gz: c5c0e279ebcd829f3b0961d10f705fc74d5307a983547c049542d391361daafdb71ef8c1747770e4b946e56d470e88a78d81b811c9995d26380fcf2ffcb5de13
+  data.tar.gz: 69ef0053f5a4873a6deaa9d7071502adb6ee677d5c9678d33467c1dd65473a6e76a97cd6427fe8b1e23feda1e83c506543ddb6010930d990f3aa71ca27b02edc

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-Once you've [installed the gem](#installation), and assuming your Kafka broker is running on localhost, you can simply start publishing messages to Kafka:
+Once you've [installed the gem](#installation), and assuming your Kafka broker is running on localhost, you can simply start publishing messages to Kafka directly from your Rails code:
 
 ```ruby
 # app/controllers/comments_controller.rb

data/lib/delivery_boy.rb

@@ -6,6 +6,22 @@ require "delivery_boy/railtie" if defined?(Rails)
 
 module DeliveryBoy
   class << self
+
+    # Write a message to a specified Kafka topic synchronously.
+    #
+    # Keep in mind that the client will block until the message has been
+    # delivered.
+    #
+    # @param value [String] the message value.
+    # @param topic [String] the topic that the message should be written to.
+    # @param key [String, nil] the message key.
+    # @param partition [Integer, nil] the topic partition that the message should
+    #   be written to.
+    # @param partition_key [String, nil] a key used to deterministically assign
+    #   a partition to the message.
+    # @return [nil]
+    # @raise [Kafka::BufferOverflow] if the producer's buffer is full.
+    # @raise [Kafka::DeliveryFailed] if delivery failed for some reason.
     def deliver(value, topic:, **options)
       sync_producer.produce(value, topic: topic, **options)
       sync_producer.deliver_messages
@@ -16,27 +32,47 @@ module DeliveryBoy
       raise
     end
 
+    # Like {.deliver_async!}, but handles +Kafka::BufferOverflow+ errors
+    # by logging them and just going on with normal business.
+    #
+    # @return [nil]
     def deliver_async(value, topic:, **options)
       deliver_async!(value, topic: topic, **options)
     rescue Kafka::BufferOverflow
       logger.error "Message for `#{topic}` dropped due to buffer overflow"
     end
 
+    # Like {.deliver}, but returns immediately.
+    #
+    # The actual delivery takes place in a background thread.
+    #
+    # @return [nil]
     def deliver_async!(value, topic:, **options)
       async_producer.produce(value, topic: topic, **options)
     end
 
+    # Shut down DeliveryBoy.
+    #
+    # Automatically called when the process exits.
+    #
+    # @return [nil]
     def shutdown
       sync_producer.shutdown if sync_producer?
       async_producer.shutdown if async_producer?
     end
 
+    # The logger used by DeliveryBoy.
+    #
+    # @return [Logger]
     def logger
       @logger ||= Logger.new($stdout)
     end
 
     attr_writer :logger
 
+    # The configuration used by DeliveryBoy.
+    #
+    # @return [DeliveryBoy::Config]
     def config
       @config ||= DeliveryBoy::Config.new(env: ENV)
     end

data/lib/delivery_boy/config.rb

@@ -75,6 +75,7 @@ module DeliveryBoy
     def load_env(env)
       loader = EnvConfigLoader.new(env, self)
 
+      loader.string_list :brokers
       loader.integer :ack_timeout
       loader.symbol :compression_codec
       loader.integer :compression_threshold

data/lib/delivery_boy/version.rb

@@ -1,3 +1,3 @@
 module DeliveryBoy
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery_boy
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-kafka