jsparrow 1.1.3 → 1.1.4

data/README.rdoc

@@ -2,7 +2,7 @@
 
 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.
+I'm sorry but any time I break backward compatibility. However, always is for make a better API.
 
 === Install
 
@@ -38,7 +38,7 @@ WARNING: OpenJMS will be used as JMS provider, but any other could be used with
 
 3) Create the client and start it
 
-  jms_client = JSparrow::Connection.new_client
+  jms_client = new_jsparrow_client
   jms_client.start
 
 4) OK! Now you can send and receive messages right now!
@@ -78,7 +78,7 @@ Or, if you don't want write code, only do it:
 
 For more informations, read the specs! ;)
 
-http://github.com/leandrosilva/jsparrow/tree/master/spec/
+http://github.com/leandrosilva/jsparrow/tree/master/spec
 
 == Copyright
 

data/Rakefile

@@ -45,5 +45,10 @@ rescue LoadError
   end
 end
 
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new do |spec|
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = %w(-fs --color)
+end
 
 task :default => :test

data/VERSION.yml

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

data/lib/connection.rb

@@ -1,253 +1,5 @@
-# Classes Java usadas nesse arquivo
 import 'java.util.Hashtable'
 import 'javax.naming.InitialContext'
 
-module JSparrow
-  module Connection
-
-    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
-
-      #
-      # 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
-    
-      #
-      # 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
-    
-      #
-      # 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
-    
-      #
-      # 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
-
-    #
-    # Classe base para estabelecer conexao com o provedor JMS via JNDI. 
-    #
-    class Base
-      attr_reader :configuration
-      
-      def initialize(configuration, jndi_context_builder)
-        @configuration        = configuration
-        @jndi_context_builder = jndi_context_builder
-
-        # Foi estabelecida?
-        @opened = false
-      end
-      
-      def is_opened?
-        @opened
-      end
-      
-      def open
-        raise InvalidStateError.new('opened', 'open') if is_opened?
-    
-        begin
-          @jndi_context = @jndi_context_builder.build
-        rescue => cause
-          raise InitializationError.new(@configuration, cause)
-        end
-        
-        @opened = true
-      end
-      
-      def is_closed?
-        not @opened
-      end
-
-      def close
-        raise InvalidStateError.new('closed', 'close') if is_closed?
-    
-        @jndi_context.close
-    
-        @opened = false  
-      end
-
-      def lookup_resources(resources = {})
-        lookuped_resource = {}
-
-        return lookuped_resource unless resources
-    
-        resources.each do |name, jndi_name|
-          lookuped_resource[name] = lookup_resource(jndi_name)
-        end
-
-        lookuped_resource
-      end
-      
-      def lookup_resource(jndi_name)
-        @jndi_context.lookup(jndi_name)
-      end
-    end
-
-    #
-    # Configuracoes necessarias para que clientes JMS se conetem
-    # ao provedor de mensageria via contexto JNDI.
-    #
-    class Configuration
-      attr_accessor :jms_client_jar, :jndi_properties,
-                    :enabled_connection_factories, :enabled_queues, :enabled_topics
-    end
-
-    #
-    # Erro para quando uma conexao esta num estado invalido para uma operacao (open ou close).
-    #
-    class InvalidStateError < StandardError
-      attr_reader :state, :operation
-
-      def initialize(state, operation)
-        super("Could not did #{operation} because connection is #{state}.")
-
-        @state     = state
-        @operation = operation
-      end
-    end
-
-    #
-    # Erro para quando nao for possivel estabelecer conexao com o provedor JMS.
-    #
-    class InitializationError < StandardError
-      attr_reader :configuration, :cause
-
-      def initialize(configuration, cause)
-        super("Could not open connection to JMS provider. Verify the config's config.")
-
-        @configuration = configuration
-        @cause         = cause
-      end
-    end
-  end
-  
-  module JNDI
-    
-    #
-    # Builder para construcao de contexto JNDI para conexao com o provedor
-    # de JMS.
-    #
-    class ContextBuilder
-      attr_accessor :jms_client_jar, :jndi_properties
-      
-      def initialize(jms_client_jar, jndi_properties)
-        @jms_client_jar  = jms_client_jar
-        @jndi_properties = jndi_properties
-      end
-      
-      #
-      # Constroi um contexto JNDI inicial a partir das configuracoes atuais.
-      #
-      def build
-          # Carrega a biblioteca cliente do servidor de aplicacoes
-          require @jms_client_jar
-          
-          InitialContext.new(to_jndi_environment_hashtable)
-      end
-
-      # --- Private methods --- #
-      private
-
-        #
-        # Cria um Hashtable Java contendo as configuracoes atuais.
-        #
-        def to_jndi_environment_hashtable
-          jndi_env = Hashtable.new
-        
-          jndi_env.put(
-            InitialContext::INITIAL_CONTEXT_FACTORY,
-            @jndi_properties[:initial_context_factory])
-            
-          jndi_env.put(
-            InitialContext::PROVIDER_URL,
-            @jndi_properties[:provider_url])
-            
-          jndi_env.put(
-            InitialContext::SECURITY_PRINCIPAL,
-            @jndi_properties[:security_principal]) if @jndi_properties[:security_principal]
-            
-          jndi_env.put(
-            InitialContext::SECURITY_CREDENTIALS,
-            @jndi_properties[:security_credentials]) if @jndi_properties[:security_credentials]
-        
-          jndi_env
-        end
-    end
-  end
-end
+require 'connection/configuration'
+require 'connection/provider'

data/lib/connection/configuration.rb

@@ -0,0 +1,88 @@
+module JSparrow
+  module Connection
+
+    #
+    # Connection configuration to connect the JMS provider.
+    #
+    class Configuration
+      attr_accessor :jms_client_jar, :jndi_properties,
+                    :enabled_connection_factories, :enabled_queues, :enabled_topics
+    end
+  
+    #
+    # Class methods to configure the connection with the JMS provider.
+    #
+    class << self
+
+      def configure(&block)
+        @@configuration = Configuration.new
+      
+        class_eval(&block)
+      
+        @@configuration
+      end
+  
+      def configuration
+        @@configuration
+      end
+
+      #
+      # Example:
+      #
+      # use_jms_client_jar "path/to/name_of_the_client_jar_file.jar"
+      #
+      def use_jms_client_jar(jms_client_jar)
+        configuration.jms_client_jar = jms_client_jar
+      end
+  
+      #
+      # Example:
+      #
+      #   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
+  
+      #
+      # Example:
+      #
+      #   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
+  
+      #
+      # Example:
+      #
+      #   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
+  
+      #
+      # Example:
+      #
+      #   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
+    end
+    
+    #
+    # Factory method.
+    #
+    def self.new
+      jndi_context_builder = JNDI::ContextBuilder.new(configuration.jms_client_jar, configuration.jndi_properties)
+  
+      connection = Provider.new(configuration, jndi_context_builder)
+    end
+  end
+end

data/lib/connection/provider.rb

@@ -0,0 +1,91 @@
+module JSparrow
+  module Connection
+    
+    #
+    # Class for establish connection with JMS provider throught JNDI. 
+    #
+    class Provider
+      attr_reader :configuration
+    
+      def initialize(configuration, jndi_context_builder)
+        @configuration        = configuration
+        @jndi_context_builder = jndi_context_builder
+
+        # Foi estabelecida?
+        @opened = false
+      end
+    
+      def is_opened?
+        @opened
+      end
+    
+      def open
+        raise InvalidStateError.new('opened', 'open') if is_opened?
+  
+        begin
+          @jndi_context = @jndi_context_builder.build
+        rescue => cause
+          raise InitializationError.new(@configuration, cause)
+        end
+      
+        @opened = true
+      end
+    
+      def is_closed?
+        not @opened
+      end
+
+      def close
+        raise InvalidStateError.new('closed', 'close') if is_closed?
+  
+        @jndi_context.close
+  
+        @opened = false  
+      end
+
+      def lookup_resources(resources = {})
+        lookuped_resource = {}
+
+        return lookuped_resource unless resources
+  
+        resources.each do |name, jndi_name|
+          lookuped_resource[name] = lookup_resource(jndi_name)
+        end
+
+        lookuped_resource
+      end
+    
+      def lookup_resource(jndi_name)
+        @jndi_context.lookup(jndi_name)
+      end
+    end
+
+    #
+    # Error to signal invalid state on open or close operation.
+    #
+    class InvalidStateError < StandardError
+      attr_reader :state, :operation
+
+      def initialize(state, operation)
+        super("Could not did #{operation} because connection is #{state}.")
+
+        @state     = state
+        @operation = operation
+      end
+    end
+
+    #
+    # Error to signal impossibility to connect the JMS provider.
+    #
+    class InitializationError < StandardError
+      attr_reader :configuration, :cause
+
+      def initialize(configuration, cause)
+        super("Could not open connection to JMS provider. Verify the config's config.")
+
+        @configuration = configuration
+        @cause         = cause
+      end
+    end
+  end
+end