rimless 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89eb85ed138758a0b67496d3816fe748d7119eb9afcd9e5d08c2e116d24b28f8
-  data.tar.gz: dea1976e01d8719aee285af77f40ec140622d15997996bbffa1f34ba61949c99
+  metadata.gz: f8731817c3b1148a4a9c5954f89cbc2a6a1f5c9e7023137be662d2405260cfc0
+  data.tar.gz: 731e88cf5b51713d89178dd7e17b5ec180ed3644f7359a6dc70994d2f2dfd5f5
 SHA512:
-  metadata.gz: a26b32866b7a5a52a5921ee07f7d400051773d28a45b62eb536b9febe704879587ddcf69a8dabf25e5799d3367c789e4767e9525c6be7dea59ef07c3cb7fdbfe
-  data.tar.gz: b13f1768f869ed85c7ea27ef83c1667999e5503a2c9c400406c2348493a869136c6c7ba528f02e2b815a8eb9bf4325359e1e2fdc41951ffaefe6ce92bd1f072c
+  metadata.gz: 470445e7954d1c51c815c98988a87fe2e8b520b53ccdc36cd77ae8380ed0756ec89c181f338e646cd5f472b2cf9fd249b259d1f34713f7ec6e71a0486bd4d27b
+  data.tar.gz: bb8c86c2aece00aa3c6e38ebb96847bf33059f60cab1e163d92cc8ae8fb077bb000423b977243214df5c3d45691e3bad48a62ebb811b4783d6f1a4688abf256e

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+### 1.1.0
+
+* Added support for Karafka `~> 1.4.0` and set is as minimum dependency version
+  (#10)
+
+### 1.0.4
+
+* Mocked WaterDrop producers in the rimless rspec helper so that tests
+  won't actually talk to Kafka (#9)
+
+### 1.0.3
+
+* Corrected broken stats when no consumer is yet defined (#8)
+
+### 1.0.2
+
+* Only load the statistics rake task when Rails is available and the
+  environment is development (instead of not production, this may cause issues
+  for +canary+ or +stage+ Rails environments)
+
+### 1.0.1
+
+* Added the missing +Karafka::Testing::RSpec::Helpers+ include to the
+  RSpec configuration
+
 ### 1.0.0
 
 * Dropped support for Ruby 2.3/2.4 and added support for Rails 6.0 (#6)

data/Makefile

@@ -85,7 +85,11 @@ update: install
 	@$(MKDIR) -p $(VENDOR_DIR)
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) update)
 
-test: #install
+test: \
+	test-specs \
+	test-style
+
+test-specs:
 	# Run the whole test suite
 	@$(call run-shell,$(BUNDLE) exec $(RAKE))
 

data/lib/rimless/consumer.rb

@@ -131,7 +131,7 @@ module Rimless
                 topic(topic_name) do
                   consumer dest_consumer
                   worker Rimless::ConsumerJob
-                  interchanger Rimless::Karafka::Base64Interchanger
+                  interchanger Rimless::Karafka::Base64Interchanger.new
                 end
               end
             end

data/lib/rimless/karafka/avro_deserializer.rb

@@ -6,15 +6,19 @@ module Rimless
     class AvroDeserializer
       # Deserialize an Apache Avro encoded Apache Kafka message.
       #
-      # @param message [String] the binary blob to deserialize
+      # @param params [Karafka::Params::Params] the Karafka message parameters
       # @return [Hash{Symbol => Mixed}] the deserialized Apache Avro message
-      def call(message)
+      def call(params)
+        # When the Kafka message does not have a payload, we won't fail.
+        # This is for Kafka users which use log compaction with a nil payload.
+        return if params.raw_payload.nil?
+
         # We use sparsed hashes inside of Apache Avro messages for schema-less
         # blobs of data, such as loosely structured metadata blobs.  Thats a
         # somewhat bad idea on strictly typed and defined messages, but their
         # occurence should be rare.
         Rimless
-          .decode(message.payload)
+          .decode(params.raw_payload)
           .yield_self { |data| Sparsify(data, sparse_array: true) }
           .yield_self { |data| data.transform_keys { |key| key.delete('\\') } }
           .yield_self { |data| Unsparsify(data, sparse_array: true) }

data/lib/rimless/karafka/base64_interchanger.rb

@@ -7,14 +7,14 @@ module Rimless
     #
     # rubocop:disable Security/MarshalLoad because we encode/decode the
     #   messages in our own controlled context
-    class Base64Interchanger
+    class Base64Interchanger < ::Karafka::Interchanger
       # Encode a binary Apache Kafka message(s) so they can be passed to the
       # Sidekiq +Rimless::ConsumerJob+.
       #
       # @param params_batch [Mixed] the raw message(s) to encode
       # @return [String] the marshaled+base64 encoded data
-      def self.encode(params_batch)
-        Base64.encode64(Marshal.dump(params_batch.to_a))
+      def encode(params_batch)
+        Base64.encode64(Marshal.dump(super))
       end
 
       # Decode the binary Apache Kafka message(s) so they can be processed by
@@ -22,8 +22,8 @@ module Rimless
       #
       # @param params_string [String] the marshaled+base64 encoded data
       # @return [Mixed] the unmarshaled+base64 decoded data
-      def self.decode(params_string)
-        Marshal.load(Base64.decode64(params_string))
+      def decode(params_string)
+        Marshal.load(Base64.decode64(super)).map(&:stringify_keys)
       end
     end
     # rubocop:enable Security/MarshalLoad

data/lib/rimless/rspec.rb

@@ -19,6 +19,7 @@ raise 'No RSPEC_CONFIGURER is defined, webmock is missing?' \
 RSPEC_CONFIGURER.configure do |config|
   config.include Rimless::RSpec::Helpers
   config.include Rimless::RSpec::Matchers
+  config.include Karafka::Testing::RSpec::Helpers
 
   # Set the custom +consumer+ type for consumer spec files
   config.define_derived_metadata(file_path: %r{/spec/consumers/}) do |meta|
@@ -61,6 +62,10 @@ RSPEC_CONFIGURER.configure do |config|
     # Clear any cached data
     FakeConfluentSchemaRegistryServer.clear
 
+    # Do not interact with Apache Kafka itself on tests
+    allow(WaterDrop::AsyncProducer).to receive(:call)
+    allow(WaterDrop::SyncProducer).to receive(:call)
+
     # Reconfigure the Rimless AvroTurf instance
     Rimless.configure_avro_turf
 

data/lib/rimless/tasks/stats.rake

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-if defined?(Rails) && !Rails.env.production?
+if defined?(Rails) && Rails.env.development?
   require 'rspec/core/rake_task'
 
   task :stats do
@@ -9,6 +9,8 @@ if defined?(Rails) && !Rails.env.production?
     [
       [:unshift, 'Consumer', 'app/consumers']
     ].each do |method, type, dir|
+      next unless File.directory? dir
+
       ::STATS_DIRECTORIES.send(method, [type, dir])
       ::CodeStatistics::TEST_TYPES << type if type.include? 'specs'
     end

data/lib/rimless/version.rb

@@ -2,5 +2,5 @@
 
 module Rimless
   # The version of the +rimless+ gem
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/rimless.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'activesupport', '>= 4.2.0'
   spec.add_runtime_dependency 'avro_turf', '~> 0.11.0'
-  spec.add_runtime_dependency 'karafka', '~> 1.3'
-  spec.add_runtime_dependency 'karafka-sidekiq-backend', '~> 1.3'
-  spec.add_runtime_dependency 'karafka-testing', '~> 1.3'
+  spec.add_runtime_dependency 'karafka', '~> 1.4'
+  spec.add_runtime_dependency 'karafka-sidekiq-backend', '~> 1.4'
+  spec.add_runtime_dependency 'karafka-testing', '~> 1.4'
   spec.add_runtime_dependency 'sinatra'
   spec.add_runtime_dependency 'sparsify', '~> 1.1'
   spec.add_runtime_dependency 'waterdrop', '~> 1.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rimless
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Hermann Mayer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: karafka-sidekiq-backend
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: karafka-testing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -418,7 +418,7 @@ files:
 homepage: https://github.com/hausgold/rimless
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -433,8 +433,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A bundle of opinionated Apache Kafka / Confluent Schema Registry helpers.
 test_files: []