failbot 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90628071f00b062ad9f21fae9244d905c2f38ceb
-  data.tar.gz: d54bf144087e7a9bac861e838faa7e64ccc7deb8
+  metadata.gz: 2c43604c17fd3f70e059393df33105ff1859a525
+  data.tar.gz: b6001b69118747ba9a4f852b8cb06411aa7ccddb
 SHA512:
-  metadata.gz: 851ec7c6a661593e9edc3ffee53799c3ceab8cde34c14a0109f8ecbdb84e95f38a304600f1671d9b2a720ccf2e09a8857d75426bff3d5197fd9d5b71182f2759
-  data.tar.gz: f47a0e5f9f083b44380f76818392e8e98bc61fc19d7871c71d205c0e92006598b3283c58ab868c243b41efc858e2fb620d566a046f177d14497b76223deeaf35
+  metadata.gz: 74a8815c07c15e8df64e60e278140b7c85ad46f354ac514a31f5f27bbeee625f8f8abc7efdcd3c6290bcfbc86d02494e78f1d87a8b3e2281313bd75132a80263
+  data.tar.gz: f43c79a47c6c371dd3c7c8581a13fce6dffd3b7a31c29a8e521bdcba457b15a44152b4474988b5f993a56de41dfe53e843af4a6184a48fe0f46a38c7bbc0b66d

data/lib/failbot.rb

@@ -17,7 +17,6 @@ module Failbot
   autoload :Haystack, 'failbot/haystack'
 
   autoload :FileBackend,   'failbot/file_backend'
-  autoload :HerokuBackend, 'failbot/heroku_backend'
   autoload :HTTPBackend,   'failbot/http_backend'
   autoload :MemoryBackend, 'failbot/memory_backend'
   autoload :JSONBackend,   'failbot/json_backend'
@@ -126,6 +125,29 @@ module Failbot
     @context = [context[0]]
   end
 
+  # Public: your last chance to modify the context that is to be reported with an exception.
+  #
+  # The key value pairs that are returned from your block will get squashed into the context,
+  # replacing the values of any keys that were already present.
+  #
+  # Example:
+  #
+  # Failbot.before_report do |exception, context|
+  #   # context is { "a" => 1, "b" => 2 }
+  #   { :a => 0, :c => 3 }
+  # end
+  #
+  # context gets reported as { "a" => 0, "b" => "2", "c" => 3 }
+  #
+  def before_report(&block)
+    @before_report = block
+  end
+
+  # For tests
+  def clear_before_report
+    @before_report = nil
+  end
+
   # Public: Sends an exception to the exception tracking service along
   # with a hash of custom attributes to be included with the report. When the
   # raise_errors option is set, this method raises the exception instead of
@@ -145,7 +167,7 @@ module Failbot
   # Returns nothing.
   def report(e, other = {})
     if @raise_errors
-      squash_context(exception_info(e), other) # surface problems squashing
+      squash_contexts(context, exception_info(e), other) # surface problems squashing
       raise e
     else
       report!(e, other)
@@ -154,7 +176,17 @@ module Failbot
 
   def report!(e, other = {})
     return unless @report_errors
-    data = squash_context(exception_info(e), other)
+    data = squash_contexts(context, exception_info(e), other)
+
+    if @before_report
+      data = squash_contexts(data, @before_report.call(e, data))
+    end
+
+    if @app_override
+      data = data.merge("app" => @app_override)
+    end
+
+    data = sanitize(data)
 
     if already_reporting
       logger.warn "FAILBOT: asked to report while reporting! #{data.inspect}" rescue nil
@@ -222,28 +254,39 @@ module Failbot
   #         stack hashes.
   #
   # Returns a Hash with all keys and values.
-  def squash_context(*other)
-    merged = {}
-    (context + other).each do |hash|
+  def squash_contexts(*contexts_to_squash)
+    squashed = {}
+
+    contexts_to_squash.flatten.each do |hash|
       hash.each do |key, value|
         value = (value.call rescue nil) if value.kind_of?(Proc)
-        merged[key.to_s] =
-          case value
-          when Time
-            value.iso8601
-          when Date
-            value.strftime("%F") # equivalent to %Y-%m-%d
-          when Numeric
-            value
-          when String, true, false
-            value.to_s
-          else
-            value.inspect
-          end
+        squashed[key.to_s] = value
       end
     end
-    merged["app"] = @app_override if @app_override
-    merged
+
+    squashed
+  end
+
+  def sanitize(attrs)
+    result = {}
+
+    attrs.each do |key, value|
+      result[key] =
+        case value
+        when Time
+          value.iso8601
+        when Date
+          value.strftime("%F") # equivalent to %Y-%m-%d
+        when Numeric
+          value
+        when String, true, false
+          value.to_s
+        else
+          value.inspect
+        end
+    end
+
+    result
   end
 
   # Extract exception info into a simple Hash.

data/lib/failbot/compat.rb

@@ -40,8 +40,6 @@ module Failbot
     # memory - Dummy backend that simply save exceptions in memory. Typically
     #          used in testing environments.
     #
-    # heroku - In-process posting for outside of vpn apps
-    #
     # file   - Append JSON-encoded exceptions to a file.
     #
     # Returns the String backend name. See also `Failbot.backend`.
@@ -108,12 +106,6 @@ module Failbot
         Failbot::MemoryBackend.new
       when 'file'
         Failbot::FileBackend.new(config['file_path'])
-      when 'heroku', 'http'
-        if backend_name == "heroku"
-          warn "The Failbot \"heroku\" backend is deprecated. Use \"http\" " \
-            "instead. #{caller[1]}"
-        end
-        Failbot::HerokuBackend.new(config['haystack'])
       else
         raise ArgumentError, "Unknown backend: #{backend_name.inspect}"
       end

data/lib/failbot/file_backend.rb

@@ -23,5 +23,9 @@ module Failbot
       end
       reports
     end
+
+    def ping
+      raise StandardError, "cannot write to #{@path}" unless File.writable?(@path)
+    end
   end
 end

data/lib/failbot/haystack.rb

@@ -20,9 +20,28 @@ module Failbot
       # make a post
       post = Net::HTTP::Post.new(@url.path)
       post.set_form_data('json' => Yajl.dump(data))
+      response = send_request(post)
 
+      # Raise if the exception doesn't make it to Haystack, ensures the failure
+      # is logged
+      raise StandardError, "couldn't send exception to Haystack" unless response.code == "201"
+    end
+
+    def self.send_data(data)
+      new(Failbot.haystack).send_data(data)
+    end
+
+    def ping
+      request = Net::HTTP::Head.new('/')
+      response = send_request(request)
+      raise StandardError, "haystack returned #{response.code}" unless response.code == "200"
+    end
+
+    private
+
+    def send_request(request)
       if user && password
-        post.basic_auth(user, password)
+        request.basic_auth(user, password)
       end
 
       # make request
@@ -32,15 +51,7 @@ module Failbot
       http.use_ssl = true if @url.scheme == "https"
 
       # push it through
-      response = http.request(post)
-
-      # Raise if the exception doesn't make it to Haystack, ensures the failure
-      # is logged
-      raise StandardError, "couldn't send exception to Haystack" unless response.code == "201"
-    end
-
-    def self.send_data(data)
-      new(Failbot.haystack).send_data(data)
+      http.request(request)
     end
   end
 end

data/lib/failbot/http_backend.rb

@@ -15,5 +15,9 @@ module Failbot
     def reports
       []
     end
+
+    def ping
+      @haystack.ping
+    end
   end
 end

data/lib/failbot/json_backend.rb

@@ -15,14 +15,46 @@ module Failbot
     end
 
     def report(data)
-      @socket = TCPSocket.new @host, @port
       payload = Yajl.dump(data)
-      @socket.send(payload, 0)
-      @socket.close
+
+      response = socket do |s|
+        s.send(payload, 0)
+        nil
+      end
     end
 
     def reports
       raise NotImplementedError
     end
+
+    def ping
+       response = socket do |s|
+        s.send("PING", 0)
+        s.close_write
+        s.read
+      end
+
+      raise StandardError, "failbotd didn't respond to PING, #{response} returned" unless response.start_with?("PONG")
+    end
+
+    private
+
+    # Connect to failbotd and yield the connection.
+    #
+    # Messages are framed by closing the write end of the socket, both ends of
+    # the socket are closed upon return from the block.
+    #
+    # block :: TCPSocket -> AnyType
+    #          A block invoked invoked with an open socket to failbotd. The
+    #          return value is returned from this method.
+    #
+    # Returns the return value of the block.
+    def socket(&block)
+      socket = TCPSocket.new @host, @port
+      response = yield socket
+      response
+    ensure
+      socket.close
+    end
   end
 end

data/lib/failbot/memory_backend.rb

@@ -18,5 +18,9 @@ module Failbot
 
       @reports << data
     end
+
+    def ping
+      # nop
+    end
   end
 end

data/lib/failbot/middleware.rb

@@ -35,7 +35,7 @@ module Failbot
         :method       => request.request_method,
         :user_agent   => env['HTTP_USER_AGENT'],
         :params       => filtered_parameters(env, params),
-        :session      => (request.session.to_hash rescue nil),
+        :session      => filtered_parameters(env, (request.session.to_hash rescue {})),
         :referrer     => request.referrer,
         :remote_ip    => request.ip,
         :url          => request.url

data/lib/failbot/version.rb

@@ -1,3 +1,3 @@
 module Failbot
-  VERSION = "1.1.5"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: failbot
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - "@rtomayko"
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -81,7 +81,6 @@ files:
 - lib/failbot/failbot.yml
 - lib/failbot/file_backend.rb
 - lib/failbot/haystack.rb
-- lib/failbot/heroku_backend.rb
 - lib/failbot/http_backend.rb
 - lib/failbot/json_backend.rb
 - lib/failbot/memory_backend.rb

data/lib/failbot/heroku_backend.rb

@@ -1,15 +0,0 @@
-module Failbot
-  class HerokuBackend
-    def initialize(url)
-      @hubble = Failbot::Haystack.new(url)
-    end
-
-    def report(data)
-      @hubble.send_data(data)
-    end
-
-    def reports
-      []
-    end
-  end
-end