sidekiq_adhoc_scheduler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0403c22706ae767ef5b12de8e937ee5c3e96e651f05e8bc0d294e5649b42b76f
+  data.tar.gz: 3f7f16ee529157c2e999d0b453f127752b52e5acb87ece3d61b8461b78b0e2f5
+SHA512:
+  metadata.gz: 9b02cf070317386377e5b9055e045e0ca2892374984fe4ccd1c81b77d8debabc3fb89f21c5579178316cb2e6a85c6d11108f889776e1df390794f3dacb4b2cf3
+  data.tar.gz: 52662306703c77c953d7c46e62369deb543ce889b9c15c2b3389d3f76ef6c11d03b45f9098cd441b7c1cc67872220000aaf1a865a1b75c3023bfb0086ad8befc

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 khaile
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Sidekiq Addhoc Scheduler
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sidekiq_adhoc_scheduler", :git => "git@github.com:khaile/sidekiq_adhoc_scheduler.git"
+```
+
+And then execute:
+
+  ```bash
+    bundle
+  ```
+
+Or install itself as:
+
+  ```bash
+    gem install sidekiq_adhoc_scheduler
+  ```
+
+## Usage
+
+To enable this extension, insert this piece of code in your app at the initialization stage:
+
+```ruby
+require 'sidekiq_adhoc_scheduler'
+````

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation'
+end
+
+desc 'Run tests'
+task default: :spec

data/lib/sidekiq_adhoc_scheduler.rb

@@ -0,0 +1,8 @@
+require 'sidekiq/web' unless defined?(Sidekiq::Web)
+require 'sidekiq_adhoc_scheduler/web'
+
+module SidekiqAdhocScheduler
+  Sidekiq::Web.register(SidekiqAdhocScheduler::Web)
+  Sidekiq::Web.tabs['adhoc_schedulers'] = 'adhoc-schedulers'
+  Sidekiq::Web.locales << File.expand_path('web/locales', __dir__)
+end

data/lib/sidekiq_adhoc_scheduler/version.rb

@@ -0,0 +1,3 @@
+module SidekiqAdhocScheduler
+  VERSION = '0.0.1'.freeze
+end

data/lib/sidekiq_adhoc_scheduler/web.rb

@@ -0,0 +1,129 @@
+module SidekiqAdhocScheduler
+  module Web
+    VIEW_PATH = File.expand_path('../../web/views', __dir__)
+
+    def self.registered(app)
+      app.get '/schedulers' do
+        @schedulers = Sidekiq.get_all_schedules
+        erb File.read(File.join(VIEW_PATH, 'scheduler.html.erb'))
+      end
+
+      app.get '/scheduler/:id' do
+        @scheduler = Sidekiq.get_schedule(params[:id])
+        erb File.read(File.join(VIEW_PATH, 'scheduler_edit.html.erb'))
+      end
+
+      app.put '/scheduler/:id' do
+        job_name = params[:id]
+
+        unless job_name.to_s.strip.empty?
+          @scheduler = Sidekiq.get_schedule(params[:id])
+          data = {
+            class: params[:scheduler]['class'],
+            queue: params[:scheduler]['queue'],
+            description: params[:scheduler]['description'],
+            args: params[:scheduler]['args']
+          }
+
+          unless params[:scheduler]['args'].to_s.strip.empty?
+            args = params[:scheduler]['args'].to_s.strip
+            if args.include?('[')
+              begin
+                data[:args] = JSON.parse(args)
+              rescue JSON::ParserError => e
+                redirect "#{root_path}scheduler/#{params[:id]}"
+              end
+            else
+              data[:args] = args
+            end
+          end
+
+          if !params[:scheduler]['cron'].to_s.strip.empty?
+            data[:cron] = params[:scheduler]['cron']
+          elsif !params[:scheduler]['every'].to_s.strip.empty?
+            every = params[:scheduler]['every'].to_s.strip
+            if every.include?('[')
+              begin
+                data[:every] = JSON.parse(every)
+              rescue JSON::ParserError => e
+                redirect "#{root_path}scheduler/#{params[:id]}"
+              end
+            else
+              data[:every] = every
+            end
+          end
+
+          Sidekiq.set_schedule(job_name, data)
+        end
+
+        redirect "#{root_path}schedulers"
+      end
+
+      app.get '/schedulers/new' do
+        erb File.read(File.join(VIEW_PATH, 'scheduler_new.html.erb'))
+      end
+
+      app.post '/schedulers' do
+        job_name = params[:scheduler]['name']
+
+        unless job_name.to_s.strip.empty?
+          data = {
+            class: params[:scheduler]['class'],
+            queue: params[:scheduler]['queue'],
+            description: params[:scheduler]['description'],
+            args: params[:scheduler]['args']
+          }
+
+          unless params[:scheduler]['args'].to_s.strip.empty?
+            args = params[:scheduler]['args'].to_s.strip
+            if args.include?('[')
+              begin
+                data[:args] = JSON.parse(args)
+              rescue JSON::ParserError => e
+                redirect "#{root_path}scheduler/new"
+              end
+            else
+              data[:args] = args
+            end
+          end
+
+          if !params[:scheduler]['cron'].to_s.strip.empty?
+            data[:cron] = params[:scheduler]['cron']
+          elsif !params[:scheduler]['every'].to_s.strip.empty?
+            every = params[:scheduler]['every'].to_s.strip
+            if every.include?('[')
+              begin
+                data[:every] = JSON.parse(every)
+              rescue JSON::ParserError => e
+                redirect "#{root_path}schedulers/new"
+              end
+            else
+              data[:every] = every
+            end
+          end
+
+          Sidekiq.set_schedule(job_name, data)
+        end
+
+        redirect "#{root_path}schedulers"
+      end
+
+      app.delete '/scheduler/:id' do
+        schedules = Sidekiq.get_all_schedules.reject { |k, _v| k == params[:id] }
+        Sidekiq.schedule = schedules
+        redirect "#{root_path}schedulers"
+      end
+
+      app.get '/scheduler/:id/reject' do
+        Sidekiq.remove_schedule(params[:id])
+        redirect "#{root_path}schedulers"
+      end
+
+      app.get '/scheduler/:id/enqueue' do
+        schedule = Sidekiq.get_schedule(params[:id])
+        Sidekiq::Scheduler.enqueue_job(schedule)
+        redirect "#{root_path}schedulers"
+      end
+    end
+  end
+end

data/web/locales/en.yml

@@ -0,0 +1,13 @@
+en:
+  recurring_jobs: Recurring Jobs
+  name: Name
+  description: Description
+  interval: Interval
+  class: Class
+  queue: Queue
+  arguments: Arguments
+  enqueue_now: Enqueue now
+  next_time: Next Time
+  no_next_time: No next execution for this job
+  disable: Disable
+  enable: Enable

data/web/views/scheduler.html.erb

@@ -0,0 +1,47 @@
+<h3><%= t('recurring_jobs') %></h3>
+
+<div class="table_container">
+  <table class="table table-hover table-bordered table-striped table-white">
+    <thead>
+
+    <a class="btn btn-warn btn-xs" href="schedulers/new">
+      <%= t('Create') %>
+    </a>
+    <tr>
+      <th><%= t('name') %></th>
+      <th><%= t('description') %></th>
+      <th><%= t('interval') %></th>
+      <th><%= t('class') %></th>
+      <th><%= t('queue') %></th>
+      <th><%= t('arguments') %></th>
+      <th>Action</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    <% if ! @schedulers.nil? %>
+        <% @schedulers.each do |scheduler| %>
+            <tr>
+              <td><span class="pie"><%= scheduler[0] %></span></td>
+              <td><%= scheduler[1]['description'] %></td>
+              <td><%= !scheduler[1]['cron'].nil? ? scheduler[1]['cron'] : scheduler[1]['every'] %></td>
+              <td><%= scheduler[1]['class'] %></td>
+              <td><%= scheduler[1]['queue'] %></td>
+              <td><%= scheduler[1]['args'] %></td>
+              <td>
+                <a class="btn btn-warn btn-xs" href="<%= root_path %>scheduler/<%= URI.escape(scheduler[0]) %>/enqueue">
+                  <%= t('enqueue_now') %>
+                </a>
+                <a class="btn btn-warn btn-xs" href="<%= root_path %>scheduler/<%= URI.escape(scheduler[0]) %>">
+                  <%= t('Edit') %>
+                </a>
+                <a data-confirm="Are you sure want to reject this job?" rel="nofollow" data-method="delete" class="btn btn-warn btn-xs" href="<%= root_path %>scheduler/<%= URI.escape(scheduler[0]) %>/reject">
+                  <%= t('Reject') %>
+                </a>
+              </td>
+            </tr>
+        <% end %>
+    <% end %>
+    </tbody>
+  </table>
+</div>

data/web/views/scheduler_edit.html.erb

@@ -0,0 +1,66 @@
+<h3><%= t('recurring_jobs') %></h3>
+
+<form action="<%= root_path %>scheduler/<%= params[:id] %>" accept-charset="UTF-8" method="post">
+  <input type="hidden" name="_method" value="put">
+  <%= csrf_tag %>
+
+  <div class="form-group">
+    <label class="col-lg-3 control-label" for="name">Name</label>
+    <div class="col-lg-7">
+      <input class="form-control required" disabled="disabled" type="text" value="<%= params[:id] %>">
+    </div>
+  </div>
+
+  <div class="form-group">
+    <label class="col-lg-3 control-label" for="name">description</label>
+    <div class="col-lg-7">
+      <input class="form-control required" placeholder="description" name="scheduler[description]" type="text" value="<%= @scheduler['description'] %>">
+    </div>
+  </div>
+
+  <div class="form-group">
+    <label class="col-lg-3 control-label" for="name">Cron</label>
+    <div class="col-lg-7">
+      <input class="form-control required" placeholder="cron" name="scheduler[cron]" type="text" value="<%= @scheduler['cron'] %>">
+    </div>
+  </div>
+
+  <div class="form-group">
+    <label class="col-lg-3 control-label" for="name">every</label>
+    <div class="col-lg-7">
+      <input class="form-control required" placeholder="every" name="scheduler[every]" type="text" value='<%= @scheduler['every'].is_a?(Array) ? JSON.unparse(@scheduler['every']) : @scheduler['every'] %>'>
+    </div>
+  </div>
+
+  <div class="form-group">
+    <label class="col-lg-3 control-label" for="name">class</label>
+    <div class="col-lg-7">
+      <input class="form-control required" placeholder="class" name="scheduler[class]" type="text" value="<%= @scheduler['class'] %>">
+    </div>
+  </div>
+
+  <div class="form-group">
+    <label class="col-lg-3 control-label" for="name">args</label>
+    <div class="col-lg-7">
+      <input class="form-control required" placeholder="args" name="scheduler[args]" type="text" value="<%= @scheduler['args'] %>">
+    </div>
+  </div>
+
+  <div class="form-group">
+    <label class="col-lg-3 control-label" for="name">queue</label>
+    <div class="col-lg-7">
+      <input class="form-control required" placeholder="queue" name="scheduler[queue]" type="text" value="<%= @scheduler['queue'] %>">
+    </div>
+  </div>
+
+  <div class="form-group">
+    <div class="col-lg-12 text-center">
+      <a href="<%= root_path %>schedulers">Cancel</a>
+      <button name="button" type="submit">Submit</button>
+    </div>
+  </div>
+</form>
+
+
+
+

data/web/views/scheduler_new.html.erb

@@ -0,0 +1,65 @@
+<form action="<%= root_path %>schedulers" accept-charset="UTF-8" method="post">
+  <%= csrf_tag %>
+    <div class="form-group">
+      <label class="col-lg-3 control-label" for="name">name</label>
+      <div class="col-lg-7">
+        <input class="form-control required" name="scheduler[name]"
+               type="text" value="">
+      </div>
+    </div>
+
+    <div class="form-group">
+      <label class="col-lg-3 control-label" for="name">description</label>
+      <div class="col-lg-7">
+        <input class="form-control required" name="scheduler[description]"
+               type="text" value="">
+      </div>
+    </div>
+
+    <div class="form-group">
+      <label class="col-lg-3 control-label" for="name">Cron Job</label>
+      <div class="col-lg-7">
+        <input class="form-control required" name="scheduler[cron]"
+               type="text" value="">
+      </div>
+    </div>
+
+    <div class="form-group">
+      <label class="col-lg-3 control-label" for="name">Every</label>
+      <div class="col-lg-7">
+        <input class="form-control required" name="scheduler[every]"
+               type="text" value="">
+      </div>
+    </div>
+
+    <div class="form-group">
+      <label class="col-lg-3 control-label" for="name">class</label>
+      <div class="col-lg-7">
+        <input class="form-control required" name="scheduler[class]"
+               type="text" value="">
+      </div>
+    </div>
+
+    <div class="form-group">
+      <label class="col-lg-3 control-label" for="name">arguments</label>
+      <div class="col-lg-7">
+        <input class="form-control required" name="scheduler[args]"
+               type="text" value="">
+      </div>
+    </div>
+
+    <div class="form-group">
+      <label class="col-lg-3 control-label" for="name">queue</label>
+      <div class="col-lg-7">
+        <input class="form-control required" name="scheduler[queue]"
+               type="text" value="">
+      </div>
+    </div>
+
+    <div class="form-group">
+      <div class="col-lg-12 text-center">
+        <a href="<%= root_path %>schedulers">Cancel</a>
+        <button name="button" type="submit">Submit</button>
+      </div>
+    </div>
+</form>

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_adhoc_scheduler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Khai Le
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description: Trigger job schedulers adhoc from Sidekiq web admin
+email:
+- khaile.to@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq_adhoc_scheduler.rb
+- lib/sidekiq_adhoc_scheduler/version.rb
+- lib/sidekiq_adhoc_scheduler/web.rb
+- web/locales/en.yml
+- web/views/scheduler.html.erb
+- web/views/scheduler_edit.html.erb
+- web/views/scheduler_new.html.erb
+homepage: https://github.com/khaile/sidekiq_adhoc_scheduler
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Sidekiq addhoc scheduler
+test_files: []