cloudq 0.0.7

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tom Wilson
+
+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/bin/cloudq

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..','lib', 'cloudq')
+
+require 'fileutils'
+
+if ARGV.first
+  project = ARGV.first
+  FileUtils.mkdir_p project
+
+  config_ru = ["require 'cloudq'", "run Cloudq::App"].join("\n")
+  File.open(File.join(project, 'config.ru'),'w').write(config_ru)
+  gemfile = ['source :rubygems', "gem 'thin'", "gem 'cloudq'"].join("\n")
+  File.open(File.join(project, 'Gemfile'),'w').write(gemfile)
+  puts "****** Sucessfully Created #{project} *******"
+else
+  puts "Cloudq Remote Job Queue Framework..."
+  puts "(Please supply a project name for your cloudq server...)"
+end
+# puts "Running Cloudq on port:9292"
+# puts "Press Ctrl-C to exit"
+# # try to run in current directory
+# gem 'rack', '>=0'
+# load Gem.bin_path('rack', 'rackup', version)

data/lib/cloudq/app.rb

@@ -0,0 +1,46 @@
+module Cloudq
+  class App < Sinatra::Base
+    register Sinatra::Async
+
+    use Rack::Params
+
+    def self.version
+      "0.0.6"
+    end
+
+    aget '/' do
+      body "Welcome to Cloudq Framework"
+    end
+
+    # Post Job to the Queue
+    apost "/:queue" do |q|
+      halt 500 if params["job"].nil?
+      Job.create(params["job"].merge(:queue => q))
+      status = { :status => "success" }.to_json
+      body status
+    end
+
+
+    # Get Job from the Queue
+    aget "/:queue" do |q|
+      job = Job.where(:queue => q.to_sym, :workflow_state => :queued).first
+      if job
+        job.reserve!
+        body job.to_json
+      else
+        status = { :status => :empty }.to_json
+        body status
+      end
+    end
+
+    # Remove Job from the Queue
+    adelete "/:queue/:id" do |q, id|
+      job = Job.where(:queue => q.to_sym, :id => id).first
+      halt 404 unless job
+      job.delete!
+      status = { :status => "success" }.to_json
+      body status
+    end
+
+  end
+end

data/lib/cloudq/job.rb

@@ -0,0 +1,47 @@
+if ENV['MONGOHQ_URL']
+  MongoMapper.config = {:production => {'uri' => ENV['MONGOHQ_URL']}}
+  MongoMapper.connect(:production)
+else
+  MongoMapper.database = 'cloudq'
+end
+
+module Cloudq
+  class Job
+    include MongoMapper::Document
+    before_validation :write_initial_state, :on => :create
+
+    key :queue, String
+    key :klass, String
+    key :args, Hash
+    key :workflow_state, String
+
+    timestamps!
+
+    include Workflow
+
+    workflow do
+      state :queued do
+        event :reserve, :transitions_to => :reserved
+      end
+      state :reserved do
+        event :delete, :transitions_to => :deleted
+      end
+      state :deleted
+    end
+
+    def load_workflow_state
+      self[:workflow_state]
+    end
+
+    def persist_workflow_state(new_value)
+      self[:workflow_state] = new_value
+      save!
+    end
+
+    private
+      def write_initial_state
+        update_attributes(self.class.workflow_column => current_state.to_s) if load_workflow_state.blank?
+      end
+
+  end
+end

data/lib/cloudq/version.rb

@@ -0,0 +1,3 @@
+module Cloudq
+  VERSION = '0.0.7'
+end

data/lib/cloudq.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'json'
+require 'mongo_mapper'
+require 'sinatra'
+require 'sinatra/async'
+require 'workflow'
+
+require_relative 'rack/params'
+
+module Cloudq; end
+
+require_relative 'cloudq/job'
+require_relative 'cloudq/app'
+
+

data/lib/rack/params.rb

@@ -0,0 +1,49 @@
+module Rack
+  class Params
+    URL_ENCODED = %r{^application/x-www-form-urlencoded}
+    JSON_ENCODED = %r{^application/json}
+
+    # A middle ware to parse params. This will parse both the
+    # query string parameters and the body and place them into
+    # the _params_ hash of the Goliath::Env for the request.
+    #
+    # @example
+    #  use Rack::Params
+    #
+    # -- Borrowed from Goliath -- goliath.io
+    
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env['params'] = retrieve_params(env)
+      @app.call(env)
+    end
+
+    def retrieve_params(env)
+      params = {}
+      params.merge!(::Rack::Utils.parse_nested_query(env['QUERY_STRING']))
+
+      if env['rack.input']
+        post_params = ::Rack::Utils::Multipart.parse_multipart(env)
+        unless post_params
+          body = env['rack.input'].read
+          env['rack.input'].rewind
+          
+          post_params = case(env['CONTENT_TYPE'])
+          when URL_ENCODED then
+            ::Rack::Utils.parse_nested_query(body)
+          when JSON_ENCODED then
+            JSON.parse(body)
+          else
+            {}
+          end
+        end
+        params.merge!(post_params)
+      end
+
+      params
+    end
+  end
+end

data/readme.md

@@ -0,0 +1,171 @@
+# Cloudq Framework
+
+Cloudq is a rack-based job queue framework.  
+
+## What does that mean?
+
+Cloudq is a job queue, but instead of containing a ton of features, it focuses on doing job queue basics:
+
+* Publish a Job to a Queue
+* Reserve a Job from a Queue
+* Delete a Job from a Queue
+
+Using the rack application architecture, and taking advantage of rack middleware, adding features or embedding
+into other applications is very easy.
+
+Currently, it does depend on access to a mongodb datastore.  Either the standard localhost or you can 
+set the MONGOHQ_URL env variable.  This does not mean that any application you join with Cloudq needs to write to mongodb, just the job queue is connected to mongo.
+
+# What about security?
+# What about monitoring?
+# etc???
+
+The answer is simple, RACK MIDDLEWARE!  If you want to implement ssl encryption and enforce SSL traffic, use
+rack middleware.  If you want to attach a slick admin 
+interface that monitors your queues, then use the rack
+map function to attach another rack-based application to your config.ru file.
+
+It really is that easy, and Cloudq gives you the flexibility to integrate almast anyway you can think of.
+
+# How do I get started?
+
+1. Install Mongodb
+
+First you need to install MongoDb and have a mongodb service running.  Or you can signup for a free account on
+MongoHq.com.  
+
+2. Install Ruby version 1.9.2 or above
+
+Make sure you have Ruby 1.9.2 installed on your machine, if you do not have 1.9.2, check out [RVM](https://rvm.beginrescueend.com/).  Ruby 1.9.2 comes with rubygems, which will allow you to install the cloudq gem.
+
+3. Install the Cloudq Gem
+
+    gem install cloudq
+    
+4. Build your cloudq server
+
+    cloudq [your name]
+    
+This will create a directory and add a config.ru and Gemfile.  And if you don't want to add any other features,
+you are good to go.  All you have to do is cd into your directory and run:
+
+
+    thin start
+    
+And your cloudq server is up and running!  
+
+----------------
+
+# Deploy
+
+You can deploy Cloudq just like any rails application, but Heroku is an awesome platform to deploy:
+    
+    # make sure you have your project in a git repo
+    
+    git init
+    git add .
+    git commit -am "First Commit"
+    
+    # deploy to heroku in 2 simple steps
+    
+    heroku create
+    git push heroku master
+    
+
+# Contribution
+
+Feel free to for fork the code and make pull requests.. But also create some Rack Middleware that helps add an
+awesome feature stack to the Cloudq.
+
+Here is a link to an awesome chapter in the Rails 3 in a Nutshell on Rack.
+
+[http://rails-nutshell.labs.oreilly.com/ch07.html](http://rails-nutshell.labs.oreilly.com/ch07.html)
+
+
+# API
+
+The api pattern is like so:
+
+    / [ Queue Name ] / [ Action ] 
+
+    and
+
+    / [ Queue Name ] / [ Action ] / [ id ]
+
+
+## Add to Queue
+
+    post /myqueue
+      klass: 'Archive'
+      args: { [ args here ] }
+
+## Reserve Message
+
+    get /myqueue
+    
+    # JSON =>
+    { 
+      klass: 'Archive'
+      args: {}
+      id: 1234
+    }
+
+## Delete Message
+
+    delete /myqueue/1234
+
+
+---
+
+You can create as many queues as you want, when you post your first
+message in the queue, it will create that queue, and when you perform
+reserver, the worker will pull in a first in, first out process.
+
+---
+
+## Publish Job in Ruby
+
+    gem install cloudq_client
+
+    require 'cloudq_client/publish'
+
+    Cloudq::Connection.url = 'http://donuts.com'
+    Cloudq::Publish.job(:make_donuts, 'Donut', :types => [:glazed,
+:chocolate])
+
+
+---
+
+### Worker in Ruby
+
+    gem install cloudq_client
+
+    require 'cloudq_client/cosume'
+    require 'Donut'
+
+    Cloudq::Connection.url = 'http://donuts.com'
+    loop do
+      Cloudq::Consume.job(:make_donuts)
+      sleep 5
+    end
+
+
+---
+
+The worker can be implemented in any language, but the api is designed
+to return a json message that will call the perform class method and
+pass in arguments to that method for processing:
+
+    klass = Object.const_get(payload[:klass].capitalize)
+    klass.perform(*payload[:args])
+
+
+
+---
+
+
+
+
+
+
+

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification 
+name: cloudq
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.7
+platform: ruby
+authors: 
+- Tom Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: thin
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0.beta.3
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: async_sinatra
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: workflow
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id010
+description: The Cloudq Framework makes it easy to build remote job queue servers
+email: 
+- tom@jackhq.com
+executables: 
+- cloudq
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cloudq/app.rb
+- lib/cloudq/job.rb
+- lib/cloudq/version.rb
+- lib/cloudq.rb
+- lib/rack/params.rb
+- LICENSE
+- readme.md
+- bin/cloudq
+has_rdoc: true
+homepage: http://github.com/twilson63/cloudq
+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: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A Ruby Framework for a Remote Job Queue Server
+test_files: []
+