karafka-sidekiq-backend 1.2.0.beta3 → 1.2.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1e9d5b7c2a522e2ff126eca4b34ffc37efe1d4e9117d6996daf6b9fd959f393
-  data.tar.gz: ecf5117a7726db83707021ffeeab152b51d0f1e044fae590c8f2018ed94d52c8
+  metadata.gz: 57e4580e9858d6475c1461199217e1aba83091c90de3802457e9a2245a5700c1
+  data.tar.gz: 57771eedaf99af86108ccebdc7518c442c04ba0a340641a9af616d6601766f87
 SHA512:
-  metadata.gz: 41ab55ab65c5750ae7d2b4a4ec844da5049612f4a8e59419177dd1e85a43ff4e992a622dc6be9ee335dffd8a39ae5526fb16eaf10af27981f5494106f132441a
-  data.tar.gz: af65c10503038935f1a892aef9a231611196ea8c06a683b54e3cd6cf07f944e91cce13f19832b49070e7850a65ffd790a822091eb002dc7dfc6c575bb311f874
+  metadata.gz: 44fff2bb75bc5d3c6a0345920c4ff00e8d9d97467d570e95881749ff0a7cab408c64230eae1de01f2280e4a3b020b93c43203001ab6f208d2227094110f7a1fd
+  data.tar.gz: 87795d7271e8a20177c251bb8bdad8044844ce1aa9334538b148de3584102e25668abf48149593c0807f82359dd6bc3de66251675a6c2aea324bcf9b3bae5b20

data/CHANGELOG.md

@@ -1,8 +1,7 @@
 # Karafka Sidekiq Backend
 
-## 1.2.0.beta3
+## 1.2.0.beta4
 - ```#load``` and ```#parse``` are renamed to ```#encode``` and ```#decode``` in interchangers
-- Default interchanger is not Base64 Marshal dump
 - #274 - Rename controllers to consumers
 - Karafka 1.2 support
 - Parse data before pushing to Sidekiq

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    karafka-sidekiq-backend (1.2.0.beta3)
-      karafka (>= 1.2.0.beta2)
+    karafka-sidekiq-backend (1.2.0.beta4)
+      karafka (>= 1.2.0.beta4)
       sidekiq (>= 4.2)
 
 GEM
@@ -63,7 +63,7 @@ GEM
       concurrent-ruby (~> 1.0)
     inflecto (0.0.2)
     json (2.1.0)
-    karafka (1.2.0.beta2)
+    karafka (1.2.0.beta4)
       activesupport (>= 4.0)
       dry-configurable (~> 0.7)
       dry-inflector (~> 0.1.1)
@@ -75,7 +75,7 @@ GEM
       require_all (>= 1.4)
       ruby-kafka (>= 0.5.3)
       thor (~> 0.19)
-      waterdrop (>= 1.2.0.beta1)
+      waterdrop (~> 1.2)
     king_konf (0.1.10)
     minitest (5.11.3)
     multi_json (1.13.1)
@@ -85,7 +85,7 @@ GEM
       rack
     rake (12.3.0)
     redis (4.0.1)
-    require_all (1.5.0)
+    require_all (2.0.0)
     rouge (2.2.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)

data/README.md

@@ -1,9 +1,9 @@
 # Karafka Sidekiq Backend
 
-[![Build Status](https://travis-ci.org/karafka/karafka-sidekiq-backend.png)](https://travis-ci.org/karafka/karafka-sidekiq-backend)
+[![Build Status](https://travis-ci.org/karafka/sidekiq-backend.png)](https://travis-ci.org/karafka/karafka-sidekiq-backend)
 [![Join the chat at https://gitter.im/karafka/karafka](https://badges.gitter.im/karafka/karafka.svg)](https://gitter.im/karafka/karafka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[Karafka Sidekiq Backend](https://github.com/karafka/karafka-sidekiq-backend) provides support for consuming (processing) received Kafka messages inside of Sidekiq workers.
+[Karafka Sidekiq Backend](https://github.com/karafka/sidekiq-backend) provides support for consuming (processing) received Kafka messages inside of Sidekiq workers.
 
 ## Installations
 
@@ -47,7 +47,7 @@ App.routes.draw do
     topic :binary_video_details do
       controller Videos::DetailsController
       worker Workers::DetailsWorker
-      interchanger Interchangers::Binary
+      interchanger Interchangers::MyCustomInterchanger
     end
   end
 end
@@ -62,7 +62,7 @@ There are two options you can set inside of the ```topic``` block:
 | Option       | Value type | Description                                                                                                       |
 |--------------|------------|-------------------------------------------------------------------------------------------------------------------|
 | worker       | Class      | Name of a worker class that we want to use to schedule perform code                                               |
-| interchanger | Class      | Name of a parser class that we want to use to parse incoming data                                                 |
+| interchanger | Class      | Name of an interchanger class that we want to use to pass the incoming data to Sidekiq                            |
 
 
 ### Workers

data/karafka-sidekiq-backend.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'karafka/backends/sidekiq'
 
@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.description = 'Karafka Sidekiq backend for background messages processing'
   spec.license     = 'MIT'
 
-  spec.add_dependency 'karafka', '>= 1.2.0.beta2'
+  spec.add_dependency 'karafka', '>= 1.2.0.beta4'
   spec.add_dependency 'sidekiq', '>= 4.2'
   spec.required_ruby_version = '>= 2.3.0'
 

data/lib/karafka-sidekiq-backend.rb

@@ -17,7 +17,7 @@ module Karafka
       class << self
         # @return [String] path to Karafka gem root core
         def core_root
-          Pathname.new(File.expand_path('../karafka', __FILE__))
+          Pathname.new(File.expand_path('karafka', __dir__))
         end
       end
     end

data/lib/karafka/backends/sidekiq.rb

@@ -5,7 +5,7 @@ module Karafka
     # Sidekiq backend that schedules stuff to Sidekiq worker for delayed execution
     module Sidekiq
       # Karafka Sidekiq backend version
-      VERSION = '1.2.0.beta3'
+      VERSION = '1.2.0.beta4'
 
       # Enqueues the execution of perform method into a worker.
       # @note Each worker needs to have a class #perform_async method that will allow us to pass

data/lib/karafka/interchanger.rb

@@ -8,25 +8,26 @@ module Karafka
   #   - encode - it is meant to encode params before they get stored inside Redis
   #   - decode - decoded params back to a hash format that we can use
   #
-  # This interchanger is not the fastets but it handles many unusual cases and deals well with
-  # more complex Ruby and Rails objects
+  # This interchanger uses default Sidekiq options to exchange data
+  # @note Since we use symbols for Karafka params (performance reasons), they will be
+  #   deserialized into string versions. Keep that in mind.
   class Interchanger
     class << self
       # @param params_batch [Karafka::Params::ParamsBatch] Karafka params batch object
-      # @note Params might not be parsed because of lazy loading feature. If you implement your
-      #   own interchanger logic, this method needs to return data that can be converted to
-      #   json with default Sidekiqs logic
-      # @return [String] parsed params batch encoded into a string. There are too many problems
+      # @return [Karafka::Params::ParamsBatch] parsed params batch. There are too many problems
       #   with passing unparsed data from Karafka to Sidekiq, to make it a default. In case you
       #   need this, please implement your own interchanger.
       def encode(params_batch)
-        Base64.encode64(Marshal.dump(params_batch.parsed))
+        params_batch.parsed
       end
 
-      # @param params_batch [String] Encoded params batch string that we use to rebuild params
-      # @return [Karafka::Params::ParamsBatch] rebuilt params batch
+      # @param params_batch [Array<Hash>] Sidekiq params that are now an array
+      # @note Since Sidekiq does not like symbols, we restore symbolized keys for system keys, so
+      #   everything can work as expected. Keep in mind, that custom data will always be assigned
+      #   with string keys per design. To change it, please change this interchanger and create
+      #   your own custom parser
       def decode(params_batch)
-        Marshal.load(Base64.decode64(params_batch))
+        params_batch
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: karafka-sidekiq-backend
 version: !ruby/object:Gem::Version
-  version: 1.2.0.beta3
+  version: 1.2.0.beta4
 platform: ruby
 authors:
 - Maciej Mensfeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0.beta2
+        version: 1.2.0.beta4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0.beta2
+        version: 1.2.0.beta4
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement