checker_jobs 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dff9e8e2b91b729928d02a856b2a1848afe909ed2c17a5ba39cded6f992e8087
-  data.tar.gz: 11ae8c80cb23614057e45fbdb70de548cb7dac6e9e3368564a586a0d247272e9
+  metadata.gz: 8d3774f5e1476ee67df067f568c61988441280eb40d0a59a14e13210a967d058
+  data.tar.gz: aab870d45b4ed42e342c212cd86a0ac014481fb47ac93b32af34bec45cd9c99a
 SHA512:
-  metadata.gz: bf7ed95487af7d2d5df3a8c884d17a66fa90fef168a7c7c72b6551a595ae12c46765024117e54b02e821aadc0d1b0c79a566ff45472a4dc97181b7b503f0f0c4
-  data.tar.gz: 6754adfa0d2849ee8cabecd9e379489908f85d2a6bf349dbba75d3513645a0269f8f7e5848d375a4854b5fd93cd3b50c05c5e137d93a470099f9b4dd6a1dd02c
+  metadata.gz: bd703fda86b95bd18867ce82c7dbf07b02e428c653d4fbe0b5ad30f4ba88cdc38bfa37db8442a88c69350c4ed8956c2422e83c010a91443bc4efaba69eabdcb9
+  data.tar.gz: 242abd0c1a768fd377026bb48327b5ab2be23280266e45ec7c5d9bda8792627cc491fed7c3acb4f00d34fad3832893c14bd5e4690c5ef831b14152583ec1c455

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    checker_jobs (1.0.0)
+    checker_jobs (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -36,6 +36,7 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
+    bugsnag (5.4.1)
     builder (3.2.3)
     byebug (9.1.0)
     coderay (1.1.2)
@@ -190,6 +191,7 @@ PLATFORMS
 
 DEPENDENCIES
   actionmailer (~> 5.0)
+  bugsnag
   bundler (~> 1.13)
   checker_jobs!
   mailcatcher

data/README.md

@@ -119,6 +119,7 @@ PRs are appreciated 🙏
 
 We support different kind of notifiers, as of today we have the following:
 
+- `:bugsnag`: uses `Bugsnag` to send notifications. It takes the global configuration.
 - `: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).

data/checker_jobs.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "actionmailer", "~> 5.0"
+  spec.add_development_dependency "bugsnag"
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "mailcatcher"
   spec.add_development_dependency "pronto"

data/lib/checker_jobs/configuration.rb

@@ -1,12 +1,13 @@
-require "checker_jobs/emails_backends"
+require "checker_jobs/notifiers"
 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",
+    email: "CheckerJobs::Notifiers::Email",
+    logger: "CheckerJobs::Notifiers::Logger",
+    bugsnag: "CheckerJobs::Notifiers::Bugsnag",
   }.freeze
 
   attr_accessor :jobs_processor,

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

@@ -1,5 +1,7 @@
 module CheckerJobs::Notifiers
+  autoload :Bugsnag,                "checker_jobs/notifiers/bugsnag"
   autoload :Email,                  "checker_jobs/notifiers/email"
   autoload :EmailDefaultFormatter,  "checker_jobs/notifiers/email_default_formatter"
+  autoload :FormatterHelpers,       "checker_jobs/notifiers/formatter_helpers"
   autoload :Logger,                 "checker_jobs/notifiers/logger"
 end

data/lib/checker_jobs/notifiers/bugsnag.rb

@@ -0,0 +1,26 @@
+require "action_mailer"
+
+class CheckerJobs::Notifiers::Bugsnag
+  include CheckerJobs::Notifiers::FormatterHelpers
+
+  class Error < StandardError; end
+
+  def initialize(check, count, entries)
+    @check = check
+    @metadata = {
+      klass: @check.klass,
+      name: @check.name,
+      count: count,
+      entries: entries,
+    }
+  end
+
+  def notify
+    raise Error, "(#{@check.klass}) #{human_check_name} was triggered!"
+  rescue Error => error
+    ::Bugsnag.notify(error, {
+      severity: "warning",
+      triggered_check: @metadata,
+    })
+  end
+end

data/lib/checker_jobs/notifiers/email_default_formatter.rb

@@ -1,4 +1,6 @@
 class CheckerJobs::Notifiers::EmailDefaultFormatter
+  include CheckerJobs::Notifiers::FormatterHelpers
+
   def initialize(check, count, entries)
     @check = check
     @count = count
@@ -6,8 +8,7 @@ class CheckerJobs::Notifiers::EmailDefaultFormatter
   end
 
   def subject
-    name = @check.name.tr("_", " ").capitalize
-    "#{name} checker found #{@count} element(s)"
+    "#{human_check_name} checker found #{@count} element(s)"
   end
 
   def body
@@ -23,32 +24,8 @@ class CheckerJobs::Notifiers::EmailDefaultFormatter
 
   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/notifiers/formatter_helpers.rb

@@ -0,0 +1,34 @@
+# Needs a @check instance variable and provides the methods:
+# - #repository_url
+# - #human_check_name
+module CheckerJobs::Notifiers::FormatterHelpers
+  GITHUB_URL_FORMAT = "https://github.com/%<repository>s/blob/master/%<path>s#L%<line>i".freeze
+
+  def human_check_name
+    @check.name.tr("_", " ").capitalize
+  end
+
+  def repository_url
+    if repository_configuration.is_a?(String)
+      repository_configuration
+    elsif repository_configuration.key?(:github)
+      github_url
+    end
+  end
+
+  private
+
+  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 repository_configuration
+    CheckerJobs.configuration.repository_url
+  end
+end

data/lib/checker_jobs/notifiers/logger.rb

@@ -1,6 +1,8 @@
 require "logger"
 
 class CheckerJobs::Notifiers::Logger
+  include CheckerJobs::Notifiers::FormatterHelpers
+
   DEFAULT_LEVEL = Logger::INFO
   DEFAULT_LOGDEV = STDOUT
 
@@ -15,7 +17,7 @@ class CheckerJobs::Notifiers::Logger
   end
 
   def notify
-    @logger.add(level, format, @check.name.tr("_", " ").capitalize)
+    @logger.add(level, format, human_check_name)
   end
 
   # override this

data/lib/checker_jobs/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checker_jobs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Drivy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bugsnag
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -209,12 +223,14 @@ files:
 - 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/errors.rb
 - lib/checker_jobs/jobs_processors.rb
 - lib/checker_jobs/jobs_processors/sidekiq.rb
+- lib/checker_jobs/notifiers.rb
+- lib/checker_jobs/notifiers/bugsnag.rb
 - lib/checker_jobs/notifiers/email.rb
 - lib/checker_jobs/notifiers/email_default_formatter.rb
+- lib/checker_jobs/notifiers/formatter_helpers.rb
 - lib/checker_jobs/notifiers/logger.rb
 - lib/checker_jobs/version.rb
 homepage: https://github.com/drivy/checker_jobs