rplex 0.0.2

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+gem "sinatra","~>1.3.1"
+gem 'rest-client',"~>1.6.7"
+gem "hoe","~>2.12.4"
+gem "rack-test","~>0.6.1"
+gem 'rcov',"~>0.9.11"
+gem 'rdoc',"~>3.11"

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.0.2 / 2012-01-04
+* Added backlog delivering queue sizes
+=== 0.0.1 / 2011-12-11
+* Simple queue management and the bare minimum of the rest API: post a new job, get next job for worker
+* The corresponding client library for the API

data/Manifest.txt

@@ -0,0 +1,12 @@
+Gemfile
+History.txt
+lib/rplex.rb
+lib/rplex/client.rb
+lib/rplex/jobs.rb
+lib/rplex/server.rb
+Manifest.txt
+Rakefile
+README.txt
+test/test_jobs.rb
+test/test_server.rb
+test/test_rplex.rb

data/README.txt

@@ -0,0 +1,60 @@
+= rplex
+
+http://c11865-prj.zuehlke.com
+
+== DESCRIPTION:
+
+Simple asynchronous data based job management
+
+== INSTALL:
+
+* sudo gem install rplex
+
+=== Why?
+Because anything involving redis, postgres etc. is just a pain to install on Windows and we just wanted to parallelize a bunch of build tasks.
+
+=== How do you use it?
+In a CI system to reduce our build times by parallelizing test execution:
+
+The main build finishes and posts as data the revision and the location of the build artifacts to rplex. rplex queues the data for every worker that has appeared until that point.
+Each worker polls the rplex queue, and then uses the information to grab the build and run a bunch of tests.
+
+=== Is that all?
+Queues are created automatically when a worker tries to get data from the queue, data can be posted to a subset of the workers if necessary and that as they say is it.
+
+== Example
+Start the rplex service.
+
+Use Rplex::Client to post data:
+
+Rplex::Client.new("name","http://rplex.host:7777/job").new_job(job_id,data)
+
+Use Rplex::Processor to check the queue and do something with any data present
+
+Rplex::Processor.new(Rplex::Client.new("name","http://rplex.host:7777/job"),5).run!{|job_data| p job_data}
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011-2012 Vassilis Rizopoulos
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+$:.unshift File.join(File.dirname(__FILE__),"lib")
+require 'rubygems'
+require 'hoe'
+require 'rplex'
+
+Hoe.spec 'rplex' do |prj|
+  developer('Vassilis Rizopoulos', 'var@zuehlke.com')
+  prj.version=Rplex::Version::STRING
+  prj.summary = 'rplex multiplexes jobs across multiple workers'
+  prj.description = prj.paragraphs_of('README.txt', 1..4).join("\n\n")
+  prj.url = "http://github.com/damphyr/rplex"
+  prj.changes = prj.paragraphs_of('History.txt', 0..1).join("\n\n")
+  prj.extra_deps<<["sinatra", "~>1.3.1"]
+  prj.extra_deps<<['rest-client',"~>1.6.7"]
+end
+
+# vim: syntax=ruby

data/lib/rplex/client.rb

@@ -0,0 +1,68 @@
+require 'rest_client'
+require 'json'
+module Rplex
+  class ClientError<RuntimeError
+  end
+  
+  class Client
+    def initialize name,srv
+      @name=name
+      @service=srv
+    end
+    
+    def new_job identifier,data,workers=[]
+      puts "Adding #{identifier} to #{@service}"
+      response=RestClient.post(@service, {"identifier"=>identifier, "data" => data,"workers"=>workers}, :content_type => :json, :accept => :json)
+      return response
+    rescue
+      raise ClientError, $!.message
+    end
+    
+    def next_job
+      srv="#{@service}/#{@name}"
+      response=RestClient.get(srv,:accept => :json)
+      unless response.empty?
+        return JSON.parse(response)
+      else
+        return {}
+      end
+    rescue
+      raise ClientError, $!.message
+    end
+    
+    def backlog
+      response=RestClient.get(@service,:accept => :json)
+      unless response.empty?
+        return JSON.parse(response)
+      else
+        return []
+      end
+    rescue
+      raise ClientError, $!.message
+    end
+    
+    def to_s
+      "#{@name} working with #{@service}"
+    end
+  end
+  
+  class Processor
+    def initialize client,interval=30
+      @client=client
+      @interval=interval
+    end
+    
+    def run! 
+      raise "You need to provide a block" unless block_given?
+      while true do
+        begin
+          job_data=@client.next_job
+          yield job_data unless job_data.empty?
+        rescue ClientError
+          puts $!
+        end
+        sleep @interval
+      end
+    end
+  end
+end

data/lib/rplex/jobs.rb

@@ -0,0 +1,52 @@
+require 'thread'
+
+module Rplex
+  class InvalidData < RuntimeError
+  end
+  #Simple queue management for Rplex job data
+  class Overseer
+    def initialize
+      @queues={}
+    end
+    #Add a job for all workers currently active
+    def << job_data
+      add_job(job_data)
+    end
+    #Add a job.
+    #
+    #You can limit the workers it is distributed to by providing an Array 
+    #with the worker identifiers
+    def add_job job_data,workers=[]
+      queued_in=0
+      workers=@queues.keys if workers.empty?
+      if valid?(job_data)
+        @queues.each do |w,q|
+          if workers.include?(w)
+            q.push(job_data)
+            queued_in+=1  
+          end
+        end
+      else
+        raise InvalidData
+      end
+      return queued_in
+    end
+    #Get the next job for the worker
+    #
+    #If there is no Queue for the worker, create an empty one
+    def [](worker)
+      @queues[worker]||=Queue.new
+      @queues[worker].pop(true) rescue nil
+    end
+    #Get an array of [name,queue size]
+    def backlog
+      @queues.map{|k,v| [k,v.size]} 
+    end
+    #Returns true if the job data is valid
+    def valid? job_data
+      job_data["identifier"] && job_data["data"]
+    rescue
+      false
+    end
+  end
+end

data/lib/rplex/server.rb

@@ -0,0 +1,55 @@
+require 'sinatra/base'
+require 'rplex'
+require 'rplex/jobs'
+require 'json'
+module Rplex
+  
+  class Server<Sinatra::Base
+    def initialize
+      super
+      @overseer = Rplex::Overseer.new
+    end
+    post '/job' do
+      begin
+        reply={}
+        workers= params["workers"] ? params["workers"] : []
+        reply[:workers]=@overseer.add_job(params,workers)
+        [200,{'Content-Type' => 'application/json'},reply.to_json]
+      rescue
+        status 500
+      end
+    end
+    get '/job/:worker' do |worker|
+      reply={}
+      reply=@overseer[worker]
+      if reply
+        [200,{'Content-Type' => 'application/json'},reply.to_json]
+      else
+        status 204
+      end
+    end
+    get '/' do
+      [200,{'Content-Type' => 'application/json'},{"version"=>Rplex::Version::STRING}.to_json]
+    end
+    
+    get '/backlog' do  
+      [200,{'Content-Type' => 'application/json'},@overseer.backlog.to_json]
+    end
+    
+    def self.define_settings cfg={}
+      cfg||={}
+      #the settings that are not public
+      enable :logging
+      enable :run
+      enable :static
+      set :server, %w[thin mongrel webrick]
+      set :root, File.dirname(__FILE__)
+      #the settings that can be changed
+      cfg[:public_folder] ||= File.dirname(__FILE__) + '/public'
+      cfg[:port] ||= 7777
+      #set them
+      set :port, cfg[:port]
+      set :public_folder,cfg[:public_folder]
+    end
+  end
+end

data/lib/rplex.rb

@@ -0,0 +1,8 @@
+module Rplex
+  module Version
+    MAJOR = 0
+    MINOR = 0 
+    TINY = 2
+    STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
+  end
+end

data/test/test_jobs.rb

@@ -0,0 +1,37 @@
+$:.unshift File.join(File.dirname(__FILE__),"..","lib")
+require "test/unit"
+require "rplex/jobs"
+
+class TestOverseer < Test::Unit::TestCase
+  def test_invalid_data
+    ov=Rplex::Overseer.new
+    job_data={:foo=>"8888"}
+    assert_raise(Rplex::InvalidData) { ov << job_data }
+    job_data="foo"
+    assert_raise(Rplex::InvalidData) { ov << job_data }
+    assert_raise(Rplex::InvalidData) { ov << nil }
+  end
+  def test_basic
+    ov=Rplex::Overseer.new
+    job_data={"identifier"=>"8888","data"=>{:foo=>"bar",:bar=>"foo"}}
+    assert_nil(ov["worker"])
+    #expect that there is only 1 queue there
+    assert_equal(1, ov<<job_data)
+    assert_nil(ov["slave"])
+    assert_equal(2, ov<<job_data)
+    assert_equal(1, ov.add_job(job_data,["slave"]) )
+    #go through the slave queue
+    assert_equal(job_data,ov["slave"])
+    assert_equal(job_data,ov["slave"])
+    assert_nil(ov["slave"])
+  end
+  def test_backlog
+    ov=Rplex::Overseer.new
+    assert(ov.backlog.empty?)
+    job_data={"identifier"=>"8888","data"=>{:foo=>"bar",:bar=>"foo"}}
+    ov['worker1']
+    ov['worker2']
+    ov<<job_data
+    assert_equal([['worker1',1],['worker2',1]], ov.backlog)
+  end
+end

data/test/test_rplex.rb

@@ -0,0 +1,9 @@
+$:.unshift File.join(File.dirname(__FILE__),"..","lib")
+require "test/unit"
+require "rplex"
+
+class TestRplex < Test::Unit::TestCase
+  def test_version
+    assert_equal(Rplex::Version::STRING, "#{Rplex::Version::MAJOR}.#{Rplex::Version::MINOR}.#{Rplex::Version::TINY}")
+  end
+end

data/test/test_server.rb

@@ -0,0 +1,42 @@
+$:.unshift File.join(File.dirname(__FILE__),"..","lib")
+require 'test/unit'
+require 'rubygems'
+require 'rplex/server'
+require 'rack/test'
+require 'json'
+
+class ServerTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Rplex::Server
+  end
+  
+  def test_root
+    get '/'
+    assert_equal({"version"=>Rplex::Version::STRING},JSON.parse(last_response.body))
+  end
+  
+  def test_new
+    post '/job', :identifier=>"8888",:data=>{:url=>"http://foo.bar/drops",:revision=>"8888"}
+    assert_not_nil(JSON.parse(last_response.body)["workers"])
+    
+    post '/job', :foo=>"bar"
+    assert_equal(500, last_response.status)
+  end
+  
+  def test_job
+    get '/job/worker'
+    assert_equal(204,last_response.status)
+    payload={"identifier"=>"8888","data"=>{"url"=>"http://foo.bar/drops","revision"=>"8888"}}
+    post '/job', payload
+    get '/job/worker'
+    assert_equal(200,last_response.status)
+    assert_equal(payload,JSON.parse(last_response.body))
+  end
+  
+  def test_backlog
+    get '/backlog'
+    assert_equal(200, last_response.status)
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification 
+name: rplex
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Vassilis Rizopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 6
+        - 7
+        version: 1.6.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  type: :development
+  version_requirements: *id004
+description: |-
+  http://c11865-prj.zuehlke.com
+  
+  == DESCRIPTION:
+  
+  Simple asynchronous data based job management
+  
+  == INSTALL:
+email: 
+- var@zuehlke.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- Gemfile
+- History.txt
+- lib/rplex.rb
+- lib/rplex/client.rb
+- lib/rplex/jobs.rb
+- lib/rplex/server.rb
+- Manifest.txt
+- Rakefile
+- README.txt
+- test/test_jobs.rb
+- test/test_server.rb
+- test/test_rplex.rb
+- .gemtest
+homepage: http://github.com/damphyr/rplex
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rplex
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: rplex multiplexes jobs across multiple workers
+test_files: 
+- test/test_jobs.rb
+- test/test_rplex.rb
+- test/test_server.rb