checker_jobs 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 569627ae057bbdab3fb84673e85d6ce258eaf9d2
+  data.tar.gz: 42a55e7dddba3a9f38e1e30253b8b97fed79b0b6
+SHA512:
+  metadata.gz: 1b6c2a2411701bca8753e401f86a303c9fb386355bd5a109786b0d566ba0822e9f9c67137e87d3aa31b7b3ac2cf27276848198bd3c6634ea9d984be806794cf2
+  data.tar.gz: 5260c70caea4009c8b297fccc6859de4616d470c8b0a8322f93e6d22bc1589b9189b25a6efa4df00171ab8cdcec2f57e5c9eb3fe1074db24163c35ce64676559

data/.circleci/config.yml

@@ -0,0 +1,48 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: drivy/rails-ci:0.1.2
+    steps:
+      - checkout
+
+      - run: git fetch origin --depth=1000
+
+      # Install CodeClimate test reporter binary, rebuild without cache to update the binary
+      - restore_cache:
+          key: cc_test_reporter
+      - run:
+          name: Install Code Climate test reporter
+          command: |
+            [ -f bin/cc-test-reporter ] || curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./bin/cc-test-reporter
+            chmod +x bin/cc-test-reporter
+      - restore_cache:
+          key: cc_test_reporter
+          paths:
+            - bin/cc-test-reporter
+
+      - run:
+          name: "Creating a Gemfile.lock without bundler's version"
+          command: "head -n -3 Gemfile.lock > Gemfile.lock.no-version"
+
+      # Bundle install with cache, Ignore bundler version
+      - restore_cache:
+          key: checker_jobs-{{ checksum "Gemfile.lock.no-version"}}
+      - run:
+          name: Install Ruby dependencies
+          command: bundle install --path vendor/bundle --jobs=`nproc`
+      - save_cache:
+          key: checker_jobs-{{ checksum "Gemfile.lock.no-version"}}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: RSpec
+          command: |
+            ./bin/cc-test-reporter before-build
+            bundle exec rspec --format documentation
+            ./bin/cc-test-reporter after-build --exit-code $?
+
+      - run:
+          name: Pronto
+          command: bin/pronto-ci

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.*.swp

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,61 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "examples/*.rb"
+
+#
+# Opinionated cops
+#
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 100
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+#
+# Disabled cops
+#
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockComments:
+  Exclude:
+    - "spec/spec_helper.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Style/Proc:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,207 @@
+PATH
+  remote: .
+  specs:
+    checker_jobs (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.4)
+      activesupport (= 5.1.4)
+      globalid (>= 0.3.6)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    byebug (9.1.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.1)
+    crass (1.0.3)
+    daemons (1.2.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    erubi (1.7.0)
+    eventmachine (1.2.5)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    gitlab (4.3.0)
+      httparty
+      terminal-table
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    haml (5.0.4)
+      temple (>= 0.8.0)
+      tilt
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    mailcatcher (0.2.4)
+      eventmachine
+      haml
+      i18n
+      json
+      mail
+      sinatra
+      skinny (>= 0.1.2)
+      sqlite3-ruby
+      thin
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    mustermann (1.0.2)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    octokit (4.8.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.12.1)
+    parser (2.5.0.5)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pronto (0.9.5)
+      gitlab (~> 4.0, >= 4.0.0)
+      httparty (>= 0.13.7)
+      octokit (~> 4.7, >= 4.7.0)
+      rainbow (~> 2.1)
+      rugged (~> 0.24, >= 0.23.0)
+      thor (~> 0.19.0)
+    pronto-rubocop (0.9.0)
+      pronto (~> 0.9.0)
+      rubocop (~> 0.38, >= 0.35.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    public_suffix (3.0.1)
+    rack (2.0.4)
+    rack-protection (2.0.1)
+      rack
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    redis (4.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.53.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.22.1)
+      rubocop (>= 0.52.1)
+    ruby-progressbar (1.9.0)
+    rugged (0.26.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    sidekiq (5.0.5)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.4, < 5)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    skinny (0.2.2)
+      eventmachine (~> 1.0)
+      thin
+    sqlite3 (1.3.13)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    temple (0.8.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionmailer (~> 5.0)
+  bundler (~> 1.13)
+  checker_jobs!
+  mailcatcher
+  pronto
+  pronto-rubocop
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  rubocop
+  rubocop-rspec
+  sidekiq (~> 5.0)
+  simplecov
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Drivy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,158 @@
+# CheckerJobs
+
+This gems provides a small DSL to check your data for inconsistencies.
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/7972bd0e4dc65329f5c6/maintainability)](https://codeclimate.com/github/drivy/checker_jobs/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7972bd0e4dc65329f5c6/test_coverage)](https://codeclimate.com/github/drivy/checker_jobs/test_coverage)
+
+## Introduction
+
+To ensure database integrity, DBMS provides some tools: foreign keys, triggers,
+strored procedures, ... Those tools aren't the easiests to maintain unless your
+project is based on them. Also, you may want to avoid to duplicate your business
+rules from your application to another language and add operational complexity
+around deployment.
+
+This gem doesn't aim to replace those tools but provides something else that
+could serve a close purpose: _ensure that you work with the data you expect_.
+
+This gem helps you schedule some verifications on your data and get alerts when
+something is unexpected. You declare checks that could contain any business code
+you like and then those checks are run by your application, in background jobs.
+
+A small DSL is provided to helps you express your predicates:
+
+- `ensure_no` will check that the result of a given block is `zero?` or `empty?`
+- `ensure_more` will check that the result of a given block is `>=` than a given number
+- `ensure_fewer` will check that the result of a given block is `<=` than a given number
+
+and an easy way to configure notifications.
+
+For instance, at Drivy we don't expect users to get a negative credit amount. It
+isn't easy to get all the validation right because many rules are in play here.
+Because of those rules the credit isn't just a column in our database yet but
+needs to be computed based on various parameters. What we would like to ensure is
+that _no one ends up with a negative credit_. We could write something like:
+
+``` ruby
+class UsersChecker
+  include CheckerJobs::Base
+
+  options sidekiq: { queue: :slow }
+
+  notify "oss@drivy.com"
+
+  ensure_no :negative_rental_credit do
+    # The following code is an over-simplification
+    # Real code is more performance oriented...
+
+    user_ids_with_negative_rental_credit = []
+
+    User.find_each do |user|
+      if user.credit_amount < 0
+        user_ids_with_negative_rental_credit << user.id
+      end
+    end
+
+    user_ids_with_negative_rental_credit
+  end
+end
+```
+
+Then when something's wrong, [you'll get alerted](https://cl.ly/3l2b3T3n0o2a).
+
+You'll find more use cases and tips in the [wiki](https://github.com/drivy/checker_jobs/wiki).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'checker_jobs'
+```
+
+## Usage
+
+Have a look at the `examples` directory of the repository to get a clearer idea
+about how to use and the gem is offering.
+
+### Configure
+
+At the moment this gems supports [Drivy][gh-drivy]'s stack which includes
+[Sidekiq][gh-sidekiq] and [Rails][rails]. It has been designed to supports more
+than Sidekiq a job processor and more that ActionMailer as a notification
+gateway. If you're on the same stack as we are, configuration looks like this:
+
+``` ruby
+require "checker_jobs"
+
+CheckerJobs.configure do |config|
+  config.repository_url = { github: "drivy/checker_jobs" }
+
+  config.jobs_processor = :sidekiq
+
+  config.emails_backend = :action_mailer
+  config.emails_options = { from: "oss@drivy.com", reply_to: "no-reply@drivy.com" }
+end
+
+```
+
+This piece of code usually goes into the `config/initializers/checker_jobs.rb`
+file in a rails application. It relies on the fact that ActionMailer and sidekiq
+are already configured.
+
+If you're on a different stack and you'll like to add a new job processor or
+notification backend in this gem, [drop us a line][d-jobs].
+
+### Write checkers
+
+A checker is a class that inherits `CheckerJobs::Base` and uses the
+[DSL](wiki/DSL) to declare checks.
+
+``` ruby
+class UserChecker
+  include CheckerJobs::Base
+
+  options sidekiq: { queue: :fast }
+
+  notify "tech@drivy.com"
+
+  ensure_no :user_without_email do
+    UserRepository.missing_email.size
+  end
+end
+```
+
+The `UserChecker` will have the same interface as your usual jobs. In this
+example, `UserChecker` will be a `Sidekiq::Worker`. Its `#perform` method will
+run the check named `:user_without_email` and if
+`UserRepository.missing_email.size` is greater than 0 then an email will be
+fired through ActionMailer to `tech@drivy.com`.
+
+### Schedule checks
+
+Once you have checker jobs, you'll need to run them. There are many task
+schedulers out there and it isn't really relevant what you'll be using.
+
+You have to enqueue you job as often as you like and that's it.
+
+``` ruby
+UserChecker.perform_async
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/drivy/checker_jobs.
+
+You'll find out that the CI is setup to run test coverage and linting.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License][licence].
+
+
+[d-jobs]:     https://www.drivy.com/jobs
+[gh-drivy]:   https://github.com/drivy
+[gh-sidekiq]: https://github.com/mperham/sidekiq
+[licence]:    http://opensource.org/licenses/MIT
+[rails]:      http://rubyonrails.org

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "checker_jobs"
+
+# 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/pronto-ci

@@ -0,0 +1,2 @@
+export PRONTO_PULL_REQUEST_ID=`echo $CI_PULL_REQUEST | grep -o -E '[0-9]+$' | head -1 | sed -e 's/^0\+//'`
+bundle exec pronto run -f github_status github_pr -c origin/master || true

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/checker_jobs.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "checker_jobs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "checker_jobs"
+  spec.version       = CheckerJobs::VERSION
+  spec.authors       = ["Drivy", "Nicolas Zermati"]
+  spec.email         = ["oss@drivy.com"]
+
+  spec.summary       = "Asynchronous data consistency checks"
+  spec.description   = ""
+  spec.homepage      = "https://drivy.engineering/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "actionmailer", "~> 5.0"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "mailcatcher"
+  spec.add_development_dependency "pronto"
+  spec.add_development_dependency "pronto-rubocop"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "sidekiq", "~> 5.0"
+  spec.add_development_dependency "simplecov"
+end

data/examples/user_checker.rb

@@ -0,0 +1,66 @@
+#
+# Configuration
+#
+
+require "sidekiq"
+require "sidekiq/testing"
+
+Sidekiq::Testing.inline!
+
+require "action_mailer"
+
+ActionMailer::Base.raise_delivery_errors = true
+ActionMailer::Base.delivery_method = :smtp
+ActionMailer::Base.smtp_settings = { :address => "localhost", :port => 1025 }
+# Be sure to run `mailcatcher` to see the actual emails on this example
+
+require "checker_jobs"
+
+CheckerJobs.configure do |config|
+  config.repository_url = { github: "drivy/checker_jobs" }
+
+  config.jobs_processor = :sidekiq
+
+  config.emails_backend = :action_mailer
+  config.emails_options = { from: "oss@drivy.com", reply_to: "no-reply@drivy.com" }
+
+  config.around_check = ->(check) {
+    puts "Starting check #{check.name}..."
+    check.perform
+    puts "Done #{check.name}!"
+  }
+end
+
+#
+# Checker
+#
+
+class UserChecker
+  include CheckerJobs::Base
+
+  options sidekiq: { queue: :fast }
+
+  notify "tech@drivy.com"
+
+  ensure_no :inconsistent_payment do
+    UserRepository.missing_email.size
+  end
+end
+
+#
+# Context
+#
+
+module UserRepository
+  def self.missing_email
+    [ User.new(1) ]
+  end
+end
+
+User = Struct.new(:id)
+
+#
+# Triggering the checker
+#
+
+UserChecker.perform_async

data/lib/checker_jobs/base.rb

@@ -0,0 +1,8 @@
+require "checker_jobs/dsl"
+
+module CheckerJobs::Base
+  def self.included(base)
+    base.extend(CheckerJobs::DSL)
+    base.include(CheckerJobs.configuration.jobs_processor_module)
+  end
+end

data/lib/checker_jobs/checks/base.rb

@@ -0,0 +1,19 @@
+CheckerJobs::Checks::Base = Struct.new(:klass, :name, :options, :block) do
+  def perform
+    klass.new.instance_exec(&block).tap do |result|
+      handle_result(result)
+    end
+  end
+
+  private
+
+  def notify(count:, entries: nil)
+    CheckerJobs.configuration.emails_backend_class.
+      new(self, count, entries).
+      notify
+  end
+
+  def handle_result(_result)
+    raise NotImplementedError
+  end
+end

data/lib/checker_jobs/checks/ensure_fewer.rb

@@ -0,0 +1,12 @@
+class CheckerJobs::Checks::EnsureFewer < CheckerJobs::Checks::Base
+  private
+
+  def handle_result(result)
+    case result
+    when Numeric
+      notify(count: result) if result > options.fetch(:than)
+    else
+      raise ArgumentError, "Unsupported result: '#{result.class.name}' for 'ensure_less'"
+    end
+  end
+end

data/lib/checker_jobs/checks/ensure_more.rb

@@ -0,0 +1,12 @@
+class CheckerJobs::Checks::EnsureMore < CheckerJobs::Checks::Base
+  private
+
+  def handle_result(result)
+    case result
+    when Numeric
+      notify(count: result) if result < options.fetch(:than)
+    else
+      raise ArgumentError, "Unsupported result: '#{result.class.name}' for 'ensure_more'"
+    end
+  end
+end

data/lib/checker_jobs/checks/ensure_no.rb

@@ -0,0 +1,14 @@
+class CheckerJobs::Checks::EnsureNo < CheckerJobs::Checks::Base
+  private
+
+  def handle_result(result)
+    case result
+    when Numeric
+      notify(count: result) unless result.zero?
+    when Enumerable
+      notify(count: result.size, entries: result) unless result.empty?
+    else
+      raise ArgumentError, "Unsupported result: '#{result.class.name}' for 'ensure_no'"
+    end
+  end
+end

data/lib/checker_jobs/checks.rb

@@ -0,0 +1,6 @@
+module CheckerJobs::Checks
+  autoload :Base,        "checker_jobs/checks/base"
+  autoload :EnsureFewer, "checker_jobs/checks/ensure_fewer"
+  autoload :EnsureMore,  "checker_jobs/checks/ensure_more"
+  autoload :EnsureNo,    "checker_jobs/checks/ensure_no"
+end

data/lib/checker_jobs/configuration.rb

@@ -0,0 +1,41 @@
+require "checker_jobs/emails_backends"
+require "checker_jobs/jobs_processors"
+
+class CheckerJobs::Configuration
+  DEFAULT_TIME_BETWEEN_CHECKS = 15 * 60 # 15 minutes, expressed in seconds
+
+  attr_accessor :jobs_processor,
+                :emails_backend,
+                :emails_options,
+                :emails_formatter_class,
+                :time_between_checks,
+                :repository_url,
+                :around_check
+
+  def self.default
+    new.tap do |config|
+      config.emails_options = {}
+      config.emails_formatter_class = CheckerJobs::EmailsBackends::DefaultFormatter
+      config.time_between_checks = DEFAULT_TIME_BETWEEN_CHECKS
+      config.around_check = ->(check) { check.perform }
+    end
+  end
+
+  def jobs_processor_module
+    case jobs_processor
+    when :sidekiq
+      CheckerJobs::JobsProcessors::Sidekiq
+    else
+      raise CheckerJobs::UnsupportedConfigurationOption.new(:jobs_processor, jobs_processor)
+    end
+  end
+
+  def emails_backend_class
+    case emails_backend
+    when :action_mailer
+      CheckerJobs::EmailsBackends::ActionMailer
+    else
+      raise CheckerJobs::UnsupportedConfigurationOption.new(:emails_backend, emails_backend)
+    end
+  end
+end

data/lib/checker_jobs/dsl.rb

@@ -0,0 +1,73 @@
+require "checker_jobs/checks"
+
+# DSL to declare checker jobs. It provides predicates:
+#
+# - ensure_no
+# - ensure_more
+# - ensure_fewer
+#
+# And configuration methods:
+#
+# - options
+# - notify
+# - interval
+module CheckerJobs::DSL
+  def options(options_hash)
+    @options = options_hash
+  end
+
+  def notify(target)
+    @notification_target = target
+  end
+
+  def interval(duration)
+    @time_between_checks = duration
+  end
+
+  def ensure_no(name, options = {}, &block)
+    add_check CheckerJobs::Checks::EnsureNo, name, options, block
+  end
+
+  def ensure_more(name, options = {}, &block)
+    add_check CheckerJobs::Checks::EnsureMore, name, options, block
+  end
+
+  def ensure_fewer(name, options = {}, &block)
+    add_check CheckerJobs::Checks::EnsureFewer, name, options, block
+  end
+
+  #
+  # Private API
+  #
+
+  def notification_target
+    raise CheckerJobs::MissingNotificationTarget, self.class unless defined?(@notification_target)
+
+    @notification_target
+  end
+
+  def time_between_checks
+    @time_between_checks || CheckerJobs.configuration.time_between_checks
+  end
+
+  def option(key, default = nil)
+    @options && @options[key] || default
+  end
+
+  def checks
+    @check ||= {}
+  end
+
+  def add_check(klass, name, options, block)
+    name = name.to_s
+
+    raise CheckerJobs::DuplicateCheckerName, name if checks.key?(name)
+
+    checks[name] = klass.new(self, name, options, block)
+  end
+
+  def perform_check(check_name)
+    check = checks.fetch(check_name.to_s)
+    CheckerJobs.configuration.around_check.call(check)
+  end
+end

data/lib/checker_jobs/emails_backends/action_mailer.rb

@@ -0,0 +1,37 @@
+require "action_mailer"
+
+class CheckerJobs::EmailsBackends::ActionMailer
+  def initialize(check, count, entries)
+    @check = check
+    @formatter = formatter_class.new(check, count, entries)
+  end
+
+  def notify
+    Mailer.notify(@formatter.body, options).deliver!
+  end
+
+  private
+
+  def options
+    CheckerJobs.configuration.emails_options.merge({
+      to: @check.klass.notification_target,
+      subject: @formatter.subject,
+    })
+  end
+
+  def formatter_class
+    CheckerJobs.configuration.emails_formatter_class
+  end
+
+  # Simple mailer class based on ActionMailer to send HTML emails while reusing
+  # the ActionMailer configuration of the application embedding the checkers.
+  class Mailer < ::ActionMailer::Base
+    layout false
+
+    def notify(body, options)
+      mail(options) do |format|
+        format.html { render html: body.html_safe }
+      end
+    end
+  end
+end

data/lib/checker_jobs/emails_backends/default_formatter.rb

@@ -0,0 +1,54 @@
+class CheckerJobs::EmailsBackends::DefaultFormatter
+  def initialize(check, count, entries)
+    @check = check
+    @count = count
+    @entries = entries
+  end
+
+  def subject
+    name = @check.name.tr("_", " ").capitalize
+    "#{name} checker found #{@count} element(s)"
+  end
+
+  def body
+    body = "<p>See more about this email on <a href='#{repository_url}'>Github</a>.</p>"
+    if @entries
+      body += "<p>Found %<class_name>s are: <ul>%<html_ids>s</ul></p>" % {
+        class_name: @entries.first.class.name,
+        html_ids: @entries.map { |entry| "<li>#{format_entry(entry)}</li>" }.join,
+      }
+    end
+    body
+  end
+
+  private
+
+  GITHUB_URL_FORMAT = "https://github.com/%<repository>s/blob/master/%<path>s#L%<line>i".freeze
+
+  def repository_url
+    if repository_configuration.is_a?(String)
+      repository_configuration
+    elsif repository_configuration.key?(:github)
+      github_url
+    end
+  end
+
+  def github_url
+    filepath, line_number = @check.block.source_location
+    filepath = filepath.sub(Dir.pwd + "/", "")
+    GITHUB_URL_FORMAT % {
+      repository: repository_configuration[:github],
+      path: filepath,
+      line: line_number,
+    }
+  end
+
+  def format_entry(entry)
+    # NOTE: inherit and override to support your custom objects
+    entry.respond_to?(:id) ? entry.id : entry
+  end
+
+  def repository_configuration
+    CheckerJobs.configuration.repository_url
+  end
+end

data/lib/checker_jobs/emails_backends.rb

@@ -0,0 +1,4 @@
+module CheckerJobs::EmailsBackends
+  autoload :ActionMailer,     "checker_jobs/emails_backends/action_mailer"
+  autoload :DefaultFormatter, "checker_jobs/emails_backends/default_formatter"
+end

data/lib/checker_jobs/errors.rb

@@ -0,0 +1,37 @@
+module CheckerJobs
+  class Error < StandardError
+  end
+
+  class MissingNotificationTarget < Error
+  end
+
+  class Unconfigured < Error
+    def message
+      "CheckerJobs: are unconfigured, do CheckerJobs.configure before using it."
+    end
+  end
+
+  class UnsupportedConfigurationOption < Error
+    def initialize(option_name, value)
+      @option_name = option_name
+      @value = value
+      super()
+    end
+
+    def message
+      "CheckerJobs: unsupported configuration option: '#{@value.inspect}' " \
+      "isn't valid for '#{@option_name}' option."
+    end
+  end
+
+  class DuplicateCheckerName < Error
+    def initialize(checker_name)
+      @checker_name = checker_name
+      super
+    end
+
+    def message
+      "CheckerJobs: the name '#{checker_name}' is already used for another checker."
+    end
+  end
+end

data/lib/checker_jobs/jobs_processors/sidekiq.rb

@@ -0,0 +1,45 @@
+require "sidekiq"
+
+module CheckerJobs::JobsProcessors::Sidekiq
+  def self.included(base)
+    base.include(Sidekiq::Worker)
+    base.extend(ClassMethods)
+  end
+
+  def perform(check_name = nil)
+    # Run on specific check
+    return self.class.perform_check(check_name.to_s) if check_name
+
+    # Enqueue one specific check for each declared check
+    self.class.checks.values.each.with_index do |check, index|
+      scheduled_in = index * self.class.time_between_checks
+      self.class.perform_check_in(check, scheduled_in)
+    end
+  end
+
+  module ClassMethods
+    # Overrides DSL#options in order to pass specific options to Sidekiq.
+    # The options could be the queue the job processor must use, or other
+    # middleware options of your choice.
+    def options(*args)
+      super(*args).tap do
+        sidekiq_options option(:sidekiq, {})
+      end
+    end
+
+    def perform_check_in(check, interval)
+      # Borrowed from Sidekiq implementation
+      item = {
+        "class" => self,
+        "args" => [check.name.to_s],
+        "at" => Time.now.to_f + interval.to_f,
+      }
+
+      if (specific_queue = check.options[:queue])
+        item["queue"] = specific_queue.to_s
+      end
+
+      client_push(item)
+    end
+  end
+end

data/lib/checker_jobs/jobs_processors.rb

@@ -0,0 +1,3 @@
+module CheckerJobs::JobsProcessors
+  autoload :Sidekiq, "checker_jobs/jobs_processors/sidekiq"
+end

data/lib/checker_jobs/version.rb

@@ -0,0 +1,3 @@
+module CheckerJobs
+  VERSION = "0.1.0.pre".freeze
+end

data/lib/checker_jobs.rb

@@ -0,0 +1,15 @@
+require "checker_jobs/version"
+require "checker_jobs/errors"
+require "checker_jobs/configuration"
+require "checker_jobs/base"
+
+module CheckerJobs
+  def self.configuration
+    Thread.current[:checker_jobs_configuration] || raise(Unconfigured)
+  end
+
+  def self.configure(&block)
+    Thread.current[:checker_jobs_configuration] = Configuration.default
+    block&.call(configuration)
+  end
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: checker_jobs
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Drivy
+- Nicolas Zermati
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: mailcatcher
+  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: pronto
+  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: pronto-rubocop
+  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: 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: 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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-rspec
+  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: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+description: ''
+email:
+- oss@drivy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/pronto-ci
+- bin/setup
+- checker_jobs.gemspec
+- examples/user_checker.rb
+- lib/checker_jobs.rb
+- lib/checker_jobs/base.rb
+- lib/checker_jobs/checks.rb
+- lib/checker_jobs/checks/base.rb
+- lib/checker_jobs/checks/ensure_fewer.rb
+- lib/checker_jobs/checks/ensure_more.rb
+- lib/checker_jobs/checks/ensure_no.rb
+- lib/checker_jobs/configuration.rb
+- lib/checker_jobs/dsl.rb
+- lib/checker_jobs/emails_backends.rb
+- lib/checker_jobs/emails_backends/action_mailer.rb
+- lib/checker_jobs/emails_backends/default_formatter.rb
+- lib/checker_jobs/errors.rb
+- lib/checker_jobs/jobs_processors.rb
+- lib/checker_jobs/jobs_processors/sidekiq.rb
+- lib/checker_jobs/version.rb
+homepage: https://drivy.engineering/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Asynchronous data consistency checks
+test_files: []