delivery_boy 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53868e134ceaddeaafb5f96416b3fe6a44c866dd
-  data.tar.gz: 3953493bbe3755d81a971b1e62c1a1a7289ad3a9
+  metadata.gz: bd11867261e3297b893e7667d3f8d6e168d4aec6
+  data.tar.gz: 80c10735314ee3ff0b1c76de9d2e985cd695b4aa
 SHA512:
-  metadata.gz: c62591d732bc07cead953039d63a3fb62b00d59bdcc17dd848d859c69efbd8bca5df98c0ad47b9aa29c3fdc44698da0f16913ac5af9cc23309ced52e8e50f627
-  data.tar.gz: b51fc9e418556e3cdc8da29357d46a949c284d4806f7c4a047d6d424d907e2c7fd60fddbc97b5580e70974000e0620ca575f98e023a232c756a524b7f2040f27
+  metadata.gz: 6ec6357a3d625fd8b5b393318e55285e05f0d4315385ca5734a422823ea13a261cc3a148c872cb69eb7fedb88085735acfdb3663c3f7271dca2b51d5dfe5a23e
+  data.tar.gz: 6d6f43c21d5c28bafe0b7c897084b74e11a75e41a9002d59d2c716ff3e868f95b55ad62d89a1961516176042d607017b30aff26e4b46838abef44c1be129755d

data/README.md

@@ -151,14 +151,18 @@ The maximum number of messages allowed in the buffer before new messages are rej
 
 The maximum number of messages allowed in the queue before new messages are rejected. The queue is used to ferry messages from the foreground threads of your application to the background thread that buffers and delivers messages. You typically only want to increase this number if you have a very high throughput of messages and the background thread can't keep up with spikes in throughput.
 
-#### Authentication and authorization
+#### SSL Authentication and authorization
 
-See [ruby-kafka](https://github.com/zendesk/ruby-kafka#security) for more information.
+See [ruby-kafka](https://github.com/zendesk/ruby-kafka#encryption-and-authentication-using-ssl) for more information.
 
 ##### `ssl_ca_cert`
 
 A PEM encoded CA cert, or an Array of PEM encoded CA certs, to use with an SSL connection.
 
+##### `ssl_ca_cert_file_path`
+
+The path to a valid SSL certificate authority file.
+
 ##### `ssl_client_cert`
 
 A PEM encoded client cert to use with an SSL connection. Must be used in combination with `ssl_client_cert_key`.
@@ -167,6 +171,32 @@ 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`.
 
+#### 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.
+
+##### `sasl_gssapi_principal`
+
+The GSSAPI principal.
+
+##### `sasl_gssapi_keytab`
+
+Optional GSSAPI keytab.
+
+##### `sasl_plain_authzid`
+
+The authorization identity to use.
+
+##### `sasl_plain_username`
+
+The username used to authenticate.
+
+##### `sasl_plain_password`
+
+The password used to authenticate.
+
 ### 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:
@@ -202,7 +232,7 @@ end
 
 This takes care of clearing messages after each example, as well.
 
-If you're not using RSpec, you can easily replicate the functionality yourself. Call `DeliveryBoy.test_mode` at load time, and make sure that `DeliveryBoy.testing.clear` is called after each test.
+If you're not using RSpec, you can easily replicate the functionality yourself. Call `DeliveryBoy.test_mode!` at load time, and make sure that `DeliveryBoy.testing.clear` is called after each test.
 
 ### Instrumentation & monitoring
 

data/circle.yml

@@ -0,0 +1,16 @@
+machine:
+  pre:
+    - curl -sSL https://s3.amazonaws.com/circle-downloads/install-circleci-docker.sh | bash -s -- 1.10.0
+  services:
+    - docker
+  ruby:
+    version: 2.4.1
+
+dependencies:
+  pre:
+    - docker -v
+    - docker run -p 2181:2181 -p 9092:9092 --env ADVERTISED_HOST=localhost --env ADVERTISED_PORT=9092 -d spotify/kafka
+
+test:
+  override:
+    - bundle exec rspec

data/delivery_boy.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "ruby-kafka", "~> 0.4"
-  spec.add_runtime_dependency "king_konf", "~> 0.1.2"
+  spec.add_runtime_dependency "king_konf", "~> 0.1.8"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/delivery_boy/config.rb

@@ -2,25 +2,51 @@ require "king_konf"
 
 module DeliveryBoy
   class Config < KingKonf::Config
-    prefix :delivery_boy
+    env_prefix :delivery_boy
 
-    integer :ack_timeout, default: 5
-    integer :compression_threshold, default: 1
-    integer :connect_timeout, default: 10
-    integer :delivery_interval, default: 10
-    integer :delivery_threshold, default: 100
+    # Basic
+    list :brokers, items: :string, sep: ",", default: ["localhost:9092"]
+    string :client_id, default: "delivery_boy"
+
+    # Buffering
     integer :max_buffer_bytesize, default: 10_000_000
     integer :max_buffer_size, default: 1000
     integer :max_queue_size, default: 1000
+
+    # Network timeouts
+    integer :connect_timeout, default: 10
+    integer :socket_timeout, default: 30
+
+    # Delivery
+    integer :ack_timeout, default: 5
+    integer :delivery_interval, default: 10
+    integer :delivery_threshold, default: 100
     integer :max_retries, default: 2
     integer :required_acks, default: -1
     integer :retry_backoff, default: 1
-    integer :socket_timeout, default: 30
-    string :client_id, default: "delivery_boy"
+
+    # Compression
+    integer :compression_threshold, default: 1
     string :compression_codec, default: nil
+
+    # SSL authentication
     string :ssl_ca_cert, default: nil
+    string :ssl_ca_cert_file_path
     string :ssl_client_cert, default: nil
     string :ssl_client_cert_key, default: nil
-    list :brokers, items: :string, sep: ",", default: ["localhost:9092"]
+
+    # SASL authentication
+    string :sasl_gssapi_principal
+    string :sasl_gssapi_keytab
+    string :sasl_plain_authzid
+    string :sasl_plain_username
+    string :sasl_plain_password
+
+    # Datadog monitoring
+    boolean :datadog_enabled
+    string :datadog_host
+    integer :datadog_port
+    string :datadog_namespace
+    list :datadog_tags
   end
 end

data/lib/delivery_boy/instance.rb

@@ -64,8 +64,14 @@ module DeliveryBoy
         connect_timeout: config.connect_timeout,
         socket_timeout: config.socket_timeout,
         ssl_ca_cert: config.ssl_ca_cert,
+        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,
+        sasl_gssapi_principal: config.sasl_gssapi_principal,
+        sasl_gssapi_keytab: config.sasl_gssapi_keytab,
+        sasl_plain_authzid: config.sasl_plain_authzid,
+        sasl_plain_username: config.sasl_plain_username,
+        sasl_plain_password: config.sasl_plain_password,
       )
     end
 

data/lib/delivery_boy/railtie.rb

@@ -1,10 +1,20 @@
 module DeliveryBoy
   class Railtie < Rails::Railtie
     initializer "delivery_boy.load_config" do
+      config = DeliveryBoy.config
       config_file = "config/delivery_boy.yml"
 
       if File.exist?(config_file)
-        DeliveryBoy.config.load_file(config_file, Rails.env)
+        config.load_file(config_file, Rails.env)
+      end
+
+      if config.datadog_enabled
+        require "kafka/datadog"
+
+        Kafka::Datadog.host = config.datadog_host if config.datadog_host.present?
+        Kafka::Datadog.port = config.datadog_port if config.datadog_port.present?
+        Kafka::Datadog.namespace = config.datadog_namespace if config.datadog_namespace.present?
+        Kafka::Datadog.tags = config.datadog_tags if config.datadog_tags.present?
       end
     end
   end

data/lib/delivery_boy/version.rb

@@ -1,3 +1,3 @@
 module DeliveryBoy
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery_boy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-kafka
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +97,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
 - delivery_boy.gemspec
 - examples/async.rb
 - examples/sync.rb