fmq 0.1.1 → 0.2.0

data/README.txt

@@ -0,0 +1,69 @@
+= Free Message Queue (FMQ)
+
+Project website: http://fmq.rubyforge.org/
+
+Project github repositiory: git://github.com/threez/fmq.git
+
+== TODO:
+
+* create full rdoc
+* support of logging to file
+* add client apis for other languages
+* complete unit tests
+
+== DESCRIPTION:
+
+The project implements a queue system with a server and some client apis.
+
+The server is a mongrel web server that holds REST-named queues. 
+You can GET, POST, DELETE, HEAD queue messages using the normal HTTP requests. 
+The system itself uses a configuration file (YAML) to setup queues at 
+startup or even at runtime. The queue implementations can be changed using 
+an easy plugin system right from your project directory.
+
+For an simple administration and try out of the system, FMQ has an integrated ajax based web interface.
+
+The client apis are implemented using the HTTP protocol, so that 
+you can use even curl to receive messages. Ruby is implemented right now, other languages will follow.
+
+The queue itself is an URL like http://localhost:5884/myQueueName/ 
+or http://localhost:5884/myApplication/myQueueName/. If you do a GET request to 
+this url with a web browser you will receive one message from the queue. The queue 
+stores it’s internal data in an FIFO in system memory.
+
+== FEATURES/PROBLEMS:
+
+* FIFO message store
+* easy setup and maintainance of system
+* using http for communication
+* changeable queue implementation
+* ruby client lib
+* simple ajax admin interface
+
+== SYNOPSIS:
+
+After installing the gem you can start by creating a project:
+
+  fmq create my_project_name
+next step is to change to the folder and start the FMQ server:
+
+  cd my_project_name
+  fmq
+
+The server will start and host a admin interface on http://localhost:5884/admin/index.
+
+== REQUIREMENTS:
+
+* mongrel (as webserver)
+
+== INSTALL:
+
+Just install the gem as you expect:
+
+  sudo gem install fmq
+
+== LICENSE:
+
+(GNU GENERAL PUBLIC LICENSE, Version 3)
+
+Copyright (c) 2008 Vincent Landgraf

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'fmq/version'
+
+AUTHOR = 'Vincent Landgraf'  # can also be an array of Authors
+EMAIL = "fmq-3z@gmx.net"
+DESCRIPTION = "The project implements a queue system with a server and some client apis. This project wants to be a fast and lightweight implementation with most of the features of MQS or ActiveMQ."
+GEM_NAME = 'fmq' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'fmq' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "threez"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = FreeMessageQueue::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'fmq documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/default-server/admin-interface/index.html

@@ -19,7 +19,7 @@
 					  fillSelectWithQueuePaths("select-message-send", queues);
 					  fillTableSpaceWithQueues("queue-table-space", queues);
 					},
-					onFailure: function(transport){ alert(transport.getHeader("Error")) }
+					onFailure: function(transport){ alert(transport.getHeader("ERROR")) }
 				});
 			}
 			
@@ -30,7 +30,7 @@
 					  queues = transport.responseText.evalJSON();
 					  fillTableSpaceWithQueues("queue-table-space", queues);
 					},
-					onFailure: function(transport){ alert(transport.getHeader("Error")) }
+					onFailure: function(transport){ alert(transport.getHeader("ERROR")) }
 				});
 			}
 			
@@ -78,7 +78,7 @@
 					  toggle_element(button_id);
 					},
 					onFailure: function(transport){ 
-					  alert(transport.getHeader("Error"));
+					  alert(transport.getHeader("ERROR"));
 					  toggle_element(button_id);
 					}
 				});
@@ -95,8 +95,8 @@
 					  updateTable();
 					  toggle_element(button_id);
 					},
-					onFailure: function(transport){ 
-					  alert(transport.getHeader("Error"));
+					onFailure: function(transport) { 
+					  alert(transport.getHeader("ERROR"));
 					  toggle_element(button_id);
 					}
 				});
@@ -117,7 +117,7 @@
 					  updateTable();
 					  alert("Queue /" + $("queue-create-path").value + " created successfully");
 					},
-					onFailure: function(transport){ alert(transport.getHeader("Error")) }
+					onFailure: function(transport){ alert(transport.getHeader("ERROR")) }
 				});
 			}
 			
@@ -130,7 +130,7 @@
 					  updateTable();
 					  alert("Queue " + path + " successfully deleted");
 					},
-					onFailure: function(transport){ alert(transport.getHeader("Error")) }
+					onFailure: function(transport){ alert(transport.getHeader("ERROR")) }
 				});
 			}
 		</script>

data/default-server/queues/my_test.rb

@@ -1,20 +1,11 @@
-require "ostruct"
-
-class MyTestQueue
-  attr_accessor :manager
-  attr_reader :bytes, :size
-  
-  def initialize
-    @bytes = @size = 1
-  end
-  
-  def put(data)
-    puts "NEW MESSAGE"
+class MyTestQueue < FreeMessageQueue::BaseQueue
+  def put(message)
+    puts "INCOMMING: #{message.payload}"
   end
   
   def poll
-    item = OpenStruct.new
-    item.data = "Hello World"
-    item
+    msg = FreeMessageQueue::Message.new "Hello World", "text/plain"
+    msg.option["Time"] = Time.now
+    msg
   end
 end

data/lib/fmq/client.rb

@@ -27,50 +27,83 @@ module FreeMessageQueue
   #  require "fmq"
   #  
   #  # queue adress
-  #  QA = "http://localhost/webserver_agent/urgent_messages"
-  #  
-  #  my_remote_queue = FreeMessageQueue::ClientQueue.new(QA)
+  #  QA = "http://localhost/webserver_agent/messages"
+  #  queue = FreeMessageQueue::ClientQueue.new(QA)
   #  
   #  # pick one message
-  #  msg = my_remote_queue.get()
-  #  puts " == URGENT MESSSAGE == "
-  #  puts msg
+  #  message = queue.poll()
+  #  puts " == URGENT MESSSAGE == " if message.option["Priority"] == "high"
+  #  puts message.payload
   #  
   #  # put an urgent message on the queue e.g.in yaml
-  #  msg = "
+  #  payload = "message:
   #    title: server don't answer a ping request
   #    date_time: 2008-06-01 20:19:28
   #    server: 10.10.30.62
   #  "
   #  
-  #  my_remote_queue.put(msg)
+  #  message = FreeMessageQueue::Message.new(payload, "application/yaml")
+  #  queue.put(message)
   #
   class ClientQueue
     # create a connection to a queue (by url)
     def initialize(url)
-      @url = url
+      @url = URI.parse(url)
     end
 
     # this returns one message from the queue as a string
     def poll()
-      url = URI.parse(@url)
-      req = Net::HTTP::Get.new(url.path)
-      res = Net::HTTP.start(url.host, url.port) do |http|
-        http.request(req)
+      res = Net::HTTP.start(@url.host, @url.port) do |http|
+        http.get(@url.path)
+      end
+      
+      message = Message.new(res.body, res["CONTENT-TYPE"])
+      
+      res.each_key do |option_name|
+        if option_name.upcase.match(/MESSAGE_([a-zA-Z][a-zA-Z0-9_\-]*)/)
+          message.option[$1] = res[option_name]
+        end
       end
-      res.body
+      
+      return message
     end
     
     alias get poll
     
-    # this puts one message to the queue as a string
-    def put(data)
-      url = URI.parse(@url)
-      res = Net::HTTP.start(url.host, url.port) do |http|
-        http.post(url.path, data)
+    # this puts one message to the queue
+    def put(message)
+      header = {}
+      header["CONTENT-TYPE"] = message.content_type
+      
+      # send all options of the message back to the client
+      if message.respond_to?(:option) && message.option.size > 0
+        for option_name in message.option.keys
+          header["MESSAGE_#{option_name}"] = message.option[option_name].to_s
+        end
+      end
+      
+      Net::HTTP.start(@url.host, @url.port) do |http|
+        http.post(@url.path, message.payload, header)
       end
     end
     
     alias post put
+    
+    # return the size (number of messages) of the queue
+    def size
+      head["QUEUE_SIZE"].to_i
+    end
+    
+    # return the size of the queue in bytes
+    def bytes
+      head["QUEUE_BYTES"].to_i
+    end
+  protected
+    # do a head request to get the state of the queue
+    def head()
+      res = Net::HTTP.start(@url.host, @url.port) do |http|
+        http.head(@url.path)
+      end
+    end
   end
 end

data/lib/fmq/mongrel_server.rb

@@ -40,7 +40,7 @@ module FreeMessageQueue
       queue_path = request.params["REQUEST_PATH"]
       method = request.params["REQUEST_METHOD"]
       @log.debug("[MongrelHandler] Incomming request for #{queue_path} [#{method}] (#{request.params["REMOTE_ADDR"]})")
-      @log.debug("[MongrelHandler] Request data: #{YAML.dump(request.params)})")
+      @log.debug("[MongrelHandler] Request params: #{YAML.dump(request.params)})")
       
       begin
         # process supported features
@@ -62,24 +62,33 @@ module FreeMessageQueue
     # Returns an item from queue and sends it to the client.
     # If there is no item to fetch send an 204 (NoContent) and same as HEAD
     def process_get(request, response, queue_path)
-      queue_item = @queue_manager.poll(queue_path)
+      message = @queue_manager.poll(queue_path)
       
-      if queue_item then
+      unless message.nil? then
         response.start(200) do |head,out|
           @log.debug("[MongrelHandler] Response to GET (200)")
-          head["Content-Type"] = (queue_item.respond_to?(:content_type)) ? queue_item.content_type : "text/plain"
-          head["Server"] = SERVER_HEADER
-          head["Queue-Size"] = @queue_manager.queue_size(queue_path)
-          if !queue_item.data.nil? && queue_item.data.size > 0
-            @log.debug("[MongrelHandler] Response data: #{queue_item.data}")
-            out.write(queue_item.data)
+          head["CONTENT-TYPE"] =  message.content_type
+          head["SERVER"] = SERVER_HEADER
+          head["QUEUE_SIZE"] = @queue_manager.queue_size(queue_path)
+          head["QUEUE_BYTES"] = @queue_manager.queue_bytes(queue_path)
+          
+          # send all options of the message back to the client
+          if message.respond_to?(:option) && message.option.size > 0
+            for option_name in message.option.keys
+              head["MESSAGE_#{option_name.gsub("-", "_").upcase}"] = message.option[option_name].to_s
+            end
+          end
+          
+          if !message.payload.nil? && message.bytes > 0
+            @log.debug("[MongrelHandler] Message payload: #{message.payload}")
+            out.write(message.payload)
           end
         end
       else
         response.start(204) do |head,out|
           @log.debug("[MongrelHandler] Response to GET (204)")
-          head["Server"] = SERVER_HEADER
-          head["Queue-Size"] = 0
+          head["SERVER"] = SERVER_HEADER
+          head["QUEUE_SIZE"] = head["QUEUE_BYTES"] = 0
         end
       end
     end
@@ -87,13 +96,22 @@ module FreeMessageQueue
     # Put new item to the queue and and return sam e as head action (HTTP 200)
     def process_post(request, response, queue_path)
       @log.debug("[MongrelHandler] Response to POST (200)")
-      data = request.body.read
-      @log.debug("[MongrelHandler] DATA: #{data}")
-      @queue_manager.put(queue_path, data)
+      message = Message.new(request.body.read, request.params["CONTENT_TYPE"])
+      @log.debug("[MongrelHandler] Message payload: #{message.payload}")
+       
+      # send all options of the message back to the client
+      for option_name in request.params.keys
+        if option_name.match(/HTTP_MESSAGE_([a-zA-Z][a-zA-Z0-9_\-]*)/)
+          message.option[$1] = request.params[option_name]
+        end
+      end
+      
+      @queue_manager.put(queue_path, message)
       
       response.start(200) do |head,out|
-        head["Server"] = SERVER_HEADER
-        head["Queue-Size"] = @queue_manager.queue_size(queue_path)
+        head["SERVER"] = SERVER_HEADER
+        head["QUEUE_SIZE"] = @queue_manager.queue_size(queue_path)
+        head["QUEUE_BYTES"] = @queue_manager.queue_bytes(queue_path)
       end
     end
     
@@ -102,8 +120,9 @@ module FreeMessageQueue
       @log.debug("[MongrelHandler] Response to HEAD (200)")
       
       response.start(200) do |head,out|
-        head["Server"] = SERVER_HEADER
-        head["Queue-Size"] = @queue_manager.queue_size(queue_path)
+        head["SERVER"] = SERVER_HEADER
+        head["QUEUE_SIZE"] = @queue_manager.queue_size(queue_path)
+        head["QUEUE_BYTES"] = @queue_manager.queue_bytes(queue_path)
       end
     end
     
@@ -113,7 +132,7 @@ module FreeMessageQueue
       @queue_manager.delete_queue(queue_path)
 
       response.start(200) do |head,out|
-        head["Server"] = SERVER_HEADER
+        head["SERVER"] = SERVER_HEADER
       end
     end
     
@@ -123,8 +142,8 @@ module FreeMessageQueue
     def client_exception(request, response, queue_path, ex)
       @log.warn("[MongrelHandler] Client error: #{ex}")
       response.start(400) do |head,out|
-        head["Server"] = SERVER_HEADER
-        head["Error"] = ex.message
+        head["SERVER"] = SERVER_HEADER
+        head["ERROR"] = ex.message
       end
     end
     
@@ -139,9 +158,9 @@ module FreeMessageQueue
       end
       
       response.start(500) do |head,out|
-        head["Content-Type"] = "text/plain"
-        head["Server"] = SERVER_HEADER
-        head["Error"] = ex.message
+        head["CONTENT-TYPE"] = "text/plain"
+        head["SERVER"] = SERVER_HEADER
+        head["ERROR"] = ex.message
         
         out.write(ex.message + "\r\n\r\n")
         for line in ex.backtrace