workiq 1.0.0

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 workiq.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Moustafa Badawy <moustafa@rubikal.com>
+
+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,44 @@
+# Workiq
+
+Workiq adds a [Sidekiq](http://github.com/mperham/sidekiq) middleware to track a job worker status. Available status values are `:queued`, `:working`, `:complete`, and `:failed`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'workiq'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workiq
+
+## Usage
+  * Define your Sidekiq workers as normal. Check the [Sidekiq home page](http://mperham.github.com/sidekiq/) for details.
+  * Call the worker perform method
+
+``` ruby
+job_id = JobWorker.perform_async(*args)
+```
+
+OR
+
+``` ruby
+job_id = Model.delay.do_some_stuff(*args)
+```
+  * Poll job status (`:queued`, `:working`, `:complete`, and `:failed`)
+
+``` ruby
+status = Workiq.status(job_id)
+```
+
+## 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/workiq.rb

@@ -0,0 +1,11 @@
+require "workiq/version"
+require "workiq/storage"
+require "workiq/middleware/client"
+require "workiq/middleware/server"
+require "workiq/middleware/chain"
+
+module Workiq
+  def self.status(jid)
+    Workiq::Storage.read_field(jid, :status).to_sym
+  end
+end

data/lib/workiq/middleware/chain.rb

@@ -0,0 +1,11 @@
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Workiq::Middleware::Client
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Workiq::Middleware::Server
+  end
+end

data/lib/workiq/middleware/client.rb

@@ -0,0 +1,11 @@
+module Workiq
+  module Middleware
+    class Client
+      def call(worker_class, msg, queue)
+        jid = msg['jid']
+        Workiq::Storage.store_field(jid, :status => :queued)
+        yield
+      end
+    end
+  end
+end

data/lib/workiq/middleware/server.rb

@@ -0,0 +1,15 @@
+module Workiq
+  module Middleware
+    class Server
+      def call(worker, msg, queue)
+        jid = msg['jid']
+        Workiq::Storage.store_field jid, :status => :working
+        yield
+        Workiq::Storage.store_field jid, :status => :complete
+      rescue
+        Workiq::Storage.store_field jid, :status => :failed
+        raise
+      end
+    end
+  end
+end

data/lib/workiq/storage.rb

@@ -0,0 +1,23 @@
+module Workiq
+  DEFAULT_EXPIRY = 60 * 30
+  class Storage
+    class << self
+      def store_field(jid, field)
+        Sidekiq.redis do |conn|
+          result = conn.multi do
+            conn.hmset jid, *(field.to_a.flatten)
+            conn.expire jid, Workiq::DEFAULT_EXPIRY
+            conn.publish "#{jid}-field-update", jid
+          end
+          result[0]
+        end
+      end
+
+      def read_field(jid, field)
+        Sidekiq.redis do |conn|
+          conn.hmget(jid, field)[0]
+        end
+      end
+    end
+  end
+end

data/lib/workiq/version.rb

@@ -0,0 +1,3 @@
+module Workiq
+  VERSION = "1.0.0"
+end

data/workiq.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workiq/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "workiq"
+  gem.version       = Workiq::VERSION
+  gem.authors       = ["Moustafa Badawy"]
+  gem.email         = ["moustafa@rubikal.com"]
+  gem.description   = %q{Workiq adds Sidekiq middlewares to track a job worker status. Status values are :queued, :working, :complete, and :failed}
+  gem.summary       = %q{Track Sidekiq job worker status}
+  gem.homepage      = ""
+
+  gem.add_dependency 'sidekiq', '~>2.5.0'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: workiq
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Moustafa Badawy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+description: Workiq adds Sidekiq middlewares to track a job worker status. Status
+  values are :queued, :working, :complete, and :failed
+email:
+- moustafa@rubikal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/workiq.rb
+- lib/workiq/middleware/chain.rb
+- lib/workiq/middleware/client.rb
+- lib/workiq/middleware/server.rb
+- lib/workiq/storage.rb
+- lib/workiq/version.rb
+- workiq.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Track Sidekiq job worker status
+test_files: []