a13g 0.1.0.beta3 → 0.1.0.beta4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+require File.join(File.dirname(__FILE__), 'lib/a13g/version')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "a13g"
+    gem.version = A13g::VERSION::STRING
+    gem.summary = "Event-driven architecture for your applications"
+    gem.description = <<-DESCR
+A13g allows you to use event-driven architecture in your applications It can be
+used for enterprise integration with frameworks like JMS and products 
+such as ActiveMQ. 
+    DESCR
+    gem.email = "kriss.kowalik@gmail.com"
+    gem.homepage = "http://github.com/kriss/a13g"
+    gem.authors = ["Kriss Kowalik"]
+    gem.add_dependency "activesupport", ">= 2.0.0"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/a13g.gemspec

@@ -0,0 +1,100 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{a13g}
+  s.version = "0.1.0.beta4"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kriss Kowalik"]
+  s.date = %q{2010-07-26}
+  s.description = %q{A13g allows you to use event-driven architecture in your applications It can be
+used for enterprise integration with frameworks like JMS and products 
+such as ActiveMQ. 
+}
+  s.email = %q{kriss.kowalik@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "a13g-0.1.0.beta3.gem",
+     "a13g.gemspec",
+     "examples/consumer.rb",
+     "examples/multiple_connections.rb",
+     "examples/producer.rb",
+     "examples/simple_project/README",
+     "examples/simple_project/Rakefile",
+     "examples/simple_project/config/broker.yml",
+     "examples/simple_project/lib/consumers/first_consumer.rb",
+     "examples/simple_project/lib/consumers/second_consumer.rb",
+     "examples/simple_project/lib/simple_project.rb",
+     "lib/a13g.rb",
+     "lib/a13g/adapters.rb",
+     "lib/a13g/adapters/abstract_adapter.rb",
+     "lib/a13g/adapters/stomp_adapter.rb",
+     "lib/a13g/adapters/test_adapter.rb",
+     "lib/a13g/base.rb",
+     "lib/a13g/command.rb",
+     "lib/a13g/consumer.rb",
+     "lib/a13g/destination.rb",
+     "lib/a13g/errors.rb",
+     "lib/a13g/listener.rb",
+     "lib/a13g/message.rb",
+     "lib/a13g/producer.rb",
+     "lib/a13g/railtie.rb",
+     "lib/a13g/recipes.rb",
+     "lib/a13g/subscription.rb",
+     "lib/a13g/support/logger.rb",
+     "lib/a13g/support/utils.rb",
+     "lib/a13g/utils.rb",
+     "lib/a13g/version.rb",
+     "spec/a13g_spec.rb",
+     "spec/config/broker.yml",
+     "spec/dconfig/broker.yml",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kriss/a13g}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Event-driven architecture for your applications}
+  s.test_files = [
+    "spec/a13g_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/consumer.rb",
+     "examples/multiple_connections.rb",
+     "examples/simple_project/lib/consumers/second_consumer.rb",
+     "examples/simple_project/lib/consumers/first_consumer.rb",
+     "examples/simple_project/lib/simple_project.rb",
+     "examples/producer.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.0.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.0.0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.0.0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/examples/consumer.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+#require 'a13g'
+require File.dirname(__FILE__)+'/../lib/a13g'
+
+A13g.setup(:default, :adapter => 'stomp') # localhost:61613
+
+class MyConsumer < A13g::Consumer
+  subscribe "/queue/Example", :ack => :client
+  
+  def on_message(message)
+    puts message.body
+    message.ack!  
+  end
+end
+
+A13g.listen!

data/examples/multiple_connections.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+#require 'a13g'
+require File.dirname(__FILE__)+'/../lib/a13g'
+
+A13g.setup(:default, :adapter => 'stomp', :host => 'first.example.com')
+A13g.setup(:second, :adapter => 'stomp', :host => 'second.example.com')
+
+class FirstConsumer < A13g::Consumer
+  subscribe "/queue/First"
+  
+  def on_message(message)
+    # will send message using `:second` connection. 
+    publish "/queue/Second", message.body, {}, :second  
+  end
+end
+
+class SecondConsumer < A13g::Consumer
+  context :second
+  subscribe "/queue/Second"
+  
+  def on_message(message)
+    puts message.body
+  end
+end
+
+A13g.listen!

data/examples/producer.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+#require 'a13g'
+require File.dirname(__FILE__)+'/../lib/a13g'
+
+A13g.setup(:default, :adapter => 'stomp') # localhost:61613
+
+include A13g::Producer
+
+publish "/queue/Example", "My first message"
+publish "/topic/Example", "My second message..."
+

data/examples/simple_project/README

@@ -0,0 +1,3 @@
+You can run project using rake command:
+
+  rake start

data/examples/simple_project/Rakefile

@@ -0,0 +1,6 @@
+require 'rake'
+
+desc 'Run example'
+task :start do 
+  require File.join(File.dirname(__FILE__), 'lib', 'simple_project')
+end

data/examples/simple_project/config/broker.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: stomp
+  host: localhost
+  
+production:
+  adapter: stomp
+  host: localhost
+  
+test:
+  adapter: test

data/examples/simple_project/lib/consumers/first_consumer.rb

@@ -0,0 +1,7 @@
+class FirstConsumer < A13g::Consumer
+  subscribe "/queue/First"
+  
+  def on_message(message)
+    publish "/queue/Second", message.body, {}, :second  
+  end
+end

data/examples/simple_project/lib/consumers/second_consumer.rb

@@ -0,0 +1,9 @@
+class SecondConsumer < A13g::Consumer
+  context :second
+  subscribe "/queue/Second"
+  
+  def on_message(message)
+    puts message.body
+  end
+end
+

data/examples/simple_project/lib/simple_project.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+#require 'a13g'
+require File.dirname(__FILE__)+'/../../../../lib/a13g'
+
+ROOT_PATH = File.dirname(__FILE__)
+
+# By default directories structure is fit to rails application, that is:
+#
+#   log:       ROOT_PATH/log/messaging.log
+#   config:    ROOT_PATH/config/broker.yml
+#   consumers: ROOT_PATH/app/consumers/
+#  
+A13g.path.log       = '/var/log/a13g_example.log'
+A13g.path.config    = File.join(ROOT_PATH, '../config/broker.yml')
+A13g.path.consumers = File.join(ROOT_PATH, 'consumers')
+
+A13g.setup(:default)
+A13g.setup(:second, :adapter => 'stomp', :host => 'localhost')
+
+A13g.listen!

data/lib/a13g.rb

@@ -0,0 +1,68 @@
+$:.unshift(File.dirname(__FILE__))
+
+unless defined?(ActiveSupport)
+  require 'active_support'
+end
+
+require 'a13g/version'
+require 'a13g/errors'
+
+module A13g
+  autoload :Base, 'a13g/base'
+  autoload :Producer, 'a13g/producer'
+  autoload :Message, 'a13g/message'  
+  autoload :Destination, 'a13g/destination'
+  autoload :Utils, 'a13g/support/utils'
+  autoload :Consumer, 'a13g/consumer'
+  autoload :Producer, 'a13g/producer'
+  autoload :Subscription, 'a13g/subscription'
+  autoload :Listener, 'a13g/listener'
+  autoload :Logger, 'a13g/support/logger'
+  autoload :Adapters, 'a13g/adapters'
+  autoload :AbstractAdapter, "a13g/adapters/abstract_adapter"
+    
+  autoload :MessagingError, 'a13g/errors'
+  autoload :MissingDefaultContext, 'a13g/errors'
+  autoload :ConnectionNotEstablished, 'a13g/errors'
+  autoload :NoDestinationError, 'a13g/errors'
+  autoload :AdapterNotSpecified, 'a13g/errors'
+  autoload :AdapterNotFound, 'a13g/errors'
+  autoload :ConfigurationFileNotFound, 'a13g/errors'
+  autoload :StopProcessing, 'a13g/errors'
+  autoload :AbortMessage, 'a13g/errors'
+  autoload :IgnoreMessage, 'a13g/errors'
+  autoload :DestinationAlreadyDefined, 'a13g/errors'
+  autoload :DestinationNotDefinedError, 'a13g/errors'
+  autoload :DestinationAlreadySubscribedError, 'a13g/errors'
+  autoload :TooManySubscriptionsError, 'a13g/errors'
+  autoload :ContextAlreadyDefinedError, 'a13g/errors'
+    
+  def self.method_missing(meth, *args, &block)
+    if Base.respond_to?(meth)
+      Base.send(meth, *args, &block)
+    else
+      super
+    end
+  end  
+    
+  # @see A13g::Listener#start
+  # @api public
+  def self.listen!
+    Listener.start!
+  end
+  
+  # Current version.
+  #
+  # @api public
+  def self.version
+    VERSION::STRING
+  end
+  
+  extend Producer
+    
+  module ConnectionAdapters
+    autoload :BrokerStatements, "a13g/connection_adapters/abstract/broker_statements"
+    autoload :ConnectionSpecification, "a13g/connection_adapters/abstract/connection_specification"
+    autoload :ConnectionPool, "a13g/connection_adapters/abstract/connection_pool"
+  end
+end

data/lib/a13g/adapters.rb

@@ -0,0 +1,45 @@
+module A13g
+  module Adapters
+    # Register new adapter. 
+    #
+    # @param [String, Symbol] name
+    #   name of adapter
+    # @param [Class] klass
+    #   adapter class
+    #
+    # @api public
+    def self.register(name, klass)
+      available_adapters[name.to_s] = klass
+    end
+  
+    # Loads specified adapter from rubygems or directly from A13g. 
+    #
+    # @param [String] name
+    #   adapter to load
+    #
+    # @api public
+    def self.load(name)
+      unless available_adapters[name.to_s]
+        begin
+          require "a13g-#{name}-adapter"
+        rescue LoadError
+          begin
+            require File.join(File.dirname(__FILE__), "adapters/#{name}_adapter.rb")
+          rescue LoadError
+            raise AdapterNotFound, "Adapter `#{name}` not is not defned"
+          end
+        end
+      end
+      available_adapters[name.to_s]
+    end
+    
+    # List of available connection adapters. 
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def self.available_adapters
+      @available_adapters ||= {}
+    end
+  end
+end

data/lib/a13g/adapters/abstract_adapter.rb

@@ -0,0 +1,330 @@
+module A13g
+  module Adapters
+    # Base class for adapters. All connection adapters should inherit from this one.   
+    #   
+    # === Writing own adapter
+    # 
+    # When you write some new connection adapter, you should use following 
+    # code as base:
+    # 
+    #   module A13g
+    #     module Adapters
+    #       class HumptyDumptyAdapter < AbstractAdapter
+    #         register(:humpty_dumpty) # register new adapter as `humpty_dumpty`
+    #
+    #         # Your adapter code...
+    #       end
+    #     end
+    #   end
+    class AbstractAdapter
+      include ActiveSupport::Callbacks
+    
+      attr_reader :logger, :config
+      attr_reader :subscriptions, :transactions
+      attr_reader :last_published_message
+      attr_reader :last_received_message, :last_unreceived_message
+      
+      define_callbacks :after_subscribe, :after_unsubscribe, :after_publish, 
+        :after_receive, :after_unreceive, :after_abort_transaction, 
+        :after_begin_transaction, :after_commit_transaction, :after_ack
+      
+      after_subscribe do |obj, destination, headers, sub_id|
+        sub_id ||= destination.to_s
+        obj.subscriptions[sub_id] = OpenStruct.new(
+          :destination => destination.to_s,
+          :headers     => headers
+          )
+      end
+      
+      after_unsubscribe do |obj, destination, headers, sub_id|
+        sub_id ||= destination.to_s
+        obj.subscriptions.delete(sub_id)
+      end
+      
+      after_publish do |obj, destination, message, headers|
+        msg = OpenStruct.new(
+          :destination => destination, 
+          :message     => message, 
+          :headers     => headers
+          )
+        obj.instance_variable_set('@last_published_message', msg)
+      end
+      
+      after_receive do |obj, message|
+        obj.instance_variable_set('@last_received_message', message)
+      end
+      
+      after_unreceive do |obj, message|
+        msg = message.clone
+        msg.headers.merge!(defaults)
+        obj.instance_variable_set('@last_unreceived_message', msg)
+      end
+      
+      after_begin_transaction do |obj, name, headers|
+        obj.transactions[name] = OpenStruct.new(
+          :name    => name, 
+          :headers => headers
+          )
+      end
+      
+      after_abort_transaction do |obj, name, headers|
+        obj.transactions.delete(name)
+      end
+      
+      after_commit_transaction do |obj, name, headers|
+        obj.transactions.delete(name)
+      end
+
+      after_ack do |obj, message, headers|
+        message.ack = true if message.respond_to?(:ack=)
+      end
+        
+      # Little bit changed running callbacks. It allows to pass more than one 
+      # parameter to block. 
+      #
+      # @api public
+      def run_callbacks(kind, params=[], options = {}, &block)
+        params.unshift(self)
+        self.class.send("#{kind}_callback_chain").run(params, options, &block)
+      end      
+      
+      # Constructor.
+      #
+      # @param [Hash] config
+      #   connection configuration
+      #
+      # @param [Logger] logger
+      #   default logger
+      #
+      # @api public
+      def initialize(config, logger)
+        @config = config.freeze
+        @logger = logger
+        @runtime = 0
+        @last_verification = 0
+        @subscriptions = {}
+        @transactions = {}
+      end
+      
+      # Connection url. 
+      #
+      # @api public
+      def url 
+        "#{@config[:host]}:#{@config[:port]}" if @config
+      end
+
+      # @api public
+      def adapter_name
+        'Abstract'.freeze
+      end
+      
+      # @api public
+      def reset_runtime
+        rt, @runtime = @runtime, 0
+        rt
+      end
+
+      # Akcnowledge for specified message.
+      #
+      # @param [A13g::Message] message
+      #   message to acknowledge
+      #
+      # @param [Hash] headers
+      #   acknowledgement headers
+      # 
+      # @param [Array] args
+      #   additional arguments
+      #
+      # @api public
+      def ack(message, headers={}, *args)
+        raise NotImplementedError, "#{self.class}#ack not implemented" 
+      end
+      alias_method :acknowledge, :ack
+      
+      # Begin transaction. 
+      #
+      # @param [String] name
+      #   transaction id
+      # 
+      # @param [Hash] headers
+      #   transaction headers
+      # 
+      # @param [Array] args
+      #   additional arguments
+      #
+      # @api public
+      def begin(name, headers={}, *args)
+        raise NotImplementedError, "#{self.class}#begin not implemented"
+      end
+      
+      # Commit transaction. Parameters the same as #begin method. 
+      # 
+      # @see A13g::Adapters::AbstractAdapter#begin
+      #
+      # @api public
+      def commit(name, headers={}, *args)
+        raise NotImplementedError, "#{self.class}#commit not implemented"
+      end
+      
+      # Abort transaction. Parameters the same as #begin method. 
+      # 
+      # @see A13g::Adapters::AbstractAdapter#begin
+      #
+      # @api public
+      def abort(name, headers={}, *args)
+        raise NotImplementedError, "#{self.class}#abort not implemented"
+      end
+      
+      # Subscribe specified queue/topic.
+      #
+      # @param [String] destination
+      #   destination to subscribe
+      #
+      # @param [Hash] headers
+      #   subscription headers
+      #
+      # @param [Array] args
+      #   additional arguments
+      #
+      # @api public
+      def subsrcibe(destination, headers={}, *args)
+        raise NotImplementedError, "#{self.class}#subsrcibe not implemented"
+      end
+      
+      # Unsubscribe specified queue/topic. Params the same as #subscription method. 
+      #
+      # @see A13g::Adapters::AbstractAdapter#subscription
+      #
+      # @api public
+      def unsubscribe(destination, headers={}, *args)
+        raise NotImplementedError, "#{self.class}#unsubscribe not implemented"
+      end
+      
+      # Publish message to specified destination. 
+      #
+      # @param [String] destination
+      #   destination name
+      #
+      # @param [String] message
+      #   text to send
+      #
+      # @param [Hash] headers
+      #   message headers
+      #
+      # @param [Array] args
+      #   additional arguments
+      #
+      # @api public
+      def publish(destination, message, headers={}, *args)
+        raise NotImplementedError, "#{self.class}#publish not implemented"
+      end
+      
+      # Set message as unreceived. Parameters the same as #ack method. 
+      # 
+      # @see A13g::Adapters::AbstractAdapter#ack
+      #
+      # @api public
+      def unreceive(message, headers={}, *args)
+        raise NotImplementedError, "#{self.class}#unreceive not implemented"
+      end
+      
+      # Check message acknowledgement. 
+      #
+      # @param [A13g::Message] message
+      #   received message
+      #
+      # @param [Array] args
+      #   additional arguments
+      #
+      # @api public
+      def client_ack?(message, *args)
+        raise NotImplementedError, "#{self.class}#client_ack? not implemented"
+      end
+      
+      # Receive messages from subscribed queues. 
+      #
+      # @param [Array] args
+      #   additional arguments
+      #
+      # @return [A13g::Message] 
+      #   received message
+      #
+      # @api public
+      def receive(*args)
+        raise NotImplementedError, "#{self.class}#receive not implemented"
+      end
+
+      # Checks whether the connection to the database is still active. This includes
+      # checking whether the database is actually capable of responding, i.e. whether
+      # the connection isn't stale.
+      #
+      # @return [Boolean] 
+      #   is connection active?
+      #
+      # @api public
+      def active?
+        @active != false
+      end
+      
+      # Disconnects from the broker if already connected, and establishes a
+      # new connection with the broker.
+      #
+      # @api public
+      def reconnect!
+        @active = true
+      end
+      
+      # Disconnects from the broker if already connected. Otherwise, this
+      # method does nothing.
+      #
+      # @api public
+      def disconnect!
+        @active = false
+      end
+      
+      # Reset the state of this connection.
+      #
+      # The default implementation does nothing; the implementation should be
+      # overridden by concrete adapters.
+      #
+      # @api public
+      def reset!
+        # this should be overridden by concrete adapters
+      end
+      
+      # Returns `true` if its safe to reload the connection between requests for development mode.
+      #
+      # @return [Boolean] 
+      #
+      # @api public
+      def requires_reloading?
+        false
+      end
+      
+      # Checks whether the connection to the broker is still active (i.e. not stale).
+      # This is done under the hood by calling <tt>active?</tt>. If the connection
+      # is no longer active, then this method will reconnect to the broker.
+      #
+      # @api public
+      def verify!(*ignored)
+        unless active?
+          logger.error("*** No active connection with broker at #{url}. Trying to reconnect...")
+          reconnect!
+        end 
+      end
+      
+      protected
+      
+      # Provides access to the underlying broker driver for this adapter.
+      #
+      # @return [Object] 
+      #   direct connection object
+      #
+      # @api semipublic
+      def raw_connection
+        verify!   
+        @connection
+      end
+    end
+  end
+end