sidekiq-tip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9c09d096026300573d79097d5df3145b88d399c
+  data.tar.gz: dadbd7f18d6c0c9e697c34c1e2d43d25e9cd34e7
+SHA512:
+  metadata.gz: 54a4f3564265edaba1477ef5937b9357d87d1cf5334d8a3856e47b743444061e0a4b4a62dfb6b68aa48fd233d50993e35405e7a71e9dec70c42015e4d2ff9837
+  data.tar.gz: 7e358daf21505008ebf7d2ba5bd2a01a43bf58599395b7a0cb54bff11e6391618b566616a6f63510f68ab0e5749543123ee184e9113f2c0480a2e926da6cd1c1

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.sw*
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-tip.gemspec
+gemspec
+
+group :developmnt, :test do
+  gem 'pry'
+  gem 'sidekiq', git: 'https://github.com/mperham/sidekiq.git'
+  gem 'minitest'
+  gem 'wrong'
+  gem 'mocha'
+  gem 'timecop'
+  gem 'multi_json'
+  gem 'mock_redis'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Andrew Kumanyaev
+
+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,45 @@
+# Sidekiq::Tip
+
+Perform sidekiq jobs in time interval
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-tip'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sidekiq-tip
+```
+
+## Usage
+
+```ruby
+class SomeJob
+  include Sidekiq::Worker
+  # [0, 0, 0] == [hour, min, sec]
+  sidekiq_options start_at: [0, 0, 0], finish_at: [10, 0, 0]
+
+  def perform
+    # ...
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sidekiq-tip/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'bundler/setup'
+
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/sidekiq/tip/server/middleware.rb

@@ -0,0 +1,53 @@
+require 'pry'
+
+module Sidekiq
+  module Tip
+    module Server
+      class Middleware
+        def initialize(options={})
+          @start_at  = options.fetch(:start_at,  [0, 0, 0]) # hour, minutes, second
+          @finish_at = options.fetch(:finish_at, [23, 59, 59]) # hour, minutes, second
+        end
+
+        def call(worker, msg, queue)
+          fetch_times(msg)
+
+          if appropriate_time_interval?
+            yield
+          else
+            worker.class.perform_in(wait_time, msg)
+          end
+        end
+
+        #private
+
+        def fetch_times(msg)
+          @start_at = msg.fetch('start_at', @start_at)
+          @finish_at = msg.fetch('finish_at', @finish_at)
+        end
+
+        def appropriate_time_interval?
+          current_time.between?(start_time, finish_time)
+        end
+
+        def start_time
+          hour, min, sec = @start_at
+          Time.utc(current_time.year, current_time.month, current_time.day, hour, min, sec)
+        end
+
+        def finish_time
+          hour, min, sec = @finish_at
+          Time.utc(current_time.year, current_time.month, current_time.day, hour, min, sec)
+        end
+
+        def current_time
+          Time.now.utc
+        end
+
+        def wait_time
+          (start_time + 86400) - current_time
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/tip/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Tip
+    VERSION = "0.0.1"
+  end
+end

data/lib/sidekiq/tip.rb

@@ -0,0 +1,9 @@
+require "sidekiq/tip/version"
+require "sidekiq/tip/server/middleware"
+require 'pry'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Tip::Server::Middleware
+  end
+end

data/sidekiq-tip.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/tip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-tip"
+  spec.version       = Sidekiq::Tip::VERSION
+  spec.authors       = ["Andrew Kumanyaev"]
+  spec.email         = ["me@zzet.org"]
+  spec.summary       = %q{Perform worker in time interval}
+  spec.description   = %q{Sometimes we need to perform some workers in time interval. For example, we want to run all jobs at night (from 2 am to 6 am).}
+  spec.homepage      = "https://github.com/zzet/sidekiq-tip"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test/lib/middleware_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+require 'pry'
+
+class MiddlawareTest < Minitest::Test
+  def test_job_in_interval
+    t = Time.utc(2008, 9, 1, 1, 0, 0)
+    Timecop.travel(t)
+
+    assert { SomeJob.jobs.size == 0 }
+    SomeJob.perform_async
+    assert { SomeJob.jobs.size == 1 }
+    SomeJob.drain
+    assert { SomeJob.jobs.size == 0 }
+
+    Timecop.return
+  end
+
+  def test_job_not_in_interval
+    t = Time.utc(2008, 9, 1, 1, 0, 0)
+    Timecop.travel(t)
+
+    assert { SomeIvarJob.jobs.size == 0 }
+    SomeIvarJob.perform_async
+    assert { SomeIvarJob.jobs.size == 1 }
+    SomeJob.drain
+    assert { SomeIvarJob.jobs.size == 1 }
+
+    Timecop.return
+  end
+
+  def test_job_without_interval_settings
+    t = Time.utc(2008, 9, 1, 1, 0, 0)
+    Timecop.travel(t)
+
+    assert { SomeSimpleJob.jobs.size == 0 }
+    SomeSimpleJob.perform_async
+    assert { SomeSimpleJob.jobs.size == 1 }
+    SomeSimpleJob.drain
+    assert { SomeSimpleJob.jobs.size == 0 }
+
+    Timecop.return
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,66 @@
+# require 'simplecov'
+# SimpleCov.start
+
+# require 'coveralls'
+# Coveralls.wear!
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/autorun'
+require 'timecop'
+require 'wrong'
+
+require 'celluloid/current'
+require 'celluloid/test'
+Celluloid.boot
+
+require 'sidekiq'
+require 'sidekiq/cli'
+require 'sidekiq/processor'
+require 'sidekiq/util'
+
+require 'sidekiq/testing'
+Sidekiq::Testing.fake!
+
+require 'sidekiq/tip'
+
+Sidekiq::Testing.server_middleware do |chain|
+  chain.add Sidekiq::Tip::Server::Middleware
+end
+
+Wrong.config.color
+
+require 'sidekiq/redis_connection'
+REDIS_URL = ENV['REDIS_URL'] || 'redis://localhost/15'
+REDIS = Sidekiq::RedisConnection.create(:url => REDIS_URL, :namespace => 'testy')
+
+Sidekiq.configure_client do |config|
+  config.redis = { :url => REDIS_URL, :namespace => 'testy' }
+end
+
+class MiniTest::Test
+  include Wrong
+end
+
+
+class SomeJob
+  include Sidekiq::Worker
+
+  sidekiq_options start_at: [0, 0, 0], finish_at: [10, 0, 0]
+
+  def perform; end
+end
+
+class SomeIvarJob
+  include Sidekiq::Worker
+
+  sidekiq_options start_at: [10, 0, 0], finish_at: [15, 0, 0]
+
+  def perform; end
+end
+
+class SomeSimpleJob
+  include Sidekiq::Worker
+
+  def perform; end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-tip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kumanyaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Sometimes we need to perform some workers in time interval. For example,
+  we want to run all jobs at night (from 2 am to 6 am).
+email:
+- me@zzet.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/tip.rb
+- lib/sidekiq/tip/server/middleware.rb
+- lib/sidekiq/tip/version.rb
+- sidekiq-tip.gemspec
+- test/lib/middleware_test.rb
+- test/test_helper.rb
+homepage: https://github.com/zzet/sidekiq-tip
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Perform worker in time interval
+test_files:
+- test/lib/middleware_test.rb
+- test/test_helper.rb
+has_rdoc: