karafka-sidekiq-backend 1.0.0.pre1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb7035c44bd2a5c8ed71073da1b0ea7ccf962027
-  data.tar.gz: be6d7a538ce48a5334ae4f8f5cc249ad8053446c
+  metadata.gz: ac35518405825e475629928acad62fb4c971148b
+  data.tar.gz: 03db71a6d95e1f7eda063311c84b5f9383290f45
 SHA512:
-  metadata.gz: 8d4cc805a0715bb35a54c5b7a960010ac56bab5883b32eed70f6f8d08b4edba543473a6c695bc79548234484bf079b4c295caecaf7370024d27a07633fa22ce7
-  data.tar.gz: 64fd8c8dd2257cc8b4a7738ef09031c70aaae6141d6016b82dd1d2ae422ff3b1904a01cb314ca383358220ffbd6e032468902c550890efd60da27ae2eaae15dc
+  metadata.gz: 4a55f875872e7988bff3b4d97ad5828bb8e1766d1329cdaaad2312e08005d7bc1f55065d5a37cc0fd8f0dbc46d19a6ac1743067f1e9ed1d11264624003e1a345
+  data.tar.gz: a912aa6c87ef62998f444f23e2c4970400806c9ddb91f530ce8845e0bc6d3c781b03e9eaa4898e4e5e32c43a47ef5b3b812bff3dba3551a0057f36d88460d0d7

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    karafka-sidekiq-backend (1.0.0.pre1)
-      karafka (>= 1.0.0.pre1)
+    karafka-sidekiq-backend (1.0.0)
+      karafka (>= 1.0.0)
       sidekiq (>= 4.2)
 
 GEM
@@ -67,7 +67,7 @@ GEM
     i18n (0.8.6)
     inflecto (0.0.2)
     json (2.1.0)
-    karafka (1.0.0.rc1)
+    karafka (1.0.0)
       activesupport (>= 5.0)
       celluloid
       dry-configurable (~> 0.7)
@@ -80,7 +80,7 @@ GEM
       thor (~> 0.19)
       waterdrop (>= 0.4)
     minitest (5.10.3)
-    multi_json (1.12.1)
+    multi_json (1.12.2)
     null-logger (0.1.4)
     rack (2.0.3)
     rack-protection (2.0.0)

data/README.md

@@ -1,8 +1,9 @@
 # Karafka Sidekiq Backend
 
 [![Build Status](https://travis-ci.org/karafka/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 provides support for processing received Kafka messages inside of Sidekiq workers.
+[Karafka Sidekiq Backend](https://github.com/karafka/karafka-sidekiq-backend) provides support for processing received Kafka messages inside of Sidekiq workers.
 
 ## Installations
 
@@ -21,7 +22,7 @@ end
 
 and you are ready to go. Karafka Sidekiq Backend integrates with Karafka automatically
 
-Note: You can name your application worker base class with any name you want. The only thing that is required is a direct inheritance from the ```Karafka::BaseWorker``` class.
+**Note**: You can name your application worker base class with any name you want. The only thing that is required is a direct inheritance from the ```Karafka::BaseWorker``` class.
 
 ## Usage
 
@@ -112,3 +113,30 @@ topic :binary_video_details do
   interchanger Base64Interchanger
 end
 ```
+
+## References
+
+* [Karafka framework](https://github.com/karafka/karafka)
+* [Karafka Sidekiq Backend Travis CI](https://travis-ci.org/karafka/karafka-sidekiq-backend)
+* [Karafka Sidekiq Backend Coditsu](https://app.coditsu.io/karafka/repositories/karafka-sidekiq-backend)
+
+## Note on Patches/Pull Requests
+
+Fork the project.
+Make your feature addition or bug fix.
+Add tests for it. This is important so we don't break it in a future versions unintentionally.
+Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull). Send me a pull request. Bonus points for topic branches.
+
+[![coditsu](https://coditsu.io/assets/quality_bar.svg)](https://app.coditsu.io/karafka/repositories/karafka-sidekiq-backend)
+
+Each pull request must pass our quality requirements. To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combinse multiple linters and code analyzers for both code and documentation.
+
+Unfortunately, it does not yet support independent forks, however you should be fine by looking at what we require.
+
+Please run:
+
+```bash
+bundle exec rake
+```
+
+to check if everything is in order. After that you can submit a pull request.

data/karafka-sidekiq-backend.gemspec

@@ -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.0.0.pre1'
+  spec.add_dependency 'karafka', '>= 1.0.0'
   spec.add_dependency 'sidekiq', '>= 4.2'
   spec.required_ruby_version = '>= 2.3.0'
 

data/lib/karafka/backends/sidekiq.rb

@@ -4,7 +4,8 @@ module Karafka
   module Backends
     # Sidekiq backend that schedules stuff to Sidekiq worker for delayed execution
     module Sidekiq
-      VERSION = '1.0.0.pre1'
+      # Karafka Sidekiq backend version
+      VERSION = '1.0.0'
 
       private
 

data/lib/karafka/extensions/sidekiq_attributes_map.rb

@@ -2,13 +2,20 @@
 
 module Karafka
   module Extensions
+    # Additional Karafka::Attributes map topic attributes that can be used when worker
+    # is active and we use sidekiq backend
     module SidekiqAttributesMap
+      # Class methods that extend the attributes map class
       module ClassMethods
+        # Extra topic fields that we need to have to work with sidekiq backend
+        # @return [Array<Symbol>] available topic options
         def topic
           super + %i[interchanger worker]
         end
       end
 
+      # Prepends class methods into attributes map
+      # @param base [Class] class that we prepend to
       def self.prepended(base)
         class << base
           prepend ClassMethods

data/lib/karafka/extensions/sidekiq_topic_attributes.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 module Karafka
+  # Namespace for additional extensions that we include into some Karafka components, to gain
+  # extra features that we require
   module Extensions
+    # Additional Karafka::Routing::Topic methods that are required to work with Sidekiq backend
     module SidekiqTopicAttributes
       # @return [Class] Class (not an instance) of a worker that should be used to schedule the
       #   background job
@@ -14,6 +19,8 @@ module Karafka
         @interchanger ||= Karafka::Interchanger
       end
 
+      # Creates attributes writers for worker and interchanger, so they can be overwritten
+      # @param base [Class] Karafka::Routing::Topic class
       def self.included(base)
         base.send :attr_writer, :worker
         base.send :attr_writer, :interchanger

data/lib/karafka/interchanger.rb

@@ -9,24 +9,24 @@ module Karafka
   #   - parse - decoded params back to a hash format that we can use
   class Interchanger
     class << self
-      # @param params [Karafka::Params::Params] Karafka params object
+      # @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 [Karafka::Params::Params] same as input. We assume that our incoming data is
+      # @return [Karafka::Params::ParamsBatch] same as input. We assume that our incoming data is
       #   jsonable-safe and we can rely on a direct Sidekiq encoding logic
-      def load(params)
-        params
+      def load(params_batch)
+        params_batch
       end
 
-      # @param params [Hash] Sidekiqs params that are now a Hash (after they were JSON#parse)
+      # @param params_batch [Hash] Sidekiqs params that are now a Hash (after they were JSON#parse)
       # @note Hash is what we need to build Karafka::Params::Params, so we do nothing
       #   with it. If you implement your own interchanger logic, this method needs to return
       #   a hash with appropriate data that will be used to build Karafka::Params::Params
       # @return [Hash] We return exactly what we received. We rely on sidekiqs default
       #   interchanging format
-      def parse(params)
-        params
+      def parse(params_batch)
+        params_batch
       end
     end
   end

data/lib/karafka-sidekiq-backend.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 %w[
+  karafka
   sidekiq
 ].each(&method(:require))
 
+# Karafka framework namespace
 module Karafka
+  # Namespace for all the backends that process data
   module Backends
+    # Sidekiq Karafka backend
     module Sidekiq
       class << self
         # @return [String] path to Karafka gem root core
@@ -17,4 +21,5 @@ module Karafka
   end
 end
 
+# Uses Karafka loader to load all the sources that this backend needs
 Karafka::Loader.load!(Karafka::Backends::Sidekiq.core_root)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: karafka-sidekiq-backend
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre1
+  version: 1.0.0
 platform: ruby
 authors:
 - Maciej Mensfeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2017-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -81,9 +81,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.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.6.13