jsparrow 1.1.2 → 1.1.3

data/README.rdoc

@@ -2,6 +2,8 @@
 
 JSparrow is a JMS client based on JRuby. Previously it has been called Sparrow, but changed his name because has another project with the same name.
 
+WARNING: I'm sorry but any time I break backward compatibility. However, always is for make a better API.
+
 === Install
 
 Make gem install:
@@ -21,17 +23,17 @@ WARNING: OpenJMS will be used as JMS provider, but any other could be used with
 
 2) Setup indispensable informations to connect your JMS provider
 
-  JSparrow::Connection.configure do |connection|
-    connection.use_jms_client_jar '/opt/openjms/lib/openjms-0.7.7-beta-1.jar'
+  JSparrow::Connection.configure do
+    use_jms_client_jar '/opt/openjms/lib/openjms-0.7.7-beta-1.jar'
 
-    connection.use_jndi_properties :initial_context_factory => 'org.exolab.jms.jndi.InitialContextFactory',
-                                   :provider_url            => 'tcp://localhost:3035'
-                                 # :security_principal      => 'user',
-                                 # :security_credentials    => 'password'
+    use_jndi_properties :initial_context_factory => 'org.exolab.jms.jndi.InitialContextFactory',
+                        :provider_url            => 'tcp://localhost:3035'
+                      # :security_principal      => 'user',
+                      # :security_credentials    => 'password'
 
-    connection.enable_connection_factories :queue_connection_factory => 'ConnectionFactory'
+    enable_connection_factories :queue_connection_factory => 'ConnectionFactory'
     
-    connection.enable_queues :my_queue => 'MyQueue'
+    enable_queues :my_queue => 'MyQueue'
   end
 
 3) Create the client and start it
@@ -72,6 +74,12 @@ Or, if you don't want write code, only do it:
 
   jruby sample/sample_queue.rb
 
+=== Next
+
+For more informations, read the specs! ;)
+
+http://github.com/leandrosilva/jsparrow/tree/master/spec/
+
 == Copyright
 
 Copyright (c) 2009 Leandro Silva (CodeZone) <leandrodoze@gmail.com>. See LICENSE for details.

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 1
 :minor: 1
-:patch: 2
+:patch: 3
 :build: 

data/lib/connection.rb

@@ -5,42 +5,99 @@ import 'javax.naming.InitialContext'
 module JSparrow
   module Connection
 
-    #
-    # Metodo usado para configurar a conexao com o provedor de JMS.
-    #
-    def self.configure
-      @@configuration = Configuration.new
-      
-      yield @@configuration
-      
-      @@jndi_context_builder = JNDI::ContextBuilder.new(@@configuration.jms_client_jar, @@configuration.jndi_properties)
+    class << self
+      #
+      # Metodo usado para configurar a conexao.
+      #
+      def configure(&block)
+        @@configuration = Configuration.new
+        
+        class_eval(&block)
+        
+        @@configuration
+      end
+    
+      #
+      # Metodo usado para obter a configuracao para conexao com o provedor de JMS.
+      #
+      def configuration
+        @@configuration
+      end
 
-      @@configuration
-    end
+      #
+      # Use:
+      #
+      # use_jms_client_jar "path/to/name_of_the_client_jar_file.jar"
+      #
+      def use_jms_client_jar(client_jar)
+        configuration.jms_client_jar = client_jar
+      end
     
-    #
-    # Metodo usado para obter a configuracao para conexao com o provedor de JMS.
-    #
-    def self.configuration
-      @@configuration
-    end
+      #
+      # Use:
+      #
+      #   use_jndi_properties :a_jndi_property_name_in_lower_case     => "a_value_of_property",
+      #                       :other_jndi_property_name_in_lower_case => "other_value_of_property"
+      #
+      def use_jndi_properties(jndi_properties = {})
+        configuration.jndi_properties = jndi_properties
+      end
     
-    #
-    # Metodo usado para criar um novo Client JMS.
-    #
-    def self.new_client
-      connection = Base.new(@@configuration, @@jndi_context_builder)
-      
-      Client.new(connection)
-    end
+      #
+      # Use:
+      #
+      #   enable_connection_factories :queue_connection_factory => "jndi_name_of_queue_connection_factory",
+      #                               :topic_connection_factory => "jndi_name_of_topic_connection_factory"
+      #
+      def enable_connection_factories(jndi_names = {})
+        configuration.enabled_connection_factories = jndi_names
+      end
     
-    #
-    # Metodo usado para criar um novo Listener de mensagens JMS.
-    #
-    def self.new_listener(listener_spec)
-      connection = Base.new(@@configuration, @@jndi_context_builder)
-      
-      listener_spec[:as].new(connection)
+      #
+      # Use:
+      #
+      #   enable_queues :a_queue_name_in_lower_case     => "jndi_name_of_a_queue",
+      #                 :other_queue_name_in_lower_case => "jndi_name_of_other_queue"
+      #
+      def enable_queues(jndi_names = {})
+        configuration.enabled_queues = jndi_names
+      end
+    
+      #
+      # Use:
+      #
+      #   enable_topics :a_topic_name_in_lower_case     => "jndi_name_of_a_topic",
+      #                 :other_topic_name_in_lower_case => "jndi_name_of_other_topic"
+      #
+      def enable_topics(jndi_names = {})
+        configuration.enabled_topics = jndi_names
+      end
+
+      #
+      # Metodo usado para criar um novo Client JMS.
+      #
+      def new_client
+        Client.new(new_connection)
+      end
+  
+      #
+      # Metodo usado para criar um novo Listener de mensagens JMS.
+      #
+      def new_listener(listener_spec)
+        listener_spec[:as].new(new_connection)
+      end
+
+      # --- Private methods --- #
+      private
+
+        #
+        # Metodo usado para criar uma nova Connection
+        #
+        def new_connection
+          jndi_context_builder = JNDI::ContextBuilder.new(configuration.jms_client_jar, configuration.jndi_properties)
+        
+          connection = Base.new(configuration, jndi_context_builder)
+        end
     end
 
     #
@@ -107,57 +164,8 @@ module JSparrow
     # ao provedor de mensageria via contexto JNDI.
     #
     class Configuration
-      attr_reader :jms_client_jar, :jndi_properties,
-                  :enabled_connection_factories, :enabled_queues, :enabled_topics
-      
-      #
-      # Use:
-      #
-      # use_jms_client_jar "path/to/name_of_the_client_jar_file.jar"
-      #
-      def use_jms_client_jar(client_jar)
-        @jms_client_jar = client_jar
-      end
-      
-      #
-      # Use:
-      #
-      #   use_jndi_properties :a_jndi_property_name_in_lower_case     => "a_value_of_property",
-      #                       :other_jndi_property_name_in_lower_case => "other_value_of_property"
-      #
-      def use_jndi_properties(jndi_properties = {})
-        @jndi_properties = jndi_properties
-      end
-      
-      #
-      # Use:
-      #
-      #   enable_connection_factories :queue_connection_factory => "jndi_name_of_queue_connection_factory",
-      #                               :topic_connection_factory => "jndi_name_of_topic_connection_factory"
-      #
-      def enable_connection_factories(jndi_names = {})
-        @enabled_connection_factories = jndi_names
-      end
-      
-      #
-      # Use:
-      #
-      #   enable_queues :a_queue_name_in_lower_case     => "jndi_name_of_a_queue",
-      #                 :other_queue_name_in_lower_case => "jndi_name_of_other_queue"
-      #
-      def enable_queues(jndi_names = {})
-        @enabled_queues = jndi_names
-      end
-      
-      #
-      # Use:
-      #
-      #   enable_topics :a_topic_name_in_lower_case     => "jndi_name_of_a_topic",
-      #                 :other_topic_name_in_lower_case => "jndi_name_of_other_topic"
-      #
-      def enable_topics(jndi_names = {})
-        @enabled_topics = jndi_names
-      end
+      attr_accessor :jms_client_jar, :jndi_properties,
+                    :enabled_connection_factories, :enabled_queues, :enabled_topics
     end
 
     #

data/lib/messaging.rb

@@ -100,32 +100,48 @@ module JSparrow
     #
     # Receptor de mensagens.
     #
-    class Receiver < Base    
+    class Receiver < Base
       def receive_message(criteria_for_receiving = {:timeout => DEFAULT_RECEIVER_TIMEOUT, :selector => ''}, &message_handler)
-        # Cria uma conexao, uma sessao e um consumidor de qualquer tipo de mensagem
-        connection = @connection_factory.create_connection
-        session    = connection.create_session(false, Session::AUTO_ACKNOWLEDGE)
-        consumer   = session.create_consumer(@destination, criteria_for_receiving[:selector])
+        receive(:one_message, criteria_for_receiving, &message_handler)
+      end
+
+      def receive_messages(criteria_for_receiving = {:timeout => DEFAULT_RECEIVER_TIMEOUT, :selector => ''}, &message_handler)
+        receive(:many_messages, criteria_for_receiving, &message_handler)
+      end
+      
+      # --- Private methods --- #
+      private
+      
+        def receive(how_much_messages, criteria_for_receiving, &message_handler)
+          # Cria uma conexao, uma sessao e um consumidor de qualquer tipo de mensagem
+          connection = @connection_factory.create_connection
+          session    = connection.create_session(false, Session::AUTO_ACKNOWLEDGE)
+          consumer   = session.create_consumer(@destination, criteria_for_receiving[:selector])
         
-        # Prepara a conexao para receber mensagens
-        connection.start
+          # Prepara a conexao para receber mensagens
+          connection.start
         
-        # Inicia o recebimento de mensagens
-        timeout = criteria_for_receiving[:timeout] || DEFAULT_RECEIVER_TIMEOUT
+          # Inicia o recebimento de mensagens
+          timeout = criteria_for_receiving[:timeout] || DEFAULT_RECEIVER_TIMEOUT
+          
+          # Uma (if) mensagem ou muitas (while) mensagens?
+          conditional_keyword = (how_much_messages.eql? :one_message) ? 'if' : 'while'
         
-        while (received_message = consumer.receive(timeout))
-          # Inclui o modulo de identificacao de mensagem, util para o message_handler
-          class << received_message
-            include MessageType
-          end
+          eval %Q{
+            #{conditional_keyword} (received_message = consumer.receive(timeout))
+              # Inclui o modulo de identificacao de mensagem, util para o message_handler
+              class << received_message
+                include MessageType
+              end
+
+              # Delega o tratamento da mensagem para o bloco recebido
+              message_handler.call(received_message)
+            end
+          }
         
-          # Delega o tratamento da mensagem para o bloco recebido
-          message_handler.call(received_message)
+          # Fecha a conexao
+          connection.close
         end
-        
-        # Fecha a conexao
-        connection.close
-      end
     end
   
     #

data/sample/sample_queue.rb

@@ -1,17 +1,17 @@
 require 'rubygems'
 require 'jsparrow'
 
-JSparrow::Connection.configure do |connection|
-  connection.use_jms_client_jar '/opt/openjms/lib/openjms-0.7.7-beta-1.jar'
+JSparrow::Connection.configure do
+  use_jms_client_jar '/opt/openjms/lib/openjms-0.7.7-beta-1.jar'
 
-  connection.use_jndi_properties :initial_context_factory => 'org.exolab.jms.jndi.InitialContextFactory',
-                                 :provider_url            => 'tcp://localhost:3035'
-                               # :security_principal      => 'user',
-                               # :security_credentials    => 'password'
+  use_jndi_properties :initial_context_factory => 'org.exolab.jms.jndi.InitialContextFactory',
+                      :provider_url            => 'tcp://localhost:3035'
+                    # :security_principal      => 'user',
+                    # :security_credentials    => 'password'
 
-  connection.enable_connection_factories :queue_connection_factory => 'ConnectionFactory'
+  enable_connection_factories :queue_connection_factory => 'ConnectionFactory'
   
-  connection.enable_queues :test_queue => 'TestQueue'
+  enable_queues :test_queue => 'TestQueue'
 end
 
 jms_client = JSparrow::Connection.new_client

data/sample/sample_topic.rb

@@ -1,17 +1,17 @@
 require 'rubygems'
 require 'jsparrow'
 
-JSparrow::Connection.configure do |connection|
-  connection.use_jms_client_jar '/opt/openjms/lib/openjms-0.7.7-beta-1.jar'
+JSparrow::Connection.configure do
+  use_jms_client_jar '/opt/openjms/lib/openjms-0.7.7-beta-1.jar'
 
-  connection.use_jndi_properties :initial_context_factory => 'org.exolab.jms.jndi.InitialContextFactory',
-                                 :provider_url            => 'tcp://localhost:3035'
-                               # :security_principal      => 'user',
-                               # :security_credentials    => 'password'
+  use_jndi_properties :initial_context_factory => 'org.exolab.jms.jndi.InitialContextFactory',
+                      :provider_url            => 'tcp://localhost:3035'
+                    # :security_principal      => 'user',
+                    # :security_credentials    => 'password'
 
-  connection.enable_connection_factories :topic_connection_factory => 'ConnectionFactory'
+  enable_connection_factories :topic_connection_factory => 'ConnectionFactory'
   
-  connection.enable_topics :test_topic => 'TestTopic'
+  enable_topics :test_topic => 'TestTopic'
 end
 
 jms_client = JSparrow::Connection.new_client

data/spec/messaging_spec.rb

@@ -66,7 +66,23 @@ describe JSparrow::Messaging do
       received_id_long.should eql my_id_long
     end
   
-    it 'should send messages a lot and next receive it' do
+  it 'should send a message and next receive it with criterias' do
+    my_text = 'Mensagem de texto enviada da spec'
+  
+    @sender.send_text_message(my_text) do |msg|
+      msg.set_string_property('recipient', 'jsparrow-spec')
+    end
+  
+    received_text = nil
+  
+    @receiver.receive_message(:timeout => 1000, :selector => "recipient = 'jsparrow-spec'") do |msg|
+      received_text = msg.text
+    end
+  
+    received_text.should eql my_text
+  end
+
+    it 'should send messages a lot and next receive it with criterias' do
       my_text = 'Mensagem de texto enviada da spec'
     
       my_object = java.util.ArrayList.new
@@ -99,7 +115,7 @@ describe JSparrow::Messaging do
       received_object  = nil
       received_id_long = nil
     
-      @receiver.receive_message(:timeout => 1000, :selector => "recipient = 'jsparrow-spec'") do |msg|
+      @receiver.receive_messages(:timeout => 1000, :selector => "recipient = 'jsparrow-spec'") do |msg|
         if msg.is_text_message?
           received_text = msg.text
         end

data/spec/spec_helper.rb

@@ -9,20 +9,20 @@ require File.dirname(File.expand_path(__FILE__)) + '/../lib/jsparrow.rb'
 module JSparrowHelperMethods
 
   def configure_connection
-    JSparrow::Connection.configure do |connection|
-      connection.use_jms_client_jar '/opt/openjms/lib/openjms-0.7.7-beta-1.jar'
+    JSparrow::Connection.configure do
+      use_jms_client_jar '/opt/openjms/lib/openjms-0.7.7-beta-1.jar'
 
-      connection.use_jndi_properties :initial_context_factory => 'org.exolab.jms.jndi.InitialContextFactory',
-                                     :provider_url            => 'tcp://localhost:3035'
-                                   # :security_principal      => 'user',
-                                   # :security_credentials    => 'password'
+      use_jndi_properties :initial_context_factory => 'org.exolab.jms.jndi.InitialContextFactory',
+                          :provider_url            => 'tcp://localhost:3035'
+                        # :security_principal      => 'user',
+                        # :security_credentials    => 'password'
       
-      connection.enable_connection_factories :queue_connection_factory => 'ConnectionFactory', 
-                                             :topic_connection_factory => 'ConnectionFactory'
+      enable_connection_factories :queue_connection_factory => 'ConnectionFactory', 
+                                  :topic_connection_factory => 'ConnectionFactory'
       
-      connection.enable_queues :test_queue => 'TestQueue'
+      enable_queues :test_queue => 'TestQueue'
       
-      connection.enable_topics :test_topic => 'TestTopic'
+      enable_topics :test_topic => 'TestTopic'
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsparrow
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors: 
   - Leandro Silva