ap4r 0.3.5 → 0.3.6

data/lib/ap4r/mongrel_ap4r.rb

@@ -116,6 +116,8 @@ module Ap4r::Mongrel
         listener do
           log "Starting AP4R Handler with #{defaults[:ap4r_config_file]}"
           uri "/", :handler => ::Ap4r::Mongrel::Ap4rHandler.new(defaults)
+          uri "/queues", :handler => ::Ap4r::Mongrel::Ap4rSendMessageHandler.new(defaults)
+          uri "/subscribes", :handler => ::Ap4r::Mongrel::Ap4rSubscribeMessageHandler.new(defaults)
         end
         setup_signals(settings)
       end

data/lib/ap4r/queue_manager_ext.rb

@@ -6,7 +6,7 @@ require 'active_support'
 require 'yaml'
 require 'thread'
 require 'pp'
-
+require 'erb'
 require 'uuid'
 require 'reliable-msg'
 
@@ -19,21 +19,21 @@ require 'ap4r/carrier'
 module ReliableMsg #:nodoc:
 
   # = Dynamic configuration with ERb
-  # 
-  # Some times you would like to inject dynamic values into your configuration file. 
+  #
+  # Some times you would like to inject dynamic values into your configuration file.
   # In these cases, you can mix ERb in with your YAML to code some logic, like:
-  # 
+  #
   # <% acl = [] %>
   # <% for i in 1..100 %>
   # <% acl << "192.168.0.#{i}" %>
-  # <% end %> 
+  # <% end %>
   # acl: <%= acl.map{|ip| "allow #{ip}"}.join(' ')
   #
   class Config
-    
+
     alias :load_no_create_original :load_no_create
     alias :load_or_create_original :load_or_create
-   
+
     #--
     # TODO: should enhance YAML.load_documents instead of this method?, 2007/5/7 kato-k
     def load_no_create
@@ -47,7 +47,7 @@ module ReliableMsg #:nodoc:
         true
       end
     end
-    
+
     #--
     # TODO: should enhance YAML.load_documents instead of this method?, 2007/5/7 kato-k
     def load_or_create
@@ -68,13 +68,13 @@ module ReliableMsg #:nodoc:
         @logger.info format(INFO_CREATED_CONFIG, @file)
       end
     end
-  
+
     private
     def erb_render(configuration_content)
-      ERB.new(configuration_content).result
+      ::ERB.new(configuration_content).result
     end
   end
-  
+
   class QueueManager
 
     # Gets a queue name which has the most stale message.

data/lib/ap4r/retention_history.rb

@@ -7,14 +7,16 @@ require 'active_support'
 module ReliableMsg #:nodoc:
 
   # This class is too much experimental.
-  # The aim: for performance monitoring, records unprocessed message count 
+  # The aim: for performance monitoring, records unprocessed message count
   # in every queues at some interval.
   class RetentionHistory
     include DRbUndumped
 
-    LOOP_INTERVAL = 1.seconds
-    SHELF_LIFE = 10.minutes
-#    SHELF_LIFE = 10.seconds
+    # to_i method is required for ActiveSupport 2.0 where return value of seconds method
+    # is not Fixnum.
+    LOOP_INTERVAL = 1.seconds.to_i
+    SHELF_LIFE = 10.minutes.to_i
+#    SHELF_LIFE = 10.seconds.to_i
     attr_reader :data
 
     def initialize(qm, logger, config)

data/lib/ap4r/stored_message.rb

@@ -31,7 +31,7 @@ module Ap4r
     
     def dumped_headers
       # The warning occurs when putting backslash into binaly type in PostgreSQL.
-      if postgresql?
+      if self.class.postgresql?
         self.headers
       else
         Marshal::dump(self.headers)
@@ -40,7 +40,7 @@ module Ap4r
     
     def dumped_object
       # The warning occurs when putting backslash into binaly type in PostgreSQL.
-      if postgresql?
+      if self.class.postgresql?
         self.object
       else
         Marshal::dump(self.object)

data/lib/ap4r/util/queue_client.rb

@@ -7,15 +7,14 @@ module Ap4r::Util #:nodoc:
   #
   # Client class for +QueueManager+.
   # This class wraps DRb client and provides some helper methods.
-  # TODO: many drb calls are executed in a method call such as +list_queues+.
-  #       ParseTree is perhaps needed.
-  # TODO: +Proc+ object cannnot be passed via DRb. ParseTree also?
+  # TODO: many drb calls are executed in a method call such as +list_queues+. 2006/09/22 by shino
+  #       ParseTree is perhaps needed. Now ruby-parser is also available?
   class QueueClient
     CONFIG_DIR_DEFAULT = 'config'
     CONFIG_FILE_DEFAULT = 'queues.cfg'
 
     HOST_DEFAULT = 'localhost'
-    
+
     DEFAULT_QUEUE_PREFIX = 'queue.test.'
     DEFAULT_QUEUE_SUFFIX = 'default'
     DEFAULT_MULTI_QUEUE = DEFAULT_QUEUE_PREFIX + '*'
@@ -57,7 +56,7 @@ module Ap4r::Util #:nodoc:
     def list_queues
       qm.store.queues.keys
     end
-  
+
     def list_messages(suffix = DEFAULT_QUEUE_SUFFIX,
                       prefix = DEFAULT_QUEUE_PREFIX)
       qm.store.queues[prefix.to_s + suffix.to_s]

data/lib/ap4r/version.rb

@@ -8,7 +8,7 @@ module Ap4r
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 5
+    TINY  = 6
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/rails_plugin/ap4r/lib/async_helper.rb

@@ -4,7 +4,7 @@
 
 require 'reliable-msg'
 require 'ap4r/stored_message'
-require 'message_builder'
+require 'ap4r/message_builder'
 
 module Ap4r
 

data/rails_plugin/ap4r/tasks/ap4r.rake

@@ -1,5 +1,3 @@
-require File.expand_path(File.dirname(__FILE__) + "/../lib/ap4r/service_handler.rb")
-
 namespace :test do
 
 #  task :asyncs do
@@ -10,14 +8,14 @@ namespace :test do
   namespace :asyncs do
 
     desc "Start Rails and AP4R servers to test:asyncs:exec"
-    task :arrange do |t|
+    task :arrange => :require_dependencies do |t|
       ap4r_handler = Ap4r::ServiceHandler.new
       ap4r_handler.start_rails_service
       ap4r_handler.start_ap4r_service
     end
 
     desc "Start Rails and AP4R servers to test:asyncs:exec"
-    task :cleanup do |t|
+    task :cleanup => :require_dependencies do |t|
       ap4r_handler = Ap4r::ServiceHandler.new
       ap4r_handler.stop_ap4r_service
       ap4r_handler.stop_rails_service
@@ -30,6 +28,13 @@ namespace :test do
     end
     Rake::Task['test:asyncs:run'].comment = "Run the unit tests in test/async"
 
+    # service_handler.rb needs to require the following libraries.
+    # If reliable-msg's rails adapter is loaded before rails initialization,
+    # it may cause to uninitialization error because the adapter requires ActionController.
+    # So, the load of the following libraries is delayed with rake task.
+    task :require_dependencies do
+      require File.expand_path(File.dirname(__FILE__) + "/../lib/ap4r/service_handler.rb")
+    end
   end
 
 end

data/spec/local/message_builder_spec.rb

@@ -0,0 +1,200 @@
+require File.join(File.dirname(__FILE__), "../spec_helper")
+require 'ap4r/message_builder'
+# TODO: move message_builder.rb to lib directory below. 2008/01/18 kiwamu
+# require File.join(File.dirname(__FILE__), "../../rails_plugin/ap4r/lib/message_builder")
+
+describe "When simple API is used," do
+
+  describe Ap4r::MessageBuilder, " with an empty message" do
+    before(:all) do
+      empty_message = {}
+      @message_builder = Ap4r::MessageBuilder.new("queue_name", empty_message, {})
+    end
+
+    it "should have the right MIME header." do
+      pending("TODO: should modify implementation? 2008/01/18 kiwamu")
+      mime_type = @message_builder.message_headers["http_header_Content-type".to_sym]
+      mime_type.should == "application/x-www-form-urlencoded"
+    end
+
+    it "should have the given message." do
+      @message_builder.message_body.should == {}
+    end
+
+    it "should return also a empty string body after format." do
+      @message_builder.format_message_body.should == ""
+    end
+
+  end
+
+  describe Ap4r::MessageBuilder, " with a simple message" do
+    before(:all) do
+      message = {:foo => "bar"}
+      @message_builder = Ap4r::MessageBuilder.new("queue_name", message, {})
+    end
+
+    it "should have the right MIME header." do
+      pending("TODO: should modify implementation? 2008/01/18 kiwamu")
+      mime_type = @message_builder.message_headers["http_header_Content-type".to_sym]
+      mime_type.should == "application/x-www-form-urlencoded"
+    end
+
+    it "should have the given message." do
+      @message_builder.message_body.should == {:foo => "bar"}
+    end
+
+    it "should return the urlencoded body." do
+      @message_builder.format_message_body.should == "foo=bar"
+    end
+
+  end
+
+  describe Ap4r::MessageBuilder, " with a nested complicated message" do
+    before(:all) do
+      @message = {:a => {:b => "c", :d => { :e => "f", :g => "h"}}, :i => "j"}
+      @message_builder = Ap4r::MessageBuilder.new("queue_name", @message, {})
+    end
+
+    it "should have the given message." do
+      @message_builder.message_body.should == @message
+    end
+
+    it "should return the urlencoded body." do
+      query = @message_builder.format_message_body
+      query.split("&").sort.should == %w(a[b]=c a[d][e]=f a[d][g]=h i=j).sort
+    end
+
+  end
+
+end
+
+
+describe "When block style API is used, " do
+
+  describe Ap4r::MessageBuilder, " assigned unknown format" do
+
+    before(:all) do
+
+      block = Proc.new do
+        body :key1, "value"
+        body :key2, 1
+        format :unknown_format
+      end
+
+      @message_builder = Ap4r::MessageBuilder.new("", {}, {})
+      @message_builder.instance_eval(&block)
+    end
+
+    it "should have the right MIME header." do
+      pending("TODO: should modify implementation? 2008/01/24 kiwamu")
+      mime_type = @message_builder.message_headers["http_header_Content-type".to_sym]
+      mime_type.should == "application/x-www-form-urlencoded"
+    end
+
+    it "should have the given message." do
+      @message_builder.message_body.should == {:key1 => "value", :key2 => 1}
+    end
+
+    it "should return the urlencoded body." do
+      @message_builder.format_message_body.should == "key1=value&key2=1"
+    end
+
+  end
+
+  describe Ap4r::MessageBuilder, " assigned text format" do
+
+    before(:all) do
+
+      block = Proc.new do
+        body :key1, "value"
+        body :key2, 1
+        format :text
+      end
+
+      @message_builder = Ap4r::MessageBuilder.new("", {}, {})
+      @message_builder.instance_eval(&block)
+    end
+
+    it "should have the right MIME header." do
+      mime_type = @message_builder.message_headers["http_header_Content-type".to_sym]
+      mime_type.should == "text/plain"
+    end
+
+    it "should return the to_s formatted body." do
+      @message_builder.format_message_body.should == {:key1 => "value", :key2 => 1}.to_s
+    end
+  end
+
+  describe Ap4r::MessageBuilder, " assigned xml format" do
+
+    before(:all) do
+
+      block = Proc.new do
+        body :key1, "value"
+        body :key2, 1
+        format :xml
+      end
+
+      @message_builder = Ap4r::MessageBuilder.new("", {}, {})
+      @message_builder.instance_eval(&block)
+    end
+
+    it "should have the right MIME header." do
+      mime_type = @message_builder.message_headers["http_header_Content-type".to_sym]
+      mime_type.should == "application/xml"
+    end
+
+    it "should return the xml formatted body." do
+      @message_builder.format_message_body.should == {:key1 => "value", :key2 => 1}.to_xml(:root => "root")
+    end
+  end
+
+  describe Ap4r::MessageBuilder, " assigned json format" do
+
+    before(:all) do
+
+      block = Proc.new do
+        body :key1, "value"
+        body :key2, 1
+        format :json
+      end
+
+      @message_builder = Ap4r::MessageBuilder.new("", {}, {})
+      @message_builder.instance_eval(&block)
+    end
+
+    it "should have the right MIME header." do
+      mime_type = @message_builder.message_headers["http_header_Content-type".to_sym]
+      mime_type.should == "application/json"
+    end
+
+    it "should return the json formatted body." do
+      @message_builder.format_message_body.should == {:key1 => "value", :key2 => 1}.to_json
+    end
+  end
+
+  describe Ap4r::MessageBuilder, " assigned yaml format" do
+
+    before(:all) do
+
+      block = Proc.new do
+        body :key1, "value"
+        body :key2, 1
+        format :yaml
+      end
+
+      @message_builder = Ap4r::MessageBuilder.new("", {}, {})
+      @message_builder.instance_eval(&block)
+    end
+
+    it "should have the right MIME header." do
+      mime_type = @message_builder.message_headers["http_header_Content-type".to_sym]
+      mime_type.should == "text/yaml"
+    end
+
+    it "should return the yaml formatted body." do
+      @message_builder.format_message_body.should == {:key1 => "value", :key2 => 1}.to_yaml
+    end
+  end
+
+end

data/spec/local/send_message_handler_spec.rb

@@ -0,0 +1,109 @@
+require File.join(File.dirname(__FILE__), "../spec_helper")
+
+require "reliable-msg"
+require "ap4r/mongrel"
+
+describe Ap4r::Mongrel::Ap4rSendMessageHandler, " on accepting a simple message" do
+
+  def start_queue_manager
+    @manager = ::ReliableMsg::QueueManager.new(:config => "config/queues_disk.cfg")
+    @manager.start_original
+  end
+
+  before(:each) do
+    start_queue_manager
+    q = ::ReliableMsg::Queue.new "queue.test"
+    while q.get; end
+
+    params = {
+      Mongrel::Const::PATH_INFO => "/queue.test",
+      Mongrel::Const::REQUEST_METHOD => "POST",
+    }
+    class << params
+      def http_body
+        "hoge"
+      end
+    end
+
+    class MockSocket
+      def initialize;end
+      def closed?;false;end
+    end
+
+    @handler = Ap4r::Mongrel::Ap4rSendMessageHandler.new(nil)
+    @request = Mongrel::HttpRequest.new(params, nil, nil)
+    @response = Mongrel::HttpResponse.new(MockSocket.new)
+    @handler.process(@request, @response)
+  end
+
+  after(:each)do
+    @manager.stop_original
+  end
+
+  it "should have one message in the queue" do
+    q = ReliableMsg::Queue.new "queue.test"
+    q.get.should_not be_nil
+    q.get.should be_nil
+  end
+
+  it "should have the same message body as http body" do
+    q = ReliableMsg::Queue.new "queue.test"
+    q.get.object.should == "hoge"
+  end
+end
+
+describe Ap4r::Mongrel::Ap4rSendMessageHandler, " on accepting a message with options" do
+
+  before(:each) do
+    @manager = ::ReliableMsg::QueueManager.new(:config => "config/queues_disk.cfg")
+    @manager.start_original
+
+    params = {
+      Mongrel::Const::PATH_INFO => "/queue.test",
+      Mongrel::Const::REQUEST_METHOD => "POST",
+      "HTTP_X_AP4R" => "priority=1, delivery=once, dispatch_mode=HTTP, target_method=POST, " +
+                       "target_url=http://sample.com:3000"
+    }
+    class << params
+      def http_body
+        "hoge"
+      end
+    end
+
+    class MockSocket
+      def initialize;end
+      def closed?;false;end
+    end
+
+    @handler = Ap4r::Mongrel::Ap4rSendMessageHandler.new(nil)
+    @request = Mongrel::HttpRequest.new(params, nil, nil)
+    @response = Mongrel::HttpResponse.new(MockSocket.new)
+    @handler.process(@request, @response)
+  end
+
+  after(:each)do
+    @manager.stop_original
+  end
+
+  it "should have one message in the queue" do
+    q = ReliableMsg::Queue.new "queue.test"
+    q.get.should_not be_nil
+    q.get.should be_nil
+  end
+
+  it "should have the same message body as http body" do
+    q = ReliableMsg::Queue.new "queue.test"
+    q.get.object.should == "hoge"
+  end
+
+  it "should have the same message header as http header" do
+    q = ReliableMsg::Queue.new "queue.test"
+    m = q.get
+    m.headers[:priority].should == 1
+    m.headers[:delivery].should == :once
+    m.headers[:dispatch_mode].should == :HTTP
+    m.headers[:target_method].should == :POST
+    m.headers[:target_url].should == "http://sample.com:3000"
+  end
+
+end