checker_jobs 0.1.2.pre → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd7238a9e052db0d3953584be6cf3d082ae6b171
-  data.tar.gz: a4bf0b5505b76cbc4c23b195bdb9af6bc14c8f7d
+SHA256:
+  metadata.gz: dff9e8e2b91b729928d02a856b2a1848afe909ed2c17a5ba39cded6f992e8087
+  data.tar.gz: 11ae8c80cb23614057e45fbdb70de548cb7dac6e9e3368564a586a0d247272e9
 SHA512:
-  metadata.gz: fb9d91c1b2eacb5f86cc4304fdaf4bb7bee7f5addb90094e7f81df44fab5795f211f3e7891e654522313fd875ed0546951cd39cc0d2904ccf6f88c80113dcade
-  data.tar.gz: '0586d068670200ddf86e62f848bf5ed636992eb4b6de358653183b8cad61e3c519ce31c741933c43077d9839fdf3bc98e7aa736fc02690293ec06a98cb335a8e'
+  metadata.gz: bf7ed95487af7d2d5df3a8c884d17a66fa90fef168a7c7c72b6551a595ae12c46765024117e54b02e821aadc0d1b0c79a566ff45472a4dc97181b7b503f0f0c4
+  data.tar.gz: 6754adfa0d2849ee8cabecd9e379489908f85d2a6bf349dbba75d3513645a0269f8f7e5848d375a4854b5fd93cd3b50c05c5e137d93a470099f9b4dd6a1dd02c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    checker_jobs (0.1.2.pre)
+    checker_jobs (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -41,7 +41,7 @@ GEM
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
-    crass (1.0.3)
+    crass (1.0.4)
     daemons (1.2.6)
     diff-lcs (1.3)
     docile (1.1.5)
@@ -109,16 +109,16 @@ GEM
       byebug (~> 9.1)
       pry (~> 0.10)
     public_suffix (3.0.1)
-    rack (2.0.4)
-    rack-protection (2.0.1)
+    rack (2.0.5)
+    rack-protection (2.0.3)
       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)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
     rainbow (2.2.2)
       rake
     rake (10.5.0)
@@ -160,10 +160,10 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    sinatra (2.0.1)
+    sinatra (2.0.3)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.1)
+      rack-protection (= 2.0.3)
       tilt (~> 2.0)
     skinny (0.2.2)
       eventmachine (~> 1.0)

data/README.md

@@ -41,7 +41,7 @@ class UsersChecker
 
   options sidekiq: { queue: :slow }
 
-  notify "oss@drivy.com"
+  notify :email, to: "oss@drivy.com"
 
   ensure_no :negative_rental_credit do
     # The following code is an over-simplification
@@ -74,26 +74,30 @@ 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.
+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" }
+CheckerJobs.configure do |c|
+  c.jobs_processor = :sidekiq
+
+  c.notifier :email do |options|
+    options[:formatter_class] = CheckerJobs::Notifiers::EmailDefaultFormatter
+    options[:email_options] = {
+      from: "oss@drivy.com",
+      reply_to: "no-reply@drivy.com",
+    }
+  end
 
-  config.jobs_processor = :sidekiq
+  c.notifier :logger do |options|
+    options[:logdev] = STDOUT
+    options[:level] = Logger::INFO
+  end
 
-  config.emails_backend = :action_mailer
-  config.emails_options = { from: "oss@drivy.com", reply_to: "no-reply@drivy.com" }
+  c.repository_url = { github: "drivy/checker_jobs" }
 end
 
 ```
@@ -105,6 +109,21 @@ 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].
 
+### Job Processor
+
+At the moment, only [Sidekiq][gh-sidekiq] is supported as a job processor to asynchronously check for data inconsitencies.
+The gem is designed to supports more processor.
+PRs are appreciated 🙏
+
+### Notifiers
+
+We support different kind of notifiers, as of today we have the following:
+
+- `:email`: uses `ActionMailer` to send emails. You can pass it any `ActionMailer` options.
+- `:logger`: Uses `Logger` to output inconsitencies in the log. Takes the following params:
+  - `logdev`: The log device. This is a filename (String) or IO object (typically STDOUT, STDERR, or an open file).
+  - `level`: Logging severity threshold (e.g. Logger::INFO)
+
 ### Write checkers
 
 A checker is a class that inherits `CheckerJobs::Base` and uses the
@@ -116,7 +135,7 @@ class UserChecker
 
   options sidekiq: { queue: :fast }
 
-  notify "tech@drivy.com"
+  notify :email, to: "oss@drivy.com"
 
   ensure_no :user_without_email do
     UserRepository.missing_email.size
@@ -128,7 +147,7 @@ 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`.
+fired through ActionMailer to `oss@drivy.com`.
 
 ### Schedule checks
 
@@ -150,10 +169,3 @@ 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/checker_jobs.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Drivy", "Nicolas Zermati"]
   spec.email         = ["oss@drivy.com"]
 
-  spec.summary       = "Asynchronous data consistency checks"
+  spec.summary       = "Regression tests for data"
   spec.description   = ""
   spec.homepage      = "https://github.com/drivy/checker_jobs"
   spec.license       = "MIT"

data/examples/user_checker.rb

@@ -21,8 +21,13 @@ CheckerJobs.configure do |config|
 
   config.jobs_processor = :sidekiq
 
-  config.emails_backend = :action_mailer
-  config.emails_options = { from: "oss@drivy.com", reply_to: "no-reply@drivy.com" }
+  config.notifier :email do |options|
+    options[:formatter_class] = CheckerJobs::Notifiers::EmailDefaultFormatter
+    options[:email_options] = {
+      from: "oss@drivy.com",
+      reply_to: "no-reply@drivy.com",
+    }
+  end
 
   config.around_check = -> {
     puts "Starting check #{check.name}..."
@@ -40,7 +45,7 @@ class UserChecker
 
   options sidekiq: { queue: :fast }
 
-  notify "tech@drivy.com"
+  notify :email, to: "tech@drivy.com"
 
   ensure_no :inconsistent_payment do
     UserRepository.missing_email.size

data/lib/checker_jobs/checks/base.rb

@@ -10,9 +10,8 @@ CheckerJobs::Checks::Base = Struct.new(:klass, :name, :options, :block) do
   private
 
   def notify(count:, entries: nil)
-    CheckerJobs.configuration.emails_backend_class.
-      new(self, count, entries).
-      notify
+    notifier_class = CheckerJobs.configuration.notifier_class(klass.notifier)
+    notifier_class.new(self, count, entries).notify
   end
 
   def handle_result(_result)

data/lib/checker_jobs/configuration.rb

@@ -4,23 +4,31 @@ require "checker_jobs/jobs_processors"
 class CheckerJobs::Configuration
   DEFAULT_TIME_BETWEEN_CHECKS = 15 * 60 # 15 minutes, expressed in seconds
 
+  NOTIFIER_CLASSES = {
+    email:          "CheckerJobs::Notifiers::Email",
+    logger:         "CheckerJobs::Notifiers::Logger",
+  }.freeze
+
   attr_accessor :jobs_processor,
-                :emails_backend,
-                :emails_options,
-                :emails_formatter_class,
+                :notifiers_options,
                 :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.notifiers_options = {}
       config.time_between_checks = DEFAULT_TIME_BETWEEN_CHECKS
       config.around_check = ->(&block) { block.call }
     end
   end
 
+  def notifier(notifier_symbol)
+    options = {}
+    yield(options)
+    @notifiers_options[notifier_symbol] = options
+  end
+
   def jobs_processor_module
     case jobs_processor
     when :sidekiq
@@ -30,12 +38,10 @@ class CheckerJobs::Configuration
     end
   end
 
-  def emails_backend_class
-    case emails_backend
-    when :action_mailer
-      CheckerJobs::EmailsBackends::ActionMailer
-    else
-      raise CheckerJobs::UnsupportedConfigurationOption.new(:emails_backend, emails_backend)
+  def notifier_class(notifier)
+    notifier_class_name = NOTIFIER_CLASSES.fetch(notifier) do
+      raise CheckerJobs::UnsupportedConfigurationOption.new(:notifier, notifier)
     end
+    Object.const_get(notifier_class_name)
   end
 end

data/lib/checker_jobs/dsl.rb

@@ -16,8 +16,9 @@ module CheckerJobs::DSL
     @options = options_hash
   end
 
-  def notify(target)
-    @notification_target = target
+  def notify(notifier, notifier_options = {})
+    @notifier = notifier
+    @notifier_options = notifier_options
   end
 
   def interval(duration)
@@ -40,10 +41,14 @@ module CheckerJobs::DSL
   # Private API
   #
 
-  def notification_target
-    raise CheckerJobs::MissingNotificationTarget, self.class unless defined?(@notification_target)
+  def notifier
+    raise CheckerJobs::MissingNotifier, self.class unless defined?(@notifier)
+    @notifier
+  end
 
-    @notification_target
+  def notifier_options
+    raise CheckerJobs::MissingNotifier, self.class unless defined?(@notifier)
+    @notifier_options
   end
 
   def time_between_checks

data/lib/checker_jobs/emails_backends.rb

@@ -1,4 +1,5 @@
-module CheckerJobs::EmailsBackends
-  autoload :ActionMailer,     "checker_jobs/emails_backends/action_mailer"
-  autoload :DefaultFormatter, "checker_jobs/emails_backends/default_formatter"
+module CheckerJobs::Notifiers
+  autoload :Email,                  "checker_jobs/notifiers/email"
+  autoload :EmailDefaultFormatter,  "checker_jobs/notifiers/email_default_formatter"
+  autoload :Logger,                 "checker_jobs/notifiers/logger"
 end

data/lib/checker_jobs/errors.rb

@@ -2,7 +2,10 @@ module CheckerJobs
   class Error < StandardError
   end
 
-  class MissingNotificationTarget < Error
+  class MissingNotifier < Error
+  end
+
+  class InvalidNotifierOptions < Error
   end
 
   class Unconfigured < Error

data/lib/checker_jobs/{emails_backends/action_mailer.rb → notifiers/email.rb}

@@ -1,9 +1,12 @@
 require "action_mailer"
 
-class CheckerJobs::EmailsBackends::ActionMailer
+class CheckerJobs::Notifiers::Email
   def initialize(check, count, entries)
     @check = check
     @formatter = formatter_class.new(check, count, entries)
+    @defaults = { subject: @formatter.subject }
+
+    raise CheckerJobs::InvalidNotifierOptions unless valid?
   end
 
   def notify
@@ -12,15 +15,22 @@ class CheckerJobs::EmailsBackends::ActionMailer
 
   private
 
+  def valid?
+    options[:to].is_a?(String)
+  end
+
   def options
-    CheckerJobs.configuration.emails_options.merge({
-      to: @check.klass.notification_target,
-      subject: @formatter.subject,
-    })
+    @options ||=  @defaults.
+                  merge(notifier_options[:email_options]).
+                  merge(@check.klass.notifier_options)
   end
 
   def formatter_class
-    CheckerJobs.configuration.emails_formatter_class
+    notifier_options[:formatter_class] || CheckerJobs::Notifiers::EmailDefaultFormatter
+  end
+
+  def notifier_options
+    CheckerJobs.configuration.notifiers_options[@check.klass.notifier]
   end
 
   # Simple mailer class based on ActionMailer to send HTML emails while reusing

data/lib/checker_jobs/{emails_backends/default_formatter.rb → notifiers/email_default_formatter.rb}

@@ -1,4 +1,4 @@
-class CheckerJobs::EmailsBackends::DefaultFormatter
+class CheckerJobs::Notifiers::EmailDefaultFormatter
   def initialize(check, count, entries)
     @check = check
     @count = count

data/lib/checker_jobs/notifiers/logger.rb

@@ -0,0 +1,51 @@
+require "logger"
+
+class CheckerJobs::Notifiers::Logger
+  DEFAULT_LEVEL = Logger::INFO
+  DEFAULT_LOGDEV = STDOUT
+
+  def initialize(check, count, entries)
+    @check = check
+    @count = count
+    @entries = entries
+    raise CheckerJobs::InvalidNotifierOptions unless valid?
+
+    @logger = Logger.new(logdev)
+    @logger.level = level
+  end
+
+  def notify
+    @logger.add(level, format, @check.name.tr("_", " ").capitalize)
+  end
+
+  # override this
+  def format
+    "found #{@count} entries"
+  end
+
+  private
+
+  def valid?
+    (logdev.is_a?(String) || logdev.is_a?(IO)) &&
+      [
+        Logger::UNKNOWN, Logger::FATAL, Logger::ERROR,
+        Logger::WARN, Logger::INFO, Logger::DEBUG
+      ].include?(level)
+  end
+
+  def level
+    @level ||=  @check.klass.notifier_options[:level] ||
+                notifier_options[:level] ||
+                DEFAULT_LEVEL
+  end
+
+  def logdev
+    @logdev ||= @check.klass.notifier_options[:logdev] ||
+                notifier_options[:logdev] ||
+                DEFAULT_LOGDEV
+  end
+
+  def notifier_options
+    CheckerJobs.configuration.notifiers_options[@check.klass.notifier]
+  end
+end

data/lib/checker_jobs/version.rb

@@ -1,3 +1,3 @@
 module CheckerJobs
-  VERSION = "0.1.2.pre".freeze
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checker_jobs
 version: !ruby/object:Gem::Version
-  version: 0.1.2.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Drivy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -210,11 +210,12 @@ files:
 - 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/notifiers/email.rb
+- lib/checker_jobs/notifiers/email_default_formatter.rb
+- lib/checker_jobs/notifiers/logger.rb
 - lib/checker_jobs/version.rb
 homepage: https://github.com/drivy/checker_jobs
 licenses:
@@ -231,13 +232,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '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.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Asynchronous data consistency checks
+summary: Regression tests for data
 test_files: []