racecar 0.5.0.beta2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1dc4466a144fa4e914a2e6989d19c32841909e6b
-  data.tar.gz: f70ce01e975ea49a314bc36d13733f3cd11aed71
+SHA256:
+  metadata.gz: 28a2c032c29aeba007b00c13eb0bfec94b2d32bf6a6076235b801c4eee28a6b1
+  data.tar.gz: b2f63c4a91f2a9ecfa26d7f4ac1902dc865221a8d0ed203a13dfb59c04dc35f5
 SHA512:
-  metadata.gz: b6e6a5fa75b949265456858e8d8c99b3701acf1ad50de51e7aea3daf2d97c6be85c1e56ab8358d6f782b9c771eee4e609e91494c4c5f4cc5b0c2ee41ef25e15e
-  data.tar.gz: 19894d6636220cfdb7bb9221554d7fe72bb93e3984767dee1c99d354fb94cf779fac42c333640b35def6d453f90004fa191baee69ebc9e7ad8bb71437ebb2033
+  metadata.gz: eabaf84b44a70f65ea8fda8ff9e9721f39d342b65c66995b580bfc99d5977d8d675100e01428c0c64b4342d3165e52951b4a08b11cdcd54c6cb93601fca9abf0
+  data.tar.gz: 7155e003d823e1cfbdb80b374b8f6b14169c65c3dfaeb9eda734d72cca373a5bc9662616616cf4ee12f3002801c0cbfd0664758a8406fd410867e5aca5f45659

data/.gitignore

@@ -7,4 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-/vendor/bundle/
+/vendor/bundle/

data/CHANGELOG.md

@@ -2,10 +2,30 @@
 
 ## Unreleased
 
+## racecar v1.2.0
+
+* Support for `ssl_client_cert_key_password` (#173).
+* Support for `OAUTHBEARER` authentication (`sasl_oauth_token_provider`) (#178).
+
+## racecar v1.1.0
+
+* Require ruby-kafka v1.0 or higher.
+* Add error handling for required libraries (#149).
+
+## racecar v1.0.1
+
+* Add `--without-rails` option to boot consumer without Rails (#139).
+
+## racecar v1.0.0
+
+Unchanged from v0.5.0.
+
 ## racecar v0.5.0
 
 * Add support for manually sending heartbeats with `heartbeat` (#105).
 * Allow configuring `sasl_over_ssl`.
+* Add current directory to `$LOAD_PATH` only when `--require` option is used (#117).
+* Support for `ssl_verify_hostname` in the configuration (#120)
 
 ## racecar v0.4.2
 

data/README.md

@@ -294,6 +294,7 @@ The memory usage limit is roughly estimated as `max_bytes * max_fetch_queue_size
 * `ssl_ca_cert_file_path` - The path to a valid SSL certificate authority file.
 * `ssl_client_cert` – A valid SSL client certificate, as a string.
 * `ssl_client_cert_key` – A valid SSL client certificate key, as a string.
+* `ssl_client_cert_key_password` – The password for the client cert key, as a string (optional).
 
 #### SASL encryption, authentication & authorization
 
@@ -316,6 +317,15 @@ If using SCRAM:
 * `sasl_scram_password` – The password used to authenticate.
 * `sasl_scram_mechanism` – The SCRAM mechanism to use, either `sha256` or `sha512`.
 
+If using OAUTHBEARER:
+
+* `sasl_oauth_token_provider`- In order to authenticate using OAUTHBEARER, you must set the client with an instance of a class that implements a token method (the interface is described in Kafka::Sasl::OAuth) which returns an ID/Access token.
+This mechanism is supported in kafka >= 2.0.0 as of KIP-255.
+
+See more at [here](https://github.com/zendesk/ruby-kafka/tree/master#oauthbearer).
+
+NOTE: `sasl_oauth_token_provider` only works using the `config/racecar.rb` configuration file.
+
 #### Producing messages
 
 These settings are related to consumers that _produce messages to Kafka_.
@@ -332,6 +342,9 @@ Racecar supports configuring ruby-kafka's [Datadog](https://www.datadoghq.com/)
 * `datadog_namespace` – The namespace to use for Datadog metrics.
 * `datadog_tags` – Tags that should always be set on Datadog metrics.
 
+#### Consumers Without Rails ####
+
+By default, if Rails is detected, it will be automatically started when the consumer is started. There are cases where you might not want or need Rails. You can pass the `--without-rails` option when starting the consumer and Rails won't be started.
 
 ### Testing consumers
 

data/exe/racecar

@@ -3,8 +3,6 @@
 require "racecar"
 require "racecar/cli"
 
-$LOAD_PATH.unshift(Dir.pwd)
-
 begin
   Racecar::Cli.main(ARGV)
 rescue SignalException => e

data/lib/racecar.rb

@@ -22,6 +22,10 @@ module Racecar
     @config ||= Config.new
   end
 
+  def self.config=(config)
+    @config = config
+  end
+
   def self.configure
     yield config
   end

data/lib/racecar/cli.rb

@@ -23,10 +23,10 @@ module Racecar
     def run
       $stderr.puts "=> Starting Racecar consumer #{consumer_name}..."
 
-      RailsConfigFileLoader.load!
+      RailsConfigFileLoader.load! unless config.without_rails?
 
       if File.exist?("config/racecar.rb")
-        require "config/racecar"
+        require "./config/racecar"
       end
 
       # Find the consumer class by name.
@@ -94,11 +94,20 @@ module Racecar
     end
 
     def build_parser
+      load_path_modified = false
+
       OptionParser.new do |opts|
         opts.banner = "Usage: racecar MyConsumer [options]"
 
         opts.on("-r", "--require STRING", "Require a library before starting the consumer") do |lib|
-          require lib
+          $LOAD_PATH.unshift(Dir.pwd) unless load_path_modified
+          load_path_modified = true
+          begin
+            require lib
+          rescue => e
+            $stderr.puts "=> #{lib} failed to load: #{e.message}"
+            exit
+          end
         end
 
         opts.on("-l", "--log STRING", "Log to the specified file") do |logfile|

data/lib/racecar/config.rb

@@ -73,6 +73,9 @@ module Racecar
     desc "A valid SSL client certificate key"
     string :ssl_client_cert_key
 
+    desc "The password for the SSL client certificate key"
+    string :ssl_client_cert_key_password
+
     desc "Support for using the CA certs installed on your system by default for SSL. More info, see: https://github.com/zendesk/ruby-kafka/pull/521"
     boolean :ssl_ca_certs_from_system, default: false
 
@@ -127,11 +130,20 @@ module Racecar
     desc "Tags that should always be set on Datadog metrics"
     list :datadog_tags
 
+    desc "Whether to check the server certificate is valid for the hostname"
+    boolean :ssl_verify_hostname, default: true
+
+    desc "Whether to boot Rails when starting the consumer"
+    boolean :without_rails, default: false
+
     # The error handler must be set directly on the object.
     attr_reader :error_handler
 
     attr_accessor :subscriptions, :logger
 
+    # The OAUTHBEARER token provider class.
+    attr_accessor :sasl_oauth_token_provider
+
     def initialize(env: ENV)
       super(env: env)
       @error_handler = proc {}
@@ -162,6 +174,10 @@ module Racecar
       if max_pause_timeout && !pause_with_exponential_backoff?
         raise ConfigError, "`max_pause_timeout` only makes sense when `pause_with_exponential_backoff` is enabled"
       end
+
+      if ssl_client_cert_key_password && !ssl_client_cert_key
+        raise ConfigError, "`ssl_client_cert_key_password` must be used in conjunction with `ssl_client_cert_key`"
+      end
     end
 
     def load_consumer_class(consumer_class)

data/lib/racecar/runner.rb

@@ -27,13 +27,16 @@ module Racecar
         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,
+        ssl_client_cert_key_password: config.ssl_client_cert_key_password,
         sasl_plain_username: config.sasl_plain_username,
         sasl_plain_password: config.sasl_plain_password,
         sasl_scram_username: config.sasl_scram_username,
         sasl_scram_password: config.sasl_scram_password,
         sasl_scram_mechanism: config.sasl_scram_mechanism,
+        sasl_oauth_token_provider: config.sasl_oauth_token_provider,
         sasl_over_ssl: config.sasl_over_ssl,
         ssl_ca_certs_from_system: config.ssl_ca_certs_from_system,
+        ssl_verify_hostname: config.ssl_verify_hostname
       )
 
       @consumer = kafka.consumer(

data/lib/racecar/version.rb

@@ -1,3 +1,3 @@
 module Racecar
-  VERSION = "0.5.0.beta2"
+  VERSION = "1.2.0"
 end

data/racecar.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "king_konf", "~> 0.3.7"
-  spec.add_runtime_dependency "ruby-kafka", "~> 0.6"
+  spec.add_runtime_dependency "ruby-kafka", "~> 1.0"
 
   spec.add_development_dependency "bundler", [">= 1.13", "< 3"]
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: racecar
 version: !ruby/object:Gem::Version
-  version: 0.5.0.beta2
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel Schierbeck
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: king_konf
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -141,12 +141,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A framework for running Kafka consumers