banter 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11d9e4fde9f27b5c99163b5abb6ddd4f8cb29607
-  data.tar.gz: 754895e5e7af5773b072e7fb7f2024728bbaa555
+  metadata.gz: 51871d5d895dbf72454f67a614a14aa8af5cd6ee
+  data.tar.gz: 37321de3cd2605a5b7d99ffce5e979167b7597df
 SHA512:
-  metadata.gz: c4418fba824671130e639689e5c9f158256a45f7dfff640366bbafa50eac3a98478a7daa0bb2d3170148a05a01acc7e92d14d89f32d9e0e7558d8a87621c5db7
-  data.tar.gz: c15e928646a3f46129dfa639fb637a33fd3d0dfd98acc871ed17de0656dc4042a91c85e7dc396cda395efc4e8af15eeb939fd156bdad8cb0d8a03d867429ec30
+  metadata.gz: 9dba68030359665879dbd785c613523282f97a5b91a721824c91dd4375e87a8299e39f68af759595ffe5963b584b7981b526a7a5d0071f05b2a4a02cc1c95669
+  data.tar.gz: 16ba97865260c2e81463d374f1c4806cf17ad65628022aa6abc90da7e6d8af8741a0166afd67887f59a5d87c5f9f8dc53ccb989e7609f376e379212d5707173a

data/.gitignore

@@ -19,4 +19,4 @@ test/version_tmp
 tmp
 .rspec
 .idea
-test_pubsub.log
+*.log

data/.travis.yml

@@ -8,4 +8,12 @@ services:
 before_script:
   - sleep 5
   - mongo mydb_test --eval 'db.addUser("travis", "test");'
+notifications:
+  email:
+    - webadmin@honest.com
+    - tushar@honest.com
+  on_success: always
+  on_failure: always
+
+
 

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in banter.gemspec
 gemspec
 
+gem 'coffee-script'
+gem 'json'
 group :test do
   gem 'rack-test'
   gem 'sinatra'

data/Rakefile

@@ -5,3 +5,32 @@ begin
   RSpec::Core::RakeTask.new(:spec)
   task :default => :spec
 end
+
+begin
+  require 'coffee-script'
+
+  namespace :js do
+    def add_javascript(js_file, output_file)
+      js_file_souce = File.read("#{File.dirname(__FILE__)}/web/assets/javascripts/#{js_file}.js")
+      output_file.puts js_file_souce
+    end
+
+    desc "compile coffee-scripts from ./assets/javascripts"
+    task :compile do
+      source = "#{File.dirname(__FILE__)}/web/assets/javascripts/**/*.coffee"
+      target = "#{File.dirname(__FILE__)}/web/assets/javascripts/banter.js"
+      file   = File.open(target, 'w+')
+
+      add_javascript("ng-prettyjson", file)
+
+      Dir.glob(source) do |cf|
+        puts cf
+        file.puts CoffeeScript.compile File.read(cf)
+      end
+
+      file.close
+    end
+  end
+
+
+end

data/lib/banter/subscriber.rb

@@ -90,6 +90,24 @@ module Banter
 
     private
 
+    # @param [Integer] number The expected number of total objects that may be processed due to the message
+    def total(number)
+      return unless Banter::Configuration.web_enabled
+      BanterMessage.update_progress_total(number)
+    end
+
+    # @param [Integer] number The current progress of the execution of the message
+    def at(number)
+      return unless Banter::Configuration.web_enabled
+      BanterMessage.update_progress_at(number)
+    end
+
+    # @param [Object] object An object that indicates the current progress of the message
+    def progress(object)
+      return unless Banter::Configuration.web_enabled
+      BanterMessage.update_progress(object)
+    end
+
     def self.validate_routing_key_name(key)
       return true if key.blank?
       key.match(/\A([a-z]+\.?)*([a-z]+)\Z/).present?

data/lib/banter/version.rb

@@ -1,3 +1,3 @@
 module Banter
-  VERSION = "0.8.0"
+  VERSION = "1.0.0"
 end

data/lib/banter/web.rb

@@ -20,6 +20,12 @@ module Banter
   module Web
     autoload :Application, 'banter/web/application'
     autoload :Helpers, 'banter/web/helpers'
+
+    module Serializers
+      autoload :BanterWorkerSerializer, 'banter/web/serializers/banter_worker_serializer'
+      autoload :BanterMessageSerializer, 'banter/web/serializers/banter_message_serializer'
+      autoload :SubscriberSerializer, 'banter/web/serializers/subscriber_serializer'
+    end
   end
 end
 

data/lib/banter/web/application.rb

@@ -8,29 +8,78 @@ module Banter
       helpers Banter::Web::Helpers
 
       get '/' do
-        @workers = BanterWorker.running.ordered
-        haml :index, locals: { workers: @workers }
+        redirect "#{root_path}dashboard"
       end
 
-      get '/workers/:id' do
+      get '/dashboard*', provides: :html do
+        haml :index
+      end
+
+      get '/workers.json' do
+        content_type :json
+        workers = BanterWorker.running.ordered.map { |w| serialize_worker(w) }
+        { workers: workers }.to_json
+      end
+
+      get '/workers/:id.json' do
+        content_type :json
         worker = BanterWorker.find(params[:id])
-        haml :worker, locals: { worker: worker }
+        { worker: serialize_worker(worker) }.to_json
+      end
+
+      get '/messages/:message_id.json' do
+        content_type :json
+        message = BanterMessage.find(params[:message_id])
+        {
+          message: serialize_message(message, true)
+        }.to_json
+      end
+
+      get '/messages.json' do
+        content_type :json
+        offset   = 0
+        worker   = nil
+        offset   = 50 * (params[:page].to_i - 1) if params[:page]
+        messages = BanterMessage.ordered.limit(50).offset(offset)
+        if params[:worker_id].present?
+          worker   = BanterWorker.find(params[:worker_id])
+          messages = messages.where(worker_id: worker.id).ordered
+        end
+
+        if params[:subscriber].present?
+          messages = messages.where(subscriber_class: params[:subscriber])
+        end
+
+        hash          = {
+          messages: messages.map { |m| serialize_message(m, true) }
+        }
+        hash[:worker] = serialize_worker(worker) if worker
+        hash.to_json
       end
 
-      get '/messages/:id' do
-        message = BanterMessage.find(params[:id])
-        haml :message, locals: { message: message }
+      get '/subscribers.json' do
+        content_type :json
+        {
+          subscribers: BanterWorker.subscribers.map { |s| serialize_subscriber(s) }
+        }.to_json
       end
 
-      get '/workers/:worker_id/messages' do
-        messages = BanterMessage.where(worker_id:  Moped::BSON::ObjectId.from_string(params[:worker_id])).ordered
-        worker = BanterWorker.find(params[:worker_id])
-        haml :messages, locals: { messages: messages, worker: worker }
+      private
+
+      def serialize_message(message, include_worker = false)
+        Banter::Web::Serializers::BanterMessageSerializer.new(message).to_hash.tap do |hash|
+          hash[:worker] = serialize_worker(message.worker) if include_worker
+        end
       end
 
-      get '/subscribers' do
-        haml :subscribers
+      def serialize_worker(worker)
+        Banter::Web::Serializers::BanterWorkerSerializer.new(worker).to_hash
       end
+
+      def serialize_subscriber(subscriber)
+        Banter::Web::Serializers::SubscriberSerializer.new(subscriber).to_hash
+      end
+
     end
   end
 end

data/lib/banter/web/helpers.rb

@@ -1,8 +1,12 @@
 module Banter
   module Web
     module Helpers
-      def root_path
-        "#{env['SCRIPT_NAME']}/"
+      def root_path(path = nil)
+        "#{env['SCRIPT_NAME']}/#{path}"
+      end
+
+      def dashboard_path(path = nil)
+        root_path("dashboard/#{path}")
       end
     end
   end

data/lib/banter/web/models/banter_message.rb

@@ -14,17 +14,29 @@ class BanterMessage
   field :status, type: String
   field :error_message, type: String
   field :worker_id
-  # embeds_one :worker, class_name: 'BanterWorker'
+  field :progress_at, type: Integer
+  field :progress_total, type: Integer
+  field :progress
 
-  STATUS_STARTED = 'started'
-  STATUS_SUCCESS = 'success'
-  STATUS_ERROR  = 'error'
-  STATUS_VALIDATION_FAILED  = 'validation_failed'
+  STATUS_STARTED           = 'started'
+  STATUS_SUCCESS           = 'success'
+  STATUS_ERROR             = 'error'
+  STATUS_VALIDATION_FAILED = 'validation_failed'
 
   cattr_reader :current
 
   scope :ordered, ->() { order_by(:started_at.desc) }
+  scope :for_subscriber, ->(subscriber) { where(subscriber_class: subscriber) }
+  scope :successful, ->() { where(status: STATUS_SUCCESS) }
+  scope :errored, ->() { where(status: STATUS_ERROR) }
+  scope :validation_failed, ->() { where(status: STATUS_VALIDATION_FAILED) }
+  scope :started, ->() { where(status: STATUS_STARTED) }
 
+  # Creates a BanterMessage to record a message that is received by a subscriber.
+  # It records the created message as BanterMessage.current
+  # @param [Subscriber] subscriber_class
+  # @param [Banter::Server::ClientQueueListener] worker
+  # @param [Object] payload
   def self.message_received(subscriber_class, worker, payload)
     return unless BanterWorker.current
 
@@ -47,6 +59,7 @@ class BanterMessage
     BanterWorker.record_current!(obj)
   end
 
+  # Records the current message as successful. Clears the BanterMessage.current
   def self.message_successful
     current.status  = STATUS_SUCCESS
     current.done_at = Time.now
@@ -55,6 +68,9 @@ class BanterMessage
     @@current = nil
   end
 
+  # Records the current message as errored or validation failed with error message. Clears the BanterMessage.current
+  # @param [String] error_message
+  # @param [String] status
   def self.message_failed(error_message, status)
     current.status        = status
     current.done_at       = Time.now
@@ -64,6 +80,29 @@ class BanterMessage
     @@current = nil
   end
 
+  # Records the current progress as a number for the current message.
+  # @param [Integer] num Current progress
+  def self.update_progress_at(num)
+    return unless current
+    current.progress_at = num
+    current.save!
+  end
+
+  # Records the number of objects expected to be processed for the current message.
+  # @param [Integer] num Total number of objects expected to be processed.
+  def self.update_progress_total(num)
+    return unless current
+    current.progress_total = num
+    current.save!
+  end
+
+  # @param [Object] object Any object that indicates the progress of the message
+  def self.update_progress(object)
+    return unless current
+    current.progress = object
+    current.save!
+  end
+
   def executing?
     self.status == STATUS_STARTED
   end
@@ -76,6 +115,7 @@ class BanterMessage
     self.status == STATUS_ERROR || self.status == STATUS_VALIDATION_FAILED
   end
 
+  # @return [BanterWorker] The worker that is responsible for executing the current message
   def worker
     @worker ||= BanterWorker.find(self['worker_id'].to_s)
   end

data/lib/banter/web/models/banter_worker.rb

@@ -37,6 +37,11 @@ class BanterWorker
     @@current = nil
   end
 
+  # @return [Array] Unique subscriber classes
+  def self.subscribers
+    distinct("worker_classes")
+  end
+
   # @param [BanterMessage] banter_message Message that is currently being executed
   def self.record_current!(banter_message)
     current.current_message = banter_message.attributes

data/lib/banter/web/serializers/banter_message_serializer.rb

@@ -0,0 +1,34 @@
+module Banter
+  module Web
+
+    module Serializers
+      class BanterMessageSerializer
+        attr_accessor :message
+
+        def initialize(message)
+          @message = message
+        end
+
+        def to_hash
+          {
+            id:               message.id.to_s,
+            subscriber_class: message.subscriber_class,
+            queue_name:       message.queue_name,
+            subscribed_key:   message.subscribed_key,
+            payload_key:      message.payload_key,
+            payload:          message.payload,
+            context:          message.context,
+            started_at:       message.started_at,
+            done_at:          message.done_at,
+            status:           message.status,
+            error_message:    message.error_message,
+            worker_id:        message.worker_id,
+            progress_total:   message.progress_total,
+            progress_at:      message.progress_at,
+            progress:         message.progress
+          }
+        end
+      end
+    end
+  end
+end

data/lib/banter/web/serializers/banter_worker_serializer.rb

@@ -0,0 +1,30 @@
+module Banter
+  module Web
+
+    module Serializers
+      class BanterWorkerSerializer
+        attr_accessor :worker
+
+        def initialize(worker)
+          @worker = worker
+        end
+
+        def to_hash
+          {
+            id:              worker.id.to_s,
+            process_name:    worker.process_name,
+            pid:             worker.pid,
+            started_at:      worker.started_at,
+            stopped_at:      worker.stopped_at,
+            worker_classes:  Array.wrap(worker.worker_classes),
+            hostname:        worker.hostname,
+            current_message: worker.current_message,
+            job_count:       worker.job_count,
+            success_count:   worker.success_count,
+            failed_count:    worker.failed_count
+          }
+        end
+      end
+    end
+  end
+end

data/lib/banter/web/serializers/subscriber_serializer.rb

@@ -0,0 +1,26 @@
+module Banter
+  module Web
+
+    module Serializers
+      class SubscriberSerializer
+        attr_accessor :subscriber_class_name
+
+        def initialize(subscriber_class_name)
+          @subscriber_class_name = subscriber_class_name
+        end
+
+        def to_hash
+          messages = BanterMessage.for_subscriber(subscriber_class_name)
+          {
+            class_name:              subscriber_class_name,
+            total:                   messages.count,
+            success_count:           messages.successful.count,
+            started_count:           messages.started.count,
+            errored_count:           messages.errored.count,
+            validation_failed_count: messages.validation_failed.count
+          }
+        end
+      end
+    end
+  end
+end

data/spec/banter/subscriber_spec.rb

@@ -16,7 +16,88 @@ describe Banter::Subscriber do
     end
   end
 
-  describe "self.validates_payload_with" do
+  describe '#at' do
+    let(:subscriber) { Banter::Subscriber.new({}, {}, {}) }
+    context 'web not enabled' do
+      before do
+        allow(Banter::Configuration).to receive(:web_enabled).and_return(false)
+        subscriber.send(:at, 123)
+      end
+
+      it 'doesnt do a thing' do
+        expect(BanterMessage.count).to eq(0)
+      end
+    end
+
+    context 'web enabled' do
+      let(:banter_message) { FactoryGirl.create(:banter_message)}
+      before do
+        allow(Banter::Configuration).to receive(:web_enabled).and_return(true)
+        allow(BanterMessage).to receive(:current).and_return(banter_message)
+        subscriber.send(:at, 123)
+      end
+
+      it 'updates progress_at on current message' do
+        expect(banter_message.progress_at).to eq(123)
+      end
+    end
+  end
+
+  describe '#total' do
+    let(:subscriber) { Banter::Subscriber.new({}, {}, {}) }
+    context 'web not enabled' do
+      before do
+        allow(Banter::Configuration).to receive(:web_enabled).and_return(false)
+        subscriber.send(:total, 1230)
+      end
+
+      it 'doesnt do a thing' do
+        expect(BanterMessage.count).to eq(0)
+      end
+    end
+
+    context 'web enabled' do
+      let(:banter_message) { FactoryGirl.create(:banter_message)}
+      before do
+        allow(Banter::Configuration).to receive(:web_enabled).and_return(true)
+        allow(BanterMessage).to receive(:current).and_return(banter_message)
+        subscriber.send(:total, 1230)
+      end
+
+      it 'updates progress_at on current message' do
+        expect(banter_message.progress_total).to eq(1230)
+      end
+    end
+  end
+
+  describe '#progress' do
+    let(:subscriber) { Banter::Subscriber.new({}, {}, {}) }
+    context 'web not enabled' do
+      before do
+        allow(Banter::Configuration).to receive(:web_enabled).and_return(false)
+        subscriber.send(:progress, foo: 'bar')
+      end
+
+      it 'doesnt do a thing' do
+        expect(BanterMessage.count).to eq(0)
+      end
+    end
+
+    context 'web enabled' do
+      let(:banter_message) { FactoryGirl.create(:banter_message)}
+      before do
+        allow(Banter::Configuration).to receive(:web_enabled).and_return(true)
+        allow(BanterMessage).to receive(:current).and_return(banter_message)
+        subscriber.send(:progress, foo: 'bar')
+      end
+
+      it 'updates progress_at on current message' do
+        expect(banter_message.progress).to eq(foo: 'bar')
+      end
+    end
+  end
+
+  describe ".validates_payload_with" do
     before do
       validators.each do |validator|
         Klass.validates_payload_with validator