sidekiq-sync 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 938b02f90b02175bc9026e419c5dbb3f0619810e0b2f9b124d575a0dd67d9b6c
+  data.tar.gz: fab017628c8313197775a1a7ceada980dd5a0dabd828aa1a59c9c35beb9a5cce
+SHA512:
+  metadata.gz: 95f9a34eb6d594faf37b3f6d6b29e33b812f6569d041d89e13acf7ca94859ad051cecd399150289968315f6d1c2aea322a921b8afc4b2ecedc73b3840ef057f7
+  data.tar.gz: c153f63cfd67198750a134f25129cf0088cb2fcc2f4a97b1ab95cde64f62b518091631c1823111c02a0773631e229e22c1b1e91b91a26b58ef42e274e6d733ff

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+sidekiq-sync

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq-sync.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-sync (0.0.1)
+      sidekiq (~> 5.1, = 5.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-sidekiq (0.1.0)
+      guard (>= 2)
+      sidekiq
+    kommando (0.1.2)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.5)
+    rack-protection (2.0.3)
+      rack
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    redis (4.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    sidekiq (5.1.3)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  guard (~> 2.14, = 2.14.2)
+  guard-rspec (~> 4.7, = 4.7.3)
+  guard-sidekiq (~> 0.1, = 0.1.0)
+  kommando (~> 0.1, = 0.1.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sidekiq-sync!
+
+BUNDLED WITH
+   1.16.2

data/Guardfile

@@ -0,0 +1,81 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+### Guard::Sidekiq
+#  available options:
+#  - :verbose
+#  - :queue (defaults to "default") can be an array
+#  - :concurrency (defaults to 1)
+#  - :timeout
+#  - :environment (corresponds to RAILS_ENV for the Sidekiq worker)
+guard 'sidekiq', :environment => 'development', require: './spec/workers/*.rb' do
+  watch(%r{spec/workers/(.+)\.rb$})
+  watch(%r{lib/sidekiq/sync/(.+)\.rb$})
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: "GUARD_ACTIVE=true bundle exec rspec", all_on_start: true, all_after_pass: true do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Matti Paksula
+
+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,39 @@
+# sidekiq-sync
+
+Adds `perform_sync` to Sidekiq to get return value from perform while still executing through Sidekiq (distributed workers!). Internally it stores the result in a unique queue that is polled.
+
+## Usage:
+
+```
+class HardWorker
+  include Sidekiq::Sync::Worker
+
+  def perform(how_hard="super hard", how_long=1)
+    puts "working #{how_hard}"
+    sleep how_long
+    "I worked #{how_hard}"
+  end
+end
+
+puts HardWorker.perform_sync("really hard")
+# outputs "I worked really hard"
+
+puts HardWorker.perform_async("really hard")
+# outputs the sidekiq job..
+
+options = Sidekiq::Sync::Options.new(timeout: 3)
+puts HardWorker.perform_sync(options, "really hard", 4)
+# times out in 3 seconds and raises Sidekiq::Sync::TimeoutError
+
+options = Sidekiq::Sync::Options.new(timeout: 3, raise: false)
+puts HardWorker.perform_sync(options, "really hard", 4)
+# times out in 3 seconds, returns nil, does not raise
+
+options = Sidekiq::Sync::Options.new(timeout: 3, raise: false)
+puts HardWorker.perform_sync(options, "really hard", 4)
+# times out in 3 seconds, returns nil, does not raise
+
+options = Sidekiq::Sync::Options.new(timeout: 3, raise: false)
+puts HardWorker.perform_sync("really hard", options, 4)
+# options can be wherever you wish (still sleeps 4, timeouts in 3 and does not raise)
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/sync"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/e2e

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+set -e
+
+rake
+ruby e2e/e2e.rb

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/e2e/e2e.rb

@@ -0,0 +1,27 @@
+$stdout.sync = true
+
+require "sidekiq"
+require_relative "e2e_worker"
+
+require "kommando"
+$sidekiq_runner = Kommando.new "sidekiq -r./e2e/e2e_worker.rb", {
+  output: true
+}
+$sidekiq_runner.run_async
+
+smoke_value = E2EWorker.perform_sync "smoke"
+raise "smoke" unless smoke_value == "smoke"
+
+got_exception = false
+begin
+  E2EWorker.perform_sync "nothing", 2, Sidekiq::Sync::Options.new(timeout: 1)
+rescue Sidekiq::Sync::TimeoutError
+  got_exception = true
+end
+raise "raise" unless got_exception
+
+timeout_value = E2EWorker.perform_sync "timeout_and_raise_false", 2, Sidekiq::Sync::Options.new(timeout: 1, raise: false)
+raise "timeout_and_raise_false" if timeout_value
+
+puts "OK"
+$sidekiq_runner.kill

data/e2e/e2e_worker.rb

@@ -0,0 +1,11 @@
+require_relative "../lib/sidekiq/sync"
+
+class E2EWorker
+  include Sidekiq::Sync::Worker
+
+  def perform(what, how_long=0)
+    puts "performing: #{what}"
+    sleep how_long
+    what
+  end
+end

data/lib/sidekiq/sync.rb

@@ -0,0 +1,13 @@
+require "redis"
+
+require_relative "sync/version"
+require_relative "sync/worker"
+require_relative "sync/class_methods"
+require_relative "sync/performer"
+require_relative "sync/timeout_error"
+require_relative "sync/options"
+
+module Sidekiq
+  module Sync
+  end
+end

data/lib/sidekiq/sync/class_methods.rb

@@ -0,0 +1,31 @@
+module Sidekiq
+  module Sync
+    module ClassMethods
+      def perform_sync(*args)
+        real_args = []
+        options = Sidekiq::Sync::Options.new
+        for arg in args
+          if arg.is_a? Sidekiq::Sync::Options
+            options = arg
+          else
+            real_args << arg
+          end
+        end
+
+        return_channel = "sidekiq-sync:#{SecureRandom::uuid}"
+
+        self.perform_async(return_channel, *real_args)
+#        queue_or_nil_if_timeout, value = Sidekiq::Sync.redis.blpop return_channel, timeout: options.timeout
+        queue_or_nil_if_timeout, value = Sidekiq.redis do |r|
+          r.blpop return_channel, timeout: options.timeout
+        end
+
+        unless queue_or_nil_if_timeout
+          raise Sidekiq::Sync::TimeoutError if options.raise
+        end
+
+        value
+      end
+    end
+  end
+end

data/lib/sidekiq/sync/options.rb

@@ -0,0 +1,15 @@
+module Sidekiq
+  module Sync
+    class Options
+      attr_reader :timeout, :raise
+      def initialize(opts={})
+        @timeout = opts[:timeout] || 0
+        @raise = if opts[:raise] == false
+          false
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/sync/performer.rb

@@ -0,0 +1,21 @@
+module Sidekiq
+  module Sync
+    module Performer
+      def perform(*args)
+        if args[0] && args[0].start_with?("sidekiq-sync:")
+          channel = args.shift
+          result = super(*args)
+
+          Sidekiq.redis do |r|
+            r.lpush channel, result
+            r.expire channel, 1
+          end
+
+          result
+        else
+          super(*args)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/sync/timeout_error.rb

@@ -0,0 +1,6 @@
+module Sidekiq
+  module Sync
+    class TimeoutError < StandardError
+    end
+  end
+end

data/lib/sidekiq/sync/version.rb

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

data/lib/sidekiq/sync/worker.rb

@@ -0,0 +1,13 @@
+require "sidekiq"
+
+module Sidekiq
+  module Sync
+    module Worker
+      def self.included(includer)
+        includer.include Sidekiq::Worker
+        includer.prepend Sidekiq::Sync::Performer
+        includer.extend Sidekiq::Sync::ClassMethods
+      end
+    end
+  end
+end

data/sidekiq-sync.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/sidekiq/sync/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-sync"
+  spec.version       = Sidekiq::Sync::VERSION
+  spec.authors       = ["Matti Paksula"]
+  spec.email         = ["matti.paksula@iki.fi"]
+
+  spec.summary       = %q{perform_sync for Sidekiq}
+  spec.description   = %q{Adds perform_sync next to perform_async}
+  spec.homepage      = "https://github.com/matti/sidekiq-sync"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", "5.1.3", "~> 5.1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard", "2.14.2", "~> 2.14"
+  spec.add_development_dependency "guard-sidekiq", "0.1.0", "~> 0.1"
+  spec.add_development_dependency "guard-rspec", "4.7.3", "~> 4.7"
+  spec.add_development_dependency "kommando", "0.1.2", "~> 0.1"
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matti Paksula
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: kommando
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Adds perform_sync next to perform_async
+email:
+- matti.paksula@iki.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/e2e
+- bin/setup
+- e2e/e2e.rb
+- e2e/e2e_worker.rb
+- lib/sidekiq/sync.rb
+- lib/sidekiq/sync/class_methods.rb
+- lib/sidekiq/sync/options.rb
+- lib/sidekiq/sync/performer.rb
+- lib/sidekiq/sync/timeout_error.rb
+- lib/sidekiq/sync/version.rb
+- lib/sidekiq/sync/worker.rb
+- sidekiq-sync.gemspec
+homepage: https://github.com/matti/sidekiq-sync
+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.7.6
+signing_key: 
+specification_version: 4
+summary: perform_sync for Sidekiq
+test_files: []