phobos_db_checkpoint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7eed2349cc4d3b82e46efd24c3689b4ea7b6d168
+  data.tar.gz: ea0c58b7e369b9533f10e14bd6869ebdbcd3fad7
+SHA512:
+  metadata.gz: 8d16920bea6ffd2378dbb1041ad55ef47b6224e071b684e6cd636b35ed3235bf5c3415a6d9c5d30349e4b2c2a39377eacba4778059e52734c2dde08b9300d4a9
+  data.tar.gz: 841e2434154e57bd8b8c4fd1bc19a7640863d2233fbe378267fd25f88e08773b42639f1981dda459370786b962b2e2256ccc9d447af72c48159e9aa873c9be9b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/tmp/
+.DS_Store
+spec/examples.txt
+spec/setup/
+spec/tmp/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phobos_db_checkpoint.gemspec
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,156 @@
+![CircleCI](https://circleci.com/gh/klarna/phobos_db_checkpoint/tree/master.svg?style=shield&circle-token=a69fda09f130a862b69f6a7e8be834f884829ccd)
+
+# Phobos DB Checkpoint
+
+Phobos DB Checkpoint is a plugin to [Phobos](https://github.com/klarna/phobos) and is meant as a drop in replacement to `Phobos::Handler`, extending it with the following features:
+ * Persists your Kafka events to an active record compatible database
+ * Ensures that your [handler](https://github.com/klarna/phobos#usage-consuming-messages-from-kafka) will consume messages only once
+ * Allows your system to quickly reprocess events in case of failures
+
+## Table of Contents
+
+1. [Installation](#installation)
+1. [Usage](#usage)
+  1. [Setup](#setup)
+  1. [Handler](#handler)
+  1. [Accessing the events](#accessing-the-events)
+  1. [Instrumentation](#instrumentation)
+1. [Development](#development)
+
+## <a name="installation"></a> Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'phobos_db_checkpoint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phobos_db_checkpoint
+
+## <a name="usage"></a> Usage
+
+The main idea of Phobos DB Checkpoint is to replace the default handler `Phobos::Handler` with `PhobosDBCheckpoint::Handler`.
+
+In order to use it, you have to [setup the database](#setup) and [switch your handler](#handler) to use the `PhobosDBCheckpoint::Handler` instead.
+
+### <a name="setup"></a> Setup
+
+Phobos DB Checkpoint exposes a CLI to help you setup your project, assuming an [already configured phobos project](https://github.com/klarna/phobos#usage-standalone-apps). Example:
+
+```sh
+# run this command inside your app directory
+$ phobos_db_checkpoint init
+      create  Rakefile
+     prepend  Rakefile
+      create  config/database.yml
+      create  db/migrate/20160825183351479299_phobos_01_create_events.rb
+      append  phobos_boot.rb
+```
+
+The __init__ command will generate the base migrations, an example of `database.yml`, and add the default configuration into `phobos_boot.rb` and `Rakefile` for your convenience.
+
+After this, your app should have access to all db tasks.
+
+```sh
+$ rake -T
+    rake db:create              # Creates the database from DATABASE_URL or config/database.yml for the current RAILS_ENV (use db:create:all to create all ...
+    rake db:drop                # Drops the database from DATABASE_URL or config/database.yml for the current RAILS_ENV (use db:drop:all to drop all databa...
+    rake db:environment:set     # Set the environment value for the database
+    rake db:fixtures:load       # Loads fixtures into the current environment's database
+    rake db:migrate             # Migrate the database (options: VERSION=x, VERBOSE=false, SCOPE=blog)
+    rake db:migrate:status      # Display status of migrations
+    rake db:rollback            # Rolls the schema back to the previous version (specify steps w/ STEP=n)
+    rake db:schema:cache:clear  # Clears a db/schema_cache.dump file
+    rake db:schema:cache:dump   # Creates a db/schema_cache.dump file
+    rake db:schema:dump         # Creates a db/schema.rb file that is portable against any DB supported by Active Record
+    rake db:schema:load         # Loads a schema.rb file into the database
+    rake db:seed                # Loads the seed data from db/seeds.rb
+    rake db:setup               # Creates the database, loads the schema, and initializes with the seed data (use db:reset to also drop the database first)
+    rake db:structure:dump      # Dumps the database structure to db/structure.sql
+    rake db:structure:load      # Recreates the databases from the structure.sql file
+    rake db:version             # Retrieves the current schema version number
+```
+
+##### Note
+
+You can always re-generate the base migrations using the command __copy-migrations__, example:
+
+```sh
+$ phobos_db_checkpoint copy-migrations
+      exists  phobos_01_create_events.rb
+```
+
+This command has no side effects, if the migration is already present it will ignore it.
+
+### <a name="handler"></a> Handler
+
+In order to use the database checkpointing, your handler should be changed to include `PhobosDBCheckpoint::Handler` instead of `Phobos::Handler`. Phobos DB Checkpoint handler uses the Phobos `around_consume` functionality, which means you need to implement a `#consume` method to handle the event.
+
+Since Phobos DB Checkpoint will only save acknowledged events, you need to return from `#consume` with an invocation to `#ack` with the __entity_id__ and __event_time__ of your event. Example:
+
+```ruby
+class MyHandler
+  include PhobosDBCheckpoint::Handler
+
+  def consume(payload, metadata)
+    my_event = JSON.parse(payload)
+    # <-- your logic (which possibly skips messages) here
+    ack(my_event['id'], Time.now)
+  end
+end
+```
+
+If your handler returns anything different than an __ack__ it won't be saved to the database.
+
+Note that the `PhobosDBCheckpoint::Handler` will automatically skip already handled events (i.e. duplicate Kafka messages).
+
+### <a name="accessing-the-events">Accessing the events</a>
+
+`PhobosDBCheckpoint::Event` is a plain `ActiveRecord::Base` model, feel free to play with it.
+
+### <a name="instrumentation"></a> Instrumentation
+
+Some operations are instrumented using [Phobos::Instrumentation](https://github.com/klarna/phobos#usage-instrumentation)
+
+#### Handler notifications
+
+Overview of the built in notifications:
+  * `db_checkpoint.event_acknowledged` is sent when the event is acknowledged (saved)
+  * `db_checkpoint.event_skipped` is sent when the event is skipped (not saved)
+  * `db_checkpoint.event_already_consumed` is sent when the handler receives an existing message (not saved)
+
+The following payload is included for all notifications:
+  * listener_id
+  * group_id
+  * topic
+  * key
+  * partition
+  * offset
+  * retry_count
+  * checksum
+
+## <a name="development"></a> Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` to run the tests.
+
+To install this gem in your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/klarna/phobos_db_checkpoint.
+
+## License
+
+Copyright 2016 Klarna
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+
+You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'phobos_db_checkpoint'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/phobos_db_checkpoint

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'phobos_db_checkpoint'
+require 'phobos_db_checkpoint/cli'
+
+STDOUT.sync = true
+PhobosDBCheckpoint::CLI::Commands.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,29 @@
+machine:
+  pre:
+    - curl -sSL https://s3.amazonaws.com/circle-downloads/install-circleci-docker.sh | bash -s -- 1.10.0
+  services:
+    - docker
+  environment:
+    LOG_LEVEL: DEBUG
+    CI: true
+  ruby:
+    version: 2.3.1
+
+# Ignores circle ci default database setup
+database:
+  override:
+    - echo "overrides circle CI commands"
+
+dependencies:
+  pre:
+    - docker -v
+    - docker pull postgres:9.5.4
+    - gem install bundler -v 1.9.5
+    - bundle install
+
+test:
+  override:
+    - docker run -d -p 5432:5432 --name db postgres; sleep 5
+    - bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/unit.xml
+  post:
+    - cp log/*.log $CIRCLE_ARTIFACTS/ || true

data/lib/phobos_db_checkpoint.rb

@@ -0,0 +1,51 @@
+require 'yaml'
+require 'digest'
+require 'active_record'
+require 'phobos'
+
+require 'phobos_db_checkpoint/version'
+require 'phobos_db_checkpoint/event_actions'
+require 'phobos_db_checkpoint/event'
+require 'phobos_db_checkpoint/handler'
+
+module PhobosDBCheckpoint
+  DEFAULT_DB_DIR = 'db'.freeze
+  DEFAULT_MIGRATION_PATH = File.join(DEFAULT_DB_DIR, 'migrate').freeze
+  DEFAULT_DB_CONFIG_PATH = 'config/database.yml'.freeze
+
+  class << self
+    attr_reader :db_config
+    attr_accessor :db_config_path, :db_dir, :migration_path
+
+    def configure
+      load_db_config
+      at_exit { PhobosDBCheckpoint.close_db_connection }
+      ActiveRecord::Base.establish_connection(db_config)
+    end
+
+    def env
+      ENV['RAILS_ENV'] ||= ENV['RACK_ENV'] ||= 'development'
+    end
+
+    def load_db_config
+      @db_config_path ||= DEFAULT_DB_CONFIG_PATH
+      configs = YAML.load_file(File.expand_path(@db_config_path))
+      @db_config = configs[env]
+    end
+
+    def close_db_connection
+      connection = ActiveRecord::Base.connection
+      connection.disconnect! if connection
+    rescue ActiveRecord::ConnectionNotEstablished
+    end
+
+    def load_tasks
+      @db_dir ||= DEFAULT_DB_DIR
+      @migration_path ||= DEFAULT_MIGRATION_PATH
+      ActiveRecord::Tasks::DatabaseTasks.send(:define_method, :db_dir) { PhobosDBCheckpoint.db_dir }
+      ActiveRecord::Tasks::DatabaseTasks.send(:define_method, :migrations_paths) { [PhobosDBCheckpoint.migration_path] }
+      ActiveRecord::Tasks::DatabaseTasks.send(:define_method, :env) { PhobosDBCheckpoint.env }
+      require 'phobos_db_checkpoint/tasks'
+    end
+  end
+end

data/lib/phobos_db_checkpoint/cli.rb

@@ -0,0 +1,95 @@
+require 'thor'
+require 'fileutils'
+
+module PhobosDBCheckpoint
+  module CLI
+
+    class Commands < Thor
+      include Thor::Actions
+
+      map '-v' => :version
+      map '--version' => :version
+
+      desc 'version', 'Outputs the version number. Can be used with: phobos_db_checkpoint -v or phobos_db_checkpoint --version'
+      def version
+        puts PhobosDBCheckpoint::VERSION
+      end
+
+      desc 'init', 'Initialize your project with PhobosDBCheckpoint'
+      def init
+        create_file('Rakefile') unless File.exist?(File.join(destination_root, 'Rakefile'))
+        prepend_to_file 'Rakefile', "require 'phobos_db_checkpoint'\nPhobosDBCheckpoint.load_tasks\n"
+        copy_file 'templates/database.yml.example', 'config/database.yml'
+
+        cmd = self.class.new
+        cmd.destination_root = destination_root
+        cmd.invoke(:copy_migrations)
+
+        create_file('phobos_boot.rb') unless File.exist?(File.join(destination_root, 'phobos_boot.rb'))
+        append_to_file 'phobos_boot.rb', File.read(phobos_boot_template)
+      end
+
+      desc 'copy-migrations', 'Copy required migrations to the project'
+      option :destination,
+             aliases: ['-d'],
+             default: 'db/migrate',
+             banner: 'Destination folder relative to your project'
+      def copy_migrations
+        destination_fullpath = File.join(destination_root, options[:destination])
+        generated_migrations = list_migrations(destination_fullpath)
+        FileUtils.mkdir_p(destination_fullpath)
+
+        template_migrations_metadata.each do |metadata|
+
+          if migration_exists?(generated_migrations, metadata[:name])
+            say_status('exists', metadata[:name])
+
+          else
+            file_path = File.join(options[:destination], "#{metadata[:number]}_#{metadata[:name]}")
+            template_path = File.join('templates/migrate', metadata[:path])
+            template(template_path, file_path)
+          end
+
+        end
+      end
+
+      def self.source_root
+        File.expand_path(File.join(File.dirname(__FILE__), '../..'))
+      end
+
+      private
+      def migration_exists?(list, name)
+        list.find { |filename| filename =~ /#{name}/ }
+      end
+
+      def template_migrations_metadata
+        @template_migrations_metadata ||= begin
+          index = 0
+          template_migrations.map do |path|
+            number = [Time.now.utc.strftime('%Y%m%d%H%M%S%6N'), '%.21d' % index].max
+            name = path.split('/').last
+            index += 1
+            {path: path, name: path.gsub(/\.erb$/, ''), number: number}
+          end
+        end
+      end
+
+      def template_migrations
+        @template_migrations ||= list_migrations(migrations_template_dir)
+      end
+
+      def list_migrations(dir)
+        return [] unless Dir.exist?(dir)
+        Dir.entries(dir).select {|f| f =~ /\.rb(\.erb)?$/}
+      end
+
+      def migrations_template_dir
+        File.join(self.class.source_root, 'templates/migrate')
+      end
+
+      def phobos_boot_template
+        File.join(self.class.source_root, 'templates/phobos_boot.rb')
+      end
+    end
+  end
+end

data/lib/phobos_db_checkpoint/event.rb

@@ -0,0 +1,23 @@
+module PhobosDBCheckpoint
+  class Event < ActiveRecord::Base
+    after_initialize :assign_checksum
+
+    def exists?
+      Event.where(topic: topic, group_id: group_id, checksum: checksum).exists?
+    end
+
+    def acknowledge!(ack)
+      self.entity_id = ack.entity_id
+      self.event_time = ack.event_time
+      self.event_type = ack.event_type
+      self.event_version = ack.event_version
+      save!
+    end
+
+    private
+
+    def assign_checksum
+      self.checksum ||= Digest::MD5.hexdigest(payload.to_json) if payload
+    end
+  end
+end

data/lib/phobos_db_checkpoint/event_actions.rb

@@ -0,0 +1,3 @@
+module PhobosDBCheckpoint
+  Ack = Struct.new(:entity_id, :event_time, :event_type, :event_version)
+end

data/lib/phobos_db_checkpoint/handler.rb

@@ -0,0 +1,41 @@
+module PhobosDBCheckpoint
+  module Handler
+    include Phobos::Handler
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def ack(entity_id, event_time, event_type = nil, event_version = nil)
+      PhobosDBCheckpoint::Ack.new(entity_id, event_time, event_type, event_version)
+    end
+
+    module ClassMethods
+      include Phobos::Instrumentation
+
+      def around_consume(payload, metadata)
+        event = PhobosDBCheckpoint::Event.new(
+          topic: metadata[:topic],
+          group_id: metadata[:group_id],
+          payload: payload
+        )
+
+        event_metadata = {checksum: event.checksum}.merge(metadata)
+        if event.exists?
+          instrument('db_checkpoint.event_already_consumed', event_metadata)
+          return
+        end
+
+        event_action = yield
+        case event_action
+        when PhobosDBCheckpoint::Ack
+          instrument('db_checkpoint.event_acknowledged', event_metadata) do
+            event.acknowledge!(event_action)
+          end
+        else
+          instrument('db_checkpoint.event_skipped', event_metadata)
+        end
+      end
+    end
+  end
+end

data/lib/phobos_db_checkpoint/tasks.rb

@@ -0,0 +1,22 @@
+require 'rake'
+
+module PhobosDBCheckpoint
+  module Tasks
+    extend Rake::DSL if defined? Rake::DSL
+
+    namespace :db do
+      task :environment do
+        PhobosDBCheckpoint.configure
+      end
+
+      task :load_config do
+        PhobosDBCheckpoint.load_db_config
+        task_db_config = Hash[PhobosDBCheckpoint.env, PhobosDBCheckpoint.db_config]
+        ActiveRecord::Tasks::DatabaseTasks.database_configuration = task_db_config
+      end
+    end
+
+    load 'active_record/railties/databases.rake'
+
+  end
+end

data/lib/phobos_db_checkpoint/version.rb

@@ -0,0 +1,3 @@
+module PhobosDBCheckpoint
+  VERSION = '0.1.0'
+end

data/phobos_db_checkpoint.gemspec

@@ -0,0 +1,57 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phobos_db_checkpoint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'phobos_db_checkpoint'
+  spec.version       = PhobosDBCheckpoint::VERSION
+  spec.authors       = [
+    'Túlio Ornelas',
+    'Mathias Klippinge',
+    'Sergey Evstifeev',
+    'Thiago R. Colucci',
+    'Martin Svalin',
+    'Francisco Juan'
+  ]
+  spec.email         = [
+    'ornelas.tulio@gmail.com',
+    'mathias.klippinge@gmail.com',
+    'sergey.evstifeev@gmail.com',
+    'ticolucci@gmail.com',
+    'martin@lite.nu',
+    'francisco.juan@gmail.com'
+  ]
+
+  spec.summary       = %q{Phobos DB Checkpoint is a plugin to Phobos and is meant as a drop in replacement to Phobos::Handler}
+  spec.description   = %q{Phobos DB Checkpoint is a plugin to Phobos and is meant as a drop in replacement to Phobos::Handler}
+  spec.homepage      = "https://github.com/klarna/phobos_db_checkpoint"
+  spec.license       = 'Apache License Version 2.0'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/phobos_db_checkpoint}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'rspec_junit_formatter', '0.2.2'
+
+  spec.add_dependency 'thor'
+  spec.add_dependency 'rake'
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_dependency 'phobos', '>= 1.0.0'
+end

data/templates/database.yml.example

@@ -0,0 +1,11 @@
+development: &default
+  adapter: postgresql
+  encoding: unicode
+  database: phobos-db-checkpoint
+  user: postgres
+  host: localhost
+  port: 5432
+
+test: &test
+  <<: *default
+  database: phobos-db-checkpoint-test

data/templates/migrate/phobos_01_create_events.rb.erb

@@ -0,0 +1,20 @@
+class Phobos01CreateEvents < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def up
+    create_table :events do |t|
+      t.string    :topic,         index: true
+      t.string    :group_id,      index: true
+      t.string    :entity_id,     index: true
+      t.timestamp :event_time,    index: true
+      t.string    :event_type,    index: true
+      t.string    :event_version, index: true
+      t.string    :checksum,      index: true
+      t.json      :payload
+    end
+
+    add_index :events, [:topic, :group_id, :checksum]
+  end
+
+  def down
+    drop_table :events
+  end
+end

data/templates/phobos_boot.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'phobos_db_checkpoint'
+PhobosDBCheckpoint.configure
+PhobosDBCheckpoint.load_tasks
+Rake.application['db:create'].invoke
+Rake.application['db:migrate'].invoke

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: phobos_db_checkpoint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Túlio Ornelas
+- Mathias Klippinge
+- Sergey Evstifeev
+- Thiago R. Colucci
+- Martin Svalin
+- Francisco Juan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: phobos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Phobos DB Checkpoint is a plugin to Phobos and is meant as a drop in
+  replacement to Phobos::Handler
+email:
+- ornelas.tulio@gmail.com
+- mathias.klippinge@gmail.com
+- sergey.evstifeev@gmail.com
+- ticolucci@gmail.com
+- martin@lite.nu
+- francisco.juan@gmail.com
+executables:
+- phobos_db_checkpoint
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/phobos_db_checkpoint
+- bin/setup
+- circle.yml
+- lib/phobos_db_checkpoint.rb
+- lib/phobos_db_checkpoint/cli.rb
+- lib/phobos_db_checkpoint/event.rb
+- lib/phobos_db_checkpoint/event_actions.rb
+- lib/phobos_db_checkpoint/handler.rb
+- lib/phobos_db_checkpoint/tasks.rb
+- lib/phobos_db_checkpoint/version.rb
+- phobos_db_checkpoint.gemspec
+- templates/database.yml.example
+- templates/migrate/phobos_01_create_events.rb.erb
+- templates/phobos_boot.rb
+homepage: https://github.com/klarna/phobos_db_checkpoint
+licenses:
+- Apache License Version 2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Phobos DB Checkpoint is a plugin to Phobos and is meant as a drop in replacement
+  to Phobos::Handler
+test_files: []