banter 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d0f8fa6fb6efcc9befadeaac184560b989606f3
-  data.tar.gz: 55445f64eb387bacb905718ba61284d272d72db7
+  metadata.gz: aaa823c8ce67b181474196407a8f92bab5c396ab
+  data.tar.gz: 0a3a05c26ce018f3b4c19a9c849d2cb353c26991
 SHA512:
-  metadata.gz: 820d17a44fdb4b450f0d982c689ccc16883d589208c990db1b9e7279109876e55585c11404dc5dccf1839e823fe513ef59575c37d010784ec6f3f529e2195b6a
-  data.tar.gz: 5e74cca350d83ac11c6a8e32ca4fb771d931593616839b5086f4f25118a48d5e3a6f663dd7b3aea6833a7c3910b029687bca1c75afe8eb6850a9da57f7f1a209
+  metadata.gz: 78049fb9a4a98e41e8fe0e8f09bf40ec192529ea0fa79d76a84d9664ac9c529fc1f30e281cb7b464f732ce084f39d399b4c1eb1a2d9586a0a44878ef73d98724
+  data.tar.gz: 961168e99870c9cde24af76a2cea4182eacff90235d990ba046d61cbd561da4df8205a80558aec08f85f3110601cfaecfa8617dc465f4fb3509493cdda0def15

data/.travis.yml

@@ -3,3 +3,9 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+services:
+  - mongodb
+before_script:
+  - sleep 5
+  - mongo mydb_test --eval 'db.addUser("travis", "test");'
+

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in banter.gemspec
 gemspec
+
+group :test do
+  gem 'rack-test'
+  gem 'sinatra'
+  gem 'haml'
+  gem 'mongoid', github: 'mongoid/mongoid'
+  gem 'timecop'
+  gem "factory_girl", "~> 4.0"
+end

data/README.md

@@ -1,4 +1,4 @@
-# Banter
+    # Banter
 
 Simple Publishers and subscribers for Ruby using RabbitMQ
 
@@ -33,7 +33,7 @@ There are two sides to this gem, publishers and subscribers
 
 Publishing to a message is super simple
 
-    Banter.publish('user.created', { id: 3, name: 'Foo Bar', email: 'foobar@email.com')
+    Banter.publish('user.created', id: 3, name: 'Foo Bar', email: 'foobar@email.com')
 
 Additionally you can setup a context that is passed down to the subscribers. This context can be set up in a `before_filter`
 
@@ -81,11 +81,12 @@ Usage: bundle exec start_subscribers [options]
     -P, --pidfile PATH               path to pidfile
     -o, --only [SUBSCRIBERS]         comma separated name of subsriber classes that should be run
     -r, --require [PATH|DIR]         Location of Rails application with workers or file to require
+    -n, --name [PROCESS_NAME]        Name of the process
     -v, --version                    Print version and exit
 
 ```
 
-#### Validations
+#### Payload Validations
 
 ```ruby
 class UserWelcomeSubscriber < Banter::Subscriber
@@ -107,6 +108,39 @@ class UserWelcomeSubscriber < Banter::Subscriber
 end
 ```
 
+### Dashboards!!!
+
+Banter provides dashboards that can be easily enabled in any Rack application.
+
+For a Rails application
+
+```
+# config/application.rb
+config.banter.web_enabled = true
+```
+
+```
+#config/routes.rb
+mount Banter::Web::Application => '/banter'
+```
+
+or 
+
+```
+#config.routes.rb
+  authenticate :admin do
+    mount Banter::Web::Application => '/banter'
+  end
+```
+
+Dashboards currently use Mongo DB (Mongoid gem) to store data, so the following gems should be added to your gemfile
+```
+gem 'mongoid'
+gem 'haml'
+gem 'sinatra'
+```
+
+
 ## Contributing
 
 1. Fork it

data/lib/banter.rb

@@ -31,6 +31,10 @@ module Banter
     Publisher.instance.publish(Banter::Context.instance, routing_key, payload)
   end
 
+  def self.delay_messages
+    Publisher.instance.delay_messages{ yield }
+  end
+
   # @return [Logger] Logger used for logging through the Banter gem
   def self.logger
     return Banter::Configuration.logger if Banter::Configuration.logger

data/lib/banter/cli.rb

@@ -10,7 +10,7 @@ module Banter
   class CLI
     include Singleton
 
-    attr_accessor :pidfile, :subscribers
+    attr_accessor :pidfile, :subscribers, :process_name
 
     # Method to support parsing of arguments passed through the command line
     def parse(args = ARGV)
@@ -28,7 +28,11 @@ module Banter
           @require_path = arg
         end
 
-        opts.on '-v', '--version', "Print version and exit" do |arg|
+        opts.on '-n', '--name [PROCESS_NAME]', "Name of the process" do |arg|
+          @process_name = arg
+        end
+
+        opts.on '-v', '--version', "Print version and exit" do
           puts "Banter #{Banter::VERSION}"
           abort
         end
@@ -38,6 +42,7 @@ module Banter
     end
 
     def run
+      change_process_name
       load_environment
       write_pidfile
       load_subscribers
@@ -87,7 +92,12 @@ module Banter
     end
 
     def load_subscribers
-      Banter::Server::SubscriberServer.new(subscriber_classes).start
+      Banter::Server::SubscriberServer.instance.set_workers(subscriber_classes)
+      Banter::Server::SubscriberServer.instance.start
+    end
+
+    def change_process_name
+      $PROGRAM_NAME = @process_name || "banter_subscriber"
     end
   end
 end

data/lib/banter/configuration.rb

@@ -30,10 +30,20 @@ module Banter
     mattr_accessor :push_enabled
     @@push_enabled = true
 
+    # RabbitMQ batches messages and delays until the end of a request
+    # @default false
+    mattr_accessor :batch_messages
+    @@batch_messages = false
+
     # Dead letter queue name
     # @default nil
     mattr_accessor :dead_letter_queue
 
+    # Enable web monitoring
+    # @default false
+    mattr_accessor :web_enabled
+    @@web_enabled = false
+
     def self.configure_with(environment_name, yaml_file = nil)
       @@yaml_file = yaml_file.nil? ? "config/banter.yml" : yaml_file
       @@all_conf = Hashie::Mash.new(YAML.load_file(@@yaml_file) )

data/lib/banter/middleware.rb

@@ -2,13 +2,21 @@
 
 module Banter
   class Middleware
+    @@cached = nil
     def initialize(app)
       @app = app
     end
 
     def call(env)
       Banter::Context.clear!
-      @app.call(env)
+      if @@cached.nil?
+        @@cached = Banter::Configuration.batch_messages
+      end
+      if @@cached
+        Banter.dedupe_messages { @app.call(env) }
+      else
+        @app.call(env)
+      end
     end
   end
 end

data/lib/banter/publisher.rb

@@ -15,6 +15,7 @@ module Banter
     def initialize(exchange = nil)
       @exchange = exchange || Banter::Configuration.exchange_name
       @disabled = false
+      @batch_messages = false
     end
 
     def enable(value)
@@ -22,6 +23,13 @@ module Banter
       @disabled
     end
 
+    def delay_messages
+      delay_start
+      yield
+    ensure
+      delay_execute
+    end
+
     def start
       unless Configuration.push_enabled
         @disabled = true
@@ -41,7 +49,6 @@ module Banter
         return
       end
 
-
       @publisher.on_return do |return_info, properties, content|
         # contents are already transformed into message that we want to send
         Banter::RabbitLogger.failed_publish(return_info[:routing_key], properties, content)
@@ -49,29 +56,45 @@ module Banter
 
     end
 
-    def publish(context, key, payload, enabled = true)
+    def publish(context, key, payload)
       routing_key = "#{@exchange}.#{key}"
       envelope    = ::Banter::Message.new.serialize(context, key, payload)
 
+      if @batch_messages
+        add_message(routing_key, envelope)
+      else
+        execute_publish(routing_key, envelope)
+      end
+    end
+
+   private
+   def execute_publish(routing_key, envelope)
+
       if @publisher.nil?
         start
       end
 
-      if @disabled || @publisher.nil? || !enabled
+      if @disabled || @publisher.nil?
         Banter::RabbitLogger.failed_publish(routing_key, {}, envelope)
       else
         tries = 2
         begin
           @publisher.publish(envelope.to_json, :persistent => true, :mandatory => true, :timestamp => envelope[:ts], :content_type => "application/json", :routing_key => routing_key)
           Banter::RabbitLogger.log_publish(routing_key, envelope)
+        # FIX!!! -thl
+        # What kind of errors could be fired from a failure to publish?
+        # Should we be more specific?
+        # Docs only have errors while connecting, and really not during some sort of long running socket.  For now
+        # We'll log until we get more info.
         rescue => e
+          Banter::RabbitLogger.log(Logger::WARN, "Error occured on publish: #{e.message}: #{e.inspect}, #{routing_key}: #{envelope.inspect}")
           tries -= 1
           teardown
           start
           if tries > 0 && @publisher
             retry
           else
-            Banter::RabbitLogger.failed_publish(routing_key, {}, envelope)
+            Banter::RabbitLogger.failed_publish(routing_key, { error: e.message }, envelope)
           end
         end
 
@@ -80,9 +103,27 @@ module Banter
     end
 
     def teardown
+      # FIX!!! -thl
+      # How can I check to see if the connection is valid quickly without trying a close on the connection?
       @connection.close
       @publisher = nil
     end
 
+    def delay_start
+      @batch_messages = true
+      @messages = []
+    end
+
+    def delay_execute
+      @messages.each do |key, envelope|
+        execute_publish(key, envelope)
+      end
+      @messages.clear
+      @batch_messages = false
+    end
+
+    def add_message(key, envelope)
+      @messages << [key, envelope]
+    end
   end
 end

data/lib/banter/rabbit_logger.rb

@@ -1,5 +1,6 @@
 # Internal log class that is used to log messages before sending, after receiving, and failure to send
 module Banter
+
   class RabbitLogger
     def self.enabled?
       Banter::Configuration.logging_enabled
@@ -8,25 +9,42 @@ module Banter
     def self.log_publish(routing_key, message)
       return unless enabled?
       tags = ["BANTER PUBLISH", message[:ts], message[:pub], message[:v], routing_key]
-      Banter.logger.tagged(tags) { Banter.logger.debug message[:payload].as_json }
+      logger.tagged(tags) { logger.warn message[:payload].as_json }
     end
 
     def self.failed_publish(routing_key, properties, message)
       return unless enabled?
       tags = ["BANTER FAILED_SEND", message[:ts], message[:pub], message[:v], routing_key]
-      Banter.logger.tagged(tags) { Banter.logger.error message[:payload].as_json }
+      logger.tagged(tags) { logger.error( { properties: properties, payload:message[:payload] }.as_json ) }
     end
 
     def self.log_receive(routing_key, message)
       return unless enabled?
       tags = ["BANTER RECEIVED", message[:ts], message[:pub], message[:v], routing_key, Process::pid]
-      Banter.logger.tagged(tags) { Banter.logger.debug message[:payload].as_json }
+      logger.tagged(tags) { logger.warn message[:payload].as_json }
+    end
+
+    def self.log_complete(routing_key, message)
+      return unless enabled?
+      tags = ["BANTER COMPLETED", message[:ts], message[:pub], message[:v], routing_key, Process::pid]
+      logger.tagged(tags) { logger.warn message[:payload].as_json }
     end
 
     def self.log_service(service_name, message)
       return unless enabled?
       tags = ["BANTER SERVICE", service_name, Process::pid]
-      Banter.logger.tagged(tags) {Banter.logger.info message[:payload].as_json}
+      logger.tagged(tags) { logger.info message.as_json}
     end
+
+    @@log_map = [:debug, :info, :warn, :error, :fatal]
+    def self.log(log_level, message)
+      tags = ["BANTER LOG_LEVEL:#{@@log_map[log_level].capitalize.to_s}", Process::pid]
+      logger.tagged(tags) { logger.send(@@log_map[log_level], message.as_json ) }
+    end
+
+    def self.logger
+      Banter.logger
+    end
+
   end
 end

data/lib/banter/railtie.rb

@@ -11,7 +11,12 @@ module Banter
     end
 
     config.after_initialize do
-      Banter.logger = Rails.logger
+      Banter.logger = config.banter.logger if config.banter.logger
+
+      if Banter::Configuration.web_enabled
+        require 'banter/web'
+      end
+
     end
 
     console do

data/lib/banter/server/client_queue_listener.rb

@@ -28,17 +28,27 @@ module Banter
 
       def shutdown
         @subscriber.teardown if @subscriber.present?
-        # TODO -thl
-        # This the kosher thing to do in ruby?
-        teardown
       end
 
       def message_received(delivery_info, properties, envelope)
-        Banter.logger.debug("Message received by listener on #{worker_class.name} with payload: #{envelope[:payload]}")
+        Banter::RabbitLogger.log(::Logger::DEBUG, "Message received by listener on #{worker_class.name} with payload: #{envelope[:payload]}")
         worker = worker_class.new(delivery_info, properties, envelope[:context])
-        worker.perform!(envelope[:payload])
+        payload = envelope[:payload]
+        track_message_received(worker, payload)
+        worker.perform!(payload)
+        track_message_successful
+      rescue ::Banter::PayloadValidationError => banter_error
+        track_message_failed(banter_error.message, false)
+        Banter::RabbitLogger.log(::Logger::ERROR, { worker: worker_class.name, message: banter_error.message, envelope: envelope })
+        Airbrake.notify("Validation error for #{worker_class.name}",
+                        params: {
+                          info:       delivery_info,
+                          properties: properties,
+                          context:    envelope[:context],
+                          payload:    envelope[:payload] })
       rescue => e
-        Banter.logger.error("Failed message for #{worker_class.name}")
+        track_message_failed(e.message, true)
+        Banter::RabbitLogger.log(::Logger::DEBUG, "Failed message for #{worker_class.name} #{e.message}")
         Airbrake.notify("Failed perform for #{worker_class.name}",
                         params: {
                           info:       delivery_info,
@@ -49,7 +59,21 @@ module Banter
       end
 
       protected
-      def teardown
+
+      def track_message_successful
+        return unless Banter::Configuration.web_enabled
+        BanterMessage.message_successful
+      end
+
+      def track_message_failed(error_message, error = true)
+        return unless Banter::Configuration.web_enabled
+        status = error ? BanterMessage::STATUS_ERROR : BanterMessage::STATUS_VALIDATION_FAILED
+        BanterMessage.message_failed(error_message, status)
+      end
+
+      def track_message_received(worker, payload)
+        return unless Banter::Configuration.web_enabled
+        BanterMessage.message_received(worker_class, worker, payload)
       end
     end
   end

data/lib/banter/server/rabbit_mq_subscriber.rb

@@ -54,13 +54,14 @@ module Banter
         @consumer                                 = @listener.subscribe(consumer_tag: name, block: blocking)
 
         @consumer.on_delivery do |delivery_info, properties, contents|
-          Banter.logger.debug("Message delivery with contents: #{contents}")
+          Banter::RabbitLogger.log(Logger::DEBUG, "Message delivery with contents: #{contents}")
           if delivery_info[:redelivered]
             Airbrake.notify("PubSub Message redelivery", params: { info: delivery_info, props: properties, contents: contents }, environment_name: ENV['RAILS_ENV'])
           end
           message = ::Banter::Message.new.parse(contents)
           Banter::RabbitLogger.log_receive(delivery_info[:routing_key], message)
           yield delivery_info, properties, message
+          Banter::RabbitLogger.log_complete(delivery_info[:routing_key], message)
           true
         end
       end