sidekiq-enqueuer 2.0.0 → 2.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1632d8218572bd4f7b75fa9fef52850536a315e8
-  data.tar.gz: 54d3613fe9ae5d02473a144295f357e0a6383922
+  metadata.gz: bd0c3ed9a31d9741b5bec6103f7daedfd20a9f1c
+  data.tar.gz: 8e31a23c14f03f9b5e65964b7fd1156c0a9d4584
 SHA512:
-  metadata.gz: 9767283baceb739624184eb5e262120d128391aea48015b2ab9d3925e32bbe8ab9f2ed7fc2d3076a3f9e026608fadcfd2ff1c73de8320b1fb5ea27d1da8d3cc1
-  data.tar.gz: ca5923163c6773e7cf190fa557966eb4e1dfcb5ab3cbc7f0a59abc1d20aef5f08d5fa9e5209394df978a794e7a0a09bd0ce1790ef1e26a3bf551be226c66a651
+  metadata.gz: 1c9ef2086a55ef281d1372579f13f327597366d2bb1a8972e08b86f43ce3f5676e5c5abcc77c81501d498eb75466308b0c4899c36ce9b3b2630a9ffc05f8722f
+  data.tar.gz: 0ef6dffd01f43ba99b619a2899f5dda55fbf1eabad24ec8dfd916b3db86d663c2387e04c4a8e1f7816e97f84a2ad7af15b72ed44f0aef776c31a4f2f7a9ef41b

data/CHANGELOG.md

@@ -5,6 +5,13 @@
 - Version bump to stable after rollout to prod.
 
 
+2.1.0.beta
+-----------
+- Drop support for Yaml-like params
+- Added support for required and optional parameters based on the method definition
+- Fixed issue with nil parameters being send to Jobs as `nil` strings
+- Added New Exception to be raised when Required Param values are not present
+
 2.0.0.beta
 -----------
 

data/README.md

@@ -75,15 +75,10 @@ For ActiveJob, enqueing is being done calling the very own `perform_later` insta
 ![list](https://cloud.githubusercontent.com/assets/830633/14494297/c9b01b10-01bc-11e6-8ef5-a4d29ff45fb3.png)
 
 * Fill the form, click Enqueue or Schedule.
-![form](https://cloud.githubusercontent.com/assets/830633/14494314/ddd9f8ae-01bc-11e6-86ce-0641a9c4d3e4.png)
+![form](https://cloud.githubusercontent.com/assets/830633/20659706/e8dde182-b50a-11e6-90e6-022d5c1ae2db.png)
 
 * That is it!
 
-## Form filling
-* Support string value and hash value. Value will be stripped.
-* Start with { will be parsed by YAML as hash, eg: {k1: v1, k2: v2} to {'k1'=> 'v1', 'k2'=> 'v2'}
-
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/richfisher/sidekiq-enqueuer.

data/lib/sidekiq/enqueuer/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Enqueuer
-    VERSION = '2.0.0'.freeze
+    VERSION = '2.1.0.beta1'.freeze
   end
 end

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

@@ -1,10 +1,4 @@
 <h3>Enqueuer</h3>
-
-<div class="well">
-  <p>Support string value and hash value. Value will be stripped.</p>
-  <p>Start with { will be parsed by YAML as hash, eg: {k1: v1, k2: v2} to {'k1'=> 'v1', 'k2'=> 'v2'}. </p>
-</div>
-
 <form method="post" action="<%= root_path %>enqueuer">
   <%= csrf_tag if respond_to?(:csrf_tag) %>
 

data/lib/sidekiq/enqueuer/web_extension/helper.rb

@@ -2,9 +2,9 @@ module Sidekiq
   module Enqueuer
     module WebExtension
       module Helper
-        def get_params_by_action(name)
+        def get_params_by_action(name, job)
           return [] if params[name].nil?
-          ParamsParser.new(params[name]).process
+          Sidekiq::Enqueuer::WebExtension::ParamsParser.new(params[name], job).process
         end
 
         def find_job_by_class_name(job_class_name)
@@ -12,23 +12,6 @@ module Sidekiq
             job_klass.job == job_class_name || job_klass.job.to_s == job_class_name || job_klass.name == job_class_name
           end
         end
-
-        # TODO: Figure out the need of unlock!
-        # def does_job_have_unlock_method(klass_or_module)
-        #   klass_or_module.respond_to?(:unlock!)
-        #   false
-        # end
-
-        # TODO: Figure out the need of unlock!
-        # def get_job_unlock_params(klass_or_module)
-        #   klass_or_module.method(:unlock!).parameters.map{ |e| e[1]}
-        # end
-
-        # TODO: Figure out the need of unlock!
-        # def self.unlock!(klass, values)
-        #   parsed_values = values_parser(values)
-        #   klass.unlock!(*parsed_values)
-        # end
       end
     end
   end

data/lib/sidekiq/enqueuer/web_extension/loader.rb

@@ -18,12 +18,9 @@ module Sidekiq
 
           app.post '/enqueuer' do
             job = find_job_by_class_name(params[:job_class_name])
-            requested_params = get_params_by_action('perform')
-            # TODO: Figure out the need of unlock!
-            # if params['unlock-enable'] && params['unlock-enable'] != ''
-            #   Sidekiq::Enqueuer.unlock!(klass, get_params_by_action('unlock'))
-            # end
+
             if job
+              requested_params = get_params_by_action('perform', job)
               job.trigger(requested_params) if params['submit'] == 'Enqueue'
               job.trigger_in(params['enqueue_in'], requested_params) if params['submit'] == 'Schedule'
             end

data/lib/sidekiq/enqueuer/web_extension/params_parser.rb

@@ -2,45 +2,35 @@ module Sidekiq
   module Enqueuer
     module WebExtension
       class ParamsParser
-        attr_reader :raw_params
+        class NoProvidedValueForRequiredParam < StandardError; end
 
-        def initialize(params)
+        attr_reader :raw_params, :worker
+
+        def initialize(params, worker)
           @raw_params = params
+          @worker = worker
         end
 
         def process
-          all_params    = filter_empty(raw_params)
-          hash_params   = yaml_to_params(all_params.values)
-          all_params    = hash_params.merge!(all_params) if hash_params
-          simple_params = filter_complex(all_params)
-          simple_params.values.compact.flatten
-        end
-
-        private
-
-        def yaml_to_params(values)
-          unique_params = {}
-          values.each do |str_param|
-            param_hash = expected_hash?(str_param) ? convert_to_ruby(str_param) : {}
-            unique_params.merge!(param_hash)
+          worker.params.each do |expected_param|
+            value = extract_value(expected_param.name.to_s)
+            expected_param.value = value
+            raise NoProvidedValueForRequiredParam if expected_param.required? && !expected_param.value.present?
           end
-          unique_params
+          worker.params.map(&:value)
         end
 
-        def filter_empty(given_params)
-          given_params.delete_if { |_, v| v.to_s.empty? }
-        end
-
-        def filter_complex(given_params)
-          given_params.delete_if { |_, v| expected_hash?(v.to_s) }
-        end
+        private
 
-        def convert_to_ruby(value)
-          YAML.parse(value.to_s.strip).to_ruby
+        def extract_value(param_name)
+          return nil unless raw_params[param_name].present?
+          cleanup(raw_params[param_name])
         end
 
-        def expected_hash?(value)
-          value.to_s.start_with?('{') && value.to_s.end_with?('}')
+        def cleanup(value)
+          return nil if value.to_s.downcase == 'nil'
+          return '' if value.to_s.strip.empty?
+          value
         end
       end
     end

data/lib/sidekiq/enqueuer/worker/instance.rb

@@ -26,7 +26,7 @@ module Sidekiq
         private
 
         def trigger_job(input_params)
-          Trigger.new(job, input_params)
+          Sidekiq::Enqueuer::Worker::Trigger.new(job, input_params)
         end
 
         # TODO: what if two of this methods exist? which one to pick to figure out params?
@@ -38,7 +38,7 @@ module Sidekiq
         end
 
         def deduce_params
-          worker_params.empty? ? [] : worker_params.map { |e| Param.new(e[1], e[0]) }
+          worker_params.empty? ? [] : worker_params.map { |e| Sidekiq::Enqueuer::Worker::Param.new(e[1], e[0]) }
         end
 
         def worker_params

data/lib/sidekiq/enqueuer/worker/param.rb

@@ -2,17 +2,22 @@ module Sidekiq
   module Enqueuer
     module Worker
       class Param
-        attr_reader :name, :condition
+        attr_reader :name, :label
+        attr_accessor :value
 
         VALID_OPTIONS = { req: 'required', opt: 'optional' }.freeze
 
-        def initialize(name, condition)
+        def initialize(name, label)
           @name = name
-          @condition = VALID_OPTIONS[condition]
+          @label = VALID_OPTIONS[label]
         end
 
-        def label
-          condition
+        def required?
+          label == VALID_OPTIONS[:req]
+        end
+
+        def optional?
+          !required?
         end
       end
     end

data/lib/sidekiq/enqueuer.rb

@@ -12,8 +12,6 @@ require 'sidekiq/enqueuer/railtie' if defined? ::Rails::Railtie
 module Sidekiq
   module Enqueuer
     class << self
-      attr_accessor :configuration
-
       def configuration
         @configuration ||= Configuration.new
       end

data/sidekiq-enqueuer.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'sidekiq'
   spec.add_development_dependency 'rails', '> 4.2'
   spec.add_development_dependency 'sinatra'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-enqueuer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0.beta1
 platform: ruby
 authors:
 - richfisher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2016-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,9 +140,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8