HornsAndHooves-slackiq 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d33511bc1da33236ea8a6b3c03b4d1e2a26305fbc55d9d8db48cd71644c713c
-  data.tar.gz: da45ca5736a952f4f75bced5cfc5c1f3f4858ad7d1a0edb383558785458308c2
+  metadata.gz: 5cf82d00d5319230c303822b593bc4350c99f18cc5bd7539247c2622cc35b021
+  data.tar.gz: 40f830f297f3469d0b32bd104c6a3eeaa1cb71c0da5e8b31a8813af7bcfd5294
 SHA512:
-  metadata.gz: ebe7cbb7a607f79063c21f549ce0a2680ab8c3d96f0da08b00c65110a37aa3eb17228ac21ffc133933d53bb037e3f94b3afd718122e43462e5bd5251b01fdede
-  data.tar.gz: a1907bad4728a9f07d581901a2e3e57b60e8ddd1079a9d631cc84c5e503db42d90dbfde4936b937261ee878062274d276b4ed6b9e5105cea3cc34502238f7df4
+  metadata.gz: a07bc1b7e428c2ceac87a093118307b549dd2cae23ce12872a80f4347459951dabef1af998853f8ac54a7abdafe109805dc20a0a7703b4b4883029dc030a554d
+  data.tar.gz: 5281494bd6f24caf781621d41960f9db72655a676684b9212ed51dc721695bd8f704236f8e6c8f090febda3a7a78795198af537fa869a3daf159d6bff3d2798d

data/HornsAndHooves-slackiq.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "slackiq/version"
 
@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "httparty"
   s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"

data/lib/slackiq.rb

@@ -1,156 +1,195 @@
 require "slackiq/version"
 
 require "net/http"
+require "uri"
 require "json"
-require "httparty"
+require "date"
 
-require "slackiq/time_helper"
+class Slackiq
 
-require "active_support" # For Hash#except
+  attr_reader :options
 
-module Slackiq
-
-  class << self
-
-    # Configure all of the webhook URLs you're going to use
-    # @author Jason Lew
-    def configure(webhook_urls={})
-      raise "Argument must be a Hash" unless webhook_urls.class == Hash
-      @@webhook_urls = webhook_urls
-    end
-
-    # Send a notification to Slack with Sidekiq info about the batch
-    # @author Jason Lew
-    def notify(options={})
-      url = @@webhook_urls[options[:webhook_name]]
-      title = options[:title]
-      # description = options[:description]
-      status = options[:status]
-
-      if (bid = options[:bid]) && status.nil?
-        raise <<~EOT.chomp unless defined?(Sidekiq::Batch::Status)
-                 Sidekiq::Batch::Status is not defined. \
-                 Are you sure Sidekiq Pro is set up correctly?
-                 EOT
-        status = Sidekiq::Batch::Status.new(bid)
-      end
-
-      color = options[:color] || color_for(status)
-
-      extra_fields = options.except(:webhook_name, :title, :description, :status)
+  # @param options [Hash]
+  def self.notify(options)
+    raise "Need to run Slackiq.configure first" if @webhook_urls.nil?
+    new(options.merge(webhook_urls: @webhook_urls)).execute
+  end
 
-      fields = []
+  # @param options [Hash]
+  def self.configure(webhook_urls={})
+    @webhook_urls = webhook_urls
+  end
 
-      if status
-        created_at = status.created_at
+  # @param options [Hash]
+  def initialize(options)
+    @options = options
+  end
 
-        if created_at
-          time_now = Time.now
-          duration = Slackiq::TimeHelper.elapsed_time_humanized(created_at, time_now)
-          time_now_title = (status.complete? ? "Completed" : "Now")
-        end
+  # Send a notification to Slack with Sidekiq info about the batch
+  def execute
+    time_now = Time.now
 
-        total_jobs = status.total
-        failures = status.failures
-        jobs_run = total_jobs - status.pending
-
-        completion_percentage = (jobs_run/total_jobs.to_f)*100
-        failure_percentage = (failures/total_jobs.to_f)*100 if total_jobs && failures
-
-        # Round to two decimal places
-        decimal_places = 2
-        completion_percentage = completion_percentage.round(decimal_places)
-        failure_percentage = failure_percentage.round(decimal_places)
-
-        description = status.description
-
-        fields += [
-          {
-            title: "Created",
-            value: Slackiq::TimeHelper.format(created_at),
-            short: true
-          },
-          {
-            title: time_now_title,
-            value: Slackiq::TimeHelper.format(time_now),
-            short: true
-          },
-          {
-            title: "Duration",
-            value: duration,
-            short: true
-          },
-          {
-            title: "Total Jobs",
-            value: total_jobs,
-            short: true
-          },
-          {
-            title: "Jobs Run",
-            value: jobs_run,
-            short: true
-          },
-          {
-            title: "Completion %",
-            value: "#{completion_percentage}%",
-            short: true
-          },
-          {
-            title: "Failures",
-            value: status.failures,
-            short: true
-          },
-          {
-            title: "Failure %",
-            value: "#{failure_percentage}%",
-            short: true
-          },
-        ]
-      end
+    title    = options[:title]
+    status   = options[:status]
 
-      # Add extra fields
-      fields += extra_fields.map do |title, value|
-        {
-          title: title,
-          value: value,
-          short: false
-        }
-      end
+    if (bid = options[:bid]) && status.nil?
+      raise <<~EOT.chomp unless defined?(Sidekiq::Batch::Status)
+               Sidekiq::Batch::Status is not defined. \
+               Are you sure Sidekiq Pro is set up correctly?
+               EOT
+      status = Sidekiq::Batch::Status.new(bid)
+    end
 
-      attachments = [
-        {
-          fallback: title,
-          color:    color,
-          title:    title,
-          text:     description,
-          fields:   fields,
-        }
+    return if status.nil?
+
+    color      = options[:color] || color_for(status)
+
+    duration   = elapsed_time_humanized(status.created_at, time_now)
+    time_title = status.complete? ? "Completed" : "Now"
+    jobs_run   = status.total - status.pending
+
+    completion_percentage = percentage(jobs_run        / status.total.to_f)
+    failure_percentage    = percentage(status.failures / status.total.to_f)
+
+    fields = [
+      {
+        title: title,
+        value: status.description,
+        short: false
+      },
+      {
+        title: "Batch ID",
+        value: status.bid,
+        short: false
+      },
+      {
+        title: "Created",
+        value: time_format(status.created_at),
+        short: true
+      },
+      {
+        title: time_title,
+        value: time_format(time_now),
+        short: true
+      },
+      {
+        title: "Duration",
+        value: duration,
+        short: true
+      },
+      {
+        title: "Total Jobs",
+        value: status.total,
+        short: true
+      },
+      {
+        title: "Jobs Run",
+        value: jobs_run,
+        short: true
+      },
+      {
+        title: "Completion %",
+        value: completion_percentage,
+        short: true
+      },
+      {
+        title: "Failures",
+        value: status.failures,
+        short: true
+      },
+      {
+        title: "Failure %",
+        value: failure_percentage,
+        short: true
+      }
+    ]
+
+    body = {
+      attachments: [
+        fields: fields,
+        color:  color
       ]
+    }
+    http_post(body)
+  end
 
-      body = { attachments: attachments }.to_json
+  # @param data [Hash]
+  private def http_post(data)
+    url  = options[:webhook_urls].fetch(options[:webhook_name])
+    uri  = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true if uri.port == 443
+
+    header  = {"Content-Type": "application/json"}
+    request = Net::HTTP::Post.new(uri.request_uri, header)
+    request.body = data.to_json
+    http.request(request)
+  end
 
-      HTTParty.post(url, body: body)
-    end
+  # @param number [Numeric]
+  # @param precision [Integer]
+  # @param multiply100 [Boolean]
+  private def percentage(number, precision: 2, multiply100: true)
+    number  = number * 100 if multiply100
+    rounded = number.to_f.round(precision)
+    format  = number == rounded.to_i ? "%.f" : "%.#{precision}f"
+    (format % rounded) + "%"
+  end
 
-    # Send a notification without Sidekiq batch info
-    # @author Jason Lew
-    def message(text, options)
-      url = @@webhook_urls[options[:webhook_name]]
-      body = { text: text }.to_json
-      HTTParty.post(url, body: body)
+  # @param status [Sidekiq::Batch::Status]
+  private def color_for(status)
+    colors = {
+      red:    "f00000",
+      yellow: "ffc000",
+      green:  "009800"
+    }
+
+    if status.total == 0
+      colors[:yellow]
+    elsif status.failures > 0
+      colors[:red]
+    elsif status.failures == 0
+      colors[:green]
+    else
+      colors[:yellow]
     end
+  end
+
+  # @param t0 [DateTime]
+  # @param t1 [DateTime]
+  private def elapsed_time_humanized(t0, t1, precision: 2)
+    time_humanize(
+      elapsed_seconds(t0, t1, precision: precision),
+      precision: precision
+    )
+  end
 
-  private
-    def color_for(status)
-      if status.total == 0
-        "#FBBD08"  # yellow
-      elsif status.failures > 0
-        "#FF0000"  # red
-      elsif status.failures == 0
-        "#1C9513"  # green
-      else
-        "#FBBD08"  # yellow
+  # @param t0 [DateTime]
+  # @param t1 [DateTime]
+  private def elapsed_seconds(t0, t1, precision: 2)
+    dt0 = t0.to_datetime
+    dt1 = t1.to_datetime
+    ((dt1 - dt0) * 24 * 60 * 60).to_f.round(precision)
+  end
+
+  # http://stackoverflow.com/questions/4136248/how-to-generate-a-human-readable-time-range-using-ruby-on-rails
+  # @param secs [Integer]
+  private def time_humanize(secs, precision: 2)
+    [[60, :s], [60, :m], [24, :h], [1000, :d]].map do |count, name|
+      if secs > 0
+        secs, n = secs.divmod(count)
+        if name == :s
+          num = n.to_f == n.to_i ? n.to_i : n.to_f
+          "%.#{precision}f#{name}" % num
+        else
+          "#{n.to_i}#{name}"
+        end
       end
-    end
+    end.compact.reverse.join(" ")
+  end
+
+  # @param time [DateTime]
+  private def time_format(time)
+    time.strftime("%D @ %I:%M:%S %P")
   end
 end

data/lib/slackiq/version.rb

@@ -1,3 +1,3 @@
-module Slackiq
-  VERSION = "1.2.1"
+class Slackiq
+  VERSION = "1.3.0".freeze
 end

metadata

@@ -1,30 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: HornsAndHooves-slackiq
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - HornsAndHooves
 - Peter Maneykowski
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-07-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,13 +72,12 @@ files:
 - bin/console
 - bin/setup
 - lib/slackiq.rb
-- lib/slackiq/time_helper.rb
 - lib/slackiq/version.rb
 homepage: https://github.com/HornsAndHooves/slackiq
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'HornsAndHooves: Slack and Sidekiq Pro integration'
 test_files: []

data/lib/slackiq/time_helper.rb

@@ -1,37 +0,0 @@
-require "date"
-
-module Slackiq
-  module TimeHelper
-
-    class << self
-
-      def elapsed_time_humanized(t0, t1)
-        humanize(elapsed_seconds(t0, t1))
-      end
-
-      def elapsed_seconds(t0, t1)
-        dt0 = t0.to_datetime
-        dt1 = t1.to_datetime
-        ((dt1-dt0)*24*60*60).to_f.round(2)
-      end
-
-      # http://stackoverflow.com/questions/4136248/how-to-generate-a-human-readable-time-range-using-ruby-on-rails
-      def humanize(secs)
-        [[60, :s], [60, :m], [24, :h], [1000, :d]].map{ |count, name|
-          if secs > 0
-            secs, n = secs.divmod(count)
-            if name == :s
-              "%.2f#{name}" % [n.to_f]
-            else
-              "#{n.to_i}#{name}"
-            end
-          end
-        }.compact.reverse.join(" ")
-      end
-
-      def format(time)
-        time.strftime("%D @ %r").gsub("PM", "pm").gsub("AM", "am")
-      end
-    end
-  end
-end