rnotifier 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in rnotifier.gemspec
+gem 'rake'
+gem 'json'
+gemspec

data/README.md

@@ -0,0 +1,11 @@
+Rnotifier
+=============
+
+Rails 3 Exception catcher gem
+
+Usage
+-----
+
+In your rails app
+
+rails g rnotifier -k "API-KEY"

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/generators/rnotifier/rnotifier_generator.rb

@@ -0,0 +1,23 @@
+class RnotifierGenerator < Rails::Generators::Base
+
+	source_root File.expand_path('../templates', __FILE__)  
+	class_option :api_key, :aliases => '-k', :type => :string, :desc => 'Rnotifier API key.'
+
+	def add_config
+		if options[:api_key]
+			template 'initializer.rb', 'config/initializers/rnotifier.rb'
+      p "******* INFO *************" 
+      p "Set exception recipients email address in 'config/initializers/rnotifier.rb'"
+      p "i.e. c.exception_recipients => %w{user1@example.com, user2@example.com} "
+		else
+		  p 'Set option --api-key or -k.'
+		end
+	end
+
+	private
+	def api_key
+		"'#{options[:api_key]}'"
+	end
+
+end
+

data/lib/generators/rnotifier/templates/initializer.rb

@@ -0,0 +1,5 @@
+Rnotifier::Notifier.config do |c|
+  c.api_key = <%= api_key %>
+  c.exception_recipients = %w{user1@example.com user2@example.com}
+end
+

data/lib/rnotifier/configuration.rb

@@ -0,0 +1,49 @@
+module Rnotifier
+	class Configuration
+		DEFAULT_CONFIG = {
+			:api_host => 'http://rnotifier.com/notify/api/v1',
+			:validate_path => 'validate',
+			:notify_path => 'exception'
+		}
+
+		FILTER_PARAMS = ['password', 'password_confirmation'] 
+
+		class << self
+			attr_accessor :api_key
+			attr_accessor :client_ip
+			attr_accessor :client_host_name
+			attr_accessor :is_valid
+			attr_accessor :filter_params
+      attr_accessor :notification_server
+      attr_accessor :exception_recipients
+
+			def [](key)
+				DEFAULT_CONFIG[key] || send(key)
+			end
+
+			def validate_config
+
+        unless self.notification_server
+          self.notification_server = DEFAULT_CONFIG[:api_host]
+        else
+          self.notification_server += '/notify/api/v1'
+        end
+
+		    if self.api_key
+					response = Util.get(self[:validate_path])	
+					self.is_valid = true if response['valid_api_key']
+				else
+					Rlogger.error('[CONFIG] Check your config API key is not define.') 
+				end
+
+				unless self.is_valid
+					Rlogger.error('[CONFIG] Invalid API KEY. Please check it.') 
+				else
+					Rlogger.info('[CONFIG] API key is valid.')
+				end
+
+			end
+		end
+	end
+end
+

data/lib/rnotifier/email_notifier.rb

@@ -0,0 +1,19 @@
+module Rnotifier
+  class EmailNotifier < ActionMailer::Base
+    default :from => 'Rnotifier Exception<exception@rnotifier.in>'
+    self.mailer_name = 'email_notifier'
+    self.append_view_path "#{File.dirname(__FILE__)}/views"
+
+    def exception_notify(exception)
+      @exception = exception
+      @project_name = Rails.application.class.to_s.sub('::Application', '') 
+
+      emails = Configuration.exception_recipients
+      subject = "[RNOTIFIER][#{@project_name}##{@exception[:environment]}] #{@exception[:message]}"
+
+      mail(:to => emails, :subject => subject) do |format|
+        format.html { render "#{mailer_name}/exception_notify" }
+      end
+    end
+  end
+end

data/lib/rnotifier/notifier.rb

@@ -0,0 +1,58 @@
+module Rnotifier
+	class Notifier
+
+		class << self
+			def config(&block)
+		 		yield(Rnotifier::Configuration)
+				Configuration.validate_config rescue Rlogger.error('[CONFIG] Error from notification server.')
+
+				#Initialize Rails Exception handler
+				Rnotifier::RailsException.initialize if Configuration.is_valid
+
+				Configuration.filter_params ||= []
+
+				if Configuration.filter_params.empty?
+					Configuration.filter_params.concat(Configuration::FILTER_PARAMS)
+				end
+
+				Configuration.freeze
+			end
+
+			def send_exception(exception_data)
+				exception_data[:params] = filter_params(exception_data[:params])
+				exception_data[:occurred_at] = Time.now 
+
+				t = Thread.new do 
+					begin
+						response = Util.post(Configuration[:notify_path], {:exception_data => exception_data})
+
+						Rlogger.error("[SEND] #{response['message']}") unless response['notify']
+					rescue Exception => e
+						Rlogger.error("[SERVER] #{e.message}")
+						Rlogger.error("[SERVER] #{e.backtrace}")
+					end
+          send_email_notification(exception_data)
+				end
+			end
+
+      def send_email_notification(exception_data)
+        begin
+          EmailNotifier.exception_notify(exception_data).deliver
+        rescue Exception => e
+          Rlogger.error("[MAILER] #{e.message}")
+          Rlogger.error("[MAILER] #{e.backtrace}")
+        end
+      end
+
+			def filter_params(params = {})
+				return if params.empty?
+
+				Configuration.filter_params.each do |key|
+					params[key] = '[FILTERED]' if params.has_key?(key)
+				end
+				params
+			end
+
+    end
+	end
+end

data/lib/rnotifier/rails_exception.rb

@@ -0,0 +1,49 @@
+module Rnotifier
+	module RailsException
+		module Catcher
+
+			def self.included(base)
+				base.send(:alias_method, :render_exception_without_rnotifier, :render_exception)
+				base.send(:alias_method, :render_exception, :render_exception_with_rnotifier)
+			end
+
+      private
+      def render_exception_with_rnotifier(env,exception)
+        request = ActionDispatch::Request.new(env)
+        unless (@consider_all_requests_local || request.local?)
+          exception_data = {
+            :url => request.url,
+            :params => request.params,
+            :session => request.session,
+            :ip => request.ip,
+            :http_method => request.method,
+            :status_code => status_code(exception),
+            :class_name => exception.class.to_s,
+            :message => exception.message,
+            :exception_line => Rails.backtrace_cleaner.clean(exception.backtrace, :silent).first,
+            :backtrace => Rails.backtrace_cleaner.clean(exception.backtrace, nil),
+            :environment => Rails.env.capitalize,
+            :user_agent => request.user_agent
+          }
+
+          exception_data[:session].delete('session_id')
+          exception_data[:exception_hash] = Digest::MD5.hexdigest(exception_data[:message].gsub(/#<\w*:\w*>/, '') + 
+                                                                  exception_data[:exception_line])
+          exception_data[:env_variables] = Util.request_env(request.filtered_env)
+
+          Notifier.send_exception(exception_data)
+        end
+
+        render_exception_without_rnotifier(env, exception)
+      end
+
+    end
+
+    def self.initialize
+      if defined?(ActionDispatch::ShowExceptions)
+        Configuration.filter_params = Rails.application.config.filter_parameters.uniq
+        ActionDispatch::ShowExceptions.send(:include, Rnotifier::RailsException::Catcher)
+      end
+    end
+  end
+end

data/lib/rnotifier/rlogger.rb

@@ -0,0 +1,27 @@
+module Rnotifier
+	class Rlogger
+
+		LOG_TITLE = '[RNOTIFIER]'
+
+		class << self
+
+			def info(msg)
+				logger.info("#{LOG_TITLE}#{msg}")
+			end
+
+			def error(msg)
+				logger.error("#{LOG_TITLE}#{msg}")
+			end
+
+			def warn(msg)
+				logger.warn("#{LOG_TITLE}#{msg}")
+			end
+
+			private 
+			def logger
+				@rlogger ||= (defined?(Rails.logger) ? Rails.logger : Logger.new(STDERR))
+			end
+
+		end
+	end
+end

data/lib/rnotifier/util.rb

@@ -0,0 +1,29 @@
+module Rnotifier
+	class Util
+		class << self
+			def post(path, data = {}) 
+				url = URI.parse(Configuration.notification_server)
+				post = Net::HTTP::Post.new("#{url.path}/#{path}/#{Configuration[:api_key]}",{'Content-Type' =>'application/json'})
+
+				http = Net::HTTP.new(url.host, url.port)
+				http.use_ssl = true if url.port == 443
+				JSON.parse(http.request(post, data.to_json).body)
+			end
+
+			def get(path, params = {})
+				url = "#{Configuration.notification_server}/#{path}/#{Configuration[:api_key]}"
+				JSON.parse(Net::HTTP.get(URI.parse(url)))
+			end
+
+      def request_env(env)
+        env_hash = env.reject{|k,v| k.include?('action') || k.include?('rack')}
+        env_hash.delete('HTTP_COOKIE')
+        env_hash['HOSTNAME'] = Socket.gethostname
+
+        env_hash.to_json
+      end
+
+
+		end
+	end
+end

data/lib/rnotifier/version.rb

@@ -0,0 +1,3 @@
+module Rnotifier
+  VERSION = "0.0.2"
+end

data/lib/rnotifier/views/email_notifier/exception_notify.html.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
+  </head>
+  <body style='color:#333;font-size:14px;margin-top:30px;'>
+    <span style='font-size:15px;'>
+      <strong style='margin-right:45px;'>Project</strong> : <%= @project_name %>
+      <br/>
+      <strong style='margin-right:5px;'>Environment</strong> : <%= @exception[:environment] %>
+    </span>
+    <div style='border:2px solid #FBC7C6;padding:10px 15px;margin-top:20px;'>
+      <p style='font-weight:bold'>
+        Exception: <%= @exception[:message] %> 
+      </p>
+      <p>
+        <strong>Action : </strong><%= "#{@exception[:params][:controller]}##{@exception[:params][:action]}" %>
+      </p>
+      <p>
+        <strong>Exception Line : </strong><%= @exception[:exception_line] %>
+      </p>
+      <p>
+        <strong>Occurred at : </strong><%= @exception[:occurred_at] %> </p>
+      <p>
+        <strong>Request Url : </strong><%= "#{@exception[:http_method]}  #{@exception[:url]}" %>
+      </p>
+    </div>
+  </body>
+</html>

data/lib/rnotifier.rb

@@ -0,0 +1,15 @@
+require 'rnotifier/version'
+require 'net/http'
+require 'json'
+require 'logger'
+require 'action_mailer'
+
+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
+

data/rnotifier.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rnotifier/version', __FILE__)
+#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.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')
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: rnotifier
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jiren Patel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-18 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
+  prerelease: false
+  requirement: *id001
+  type: :runtime
+  name: json
+description: Rails 3 Exception catcher
+email: 
+- jiren@joshsoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- 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/notifier.rb
+- lib/rnotifier/rails_exception.rb
+- lib/rnotifier/rlogger.rb
+- lib/rnotifier/util.rb
+- lib/rnotifier/version.rb
+- lib/rnotifier/views/email_notifier/exception_notify.html.erb
+- rnotifier.gemspec
+homepage: https://github.com/jiren/rnotifier
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Rails 3 Exception catcher
+test_files: []
+