phobos_db_checkpoint 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb0abf033362b2d16951eea469a851873acbc863
-  data.tar.gz: 6f92192149a9ee9cbf82895c6f13329b4a87b032
+  metadata.gz: 58180a350edfdb0adf597bb4851c4673fb465dde
+  data.tar.gz: f598d60bce1c73e3a63730d3fce89fe61dedb697
 SHA512:
-  metadata.gz: 54b57b7d287df8fa95916abde5284658c2831588db59863166e8b54061067bde199e6338c251387f72434c1535924038db0a14739523904c3d2878112dc7069d
-  data.tar.gz: 4ec9fda62d8e9e2d74f7ef4db0b94c7e7d983797484d1cafd30911384bae9b1a9c9baa41de76cbe04e2704b1da1c38d201caca61e567e47684d6e765ce959f2f
+  metadata.gz: e12c26c2e3d42820ce8ba9278a4952b87f7702a1f58f45d4cba547026479ed8e82948ad8e8d67b01ee010e45737384d641c10f5266eae2e231ea2cb59195197b
+  data.tar.gz: 3cd6e4ffa88191fc70eb8fef38808fcc4bb8a86fb37ed7f315372a11988f0ce881d123cc359fcf5b922e844d733a96933ad50b0b9a3b69434b0335e12a03029a

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 3.3.0 (2017-10-26)
+
+- [enhancement] Bump Phobos version to 1.5.0 to better support Avro. #34
+
 ## 3.2.0 (2017-10-23)
 
 - [enhancement] Make pool_size only configurable through configuration files

data/README.md

@@ -14,6 +14,7 @@ Phobos DB Checkpoint is a plugin to [Phobos](https://github.com/klarna/phobos) a
 1. [Usage](#usage)
   1. [Setup](#setup)
   1. [Handler](#handler)
+    1. [Payload](#payload)
     1. [Failures](#failures)
   1. [Accessing the events](#accessing-the-events)
   1. [Events API](#events-api)
@@ -121,6 +122,27 @@ If your handler returns anything different than an __ack__ it won't be saved to
 
 Note that the `PhobosDBCheckpoint::Handler` will automatically skip already handled events (i.e. duplicate Kafka messages).
 
+#### <a name="payload"></a> Payload
+PhobosDBCheckpoint assumes that the payload received from Phobos is in a JSON format. This means that if your payload is in any other format, for example Avro binary, you need to convert/decode it to JSON.
+
+To achieve this you can override the `#before_consume` method of the handler:
+
+```ruby
+class MyHandler
+  include PhobosDBCheckpoint::Handler
+
+  # <-- setup @avro before
+
+  def before_consume(payload)
+    @avro.decode(payload)
+  end
+
+  def consume(payload, metadata)
+    # <-- consume your stuff with the decoded payload
+  end
+end
+```
+
 #### <a name="failures"></a> Failures
 
 If your handler fails during the process of consuming the event, the event will be processed again acknowledged or skipped. The default behavior of `Phobos` is to back off but keep retrying the same event forever, in order to guarantee messages are processed in the correct order. However, this blocking process could go on indefinitely, so in order to help you deal with this PhobosDBCheckpoint can (on an opt-in basis) mark them as permanently failed after a configurable number of attempts.

data/lib/phobos_db_checkpoint/version.rb

@@ -1,3 +1,3 @@
 module PhobosDBCheckpoint
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

data/phobos_db_checkpoint.gemspec

@@ -12,7 +12,8 @@ Gem::Specification.new do |spec|
     'Sergey Evstifeev',
     'Thiago R. Colucci',
     'Martin Svalin',
-    'Francisco Juan'
+    'Francisco Juan',
+    'Tommy Gustafsson'
   ]
   spec.email         = [
     'ornelas.tulio@gmail.com',
@@ -20,7 +21,8 @@ Gem::Specification.new do |spec|
     'sergey.evstifeev@gmail.com',
     'ticolucci@gmail.com',
     'martin@lite.nu',
-    'francisco.juan@gmail.com'
+    'francisco.juan@gmail.com',
+    'tommydgustafsson@gmail.com'
   ]
 
   spec.summary       = %q{Phobos DB Checkpoint is a plugin to Phobos and is meant as a drop in replacement to Phobos::Handler}
@@ -56,6 +58,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor'
   spec.add_dependency 'rake'
   spec.add_dependency 'activerecord', '>= 4.0.0'
-  spec.add_dependency 'phobos', '>= 1.0.0'
+  spec.add_dependency 'phobos', '>= 1.5.0'
   spec.add_dependency 'sinatra'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos_db_checkpoint
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -10,10 +10,11 @@ authors:
 - Thiago R. Colucci
 - Martin Svalin
 - Francisco Juan
+- Tommy Gustafsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -203,14 +204,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +235,7 @@ email:
 - ticolucci@gmail.com
 - martin@lite.nu
 - francisco.juan@gmail.com
+- tommydgustafsson@gmail.com
 executables:
 - phobos_db_checkpoint
 extensions: []
@@ -241,6 +243,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -294,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Phobos DB Checkpoint is a plugin to Phobos and is meant as a drop in replacement