racecar 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91d58261935752f8853314f793645b96fd698e13
-  data.tar.gz: 0df9c01dab82f12ac4bc39a0ef94cf2e97f7f5c7
+  metadata.gz: f99bf49d325678924cc1650412797964ca9fb6c7
+  data.tar.gz: 3411bf0ee53db4ef17d7254d57b3a9c0782bc7aa
 SHA512:
-  metadata.gz: fe3351b26b79034b3d74d399ec83909ce81adee6172eb6b772c00f187ecf460625dd45accc8b86691697ddebe90054b36f1d3ed515154c9ff742e29aef5b98b3
-  data.tar.gz: a81cea061c82501a66c413d87214f1299fb5badfbdc573c3056b3cc692fe4909628765b64ce68026d3a9f2bd7fdea4ff33d6857473dcd1496a24bac2d107135f
+  metadata.gz: d8fb917397c7f8c812ec569af3e3796254a1ac6450598538c44a88dae60c3701fc2f2cc34de52e069bdba6efad30cfcf42c56d20743fef6d8cd499254d489d47
+  data.tar.gz: 9d5e71b4fd8f4777c6a7f7928dae2bfb87410093f247cb6c4b608c9673ae452db56fe7b668c7d2377a8a6e4fb950bcf07bd934bcaebc708034ea2812e959bde9

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
+--require spec_helper
 --color

data/LICENSE.txt

@@ -1,21 +1,176 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Daniel Schierbeck
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+                                 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

@@ -1,8 +1,8 @@
 # Racecar
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/racecar`. To experiment with that code, run `bin/console` for an interactive prompt.
+Introducing Racecar, your friendly and easy-to-approach Kafka consumer framework!
 
-TODO: Delete this and the text above, and describe your gem
+Using [ruby-kafka](https://github.com/zendesk/ruby-kafka) directly can be a challenge: it's a flexible library with lots of knobs and options. Most users don't need that level of flexibility, though.
 
 ## Installation
 
@@ -22,7 +22,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add a file in e.g. `app/consumers/user_ban_consumer.rb`:
+
+```ruby
+class UserBanConsumer < Racecar::Consumer
+  subscribes_to "user_banned"
+
+  def process(message)
+    data = JSON.parse(message.value)
+    user = User.find(data["user_id"])
+    user.banned = true
+    user.save!
+  end
+end
+```
+
+Now run your consumer with `bundle exec racecar UserBanConsumer`.
+
+That's all there is to it.
 
 ## Development
 
@@ -32,10 +49,14 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/racecar.
+Bug reports and pull requests are welcome on GitHub at https://github.com/zendesk/racecar.
+
+## Copyright and license
 
+Copyright 2015 Zendesk
 
-## License
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+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/examples/cat_consumer.rb

@@ -0,0 +1,7 @@
+class CatConsumer < Racecar::Consumer
+  subscribes_to "messages", start_from_beginning: false
+
+  def process(message)
+    puts message.value
+  end
+end

data/exe/racecar

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "racecar"
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: racecar MyConsumer [options]"
+
+  opts.on("-r", "--require LIBRARY", "Require the LIBRARY before starting the consumer") do |lib|
+    require lib
+  end
+
+  opts.on_tail("--version", "Show Racecar version") do
+    require "racecar/version"
+    puts "Racecar #{Racecar::VERSION}"
+    exit
+  end
+end
+
+parser.parse!(ARGV)
+
+consumer_name = ARGV.first or raise "No consumer specified"
+config_file = "config/racecar.yml"
+
+puts "=> Starting Racecar consumer #{consumer_name}..."
+
+if defined?(Rails)
+  puts "=> Booting Rails application..."
+
+  require_relative "../config/environment"
+
+  Racecar.config.load_file(config_file, Rails.env)
+
+  if Racecar.config.log_to_stdout
+    # Write to STDOUT as well as to the log file.
+    console = ActiveSupport::Logger.new($stdout)
+    console.formatter = Rails.logger.formatter
+    console.level = Rails.logger.level
+    Rails.logger.extend(ActiveSupport::Logger.broadcast(console))
+  end
+
+  Racecar.logger = Rails.logger
+end
+
+# Find the consumer class by name.
+consumer_class = Kernel.const_get(consumer_name)
+
+# Load config defined by the consumer class itself.
+Racecar.config.load_consumer_class(consumer_class)
+
+Racecar.config.validate!
+
+puts "=> Wrooooom!"
+puts "=> Ctrl-C to shutdown consumer"
+
+processor = consumer_class.new
+
+Racecar.run(processor)
+
+puts "=> Shut down"

data/lib/racecar.rb

@@ -1,5 +1,23 @@
-require "racecar/version"
+require "logger"
+
+require "racecar/consumer"
+require "racecar/runner"
+require "racecar/config"
 
 module Racecar
-  # Your code goes here...
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.run(processor)
+    Runner.new(processor, config: config, logger: logger).run
+  end
 end

data/lib/racecar/config.rb

@@ -0,0 +1,117 @@
+require "erb"
+require "yaml"
+
+module Racecar
+  class Config
+    ALLOWED_KEYS = %w(
+      brokers
+      client_id
+      offset_commit_interval
+      offset_commit_threshold
+      heartbeat_interval
+      pause_timeout
+      connect_timeout
+      socket_timeout
+      group_id_prefix
+      group_id
+      subscriptions
+      error_handler
+      max_wait_time
+      log_to_stdout
+    )
+
+    REQUIRED_KEYS = %w(
+      brokers
+    )
+
+    DEFAULT_CONFIG = {
+      client_id: "racecar",
+      group_id_prefix: nil,
+
+      subscriptions: [],
+
+      # Default is to commit offsets every 10 seconds.
+      offset_commit_interval: 10,
+
+      # Default is no buffer threshold trigger.
+      offset_commit_threshold: 0,
+
+      # Default is to send a heartbeat every 10 seconds.
+      heartbeat_interval: 10,
+
+      # Default is to not pause partitions on processing errors.
+      pause_timeout: 0,
+
+      connect_timeout: nil,
+      socket_timeout: nil,
+      error_handler: proc {},
+      max_wait_time: 5,
+      log_to_stdout: false,
+    }
+
+    attr_accessor(*ALLOWED_KEYS)
+
+    def initialize
+      load(DEFAULT_CONFIG)
+      load_env!
+    end
+
+    def validate!
+      REQUIRED_KEYS.each do |key|
+        if send(key).nil?
+          raise "required configuration key `#{key}` not defined"
+        end
+      end
+    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)
+
+      data = processed.fetch(environment)
+
+      load(data)
+    end
+
+    def load(data)
+      data.each do |key, value|
+        unless ALLOWED_KEYS.include?(key.to_s)
+          raise "unknown configuration key `#{key}`"
+        end
+
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def load_consumer_class(consumer_class)
+      @group_id ||= consumer_class.group_id
+
+      @group_id ||= [
+        # Configurable and optional prefix:
+        group_id_prefix,
+
+        # MyFunnyConsumer => my-funny-consumer
+        consumer_class.name.gsub(/[a-z][A-Z]/) {|str| str[0] << "-" << str[1] }.downcase,
+      ].compact.join("")
+
+      @subscriptions = consumer_class.subscriptions
+      @max_wait_time = consumer_class.max_wait_time
+    end
+
+    def on_error(&handler)
+      @error_handler = handler
+    end
+
+    private
+
+    def load_env!
+      if ENV.key?("RACECAR_BROKERS")
+        @brokers = ENV["RACECAR_BROKERS"].split(",")
+      end
+    end
+  end
+end

data/lib/racecar/consumer.rb

@@ -0,0 +1,21 @@
+module Racecar
+  class Consumer
+    Subscription = Struct.new(:topic, :start_from_beginning)
+
+    class << self
+      attr_accessor :max_wait_time
+      attr_accessor :group_id
+
+      def subscriptions
+        @subscriptions ||= []
+      end
+
+      # Adds one or more topic subscriptions.
+      def subscribes_to(*topics, start_from_beginning: true)
+        topics.each do |topic|
+          subscriptions << Subscription.new(topic, start_from_beginning)
+        end
+      end
+    end
+  end
+end

data/lib/racecar/runner.rb

@@ -0,0 +1,71 @@
+require "kafka"
+
+module Racecar
+  class Runner
+    attr_reader :processor, :config, :logger
+
+    def initialize(processor, config:, logger:)
+      @processor, @config, @logger = processor, config, logger
+    end
+
+    def run
+      kafka = Kafka.new(
+        client_id: config.client_id,
+        seed_brokers: config.brokers,
+        logger: logger,
+        connect_timeout: config.connect_timeout,
+        socket_timeout: config.socket_timeout,
+      )
+
+      consumer = kafka.consumer(
+        group_id: config.group_id,
+        offset_commit_interval: config.offset_commit_interval,
+        offset_commit_threshold: config.offset_commit_threshold,
+        heartbeat_interval: config.heartbeat_interval,
+      )
+
+      # Stop the consumer on SIGINT and SIGQUIT.
+      trap("QUIT") { consumer.stop }
+      trap("INT") { consumer.stop }
+
+      config.subscriptions.each do |subscription|
+        topic = subscription.topic
+        start_from_beginning = subscription.start_from_beginning
+
+        consumer.subscribe(topic, start_from_beginning: start_from_beginning)
+      end
+
+      begin
+        consumer.each_message(max_wait_time: config.max_wait_time) do |message|
+          processor.process(message)
+        end
+      rescue Kafka::ProcessingError => e
+        @logger.error "Error processing partition #{e.topic}/#{e.partition} at offset #{e.offset}"
+
+        if config.pause_timeout > 0
+          # Pause fetches from the partition. We'll continue processing the other partitions in the topic.
+          # The partition is automatically resumed after the specified timeout, and will continue where we
+          # left off.
+          @logger.warn "Pausing partition #{e.topic}/#{e.partition} for #{config.pause_timeout} seconds"
+          consumer.pause(e.topic, e.partition, timeout: config.pause_timeout)
+        end
+
+        config.error_handler.call(e.cause, {
+          topic: e.topic,
+          partition: e.partition,
+          offset: e.offset,
+        })
+
+        # Restart the consumer loop.
+        retry
+      rescue Kafka::Error => e
+        error = "#{e.class}: #{e.message}\n" + e.backtrace.join("\n")
+        @logger.error "Consumer thread crashed: #{error}"
+
+        config.error_handler.call(e)
+      end
+
+      @logger.info "Gracefully shutting down"
+    end
+  end
+end

data/lib/racecar/version.rb

@@ -1,3 +1,3 @@
 module Racecar
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/racecar.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "A framework for running Kafka consumers"
   spec.homepage      = "https://github.com/zendesk/racecar"
-  spec.license       = "MIT"
+  spec.license       = "Apache License Version 2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: racecar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Schierbeck
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,7 +57,8 @@ description:
 email:
 - dschierbeck@zendesk.com
 - bquorning@zendesk.com
-executables: []
+executables:
+- racecar
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,12 +71,17 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/cat_consumer.rb
+- exe/racecar
 - lib/racecar.rb
+- lib/racecar/config.rb
+- lib/racecar/consumer.rb
+- lib/racecar/runner.rb
 - lib/racecar/version.rb
 - racecar.gemspec
 homepage: https://github.com/zendesk/racecar
 licenses:
-- MIT
+- Apache License Version 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []