exception_notification-redmine 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4f3e09e0c4a178a42ea58d78ca5c39744463531
-  data.tar.gz: f671f36eb35d3f4d158453e41ff417d289e2baa0
+  metadata.gz: 7ea5ba9a31d299f90a015b6fddb06b635e543709
+  data.tar.gz: abc9e443b816d759b577560e9973411df7ecb4d3
 SHA512:
-  metadata.gz: 6c43bfbfef407ea3cdd04fee98175149dd282980c2c76f77348b1811f743435ee99dd47de39894d7d14636c1b96568efcfe8d43287a4779e1c695946f17a4a4b
-  data.tar.gz: a42974a96adac7a09128174eb1c83047b121a4a722e22e22598f3ddb169f0cef74d66d9d7b86f02698deff8b1debb9e3aaefcb41005d54ccc0b43c0bf86656aa
+  metadata.gz: b495d7d0926c6b2ffcd94fd31dea5800f4243d1b27ea76822d31f7df77c276774a9435acc17e14ce232bf3484727d9994afd901391d484a3a5d477f65df44b9d
+  data.tar.gz: db0682b400dd395e92a13e09f8710d5d2be1562c95db26d8d0d64a2df661401a43dbcdb9f77d9064a26a6f4a5524f01177c5c91418373b143e4f32aca1323f65

data/CHANGELOG

@@ -2,3 +2,6 @@ Version 0.0.1: Initial release
 Version 0.0.2: Use a custom field to avoid creation of same issue multiple times
 Version 0.1.0: Version bump, add README.md, TODO.md and LICENCE
 Version 0.1.1: Update README.md
+Version 0.2.0:
+- Add issue fomatting in Redmine
+- Add default issue prefix title

data/README.md

@@ -4,6 +4,8 @@ This gem add a Redmine notifier to Exception Notification.
 
 This Ruby gem is an extension of the [exception_notification gem](http://rubygems.org/gems/exception_notification) to support creating issues in Redmine.
 
+[![Gem Version](https://badge.fury.io/rb/exception_notification-redmine.svg)](http://badge.fury.io/rb/exception_notification-redmine)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,6 +32,7 @@ As of Rails 3 ExceptionNotification-Redmine is used as a rack middleware, or in
 Whatever::Application.config.middleware.use ExceptionNotification::Rack,
   # host_url: url of your Redmine host
   # issues_url: issues.json (Redmine REST API)
+  # issues_prefix: text prepended to the issue title (default: "[Error]")
   # api_key: the api key of the user that will be used to create the Redmine issue
   # project_id: create issues in the project with the given id, where id is either project_id or project identifier
   # tracker_id: create issues with the given tracker_id
@@ -39,8 +42,9 @@ Whatever::Application.config.middleware.use ExceptionNotification::Rack,
   # x_checksum_cf_id: custom field used to avoid creation of the same issue multiple times. You must use the DOM id assigned by Redmine to this field in the issue form. You can find it by creating an issue manually in your project and inspecting the HTML form, you should see something like name="issue[custom_field_values][19]", in this case the id would be 19.
   
   :redmine => {
-    :host_url => "http://redmine.example.com",
+    :host_url => "https://redmine.example.com",
     :issues_url => "issues.json",
+    :issues_prefix => "[Error]",
     :api_key => "123456",
     :project_id => "test-project",
     :tracker_id => "1", # Bug

data/lib/exception_notification/redmine/version.rb

@@ -1,5 +1,5 @@
 module ExceptionNotification
   module Redmine
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/exception_notifier/redmine/redmine.rb

@@ -1,59 +1,72 @@
 require 'action_dispatch'
 require 'httparty'
 require 'json'
+require 'erb'
+require 'pp'
 
 module ExceptionNotifier
   
   class RedmineNotifier
-
+    
+    module Redmine
+      class MissingController
+        def method_missing(*args, &block)
+        end
+      end
+    end
+    
     def initialize(config)
       @config = config
     end
 
     def call(exception, options={})
-      env = options[:env]
-      issue = compose_issue(options, exception)
-      create_issue(issue) unless issue_exist?(issue)
+      unless options[:env].nil?
+        compose_data(options[:env], exception, options)
+        issue = compose_issue
+        create_issue(issue) unless issue_exist?(issue)
+      end
     end
-
+    
     private
 
-    def compose_issue(options, exception)
-      env = options[:env]
-
-      unless env.nil?
-        options[:body] ||= {}
-        options[:body][:server] = Socket.gethostname
-        options[:body][:process] = $$
-        options[:body][:rails_root] = Rails.root if defined?(Rails)
-        options[:body][:exception] = { :error_class => exception.class.to_s,
-                                       :message => exception.message.inspect,
-                                       :backtrace => exception.backtrace }
-        options[:body][:data] = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
-
-        issue = {}
-        issue[:project_id] = @config[:project_id]
-        issue[:tracker_id] = @config[:tracker_id]
-        issue[:status_id] = @config[:status_id]
-        issue[:priority_id] = @config[:priority_id]
-        issue[:assigned_to_id] = @config[:assigned_to_id]
-        issue[:subject] = compose_subject(options, exception)
-        issue[:custom_fields] = [{ :id    => @config[:x_checksum_cf_id],
-                                   :value => encode_subject(issue[:subject])}]
-        issue[:description] = options[:body][:exception].inspect
-        issue
-      end
+    def compose_data(env, exception, options = {})
+      @env        = env
+      @exception  = exception
+      @options    = options
+      @kontroller = env['action_controller.instance'] || MissingController.new
+      @request    = ActionDispatch::Request.new(env)
+      @backtrace  = exception.backtrace ? clean_backtrace(exception) : []
+      @data       = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
     end
-
-    def compose_subject(options, exception)
-      env = options[:env]
-      kontroller = env['action_controller.instance'] || MissingController.new
-      subject = "#{kontroller.controller_name}##{kontroller.action_name}" if kontroller
-      subject << " (#{exception.class})"
-      subject << " #{exception.message.inspect}" if options[:verbose_subject]
+    
+    def compose_issue
+      issue = {}
+      issue[:project_id] = @config[:project_id]
+      issue[:tracker_id] = @config[:tracker_id]
+      issue[:status_id] = @config[:status_id]
+      issue[:priority_id] = @config[:priority_id]
+      issue[:assigned_to_id] = @config[:assigned_to_id]
+      issue[:subject] = compose_subject
+      issue[:custom_fields] = [{ :id    => @config[:x_checksum_cf_id],
+                                 :value => encode_subject(issue[:subject])}]
+      issue[:description] = compose_description
+      issue
+    end
+    
+    def compose_subject
+      subject = "#{@config[:issues_prefix]} " || "[Error] "
+      subject << "#{@kontroller.controller_name}##{@kontroller.action_name}" if @kontroller
+      subject << " (#{@exception.class})"
+      subject << " #{@exception.message.inspect}" if @options[:verbose_subject]
       subject.length > 120 ? subject[0...120] + "..." : subject
     end
 
+    def compose_description
+      template_path = "#{File.dirname(__FILE__)}/views/exception_notifier/issue.text.erb"
+      template = File.open(template_path, "r").read
+      ERB.new(template, nil, '-').result(binding)
+    end
+
     def issues_url(params = {})
       default_params = { :key => @config[:api_key] }
       encoded_params = URI.encode_www_form(default_params.merge(params))
@@ -77,5 +90,13 @@ module ExceptionNotifier
     def encode_subject(subject)
       Digest::SHA2.hexdigest(subject)
     end
+    
+    def clean_backtrace(exception)
+      if defined?(Rails) && Rails.respond_to?(:backtrace_cleaner)
+        Rails.backtrace_cleaner.send(:filter, exception.backtrace)
+      else
+        exception.backtrace
+      end
+    end
   end
 end

data/lib/exception_notifier/redmine/views/exception_notifier/issue.text.erb

@@ -0,0 +1,35 @@
+<%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in <%= @kontroller.controller_name %>#<%= @kontroller.action_name %>:
+
+<%= @exception.message %>
+<%= @backtrace.first %>
+
+h1. Request
+
+* URL        : <%= @request.url %>
+* HTTP Method: <%= @request.request_method %>
+* IP address : <%= @request.remote_ip %>
+* Parameters : <%= @request.filtered_parameters.inspect %>
+* Timestamp  : <%= Time.current %>
+* Server : <%= Socket.gethostname %>
+<% if defined?(Rails) -%>
+* Rails root : <%= Rails.root %>
+<% end -%>
+* Process: <%= $$ %>
+
+h1. Session
+
+* session id: <%= @request.ssl? ? "[FILTERED]" : (@request.session['session_id'] || (@request.env["rack.session.options"] && @request.env["rack.session.options"][:id])).inspect %>
+* data: <%= PP.pp(@request.session.to_hash, "") %>
+
+h1. Environment
+
+<% filtered_env = @request.filtered_env -%>
+<% max = filtered_env.keys.map(&:to_s).max { |a, b| a.length <=> b.length } -%>
+<% filtered_env.keys.map(&:to_s).sort.each do |key| -%>
+<% inspect_object = filtered_env[key].is_a?(Hash) || filtered_env[key].is_a?(Array) ? filtered_env[key].inspect : filtered_env[key].to_s -%>
+* <%= "%-*s: %s" % [max.length, key, inspect_object] %>
+<% end -%>
+
+h1. Backtrace
+
+<%= @backtrace.join("\n") %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification-redmine
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Piacentini
@@ -102,6 +102,7 @@ files:
 - lib/exception_notification/redmine/version.rb
 - lib/exception_notifier/redmine.rb
 - lib/exception_notifier/redmine/redmine.rb
+- lib/exception_notifier/redmine/views/exception_notifier/issue.text.erb
 homepage: https://github.com/Nuxos-Asia/exception_notification-redmine
 licenses:
 - MIT