rnotifier 0.0.6 → 0.0.8

data/lib/rnotifier.rb

@@ -1,15 +1,53 @@
+require 'socket'
+require 'yaml'
+require 'digest/md5'
+require 'multi_json'
+require 'faraday'
+
 require 'rnotifier/version'
-require 'net/http'
-require 'json'
-require 'logger'
-require 'action_mailer'
+require 'rnotifier/config'
+require 'rnotifier/rlogger'
+require 'rnotifier/notifier'
+require 'rnotifier/exception_data' 
+require 'rnotifier/rack_middleware'
+require 'rnotifier/parameter_filter'
+require 'rnotifier/exception_code'
+require 'rnotifier/railtie' if defined?(Rails)
 
 module Rnotifier
-	autoload :Notifier,        'rnotifier/notifier'
-	autoload :Configuration,   'rnotifier/configuration'
-	autoload :RailsException,  'rnotifier/rails_exception'
-	autoload :EmailNotifier,   'rnotifier/email_notifier'
-	autoload :Util,            'rnotifier/util'
-	autoload :Rlogger,         'rnotifier/rlogger'
-end
+  class << self
+    def config(&block)
+      yield(Rnotifier::Config)
+      Rnotifier::Config.init
+    end
+
+    def load_config(file)
+      config_yaml = YAML.load_file(file)
+
+      self.config do |c|
+        c.api_key = config_yaml['apikey'] 
+
+        ['environments', 'api_host', 'ignore_exceptions', 'capture_code'].each do |f|
+          c.send("#{f}=", config_yaml[f]) if config_yaml[f]
+        end
+      end
+    end
 
+    def context(attrs = {})
+      if Thread.current[:rnotifier_context] 
+        Thread.current[:rnotifier_context].merge!(attrs)
+      else
+        Thread.current[:rnotifier_context] = attrs
+      end
+    end
+
+    def clear_context
+      Thread.current[:rnotifier_context] = nil
+    end
+
+    def send_exception(exception, opts = {})
+      Rnotifier::ExceptionData.new(exception, opts, {:type => :rescue}).notify
+    end
+
+  end
+end

data/rnotifier.gemspec

@@ -1,19 +1,28 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/rnotifier/version', __FILE__)
-#require "rnotifier/version"
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rnotifier/version'
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Jiren Patel"]
-  gem.email         = ["jiren@joshsoftware.com"]
-  gem.description   = %q{Rails 3 Exception catcher}
-  gem.summary       = %q{Rails 3 Exception catcher}
-  gem.homepage      = "https://github.com/jiren/rnotifier"
+Gem::Specification.new do |spec|
+  spec.name          = 'rnotifier'
+  spec.version       = Rnotifier::VERSION
+  spec.authors       = ['Jiren Patel']
+  spec.email         = ['jirenpatel@gmail.com']
+  spec.description   = %q{Exception catcher}
+  spec.summary       = %q{Exception catcher for Rails and other Rack apps}
+  spec.homepage      = 'https://github.com/jiren/rnotifier'
+  spec.license       = 'MIT'
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = "rnotifier"
-  gem.require_paths = ["lib"]
-  gem.version       = Rnotifier::VERSION
-  gem.add_dependency('json', '>= 1.5.3')
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '>= 0.8.7'
+  spec.add_dependency 'multi_json', '>= 1.7.2'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rspec-expectations'
 end

data/spec/code.text

@@ -0,0 +1,18 @@
+class User
+
+  attr_accessor :name, :address_1, :address_2
+
+  def initialize(name, address_1)
+    @name = name
+    @address_1 = address_1
+  end
+
+  def address
+    "#{@address_1} #{@address_2}"
+  end
+
+  def serach(q)
+    Tire.search(q)
+  end
+
+end

data/spec/config_spec.rb

@@ -0,0 +1,60 @@
+$:.unshift(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe Rnotifier::Config do
+  before(:all) do
+    @api_key = 'API-KEY'
+    @notification_path = '/' + [ Rnotifier::Config::DEFAULT[:api_version], 
+                                 Rnotifier::Config::DEFAULT[:notify_path], 
+                                 @api_key].join('/')
+  end
+
+  before(:each) do
+    ENV['RACK_ENV'] = @environments = 'production'
+
+    Rnotifier.config do |c|
+      c.api_key = @api_key
+      #c.environments = @environments
+    end
+  end
+
+  after(:each) do
+    ENV['RACK_ENV'] = 'test'
+  end
+
+  it 'has default config values' do
+    Rnotifier::Config.tap do |c|
+      expect(c.current_env).to eq @environments
+      expect(c.notification_path).to eq @notification_path
+      expect(c.api_key).to eq @api_key
+    end
+  end
+
+  it 'is invalid if config environments not include current env' do
+    ENV['RACK_ENV'] = 'staging'
+    Rnotifier.config{|c| c.environments = 'production'}
+    expect(Rnotifier::Config.valid?).to be_false
+  end
+
+  it 'is valid if config environments set to test or development' do
+    ['test', 'development'].each do |e|
+      ENV['RACK_ENV'] = e
+      Rnotifier.config{|c| c.environments = e}
+      expect(Rnotifier::Config.valid?).to be_true
+    end
+  end
+
+  it 'is invalid if api key blank' do
+    Rnotifier.config{|c| c.api_key = nil}
+    expect(Rnotifier::Config.valid?).to be_false
+  end
+
+  it 'is load config from the yaml file' do
+    Rnotifier.load_config("#{Dir.pwd}/spec/fixtures/rnotifier.yaml")
+
+    expect(Rnotifier::Config.api_key).to eq @api_key
+    expect(Rnotifier::Config.environments).to eq ['production', 'staging']
+    expect(Rnotifier::Config.valid?).to be_true
+  end
+
+end

data/spec/exception_code_spec.rb

@@ -0,0 +1,48 @@
+$:.unshift(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe Rnotifier::ExceptionCode do
+
+  before(:all) do
+    @file =  Dir.pwd + '/spec/code.text'
+    @lines = File.readlines(@file)
+    @total_lines = 18
+  end
+
+  it 'collect error line' do 
+    code = Rnotifier::ExceptionCode.find(@file, 5, 0)
+
+    expect(code[0]).to eq (5 - 1)
+    expect(code[1]).to eq @lines[4]
+  end
+
+  it 'collect error line with range context' do
+    code = Rnotifier::ExceptionCode.find(@file, 5, 3)
+    expect(code[0]).to eq (5 - 3 - 1)
+
+    @lines[code[0]..(5 + 3 - 1)].each_with_index do |l, i|
+      expect(code[i+1]).to eq l
+    end
+
+  end
+
+  it 'collect error line from the file start' do
+    code = Rnotifier::ExceptionCode.find(@file, 1, 3)
+    expect(code[0]).to eq 0
+
+    @lines[code[0]..3].each_with_index do |l, i|
+      expect(code[i+1]).to eq l
+    end
+  end
+
+  it 'collect error line from the end of file' do
+    code = Rnotifier::ExceptionCode.find(@file, @lines.count, 3)
+    expect(code[0]).to eq (@lines.count - 3 - 1)
+
+    @lines[code[0]..-1].each_with_index do |l, i|
+      expect(code[i+1]).to eq l
+    end
+  end
+
+
+end

data/spec/exception_data_spec.rb

@@ -0,0 +1,60 @@
+$:.unshift(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe Rnotifier::ExceptionData do
+
+  before(:all) do
+    rnotifier_init
+    @exception = mock_exception
+    @options = {:type => :rack}
+    @url = 'http://example.com/?foo=bar&quux=bla'
+    @vars = { 
+      'HTTP_REFERER' => 'http://localhost:3000/',
+      'HTTP_COOKIE' => '_test_app_session=yYUhYSVc1U291M2I5TWpsN0E9BjsARg%3D%3D--6d69651b1cfb6a98387eb2fd01005955b2ca5406; _gauges_unique=1;'
+    }
+    @env = Rack::MockRequest.env_for(@url, @vars)
+  end
+
+  it 'is initialize exception_data object for rack' do
+    e_data = Rnotifier::ExceptionData.new(@exception, @env, @options)
+
+    expect(e_data.exception).to eq @exception
+    expect(e_data.options).to eq @options
+    expect(e_data.request).to be_an_instance_of(Rack::Request)
+  end
+
+  it 'is build rack exception data' do
+    e_data = Rnotifier::ExceptionData.new(@exception, @env, @options)
+    data = e_data.rack_exception_data
+    request_data = data[:request]
+
+    expect(request_data[:url]).to eq @url
+    expect(request_data[:http_method]).to eq 'GET'
+    expect(request_data[:referer_url]).to eq @vars['HTTP_REFERER']
+
+    headers = {'referer' => @vars['HTTP_REFERER'], 'cookie' => '_test_app_session=[FILTERED] _gauges_unique=1;'}
+    expect(request_data[:headers]).to eq headers 
+    expect(request_data[:params]).to eq({'foo' => 'bar', 'quux' => 'bla'})
+    
+    exception_data = data[:exception]
+    expect(exception_data[:class_name]).to eq @exception.class.to_s
+    expect(exception_data[:message]).to eq @exception.message 
+  end
+
+  it 'is filter parameters' do
+
+    env = Rack::MockRequest.env_for(@url, {
+     'action_dispatch.parameter_filter' =>[:password],
+     'REQUEST_METHOD' => 'POST',
+     :input => 'password=foo&useranme=bar'
+    })
+
+    e_data = Rnotifier::ExceptionData.new(@exception, env, @options)
+    params = e_data.rack_exception_data[:request][:params]
+    
+    expect(params).to include({'password' => '[FILTERED]'})
+    expect(params).to include({'useranme' => 'bar'})
+  end
+
+
+end

data/spec/fixtures/fake_app.rb

@@ -0,0 +1,21 @@
+require 'sinatra'
+require 'sinatra/base'
+
+module RnotifierTest
+
+  class FakeApp < Sinatra::Base
+    use Rnotifier::RackMiddleware, 'spec/fixtures/rnotifier_test.yaml'
+
+    get '/' do
+      [200, {}, 'OK']
+    end
+
+    get '/exception/1' do
+      1 + '2'
+
+      [200, {}, 'OK']
+    end
+
+  end
+
+end

data/spec/fixtures/rnotifier.yaml

@@ -0,0 +1,2 @@
+apikey: API-KEY
+environments: production,staging

data/spec/fixtures/rnotifier_test.yaml

@@ -0,0 +1,2 @@
+apikey: API-KEY
+environments: test

data/spec/rack_middleware_spec.rb

@@ -0,0 +1,22 @@
+$:.unshift(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe Rnotifier::RackMiddleware do
+
+  before(:all) do
+    @type_error = "TypeError - String can't be coerced into Fixnum"
+  end
+
+  before(:each) do
+    @stubs = stub_faraday_request
+  end
+
+  it 'sends get request and catch exception' do
+     get "/exception/1"
+
+     expect(last_response.errors.split(/:\n/).first).to eq @type_error 
+     expect(last_response.status).to eq 500
+     expect { @stubs.verify_stubbed_calls }.to_not raise_error
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'open-uri'
+require 'rack'
+require 'rack/request'
+require 'rack/mock'
+require 'rack/test'
+require 'rnotifier'
+
+require File.dirname(__FILE__) + "/fixtures/fake_app"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  #config.tty = true
+  #config.formatter = :documentation
+  config.include Rack::Test::Methods
+
+  def app
+    Rack::Lint.new(RnotifierTest::FakeApp.new)
+  end
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib/')
+
+ENV['RACK_ENV'] = 'test'
+
+require 'rnotifier'
+
+def rnotifier_init
+  ENV['RACK_ENV'] = 'test'
+  Rnotifier.load_config("#{Dir.pwd}/spec/fixtures/rnotifier.yaml")
+end
+
+def set_test_adapter
+end
+
+def stub_faraday_request(opts = {})
+  opts[:status] ||= 200
+  opts[:message] ||= 'ok'
+  opts[:path] = '/' + [ Rnotifier::Config::DEFAULT[:api_version], Rnotifier::Config::DEFAULT[:notify_path], 'API-KEY'].join('/')
+
+  stubs = Faraday::Adapter::Test::Stubs.new
+  conn  = Faraday.new do |builder|
+    builder.adapter :test, stubs
+  end
+  stubs.post(opts[:path]) {|env| [opts[:status], {}, opts[:message]] }
+
+  Rnotifier::Notifier.instance_variable_set('@connection', conn)
+  stubs
+end
+
+def mock_exception
+  begin
+    1 + '2'
+  rescue Exception => e
+    return e
+  end
+end
+

metadata

@@ -1,97 +1,180 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rnotifier
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+version: !ruby/object:Gem::Version
+  version: 0.0.8
 platform: ruby
-authors: 
+authors:
 - Jiren Patel
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 5
-        - 3
-        version: 1.5.3
+date: 2013-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
   prerelease: false
-  requirement: *id001
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.2
   type: :runtime
-  name: json
-description: Rails 3 Exception catcher
-email: 
-- jiren@joshsoftware.com
-executables: []
-
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Exception catcher
+email:
+- jirenpatel@gmail.com
+executables:
+- rnotifier
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
+- bin/rnotifier
 - lib/generators/rnotifier/rnotifier_generator.rb
 - lib/generators/rnotifier/templates/initializer.rb
 - lib/rnotifier.rb
-- lib/rnotifier/configuration.rb
-- lib/rnotifier/email_notifier.rb
+- lib/rnotifier/config.rb
+- lib/rnotifier/exception_code.rb
+- lib/rnotifier/exception_data.rb
 - lib/rnotifier/notifier.rb
-- lib/rnotifier/rails_exception.rb
+- lib/rnotifier/parameter_filter.rb
+- lib/rnotifier/rack_middleware.rb
+- lib/rnotifier/railtie.rb
 - lib/rnotifier/rlogger.rb
-- lib/rnotifier/util.rb
 - lib/rnotifier/version.rb
-- lib/rnotifier/views/email_notifier/exception_notify.html.erb
 - rnotifier.gemspec
+- spec/code.text
+- spec/config_spec.rb
+- spec/exception_code_spec.rb
+- spec/exception_data_spec.rb
+- spec/fixtures/fake_app.rb
+- spec/fixtures/rnotifier.yaml
+- spec/fixtures/rnotifier_test.yaml
+- spec/rack_middleware_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jiren/rnotifier
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: Rails 3 Exception catcher
-test_files: []
-
+specification_version: 4
+summary: Exception catcher for Rails and other Rack apps
+test_files:
+- spec/code.text
+- spec/config_spec.rb
+- spec/exception_code_spec.rb
+- spec/exception_data_spec.rb
+- spec/fixtures/fake_app.rb
+- spec/fixtures/rnotifier.yaml
+- spec/fixtures/rnotifier_test.yaml
+- spec/rack_middleware_spec.rb
+- spec/spec_helper.rb

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License
-
-Copyright (c) 2011 Jiren Patel[joshsoftware.com]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.