sidekiq-enqueuer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5dbc2cdcd956e6126c1299c490e61057bc1dc61
+  data.tar.gz: 16526ef109984855d5a85018fc2767663d5d3018
+SHA512:
+  metadata.gz: 92c9046d2dd0200b36147283a34d91aaa093168a1646325154e81d81c933ad3c341b080e4b404ec9f6ad9c470042ec028c79da1932c4a0cde871779a2384a1d6
+  data.tar.gz: c8deb9bc67eb0f46d325564d3d0191a39ea26b7a3dc42f79924df4db830a80980637bc349d82e5d1372045a35ee96f734738eb8534aa58fcc3917187b8451eb5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-enqueuer.gemspec
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+# Sidekiq::Enqueuer
+
+A Sidekiq Web extension to enqueue/schedule job in Web UI. Support both Sidekiq::Worker and ActiveJob.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-enqueuer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-enqueuer
+
+## Usage
+
+Visit the Sidekiq Web, click the Enqueuer tab.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/richfisher/sidekiq-enqueuer.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/enqueuer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq/enqueuer/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  enqueuer: Enqueuer

data/lib/sidekiq/enqueuer/railtie.rb

@@ -0,0 +1,6 @@
+module Sidekiq::Enqueuer
+  class Railtie < ::Rails::Railtie
+    initializer "sidekiq_enqueuer_loaded" do
+    end
+  end
+end

data/lib/sidekiq/enqueuer/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Enqueuer
+    VERSION = "1.0.0"
+  end
+end

data/lib/sidekiq/enqueuer/views/index.erb

@@ -0,0 +1,20 @@
+<h3>Enqueuer</h3>
+
+<table class="table table-hover table-bordered table-striped table-white">
+	<thead>
+		<tr>
+			<th>Name</th>
+			<th>Params</th>
+			<th>Actions</th>
+		</tr>		
+	</thead>
+	<tbody>
+		<% for job in @jobs %>
+			<tr>
+				<td><%= job %></td>
+				<td><%= get_job_perform_params(job).join(', ') %></td>
+				<td><a href="<%= root_path %>enqueuer/<%= job %>" class="btn btn-danger btn-xs" style="color: white;">Enqueue Form</a></td>
+			</tr>
+		<% end %>
+	</tbody>
+</table>

data/lib/sidekiq/enqueuer/views/new.erb

@@ -0,0 +1,32 @@
+<h3>Enqueuer</h3>
+
+<form method="post" action="<%= root_path %>enqueuer">
+	<%= csrf_tag if respond_to?(:csrf_tag) %>
+	
+	<div class="form-group">
+		<label for="job_class_name">Job Class/Module</label>
+		<input class="form-control" name="job_class_name" value="<%= @klass %>" readonly=readonly /> 
+	</div>
+
+	<% for param in get_job_perform_params(@klass) %>
+		<div class="form-group">
+			<label for="peform[<%= param %>]"><%= param %></label>
+			<input class="form-control" name="perform[<%= param %>]" /> 
+		</div>
+	<% end %>
+
+	<div class="form-group">
+		<input type="submit" class="btn btn-danger" name="submit" value="Enqueue" />
+	</div>
+
+	<div class="form-group">
+		<hr />
+	</div>
+
+	<div class="form-group">
+		<label for="enqueue_in">Enqueue in</label>
+		<input class="form-control" name="enqueue_in" placeholder="x seconds" /> 
+	</div>
+
+	<input type="submit" class="btn btn-danger" name="submit" value="Schedule" />
+</form>

data/lib/sidekiq/enqueuer/web_extension.rb

@@ -0,0 +1,37 @@
+module Sidekiq::Enqueuer::WebExtension
+  def self.registered(app)
+    view_path = File.join(File.expand_path("..", __FILE__), "views")
+
+    app.helpers do
+      def get_job_perform_params(klass_or_module)
+        klass_or_module.instance_method(:perform).parameters.map{ |e| e[1]}
+      end
+    end
+
+    app.get "/enqueuer" do
+      @jobs = Sidekiq::Enqueuer.get_jobs
+
+      render(:erb, File.read(File.join(view_path, "index.erb")))
+    end
+
+    app.get "/enqueuer/:job_class_name" do
+      @klass = params[:job_class_name].constantize
+      render(:erb, File.read(File.join(view_path, "new.erb")))
+    end
+
+    app.post "/enqueuer" do
+      klass = params[:job_class_name].constantize
+
+      if params['submit'] == 'Enqueue'
+        Sidekiq::Enqueuer.perform_async(klass, params['perform'].values)
+      end
+
+      if params['submit'] == 'Schedule'
+        Sidekiq::Enqueuer.perform_in(klass, params['enqueue_in'], params['perform'].values)
+      end
+
+      redirect "#{root_path}enqueuer"
+    end
+
+  end
+end

data/lib/sidekiq/enqueuer.rb

@@ -0,0 +1,62 @@
+require 'sidekiq/web'
+require "sidekiq/enqueuer/version"
+require 'sidekiq/enqueuer/web_extension'
+require 'sidekiq/enqueuer/railtie' if defined? ::Rails::Railtie
+
+module Sidekiq
+  module Enqueuer
+    def self.eager_load
+      has_eager_loaded = false
+      if defined?(::Rails) && ::Rails.env != 'production' && has_eager_loaded == false
+        ::Rails.application.eager_load! 
+        has_eager_loaded = true
+      end
+    end
+
+    def self.get_job_modules
+      ObjectSpace.each_object(Module).select { |klass| has_worker_module?(klass) }
+                                     .delete_if {|klass| klass.to_s =~ /^Sidekiq::Extensions/}
+                                     .delete_if {|klass| klass.to_s =~ /^ActiveJob::QueueAdapters/}
+    end
+
+    def self.get_job_classes
+      ObjectSpace.each_object(Class).select { |klass| is_job_class?(klass) }
+    end
+
+    def self.get_jobs
+      eager_load
+      jobs = get_job_modules + get_job_classes
+      jobs.map(&:to_s).uniq.map(&:constantize)
+    end
+
+    def self.is_job_class?(klass)
+      klass < ::ActiveJob::Base
+    end
+
+    def self.has_worker_module?(klass)
+      klass.included_modules.include? ::Sidekiq::Worker
+    end
+
+    def self.perform_async(klass, values)
+      if is_job_class?(klass)
+        klass.perform_later(*values)
+      elsif has_worker_module?(klass)
+        klass.perform_async(*values)
+      end
+    end
+
+    def self.perform_in(klass, seconds_str, values)
+      seconds = seconds_str.to_i.seconds
+      if is_job_class?(klass)
+        klass.set(wait: seconds).perform_later(*values)
+      elsif has_worker_module?(klass)
+        klass.perform_in(seconds, *values)
+      end
+    end
+
+  end
+end
+
+Sidekiq::Web.register Sidekiq::Enqueuer::WebExtension
+Sidekiq::Web.tabs["Enqueuer"] = "enqueuer"
+Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "enqueuer/locales")

data/sidekiq-enqueuer.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/enqueuer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-enqueuer"
+  spec.version       = Sidekiq::Enqueuer::VERSION
+  spec.authors       = ["richfisher"]
+  spec.email         = ["richfisher.pan@gmail.com"]
+
+  spec.summary       = %q{A Sidekiq Web extension to enqueue/schedule job in Web UI.}
+  spec.description   = %q{A Sidekiq Web extension to enqueue/schedule job in Web UI. Support both Sidekiq::Worker and ActiveJob.}
+  spec.homepage      = "https://github.com/richfisher/sidekiq-enqueuer"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "sidekiq"
+  spec.add_development_dependency "rails", '> 4.2'
+  spec.add_development_dependency "sinatra"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-enqueuer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- richfisher
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rack-test
+  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: sidekiq
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
+description: A Sidekiq Web extension to enqueue/schedule job in Web UI. Support both
+  Sidekiq::Worker and ActiveJob.
+email:
+- richfisher.pan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/enqueuer.rb
+- lib/sidekiq/enqueuer/locales/en.yml
+- lib/sidekiq/enqueuer/railtie.rb
+- lib/sidekiq/enqueuer/version.rb
+- lib/sidekiq/enqueuer/views/index.erb
+- lib/sidekiq/enqueuer/views/new.erb
+- lib/sidekiq/enqueuer/web_extension.rb
+- sidekiq-enqueuer.gemspec
+homepage: https://github.com/richfisher/sidekiq-enqueuer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Sidekiq Web extension to enqueue/schedule job in Web UI.
+test_files: []