sidekiq-scheduler 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2747b49a61187194593a74c6cdba9979d26fa99a
-  data.tar.gz: 3cda4ae1544bff66d97b7a94503a75aca57a237f
+  metadata.gz: 9baa032bdb214ffc3f0d229c0a5181f36a8be200
+  data.tar.gz: 011c8eaf157ceea568cc64ba125af2c7cc0706db
 SHA512:
-  metadata.gz: fc793b476d9a19bbc541dedef091e52ffabf08d88800c4a423121e9181d6042b39bd06498bec1c98dc3763b7ee4bf6b0f13e43896bf7d58d672d3570f5039776
-  data.tar.gz: 97da3f5c4e75468877f59e713407554364befe57b8891371dab4b17387b2f18cbba633695b28cbb99e53f6f63ac090ee3ae3bd64abf2875062f49db71cf45d84
+  metadata.gz: 7c2f4d826b83179acee13b422dfb4ab00542b747b17d4f30685d675e8938d1b4b8b06d362a348590a9363b65d4acbb3711c0577db4b1ab6f5d5a0cac32d44b97
+  data.tar.gz: db0db5b8556f897a50800856031102e3f2001d8bf4658e9daabd8b41a269da92d475b37f5f01026539c435433636cb441cc3123c7fe292091b43c7c5ff04a232

data/README.md

@@ -30,6 +30,8 @@
 `sidekiq-scheduler` is an extension to [Sidekiq](http://github.com/mperham/sidekiq) that
 pushes jobs in a scheduled way, mimicking cron utility.
 
+__Note:__ If you are looking for version 2.2.*, go to [2.2-stable branch](https://github.com/moove-it/sidekiq-scheduler/tree/2.2-stable).
+
 ## Installation
 
 ``` shell
@@ -228,7 +230,7 @@ require 'sidekiq-scheduler'
 Sidekiq.configure_server do |config|
   config.on(:startup) do
     Sidekiq.schedule = YAML.load_file(File.expand_path('../../sidekiq_scheduler.yml', __FILE__))
-    Sidekiq::Scheduler.reload_schedule!
+    SidekiqScheduler::Scheduler.instance.reload_schedule!
   end
 end
 ```
@@ -256,7 +258,7 @@ If `:dynamic` flag is set to `false`, you'll have to reload the schedule manuall
 side:
 
 ``` ruby
-Sidekiq::Scheduler.reload_schedule!
+SidekiqScheduler::Scheduler.instance.reload_schedule!
 ```
 
 Invoke `Sidekiq.get_schedule` to obtain the current schedule:
@@ -367,12 +369,12 @@ if Rails.env == 'production' && (defined?(Rails::Server) || defined?(Unicorn))
 
     config.on(:startup) do
       Sidekiq.schedule = YAML.load_file(File.expand_path('../../scheduler.yml', __FILE__))
-      Sidekiq::Scheduler.reload_schedule!
+      SidekiqScheduler::Scheduler.instance.reload_schedule!
     end
   end
 else
-  Sidekiq::Scheduler.enabled = false
-  puts "Sidekiq::Scheduler.enabled is #{Sidekiq::Scheduler.enabled.inspect}"
+  SidekiqScheduler::Scheduler.instance.enabled = false
+  puts "SidekiqScheduler::Scheduler.instance.enabled is #{SidekiqScheduler::Scheduler.instance.enabled.inspect}"
 end
 ```
 
@@ -382,6 +384,6 @@ MIT License
 
 ## Copyright
 
-Copyright 2013 - 2017 Moove-IT.
+Copyright 2013 - 2018 Moove-IT.
 Copyright 2012 Morton Jonuschat.
 Some parts copyright 2010 Ben VandenBos.

data/lib/sidekiq-scheduler.rb

@@ -10,35 +10,10 @@ require_relative 'sidekiq-scheduler/extensions/schedule'
 Sidekiq.configure_server do |config|
 
   config.on(:startup) do
-    dynamic = Sidekiq::Scheduler.dynamic
-    dynamic = dynamic.nil? ? config.options.fetch(:dynamic, false) : dynamic
-
-    dynamic_every = Sidekiq::Scheduler.dynamic_every
-    dynamic_every = dynamic_every.nil? ? config.options.fetch(:dynamic_every, '5s') : dynamic_every
-
-    enabled = Sidekiq::Scheduler.enabled
-    enabled = enabled.nil? ? config.options.fetch(:enabled, true) : enabled
-
-    scheduler = config.options.fetch(:scheduler, {})
-
-    listened_queues_only = Sidekiq::Scheduler.listened_queues_only
-    listened_queues_only = listened_queues_only.nil? ? scheduler[:listened_queues_only] : listened_queues_only
-
-    schedule = Sidekiq.schedule
-    schedule ||= config.options[:schedule] || {}
-
-    scheduler_options = {
-      dynamic:       dynamic,
-      dynamic_every: dynamic_every,
-      enabled:       enabled,
-      schedule:      schedule,
-      listened_queues_only: listened_queues_only
-    }
-
     # schedules_changed's type was changed from SET to ZSET, so we remove old versions at startup
     SidekiqScheduler::RedisManager.clean_schedules_changed
 
-    schedule_manager = SidekiqScheduler::Manager.new(scheduler_options)
+    schedule_manager = SidekiqScheduler::Manager.new(config.options)
     config.options[:schedule_manager] = schedule_manager
     config.options[:schedule_manager].start
   end

data/lib/sidekiq-scheduler/manager.rb

@@ -14,26 +14,48 @@ module SidekiqScheduler
   class Manager
     include Sidekiq::Util
 
+    DEFAULT_SCHEDULER_OPTIONS = {
+      enabled: true,
+      dynamic: false,
+      dynamic_every: '5s',
+      schedule: {}
+    }
+
     def initialize(options)
-      SidekiqScheduler::Scheduler.enabled = options[:enabled]
-      SidekiqScheduler::Scheduler.dynamic = options[:dynamic]
-      SidekiqScheduler::Scheduler.dynamic_every = options[:dynamic_every]
-      SidekiqScheduler::Scheduler.listened_queues_only = options[:listened_queues_only]
-      Sidekiq.schedule = options[:schedule] if SidekiqScheduler::Scheduler.enabled
+      scheduler_options = load_scheduler_options(options)
+
+      @scheduler_instance = SidekiqScheduler::Scheduler.new(scheduler_options)
+      SidekiqScheduler::Scheduler.instance = @scheduler_instance
+      Sidekiq.schedule = scheduler_options[:schedule] if @scheduler_instance.enabled
     end
 
     def stop
-      SidekiqScheduler::Scheduler.clear_schedule!
+      @scheduler_instance.clear_schedule!
     end
 
     def start
-      SidekiqScheduler::Scheduler.load_schedule!
+      @scheduler_instance.load_schedule!
     end
 
     def reset
       clear_scheduled_work
     end
 
-  end
+    private
+
+    def load_scheduler_options(options)
+      options[:listened_queues_only] = options.fetch(:scheduler, {})[:listened_queues_only]
+      scheduler_options = DEFAULT_SCHEDULER_OPTIONS.merge(options)
 
+      current_options = {
+        enabled: SidekiqScheduler::Scheduler.enabled,
+        dynamic: SidekiqScheduler::Scheduler.dynamic,
+        dynamic_every: SidekiqScheduler::Scheduler.dynamic_every,
+        schedule: Sidekiq.schedule,
+        listened_queues_only: SidekiqScheduler::Scheduler.listened_queues_only
+      }.delete_if { |_, value| value.nil? }
+
+      scheduler_options.merge(current_options)
+    end
+  end
 end

data/lib/sidekiq-scheduler/scheduler.rb

@@ -10,400 +10,345 @@ module SidekiqScheduler
   class Scheduler
     extend Sidekiq::Util
 
-    RUFUS_METADATA_KEYS = %w(description at cron every in interval enabled)
-
     # We expect rufus jobs to have #params
     Rufus::Scheduler::Job.module_eval do
-
       alias_method :params, :opts
-
     end
 
-    class << self
+    # Set to enable or disable the scheduler.
+    attr_accessor :enabled
 
-      # Set to enable or disable the scheduler.
-      attr_accessor :enabled
+    # Set to update the schedule in runtime in a given time period.
+    attr_accessor :dynamic
 
-      # Set to update the schedule in runtime in a given time period.
-      attr_accessor :dynamic
+    # Set to update the schedule in runtime dynamically per this period.
+    attr_accessor :dynamic_every
 
-      # Set to update the schedule in runtime dynamically per this period.
-      attr_accessor :dynamic_every
+    # Set to schedule jobs only when will be pushed to queues listened by sidekiq
+    attr_accessor :listened_queues_only
 
-      # Set to schedule jobs only when will be pushed to queues listened by sidekiq
-      attr_accessor :listened_queues_only
+    class << self
 
-      # the Rufus::Scheduler jobs that are scheduled
-      def scheduled_jobs
-        @@scheduled_jobs
+      def instance
+        @instance = new unless @instance
+        @instance
       end
 
-      def print_schedule
-        if rufus_scheduler
-          logger.info "Scheduling Info\tLast Run"
-          scheduler_jobs = rufus_scheduler.all_jobs
-          scheduler_jobs.each_value do |v|
-            logger.info "#{v.t}\t#{v.last}\t"
-          end
-        end
+      def instance=(value)
+        @instance = value
       end
 
-      # Pulls the schedule from Sidekiq.schedule and loads it into the
-      # rufus scheduler instance
-      def load_schedule!
-        if enabled
-          logger.info 'Loading Schedule'
-
-          # Load schedule from redis for the first time if dynamic
-          if dynamic
-            Sidekiq.reload_schedule!
-            @current_changed_score = Time.now.to_f
-            rufus_scheduler.every(dynamic_every) do
-              update_schedule
-            end
-          end
-
-          logger.info 'Schedule empty! Set Sidekiq.schedule' if Sidekiq.schedule.empty?
-
+      def method_missing(method, *arguments, &block)
+        instance_methods.include?(method) ? instance.public_send(method, *arguments) : super
+      end
+    end
 
-          @@scheduled_jobs = {}
-          queues = sidekiq_queues
+    def initialize(options = {})
+      self.enabled = options[:enabled]
+      self.dynamic = options[:dynamic]
+      self.dynamic_every = options[:dynamic_every]
+      self.listened_queues_only = options[:listened_queues_only]
+    end
 
-          Sidekiq.schedule.each do |name, config|
-            if !listened_queues_only || enabled_queue?(config['queue'].to_s, queues)
-              load_schedule_job(name, config)
-            else
-              logger.info { "Ignoring #{name}, job's queue is not enabled." }
-            end
-          end
+    # the Rufus::Scheduler jobs that are scheduled
+    def scheduled_jobs
+      @scheduled_jobs
+    end
 
-          logger.info 'Schedules Loaded'
-        else
-          logger.info 'SidekiqScheduler is disabled'
+    def print_schedule
+      if rufus_scheduler
+        Sidekiq.logger.info "Scheduling Info\tLast Run"
+        scheduler_jobs = rufus_scheduler.all_jobs
+        scheduler_jobs.each_value do |v|
+          Sidekiq.logger.info "#{v.t}\t#{v.last}\t"
         end
       end
+    end
 
-      # Loads a job schedule into the Rufus::Scheduler and stores it in @@scheduled_jobs
-      def load_schedule_job(name, config)
-        # If rails_env is set in the config, enforce ENV['RAILS_ENV'] as
-        # required for the jobs to be scheduled.  If rails_env is missing, the
-        # job should be scheduled regardless of what ENV['RAILS_ENV'] is set
-        # to.
-        if config['rails_env'].nil? || rails_env_matches?(config)
-          logger.info "Scheduling #{name} #{config}"
-          interval_defined = false
-          interval_types = %w{cron every at in interval}
-          interval_types.each do |interval_type|
-            config_interval_type = config[interval_type]
-
-            if !config_interval_type.nil? && config_interval_type.length > 0
+    # Pulls the schedule from Sidekiq.schedule and loads it into the
+    # rufus scheduler instance
+    def load_schedule!
+      if enabled
+        Sidekiq.logger.info 'Loading Schedule'
 
-              schedule, options = SidekiqScheduler::RufusUtils.normalize_schedule_options(config_interval_type)
+        # Load schedule from redis for the first time if dynamic
+        if dynamic
+          Sidekiq.reload_schedule!
+          @current_changed_score = Time.now.to_f
+          rufus_scheduler.every(dynamic_every) do
+            update_schedule
+          end
+        end
 
-              rufus_job = new_job(name, interval_type, config, schedule, options)
-              @@scheduled_jobs[name] = rufus_job
-              update_job_next_time(name, rufus_job.next_time)
+        Sidekiq.logger.info 'Schedule empty! Set Sidekiq.schedule' if Sidekiq.schedule.empty?
 
-              interval_defined = true
 
-              break
-            end
-          end
+        @scheduled_jobs = {}
+        queues = sidekiq_queues
 
-          unless interval_defined
-            logger.info "no #{interval_types.join(' / ')} found for #{config['class']} (#{name}) - skipping"
+        Sidekiq.schedule.each do |name, config|
+          if !listened_queues_only || enabled_queue?(config['queue'].to_s, queues)
+            load_schedule_job(name, config)
+          else
+            Sidekiq.logger.info { "Ignoring #{name}, job's queue is not enabled." }
           end
         end
-      end
 
-      # Pushes the job into Sidekiq if not already pushed for the given time
-      #
-      # @param [String] job_name The job's name
-      # @param [Time] time The time when the job got cleared for triggering
-      # @param [Hash] config Job's config hash
-      def idempotent_job_enqueue(job_name, time, config)
-        registered = register_job_instance(job_name, time)
+        Sidekiq.logger.info 'Schedules Loaded'
+      else
+        Sidekiq.logger.info 'SidekiqScheduler is disabled'
+      end
+    end
 
-        if registered
-          logger.info "queueing #{config['class']} (#{job_name})"
+    # Loads a job schedule into the Rufus::Scheduler and stores it in @scheduled_jobs
+    def load_schedule_job(name, config)
+      # If rails_env is set in the config, enforce ENV['RAILS_ENV'] as
+      # required for the jobs to be scheduled.  If rails_env is missing, the
+      # job should be scheduled regardless of what ENV['RAILS_ENV'] is set
+      # to.
+      if config['rails_env'].nil? || rails_env_matches?(config)
+        Sidekiq.logger.info "Scheduling #{name} #{config}"
+        interval_defined = false
+        interval_types = %w(cron every at in interval)
+        interval_types.each do |interval_type|
+          config_interval_type = config[interval_type]
 
-          handle_errors { enqueue_job(config, time) }
+          if !config_interval_type.nil? && config_interval_type.length > 0
 
-          remove_elder_job_instances(job_name)
-        else
-          logger.debug { "Ignoring #{job_name} job as it has been already enqueued" }
-        end
-      end
+            schedule, options = SidekiqScheduler::RufusUtils.normalize_schedule_options(config_interval_type)
 
-      # Pushes job's next time execution
-      #
-      # @param [String] name The job's name
-      # @param [Time] next_time The job's next time execution
-      def update_job_next_time(name, next_time)
-        if next_time
-          SidekiqScheduler::RedisManager.set_job_next_time(name, next_time)
-        else
-          SidekiqScheduler::RedisManager.remove_job_next_time(name)
-        end
-      end
+            rufus_job = new_job(name, interval_type, config, schedule, options)
+            @scheduled_jobs[name] = rufus_job
+            SidekiqScheduler::Utils.update_job_next_time(name, rufus_job.next_time)
 
-      # Pushes job's last execution time
-      #
-      # @param [String] name The job's name
-      # @param [Time] last_time The job's last execution time
-      def update_job_last_time(name, last_time)
-        SidekiqScheduler::RedisManager.set_job_last_time(name, last_time) if last_time
-      end
+            interval_defined = true
 
-      # Returns true if the given schedule config hash matches the current
-      # ENV['RAILS_ENV']
-      def rails_env_matches?(config)
-        config['rails_env'] && ENV['RAILS_ENV'] && config['rails_env'].gsub(/\s/, '').split(',').include?(ENV['RAILS_ENV'])
-      end
+            break
+          end
+        end
 
-      def handle_errors
-        begin
-          yield
-        rescue StandardError => e
-          logger.info "#{e.class.name}: #{e.message}"
+        unless interval_defined
+          Sidekiq.logger.info "no #{interval_types.join(' / ')} found for #{config['class']} (#{name}) - skipping"
         end
       end
+    end
 
-      # Enqueue a job based on a config hash
-      #
-      # @param job_config [Hash] the job configuration
-      # @param time [Time] time the job is enqueued
-      def enqueue_job(job_config, time=Time.now)
-        config = prepare_arguments(job_config.dup)
+    # Pushes the job into Sidekiq if not already pushed for the given time
+    #
+    # @param [String] job_name The job's name
+    # @param [Time] time The time when the job got cleared for triggering
+    # @param [Hash] config Job's config hash
+    def idempotent_job_enqueue(job_name, time, config)
+      registered = SidekiqScheduler::RedisManager.register_job_instance(job_name, time)
 
-        if config.delete('include_metadata')
-          config['args'] = arguments_with_metadata(config['args'], scheduled_at: time.to_f)
-        end
+      if registered
+        Sidekiq.logger.info "queueing #{config['class']} (#{job_name})"
 
-        if active_job_enqueue?(config['class'])
-          enqueue_with_active_job(config)
-        else
-          enqueue_with_sidekiq(config)
-        end
-      end
+        handle_errors { enqueue_job(config, time) }
 
-      def rufus_scheduler_options
-        @rufus_scheduler_options ||= {}
+        SidekiqScheduler::RedisManager.remove_elder_job_instances(job_name)
+      else
+        Sidekiq.logger.debug { "Ignoring #{job_name} job as it has been already enqueued" }
       end
+    end
 
-      def rufus_scheduler_options=(options)
-        @rufus_scheduler_options = options
-      end
+    # Enqueue a job based on a config hash
+    #
+    # @param job_config [Hash] the job configuration
+    # @param time [Time] time the job is enqueued
+    def enqueue_job(job_config, time = Time.now)
+      config = prepare_arguments(job_config.dup)
 
-      def rufus_scheduler
-        @rufus_scheduler ||= new_rufus_scheduler
+      if config.delete('include_metadata')
+        config['args'] = arguments_with_metadata(config['args'], scheduled_at: time.to_f)
       end
 
-      # Stops old rufus scheduler and creates a new one.  Returns the new
-      # rufus scheduler
-      #
-      # @param [Symbol] stop_option The option to be passed to Rufus::Scheduler#stop
-      def clear_schedule!(stop_option = :wait)
-        rufus_scheduler.stop(stop_option)
-        @rufus_scheduler = nil
-        @@scheduled_jobs = {}
-        rufus_scheduler
+      if active_job_enqueue?(config['class'])
+        SidekiqScheduler::Utils.enqueue_with_active_job(config)
+      else
+        SidekiqScheduler::Utils.enqueue_with_sidekiq(config)
       end
+    end
 
-      def reload_schedule!
-        if enabled
-          logger.info 'Reloading Schedule'
-          clear_schedule!
-          load_schedule!
-        else
-          logger.info 'SidekiqScheduler is disabled'
-        end
-      end
+    def rufus_scheduler_options
+      @rufus_scheduler_options ||= {}
+    end
 
-      def update_schedule
-        last_changed_score, @current_changed_score = @current_changed_score, Time.now.to_f
-        schedule_changes = SidekiqScheduler::RedisManager.get_schedule_changes(last_changed_score, @current_changed_score)
+    def rufus_scheduler_options=(options)
+      @rufus_scheduler_options = options
+    end
 
-        if schedule_changes.size > 0
-          logger.info 'Updating schedule'
+    def rufus_scheduler
+      @rufus_scheduler ||= SidekiqScheduler::Utils.new_rufus_scheduler(rufus_scheduler_options)
+    end
 
-          Sidekiq.reload_schedule!
-          schedule_changes.each do |schedule_name|
-            if Sidekiq.schedule.keys.include?(schedule_name)
-              unschedule_job(schedule_name)
-              load_schedule_job(schedule_name, Sidekiq.schedule[schedule_name])
-            else
-              unschedule_job(schedule_name)
-            end
-          end
-          logger.info 'Schedule updated'
-        end
-      end
+    # Stops old rufus scheduler and creates a new one.  Returns the new
+    # rufus scheduler
+    #
+    # @param [Symbol] stop_option The option to be passed to Rufus::Scheduler#stop
+    def clear_schedule!(stop_option = :wait)
+      rufus_scheduler.stop(stop_option)
+      @rufus_scheduler = nil
+      @@scheduled_jobs = {}
+      rufus_scheduler
+    end
 
-      def unschedule_job(name)
-        if scheduled_jobs[name]
-          logger.debug "Removing schedule #{name}"
-          scheduled_jobs[name].unschedule
-          scheduled_jobs.delete(name)
-        end
+    def reload_schedule!
+      if enabled
+        Sidekiq.logger.info 'Reloading Schedule'
+        clear_schedule!
+        load_schedule!
+      else
+        Sidekiq.logger.info 'SidekiqScheduler is disabled'
       end
+    end
 
-      def enqueue_with_active_job(config)
-        options = {
-          queue: config['queue']
-        }.keep_if { |_, v| !v.nil? }
-
-        initialize_active_job(config['class'], config['args']).enqueue(options)
-      end
+    def update_schedule
+      last_changed_score, @current_changed_score = @current_changed_score, Time.now.to_f
+      schedule_changes = SidekiqScheduler::RedisManager.get_schedule_changes(last_changed_score, @current_changed_score)
 
-      def enqueue_with_sidekiq(config)
-        Sidekiq::Client.push(sanitize_job_config(config))
-      end
+      if schedule_changes.size > 0
+        Sidekiq.logger.info 'Updating schedule'
 
-      def initialize_active_job(klass, args)
-        if args.is_a?(Array)
-          klass.new(*args)
-        else
-          klass.new(args)
+        Sidekiq.reload_schedule!
+        schedule_changes.each do |schedule_name|
+          if Sidekiq.schedule.keys.include?(schedule_name)
+            unschedule_job(schedule_name)
+            load_schedule_job(schedule_name, Sidekiq.schedule[schedule_name])
+          else
+            unschedule_job(schedule_name)
+          end
         end
+        Sidekiq.logger.info 'Schedule updated'
       end
+    end
 
-      # Returns true if the enqueuing needs to be done for an ActiveJob
-      #  class false otherwise.
-      #
-      # @param [Class] klass the class to check is decendant from ActiveJob
-      #
-      # @return [Boolean]
-      def active_job_enqueue?(klass)
-        klass.is_a?(Class) && defined?(ActiveJob::Enqueuing) &&
-          klass.included_modules.include?(ActiveJob::Enqueuing)
-      end
-
-      # Convert the given arguments in the format expected to be enqueued.
-      #
-      # @param [Hash] config the options to be converted
-      # @option config [String] class the job class
-      # @option config [Hash/Array] args the arguments to be passed to the job
-      #   class
-      #
-      # @return [Hash]
-      def prepare_arguments(config)
-        config['class'] = try_to_constantize(config['class'])
-
-        if config['args'].is_a?(Hash)
-          config['args'].symbolize_keys! if config['args'].respond_to?(:symbolize_keys!)
-        else
-          config['args'] = Array(config['args'])
-        end
+    def job_enabled?(name)
+      job = Sidekiq.schedule[name]
+      schedule_state(name).fetch('enabled', job.fetch('enabled', true)) if job
+    end
 
-        config
-      end
+    def toggle_job_enabled(name)
+      state = schedule_state(name)
+      state['enabled'] = !job_enabled?(name)
+      set_schedule_state(name, state)
+    end
 
-      def try_to_constantize(klass)
-        klass.is_a?(String) ? klass.constantize : klass
-      rescue NameError
-        klass
-      end
+    private
 
-      # Returns true if a job's queue is included in the array of queues
-      #
-      # If queues are empty, returns true.
-      #
-      # @param [String] job_queue Job's queue name
-      # @param [Array<String>] queues
-      #
-      # @return [Boolean]
-      def enabled_queue?(job_queue, queues)
-        queues.empty? || queues.include?(job_queue)
-      end
+    def new_job(name, interval_type, config, schedule, options)
+      options = options.merge({ :job => true, :tags => [name] })
 
-      # Registers a queued job instance
-      #
-      # @param [String] job_name The job's name
-      # @param [Time] time Time at which the job was cleared by the scheduler
-      #
-      # @return [Boolean] true if the job was registered, false when otherwise
-      def register_job_instance(job_name, time)
-        SidekiqScheduler::RedisManager.register_job_instance(job_name, time)
+      rufus_scheduler.send(interval_type, schedule, options) do |job, time|
+        idempotent_job_enqueue(name, time, SidekiqScheduler::Utils.sanitize_job_config(config)) if job_enabled?(name)
       end
+    end
 
-      def remove_elder_job_instances(job_name)
-        SidekiqScheduler::RedisManager.remove_elder_job_instances(job_name)
+    def unschedule_job(name)
+      if scheduled_jobs[name]
+        Sidekiq.logger.debug "Removing schedule #{name}"
+        scheduled_jobs[name].unschedule
+        scheduled_jobs.delete(name)
       end
+    end
 
-      def job_enabled?(name)
-        job = Sidekiq.schedule[name]
-        schedule_state(name).fetch('enabled', job.fetch('enabled', true)) if job
-      end
+    # Retrieves a schedule state
+    #
+    # @param name [String] with the schedule's name
+    # @return [Hash] with the schedule's state
+    def schedule_state(name)
+      state = SidekiqScheduler::RedisManager.get_job_state(name)
 
-      def toggle_job_enabled(name)
-        state = schedule_state(name)
-        state['enabled'] = !job_enabled?(name)
-        set_schedule_state(name, state)
-      end
+      state ? JSON.parse(state) : {}
+    end
 
-      private
+    # Saves a schedule state
+    #
+    # @param name [String] with the schedule's name
+    # @param name [Hash] with the schedule's state
+    def set_schedule_state(name, state)
+      SidekiqScheduler::RedisManager.set_job_state(name, state)
+    end
 
-      def new_rufus_scheduler
-        Rufus::Scheduler.new(rufus_scheduler_options).tap do |scheduler|
-          scheduler.define_singleton_method(:on_post_trigger) do |job, triggered_time|
-            SidekiqScheduler::Scheduler.update_job_last_time(job.tags[0], triggered_time)
-            SidekiqScheduler::Scheduler.update_job_next_time(job.tags[0], job.next_time)
-          end
-        end
+    # Adds a Hash with schedule metadata as the last argument to call the worker.
+    # It currently returns the schedule time as a Float number representing the milisencods
+    # since epoch.
+    #
+    # @example with hash argument
+    #   arguments_with_metadata({value: 1}, scheduled_at: Time.now)
+    #   #=> [{value: 1}, {scheduled_at: <miliseconds since epoch>}]
+    #
+    # @param args [Array|Hash]
+    # @param metadata [Hash]
+    # @return [Array] arguments with added metadata
+    def arguments_with_metadata(args, metadata)
+      if args.is_a? Array
+        [*args, metadata]
+      else
+        [args, metadata]
       end
+    end
 
-      def new_job(name, interval_type, config, schedule, options)
-        options = options.merge({ :job => true, :tags => [name] })
+    def sidekiq_queues
+      Sidekiq.options[:queues].map(&:to_s)
+    end
 
-        rufus_scheduler.send(interval_type, schedule, options) do |job, time|
-          idempotent_job_enqueue(name, time, sanitize_job_config(config)) if job_enabled?(name)
-        end
-      end
+    # Returns true if a job's queue is included in the array of queues
+    #
+    # If queues are empty, returns true.
+    #
+    # @param [String] job_queue Job's queue name
+    # @param [Array<String>] queues
+    #
+    # @return [Boolean]
+    def enabled_queue?(job_queue, queues)
+      queues.empty? || queues.include?(job_queue)
+    end
 
-      def sanitize_job_config(config)
-        config.reject { |k, _| RUFUS_METADATA_KEYS.include?(k) }
-      end
+    # Returns true if the enqueuing needs to be done for an ActiveJob
+    #  class false otherwise.
+    #
+    # @param [Class] klass the class to check is decendant from ActiveJob
+    #
+    # @return [Boolean]
+    def active_job_enqueue?(klass)
+      klass.is_a?(Class) && defined?(ActiveJob::Enqueuing) &&
+        klass.included_modules.include?(ActiveJob::Enqueuing)
+    end
 
-      # Retrieves a schedule state
-      #
-      # @param name [String] with the schedule's name
-      # @return [Hash] with the schedule's state
-      def schedule_state(name)
-        state = SidekiqScheduler::RedisManager.get_job_state(name)
+    # Convert the given arguments in the format expected to be enqueued.
+    #
+    # @param [Hash] config the options to be converted
+    # @option config [String] class the job class
+    # @option config [Hash/Array] args the arguments to be passed to the job
+    #   class
+    #
+    # @return [Hash]
+    def prepare_arguments(config)
+      config['class'] = SidekiqScheduler::Utils.try_to_constantize(config['class'])
 
-        state ? JSON.parse(state) : {}
+      if config['args'].is_a?(Hash)
+        config['args'].symbolize_keys! if config['args'].respond_to?(:symbolize_keys!)
+      else
+        config['args'] = Array(config['args'])
       end
 
-      # Saves a schedule state
-      #
-      # @param name [String] with the schedule's name
-      # @param name [Hash] with the schedule's state
-      def set_schedule_state(name, state)
-        SidekiqScheduler::RedisManager.set_job_state(name, state)
-      end
+      config
+    end
 
-      # Adds a Hash with schedule metadata as the last argument to call the worker.
-      # It currently returns the schedule time as a Float number representing the milisencods
-      # since epoch.
-      #
-      # @example with hash argument
-      #   arguments_with_metadata({value: 1}, scheduled_at: Time.now)
-      #   #=> [{value: 1}, {scheduled_at: <miliseconds since epoch>}]
-      #
-      # @param args [Array|Hash]
-      # @param metadata [Hash]
-      # @return [Array] arguments with added metadata
-      def arguments_with_metadata(args, metadata)
-        if args.is_a? Array
-          [*args, metadata]
-        else
-          [args, metadata]
-        end
-      end
+    # Returns true if the given schedule config hash matches the current ENV['RAILS_ENV']
+    # @param [Hash] config The schedule job configuration
+    #
+    # @return [Boolean] true if the schedule config matches the current ENV['RAILS_ENV']
+    def rails_env_matches?(config)
+      config['rails_env'] && ENV['RAILS_ENV'] && config['rails_env'].gsub(/\s/, '').split(',').include?(ENV['RAILS_ENV'])
+    end
 
-      def sidekiq_queues
-        Sidekiq.options[:queues].map(&:to_s)
+    def handle_errors
+      begin
+        yield
+      rescue StandardError => e
+        Sidekiq.logger.info "#{e.class.name}: #{e.message}"
       end
     end
   end

data/lib/sidekiq-scheduler/utils.rb

@@ -3,6 +3,8 @@ require 'set'
 module SidekiqScheduler
   module Utils
 
+    RUFUS_METADATA_KEYS = %w(description at cron every in interval enabled)
+
     # Stringify keys belonging to a hash.
     #
     # Also stringifies nested keys and keys of hashes inside arrays, and sets
@@ -40,5 +42,89 @@ module SidekiqScheduler
         object
       end
     end
+
+    # Constantize a given string.
+    #
+    # @param [String] klass The string to constantize
+    #
+    # @return [Class] the class corresponding to the klass param
+    def self.try_to_constantize(klass)
+      klass.is_a?(String) ? klass.constantize : klass
+    rescue NameError
+      klass
+    end
+
+    # Initializes active_job using the passed parameters.
+    #
+    # @param [Class] klass The class to initialize
+    # @param [Array/Hash] the parameters passed to the klass initializer
+    #
+    # @return [Object] instance of the class klass
+    def self.initialize_active_job(klass, args)
+      if args.is_a?(Array)
+        klass.new(*args)
+      else
+        klass.new(args)
+      end
+    end
+
+    # Enqueues the job using the Sidekiq client.
+    #
+    # @param [Hash] config The job configuration
+    def self.enqueue_with_sidekiq(config)
+      Sidekiq::Client.push(sanitize_job_config(config))
+    end
+
+    # Enqueues the job using the ActiveJob.
+    #
+    # @param [Hash] config The job configuration
+    def self.enqueue_with_active_job(config)
+      options = {
+        queue: config['queue']
+      }.keep_if { |_, v| !v.nil? }
+
+      initialize_active_job(config['class'], config['args']).enqueue(options)
+    end
+
+    # Removes the hash values associated to the rufus metadata keys.
+    #
+    # @param [Hash] config The job configuration
+    #
+    # @return [Hash] the sanitized job config
+    def self.sanitize_job_config(config)
+      config.reject { |k, _| RUFUS_METADATA_KEYS.include?(k) }
+    end
+
+    # Creates a new instance of rufus scheduler.
+    #
+    # @return [Rufus::Scheduler] the scheduler instance
+    def self.new_rufus_scheduler(options = {})
+      Rufus::Scheduler.new(options).tap do |scheduler|
+        scheduler.define_singleton_method(:on_post_trigger) do |job, triggered_time|
+          SidekiqScheduler::Utils.update_job_last_time(job.tags[0], triggered_time)
+          SidekiqScheduler::Utils.update_job_next_time(job.tags[0], job.next_time)
+        end
+      end
+    end
+
+    # Pushes job's next time execution
+    #
+    # @param [String] name The job's name
+    # @param [Time] next_time The job's next time execution
+    def self.update_job_next_time(name, next_time)
+      if next_time
+        SidekiqScheduler::RedisManager.set_job_next_time(name, next_time)
+      else
+        SidekiqScheduler::RedisManager.remove_job_next_time(name)
+      end
+    end
+
+    # Pushes job's last execution time
+    #
+    # @param [String] name The job's name
+    # @param [Time] last_time The job's last execution time
+    def self.update_job_last_time(name, last_time)
+      SidekiqScheduler::RedisManager.set_job_last_time(name, last_time) if last_time
+    end
   end
 end

data/lib/sidekiq-scheduler/version.rb

@@ -1,5 +1,5 @@
 module SidekiqScheduler
 
-  VERSION = '2.2.2'
+  VERSION = '3.0.0'
 
 end

data/lib/sidekiq-scheduler/web.rb

@@ -17,14 +17,14 @@ module SidekiqScheduler
 
       app.get '/recurring-jobs/:name/enqueue' do
         schedule = Sidekiq.get_schedule(params[:name])
-        SidekiqScheduler::Scheduler.enqueue_job(schedule)
+        SidekiqScheduler::Scheduler.instance.enqueue_job(schedule)
         redirect "#{root_path}recurring-jobs"
       end
 
       app.get '/recurring-jobs/:name/toggle' do
         Sidekiq.reload_schedule!
 
-        SidekiqScheduler::Scheduler.toggle_job_enabled(params[:name])
+        SidekiqScheduler::Scheduler.instance.toggle_job_enabled(params[:name])
         redirect "#{root_path}recurring-jobs"
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq