hirefire-resource 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff7c7b164fe5e2bb61f464feda1046fff39f0a100825316dc488bf280f73b0b7
-  data.tar.gz: 840da97d1a8463a1ed71e45bd751c57d90ee2b0e428472871e3142d1c8d03c4e
+  metadata.gz: affa2055a22d9ebc019b20ddace8e5fe042bd7c04115735d88fac5710458eb1d
+  data.tar.gz: d5b2aa9fade2670ca74f1af8e3ed3ba76cfb0b520d0794077f1e0e0bc5e8459b
 SHA512:
-  metadata.gz: 5be7fb8d94c53c24de38fbc2e55dbf4087eac4cfbf6458ca0ec307c502dbdd5b9dec81d932476dac495d9a5ccdb13d9e1a86033f7efc8f32557279a3b94544f0
-  data.tar.gz: a8c2af9bb6384b663f27ff9267f5b6703425b269c32e302224d43e4defd47d580ded7a3020eec710cdf555dff24f9b241c15e8cbb5a4550296ef927267e99c9a
+  metadata.gz: 5f3455375d6259f6d1142056af6c3285fcbfe6aafeac6e0d92778b49e9a2818378edebe6d68f6cecf74522e11b78932361f69c5fe4328ca3768937a42a7541ed
+  data.tar.gz: aad73cc64b02064a4b8d4bd451f578415939300dcaeed6345315bcff99268943c70d774c820d591b7deaa6afd60edeee1c2fd64928847078111f4ccd8c6fafb9

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.2
+        bundler-cache: true
+    - name: Run standardrb
+      run: bundle exec rake standard

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.10.0
+
+* Support Latency (Sidekiq)
+* Rename the "quantity" property to "value" in JSON response ("quantity" is still supported)
+
 ## v0.9.1
 
 * Support GoodJob > 2.2 where Job class is renamed to Execution

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+gem "rake"
+gem "standardrb"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    hirefire-resource (0.9.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.5.0)
+      rubocop (= 1.23.0)
+      rubocop-performance (= 1.12.0)
+    standardrb (1.0.0)
+      standard
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  hirefire-resource!
+  rake
+  standardrb
+
+BUNDLED WITH
+   2.2.24

data/Rakefile

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "standard/rake"

data/hirefire-resource.gemspec

@@ -1,21 +1,19 @@
-Gem::Specification.new do |gem|
-  gem.name = "hirefire-resource"
-  gem.version = "0.9.1"
-  gem.platform = Gem::Platform::RUBY
-  gem.authors = "Michael van Rooijen"
-  gem.email = "michael@hirefire.io"
-  gem.homepage = "https://www.hirefire.io"
-  gem.summary = "Autoscaling for your Heroku dynos"
-  gem.description = "Load- and schedule-based scaling for web- and worker dynos"
-  gem.licenses = ["Apache License"]
-  gem.metadata = {
+Gem::Specification.new do |spec|
+  spec.name = "hirefire-resource"
+  spec.version = "0.10.0"
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = "Michael van Rooijen"
+  spec.email = "michael@hirefire.io"
+  spec.homepage = "https://www.hirefire.io"
+  spec.summary = "Autoscaling for your Heroku dynos"
+  spec.description = "Load- and schedule-based scaling for web- and worker dynos"
+  spec.licenses = ["Apache License"]
+  spec.metadata = {
     "homepage_uri" => "https://www.hirefire.io",
     "changelog_uri" => "https://github.com/hirefire/hirefire-resource/blob/master/CHANGELOG.md",
     "source_code_uri" => "https://github.com/hirefire/hirefire-resource/",
-    "bug_tracker_uri" => "https://github.com/hirefire/hirefire-resource/issues",
+    "bug_tracker_uri" => "https://github.com/hirefire/hirefire-resource/issues"
   }
-
-  gem.files = %x[git ls-files].split("\n")
-  gem.executables = ["hirefire", "hirefireapp"]
-  gem.require_path = "lib"
+  spec.files = `git ls-files`.split("\n")
+  spec.require_path = "lib"
 end

data/lib/hirefire/macro/bunny.rb

@@ -27,10 +27,10 @@ module HireFire
 
         queues.flatten!
 
-        if queues.last.is_a?(Hash)
-          options = queues.pop
+        options = if queues.last.is_a?(Hash)
+          queues.pop
         else
-          options = {}
+          {}
         end
 
         if options[:durable].nil?
@@ -43,38 +43,33 @@ module HireFire
           channel = nil
           begin
             channel = connection.create_channel
-            return count_messages(channel, queues, options)
+            count_messages(channel, queues, options)
           ensure
-            if channel
-              channel.close
-            end
+            channel&.close
           end
         elsif options[:amqp_url]
           connection = ::Bunny.new(options[:amqp_url])
           begin
             connection.start
             channel = connection.create_channel
-            return count_messages(channel, queues, options)
+            count_messages(channel, queues, options)
           ensure
-            if channel
-              channel.close
-            end
-
+            channel&.close
             connection.close
           end
         else
-          raise %{Must pass in :connection => rabbitmq_connection or :amqp_url => url\n} +
-                  %{For example: HireFire::Macro::Bunny.queue("queue1", :connection => rabbitmq_connection}
+          raise %(Must pass in :connection => rabbitmq_connection or :amqp_url => url\n) +
+            %{For example: HireFire::Macro::Bunny.queue("queue1", :connection => rabbitmq_connection}
         end
       end
 
       def count_messages(channel, queue_names, options)
         queue_names.inject(0) do |sum, queue_name|
-          if options.key?(:'x-max-priority')
-            queue = channel.queue(queue_name, :durable   => options[:durable],
-                                              :arguments => {"x-max-priority" => options[:'x-max-priority']})
+          queue = if options.key?(:'x-max-priority')
+            channel.queue(queue_name, durable: options[:durable],
+                                              arguments: {"x-max-priority" => options[:'x-max-priority']})
           else
-            queue = channel.queue(queue_name, :durable => options[:durable])
+            channel.queue(queue_name, durable: options[:durable])
           end
           sum + queue.message_count
         end

data/lib/hirefire/macro/delayed_job.rb

@@ -35,26 +35,26 @@ module HireFire
         def queue(*queues)
           queues.flatten!
 
-          if queues.last.is_a?(Hash)
-            options = queues.pop
+          options = if queues.last.is_a?(Hash)
+            queues.pop
           else
-            options = {}
+            {}
           end
 
           case options[:mapper]
           when :active_record
             c = ::Delayed::Job
-            c = c.where(:failed_at => nil)
+            c = c.where(failed_at: nil)
             c = c.where("run_at <= ?", Time.now.utc)
             c = c.where("priority >= ?", options[:min_priority]) if options.key?(:min_priority)
             c = c.where("priority <= ?", options[:max_priority]) if options.key?(:max_priority)
-            c = c.where(:queue => queues) unless queues.empty?
+            c = c.where(queue: queues) unless queues.empty?
             c.count.tap { ActiveRecord::Base.clear_active_connections! }
           when :active_record_2
             c = ::Delayed::Job
-            c = c.scoped(:conditions => ["run_at <= ? AND failed_at is NULL", Time.now.utc])
-            c = c.scoped(:conditions => ["priority >= ?", options[:min_priority]]) if options.key?(:min_priority)
-            c = c.scoped(:conditions => ["priority <= ?", options[:max_priority]]) if options.key?(:max_priority)
+            c = c.scoped(conditions: ["run_at <= ? AND failed_at is NULL", Time.now.utc])
+            c = c.scoped(conditions: ["priority >= ?", options[:min_priority]]) if options.key?(:min_priority)
+            c = c.scoped(conditions: ["priority <= ?", options[:max_priority]]) if options.key?(:max_priority)
             # There is no queue column in delayed_job <= 2.x
             c.count.tap do
               if ActiveRecord::Base.respond_to?(:clear_active_connections!)
@@ -63,14 +63,14 @@ module HireFire
             end
           when :mongoid
             c = ::Delayed::Job
-            c = c.where(:failed_at => nil)
+            c = c.where(failed_at: nil)
             c = c.where(:run_at.lte => Time.now.utc)
             c = c.where(:priority.gte => options[:min_priority]) if options.key?(:min_priority)
             c = c.where(:priority.lte => options[:max_priority]) if options.key?(:max_priority)
             c = c.where(:queue.in => queues) unless queues.empty?
             c.count
           else
-            raise %{Must pass in :mapper => :active_record or :mapper => :mongoid\n} +
+            raise %(Must pass in :mapper => :active_record or :mapper => :mongoid\n) +
               %{For example: HireFire::Macro::Delayed::Job.queue("worker", :mapper => :active_record)}
           end
         end

data/lib/hirefire/macro/qu.rb

@@ -17,7 +17,10 @@ module HireFire
       #
       def queue(*queues)
         queues = ::Qu.backend.queues if queues.empty?
-        queues.flatten.inject(0) { |memo, queue| memo += ::Qu.backend.length(queue); memo }
+        queues.flatten.inject(0) { |memo, queue|
+          memo += ::Qu.backend.length(queue)
+          memo
+        }
       end
     end
   end

data/lib/hirefire/macro/que.rb

@@ -16,7 +16,7 @@ module HireFire
       # @return [Integer] the number of jobs in the queue(s).
       #
       def queue(*queues)
-        query   = queues.empty? && base_query || base_query + " AND queue IN (#{names(queues)})"
+        query = queues.empty? && base_query || base_query + " AND queue IN (#{names(queues)})"
         results = ::Que.execute(query).first
         (results[:total] || results["total"]).to_i
       end

data/lib/hirefire/macro/sidekiq.rb

@@ -5,9 +5,19 @@ module HireFire
     module Sidekiq
       extend self
 
+      # The latency in seconds for the provided queue.
+      #
+      # @example Sidekiq Queue Latency Macro Usage
+      #   HireFire::Macro::Sidekiq.queue # default queue
+      #   HireFire::Macro::Sidekiq.queue("email") # email queue
+      #
+      def latency(queue = "default")
+        ::Sidekiq::Queue.new(queue).latency
+      end
+
       # Counts the amount of jobs in the (provided) Sidekiq queue(s).
       #
-      # @example Sidekiq Macro Usage
+      # @example Sidekiq Queue Size Macro Usage
       #   HireFire::Macro::Sidekiq.queue # all queues
       #   HireFire::Macro::Sidekiq.queue("email") # only email queue
       #   HireFire::Macro::Sidekiq.queue("audio", "video") # audio and video queues
@@ -23,10 +33,10 @@ module HireFire
 
         queues.flatten!
 
-        if queues.last.is_a?(Hash)
-          options = queues.pop
+        options = if queues.last.is_a?(Hash)
+          queues.pop
         else
-          options = {}
+          {}
         end
 
         queues.map!(&:to_s)
@@ -54,11 +64,11 @@ module HireFire
         in_queues = stats.enqueued
 
         if !options[:skip_scheduled]
-          in_schedule = ::Sidekiq.redis { |c| c.zcount('schedule', '-inf', Time.now.to_f) }
+          in_schedule = ::Sidekiq.redis { |c| c.zcount("schedule", "-inf", Time.now.to_f) }
         end
 
         if !options[:skip_retries]
-          in_retry = ::Sidekiq.redis { |c| c.zcount('retry', '-inf', Time.now.to_f) }
+          in_retry = ::Sidekiq.redis { |c| c.zcount("retry", "-inf", Time.now.to_f) }
         end
 
         if !options[:skip_working]
@@ -102,9 +112,9 @@ module HireFire
         if !options[:skip_working]
           # Objects yielded to Workers#each:
           # https://github.com/mperham/sidekiq/blob/305ab8eedc362325da2e218b2a0e20e510668a42/lib/sidekiq/api.rb#L912
-          in_progress = ::Sidekiq::Workers.new.select do |key, tid, job|
-            queues.include?(job['queue']) && job['run_at'] <= now
-          end.size
+          in_progress = ::Sidekiq::Workers.new.count do |key, tid, job|
+            queues.include?(job["queue"]) && job["run_at"] <= now
+          end
         end
 
         [in_queues, in_schedule, in_retry, in_progress].compact.inject(&:+)

data/lib/hirefire/middleware.rb

@@ -2,14 +2,13 @@
 
 module HireFire
   class Middleware
-
     # Initializes HireFire::Middleware.
     #
     # @param [Proc] app call with `env` to continue down the middleware stack.
     #
     def initialize(app)
-      @app         = app
-      @token       = ENV["HIREFIRE_TOKEN"]
+      @app = app
+      @token = ENV["HIREFIRE_TOKEN"]
       @path_prefix = get_path_prefix
     end
 
@@ -77,9 +76,9 @@ module HireFire
     # @return [String] in text/html format.
     #
     def build_test_response
-      status  = 200
+      status = 200
       headers = {"Content-Type" => "text/html"}
-      body    = "HireFire Middleware Found!"
+      body = "HireFire Middleware Found!"
 
       [status, headers, [body]]
     end
@@ -91,14 +90,14 @@ module HireFire
     #
     def build_info_response
       entries = HireFire::Resource.dynos.map do |config|
-        %({"name":"#{config[:name]}","quantity":#{config[:quantity].call || "null"}})
+        %({"name":"#{config[:name]}","value":#{config[:value].call || "null"}})
       end
 
-      status                   = 200
-      headers                  = Hash.new
-      headers["Content-Type"]  = "application/json"
+      status = 200
+      headers = {}
+      headers["Content-Type"] = "application/json"
       headers["Cache-Control"] = "must-revalidate, private, max-age=0"
-      body                     = "[" + entries.join(",") + "]"
+      body = "[" + entries.join(",") + "]"
 
       [status, headers, [body]]
     end

data/lib/hirefire/resource.rb

@@ -42,10 +42,10 @@ module HireFire
     # Will be used through block-style configuration with the `configure` method.
     #
     # @param [Symbol, String] name the name of the dyno as defined in the Procfile.
-    # @param [Proc] block an Integer containing the quantity calculation logic.
+    # @param [Proc] block an Integer containing the value calculation logic.
     #
     def dyno(name, &block)
-      dynos << { :name => name, :quantity => block }
+      dynos << {name: name, value: block}
     end
   end
 end

metadata

@@ -1,33 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: hirefire-resource
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies: []
 description: Load- and schedule-based scaling for web- and worker dynos
 email: michael@hirefire.io
-executables:
-- hirefire
-- hirefireapp
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- bin/hirefire
-- bin/hirefireapp
 - hirefire-resource.gemspec
 - lib/hirefire-resource.rb
-- lib/hirefire/cli.rb
 - lib/hirefire/macro/bunny.rb
 - lib/hirefire/macro/delayed_job.rb
 - lib/hirefire/macro/good_job.rb

data/bin/hirefire

@@ -1,4 +0,0 @@
-#! /usr/bin/env ruby
-
-require File.expand_path("../../lib/hirefire/cli", __FILE__)
-

data/bin/hirefireapp

@@ -1,5 +0,0 @@
-#! /usr/bin/env ruby
-
-puts "Please use the `hirefire` utility instead of the `hirefireapp` utility."
-exit 1
-

data/lib/hirefire/cli.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "open-uri"
-require "openssl"
-
-OpenSSL::SSL.send(:remove_const, :VERIFY_PEER)
-OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
-
-def usage
-  puts(<<-EOS)
-
-Usage:
-
-  hirefire http://mydomain.com/
-
-Or locally:
-
-  gem install thin
-  [bundle exec] thin start -p 3000
-  hirefire http://127.0.0.1:3000/
-
-SSL Enabled URLs:
-
-  hirefire https://mydomain.com/
-
-EOS
-end
-
-if (url = ARGV[0]).nil?
-  usage
-else
-  begin
-    response = open(File.join(url, "hirefire", "test")).read
-  rescue
-    puts
-    puts "Error: Could not connect to: #{url}"
-    usage
-    exit 1
-  end
-
-  if response =~ /HireFire/
-    puts response
-  else
-    puts "Error: Could not find HireFire at #{url}."
-    exit 1
-  end
-end