superbolt 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c78aea5b8060d528b43b74ac5c6939e137bad63
-  data.tar.gz: 9a660f7536bd590f3f2aad70f1bcf16b10a67b2c
+  metadata.gz: 7f7e42b8136e680635a7c00c37cb0a4bf1bc9aec
+  data.tar.gz: d43dded8b39232b7e9ed7123e1556461417a3db1
 SHA512:
-  metadata.gz: 3c06a247acb6b856c9c72078ffab1da9869df256de2eef70ce65b48b981dfd19b80b84d015cc51207b733984f99c7deed41cc8d2f3fb5c1d2c6368aa41f88cfe
-  data.tar.gz: e33cbf5336606dec0cb52e420b49a00c0d278721ed348e55abefc1ea6b2f08be918122bcac7adaed28cf10bebf1c77eed764b2bf2cb33a057415c806a4502deb
+  metadata.gz: ee3084deda5525a9ba5d20fcce3f0781431cf6cf7732556f54850cf38de4ce8cab949803c02519deec0ede961e050b0a490cead8af781facf03c9a5851697947
+  data.tar.gz: b78d27807ed2368663ff7253c1d8cbcd051557bf435ea41bce170d326f71cad19688ec97ecd3705f68e7368f090d21977349dd9aae78ff2a0864909d665a54ff

data/README.md

@@ -21,14 +21,14 @@ important: reading and sending messages.
 
 Superbolt has two main components: a queue and an app.
 
-The queue object acts like a queue. The queue can push, pop and peek. 
-The queue is able to spit out all or a subset of the messages on the 
+The queue object acts like a queue. The queue can push, pop and peek.
+The queue is able to spit out all or a subset of the messages on the
 queue. It can clear itself. In short it makes inline operations doable.
 
-The app on the other hand is an EventMachine process that takes over the
+The app on the other hand is long running process that takes over the
 thread. It continually reads from a single queue until it recieves a
-signal or message shutting it down. It is smart; it handles exceptions in message
-processing by moving those problem messages to a related error queue. It also
+signal shutting it down. It is smart; it is capable of sending exception
+notifications exceptions in message processing to Airbrake. It also
 listens on a separate quit queue for a graceful shutdown. A graceful
 shutdown means no messages are lost.
 
@@ -101,12 +101,12 @@ key that is used. Actual connection params that RabbitMQ Bunny/AMQP use
 can also be passed in as above. If a connection key is not found in the
 ENV, localhost will be used. If the application uses these typical
 conventions, then no connection configuration is required.
- 
+
 #### App Name
 
 The application name/identifier is an important default to setup in
 order to get all the goodness of related to messaging and its
-conventions. 
+conventions.
 
 If no app name is set up, a littlem or work is required to send a
 message:
@@ -133,7 +133,7 @@ filtering is easier for the consuming application.
 Superbolt doesn't want to developers worrying about exchanges,
 durability or connection ceremony. Developers should be able to just
 send a message. The ease of that sending depends on whether developers
-are sticking with the Superbolt conventions or not. 
+are sticking with the Superbolt conventions or not.
 
 #### The easiest way to message
 
@@ -154,7 +154,7 @@ This message can be received on a queue
       event: 'dorothy',
       arguments: 'On yellow brick road; has friends!'
     }
-  
+
 #### A more customizable messaging experience
 
 Messages can also be sent via Superbolt::Queue objects. In this case the
@@ -162,20 +162,20 @@ message can be anything and the queue name is exactly what is passed in.
 
     queue = Superbolt::Queue.new('dorothy')
     queue.push({demand: 'Surrender!'})
-    queue.pop 
+    queue.pop
     => {
       'demand' => 'Surrender!'
     }
 
 ### Reading messages
 
-Messages can be read inline or via a standalone app. 
+Messages can be read inline or via a standalone app.
 
 #### Reading Inline
 
 Reading messages inline is easy and to the point. The Superbolt::Queue
 object tries to act queue-like instead of like a hard to use external
-service. 
+service.
 
 Popping messages off the queue will remove the message from the queue
 immediately. If something goes wrong with eth message processing, it is
@@ -184,12 +184,12 @@ do.
 
     message = queue.pop # This removes the message permanently
 
-Messages can be read in non-destructive ways as well. 
+Messages can be read in non-destructive ways as well.
 
     message = queue.peek
     # Ponder or process message.
     # It is still hanging out at the top of the queue.
-    # It can be deleted with a pop, 
+    # It can be deleted with a pop,
     # provided another consumer hasn't already deleted it!
 
 Because of asynchronicity issues with job processing across several apps
@@ -202,7 +202,7 @@ and information gathering.
     queue.delete {|m| m['level'] == 'not_important' }
 
     # peek at messages in a certain range
-    queue.slice(2, 4) 
+    queue.slice(2, 4)
 
     # get a certain message, non-destructively
     queue[3]
@@ -218,16 +218,9 @@ communications.
     end
 
 Exceptions raised in the processing block will not exit
-the Superbolt app. Errors will be logged and the message will be put on
-an error queue with information about the exception raised. Those
-messages can be seen by accessing the related error queue:
-
-    error_queue = Superbolt::App.new('dorothy_inbox').error_queue
-    error_queue.all
-
-The error queue is a Superbolt::Queue and methods like #pop, #delete,
-and #[] are available to gather more data about the exceptions being
-raised.
+the Superbolt app. Errors will be logged and the notification will be sent
+to the error notifier (none by default, can be airbrake) with information
+about the exception raised.
 
 The app can be shutdown gracefully by sending a quit message to a
 special queue:
@@ -235,6 +228,19 @@ special queue:
     quit_queue = Superbolt::App.new('dorothy_inbox').quit_queue
     quit_queue.push(message: 'for a deploy')
 
+## Error reporting
+
+  `Superbolt::App` can hook into Airbrake by your command:
+
+    Superbolt.error_notifier = :airbrake
+
+    Superbolt::App.new('dorothy_inbox') do
+      do_unsafe_stuff
+    end
+
+  Note that Superbolt does not have [the Airbrake gem](https://github.com/airbrake/airbrake)
+  amongst it's dependencies, so it is up to you to add it to your project.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/superbolt.rb

@@ -11,6 +11,9 @@ require 'active_support/inflector'
 require "superbolt/version"
 require "superbolt/config"
 
+require "superbolt/error_notifier/airbrake"
+require "superbolt/error_notifier/none"
+
 require "superbolt/adapter/base"
 require "superbolt/adapter/bunny"
 require "superbolt/adapter/amqp"

data/lib/superbolt/app.rb

@@ -1,14 +1,15 @@
 module Superbolt
   class App
-    attr_reader :config, :env, :runner_type
+    attr_reader :config, :env, :runner_type, :error_notifier_type
     attr_accessor :logger
 
     def initialize(name, options={})
-      @name = name
-      @env =            options[:env] || Superbolt.env
-      @logger =         options[:logger] || Logger.new($stdout)
-      @config =         options[:config] || Superbolt.config
-      @runner_type =    options[:runner] || config.runner || :default
+      @name                = name
+      @env                 = options[:env] || Superbolt.env
+      @logger              = options[:logger] || Logger.new($stdout)
+      @config              = options[:config] || Superbolt.config
+      @runner_type         = options[:runner] || config.runner || :default
+      @error_notifier_type = options[:error_notifier] || Superbolt.error_notifier
     end
 
     def name
@@ -20,10 +21,6 @@ module Superbolt
       Queue.new("#{connection.name}.quit", connection.config)
     end
 
-    def error_queue
-      Queue.new("#{connection.name}.error", connection.config)
-    end
-
     def connection
       @connection ||= Connection::Queue.new(name, config)
     end
@@ -41,7 +38,7 @@ module Superbolt
     end
 
     def run(&block)
-      @consumer = runner_class.new(queue, error_queue, logger, block).run
+      runner_class.new(queue, error_notifier, logger, block).run
       # quit_subscriber_queue.subscribe do |message|
       #    (message)
       # end
@@ -65,9 +62,27 @@ module Superbolt
       runner_map[:ack_one]
     end
 
+    def error_notifier
+      @error_notifier ||= error_notifier_class.new(logger)
+    end
+
+    def error_notifier_class
+      error_notifier_map[error_notifier_type] || default_error_notifier
+    end
+
+    def error_notifier_map
+      {
+        airbrake: ErrorNotifier::Airbrake,
+        none:     ErrorNotifier::None
+      }
+    end
+
+    def default_error_notifier
+      error_notifier_map[:none]
+    end
+
     def quit(message='no message given')
       logger.info "EXITING Superbolt App listening on queue #{name}: #{message}"
-      q.channel.consumers.first[0]
       q.channel.basic_cancel q.channel.consumers.first[0]
       close
     end

data/lib/superbolt/config.rb

@@ -27,6 +27,10 @@ module Superbolt
       options[:runner]
     end
 
+    def error_notifier
+      options[:error_notifier]
+    end
+
     def env_params
       ENV[env_connection_key]
     end

data/lib/superbolt/error_notifier/airbrake.rb

@@ -0,0 +1,17 @@
+module Superbolt
+  module ErrorNotifier
+    class Airbrake
+      def initialize(logger)
+        @logger = logger
+      end
+
+      def error!(exception, superbolt_message = nil)
+        if defined? ::Airbrake
+          ::Airbrake.notify_or_ignore(exception, parameters: superbolt_message)
+        else
+          @logger.warn("You have configured Superbolt to send errors to Airbrake, but Airbrake is not available or is not configured!")
+        end
+      end
+    end
+  end
+end

data/lib/superbolt/error_notifier/none.rb

@@ -0,0 +1,9 @@
+module Superbolt
+  module ErrorNotifier
+    class None
+      def initialize(*); end
+      def error!(*); end
+    end
+  end
+end
+

data/lib/superbolt/facade.rb

@@ -1,9 +1,10 @@
 module Superbolt
-    
+
   def self.config=(options)
     @config = Config.new({
       env: env,
       app_name: app_name,
+      error_notifier: error_notifier,
       file_matcher: file_matcher
     }.merge(options))
   end
@@ -17,7 +18,7 @@ module Superbolt
   end
 
   class << self
-    attr_writer :env, :file_matcher
+    attr_writer :env, :file_matcher, :error_notifier
     attr_accessor :app_name
   end
 
@@ -29,6 +30,10 @@ module Superbolt
     @file_matcher || /_file$/
   end
 
+  def self.error_notifier
+    @error_notifier || :none
+  end
+
   def self.message(args={})
     Superbolt::Messenger.new(args)
   end

data/lib/superbolt/incoming_message.rb

@@ -29,4 +29,4 @@ module Superbolt
       hash
     end
   end
-end
+end

data/lib/superbolt/runner/base.rb

@@ -1,11 +1,11 @@
 module Superbolt
   module Runner
     class Base
-      attr_reader :queue, :error_queue, :logger, :block
+      attr_reader :queue, :error_notifier, :logger, :block
 
-      def initialize(queue, error_queue, logger, block)
+      def initialize(queue, error_notifier, logger, block)
         @queue = queue
-        @error_queue = error_queue
+        @error_notifier = error_notifier
         @logger = logger
         @block = block
       end
@@ -15,13 +15,7 @@ module Superbolt
       end
 
       def on_error(message, error)
-        error_message = message.merge({error: {
-          class: error.class,
-          message: error.message,
-          backtrace: error.backtrace,
-          errored_at: Time.now
-        }})
-        error_queue.push(error_message)
+        error_notifier.error!(error, message)
       end
     end
   end

data/lib/superbolt/runner/default.rb

@@ -14,10 +14,11 @@ module Superbolt
         queue.subscribe(ack: ack, block: true) do |delivery_info, metadata, payload|
           message = Superbolt::IncomingMessage.new(delivery_info, payload, channel)
           processor = processor_class.new(message, logger, &block)
-          processor.perform
-          # unless processor.perform
-          #   on_error(message.parse, processor.exception)
-          # end
+          success = processor.perform
+
+          unless success
+            on_error(message.parse, processor.exception)
+          end
 
           message.ack if ack
         end

data/lib/superbolt/version.rb

@@ -1,3 +1,3 @@
 module Superbolt
-  VERSION = "0.6.0" #possibly broken for file transfer :(
+  VERSION = "0.7.0" #possibly broken for file transfer :(
 end

data/spec/app_spec.rb

@@ -62,6 +62,7 @@ describe Superbolt::App do
     it 'removes messages from the queue on successful completion' do
       queue.push({first: 1})
       queue.push({last: 2})
+      messages = []
 
       app.run do |message, logger|
         messages << message
@@ -94,16 +95,44 @@ describe Superbolt::App do
       message_received.should be_true
     end
 
-    it "moves the message to an error queue if an exception is raised" do
-      pending "we will probably delete this test in favor of airbrake"
-      queue.push({oh: 'noes'})
+    context 'notifying errors' do
+      let(:message) { { 'oh' => 'noes' } }
+      let(:the_error) { RuntimeError.new('something went wrong') }
+
+      context 'airbrake' do
+        before { Superbolt.error_notifier = :airbrake }
+        after  { Superbolt.error_notifier = nil }
+
+        it 'uses ErrorNotifiers::Airbrake' do
+          app.error_notifier.should be_an_instance_of(Superbolt::ErrorNotifier::Airbrake)
+          app.error_notifier.should_receive(:error!).with(the_error, message)
+          messages = []
 
-      app.run do |message|
-        # quit_queue.push({message: 'halt thyself'})
-        raise "something went wrong"
+          queue.push(message)
+          queue.push(message)
+
+          app.run do |message|
+            messages << message
+            messages.length > 1 ? app.quit : raise(the_error)
+          end
+        end
+      end
+
+      context 'default' do
+        it 'does not fail' do
+          app.error_notifier.should be_an_instance_of(Superbolt::ErrorNotifier::None)
+          app.error_notifier.should_receive(:error!).with(the_error, message)
+          messages = []
+
+          queue.push(message)
+          queue.push(message)
+
+          app.run do |message|
+            messages << message
+            messages.length > 1 ? app.quit : raise(the_error)
+          end
+        end
       end
-      queue.size.should == 0
-      error_queue.size.should == 1
     end
   end
 

data/spec/lib/superbolt/error_notifier/airbrake_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'stringio'
+
+describe Superbolt::ErrorNotifier::Airbrake do
+  subject(:notifier) { described_class.new(logger) }
+
+  let(:logger) { Logger.new(out) }
+  let(:out) { StringIO.new('') }
+
+  let(:error) { RuntimeError.new('ouch!')  }
+  let(:message) { { the_superbolt: 'message' } }
+
+  context 'when the app has Airbrake installed' do
+    before do
+      stub_const("::Airbrake", double(:Airbrake, notify_or_ignore: nil))
+    end
+
+    it 'logs an error to Airbrake when there was one' do
+      expect(Airbrake).to receive(:notify_or_ignore).with(error, parameters: message)
+      notifier.error!(error, message)
+    end
+
+    it 'can live without the message' do
+      expect(Airbrake).to receive(:notify_or_ignore).with(error, parameters: nil)
+      notifier.error!(error)
+    end
+  end
+
+  context 'when Airbrake is not there' do
+    it 'will not break' do
+      expect(defined? Airbrake).to be_nil
+      notifier.error!(error, message)
+      # no errors
+    end
+
+    it 'will log a warning' do
+      notifier.error!(error, message)
+      expect(out.string).to include('Airbrake is not available or is not configured!')
+    end
+  end
+end

data/spec/lib/superbolt/error_notifier/none_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Superbolt::ErrorNotifier::None do
+  subject(:notifier) { described_class.new(double(:Logger)) }
+
+  let(:error) { RuntimeError.new('ouch!')  }
+  let(:message) { { the_superbolt: 'message' } }
+
+  it 'does not fail' do
+    notifier.error!(error)
+    notifier.error!(error, message)
+  end
+end
+

data/spec/lib/superbolt/runner/pg_spec.rb

@@ -28,7 +28,7 @@ module PG
 end
 
 describe "Superbolt::Runner::Pg" do
-  let(:runner) { Superbolt::Runner::Pg.new('berkin', double('error', push: true), 'whatever', 'some block') }
+  let(:runner) { Superbolt::Runner::Pg.new('berkin', Superbolt::ErrorNotifier::None.new, 'whatever', 'some block') }
   let(:connection) { double('connection', reset!: true) }
 
   before do

data/spec/superbolt_spec.rb

@@ -6,20 +6,24 @@ describe Superbolt, 'the facade' do
       @config = nil
     end
   end
-    
+
   describe 'total configuration' do
     before do
       Superbolt.app_name = 'bossanova'
       Superbolt.env = 'production'
+      Superbolt.error_notifier = :airbrake
       Superbolt.config = {
         connection_key: 'SOME_RABBITMQ_URL'
       }
     end
 
+    after { Superbolt.error_notifier = nil }
+
     it "should retain the configuration information" do
       Superbolt.config.app_name.should == 'bossanova'
       Superbolt.config.env.should == 'production'
       Superbolt.config.env_connection_key.should == 'SOME_RABBITMQ_URL'
+      Superbolt.config.error_notifier.should == :airbrake
     end
   end
 

data/superbolt.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "= 2.14.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superbolt
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - socialchorus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-19 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,16 +112,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 description: Superbolt is comprised of a standalone app, and a queue-like queue for
   sending messages between services and applications.
 email:
@@ -144,6 +144,8 @@ files:
 - lib/superbolt/connection/app.rb
 - lib/superbolt/connection/base.rb
 - lib/superbolt/connection/queue.rb
+- lib/superbolt/error_notifier/airbrake.rb
+- lib/superbolt/error_notifier/none.rb
 - lib/superbolt/facade.rb
 - lib/superbolt/file_manager.rb
 - lib/superbolt/file_packer.rb
@@ -171,6 +173,8 @@ files:
 - spec/file_packer_spec.rb
 - spec/file_unpacker_spec.rb
 - spec/incoming_message_spec.rb
+- spec/lib/superbolt/error_notifier/airbrake_spec.rb
+- spec/lib/superbolt/error_notifier/none_spec.rb
 - spec/lib/superbolt/runner/pg_spec.rb
 - spec/messenger_spec.rb
 - spec/queue_spec.rb
@@ -212,6 +216,8 @@ test_files:
 - spec/file_packer_spec.rb
 - spec/file_unpacker_spec.rb
 - spec/incoming_message_spec.rb
+- spec/lib/superbolt/error_notifier/airbrake_spec.rb
+- spec/lib/superbolt/error_notifier/none_spec.rb
 - spec/lib/superbolt/runner/pg_spec.rb
 - spec/messenger_spec.rb
 - spec/queue_spec.rb