rnotifier 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdc39bc4bb388b4f04a7da32a3a1c78f94f02776
-  data.tar.gz: 416474803f5349c511b8fd5f95b38cccc2208ffc
+  metadata.gz: 230323fb6bf53cf96bb51c161db128e700ee4418
+  data.tar.gz: 1d6ae42ba52711eb1dcf22f276d8ba6f1c08b83f
 SHA512:
-  metadata.gz: 8d8f7981351c4a9ced9be049a1f7732b77b5eaf55d8fb29cb1d837cea7165d795ad81d1261f6981371a118f34f80c256adede6935b622ae7eeaef281c5dc7b97
-  data.tar.gz: 8af20c69d211af538a61f6da359f95cded4cbd778c790fc5f30c7d398039f1e5b29083803773d3152a6926c36752ecb37918d8150f6e56ec74c21d63658f83a1
+  metadata.gz: 689155f28d570e40a98551e59b23e5837c82dd9a6fd85c67df1f383d60fc78a8c3e0fb315ab328d2bf350e64cb5516c2fc9ef47837b15b7f92898ee2fbed3260
+  data.tar.gz: e0ca66d1a5c13467fc94f2fe3effb39aa67095d6fb7b185ce2ea8ec9f66c1d6c4d13cc57aadd05cbd40bc3aef693583d99f68b3e39f8bf46cd2848b3d2b1399c

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+log

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'coveralls', require: false
+gem 'simplecov', require: false, group: :test
+gem 'coveralls', require: false, group: :test
 # Specify your gem's dependencies in rnotifier.gemspec
 gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Jiren Patel
+Copyright (c) 2013 Jiren Patel[jirenpatel@gmail.com]
 
 MIT License
 

data/README.md

@@ -28,6 +28,8 @@ Or install it yourself as:
     environments: development,test #default is production
     capture_code: true             #default false
     api_host: 'http://yourapp.com' #default http://rnotifier.com
+    ignore_exceptions: ActiveRecord::RecordNotFound,AbstractController::ActionNotFound,ActionController::RoutingError
+    ignore_bots: Googlebot
 
 ### To test config
 

data/lib/rnotifier/config.rb

@@ -14,7 +14,7 @@ module Rnotifier
 
     class << self
       attr_accessor :api_key, :exception_path, :event_path, :environments, :current_env, 
-        :valid, :app_env, :api_host, :ignore_exceptions, :capture_code
+        :valid, :app_env, :api_host, :ignore_exceptions, :capture_code, :ignore_bots
 
       def [](val)
         DEFAULT[val]
@@ -48,8 +48,10 @@ module Rnotifier
         self.api_host ||= DEFAULT[:api_host]
         self.exception_path = '/' + [DEFAULT[:api_version], DEFAULT[:exception_path]].join('/')
         self.app_env = get_app_env
-        self.ignore_exceptions = self.ignore_exceptions.split(',') if self.ignore_exceptions.is_a?(String)
 
+        self.ignore_exceptions = self.ignore_exceptions.split(',').map(&:strip) if self.ignore_exceptions.is_a?(String)
+        self.ignore_bots = self.ignore_bots.split(',').map(&:strip) if self.ignore_bots.is_a?(String)
+        
         self.event_path = '/' + [DEFAULT[:api_version], DEFAULT[:event_path]].join('/')
         self.valid = true 
       end

data/lib/rnotifier/event_data.rb

@@ -14,16 +14,19 @@ module Rnotifier
         :rnotifier_client => Config::CLIENT,
         :type => type,
       }
-      @data[:context_data] = Thread.current[:rnotifier_context] if Thread.current[:rnotifier_context]
+
       @data[:tags] = tags if tags
     end
 
     def notify
+      return false unless Config.valid?
+
       begin
-        Notifier.send(data, Rnotifier::Config.event_path)
+        Notifier.send(data, Config.event_path)
       rescue Exception => e
         Rlogger.error("[EVENT NOTIFY] #{e.message}")
         Rlogger.error("[EVENT NOTIFY] #{e.backtrace}")
+        false
       end
     end
 

data/lib/rnotifier/exception_code.rb

@@ -8,8 +8,8 @@ module Rnotifier
       def get(exception)
         return unless exception.backtrace
 
-        if exception.class == SyntaxError && exception.message.match(SYNTAX_ERROR_REGX)
-          bline = $1 
+        if exception.class == SyntaxError && m = exception.message.match(SYNTAX_ERROR_REGX)
+          bline = m[1]
         else
           bline = exception.backtrace.find do |l| 
             l.index(Config.app_env[:app_root]) == 0 && !Gem.path.any?{|path| l.index(path) == 0}

data/lib/rnotifier/exception_data.rb

@@ -13,8 +13,9 @@ module Rnotifier
     end
 
     def notify
-      return if !Config.valid?
-      return if Config.ignore_exceptions && Config.ignore_exceptions.include?(exception.class.to_s)
+      return false unless Config.valid?
+      return false if Config.ignore_exceptions && Config.ignore_exceptions.include?(exception.class.to_s)
+      return false if @options[:type] == :rack && is_bot?(@request.user_agent)
 
       begin
         data = options[:type] == :rack ? self.rack_exception_data : {:extra => self.env }
@@ -85,6 +86,12 @@ module Rnotifier
       headers
     end
 
+    def is_bot?(agent)
+      return false if agent.nil? || Config.ignore_bots.nil? || Config.ignore_bots.empty? 
+      
+      Config.ignore_bots.each { |bot| return true if (agent =~ Regexp.new(bot)) }
+      false
+    end
 
   end
 end

data/lib/rnotifier/rack_middleware.rb

@@ -3,7 +3,7 @@ module Rnotifier
 
     def initialize(app, config_file = nil)
       @app = app
-      Rnotifier.load_config(config_file) if config_file 
+      config_file ? Rnotifier.load_config(config_file) : Rnotifier.config 
     end
 
     def call(env)

data/lib/rnotifier/version.rb

@@ -1,3 +1,3 @@
 module Rnotifier
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/rnotifier.rb

@@ -18,7 +18,7 @@ require 'rnotifier/railtie' if defined?(Rails)
 module Rnotifier
   class << self
     def config(&block)
-      yield(Rnotifier::Config)
+      yield(Rnotifier::Config) if block_given?
       Rnotifier::Config.init
     end
 
@@ -28,7 +28,7 @@ module Rnotifier
       self.config do |c|
         c.api_key = config_yaml['apikey'] 
 
-        ['environments', 'api_host', 'ignore_exceptions', 'capture_code'].each do |f|
+        ['environments', 'api_host', 'ignore_exceptions', 'ignore_bots', 'capture_code'].each do |f|
           c.send("#{f}=", config_yaml[f]) if config_yaml[f]
         end
       end

data/spec/config_spec.rb

@@ -60,4 +60,22 @@ describe Rnotifier::Config do
     expect(Rnotifier::Config.valid?).to be_true
   end
 
+  it 'set config invalid if environments not set in config and app env is test or development' do
+    clear_config
+    ENV['RACK_ENV'] = 'test'
+    
+    Rnotifier.load_config("#{Dir.pwd}/spec/fixtures/rnotifier_ignore_env.yaml")
+
+    expect(Rnotifier::Config.valid?).to be_false
+  end
+
+  it 'set api key from the ENV variable RNOTIFIER_API_KEY' do
+    clear_config
+    ENV['RNOTIFIER_API_KEY'] = 'ENV-API-KEY'
+    Rnotifier::Config.init
+
+    expect(Rnotifier::Config.api_key).to eq 'ENV-API-KEY'
+    ENV['RNOTIFIER_API_KEY'] = nil
+  end
+
 end

data/spec/event_data_spec.rb

@@ -32,16 +32,21 @@ describe Rnotifier::EventData do
 
   it 'sends event data to server' do
     stubs = stub_faraday_request({:path => Rnotifier::Config.event_path})
-    Rnotifier::EventData.new(@name, @data).notify
+    status = Rnotifier::EventData.new(@name, @data).notify
 
+    expect(status).to be_true
     expect { stubs.verify_stubbed_calls }.to_not raise_error
   end
 
   it 'sends event data with tags to server' do
-    stubs = stub_faraday_request({:path => Rnotifier::Config.event_path})
-    Rnotifier.event(@name, @data, {:tags => [:new]})
+    [:event, :alert].each do |e|
+      stubs = stub_faraday_request({:path => Rnotifier::Config.event_path})
 
-    expect { stubs.verify_stubbed_calls }.to_not raise_error
+      status = Rnotifier.send(e, @name, @data, {:tags => [:new]})
+
+      expect(status).to be_true
+      expect { stubs.verify_stubbed_calls }.to_not raise_error
+    end
   end
 
 end

data/spec/exception_code_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 describe Rnotifier::ExceptionCode do
 
   before(:all) do
-    @file =  Dir.pwd + '/spec/code.text'
+    @file =  Dir.pwd + '/spec/fixtures/code.text'
     @lines = File.readlines(@file)
     @total_lines = 18
   end
@@ -44,5 +44,23 @@ describe Rnotifier::ExceptionCode do
     end
   end
 
+  it 'collect code lines for exception' do
+    rnotifier_init
+    code =  Rnotifier::ExceptionCode.get(mock_exception)
+    
+    lines = File.readlines(File.dirname(__FILE__) + "/mock_exception_helper.rb")[0..5]
+
+    expect(code).to eq([0].concat(lines))
+  end
+
+  it 'collect code lines for systax error' do
+    rnotifier_init
+    e = mock_syntax_error
+    code =  Rnotifier::ExceptionCode.get(e)
+
+    lines = File.readlines(File.dirname(__FILE__) + "/mock_exception_helper.rb")[6..-1]
+
+    expect(code).to eq([6].concat(lines))
+  end
 
 end

data/spec/exception_data_spec.rb

@@ -56,5 +56,32 @@ describe Rnotifier::ExceptionData do
     expect(params).to include({'useranme' => 'bar'})
   end
 
+  it 'match the user agent is bot or not' do
+    e_data = Rnotifier::ExceptionData.new(@exception, @env, @options)
+    expect(e_data.is_bot?(nil)).to be_false
+
+    user_agent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_4) AppleWebKit/536.30.1 (KHTML, like Gecko) Version/6.0.5 Safari/536.30.1'
+    expect(e_data.is_bot?(user_agent)).to be_false
+
+    user_agent = "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"
+    env = Rack::MockRequest.env_for(@url, @vars.merge({'HTTP_USER_AGENT' => user_agent}))
+
+    e_data = Rnotifier::ExceptionData.new(@exception, env, @options)
+    expect(e_data.is_bot?(user_agent)).to be_true
+  end
+
+  it 'ignores error for unwanted bot request' do
+   
+  end
+
+  it 'sends exception manually' do
+     stubs = stub_faraday_request
+     params = {:manual_exception => true}
+
+     status = Rnotifier.exception(@exception, params)
+
+     expect(status).to be_true
+     expect {stubs.verify_stubbed_calls }.to_not raise_error
+  end
 
 end

data/spec/fixtures/rnotifier.yaml

@@ -1,2 +1,3 @@
 apikey: API-KEY
 environments: production,staging,test
+ignore_bots: Googlebot

data/spec/fixtures/rnotifier_ignore_env.yaml

@@ -0,0 +1 @@
+apikey: API-KEY

data/spec/fixtures/{fake_app.rb → test_sinatra_app.rb}

@@ -3,7 +3,7 @@ require 'sinatra/base'
 
 module RnotifierTest
 
-  class FakeApp < Sinatra::Base
+  class TestSinatraApp < Sinatra::Base
     set :environment, :production
     use Rnotifier::RackMiddleware, 'spec/fixtures/rnotifier_test.yaml'
 

data/spec/mock_exception_helper.rb

@@ -0,0 +1,13 @@
+def mock_exception
+  begin
+    1 + '2'
+  rescue Exception => e
+    return e
+  end
+end
+
+def mock_syntax_error
+  e = SyntaxError.new("#{File.dirname(__FILE__)}/mock_exception_helper.rb:#{__LINE__}: syntax error, unexpected ||, expecting '}'")
+  e.set_backtrace([])
+  return e
+end

data/spec/spec_helper.rb

@@ -7,14 +7,22 @@ require 'rack'
 require 'rack/request'
 require 'rack/mock'
 require 'rack/test'
+require 'simplecov'
 require 'coveralls'
 
-$:.unshift(File.dirname(__FILE__) + '/../lib/')
-require 'rnotifier'
-require File.dirname(__FILE__) + "/fixtures/fake_app"
+SimpleCov.start do
+  add_filter '/spec/'
+  add_group 'gem', 'lib'
+end
 
 Coveralls.wear!
 
+$:.unshift(File.dirname(__FILE__) + '/../lib/')
+
+require 'rnotifier'
+require File.dirname(__FILE__) + '/mock_exception_helper' 
+require File.dirname(__FILE__) + '/fixtures/test_sinatra_app'
+
 RSpec.configure do |config|
   config.color_enabled = true
   #config.tty = true
@@ -22,7 +30,7 @@ RSpec.configure do |config|
   config.include Rack::Test::Methods
 
   def app
-    Rack::Lint.new(RnotifierTest::FakeApp.new)
+    Rack::Lint.new(RnotifierTest::TestSinatraApp.new)
   end
 end
 
@@ -46,11 +54,9 @@ def stub_faraday_request(opts = {})
   stubs
 end
 
-def mock_exception
-  begin
-    1 + '2'
-  rescue Exception => e
-    return e
-  end
+def clear_config
+  [:api_key, :exception_path, :event_path, :environments, :current_env,
+    :app_env, :api_host, :ignore_exceptions, :capture_code].each do |m|
+      Rnotifier::Config.send("#{m}=", nil)
+    end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rnotifier
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jiren Patel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -138,14 +138,16 @@ files:
 - lib/rnotifier/rlogger.rb
 - lib/rnotifier/version.rb
 - rnotifier.gemspec
-- spec/code.text
 - spec/config_spec.rb
 - spec/event_data_spec.rb
 - spec/exception_code_spec.rb
 - spec/exception_data_spec.rb
-- spec/fixtures/fake_app.rb
+- spec/fixtures/code.text
 - spec/fixtures/rnotifier.yaml
+- spec/fixtures/rnotifier_ignore_env.yaml
 - spec/fixtures/rnotifier_test.yaml
+- spec/fixtures/test_sinatra_app.rb
+- spec/mock_exception_helper.rb
 - spec/rack_middleware_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jiren/rnotifier
@@ -173,13 +175,15 @@ signing_key:
 specification_version: 4
 summary: Exception catcher for Rails and other Rack apps
 test_files:
-- spec/code.text
 - spec/config_spec.rb
 - spec/event_data_spec.rb
 - spec/exception_code_spec.rb
 - spec/exception_data_spec.rb
-- spec/fixtures/fake_app.rb
+- spec/fixtures/code.text
 - spec/fixtures/rnotifier.yaml
+- spec/fixtures/rnotifier_ignore_env.yaml
 - spec/fixtures/rnotifier_test.yaml
+- spec/fixtures/test_sinatra_app.rb
+- spec/mock_exception_helper.rb
 - spec/rack_middleware_spec.rb
 - spec/spec_helper.rb