cloudist 0.0.2

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem "amqp"
+gem "json"
+gem "activesupport"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "moqueue", :git => "git://github.com/customink/moqueue.git"
+  gem "mocha"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "reek", "~> 1.2.8"
+  gem "roodi", "~> 2.1.0"
+end

data/Gemfile.lock

@@ -0,0 +1,61 @@
+GIT
+  remote: git://github.com/customink/moqueue.git
+  revision: 091a8f57e5c79b0b25e152b4d5230e4031797d62
+  specs:
+    moqueue (0.1.4)
+      amqp
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    amqp (0.6.7)
+      eventmachine (>= 0.12.4)
+    diff-lcs (1.1.2)
+    eventmachine (0.12.10)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    mocha (0.9.10)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.5)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  amqp
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  json
+  mocha
+  moqueue!
+  rcov
+  reek (~> 1.2.8)
+  roodi (~> 2.1.0)
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ivan Vanderbyl
+
+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,113 @@
+Cloudist
+========
+
+Cloudist is a super fast job queue for high demand and scalable tasks. It uses AMQP (RabbitMQ mainly) for message store are
+distribution, while providing a simple DSL for handling jobs and responses.
+
+Cloudist can be used within Rails or just about any Ruby app to distribute long running tasks, such as encoding a video, generating PDFs, scraping site data
+or even just sending emails. Unlike other job queues (DelayedJob etc) Cloudist does not load your entire Rails stack into memory for every worker, and it is not designed to, instead it
+expects all the data your worker requires to be sent in the initial job request. This means your workers stay slim and can scale very quickly and even run on EC2 micros outside your applications
+network without any further configuration.
+
+Another way Cloudist differs from other AMQP based job queues like Minion is it allows workers to report events, logs, system stats and replies back to the application which distributed the
+job, and unlike database based job queues, there is almost no delay between messages, except network latency of course.
+
+Installation
+------------
+
+    gem install cloudist
+
+Or if your app has a Gemfile:
+    
+    gem 'cloudist'
+
+Usage
+-----
+
+Cloudist requires an EventMachine reactor loop and an AMQP connection, so if your application is already using one, or your web server supplies one (for example Thin) these examples will work
+out of the box. Otherwise simply wrap everything inside this block:
+    
+    Cloudist.settings = {:user => 'guest'} # Standard AMQP settings
+    Cloudist.start {
+      # usual stuff here
+      worker {
+        # define a worker
+      }
+    }
+    
+This will start and AMQP connection and EM loop then yield everything inside it.
+
+In your worker:
+
+    Cloudist.worker {
+      job('make.sandwich') {
+        # Make sandwich here
+        
+        # Your worker has access to the data sent from the server in the 'data' attribute
+        data # => {:bread => "white", :sauce => 'bbq'}
+        
+        # Fire the finished event
+        finished!
+      }
+    }
+    
+In your application:
+
+    job = Cloudist.enqueue('make.sandwich', :bread => "white", :sauce => 'bbq')
+    
+    Cloudist.listen(job) {
+      event('finished') {
+        # Called when we finish making a sandwich
+      }
+    }
+    
+You don't need to listen to responses immediately, if you store the job_id you can listen to responses at any time in the near future.
+
+You can also queue jobs outside an EventMachine loop using Cloudist.enqueue but this will be very slow as it has to connect to your message queue first.
+
+Acknowledgements
+-------
+
+Portions of this gem are based on code from the following projects:
+
+- Heroku's Droid gem
+- Lizzy
+- Minion
+- Nanite
+- Smith
+
+Contributing to Cloudist
+------------------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch e.g. git checkout -b feature-my-awesome-idea or bugfix-this-does-not-work
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+    
+Copyright
+---------
+
+Copyright (c) 2011 Ivan Vanderbyl. 
+
+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,63 @@
+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 = "cloudist"
+  gem.homepage = "http://github.com/ivanvanderbyl/cloudist"
+  gem.license = "MIT"
+  gem.summary = %Q{Super fast job queue using AMQP}
+  gem.description = %Q{Cloudist is a simple, highly scalable job queue for Ruby applications, it can run within Rails, or on EC2, and does not load your entire Rails stack like delayed job does.}
+  gem.email = "ivanvanderbyl@me.com"
+  gem.authors = ["Ivan Vanderbyl"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+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 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cloudist #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/examples/queue_message.rb

@@ -0,0 +1,19 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require "rubygems"
+require "cloudist"
+
+ENV["AMQP_URL"] = 'amqp://test_pilot:t35t_p1l0t!@ec2-50-16-134-211.compute-1.amazonaws.com:5672/'
+
+::Signal.trap('INT') { Cloudist.stop }
+::Signal.trap('TERM'){ Cloudist.stop }
+
+Cloudist.start {
+  
+  payload = Cloudist::Payload.new({:event => "started"})
+  
+  q = Cloudist::ReplyQueue.new('temp.reply.make.sandwich')
+  q.setup
+  q.publish_to_q(payload)
+  
+  stop
+}

data/examples/sandwich_client.rb

@@ -0,0 +1,17 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require "rubygems"
+require "cloudist"
+
+Cloudist.signal_trap!
+
+Cloudist.start {
+  
+  log.info("Dispatching sandwich making job...")
+  enqueue('make.sandwich', {:bread => 'white'})
+  
+  # Listen to all sandwich jobs
+  listen('make.sandwich') {
+    Cloudist.log.info("Make sandwich event: #{id}")
+  }
+  
+}

data/examples/sandwich_worker.rb

@@ -0,0 +1,21 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require "rubygems"
+require "cloudist"
+
+Cloudist.signal_trap!
+
+Cloudist.start {
+  log.info("Started Worker")
+  
+  worker {
+    job('make.sandwich') {
+      # Fire the started event
+      started!
+      
+      log.info("JOB (#{id}) Make sandwich with #{data[:bread]} bread")
+      log.debug(data.inspect)
+      
+      finished!
+    }    
+  }
+}

data/lib/cloudist.rb

@@ -0,0 +1,141 @@
+require 'uri'
+require 'json'
+require "active_support/hash_with_indifferent_access"
+require "amqp"
+require "mq"
+require "logger"
+require "digest/md5"
+
+$:.unshift File.dirname(__FILE__)
+require "cloudist/core_ext/string"
+require "cloudist/errors"
+require "cloudist/utils"
+require "cloudist/basic_queue"
+require "cloudist/job_queue"
+require "cloudist/reply_queue"
+require "cloudist/publisher"
+require "cloudist/payload"
+require "cloudist/request"
+require "cloudist/worker"
+require "cloudist/listener"
+require "cloudist/job"
+
+module Cloudist
+  class << self
+    # Start the Cloudist loop
+    # 
+    #   Cloudist.start {
+    #     # Do stuff in here
+    #   }
+    # 
+    # == Options
+    # * :user => 'name'
+    # * :pass => 'secret'
+    # * :host => 'localhost'
+    # * :port => 5672
+    # * :vhost => /
+    # 
+    # Refer to default config below for how to set these as defaults
+    # 
+    def start(options = {}, &block)
+      config = settings.update(options)
+      AMQP.start(config) do
+        self.instance_eval(&block)
+      end
+    end
+
+    # Define a worker. Must be called inside start loop
+    # 
+    # worker {
+    #   job('make.sandwich') {}
+    # }
+    # 
+    # Refer to examples.
+    def worker(options = {}, &block)
+      _worker = Cloudist::Worker.new(options)
+      _worker.instance_eval(&block)
+      return _worker
+    end
+    
+    # Accepts either a queue name or a job instance returned from enqueue.
+    # This method operates in two modes, when given a queue name, it
+    # will return all responses regardless of job id so you can use the job
+    # id to lookup a database record to update etc.
+    # When given a job instance it will only return messages from that job.
+    def listen(job_or_queue_name, &block)
+      _listener = Cloudist::Listener.new(job_or_queue_name)
+      _listener.subscribe(&block)
+      return _listener
+    end
+    
+    # Enqueues a job.
+    # Takes a queue name and data hash to be sent to the worker.
+    # Returns Job instance
+    # Use Job#id to reference job later on.
+    def enqueue(job_queue_name, data = nil)
+      raise EnqueueError, "Incorrect arguments, you must include data when enquing job" if data.nil?
+      # TODO: Detect if inside loop, if not use bunny sync
+      Cloudist::Publisher.enqueue(job_queue_name, data)
+    end
+
+    # Call this at anytime inside the loop to exit the app.
+    def stop_safely
+      ::EM.add_timer(0.2) { 
+        ::AMQP.stop { 
+          ::EM.stop
+        }
+      }
+    end
+    
+    alias :stop :stop_safely
+
+    def closing?
+      ::AMQP.closing?
+    end
+
+    def log
+      @@log ||= Logger.new($stdout)
+    end
+    
+    def log=(log)
+      @@log = log
+    end
+    
+    def handle_error(e)
+      log.error "#{e.class}: #{e.message}"#, :exception => e
+      log.error e.backtrace.join("\n")
+    end
+    
+    def version
+      @@version ||= File.read(File.dirname(__FILE__) + '/../VERSION').strip
+    end
+    
+    def default_settings
+      uri = URI.parse(ENV["AMQP_URL"] || 'amqp://guest:guest@localhost:5672/')
+      {
+        :vhost => uri.path,
+        :host => uri.host,
+        :user => uri.user,
+        :port => uri.port || 5672,
+        :pass => uri.password
+      }
+    rescue Object => e
+      raise "invalid AMQP_URL: (#{uri.inspect}) #{e.class} -> #{e.message}"
+    end
+    
+    def settings
+      @@settings ||= default_settings
+    end
+    
+    def settings=(settings_hash)
+      @@settings = default_settings.update(settings_hash)
+    end
+    
+    def signal_trap!
+      ::Signal.trap('INT') { Cloudist.stop }
+      ::Signal.trap('TERM'){ Cloudist.stop }
+    end
+    
+  end
+  
+end