sidekiq_pipeline 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e48df4c8494e895863a4a2499d5519d0c350dc14
+  data.tar.gz: 325a740464152838b92133caf21a686365ca4de7
+SHA512:
+  metadata.gz: 5db0e1a76305b91b744206c23c16ba5701ec6d8e73baf9ffc27424f8a72e0de12a439c97b13730647ebe0507ea5cbccab47b1a7952ab7457ec34bc5aff896580
+  data.tar.gz: 1b9907e9edfbdc6eff016ac35a2b0801ab348d626a99f2896b1d78ff77813b9df9b65a51a7d5f4a727101e72d25124eedbb178c4933d4cf4029f39fd54ed98d8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.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_pipeline.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Bergeron
+
+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,61 @@
+# SidekiqPipeline
+
+Allows you to define pipelines in Sidekiq, an ordered chain of jobs.
+
+```ruby
+class WorkerOne
+  include Sidekiq::Worker
+  include SidekiqPipeline
+
+  def pipeline_perform(params)
+    puts params["key"]
+  end
+end
+
+class WorkerTwo
+  include Sidekiq::Worker
+  include SidekiqPipeline
+
+  def pipeline_perform(params)
+    puts params["data"]
+  end
+end
+
+tasks = {
+  pipeline: [{
+    class: "WorkerOne",
+    params: {key: 'foo'}
+  },{
+    class: "WorkerTwo",
+    params: {data: 'bar'}
+  }]
+}
+
+SidekiqPipeline.execute(tasks)
+# WorkerOne will output: 'foo'
+# WorkerTwo will output: 'bar'
+```
+
+Tasks will be run in the order they are defined. If a task fails, it will retry on the step it failed on, and it will continue down the pipeline if/when it retires successfully. Each worker can have it's own queue or share queues. Tries to be as unobtrusive as possible
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq_pipeline'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq_pipeline
+
+## 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_pipeline.rb

@@ -0,0 +1,37 @@
+require "sidekiq_pipeline/version"
+
+module SidekiqPipeline
+
+  # For kicking off a pipeline
+  def self.execute(params)
+    first_job = params[:pipeline].first
+
+    klass = Object.const_get(first_job[:class])
+
+    klass.perform_async(params)
+  end
+
+  def perform(params)
+    # params = {
+    #   pipeline: [{
+    #       class: "Worker1",
+    #       params: {...}
+    #     },{
+    #       class: "Worker2",
+    #       params: {...}
+    #     },...
+    #   ]
+    # }
+
+    job = params["pipeline"].shift
+    klass = Object.const_get(job["class"])
+
+    klass.new.pipeline_perform(job["params"])
+
+    if !params["pipeline"].empty?
+      klass = Object.const_get(params["pipeline"].first["class"])
+      klass.perform_async(params)
+    end
+  end
+
+end

data/lib/sidekiq_pipeline/version.rb

@@ -0,0 +1,3 @@
+module SidekiqPipeline
+  VERSION = "0.0.1"
+end

data/sidekiq_pipeline.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_pipeline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq_pipeline"
+  spec.version       = SidekiqPipeline::VERSION
+  spec.authors       = ["Paul Bergeron"]
+  spec.email         = ["paul.d.bergeron@gmail.com"]
+  spec.summary       = %q{Supports defining 'pipelines' of workers in Sidekiq}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "sidekiq", "~> 2.7.5"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_pipeline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Bergeron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-19 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+description: 
+email:
+- paul.d.bergeron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq_pipeline.rb
+- lib/sidekiq_pipeline/version.rb
+- sidekiq_pipeline.gemspec
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Supports defining 'pipelines' of workers in Sidekiq
+test_files: []