leandrosilva-sparrow 1.0.0 → 1.0.1

data/README.rdoc

@@ -2,6 +2,66 @@
 
 Sparrow is a JMS client (JRuby based).
 
+=== Install
+
+Add Github as a source for your RubyGem:
+
+  gem sources -a http://gems.github.com
+
+Make install:
+
+  sudo gem install leandrosilva-sparrow
+
+=== Example
+
+===== Three steps to send and receive JMS messages to/from a Java EE application server.
+
+WARNING: OC4J will be used as Java EE application server, but any other could be used with no problems.
+
+1) Create my_sparrow_test.rb file and require the gems
+
+  require 'rubygems'
+  require 'sparrow'
+
+2) Create and setup a sparrow JMS client
+
+  jms_client = Sparrow::JMS::Connection::Client.new do |properties|
+    properties.client_jar_file         = '/oc4j_extended_101330/j2ee/home/oc4jclient.jar'
+    properties.initial_context_factory = 'oracle.j2ee.naming.ApplicationClientInitialContextFactory'
+    properties.provider_url            = 'ormi://localhost:23791'
+    properties.security_principal      = 'oc4jadmin'
+    properties.security_credentials    = 'welcome'
+  end
+
+  jms_client.enable_connection_factories(
+      :queue_connection_factory => 'jms/MyQueueCF'
+    )
+    
+  jms_client.enable_queues(
+      :my_queue => 'jms/MyQueue'
+    )
+
+3) OK! You can send and receive messages right now!
+
+  jms_client.queue_sender(:my_queue).send_text_message('sparrow rocks!') do |msg|
+    msg.set_string_property('recipient', 'sparrow-example')
+  end
+
+  jms_client.queue_receiver(:my_queue).receive_message(
+      :timeout  => 5000,
+      :selector => "recipient = 'sparrow-example'"
+    ) do |msg|
+    
+    puts msg.is_text_message?    # true
+    puts msg.text                # sparrow rocks!
+  end
+
+So, now start the OC4J server, create the connection factory (jms/MyQueueCF) and queue (jms/MyQueue), and run above script:
+
+  jruby my_sparrow_test.rb
+
+sparrow rocks! =)
+
 == Copyright
 
 Copyright (c) 2009 Leandro Silva. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 0
 :major: 1
-:patch: 0
+:patch: 1

data/lib/connection.rb

@@ -7,8 +7,8 @@ module Sparrow
     module Connection
 
       #
-      # Configura��es necess�rias para que clientes JMS se conectem
-      # ao servidor de aplica��es Java EE via JNDI Context.
+      # Configuracoes necessarias para que clientes JMS se conectem
+      # ao servidor de aplicacoes Java EE via JNDI Context.
       #
       class Properties
         attr_accessor :client_jar_file,
@@ -16,7 +16,7 @@ module Sparrow
                       :security_principal, :security_credentials
         
         #
-        # Cria um Hashtable Java contendo as configura��es atuais.
+        # Cria um Hashtable Java contendo as configuracoes atuais.
         #
         def to_jndi_environment_hashtable
           jndi_env = Hashtable.new
@@ -37,10 +37,10 @@ module Sparrow
         end
         
         #
-        # Constroi um contexto JNDI inicial a partir das configura��es atuais.
+        # Constroi um contexto JNDI inicial a partir das configuracoes atuais.
         #
         def build_jndi_context
-            # Carrega a biblioteca cliente do servidor de aplica��es
+            # Carrega a biblioteca cliente do servidor de aplicacoes
             require @client_jar_file
             
             InitialContext.new(to_jndi_environment_hashtable)
@@ -48,8 +48,8 @@ module Sparrow
       end
     
       #
-      # Cliente JMS que possibilita a conex�o com o servidor de aplica��es Java EE
-      # que prov� o servi�o JMS.
+      # Cliente JMS que possibilita a conexao com o servidor de aplicacoes Java EE
+      # que prove o servico JMS.
       #
       class Client
         attr_reader :properties
@@ -65,7 +65,7 @@ module Sparrow
             raise ClientInitializationError.new(@properties, cause)
           end
           
-          # Conex�es, filas, t�picos, senders e receivers que ser�o habilitados
+          # Conexoes, filas, topicos, senders e receivers que serao habilitados
           @connection_factories = {}
           @queues               = {}
           @queue_senders        = {}

data/lib/jee.rb

@@ -1,14 +1,14 @@
-# Defini��o do diret�rios onde est�o as libs
+# Libs directory definition
 JEE_LIB_DIR = File.expand_path(File.dirname(__FILE__)) + '/jee'
 
-# Antes de qualquer outra, a fundamental
+# Befor all, the fundamental require for us
 require 'java'
 
-# Biblioteca essencial de integra��o com JMS
+# Lib to JMS integration (contain the META-INF/applicationContext.xml)
 require "#{JEE_LIB_DIR}/sparrow-essential.jar"
 
-#  Biblioteca Java EE principal
+#  Java EE
 require "#{JEE_LIB_DIR}/javaee-1.5.jar"
 
-# Biblioteca da API JMS
-require "#{JEE_LIB_DIR}/jms.jar"
+# JMS API
+require "#{JEE_LIB_DIR}/jms.jar"

data/lib/messaging.rb

@@ -3,21 +3,21 @@ import 'javax.jms.Session'
 import 'javax.jms.MessageListener'
 
 module Sparrow
-  module JMS
+  module JMSg
     module Messaging
 
       #
-      # Tempo padr�o de timeout no recebimento de mensagens = 1 milesegundo.
+      # Tempo padrao de timeout no recebimento de mensagens = 1 milesegundo.
       #
       DEFAULT_RECEIVER_TIMEOUT = 1000
     
       #
       # Classe base para mensageiros, que enviam ou recebem mensagens, tanto
-      # para filas ou t�picos.
+      # para filas ou topicos.
       #
       class Base
         def initialize(connection_factory, destination)
-          # F�brica de conex�es JMS
+          # Fabrica de conexoes JMS
           @connection_factory = connection_factory
 
           # Destino JMS para envio ou recebimento de mensagens
@@ -33,7 +33,6 @@ module Sparrow
           send_message do |session|
             text_message = session.create_text_message(text)
             
-            # Se houver uma bloco para tratamento da mensagem
             if block_given?
               yield(text_message)
             end
@@ -46,7 +45,6 @@ module Sparrow
           send_message do |session|
             object_message = session.create_object_message(object)
             
-            # Se houver uma bloco para tratamento da mensagem
             if block_given?
               yield(object_message)
             end
@@ -59,7 +57,6 @@ module Sparrow
           send_message do |session|
             map_message = session.create_map_message
             
-            # Se houver uma bloco para tratamento da mensagem
             if block_given?
               yield(map_message)
             end
@@ -69,15 +66,15 @@ module Sparrow
         end
         
         def send_messages(&message_sender)
-          # Cria uma conex�o, uma sess�o e um emissor de qualquer tipo de mensagem
+          # Cria uma conexao, uma sessao e um emissor de qualquer tipo de mensagem
           connection = @connection_factory.create_connection
           session    = connection.create_session(true, Session::AUTO_ACKNOWLEDGE)
           producer   = session.create_producer(@destination)
           
-          # Passa o controle que trata a emiss�o de mensagens
+          # Passa o controle que trata a emissao de mensagens
           message_sender.call(session, producer)
 
-          # Fecha a conex�o
+          # Fecha a conexao
           connection.close
         end
         
@@ -85,7 +82,7 @@ module Sparrow
         private
         
         def send_message(&message_creator)
-          # Cria uma conex�o, uma sess�o e um emissor de qualquer tipo de mensagem
+          # Cria uma conexao, uma sessao e um emissor de qualquer tipo de mensagem
           connection = @connection_factory.create_connection
           session    = connection.create_session(true, Session::AUTO_ACKNOWLEDGE)
           producer   = session.create_producer(@destination)
@@ -96,7 +93,7 @@ module Sparrow
           # Envia a mensagem
           producer.send(message)
           
-          # Commita a sess�o e fecha a conex�o
+          # Commita a sessao e fecha a conexao
           session.commit
           connection.close
         end
@@ -107,19 +104,19 @@ module Sparrow
       #
       class Receiver < Base    
         def receive_message(criteria_for_receiving = {:timeout => DEFAULT_RECEIVER_TIMEOUT, :selector => ''}, &message_handler)
-          # Cria uma conex�o, uma sess�o e um consumidor de qualquer tipo de mensagem
+          # 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 conex�o para receber mensagens
+          # Prepara a conexao para receber mensagens
           connection.start
           
           # Inicia o recebimento de mensagens
           timeout = criteria_for_receiving[:timeout] || DEFAULT_RECEIVER_TIMEOUT
           
           while (received_message = consumer.receive(timeout))
-            # Inclui o modulo de identifica��o de mensagem, util para o message_handler
+            # Inclui o modulo de identificacao de mensagem, util para o message_handler
             class << received_message
               include MessageType
             end
@@ -128,7 +125,7 @@ module Sparrow
             message_handler.call(received_message)
           end
           
-          # Fecha a conex�o
+          # Fecha a conexao
           connection.close
         end
       end
@@ -136,7 +133,7 @@ module Sparrow
       #
       # Ouvintes de mensagens.
       #
-      # TODO: Completar a implementa��o. Ainda n�o est� legal.
+      # TODO: Completar a implementacao. Ainda nao esta legal.
       #
       class Listener < Base
         include MessageListener
@@ -146,12 +143,12 @@ module Sparrow
         end
         
         def criteria_for_receiving(criteria = {:timeout => DEFAULT_RECEIVER_TIMEOUT, :selector => ''})
-          # Valor default para timeout, caso n�o tenha sido informado
+          # Valor default para timeout, caso nao tenha sido informado
           @criteria_for_receiving[:timeout] = criteria[:timeout] || DEFAULT_RECEIVER_TIMEOUT
         end
         
         #
-        # Nome pelo qual este listener ser� conhecido.
+        # Nome pelo qual este listener sera conhecido.
         #
         # Invariavelmente deve ser re-implementado nas subclasses.
         #
@@ -160,7 +157,7 @@ module Sparrow
         end
         
         #
-        # Destino JMS que ser� escutado.
+        # Destino JMS que sera escutado.
         #
         # Invariavelmente deve ser re-implementado nas subclasses.
         #
@@ -172,7 +169,7 @@ module Sparrow
         # Inicia a escuta de mensagens.
         #
         def start_listening
-          # Cria uma conex�o, uma sess�o e um consumidor de qualquer tipo de mensagem
+          # 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])
@@ -180,15 +177,15 @@ module Sparrow
           # Registra-se como ouvinte
           consumer.message_listener = self
           
-          # inicia a escuta de mensagens
+          # Inicia a escuta de mensagens
           connection.start
         end
         
         #
-        # Faz o enriquecimento do objeto mensagem e delega para o m�todo on_receive_message
+        # Faz o enriquecimento do objeto mensagem e delega para o metodo on_receive_message
         # que, implementado pelas subclasses, efetivamente trata a mensagem.
         #
-        # N�o deve ser re-implementado por subclasses.
+        # Nao deve ser re-implementado por subclasses.
         #
         def on_message(received_message)
           class << received_message
@@ -199,8 +196,8 @@ module Sparrow
         end
         
         #
-        # � executado todas as vezes que chega uma mensagem que atenda aos crit�rios
-        # definido para este listener (na vari�vel de inst�ncia @criteria).
+        # E executado todas as vezes que chega uma mensagem que atenda aos criterios
+        # definido para este listener (na variavel de instancia @criteria).
         #
         # Invariavelmente deve ser re-implementado nas subclasses.
         #
@@ -227,4 +224,4 @@ module Sparrow
       end
     end
   end
-end
+end

data/lib/sparrow.rb

@@ -1,6 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(File.expand_path(__FILE__)))
 
-# Bibliotecas Java necessárias
+# Bibliotecas Java necessarias
 require 'jee.rb'
 
 # Bibliotecas sparrow

data/spec/connection_spec.rb

@@ -1,9 +1,9 @@
 require File.dirname(File.expand_path(__FILE__)) + '/spec_helper.rb'
 
 #
-# Cen�rio de configura��o do cliente JMS, quando s�o informadas as propriedades de ambiente
-# para conex�o com o servidor de aplica��es e a inicializa��o do contexto JNDI inicial,
-# onde est�o criadas as connection factories, queues e topics.
+# Cenario de configuracao do cliente JMS, quando sao informadas as propriedades de ambiente
+# para conexao com o servidor de aplicacoes e a inicializacao do contexto JNDI inicial,
+# onde estao criadas as connection factories, queues e topics.
 #
 describe Sparrow::JMS::Connection::Client, ', quando esta sendo configurado,' do
 
@@ -45,8 +45,8 @@ describe Sparrow::JMS::Connection::Client, ', quando esta sendo configurado,' do
 end
 
 #
-# Cen�rio p�s-configura��o do cliente JMS, quando as queues e os t�picos j� devem estar
-# dispon�veis, e ent�o � poss�vel obter sender/receiver para elas.
+# Cenario pos-configuracao do cliente JMS, quando as queues e os topicos ja devem estar
+# disponiveis, e entao e possivel obter sender/receiver para elas.
 #
 describe Sparrow::JMS::Connection::Client, ', depois de ter sido configurado,' do
 

data/spec/messaging_spec.rb

@@ -1,8 +1,8 @@
 require File.dirname(File.expand_path(__FILE__)) + '/spec_helper.rb'
 
 #
-# Cen�rio p�s-obten��o de um Sender e um Receiver, quando deve ser poss�vel enviar e
-# receber mensagens de tr�s tipos (Texto, Objeto e Mapa) de uma queue especifica,
+# Cenario pos-obtencao de um Sender e um Receiver, quando deve ser possivel enviar e
+# receber mensagens de tres tipos (Texto, Objeto e Mapa) de uma queue especifica,
 # individualmente ou em lote.
 #
 describe Sparrow::JMS::Messaging, ', quando tem um Sender e um Receiver para uma Queue especifica,' do
@@ -89,7 +89,7 @@ describe Sparrow::JMS::Messaging, ', quando tem um Sender e um Receiver para uma
       map_message.set_long('id', my_id_long)
       producer.send(map_message)
       
-      # Commita as tr�s mensagens enviadas na sess�o
+      # Commita as tres mensagens enviadas na sessao
       session.commit
     end
     
@@ -118,8 +118,8 @@ describe Sparrow::JMS::Messaging, ', quando tem um Sender e um Receiver para uma
 end
 
 #
-# Cen�rio p�s-configura��o do cliente JMS, quando deve ser poss�vel escutar mensagens
-# atrav�s de objetos listeners.
+# Cenario pos-configuracao do cliente JMS, quando deve ser possivel escutar mensagens
+# atraves de objetos listeners.
 #
 describe Sparrow::JMS::Messaging::Listener,
          ', quando um Listener se registra para escutar uma Queue especifica,' do
@@ -129,4 +129,4 @@ describe Sparrow::JMS::Messaging::Listener,
   end
   
   it 'deveria possibilitar escutar mensagens atraves de um listener'
-end
+end

data/spec/spec_helper.rb

@@ -4,12 +4,15 @@ require 'spec'
 require File.dirname(File.expand_path(__FILE__)) + '/../lib/sparrow.rb'
 
 #
-# M�dulo com m�todos uteis para as propertiess.
+# Modulo com metodos uteis para as propertiess.
 #
 module SparrowHelperMethods
 
   #
-  # Apenas cria, mas n�o faz o setup do cliente JMS.
+  # Apenas cria, mas nao faz o setup do cliente JMS.
+  #
+  # WARNING: OC4J will be used as Java EE application server, but any other could
+  # be used with no problems.
   #
   def create_jms_client
     jms_client = Sparrow::JMS::Connection::Client.new do |properties|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: leandrosilva-sparrow
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Leandro Silva
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-07 00:00:00 -08:00
+date: 2009-03-08 00:00:00 -08:00
 default_executable: 
 dependencies: []