yogi_berra 0.1.7 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODE4NWE0ZDYyZWQ1ZjcyMzU3NmQ4NmIzY2NhYTE2N2ZkOTlkZWQyMA==
+    NGY3ZThlMDQ1ZDFhYjgwOWJjYjk0MWFlNTBlNGEyY2Y0MzcwYWNjMA==
   data.tar.gz: !binary |-
-    MWE5ZmQxZGNlMWFjM2VkZDUxMzI0YzM0Y2ViM2I1NWIyMjczODlhOQ==
+    ZDk1YmJjM2RkZmE2OWFmMjQ3YmJkMzgwMzYyMzk3YzFjODBjZDJmYw==
 SHA512:
   metadata.gz: !binary |-
-    MmRmZWIwOGM0NWZiMDBjYWFlZTZhMzVhNDhkNzIyMzE0ZjY3NzAwZWZlMjhj
-    YzA3ZjY0OTI3Njg4M2RkNzE0Y2QyMWI3YTc0NjUxMGJkMzY0NWFmNzdmZTdj
-    MzEyNDk4YzI3MmFiNmU0ZTU3ZTBiN2RlZTQxMTM1ZTBjNmMwOWY=
+    Y2ZiNDMzYzIxZGFjMGY0ZjM2YjZhMTlhOGRhYjQxNjA0NjRlMTEwNTdjYjY1
+    NDZhZjhmYTc3ZmE3NzBiMGIxMjkzYWEwOGU5YjdlN2IzZGQ2ZmZjZWUwYjcx
+    ZmU0NTk3MWE5NGVlZjBhOTllOGUzZTdkODk5OWZiMTVmZTg5NTY=
   data.tar.gz: !binary |-
-    OTBjNTk5NjM5MzJiNTQxNzc1ZDUyZGU5NGIyMjlkMzJmMzJlYWI1MGE5ZTA3
-    ZGU1ZTBiNDgyZDU4YWZlOTc0ZmM0OWE0MGMwMTM5ODZmOTQ0NTFjYmFkNzk5
-    ZDU2YzIxYzAzODA4M2IwZjdlOWNiOTcxNjVkZjE4YThjODRjZmE=
+    MzllNDEzMmFhMmIwNzJjOGI5NjY4YmJjMmU0MTJjYzMwZTQ0YTZjN2I1ZGRk
+    Yjc5OTU2ODBlZDk3ZjI4NDYwM2RlN2E3YzVmNzgwMmVhYmQ2NDQ5M2NkMWZi
+    OGM2MDc3MjQ4NzUyYjhlZDlkODdhYzcxMWNiZTY2ZWY4NmFmMGU=

data/Gemfile

@@ -4,5 +4,6 @@ gem "mongo", "~> 1.8.3"
 gem "rspec", "~> 2.13.0"
 gem "builder", "~> 3.2.1"
 gem "rake", "~> 10.0.4"
-
+gem 'coveralls', :require => false
+gem 'mime-types', '~> 1.17'
 gemspec

data/README.md

@@ -1,4 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/yogi_berra.png)](http://badge.fury.io/rb/yogi_berra)
 [![Build Status](https://travis-ci.org/earlonrails/yogi_berra.png?branch=master)](https://travis-ci.org/earlonrails/yogi_berra)
+[![Coverage Status](https://coveralls.io/repos/earlonrails/yogi_berra/badge.png)](https://coveralls.io/r/earlonrails/yogi_berra)
 
 Yogi Berra
 ==========
@@ -17,8 +19,8 @@ the buffer will be entered into the database. There can be data loss if the buff
 There are some messages in the logs which will tell you if the connection is down.
 This makes the catcher work when it does and not crash or slow when it doesn't.
 
-Installation
-------------
+Installation With Rails
+-----------------------
 
 add yogi_berra to your Gemfile:
 
@@ -37,6 +39,61 @@ Create a yogi.yml file in rails root config/ folder. Here is a sample:
       host: localhost
       port: 27017
 
+Rails 3+
+--------
+Generate an initializer
+
+    rails g yogi_berra:install [--resque|--sidekiq]
+
+
+Rails 2.3
+---------
+Create an initializer manually, here is an example:
+
+    require 'yogi_berra/rails'
+
+    # Sidekiq error handling support
+    # require 'yogi_berra/sidekiq'
+
+    # Resque error handling support
+    # require 'resque/failure/multiple'
+    # require 'resque/failure/redis'
+    # require 'yogi_berra/resque'
+
+    # Resque::Failure::Multiple.classes = [Resque::Failure::Redis, YogiBerra::Resque]
+    # Resque::Failure.backend = Resque::Failure::Multiple
+
+    YogiBerra.configure do |config|
+      # Ignore exception types.
+      # ActiveRecord::RecordNotFound, AbstractController::ActionNotFound and ActionController::RoutingError are already added.
+      # config.ignored_exceptions += %w{ActionView::TemplateError CustomError}
+
+      # Mongodb setup
+      # should point to the yogi.yml file which should contain the mongodb configuration settings ie
+      #
+      # defaults: &defaults
+      #   username: yogi
+      #   password: berra
+      #   project: rails_yogi_project
+      #
+      # test:
+      #   <<: *defaults
+      #   database: yogi_berra
+      #   host: localhost
+      #   port: 27017
+      #
+      # Optionally a replica set may be used by replacing host with
+      #
+      # replica_set:
+      #   - host1:27017
+      #   - host2:27017
+      #   - host3:27017
+      #
+
+      config.yogi_yml = "#{Rails.root}/config/yogi.yml"
+    end
+
+
 Without Rails
 -------------
 
@@ -63,6 +120,7 @@ Thanks
 ------
 
 To :
+
   - Thoughtbot Airbrake:
     https://github.com/airbrake/airbrake/tree/master/lib/airbrake
     This gem is awesome and was the base for most of the code here.

data/lib/generators/yogi_berra/install_generator.rb

@@ -0,0 +1,17 @@
+# require 'rails/generators/base'
+
+module YogiBerra
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates a YogiBerra initializer."
+
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :resque, :type => :boolean, :desc => 'Add support for handling errors in Resque jobs.'
+      class_option :sidekiq, :type => :boolean, :desc => 'Add support for handling errors in Sidekiq jobs.'
+
+      def copy_initializer
+        template 'yogi_berra.rb', 'config/initializers/yogi_berra.rb'
+      end
+    end
+  end
+end

data/lib/generators/yogi_berra/templates/yogi_berra.rb

@@ -0,0 +1,42 @@
+require 'yogi_berra/engine'
+
+# Sidekiq error handling support
+# require 'yogi_berra/sidekiq'
+
+# Resque error handling support
+# require 'resque/failure/multiple'
+# require 'resque/failure/redis'
+# require 'yogi_berra/resque'
+
+# Resque::Failure::Multiple.classes = [Resque::Failure::Redis, YogiBerra::Resque]
+# Resque::Failure.backend = Resque::Failure::Multiple
+
+YogiBerra.configure do |config|
+  # Ignore exception types.
+  # ActiveRecord::RecordNotFound, AbstractController::ActionNotFound and ActionController::RoutingError are already added.
+  # config.ignored_exceptions += %w{ActionView::TemplateError CustomError}
+
+  # Mongodb setup
+  # should point to the yogi.yml file which should contain the mongodb configuration settings ie
+  #
+  # defaults: &defaults
+  #   username: yogi
+  #   password: berra
+  #   project: rails_yogi_project
+  #
+  # test:
+  #   <<: *defaults
+  #   database: yogi_berra
+  #   host: localhost
+  #   port: 27017
+  #
+  # Optionally a replica set may be used by replacing host with
+  #
+  # replica_set:
+  #   - host1:27017
+  #   - host2:27017
+  #   - host3:27017
+  #
+
+  config.yogi_yml = "#{Rails.root}/config/yogi.yml"
+end

data/lib/yogi_berra/action_controller_catcher.rb

@@ -6,7 +6,7 @@ module YogiBerra
       if base.method_defined?(:rescue_action_in_public)
         base.send(:alias_method, :rescue_action_in_public_without_yogi, :rescue_action_in_public)
         base.send(:alias_method, :rescue_action_in_public, :rescue_action_in_public_with_yogi)
-        if YogiBerra::Catcher.settings
+        if YogiBerra.settings
           base.send(:alias_method, :rescue_action_locally_without_yogi, :rescue_action_locally)
           base.send(:alias_method, :rescue_action_locally, :rescue_action_locally_with_yogi)
         end

data/lib/yogi_berra/catcher.rb

@@ -1,34 +1,24 @@
 require 'mongo'
-require 'facets'
 require 'yaml'
 require 'timeout'
 
 module YogiBerra
   class Catcher
-    extend Facets
-    cattr_accessor :settings, :mongo_client, :connection
-
     class << self
       def load_db_settings(config_file = nil)
         if config_file
-          database_config = config_file
-        elsif defined?(::Rails)
-          database_config = Rails.root ? "#{Rails.root}/config/yogi.yml" : "config/yogi.yml"
-        else
-          YogiBerra::Logger.log("No config file specified!", :error)
+          YogiBerra.yogi_yml = config_file
         end
 
-        if database_config
-          begin
-            File.open(database_config, 'r') do |f|
-              yaml_file = YAML.load(f)
-              @@settings = yaml_file["#{environment}"] if yaml_file
-            end
-          rescue
-            YogiBerra::Logger.log("No such file: #{database_config}", :error)
+        begin
+          File.open(YogiBerra.yogi_yml, 'r') do |f|
+            yaml_file = YAML.load(f)
+            YogiBerra.settings = yaml_file["#{environment}"] if yaml_file
           end
-          @@settings
+        rescue
+          YogiBerra::Logger.log("No such file: #{database_config}", :error)
         end
+        YogiBerra.settings
       end
 
       def environment
@@ -44,21 +34,21 @@ module YogiBerra
       end
 
       def fork_database
-        host = @@settings["host"]
-        port = @@settings["port"]
-        database = @@settings["database"]
-        username = @@settings["username"]
-        password = @@settings["password"]
-        replica_set = @@settings["replica_set"]
+        host = YogiBerra.settings["host"]
+        port = YogiBerra.settings["port"]
+        database = YogiBerra.settings["database"]
+        username = YogiBerra.settings["username"]
+        password = YogiBerra.settings["password"]
+        replica_set = YogiBerra.settings["replica_set"]
 
         # :w => 0 set the default write concern to 0, this allows writes to be non-blocking
         # by not waiting for a response from mongodb
         Thread.new do
           begin
             if replica_set
-              @@mongo_client = Mongo::MongoReplicaSetClient.new(replica_set, :w => 0, :connect_timeout => 10)
+              YogiBerra.mongo_client = Mongo::MongoReplicaSetClient.new(replica_set, :w => 0, :connect_timeout => 10)
             else
-              @@mongo_client = Mongo::MongoClient.new(host, port, :w => 0, :connect_timeout => 10)
+              YogiBerra.mongo_client = Mongo::MongoClient.new(host, port, :w => 0, :connect_timeout => 10)
             end
           rescue Timeout::Error => timeout_error
             YogiBerra::Logger.log("Couldn't connect to the mongo database timeout on host: #{host} port: #{port}.\n #{timeout_error.inspect}", :error)
@@ -69,10 +59,10 @@ module YogiBerra
             retry
           end
 
-          @@connection = @@mongo_client[database]
+          YogiBerra.connection = YogiBerra.mongo_client[database]
           if username && password
             begin
-              @@connection.authenticate(username, password)
+              YogiBerra.connection.authenticate(username, password)
             rescue
               YogiBerra::Logger.log("Couldn't authenticate with user #{username} to mongo database on host: #{host} port: #{port} database: #{database}.", :warn)
             end
@@ -81,14 +71,14 @@ module YogiBerra
       end
 
       def connect(load_settings = false)
-        load_db_settings if load_settings
+        load_db_settings if load_db_settings
 
-        if @@settings
+        if YogiBerra.settings
           fork_database
         else
           YogiBerra::Logger.log("Couldn't load the yogi.yml file.", :error) if load_settings
         end
-        @@connection
+        YogiBerra.connection
       end
     end
   end

data/lib/yogi_berra/data.rb

@@ -14,13 +14,13 @@ module YogiBerra
       end
       # convert all the keys to strings for bson storage, using activesupport keys.rb file
       data.deep_stringify_keys_and_values!
-      YogiBerra::Catcher.connection["caught_exceptions"].insert(data)
+      YogiBerra.connection["caught_exceptions"].insert(data)
     end
 
     def self.parse_exception(notice)
       data_hash = {
         :error_class => "#{notice.exception.class}",
-        :project => YogiBerra::Catcher.settings["project"],
+        :project => YogiBerra.settings["project"],
         :error_message => notice.respond_to?(:error_message) ? notice.error_message : notice.message
       }
       data_hash[:backtraces] = notice.backtrace

data/lib/yogi_berra/resque.rb

@@ -0,0 +1,20 @@
+require 'resque/failure/base'
+
+module YogiBerra
+  class Resque < Resque::Failure::Base
+    def self.count
+      Stat[:failed]
+    end
+
+    def save
+      data = {
+        :queue  => queue,
+        :worker => worker.to_s,
+        :args   => payload["args"],
+        :class  => payload["class"].to_s
+      }
+
+      YogiBerra.exceptionize(exception, :resque => data)
+    end
+  end
+end

data/lib/yogi_berra/sidekiq.rb

@@ -0,0 +1,21 @@
+require 'sidekiq'
+
+module YogiBerra
+  class Sidekiq
+    def call(worker, message, queue)
+      begin
+        yield
+      rescue Exception => exception
+        message["worker"] = message.delete("jid")
+        YogiBerra.exceptionize(exception, :sidekiq => message)
+        raise exception
+      end
+    end
+  end
+end
+
+::Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add ::YogiBerra::Sidekiq
+  end
+end

data/lib/yogi_berra/version.rb

@@ -1,3 +1,3 @@
 module YogiBerra
-  VERSION = "0.1.7"
+  VERSION = "0.2.0"
 end

data/lib/yogi_berra.rb

@@ -4,14 +4,14 @@ require 'yogi_berra/notice'
 require 'yogi_berra/exception_middleware'
 require 'yogi_berra/data'
 require 'yogi_berra/logger'
-
-if defined?(::Rails.version) && ::Rails.version.to_f >= 3.0
-  require 'yogi_berra/engine'
-else
-  require 'yogi_berra/rails'
-end
+require 'facets'
+include Facets
 
 module YogiBerra
+  mattr_accessor :ignored_exceptions, :yogi_yml, :settings, :mongo_client, :connection
+  @@ignored_exceptions = %w{ActiveRecord::RecordNotFound AbstractController::ActionNotFound ActionController::RoutingError}
+  @@yogi_yml = "config/yogi.yml"
+
   class << self
     # Stores the notice exception
     # @see YogiBerra.exceptionize
@@ -19,13 +19,21 @@ module YogiBerra
     # @params environment
     # @params opts
     def exceptionize(exception, environment = nil, opts = {})
+      return false if ignored_exception?(exception)
       notice = build_notice_for(exception, opts)
-      if YogiBerra::Catcher.connection
+      if YogiBerra.connection
         YogiBerra::Data.store!(notice, environment)
       end
     end
 
+    def configure
+      yield self
+    end
+
     private
+    def ignored_exception?(exception)
+      @@ignored_exceptions.collect(&:to_s).include?(exception.class.name)
+    end
 
     def build_notice_for(exception, opts = {})
       exception = unwrap_exception(exception)

data/spec/fixtures/rails.rb

@@ -8,5 +8,6 @@ class Rails
     "test"
   end
 end
+YogiBerra.yogi_yml = "#{SPEC_FOLDER}/fixtures/config/yogi.yml"
 
 ENV['RAILS_ENV'] = "test"

data/spec/spec_helper.rb

@@ -2,6 +2,9 @@ SPEC_FOLDER = File.dirname(__FILE__)
 require 'yogi_berra'
 require 'rspec/mocks'
 
+require 'coveralls'
+Coveralls.wear!
+
 def build_exception
   raise Exception
 rescue Exception => caught_exception

data/spec/yogi_berra_catcher_spec.rb

@@ -11,16 +11,16 @@ describe YogiBerra::Catcher do
 
   it "should load a yaml file without rails" do
     lambda { YogiBerra::Catcher.load_db_settings(@test_yaml) }.should_not raise_error
-    YogiBerra::Catcher.settings.should_not == nil
-    YogiBerra::Catcher.settings["project"].should == "test_yogi_project"
+    YogiBerra.settings.should_not == nil
+    YogiBerra.settings["project"].should == "test_yogi_project"
   end
 
   it "should load a yaml file with rails" do
     ENV["YOGI_ENV"] = nil
     load "#{SPEC_FOLDER}/fixtures/rails.rb"
     lambda { YogiBerra::Catcher.load_db_settings }.should_not raise_error
-    YogiBerra::Catcher.settings.should_not == nil
-    YogiBerra::Catcher.settings["project"].should == "rails_yogi_project"
+    YogiBerra.settings.should_not == nil
+    YogiBerra.settings["project"].should == "rails_yogi_project"
     Object.send(:remove_const, :Rails)
   end
 
@@ -29,7 +29,7 @@ describe YogiBerra::Catcher do
     YogiBerra::Catcher.load_db_settings(@test_yaml)
     mock_yogi_fork_database
     lambda { YogiBerra::Catcher.connect }.should_not raise_error
-    YogiBerra::Catcher.connection.should_not == nil
+    YogiBerra.connection.should_not == nil
   end
 
   it "should grab a connection to mongodb" do
@@ -37,7 +37,7 @@ describe YogiBerra::Catcher do
     YogiBerra::Catcher.load_db_settings(@test_yaml)
     mock_yogi_fork_database
     YogiBerra::Catcher.connect
-    YogiBerra::Catcher.mongo_client.should_not == nil
+    YogiBerra.mongo_client.should_not == nil
   end
 
   it "should grab a connection and authenticate" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yogi_berra
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Earl Krauss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -88,6 +88,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/facets.rb
+- lib/generators/yogi_berra/install_generator.rb
+- lib/generators/yogi_berra/templates/yogi_berra.rb
 - lib/keys.rb
 - lib/yogi_berra/action_controller_catcher.rb
 - lib/yogi_berra/backtrace.rb
@@ -98,6 +100,8 @@ files:
 - lib/yogi_berra/logger.rb
 - lib/yogi_berra/notice.rb
 - lib/yogi_berra/rails.rb
+- lib/yogi_berra/resque.rb
+- lib/yogi_berra/sidekiq.rb
 - lib/yogi_berra/version.rb
 - lib/yogi_berra.rb
 - Gemfile