sidekiq_adhoc_job 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbb78def72673141d39f88a5cdd7b3142da526620ce4ec42829cac57cc35f398
+  data.tar.gz: ae4d22cb3bcaeef550515011c282368bd6f6ccb75b93a9b6fc397af87cdd9662
+SHA512:
+  metadata.gz: 50288dad7f7287ceed184e0327febe69b26eccf994a81f335819aa6b15bc9c8c300e7da3c373dce6ea3de3beb5b4cabf0539c25765dab3659cda63041d97cb9e
+  data.tar.gz: e6f3e09e7c731034059bfc6085219a20c401385d65b52fd57d659ab739a0d6d4c41d8a1fd330d47256ebb62b9d5e7c841711383897ed36db0ebfc6ed8988b541

data/lib/sidekiq_adhoc_job/services/schedule_adhoc_job.rb

@@ -0,0 +1,32 @@
+module SidekiqAdhocJob
+  class ScheduleAdhocJob
+
+    StringUtil ||= ::SidekiqAdhocJob::Utils::String
+
+    def initialize(job_name, request_params)
+      @request_params = request_params.inject({}) do |acc, (k, v)|
+        acc[k.to_sym] = v
+        acc
+      end
+      @worker_klass = WorkerClassesLoader.find_worker_klass(job_name)
+      parse_params
+    end
+
+    def call
+      worker_klass.perform_async(*worker_params)
+    end
+
+    private
+
+    attr_reader :request_params, :worker_klass, :allowed_params, :worker_params
+
+    def parse_params
+      @allowed_params = worker_klass.new.method(:perform).parameters.reject { |type, _| type == :rest }.flat_map(&:last)
+      @worker_params = allowed_params.map { |key| StringUtil.parse(request_params[key]) }
+      if !!request_params[:rest_args] && !request_params[:rest_args].empty?
+        @worker_params += request_params[:rest_args].split(',').map { |arg| StringUtil.parse(arg.strip) }
+      end
+    end
+
+  end
+end

data/lib/sidekiq_adhoc_job/utils/string.rb

@@ -0,0 +1,108 @@
+# References: https://github.com/hanami/utils/blob/master/lib/hanami/utils/string.rb
+module SidekiqAdhocJob
+  module Utils
+    class String
+
+      EMPTY_STRING               ||= ''.freeze
+      CLASSIFY_SEPARATOR         ||= '_'.freeze
+      NAMESPACE_SEPARATOR        ||= '::'.freeze
+      UNDERSCORE_SEPARATOR       ||= '/'.freeze
+      UNDERSCORE_DIVISION_TARGET ||= '\1_\2'.freeze
+      DASHERIZE_SEPARATOR        ||= '-'.freeze
+      CLASSIFY_WORD_SEPARATOR    ||= /#{CLASSIFY_SEPARATOR}|#{NAMESPACE_SEPARATOR}|#{UNDERSCORE_SEPARATOR}|#{DASHERIZE_SEPARATOR}/.freeze
+
+      # Return a CamelCase version of the string
+      # If the given string is a file name, it will convert each file directory into a CamelCase namespace
+      #
+      # @see https://github.com/hanami/utils/blob/92ef4464f7ae3e5acba4b8fadc1c8225a81b9b76/lib/hanami/utils/string.rb#L223
+      #
+      # @param input [::String] the input
+      #
+      # @return [::String] the transformed string
+      #
+      # @since 0.1.0
+      #
+      # @example
+      #   require 'sidekiq_adhoc_job/utils/string'
+      #
+      #   SidekiqAdhocJob::Utils::String.classify('sidekiq_adhoc_job') # => 'SidekiqAdhocJob'
+      #   SidekiqAdhocJob::Utils::String.classify('sidekiq_adhoc_job/utils/string') # => 'SidekiqAdhocJob::Utils::String'
+      def self.classify(input)
+        string = ::String.new(input.to_s)
+        words = underscore(string).split(CLASSIFY_WORD_SEPARATOR).map!(&:capitalize)
+        delimiters = underscore(string).scan(CLASSIFY_WORD_SEPARATOR)
+
+        delimiters.map! do |delimiter|
+          delimiter == CLASSIFY_SEPARATOR ? EMPTY_STRING : NAMESPACE_SEPARATOR
+        end
+
+        words.zip(delimiters).join
+      end
+
+      # Return a downcased and underscore separated version of the string
+      # If the given string is a namespaced class name, it will convert the namespace separator :: into a file path separator /
+      #
+      # @see https://github.com/hanami/utils/blob/92ef4464f7ae3e5acba4b8fadc1c8225a81b9b76/lib/hanami/utils/string.rb#L250
+      #
+      # @param input [::String] the input
+      #
+      # @return [::String] the transformed string
+      #
+      # @since 0.1.0
+      #
+      # @example
+      #   require 'sidekiq_adhoc_job/utils/string'
+      #
+      #   SidekiqAdhocJob::Utils::String.underscore('SidekiqAdhocJob') # => 'sidekiq_adhoc_job'
+      #   SidekiqAdhocJob::Utils::String.underscore('SidekiqAdhocJob::Utils::String') # => 'sidekiq_adhoc_job/utils/string'
+      def self.underscore(input)
+        string = ::String.new(input.to_s)
+        string.gsub!(NAMESPACE_SEPARATOR, UNDERSCORE_SEPARATOR)
+        string.gsub!(/([A-Z\d]+)([A-Z][a-z])/, UNDERSCORE_DIVISION_TARGET)
+        string.gsub!(/([a-z\d])([A-Z])/, UNDERSCORE_DIVISION_TARGET)
+        string.gsub!(/[[:space:]]|\-/, UNDERSCORE_DIVISION_TARGET)
+        string.downcase
+      end
+
+      def self.constantize(input)
+        names = input.split('::')
+        names.shift if names.empty? || names.first.empty?
+
+        constant = Object
+        names.each do |name|
+          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        constant
+      end
+
+      def self.parse(input)
+        return unless input
+
+        if input == 'true'
+          true
+        elsif input == 'false'
+          false
+        elsif (i = parse_integer(input))
+          i
+        elsif (f = parse_float(input))
+          f
+        else
+          input
+        end
+      end
+
+      def self.parse_integer(input)
+        Integer(input)
+      rescue ArgumentError => _e
+        nil
+      end
+
+      def self.parse_float(input)
+        Float(input)
+      rescue ArgumentError => _e
+        nil
+      end
+
+    end
+  end
+end

data/lib/sidekiq_adhoc_job/version.rb

@@ -0,0 +1,3 @@
+module SidekiqAdhocJob
+  VERSION = '0.1.2'.freeze
+end

data/lib/sidekiq_adhoc_job/web/job_presenter.rb

@@ -0,0 +1,56 @@
+# References: https://github.com/moove-it/sidekiq-scheduler/blob/master/lib/sidekiq-scheduler/job_presenter.rb
+module SidekiqAdhocJob
+  module Web
+    class JobPresenter
+      include Sidekiq::WebHelpers
+
+      attr_reader :name, :path_name, :queue, :required_args, :optional_args, :has_rest_args, :args
+
+      StringUtil ||= ::SidekiqAdhocJob::Utils::String
+
+      # args: { req: [], opt: [] }
+      def initialize(name, path_name, queue, args)
+        @name = name
+        @path_name = path_name
+        @queue = queue
+        @required_args = args[:req] || []
+        @optional_args = args[:opt] || []
+        @has_rest_args = !!args[:rest]
+        @args = @required_args + @optional_args
+      end
+
+      # Builds the presenter instances for the schedule hash
+      #
+      # @param
+      # @return [Array<JobPresenter>] an array with the instances of presenters
+      def self.build_collection
+        WorkerClassesLoader.worker_klasses.map do |path_name, worker_klass|
+          convert_klass_name_to_presenter(path_name, worker_klass)
+        end
+      end
+
+      def self.find(path_name)
+        klass_name = WorkerClassesLoader.find_worker_klass(path_name)
+
+        return unless klass_name
+
+        convert_klass_name_to_presenter(path_name, klass_name)
+      end
+
+      def self.convert_klass_name_to_presenter(path_name, klass_name)
+        klass_obj = klass_name.new
+        queue = klass_name.sidekiq_options['queue']
+        args = klass_obj
+               .method(:perform)
+               .parameters
+               .group_by { |type, _| type }
+               .inject({}) do |acc, (type, params)|
+                 acc[type] = params.map(&:last)
+                 acc
+               end
+        new(klass_name, path_name, queue, args)
+      end
+
+    end
+  end
+end

data/lib/sidekiq_adhoc_job/web/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  adhoc_jobs: Adhoc Jobs
+  adhoc_jobs_actions: Actions
+  adhoc_jobs_go_back: Go Back
+  adhoc_jobs_has_rest_arguments: Has Rest Arguments
+  adhoc_jobs_name: Job Name
+  adhoc_jobs_optional_arguments: Optional Arguments
+  adhoc_jobs_queue: Job Queue
+  adhoc_jobs_required_arguments: Required Arguments
+  adhoc_jobs_run_job: Run Job
+  adhoc_jobs_view_job: View Job

data/lib/sidekiq_adhoc_job/web/routes/jobs/index.rb

@@ -0,0 +1,17 @@
+module SidekiqAdhocJob
+  module Web
+    module Jobs
+      class Index
+
+        def self.register(app)
+          app.get '/adhoc-jobs' do
+            @presented_jobs = SidekiqAdhocJob::Web::JobPresenter.build_collection
+
+            erb File.read(File.join(VIEW_PATH, 'jobs/index.html.erb'))
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sidekiq_adhoc_job/web/routes/jobs/schedule.rb

@@ -0,0 +1,16 @@
+module SidekiqAdhocJob
+  module Web
+    module Jobs
+      class Schedule
+
+        def self.register(app)
+          app.post '/adhoc-jobs/:name/schedule' do
+            SidekiqAdhocJob::ScheduleAdhocJob.new(params[:name], request.params).call
+            redirect "#{root_path}adhoc-jobs"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sidekiq_adhoc_job/web/routes/jobs/show.rb

@@ -0,0 +1,21 @@
+module SidekiqAdhocJob
+  module Web
+    module Jobs
+      class Show
+
+        def self.register(app)
+          app.get '/adhoc-jobs/:name' do
+            @csrf_token = env['rack.session'][:csrf]
+            @presented_job = SidekiqAdhocJob::Web::JobPresenter.find(params[:name])
+            if @presented_job
+              erb File.read(File.join(VIEW_PATH, 'jobs/show.html.erb'))
+            else
+              redirect "#{root_path}adhoc-jobs"
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sidekiq_adhoc_job/web/templates/jobs/index.html.erb

@@ -0,0 +1,33 @@
+<h3><%= t('adhoc_jobs') %></h3>
+
+<div class="table_container">
+  <table class="table table-hover table-bordered table-striped table-white">
+    <thead>
+      <tr>
+        <th><%= t('adhoc_jobs_name') %></th>
+        <th><%= t('adhoc_jobs_queue') %></th>
+        <th><%= t('adhoc_jobs_required_arguments') %></th>
+        <th><%= t('adhoc_jobs_optional_arguments') %></th>
+        <th><%= t('adhoc_jobs_has_rest_arguments') %></th>
+        <th><%= t('adhoc_jobs_actions') %></th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% @presented_jobs.each do |job| %>
+        <tr>
+          <td><%= job.name %></td>
+          <td><%= job.queue %></td>
+          <td><%= job.required_args.join(', ') %></td>
+          <td><%= job.optional_args.join(', ') %></td>
+          <td><%= job.has_rest_args %></td>
+          <td class="text-center">
+            <a class="btn btn-warn btn-xs" href="<%= root_path %>adhoc-jobs/<%= URI.escape(job.path_name) %>">
+              <%= t('adhoc_jobs_view_job') %>
+            </a>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/lib/sidekiq_adhoc_job/web/templates/jobs/show.html.erb

@@ -0,0 +1,39 @@
+<h3><%= t('adhoc_jobs') %></h3>
+
+<form method="POST" action="<%= root_path %>adhoc-jobs/<%= URI.escape(@presented_job.path_name) %>/schedule">
+  <input type="hidden" name="authenticity_token" value="<%= @csrf_token %>" />
+  <% if @presented_job.args.empty? && !@presented_job.has_rest_args %>
+    <p>No job arguments</p>
+  <% else %>
+    <% @presented_job.required_args.each do |arg| %>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="<%= arg %>">*<%= arg %>:</label>
+        <div class="col-sm-4">
+          <input class="form-control" type="text" name="<%= arg %>" id="<%= arg %>" required/>
+        </div>
+      </div>
+    <% end %>
+    <% @presented_job.optional_args.each do |arg| %>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="<%= arg %>"><%= arg %>:</label>
+        <div class="col-sm-4">
+          <input class="form-control" type="text" name="<%= arg %>" id="<%= arg %>"/>
+        </div>
+      </div>
+    <% end %>
+    <% if @presented_job.has_rest_args %>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="rest_args">*Rest arguments (please separate each argument by comma):</label>
+        <div class="col-sm-4">
+          <input class="form-control" type="text" name="rest_args" id="rest_args" required/>
+        </div>
+      </div>
+    <% end %>
+  <% end %>
+  <div class="form-group row">
+    <div class="col-sm-4">
+      <button type="submit" class="btn btn-danger"><%= t('adhoc_jobs_run_job') %></button>
+      <a class="btn" href="<%= root_path %>adhoc-jobs"><%= t('adhoc_jobs_go_back') %></a>
+    </div>
+  </div>
+</form>

data/lib/sidekiq_adhoc_job/web.rb

@@ -0,0 +1,26 @@
+require 'pathname'
+
+ROUTE_PATH ||= File.expand_path('web/routes', __dir__)
+
+module SidekiqAdhocJob
+  module Web
+    VIEW_PATH  ||= File.expand_path('web/templates', __dir__)
+
+    StringUtil ||= ::SidekiqAdhocJob::Utils::String
+
+    def self.registered(app)
+      Dir[File.join(ROUTE_PATH, '**/*.rb')].each do |file_name|
+        relative_path = ::Pathname.new(file_name).relative_path_from(ROUTE_PATH)
+        module_name = StringUtil.classify(File.dirname(relative_path))
+        klass_name = StringUtil.classify(File.basename(relative_path, '.rb'))
+        namespaced_klass_name = StringUtil.constantize("SidekiqAdhocJob::Web::#{module_name}::#{klass_name}")
+        namespaced_klass_name.register(app)
+      end
+    end
+
+  end
+end
+
+Dir[File.join(ROUTE_PATH, '**/*.rb')].each do |file_name|
+  require_relative file_name
+end

data/lib/sidekiq_adhoc_job/worker_classes_loader.rb

@@ -0,0 +1,52 @@
+module SidekiqAdhocJob
+  class WorkerClassesLoader
+
+    VALID_QUALIFIED_CLASS_NAME ||= /\A(([A-Z]{1}[a-z]+)(::)*)+\z/
+    VALID_WORKER_CLASS_NAME ||= /^.+[^(::)]+Worker$/
+
+    StringUtil ||= Utils::String
+
+    @_worker_klasses = {}
+
+    def self.load(module_names)
+      module_consts = module_names.map { |name| StringUtil.constantize(name.to_s) }
+      module_consts.each do |module_const|
+        module_const.constants.each do |sub_module_const_sym|
+          load_workers(module_const, sub_module_const_sym, @_worker_klasses)
+        end
+      end
+    end
+
+    def self.worker_klasses
+      @_worker_klasses
+    end
+
+    def self.find_worker_klass(path_name)
+      @_worker_klasses[path_name]
+    end
+
+    def self.load_workers(parent_module_const, module_sym, workers)
+      qualified_name = module_sym.to_s
+      return unless VALID_QUALIFIED_CLASS_NAME.match?(qualified_name)
+
+      module_const = begin
+                       StringUtil.constantize(qualified_name)
+                     rescue NameError => _e
+                       qualified_name = [parent_module_const, module_sym].compact.join('::')
+                       begin
+                         StringUtil.constantize(qualified_name)
+                       rescue NameError => _e
+                         nil
+                       end
+                     end
+      return unless module_const && module_const.is_a?(Class)
+
+      if VALID_WORKER_CLASS_NAME.match?(qualified_name)
+        path_name = StringUtil.underscore(qualified_name).gsub('/', '_')
+        workers[path_name] = module_const
+        return
+      end
+    end
+
+  end
+end

data/lib/sidekiq_adhoc_job.rb

@@ -0,0 +1,45 @@
+require 'sidekiq'
+require 'sidekiq/web'
+
+require 'sidekiq_adhoc_job/utils/string'
+require 'sidekiq_adhoc_job/worker_classes_loader'
+require 'sidekiq_adhoc_job/web/job_presenter'
+require 'sidekiq_adhoc_job/services/schedule_adhoc_job'
+require 'sidekiq_adhoc_job/web'
+
+module SidekiqAdhocJob
+
+  InvalidConfigurationError ||= Class.new(RuntimeError)
+
+  def self.configure
+    @_config = Configuration.new
+    yield @_config
+  end
+
+  def self.config
+    @_config
+  end
+
+  def self.init
+    raise InvalidConfigurationError, 'Must configure before init' unless @_config&.configured?
+
+    SidekiqAdhocJob::WorkerClassesLoader.load(@_config.module_names)
+
+    Sidekiq::Web.register(SidekiqAdhocJob::Web)
+    Sidekiq::Web.tabs['adhoc_jobs'] = 'adhoc-jobs'
+    Sidekiq::Web.locales << File.expand_path('sidekiq_adhoc_job/web/locales', __dir__)
+  end
+
+  class Configuration
+    attr_accessor :module_names
+
+    def initialize
+      @module_names = []
+    end
+
+    def configured?
+      !@module_names.empty?
+    end
+  end
+
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_adhoc_job
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Goh Khoon Hiang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !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.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !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: 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: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.7
+description: Trigger jobs adhoc from Sidekiq web admin
+email:
+- gohkhoonhiang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sidekiq_adhoc_job.rb
+- lib/sidekiq_adhoc_job/services/schedule_adhoc_job.rb
+- lib/sidekiq_adhoc_job/utils/string.rb
+- lib/sidekiq_adhoc_job/version.rb
+- lib/sidekiq_adhoc_job/web.rb
+- lib/sidekiq_adhoc_job/web/job_presenter.rb
+- lib/sidekiq_adhoc_job/web/locales/en.yml
+- lib/sidekiq_adhoc_job/web/routes/jobs/index.rb
+- lib/sidekiq_adhoc_job/web/routes/jobs/schedule.rb
+- lib/sidekiq_adhoc_job/web/routes/jobs/show.rb
+- lib/sidekiq_adhoc_job/web/templates/jobs/index.html.erb
+- lib/sidekiq_adhoc_job/web/templates/jobs/show.html.erb
+- lib/sidekiq_adhoc_job/worker_classes_loader.rb
+homepage: https://github.com/gohkhoonhiang/sidekiq_adhoc_job
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/sidekiq_adhoc_job
+- 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.3
+signing_key: 
+specification_version: 4
+summary: Trigger jobs adhoc from Sidekiq web admin
+test_files: []