karousel 0.9.8

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p194@karousel --create

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+branches:
+  only:
+      - master

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'jeweler'
+
+group :test, :development do
+  gem 'cucumber'
+  gem 'rspec'
+  gem 'debugger'
+end
+
+

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.1.3)
+    columnize (0.3.6)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    debugger (1.2.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.3)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.3)
+    diff-lcs (1.1.3)
+    gherkin (2.11.2)
+      json (>= 1.4.6)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber
+  debugger
+  jeweler
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Marine Biological Laboratory
+
+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.rdoc

@@ -0,0 +1,79 @@
+= Karousel
+
+{<img src="https://secure.travis-ci.org/GlobalNamesArchitecture/karousel.png" />}[http://travis-ci.org/GlobalNamesArchitecture/karousel] {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/GlobalNamesArchitecture/karousel]
+
+Karousel is an intelligent, client-side job dispenser that accesses a parallelized service without overloading its queue. It dishes out jobs onto a defined number of 'seats' on the 'karousel', tosses out completed jobs, and refills empty 'seats' with new jobs. As a result, the queue on the parallelized service remains lean and clients make responsible use of the service.
+
+== Principle of operation
+
+The gem works on a carousel principle. Jobs are loaded onto a carousel-like object. The size of the 'karousel' (i.e. its 'seats') determines how many objects are active at any given time. For example, if the size of the 'karousel' is 20, only 20 objects at a time will access the service.
+
+Karousel loads all jobs, initiates its rotation, and sends each job in succession to a service. For each new job, 'karousel' waits for an 'OK' from the service, captures the status of the job and optionally stores the response from the service. Starting with the oldest submitted job, 'karousel' checks to see if the job is finished. If it is finished, it is processed, removed from the 'karousel', and the seat is freed for a new job. After a rotation of the 'karousel' empty seats are filled with new jobs and the 'karousel' continues to rotate.
+
+== Installation
+
+    gem install karousel
+
+== Usage
+
+Given a Karousel-compatible job class (e.g. KarouselJob) the usage is:
+
+    require 'karousel'
+    karousel = Karousel.new(KarouselJob, 20, 5)
+    karousel.run
+
+where KarouselJob is the name of your job class, 20 is number of 'seats' on your 'karousel', and 5 is the time interval in seconds between complete rotations of the 'karousel'.
+
+You can optionally supply a block to the 'run' method to perform your own logging, collect data, or other uses. For example:
+
+    count = 0
+    karousel.run { puts count += 1 }
+
+or
+
+    result = []
+    karousel.run { result << karousel.cycle_data }
+
+== How to write a Job Class
+
+A Job class requires the following signature:
+
+    class MyJob < Karousel::ClientJob
+
+      def self.populate(number_of_seats)
+        ... #returns an array of the karousel size (number_of_seats would be 20 in our example)
+      end
+
+      def send
+        ... #sends the job to the service, returns true if it receives an expected response, false otherwise
+      end
+
+      def finished?
+        ... #returns true if job is done, false otherwise
+      end
+
+      def process
+        ... #processes the finished job
+      end
+
+    end
+
+You can also check out https://github.com/GlobalNamesArchitecture/karousel/blob/master/spec/support/client_job_dummy.rb file or https://github.com/GlobalNamesArchitecture/karousel_example
+
+== Contributing to karousel
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't yet been fixed.
+* Check out the issue tracker to make sure someone hasn't already submitted a similar request and/or a solution.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure you add tests. This is important so I don't unintentionally break Karousel in the future.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, that's fine, but please isolate to its commit so I can cherry-pick around it.
+
+== Copyright
+
+Authors: Dmitry Mozzherin, David Shorthouse
+
+Copyright (c) 2012 Marine Biological Laboratory. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "karousel"
+  gem.homepage = "http://github.com/dimus/karousel"
+  gem.license = "MIT"
+  gem.summary = %Q{Job dispenser for parallel workers}
+  gem.description = %Q{Use it if you have waaay to many items in your workers' queue}
+  gem.email = "dmozzherin@gmail.com"
+  gem.authors = ["Dmitry Mozzherin", "David Shorthouse"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "karousel #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.8

data/features/karousel.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'karousel'
+
+require 'rspec/expectations'

data/lib/karousel.rb

@@ -0,0 +1,58 @@
+Dir[File.join(File.dirname(__FILE__), "karousel", "*.rb")].each {|f| require f}
+
+
+class Karousel
+  attr_reader :size, :seats, :time_interval, :cycle_data
+
+  def initialize(klass, size=10, time_interval = 0)
+    @klass = klass
+    @size = size
+    @time_interval = time_interval
+    @seats = []
+    @cycle_data = []
+  end
+
+  def populate
+    new_seats = []
+    @klass.populate(@size - @seats.size).each do |inst|
+      new_seats << Job.new(inst)
+    end
+    @seats = new_seats + @seats
+  end
+
+  def run(&block)
+    populate
+    until @seats.empty? do
+      send_request
+      sleep(@time_interval)
+      check_response
+      yield if block
+      populate
+    end
+  end
+
+  private
+
+  def send_request
+    @cursor = 0
+    @seats.each_with_index do |job, index|
+      if job.status == :sent
+        @cursor = index
+        break
+      end
+      job.send
+    end
+  end
+
+  def check_response
+    @cycle_data = []
+    @seats = @seats[@cursor..-1] + @seats[0...@cursor] if @cursor != 0
+    @seats.size.times do
+      job = @seats.shift
+      @cycle_data << job
+      (job.status != :failure && job.finished? && job.status == :success) ? job.process : @seats.push(job)
+    end
+    @cursor = 0
+  end
+
+end

data/lib/karousel/client_job.rb

@@ -0,0 +1,32 @@
+class Karousel
+  class ClientJob
+    attr_accessor :status
+
+    def initialize
+      @status = 1
+    end
+
+    def self.populate
+      not_implemented_error
+    end
+
+    def send
+      not_implemented_error
+    end
+
+    def finished?
+      not_implemented_error
+    end
+
+    def process
+      not_implemented_error
+    end
+
+    private
+
+    def not_implemented_error
+      raise Karousel::NotImplementedError
+    end
+
+  end
+end

data/lib/karousel/job.rb

@@ -0,0 +1,43 @@
+class Karousel
+  class Job
+    STATUS = { 1 => :init, 2 => :sent, 3 => :success, 4 => :failure }
+    attr_reader :client_job
+
+    def initialize(client_job)
+      raise TypeError.new("Unknown client job type") unless client_job.is_a?(Karousel::ClientJob)
+      @client_job = client_job
+      @invert_status = STATUS.invert
+    end
+
+    def status
+      @status = STATUS[@client_job.status]
+      raise TypeError.new("status must be an integer between 1 and 4") unless @status
+      @status
+    end
+
+    def status= (new_status)
+      new_status = @invert_status[new_status]
+      raise TypeError.new("Unknown status") unless new_status
+      @client_job.status = new_status
+    end
+
+    def send
+      is_ok = @client_job.send
+      self.status = is_ok ? :sent : :failure 
+      is_ok
+    end
+
+    def finished?
+      is_ok = @client_job.finished?
+      self.status = is_ok ? :success : :failure
+      is_ok
+    end
+
+    def process
+      is_ok = @client_job.process
+      self.status = is_ok ? :success : :failure
+      is_ok
+    end
+
+  end
+end

data/spec/job_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Karousel::Job do
+
+  it "should instantiate" do 
+    j = Karousel::Job.new(ClientJobDummy.new)
+    j.class.should == Karousel::Job
+    j.client_job.class.should == ClientJobDummy
+  end
+
+end
+

data/spec/karousel_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Karousel" do
+  before(:all) do
+    @karousel = Karousel.new(ClientJobDummy, 20, 0)
+  end
+
+  before(:each) do
+    ClientJobDummy.reset
+  end
+  
+  it "should initiate" do
+    k = Karousel.new(ClientJobDummy, 20, 0)
+    k.class.should == Karousel
+  end
+
+  it "should have size" do
+    @karousel.size.should == 20
+    @karousel.seats.size.should == 0
+    @karousel.time_interval.should == 0
+  end
+  
+  it "should run with block" do
+    karousel = Karousel.new(ClientJobDummy, 20, 0)
+    karousel.run do
+      karousel.cycle_data.size.should > 0
+      statuses = karousel.cycle_data.map {|c| c.status}
+      statuses.uniq!
+      [:failure, :success].should == statuses.sort! if statuses.size > 1
+    end
+  end
+
+  it "should be able to get loaded with jobs" do 
+    @karousel.seats.size.should == 0 
+    @karousel.populate
+    @karousel.seats.size.should == 20
+    @karousel.seats[0].class == Karousel::Job
+    @karousel.seats[0].status.should == :init
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'karousel'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/client_job_dummy.rb

@@ -0,0 +1,34 @@
+require_relative './dummy_server'
+
+class ClientJobDummy < Karousel::ClientJob
+  @@dummy_data = 0 
+  
+  def self.reset
+    @@dummy_data = 0
+  end
+
+  def self.reset_failures
+  end
+
+  def self.populate(karousel_size)
+    @@dummy_data += karousel_size
+    return [] if @@dummy_data > 100
+    karousel_size.times.map { self.new }
+  end
+
+  def send
+    @server = DummyServer.new
+    @server.first_request
+    rand(0..10) > 9 ? false : true
+  end
+
+  def finished?
+    @server.following_request
+    rand(0..10) > 8 ? false : true
+  end
+
+  def process
+  end
+
+end
+

data/spec/support/dummy_server.rb

@@ -0,0 +1,13 @@
+class DummyServer
+
+  def first_request
+    @wait_num = rand(1..10)
+    @tries_num = 0
+  end
+
+  def following_request
+    @tries_num += 1
+    @tries_num == @wait_num ? true : false
+  end
+
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: karousel
+version: !ruby/object:Gem::Version
+  version: 0.9.8
+  prerelease: 
+platform: ruby
+authors:
+- Dmitry Mozzherin
+- David Shorthouse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use it if you have waaay to many items in your workers' queue
+email: dmozzherin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- features/karousel.feature
+- features/step_definitions/karousel_steps.rb
+- features/support/env.rb
+- lib/karousel.rb
+- lib/karousel/client_job.rb
+- lib/karousel/job.rb
+- spec/job_spec.rb
+- spec/karousel_spec.rb
+- spec/spec_helper.rb
+- spec/support/client_job_dummy.rb
+- spec/support/dummy_server.rb
+homepage: http://github.com/dimus/karousel
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -572150406200940966
+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: Job dispenser for parallel workers
+test_files: []