gush-mmx 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f55fd6914dcc9cf58d63c7bf6df6489c8f9eb76
+  data.tar.gz: aa4bcedcb43924b69197c361e5c4964ac42e196d
+SHA512:
+  metadata.gz: 51223f508abf7a0e6286bc34f118553d49ecc7e9b49dc9c62e1a5adf7e83ae453a59efd02679d49bfa6d3b01a5bf41a068f0cc79224e5d60d9f1f9aea4677dd5
+  data.tar.gz: 200c6e51fe0d8bebc12d7ec8989bd7883392f5ea7e51463ef6acfe2df29df7440d925875980f2e676062d5feb625d313412ec00ef74d9f129a75f59f95d6085c

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+workflows/
+tmp
+test.rb
+/Gushfile.rb
+dump.rdb

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+script: "bundle exec rspec"
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+services:
+  - redis-server
+email:
+  recipients:
+    - piotrek@okonski.org
+  on_success: change
+  on_failure: always

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.4
+
+- remove hard dependency on Yajl, so Gush can work with non-MRI Rubies ([#31](https://github.com/chaps-io/gush/pull/31) by [Nick Rakochy](https://github.com/chaps-io/gush/pull/31))

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+platforms :mri, :ruby do
+  gem 'yajl-ruby'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chaps sp. z o.o.
+
+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,258 @@
+# Gush [![Build Status](https://travis-ci.org/chaps-io/gush.svg?branch=master)](https://travis-ci.org/chaps-io/gush)
+
+## [![](http://i.imgur.com/ya8Wnyl.png)](https://chaps.io) proudly made by [Chaps](https://chaps.io)
+
+Gush is a parallel workflow runner using only Redis as its message broker and Sidekiq for workers.
+
+
+# New
+
+Options for config:
+* redis_prefix - Redis namespace
+* sidekiq_queue - queue name in Sidekiq
+
+
+ 
+## Theory
+
+Gush relies on directed acyclic graphs to store dependencies, see [Parallelizing Operations With Dependencies](https://msdn.microsoft.com/en-us/magazine/dd569760.aspx) by Stephen Toub.
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gush'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gush
+
+## Usage
+
+### Defining workflows
+
+The DSL for defining jobs consists of a single `run` method.
+Here is a complete example of a workflow you can create:
+
+```ruby
+# workflows/sample_workflow.rb
+class SampleWorkflow < Gush::Workflow
+  def configure(url_to_fetch_from)
+    run FetchJob1, params: { url: url_to_fetch_from }
+    run FetchJob2, params: {some_flag: true, url: 'http://url.com'}
+
+    run PersistJob1, after: FetchJob1
+    run PersistJob2, after: FetchJob2
+
+    run Normalize,
+        after: [PersistJob1, PersistJob2],
+        before: Index
+
+    run Index
+  end
+end
+```
+
+**Hint:** For debugging purposes you can vizualize the graph using `viz` command:
+
+```
+bundle exec gush viz SampleWorkflow
+```
+
+For the Workflow above, the graph will look like this:
+
+![SampleWorkflow](http://i.imgur.com/SmeRRVT.png)
+
+
+#### Passing parameters to jobs
+
+You can pass any primitive arguments into jobs while defining your workflow:
+
+```ruby
+# app/workflows/sample_workflow.rb
+class SampleWorkflow < Gush::Workflow
+  def configure
+    run FetchJob1, params: { url: "http://some.com/url" }
+  end
+end
+```
+
+See below to learn how to access those params inside your job.
+
+#### Defining jobs
+
+Jobs are classes inheriting from `Gush::Job`:
+
+```ruby
+# app/jobs/fetch_job.rb
+class FetchJob < Gush::Job
+  def work
+    # do some fetching from remote APIs
+
+    params #=> {url: "http://some.com/url"}
+  end
+end
+```
+
+`params` method is a hash containing your (optional) parameters passed to `run` method in the workflow.
+
+#### Passing arguments to workflows
+
+Workflows can accept any primitive arguments in their constructor, which then will be available in your
+`configure` method.
+
+Here's an example of a workflow responsible for publishing a book:
+
+```ruby
+# app/workflows/sample_workflow.rb
+class PublishBookWorkflow < Gush::Workflow
+  def configure(url, isbn)
+    run FetchBook, params: { url: url }
+    run PublishBook, params: { book_isbn: isbn }
+  end
+end
+```
+
+and then create your workflow with those arguments:
+
+```ruby
+PublishBookWorkflow.new("http://url.com/book.pdf", "978-0470081204")
+```
+
+
+### Running workflows
+
+Now that we have defined our workflow we can use it:
+
+#### 1. Initialize and save it
+
+```ruby
+flow = SampleWorkflow.new(optional, arguments)
+flow.save # saves workflow and its jobs to Redis
+```
+
+**or:** you can also use a shortcut:
+
+```ruby
+flow = SampleWorkflow.create(optional, arguments)
+```
+
+#### 2. Start workflow
+
+First you need to start Sidekiq workers:
+
+```
+bundle exec gush workers
+```
+
+and then start your workflow:
+
+```ruby
+flow.start!
+```
+
+Now Gush will start processing jobs in background using Sidekiq
+in the order defined in `configure` method inside Workflow.
+
+### Pipelining
+
+Gush offers a useful feature which lets you pass results of a job to its dependencies, so they can act accordingly.
+
+**Example:**
+
+Let's assume you have two jobs, `DownloadVideo`, `EncodeVideo`.
+The latter needs to know where the first one downloaded the file to be able to open it.
+
+
+```ruby
+class DownloadVideo < Gush::Job
+  def work
+    downloader = VideoDownloader.fetch("http://youtube.com/?v=someytvideo")
+
+    output(downloader.file_path)
+  end
+end
+```
+
+`output` method is Gush's way of saying: "I want to pass this down to my descendants".
+
+Now, since `DownloadVideo` finished and its dependant job `EncodeVideo` started, we can access that payload down the (pipe)line:
+
+```ruby
+class EncodeVideo < Gush::Job
+  def work
+    video_path = payloads["DownloadVideo"]
+  end
+end
+```
+
+`payloads` is a hash containing outputs from all parent jobs, where job class names are the keys.
+
+**Note:** `payloads` will only contain outputs of the job's ancestors. So if job `A` depends on `B` and `C`,
+the `payloads` hash will look like this:
+
+```ruby
+{
+  "B" => (...),
+  "C" => (...)
+}
+```
+
+
+### Checking status:
+
+#### In Ruby:
+
+```ruby
+flow.reload
+flow.status
+#=> :running|:finished|:failed
+```
+
+`reload` is needed to see the latest status, since workflows are updated asynchronously.
+
+#### Via CLI:
+
+- of a specific workflow:
+
+  ```
+  bundle exec gush show <workflow_id>
+  ```
+
+- of all created workflows:
+
+  ```
+  bundle exec gush list
+  ```
+
+
+### Requiring workflows inside your projects
+
+When using Gush and its CLI commands you need a Gushfile.rb in root directory.
+Gushfile should require all your Workflows and jobs, for example:
+
+```ruby
+require_relative './lib/your_project'
+
+Dir[Rails.root.join("app/workflows/**/*.rb")].each do |file|
+  require file
+end
+```
+
+## Contributors
+
+- [Mateusz Lenik](https://github.com/mlen)
+- [Michał Krzyżanowski](https://github.com/krzyzak)
+- [Maciej Nowak](https://github.com/keqi)
+- [Maciej Kołek](https://github.com/ferusinfo)
+
+## Contributing
+
+1. Fork it ( http://github.com/chaps-io/gush/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 new Pull Request

data/Rakefile

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

data/bin/gush

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require "pathname"
+require "bundler"
+Bundler.require
+
+bin_file = Pathname.new(__FILE__).realpath
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require 'gush'
+
+begin
+  Gush::CLI.start(ARGV)
+rescue Gush::WorkflowNotFound
+  puts "Workflow not found".red
+rescue Gush::DependencyLevelTooDeep
+  puts "Dependency level too deep. Perhaps you have a dependency cycle?".red
+end

data/gush.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "gush-mmx"
+  spec.version       = "0.4.2"
+  spec.authors       = ["Piotrek Okoński", "Max Ivak"]
+  spec.email         = ["piotrek@okonski.org", "maxivak@gmail.com"]
+  spec.summary       = "Fast and distributed workflow runner using only Sidekiq and Redis"
+  spec.description   = "Gush is a parallel workflow runner using only Redis as its message broker and Sidekiq for workers."
+  spec.homepage      = "https://github.com/pokonski/gush"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = "gush"
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", "~> 4.0"
+  spec.add_dependency "multi_json", "~> 1.11"
+  spec.add_dependency "redis", "~> 3.2"
+  spec.add_dependency "hiredis", "~> 0.6"
+  spec.add_dependency "ruby-graphviz", "~> 1.2"
+  spec.add_dependency "terminal-table", "~> 1.4"
+  spec.add_dependency "colorize", "~> 0.7"
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "launchy", "~> 2.4"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", '~> 3.0'
+  spec.add_development_dependency "pry", '~> 0.10'
+  spec.add_development_dependency 'fakeredis', '~> 0.5'
+end

data/lib/gush.rb

@@ -0,0 +1,61 @@
+require "bundler/setup"
+
+require "graphviz"
+require "hiredis"
+require "pathname"
+require "redis"
+require "securerandom"
+require "sidekiq"
+require "multi_json"
+
+require "gush/json"
+require "gush/cli"
+require "gush/cli/overview"
+require "gush/graph"
+require "gush/client"
+require "gush/configuration"
+require "gush/errors"
+require "gush/job"
+require "gush/worker"
+require "gush/workflow"
+
+module Gush
+  def self.gushfile
+    configuration.gushfile
+  end
+
+  def self.root
+    Pathname.new(__FILE__).parent.parent
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+    reconfigure_sidekiq
+  end
+
+  def self.reconfigure_sidekiq
+    #puts "^^^^^^^^ reconfigure_sidekiq ^^^"
+    Sidekiq.configure_server do |config|
+      #config.redis = { url: configuration.redis_url, queue: configuration.namespace}
+
+      opts = { url: configuration.redis_url, namespace: configuration.redis_prefix, queue: configuration.sidekiq_queue }
+      #puts "sidekiq server opts: #{opts}"
+      config.redis = { url: configuration.redis_url, namespace: configuration.redis_prefix, queue: configuration.sidekiq_queue }
+    end
+
+    Sidekiq.configure_client do |config|
+      #config.redis = { url: configuration.redis_url, queue: configuration.namespace}
+
+      opts = { url: configuration.redis_url, namespace: configuration.redis_prefix, queue: configuration.sidekiq_queue }
+      #puts "sidekiq client opts: #{opts}"
+
+      config.redis = { url: configuration.redis_url, namespace: configuration.redis_prefix, queue: configuration.sidekiq_queue }
+    end
+  end
+end
+
+#Gush.reconfigure_sidekiq