delivery_boy 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b22537575f9af9b44a9a9f285e74d073b48bec92
-  data.tar.gz: 2505ca15d3d2b60a94fb4c88f1a959803d334c44
+  metadata.gz: fd80f951111ad29fdbf5ff8bbc02aef63b59d176
+  data.tar.gz: b9c6b8209940ef36ce24e8aec5261483100726bf
 SHA512:
-  metadata.gz: c5c0e279ebcd829f3b0961d10f705fc74d5307a983547c049542d391361daafdb71ef8c1747770e4b946e56d470e88a78d81b811c9995d26380fcf2ffcb5de13
-  data.tar.gz: 69ef0053f5a4873a6deaa9d7071502adb6ee677d5c9678d33467c1dd65473a6e76a97cd6427fe8b1e23feda1e83c506543ddb6010930d990f3aa71ca27b02edc
+  metadata.gz: ddc0d55c7acb75817794d542c1ac132292c39d466f5d65ddc969f51c57815bd8e5951d9e12aa3391263c3bfc3312f4db86e814e13c905c8c790ef19155328070
+  data.tar.gz: 0ae524907b55be94d29b2c2849c87ea8d81ba28b80d8f94d9e0ff12822258ced4a0f9581e40e803db5557058b4ab58cf0905a5a8b01cd83e4a9883bd3fa0d00f

data/README.md

@@ -71,6 +71,8 @@ $ bundle exec rails generate delivery_boy:install
 
 This will create a config file at `config/delivery_boy.yml` with configurations for each of your Rails environments. Open that file in order to make changes.
 
+Note that for most configuration variables, you can pass in an environment variable. These environment variables all take the form `DELIVERY_BOY_X`, where `X` is the upper-case configuration variable name, e.g. `DELIVERY_BOY_CLIENT_ID`.
+
 The following configuration variables can be set:
 
 #### Basic

data/lib/delivery_boy/config.rb

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

data/lib/delivery_boy/fake.rb

@@ -0,0 +1,28 @@
+module DeliveryBoy
+
+  # A fake implementation that is useful for testing.
+  class Fake
+    FakeMessage = Struct.new(:value, :key, :topic, :partition, :partition_key)
+
+    def initialize
+      @messages = Hash.new {|h, k| h[k] = [] }
+    end
+
+    def deliver(value, topic:, **options)
+      message = FakeMessage.new(value: value, topic: topic, **options)
+      @messages[topic] << message
+
+      nil
+    end
+
+    alias deliver_async! deliver
+
+    def shutdown
+      @messages.clear
+    end
+
+    def messages_for(topic)
+      @messages[topic]
+    end
+  end
+end

data/lib/delivery_boy/instance.rb

@@ -0,0 +1,86 @@
+module DeliveryBoy
+
+  # This class implements the actual logic of DeliveryBoy. The DeliveryBoy module
+  # has a module-level singleton instance.
+  class Instance
+    def initialize(config, logger)
+      @config = config
+      @logger = logger
+    end
+
+    def deliver(value, topic:, **options)
+      sync_producer.produce(value, topic: topic, **options)
+      sync_producer.deliver_messages
+    rescue
+      # Make sure to clear any buffered messages if there's an error.
+      sync_producer.clear_buffer
+
+      raise
+    end
+
+    def deliver_async!(value, topic:, **options)
+      async_producer.produce(value, topic: topic, **options)
+    end
+
+    def shutdown
+      sync_producer.shutdown if sync_producer?
+      async_producer.shutdown if async_producer?
+    end
+
+    private
+
+    attr_reader :config, :logger
+
+    def sync_producer
+      # We want synchronous producers to be per-thread in order to avoid problems with
+      # concurrent deliveries.
+      Thread.current[:delivery_boy_sync_producer] ||= kafka.producer(**producer_options)
+    end
+
+    def sync_producer?
+      Thread.current.key?(:delivery_boy_sync_producer)
+    end
+
+    def async_producer
+      # The async producer doesn't have to be per-thread, since all deliveries are
+      # performed by a single background thread.
+      @async_producer ||= kafka.async_producer(
+        max_queue_size: config.max_queue_size,
+        delivery_threshold: config.delivery_threshold,
+        delivery_interval: config.delivery_interval,
+        **producer_options,
+      )
+    end
+
+    def async_producer?
+      !@async_producer.nil?
+    end
+
+    def kafka
+      @kafka ||= Kafka.new(
+        seed_brokers: config.brokers,
+        client_id: config.client_id,
+        logger: logger,
+        connect_timeout: config.connect_timeout,
+        socket_timeout: config.socket_timeout,
+        ssl_ca_cert: config.ssl_ca_cert,
+        ssl_client_cert: config.ssl_client_cert,
+        ssl_client_cert_key: config.ssl_client_cert_key,
+      )
+    end
+
+    # Options for both the sync and async producers.
+    def producer_options
+      {
+        required_acks: config.required_acks,
+        ack_timeout: config.ack_timeout,
+        max_retries: config.max_retries,
+        retry_backoff: config.retry_backoff,
+        max_buffer_size: config.max_buffer_size,
+        max_buffer_bytesize: config.max_buffer_bytesize,
+        compression_codec: config.compression_codec,
+        compression_threshold: config.compression_threshold,
+      }
+    end
+  end
+end

data/lib/delivery_boy/version.rb

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

data/lib/delivery_boy.rb

@@ -1,6 +1,8 @@
 require "logger"
 require "kafka"
 require "delivery_boy/version"
+require "delivery_boy/instance"
+require "delivery_boy/fake"
 require "delivery_boy/config"
 require "delivery_boy/railtie" if defined?(Rails)
 
@@ -23,13 +25,7 @@ module DeliveryBoy
     # @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
-    rescue
-      # Make sure to clear any buffered messages if there's an error.
-      sync_producer.clear_buffer
-
-      raise
+      instance.deliver(value, topic: topic, **options)
     end
 
     # Like {.deliver_async!}, but handles +Kafka::BufferOverflow+ errors
@@ -48,7 +44,7 @@ module DeliveryBoy
     #
     # @return [nil]
     def deliver_async!(value, topic:, **options)
-      async_producer.produce(value, topic: topic, **options)
+      instance.deliver_async!(value, topic: topic, **options)
     end
 
     # Shut down DeliveryBoy.
@@ -57,8 +53,7 @@ module DeliveryBoy
     #
     # @return [nil]
     def shutdown
-      sync_producer.shutdown if sync_producer?
-      async_producer.shutdown if async_producer?
+      instance.shutdown
     end
 
     # The logger used by DeliveryBoy.
@@ -77,58 +72,18 @@ module DeliveryBoy
       @config ||= DeliveryBoy::Config.new(env: ENV)
     end
 
-    private
-
-    def sync_producer
-      # We want synchronous producers to be per-thread in order to avoid problems with
-      # concurrent deliveries.
-      Thread.current[:delivery_boy_sync_producer] ||= kafka.producer(**producer_options)
-    end
-
-    def sync_producer?
-      Thread.current.key?(:delivery_boy_sync_producer)
+    def test_mode!
+      @instance = testing
     end
 
-    def async_producer
-      # The async producer doesn't have to be per-thread, since all deliveries are
-      # performed by a single background thread.
-      @async_producer ||= kafka.async_producer(
-        max_queue_size: config.max_queue_size,
-        delivery_threshold: config.delivery_threshold,
-        delivery_interval: config.delivery_interval,
-        **producer_options,
-      )
+    def testing
+      @testing ||= Fake.new
     end
 
-    def async_producer?
-      !@async_producer.nil?
-    end
-
-    def kafka
-      @kafka ||= Kafka.new(
-        seed_brokers: config.brokers,
-        client_id: config.client_id,
-        logger: logger,
-        connect_timeout: config.connect_timeout,
-        socket_timeout: config.socket_timeout,
-        ssl_ca_cert: config.ssl_ca_cert,
-        ssl_client_cert: config.ssl_client_cert,
-        ssl_client_cert_key: config.ssl_client_cert_key,
-      )
-    end
+    private
 
-    # Options for both the sync and async producers.
-    def producer_options
-      {
-        required_acks: config.required_acks,
-        ack_timeout: config.ack_timeout,
-        max_retries: config.max_retries,
-        retry_backoff: config.retry_backoff,
-        max_buffer_size: config.max_buffer_size,
-        max_buffer_bytesize: config.max_buffer_bytesize,
-        compression_codec: config.compression_codec,
-        compression_threshold: config.compression_threshold,
-      }
+    def instance
+      @instance ||= Instance.new(config, logger)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery_boy
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-kafka
@@ -90,6 +90,8 @@ files:
 - lib/delivery_boy/config_error.rb
 - lib/delivery_boy/config_file_loader.rb
 - lib/delivery_boy/env_config_loader.rb
+- lib/delivery_boy/fake.rb
+- lib/delivery_boy/instance.rb
 - lib/delivery_boy/railtie.rb
 - lib/delivery_boy/version.rb
 - lib/generators/delivery_boy/config_file.yml.erb