HornsAndHooves-slackiq 1.1.13 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cbd140b134d6de7cf86dd0227b2cb33e9fddedd0e4b49a11b9dc5f5f27911c7
-  data.tar.gz: 0f3fab8b618b37c1615e6e3e8fb156fccbd435ac9690f357b0c36260e5a0e43b
+  metadata.gz: 23e05e5344c4891a0825371e1d79342aedc903e109b0be8f4c79df75b2fe601e
+  data.tar.gz: 2d55c5017831b9041ddc6cd31d862c7a104a22c192762bf6836ba59f94be4312
 SHA512:
-  metadata.gz: ad7c9fc78fcf4ad9a77896dcf9dcecf8bb1ee5f4989fb7a65cf1915ccb2fc5d97fcb94f77882dd9b5df59b33491baef93f1d3dea3afff6479d583720153251d7
-  data.tar.gz: 29515290b0b20db4e94e5a0eab7e4961d3d43dfd3a304a399006d53878ea6133df4d4edf5da202f3e5aa8ea70ede885a7e3c450f147057663e20c2f39cceca86
+  metadata.gz: db63885b16aeaa6872dd46b35268d044be86f514432d6e97eaef6245a6987e797c8f4ea55d5648c77c288cbb342b95401a8076c6d4d7141ffcaa54b781bfb6b5
+  data.tar.gz: b3d3ae0dff813cd203df53c8d1d2f6902093457819e2e325885fae2a855de39d6676b0c9392ef25fc904477945a92cd8ba20e535e70f8ad4c4dec661a51c0250

data/Gemfile

@@ -1,9 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in slackiq.gemspec
 gemspec
 
-group :development, :test do
-  gem "sidekiq"
-  gem "rspec-sidekiq"
-end
+gem "sidekiq"

data/HornsAndHooves-slackiq.gemspec

@@ -1,28 +1,26 @@
 # -*- 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'
+require "slackiq/version"
 
 Gem::Specification.new do |s|
   s.name          = "HornsAndHooves-slackiq"
   s.version       = Slackiq::VERSION
   s.authors       = ["HornsAndHooves", "Peter Maneykowski"]
-  s.email         = ['maneyko@integracredit.com']
-  s.summary       = 'HornsAndHooves: Slack and Sidekiq Pro integration'
+  s.email         = ["maneyko@integracredit.com"]
+  s.summary       = "HornsAndHooves: Slack and Sidekiq Pro integration"
   s.description   = "Slackiq (by HornsAndHooves) integrates Slack and Sidekiq so that you can "\
                     "have vital information about your Sidekiq jobs sent directly to your team's Slack."
-  s.homepage      = 'https://github.com/HornsAndHooves/slackiq'
-  s.license       = 'MIT'
+  s.homepage      = "https://github.com/HornsAndHooves/slackiq"
+  s.license       = "MIT"
 
   s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.bindir        = "exe"
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'httparty'
-  s.add_development_dependency "bundler", "~> 1.10"
-  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
-  s.add_development_dependency "rspec-sidekiq"
 end

data/README.md

@@ -10,7 +10,7 @@ Slackiq (pronounced *slack-kick*) integrates [Slack](https://slack.com/) and [Si
 Add this line to your Gemfile:
 
 ```ruby
-gem 'slackiq'
+gem "slackiq"
 ```
 
 Then run:
@@ -26,8 +26,8 @@ First, set up any number of Slack Incoming Webhooks [from your Slack](https://sl
 Then, you only need to call the `configure` method when your application launches to configure all of the webhooks to which you want to post. If you're using Rails, create an initializer at `config/initializers/slackiq.rb`. Here's an example:
 
 ```ruby
-Slackiq.configure( web_scrapes: 'https://hooks.slack.com/services/HA298HF2/ALSKF2451/lknsaHHA2323KKDKND',
-                   data_processing: 'https://hooks.slack.com/services/HA298HF2/ALSKF2451/H24dLKAHD22423')
+Slackiq.configure( web_scrapes: "https://hooks.slack.com/services/HA298HF2/ALSKF2451/lknsaHHA2323KKDKND",
+                   data_processing: "https://hooks.slack.com/services/HA298HF2/ALSKF2451/H24dLKAHD22423")
 ```
 
 `:web_scrapes` and `data_processing` are examples of keys. Use whatever keys you want.
@@ -57,7 +57,7 @@ class WebScraper
     # Scrape the first 100 URLs in the database
     def scrape_100
       batch = Sidekiq::Batch.new
-      batch.description = 'Scrape the first 100 URLs!'
+      batch.description = "Scrape the first 100 URLs!"
       batch.on(:complete, self)
 
       batch.jobs do
@@ -72,22 +72,22 @@ class WebScraper
   end
 
   def on_complete(status, options)
-    Slackiq.notify(webhook_name: :web_scrapes, status: status, title: 'Scrape Completed!',
-    'Total URLs in DB' => URL.count.to_s,
-    'Servers' => "#{Server.active_count} active, #{Server.inactive_count} inactive")
+    Slackiq.notify(webhook_name: :web_scrapes, status: status, title: "Scrape Completed!",
+    "Total URLs in DB" => URL.count.to_s,
+    "Servers" => "#{Server.active_count} active, #{Server.inactive_count} inactive")
   end
 
 end
 ```
 
-Note that in this case, `'Total URLs in DB'` and `'Servers'` are custom fields that will also appear in Slack!
+Note that in this case, `"Total URLs in DB"` and `"Servers"` are custom fields that will also appear in Slack!
 
 ### Want to send a message to Slack that isn't Sidekiq-related?
 
 No prob. Just:
 
 ```ruby
-Slackiq.message('Server 5 is overloaded!', webhook_name: :data_processing)
+Slackiq.message("Server 5 is overloaded!", webhook_name: :data_processing)
 ```
 
 ## Contributing

data/lib/slackiq/version.rb

@@ -1,3 +1,3 @@
-module Slackiq
-  VERSION = "1.1.13"
+class Slackiq
+  VERSION = "1.3.1".freeze
 end

data/lib/slackiq.rb

@@ -1,157 +1,197 @@
-require 'slackiq/version'
+require "slackiq/version"
 
-require 'net/http'
-require 'json'
-require 'httparty'
+require "net/http"
+require "uri"
+require "json"
+require "date"
 
-require 'slackiq/time_helper'
-require 'slackiq/sidekiq_status'
+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
+
+    return if status.total.to_f <= 0
+
+    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

metadata

@@ -1,60 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: HornsAndHooves-slackiq
 version: !ruby/object:Gem::Version
-  version: 1.1.13
+  version: 1.3.1
 platform: ruby
 authors:
 - HornsAndHooves
 - Peter Maneykowski
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
 - !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:
     - - ">="
@@ -68,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-sidekiq
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,14 +72,12 @@ files:
 - bin/console
 - bin/setup
 - lib/slackiq.rb
-- lib/slackiq/sidekiq_status.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
@@ -122,8 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: 'HornsAndHooves: Slack and Sidekiq Pro integration'
 test_files: []

data/lib/slackiq/sidekiq_status.rb

@@ -1,24 +0,0 @@
-# RSpec::Sidekiq::Batch::Status does not support batch failures.
-# Here, FailureStatus and SuccessStatus circumvent this problem.
-
-if defined?(RSpec)
-  require 'rspec-sidekiq'
-
-  module RSpec
-    module Sidekiq
-      class Batch
-        class FailureStatus < NullStatus
-          def failures
-            1
-          end
-        end
-
-        class SuccessStatus < NullStatus
-          def failures
-            0
-          end
-        end
-      end
-    end
-  end
-end

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