delivery_boy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0764539427dbbb53a7fefaa79c63177c899e18e
+  data.tar.gz: 6483a025b200c5e846d13ddb772bccaa656c945d
+SHA512:
+  metadata.gz: 389af5e34963f8a97134939efa34b7b6519e20cc2f850b977c478982a60335635fdbf71974482bd2035218cf0369ea52fe3648fd088daf5d660e791d1ea9e267
+  data.tar.gz: dca33d4f8545897c0b372c49cc1e66b0561e598973ec6e58c848795f1c6e5e45dc3bdc50a47f4fad4170ce820b691f927d06b130348a6ed312c5780d86f540e9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in delivery_boy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,184 @@
+# DeliveryBoy
+
+This library provides a dead easy way to start publishing messages to a Kafka cluster from your Ruby or Rails application!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delivery_boy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delivery_boy
+
+## 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:
+
+```ruby
+# app/controllers/comments_controller.rb
+class CommentsController < ApplicationController
+  def create
+    @comment = Comment.create!(params)
+
+    # This will publish a JSON representation of the comment to the `comments` topic
+    # in Kafka. Make sure to create the topic first, or this may fail.
+    DeliveryBoy.deliver(comment.to_json, topic: "comments")
+  end
+end
+```
+
+The above example will block the server process until the message has been delivered. If you want deliveries to happen in the background in order to free up your server processes more quickly, call `#deliver_async` instead:
+
+```ruby
+# app/controllers/comments_controller.rb
+class CommentsController < ApplicationController
+  def show
+    @comment = Comment.find(params[:id])
+
+    event = {
+      name: "comment_viewed",
+      data: {
+        comment_id: @comment.id,
+        user_id: current_user.id
+      }
+    }
+
+    # By delivering messages asynchronously you free up your server processes faster.
+    DeliveryBoy.deliver_async(event.to_json, topic: "activity")
+  end
+end
+```
+
+In addition to improving response time, delivering messages asynchronously also protects your application against Kafka availability issues -- if messages cannot be delivered, they'll be buffered for later and retried automatically.
+
+### Configuration
+
+You configure DeliveryBoy either through a config file or by setting environment variables.
+
+If you're using Rails, the fastest way to get started is to execute the following in your terminal:
+
+```
+$ 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.
+
+The following configuration variables can be set:
+
+#### Basic
+
+##### `brokers`
+
+A list of Kafka brokers that should be used to initialize the client. Defaults to just `localhost:9092` in development and test, but in production you need to pass a list of `hostname:port` strings.
+
+##### `client_id`
+
+This is how the client will identify itself to the Kafka brokers. Default is `delivery_boy`.
+
+#### Message delivery
+
+##### `delivery_interval`
+
+The number of seconds between background message deliveries. Default is 10 seconds. Disable timer-based background deliveries by setting this to 0.
+
+##### `delivery_threshold`
+
+The number of buffered messages that will trigger a background message delivery. Default is 100 messages. Disable buffer size based background deliveries by setting this to 0.
+
+##### `required_acks`
+
+The number of Kafka replicas that must acknowledge messages before they're considered as successfully written. Default is _all_ replicas.
+
+See [ruby-kafka](https://github.com/zendesk/ruby-kafka#message-durability) for more information.
+
+##### `ack_timeout`
+
+A timeout executed by a broker when the client is sending messages to it. It defines the number of seconds the broker should wait for replicas to acknowledge the write before responding to the client with an error. As such, it relates to the `required_acks` setting. It should be set lower than `socket_timeout`.
+
+##### `max_retries`
+
+The number of retries when attempting to deliver messages. The default is 2, so 3 attempts in total, but you can configure a higher or lower number.
+
+##### `retry_backoff`
+
+The number of seconds to wait after a failed attempt to send messages to a Kafka broker before retrying. The `max_retries` setting defines the maximum number of retries to attempt, and so the total duration could be up to `max_retries * retry_backoff` seconds. The timeout can be arbitrarily long, and shouldn't be too short: if a broker goes down its partitions will be handed off to another broker, and that can take tens of seconds.
+
+#### Compression
+
+See [ruby-kafka](https://github.com/zendesk/ruby-kafka#compression) for more information.
+
+##### `compression_codec`
+
+The codec used to compress messages. Must be either `snappy` or `gzip`.
+
+##### `compression_threshold`
+
+The minimum number of messages that must be buffered before compression is attempted. By default only one message is required. Only relevant if `compression_codec` is set.
+
+#### Network
+
+##### `connect_timeout`
+
+The number of seconds to wait while connecting to a broker for the first time. When the Kafka library is initialized, it needs to connect to at least one host in `brokers` in order to discover the Kafka cluster. Each host is tried until there's one that works. Usually that means the first one, but if your entire cluster is down, or there's a network partition, you could wait up to `n * connect_timeout` seconds, where `n` is the number of hostnames in `brokers`.
+
+##### `socket_timeout`
+
+Timeout when reading data from a socket connection to a Kafka broker. Must be larger than `ack_timeout` or you risk killing the socket before the broker has time to acknowledge your messages.
+
+#### Buffering
+
+When using the asynhronous API, messages are buffered in a background thread and delivered to Kafka based on the configured delivery policy. Because of this, problems that hinder the delivery of messages can cause the buffer to grow. In order to avoid unlimited buffer growth that would risk affecting the host application, some limits are put in place. After the buffer reaches the maximum size allowed, calling `DeliveryBoy.deliver_async` will raise `Kafka::BufferOverflow`.
+
+##### `max_buffer_bytesize`
+
+The maximum number of bytes allowed in the buffer before new messages are rejected.
+
+##### `max_buffer_size`
+
+The maximum number of messages allowed in the buffer before new messages are rejected.
+
+##### `max_queue_size`
+
+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
+
+See [ruby-kafka](https://github.com/zendesk/ruby-kafka#security) 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_client_cert`
+
+A PEM encoded client cert to use with an SSL connection. Must be used in combination with `ssl_client_cert_key`.
+
+##### `ssl_client_cert_key`
+
+A PEM encoded client cert key to use with an SSL connection. Must be used in combination with `ssl_client_cert`.
+
+### Instrumentation & monitoring
+
+Since DeliveryBoy is just an opinionated API on top of ruby-kafka, you can use all the [instrumentation made available by that library](https://github.com/zendesk/ruby-kafka#instrumentation). You can also use the [existing monitoring solutions](https://github.com/zendesk/ruby-kafka#monitoring) that integrate with various monitoring services.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/dasch/delivery_boy).
+
+## Copyright and license
+
+Copyright 2017 Zendesk, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+
+You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "delivery_boy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/delivery_boy.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "delivery_boy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "delivery_boy"
+  spec.version       = DeliveryBoy::VERSION
+  spec.authors       = ["Daniel Schierbeck"]
+  spec.email         = ["daniel.schierbeck@gmail.com"]
+
+  spec.summary       = "A simple way to produce messages to Kafka from Ruby applications"
+  spec.description   = "A simple way to produce messages to Kafka from Ruby applications"
+  spec.homepage      = "https://github.com/zendesk/delivery_boy"
+  spec.license       = "Apache License Version 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "ruby-kafka", "~> 0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/examples/async.rb

@@ -0,0 +1,4 @@
+require "delivery_boy"
+
+DeliveryBoy.deliver_async "howdy", topic: "greetings"
+DeliveryBoy.shutdown

data/examples/sync.rb

@@ -0,0 +1,4 @@
+require "delivery_boy"
+
+DeliveryBoy.deliver "hello", topic: "greetings"
+DeliveryBoy.shutdown

data/lib/delivery_boy.rb

@@ -0,0 +1,92 @@
+require "logger"
+require "kafka"
+require "delivery_boy/version"
+require "delivery_boy/config"
+require "delivery_boy/railtie" if defined?(Rails)
+
+module DeliveryBoy
+  class << self
+    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
+
+    def logger
+      @logger ||= Logger.new($stdout)
+    end
+
+    attr_writer :logger
+
+    def config
+      @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)
+    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/config.rb

@@ -0,0 +1,98 @@
+require "erb"
+require "yaml"
+require "delivery_boy/env_config_loader"
+require "delivery_boy/config_file_loader"
+require "delivery_boy/config_error"
+
+module DeliveryBoy
+  class Config
+    VARIABLES = %w[
+      ack_timeout
+      brokers
+      client_id
+      compression_codec
+      compression_threshold
+      connect_timeout
+      delivery_interval
+      delivery_threshold
+      max_buffer_bytesize
+      max_buffer_size
+      max_queue_size
+      max_retries
+      required_acks
+      retry_backoff
+      socket_timeout
+      ssl_ca_cert
+      ssl_client_cert
+      ssl_client_cert_key
+    ]
+
+    DEFAULTS = {
+      ack_timeout: 5,
+      brokers: ["localhost:9092"],
+      client_id: "delivery_boy",
+      compression_threshold: 1,
+      connect_timeout: 10,
+      max_buffer_bytesize: 10_000_000,
+      max_buffer_size: 1000,
+      max_retries: 2,
+      required_acks: :all,
+      retry_backoff: 1,
+      socket_timeout: 30,
+      delivery_interval: 10,
+      delivery_threshold: 100,
+      max_queue_size: 1000,
+    }
+
+    attr_accessor(*VARIABLES)
+
+    def initialize(env:)
+      load_config(DEFAULTS)
+      load_env(env)
+    end
+
+    def load_file(path, environment)
+      loader = ConfigFileLoader.new(self)
+      loader.load_file(path, environment)
+    end
+
+    private
+
+    def load_config(config)
+      config.each do |variable, value|
+        set(variable, value)
+      end
+    end
+
+    def load_env(env)
+      loader = EnvConfigLoader.new(env, self)
+
+      loader.integer :ack_timeout
+      loader.symbol :compression_codec
+      loader.integer :compression_threshold
+      loader.integer :connect_timeout
+      loader.integer :delivery_interval
+      loader.integer :delivery_threshold
+      loader.integer :max_buffer_bytesize
+      loader.integer :max_buffer_size
+      loader.integer :max_queue_size
+      loader.integer :max_retries
+      loader.integer :required_acks
+      loader.integer :retry_backoff
+      loader.integer :socket_timeout
+      loader.string :ssl_ca_cert
+      loader.string :ssl_client_cert
+      loader.string :ssl_client_cert_key
+
+      loader.validate!
+    end
+
+    def set(variable, value)
+      unless VARIABLES.include?(variable.to_s)
+        raise ConfigError, "unknown configuration variable #{variable}"
+      end
+
+      instance_variable_set("@#{variable}", value)
+    end
+  end
+end

data/lib/delivery_boy/config_error.rb

@@ -0,0 +1,4 @@
+module DeliveryBoy
+  ConfigError = Class.new(StandardError)
+end
+

data/lib/delivery_boy/config_file_loader.rb

@@ -0,0 +1,20 @@
+module DeliveryBoy
+  class ConfigFileLoader
+    def initialize(config)
+      @config = config
+    end
+
+    def load_file(path, environment)
+      # First, load the ERB template from disk.
+      template = ERB.new(File.new(path).read)
+
+      # The last argument to `safe_load` allows us to use aliasing to share
+      # configuration between environments.
+      processed = YAML.safe_load(template.result(binding), [], [], true)
+
+      processed.fetch(environment).each do |variable, value|
+        @config.set(variable, value)
+      end
+    end
+  end
+end

data/lib/delivery_boy/env_config_loader.rb

@@ -0,0 +1,57 @@
+require "delivery_boy/config_error"
+
+module DeliveryBoy
+  class EnvConfigLoader
+    KEY_PREFIX = "DELIVERY_BOY"
+
+    def initialize(env, config)
+      @env = env
+      @config = config
+      @loaded_keys = []
+    end
+
+    def string(name)
+      set(name) {|value| value }
+    end
+
+    def symbol(name)
+      set(name) {|value| value.to_sym }
+    end
+
+    def integer(name)
+      set(name) do |value|
+        begin
+          Integer(value)
+        rescue ArgumentError
+          raise ConfigError, "#{value.inspect} is not an integer"
+        end
+      end
+    end
+
+    def string_list(name)
+      set(name) {|value| value.split(",") }
+    end
+
+    def validate!
+      # Make sure the user hasn't made a typo and added a key we don't know
+      # about.
+      @env.keys.grep(/^#{KEY_PREFIX}_/).each do |key|
+        unless @loaded_keys.include?(key)
+          raise ConfigError, "unknown config variable #{key}"
+        end
+      end
+    end
+
+    private
+
+    def set(name)
+      key = "#{KEY_PREFIX}_#{name.upcase}"
+
+      if @env.key?(key)
+        value = yield @env.fetch(key)
+        @config.set(name, value)
+        @loaded_keys << key
+      end
+    end
+  end
+end

data/lib/delivery_boy/railtie.rb

@@ -0,0 +1,11 @@
+module DeliveryBoy
+  class Railtie < Rails::Railtie
+    initializer "delivery_boy.load_config" do
+      config_file = "config/delivery_boy.yml"
+
+      if File.exist?(config_file)
+        DeliveryBoy.config.load_file(config_file, Rails.env)
+      end
+    end
+  end
+end

data/lib/delivery_boy/version.rb

@@ -0,0 +1,3 @@
+module DeliveryBoy
+  VERSION = "0.1.0"
+end

data/lib/generators/delivery_boy/config_file.yml.erb

@@ -0,0 +1,20 @@
+# These config values will be shared by all environments but can be overridden.
+common: &common
+  client_id: "<%= Rails.application.class.name.split("::").first.underscore %>"
+
+development:
+  <<: *common
+  brokers:
+    - localhost:9092
+
+test:
+  <<: *common
+  brokers:
+    - localhost:9092
+
+production:
+  <<: *common
+  brokers:
+    - kafka1.myapp.com:9092
+    - kafka2.myapp.com:9092
+    - kafka3.myapp.com:9092

data/lib/generators/delivery_boy/install_generator.rb

@@ -0,0 +1,11 @@
+module DeliveryBoy
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../", __FILE__)
+
+      def create_config_file
+        template "config_file.yml.erb", "config/delivery_boy.yml"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: delivery_boy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Schierbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple way to produce messages to Kafka from Ruby applications
+email:
+- daniel.schierbeck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- delivery_boy.gemspec
+- examples/async.rb
+- examples/sync.rb
+- lib/delivery_boy.rb
+- lib/delivery_boy/config.rb
+- lib/delivery_boy/config_error.rb
+- lib/delivery_boy/config_file_loader.rb
+- lib/delivery_boy/env_config_loader.rb
+- lib/delivery_boy/railtie.rb
+- lib/delivery_boy/version.rb
+- lib/generators/delivery_boy/config_file.yml.erb
+- lib/generators/delivery_boy/install_generator.rb
+homepage: https://github.com/zendesk/delivery_boy
+licenses:
+- Apache License Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple way to produce messages to Kafka from Ruby applications
+test_files: []