sidekiq-repeating-jobs 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ab3a25387fe420a992cbfbce90e2e0a3c3e772b
+  data.tar.gz: e4e0ba152095b7554676812c9d80993f7d2fa9a9
+SHA512:
+  metadata.gz: fbd1f976e6149daa3904aa9effd806d5c25cad954b743e6a88c05048fa4ffcf9e44442f57c80dd8954fa5114c74631327d58bd1e9a57eb69d418229dbd8cfd49
+  data.tar.gz: 9597438f606f5480af8c2c0ac3ae7df305e353a62ae098016daddf2795ca6bb966fb9748645313391ff71c6e5033539476cedc57522dc56156125ff7e2bb52bb

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marc Lennox
+
+MIT License
+
+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::Repeating::Jobs
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-repeating-jobs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-repeating-jobs
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sidekiq_repeating_jobs.rb

@@ -0,0 +1,14 @@
+require "yaml" if RUBY_VERSION.include?('2.0.0')
+require "sidekiq_repeating_jobs/version"
+require "sidekiq_repeating_jobs/middleware"
+require "sidekiq_repeating_jobs/version"
+require "sidekiq_repeating_jobs/config"
+require "sidekiq_repeating_jobs/worker_helper"
+
+module SidekiqRepeatingJobs
+
+  def self.config
+    SidekiqRepeatingJobs::Config
+  end
+
+end

data/lib/sidekiq_repeating_jobs/config.rb

@@ -0,0 +1,30 @@
+module SidekiqRepeatingJobs
+
+  class Config
+
+    DEFAULT_EXPIRATION_SECONDS=30*60
+    DEFAULT_REPEAT_SECONDS=60
+
+    class << self
+
+      def active?(worker_class)
+        worker_class.get_sidekiq_options['repeat'].present?
+      end
+
+      def job_name(worker_class)
+        worker_class.get_sidekiq_options['repeating_job_name'] || worker_class.name.demodulize.underscore
+      end
+
+      def repeat_interval(worker_class)
+        (r = worker_class.get_sidekiq_options['repeat']).is_a?(Fixnum) ? r : DEFAULT_REPEAT_SECONDS
+      end
+
+      def expiration_interval(worker_class)
+        self.repeat_interval(worker_class) + (worker_class.get_sidekiq_options['repeating_job_expiration'] || DEFAULT_EXPIRATION_SECONDS)
+      end
+
+    end
+
+  end
+
+end

data/lib/sidekiq_repeating_jobs/middleware.rb

@@ -0,0 +1,16 @@
+require 'sidekiq'
+require 'sidekiq_repeating_jobs/middleware/helpers'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    require 'sidekiq_repeating_jobs/middleware/server/repeating_jobs'
+    chain.add SidekiqRepeatingJobs::Middleware::Server::RepeatingJobs
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    require 'sidekiq_repeating_jobs/middleware/client/repeating_jobs'
+    chain.add SidekiqRepeatingJobs::Middleware::Client::RepeatingJobs
+  end
+end

data/lib/sidekiq_repeating_jobs/middleware/client/repeating_jobs.rb

@@ -0,0 +1,21 @@
+module SidekiqRepeatingJobs
+  module Middleware
+    module Client
+      class RepeatingJobs
+        include SidekiqRepeatingJobs::Middleware::Helpers
+
+        def log_name
+          "RepeatingJobClient"
+        end
+
+        def call(worker_class, item, queue)
+          if SidekiqRepeatingJobs::Config.active?(worker_class)
+            yield if valid_arguments?(worker_class, item['args'].last)
+          else
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_repeating_jobs/middleware/helpers.rb

@@ -0,0 +1,103 @@
+module SidekiqRepeatingJobs
+  module Middleware
+    module Helpers
+
+      module ClassMethods
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def log_message(args, message, level=:info)
+        Sidekiq.logger.send(level, "[#{self.log_name}] [#{/^([:_a-z]+\:repeating_job\:)([:_a-z]+)$/.match(args['repeating_job_key'])[2]}] #{message}")
+      end
+
+      private
+
+      def process_name
+        "#{Socket.gethostbyname(Socket.gethostname).first}-p#{Process.pid}-t#{Thread.current.object_id}"
+      end
+
+      def active_key(args)
+        "#{args['repeating_job_key']}:active"
+      end
+
+      def owner_id_key(args)
+        "#{args['repeating_job_key']}:owner_id"
+      end
+
+      def owner_name_key(args)
+        "#{args['repeating_job_key']}:owner_name"
+      end
+
+      def last_run_at_key(args)
+        "#{args['repeating_job_key']}:last_run_at"
+      end
+
+      def valid_arguments?(worker_class, arguments)
+        raise "Missing repeat job arguments" if arguments.nil? || !arguments.is_a?(Hash)
+        arguments.assert_valid_keys('scheduler_key', 'scheduler_id', 'repeating_job_key', 'repeating_job_id')
+        raise "Missing scheduler_key repeat job argument" if arguments['scheduler_key'].nil?
+        check_scheduler(worker_class, arguments)
+        return false if arguments['scheduler_id'].nil?
+        raise "Missing repeating_job_key repeat job argument" if arguments['repeating_job_key'].nil?
+        check_reservation(worker_class, arguments)
+        return false if arguments['repeating_job_id'].nil?
+        return true
+      end
+
+      def check_scheduler(worker_class, arguments)
+        Sidekiq.redis do |conn|
+          if (scheduler_id=conn.redis.get("#{arguments['scheduler_key']}:owner_id"))
+            if arguments['scheduler_id']
+              unless arguments['scheduler_id'] == scheduler_id
+                self.log_message(arguments, "schedule [#{arguments['scheduler_id']}] no longer active")
+                arguments.delete('scheduler_id')
+                conn.redis.del(owner_id_key(arguments))
+              end
+            else
+              arguments['scheduler_id']=scheduler_id
+              self.log_message(arguments, "Using active schedule [#{arguments['scheduler_id']}]")
+            end
+          else
+            self.log_message(arguments, "has no active schedule")
+            arguments.delete('scheduler_id')
+          end
+        end
+      end
+
+      def check_reservation(worker_class, arguments)
+        Sidekiq.redis do |conn|
+          if conn.redis.get(active_key(arguments)) == 'true' || conn.redis.setnx(active_key(arguments), 'true')
+            repeating_job_id=arguments['repeating_job_id'] || SecureRandom.hex(16).downcase
+            existing_repeating_job_id=conn.redis.get(owner_id_key(arguments))
+            unless repeating_job_id == existing_repeating_job_id || conn.redis.setnx(owner_id_key(arguments), repeating_job_id)
+              if existing_repeating_job_id
+                self.log_message(arguments, "existing reservation [#{existing_repeating_job_id}] for #{conn.redis.ttl(owner_id_key(arguments))} seconds")
+              else
+                self.log_message(arguments, "invalid reservation [#{arguments['repeating_job_id']}]")
+              end
+              arguments.delete('repeating_job_id')
+            else
+              arguments['repeating_job_id']=repeating_job_id
+              result=conn.redis.multi do
+                conn.redis.expire(owner_id_key(arguments), SidekiqRepeatingJobs::Config.expiration_interval(worker_class))
+                conn.redis.setex(owner_name_key(arguments), SidekiqRepeatingJobs::Config.expiration_interval(worker_class), process_name)
+                conn.redis.set(last_run_at_key(arguments), DateTime.now.strftime("%Y-%m-%d %H:%M:%S %Z"))
+              end
+              if existing_repeating_job_id
+                self.log_message(arguments, "extended reservation [#{arguments['repeating_job_id']}] by #{SidekiqRepeatingJobs::Config.expiration_interval(worker_class)} seconds")
+              else
+                self.log_message(arguments, "reserved [#{arguments['repeating_job_id']}] for #{SidekiqRepeatingJobs::Config.expiration_interval(worker_class)} seconds")
+              end
+            end
+          else
+            self.log_message(arguments, "is currently inactive")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/sidekiq_repeating_jobs/middleware/server/repeating_jobs.rb

@@ -0,0 +1,30 @@
+module SidekiqRepeatingJobs
+  module Middleware
+    module Server
+      class RepeatingJobs
+        include SidekiqRepeatingJobs::Middleware::Helpers
+
+        def log_name
+          "RepeatingJobServer"
+        end
+
+        def call(*args)
+          worker_class=eval(args[1]['class'])
+          if SidekiqRepeatingJobs::Config.active?(worker_class)
+            arguments=args[1]['args'].slice!(-1)
+            if valid_arguments?(worker_class, arguments)
+              begin
+                yield
+              ensure
+                worker_class.perform_in(SidekiqRepeatingJobs::Config.repeat_interval(worker_class), *args[1]['args'], arguments)
+                self.log_message(arguments, "scheduled in #{SidekiqRepeatingJobs::Config.repeat_interval(worker_class)} seconds")
+              end
+            end
+          else
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_repeating_jobs/version.rb

@@ -0,0 +1,3 @@
+module SidekiqRepeatingJobs
+  VERSION = "0.0.4"
+end

data/lib/sidekiq_repeating_jobs/worker_helper.rb

@@ -0,0 +1,23 @@
+module SidekiqRepeatingJobs
+
+  module WorkerHelper
+
+    module ClassMethods
+      def trigger(*keys)
+        keys.each do |key|
+          arguments={
+            'scheduler_key' => "#{Settings[:redis].namespace}:scheduler",
+            'repeating_job_key' => "#{Settings[:sidekiq].namespace}:repeating_job:#{SidekiqRepeatingJobs::Config.job_name(self)}:#{key}"
+          }
+          self.perform_async(key, arguments)
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+  end
+
+end

data/sidekiq-repeating-jobs.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq_repeating_jobs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-repeating-jobs"
+  spec.version       = SidekiqRepeatingJobs::VERSION
+  spec.authors       = ["Marc Lennox"]
+  spec.email         = ["marc.lennox@gmail.com"]
+  spec.description   = %q{Sidekiq plugin that provides for singleton jobs that reschedule themselves after completion}
+  spec.summary       = %q{Sidekiq plugin that provides for singleton jobs that reschedule themselves after completion}
+  spec.homepage      = "http://github.com/marclennox/sidekiq-repeating-jobs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             "sidekiq", "~> 2.15"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-repeating-jobs
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Marc Lennox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Sidekiq plugin that provides for singleton jobs that reschedule themselves
+  after completion
+email:
+- marc.lennox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq_repeating_jobs.rb
+- lib/sidekiq_repeating_jobs/config.rb
+- lib/sidekiq_repeating_jobs/middleware.rb
+- lib/sidekiq_repeating_jobs/middleware/client/repeating_jobs.rb
+- lib/sidekiq_repeating_jobs/middleware/helpers.rb
+- lib/sidekiq_repeating_jobs/middleware/server/repeating_jobs.rb
+- lib/sidekiq_repeating_jobs/version.rb
+- lib/sidekiq_repeating_jobs/worker_helper.rb
+- sidekiq-repeating-jobs.gemspec
+homepage: http://github.com/marclennox/sidekiq-repeating-jobs
+licenses:
+- MIT
+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.1.9
+signing_key: 
+specification_version: 4
+summary: Sidekiq plugin that provides for singleton jobs that reschedule themselves
+  after completion
+test_files: []