job_dispatch 0.0.1

data/spec/job_dispatch/identity_spec.rb

@@ -0,0 +1,88 @@
+require 'rspec'
+require 'spec_helper'
+
+describe JobDispatch::Identity do
+
+  context "with a string" do
+
+    subject { JobDispatch::Identity.new('hello')}
+
+    it "returns a string" do
+      expect(subject.to_s).to eq('hello')
+    end
+    it "returns a symbol" do
+      expect(subject.to_sym).to eq(:hello)
+    end
+    it "returns hex string" do
+      expect(subject.to_hex).to eq('68656c6c6f')
+    end
+  end
+
+  context "with a symbol" do
+
+    subject { JobDispatch::Identity.new(:hello)}
+
+    it "returns a string" do
+      expect(subject.to_s).to eq('hello')
+    end
+    it "returns a symbol" do
+      expect(subject.to_sym).to eq(:hello)
+    end
+    it "returns hex string" do
+      expect(subject.to_hex).to eq('68656c6c6f')
+    end
+  end
+
+
+  context "with no-printable characters" do
+    let(:worker_id) { [0, 0x80, 0, 0x41, 0xB9].pack('c*') }
+    subject { JobDispatch::Identity.new(worker_id)}
+
+    it "returns a string" do
+      expect(subject.to_s).to eq(worker_id)
+    end
+    it "returns a symbol" do
+      expect(subject.to_sym).to eq(worker_id.to_sym)
+    end
+    it "returns hex string" do
+      expect(subject.to_hex).to eq('00800041b9')
+    end
+  end
+
+  context "testing equality" do
+
+    context "with same identity" do
+      before :each do
+        @a = JobDispatch::Identity.new('a')
+        @b = JobDispatch::Identity.new('a')
+      end
+
+      it "is equal to another with the same identity" do
+        expect(@a == @b).to be_true
+      end
+
+      it "can look up an item from a hash" do
+        hash = {}
+        hash[@a] = 'hello'
+        expect(hash[@b]).to eq('hello')
+      end
+    end
+
+    context "with different identity" do
+      before :each do
+        @a = JobDispatch::Identity.new('a')
+        @b = JobDispatch::Identity.new('b')
+      end
+
+      it "is not equal to another with the same identity" do
+        expect(@a == @b).to be_false
+      end
+
+      it "can look up an item from a hash" do
+        hash = {}
+        hash[@a] = 'hello'
+        expect(hash[@b]).to be_nil
+      end
+    end
+  end
+end

data/spec/job_dispatch/job_spec.rb

@@ -0,0 +1,77 @@
+require 'rspec'
+require 'spec_helper'
+
+describe JobDispatch::Job do
+
+  context "succeeded" do
+    subject { TestJob.new(1, 'default', JobDispatch::Job::PENDING) }
+    before(:each) { subject.succeeded!('result') }
+    it "sets the status to COMPLETED" do
+      expect(subject.status).to eq(JobDispatch::Job::COMPLETED)
+    end
+
+    it "sets the result" do
+      expect(subject.result).to eq('result')
+    end
+    it "sets completed at" do
+      expect(subject.completed_at).to be_within(1.second).of(Time.now)
+    end
+  end
+
+  context "failed" do
+    subject { TestJob.new(1, 'default', JobDispatch::Job::PENDING) }
+    before(:each) { subject.failed!('error message') }
+    it "sets the status to FAILED" do
+      expect(subject.status).to eq(JobDispatch::Job::FAILED)
+    end
+
+    it "sets the result" do
+      expect(subject.result).to eq('error message')
+    end
+
+    it "sets completed at" do
+      expect(subject.completed_at).to be_within(1.second).of(Time.now)
+    end
+
+    context "and retryable" do
+      before(:each) do
+        subject.retry_count = 1
+        subject.retry_delay = 10
+        subject.failed!('error message')
+      end
+      it "sets the status to PENDING" do
+        expect(subject.status).to eq(JobDispatch::Job::PENDING)
+      end
+      it "sets completed at" do
+        expect(subject.completed_at).to be_within(1.second).of(Time.now)
+      end
+      it "sets the result" do
+        expect(subject.result).to eq('error message')
+      end
+      it "decrements retry_count" do
+        expect(subject.retry_count).to eq(0)
+      end
+      it "doubles the retry_delay" do
+        expect(subject.retry_delay).to eq(20)
+      end
+    end
+
+    context "and out of retries" do
+      before(:each) do
+        subject.retry_count = 0
+        subject.retry_delay = 20
+        subject.failed!('error message')
+      end
+      it "sets the status to PENDING" do
+        expect(subject.status).to eq(JobDispatch::Job::FAILED)
+      end
+      it "sets completed at" do
+        expect(subject.completed_at).to be_within(1.second).of(Time.now)
+      end
+      it "sets the result" do
+        expect(subject.result).to eq('error message')
+      end
+    end
+  end
+
+end

data/spec/job_dispatch/worker/socket_spec.rb

@@ -0,0 +1,32 @@
+require 'rspec'
+require 'spec_helper'
+
+describe JobDispatch::Worker::Socket do
+
+  let(:endpoint) { 'ipc://test' }
+  let(:item_class) do
+    double('ItemClass')
+  end
+  subject { JobDispatch::Worker::Socket.new(endpoint, item_class) }
+
+  context "receiving a message" do
+    before :each do
+      @item = double('Item')
+      @item.stub(:job_id=)
+      item_class.stub(:new).and_return(@item)
+    end
+
+    it "creates an item of the right class" do
+      item_class.should_receive(:new)
+      subject.socket.stub(:recv).and_return(JSON.dump({command:'idle'}))
+      expect(subject.read_item).to eq(@item)
+    end
+
+    it "quits when a quit message is received" do
+      Process.stub(:exit).and_return(nil)
+      Process.should_receive(:exit).with(0)
+      subject.socket.stub(:recv).and_return(JSON.dump({command:'quit'}))
+      subject.read_item
+    end
+  end
+end

data/spec/job_dispatch/worker_spec.rb

@@ -0,0 +1,24 @@
+require 'rspec'
+require 'spec_helper'
+
+describe JobDispatch::Worker do
+
+  Item ||= JobDispatch::Worker::Item
+  Socket ||= JobDispatch::Worker::Socket
+
+  context "with custom item class" do
+    before :each do
+      @klass = double('ItemClass')
+      @worker = JobDispatch::Worker.new('ipc://test', item_class: @klass)
+    end
+    it "initialises the custom item class" do
+      expect(@worker.item_class).to eq(@klass)
+    end
+
+    it "sets the custom class on the socket" do
+      @worker.connect
+      expect(@worker.socket.item_class).to eq(@klass)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'simplecov'
+SimpleCov.start 'rails'
+
+require 'job_dispatch'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["spec/support/**/*.rb"].each { |f| load f }
+
+require 'factory_girl'
+Dir["spec/factories/**/*.rb"].each { |f| load f }
+
+require 'timecop'
+
+
+RSpec.configure do |config|
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  #config.order = "random"
+end

data/spec/support/test_job.rb

@@ -0,0 +1,30 @@
+# This class is a stand in for an ActiveRecord or Mongoid::Document style class
+TestJob = Struct.new :id,
+                     :queue,
+                     :status,
+                     :enqueued_at,
+                     :expire_execution_at,
+                     :scheduled_at,
+                     :completed_at,
+                     :result,
+                     :target,
+                     :method,
+                     :parameters,
+                     :retry_count,
+                     :retry_delay,
+                     :timeout do
+  include JobDispatch::Job
+
+  def save!
+    true
+  end
+
+  def save
+    true
+  end
+
+  def reload
+    self
+  end
+
+end

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: job_dispatch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Connolly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbczmq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: nullobject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: text-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !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'
+description: Job Dispatch to workers via ZeroMQ
+email:
+- matt@mobiledataanywhere.com
+executables:
+- job-dispatcher
+- job-status
+- job-worker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/job-dispatcher
+- bin/job-status
+- bin/job-worker
+- examples/mongoid-job.rb
+- job_dispatch.gemspec
+- lib/job_dispatch.rb
+- lib/job_dispatch/broker.rb
+- lib/job_dispatch/broker/command.rb
+- lib/job_dispatch/broker/internal_job.rb
+- lib/job_dispatch/broker/socket.rb
+- lib/job_dispatch/client.rb
+- lib/job_dispatch/client/proxy.rb
+- lib/job_dispatch/client/proxy_error.rb
+- lib/job_dispatch/client/synchronous_proxy.rb
+- lib/job_dispatch/configuration.rb
+- lib/job_dispatch/identity.rb
+- lib/job_dispatch/job.rb
+- lib/job_dispatch/signaller.rb
+- lib/job_dispatch/sockets/enqueue.rb
+- lib/job_dispatch/status.rb
+- lib/job_dispatch/version.rb
+- lib/job_dispatch/worker.rb
+- lib/job_dispatch/worker/item.rb
+- lib/job_dispatch/worker/socket.rb
+- spec/factories/jobs.rb
+- spec/job_dispatch/broker/socket_spec.rb
+- spec/job_dispatch/broker_spec.rb
+- spec/job_dispatch/identity_spec.rb
+- spec/job_dispatch/job_spec.rb
+- spec/job_dispatch/worker/socket_spec.rb
+- spec/job_dispatch/worker_spec.rb
+- spec/job_dispatch_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_job.rb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Job Dispatch is a gem for dispatching jobs to workers in an asynchronous
+  manner. Job Dispatch does not require any specific database. Jobs are dispatched
+  using ZeroMQ messages and workers can be implemented in any language.
+test_files:
+- spec/factories/jobs.rb
+- spec/job_dispatch/broker/socket_spec.rb
+- spec/job_dispatch/broker_spec.rb
+- spec/job_dispatch/identity_spec.rb
+- spec/job_dispatch/job_spec.rb
+- spec/job_dispatch/worker/socket_spec.rb
+- spec/job_dispatch/worker_spec.rb
+- spec/job_dispatch_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_job.rb