redmine_airbrake_backend 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d8a9f1faf769ff932d95c7c834ee697dac4c686
-  data.tar.gz: 1b6e0a26f4e5587afa7be9fa38bedf892e79c784
+  metadata.gz: 0c4df3337dec81bfdd744a3ca6a7b741b29ceb59
+  data.tar.gz: 2e43509ade9e2934870111dbd47e8fe2fa5baf58
 SHA512:
-  metadata.gz: 1abf3729e9b38f7d0eb6d195d642632513ba8457cd84b0aa710d10d62725be77af8c25fd272341901033c62d5d5acbf5e8923da33d3ce6862f5c06de744ead16
-  data.tar.gz: 0ced6e811c22c9e5ed5587dad4c359f120edb1df50745c94916da5495fe02cb6acba2353ecb86d536d2fca50024528bf723e5567676fd92aed659ae678f12627
+  metadata.gz: 79d9a308477cf2ee7b1df7c825a9ecde9e10d34278d9656e3c221f6598424f5ae855cbcb6a023c10a6d2fbbf6401b3ee97bb2684b4004c8cf969e7a6f2cdd4c5
+  data.tar.gz: ed5d5aa24babd1201e680fdb5c761ae7e6cc1050e6bb15e6cb189e8a1790b58df9aa447a9ba23e98cf759b45fe258521478711d1b8c870a6fe78cb0d4ccc77e0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redmine_airbrake_backend (0.1.0)
+    redmine_airbrake_backend (0.2.0)
       hpricot
       htmlentities
       rails

data/README.md

@@ -46,7 +46,7 @@ end
 
 ## Notes
 
-Based and inspired by https://github.com/milgner/redmine_airbrake_server
+Based on https://github.com/milgner/redmine_airbrake_server
 
 ## Code Status
 

data/app/controllers/airbrake_controller.rb

@@ -1,24 +1,14 @@
-require 'json'
-require 'hpricot'
-require 'htmlentities'
+require 'redmine_airbrake_backend/notice'
 
 class AirbrakeController < ::ApplicationController
-  SUPPORTED_API_VERSIONS = %w(2.4)
-
-  prepend_before_filter :set_api_auth
-  before_filter :parse_notice
-  before_filter :init_vars
+  prepend_before_filter :parse_notice_and_api_auth
+  before_filter :load_records
 
   accept_api_auth :notice
 
   def notice
     return unless authorize(:issues, :create)
 
-    raise ArgumentError.new("Airbrake version not supported") unless SUPPORTED_API_VERSIONS.include?(@notice[:version])
-    raise ArgumentError.new("Project not found") unless @project
-    raise ArgumentError.new("Tracker not found") unless @tracker
-    raise ArgumentError.new("Tracker does not have a notice hash custom field") unless @tracker.custom_fields.where(id: notice_hash_field.id).first
-
     # Issue by project, tracker and hash
     issue_ids = CustomValue.where(customized_type: Issue.name, custom_field_id: notice_hash_field.id, value: notice_hash).select([:customized_id]).collect{|cv| cv.customized_id}
     @issue = Issue.where(id: issue_ids, project_id: @project.id, tracker_id: @tracker.id).first
@@ -29,7 +19,7 @@ class AirbrakeController < ::ApplicationController
         author: User.current,
         category: @category,
         priority: @priority,
-        description: render_to_string(partial: 'issue_description'),
+        description: render_description,
         assigned_to: @assignee
       ) unless @issue
 
@@ -42,7 +32,7 @@ class AirbrakeController < ::ApplicationController
     # Reopen if closed
     if reopen? && @issue.status.is_closed?
       @issue.status = IssueStatus.where(is_default: true).order(:position).first
-      @issue.init_journal(User.current, "Issue reopened after occurring again in environment #{@notice[:server_environment][:environment_name]}")
+      @issue.init_journal(User.current, "Issue reopened after occurring again in environment #{@notice.env[:environment_name]}")
     end
 
     # Hash
@@ -64,41 +54,73 @@ class AirbrakeController < ::ApplicationController
 
   private
 
-  def set_api_auth
-    params[:key] = redmine_params[:api_key] rescue nil
+  def parse_notice_and_api_auth
+    @notice = RedmineAirbrakeBackend::Notice.parse(request.body)
+    params[:key] = @notice.params[:api_key]
+  rescue RedmineAirbrakeBackend::Notice::NoticeInvalid, RedmineAirbrakeBackend::Notice::UnsupportedVersion
+    render nothing: true, status: :bad_request
   end
 
-  def redmine_params
-    JSON.parse(params[:notice][:api_key]).symbolize_keys
+  def load_records
+    # Project
+    unless @project = Project.where(identifier: @notice.params[:project]).first
+      render nothing: true, status: :bad_request
+      return
+    end
+
+    # Tracker
+    unless (@tracker = record_for(@project.trackers, :tracker)) && @tracker.custom_fields.where(id: notice_hash_field.id).first
+      render nothing: true, status: :bad_request
+      return
+    end
+
+    # Category
+    @category = record_for(@project.issue_categories, :category)
+
+    # Priority
+    @priority = record_for(IssuePriority, :priority) || IssuePriority.default
+
+    # Assignee
+    @assignee = record_for(@project.users, :assignee, [:id, :login])
   end
-  helper_method :redmine_params
 
-  def subject
-    if @notice[:error][:message].starts_with?("#{@notice[:error][:class]}:")
-      "[#{notice_hash[0..7]}] #{@notice[:error][:message]}"[0..254]
-    else
-      "[#{notice_hash[0..7]}] #{@notice[:error][:class]} #{@notice[:error][:message]}"[0..254]
+  def record_for(on, param_key, fields=[:id, :name])
+    fields.each do |field|
+      val = on.where(field => @notice.params[param_key]).first
+      return val if val.present?
     end
+
+    project_setting(param_key)
   end
 
-  def backtrace
-    if @notice[:error][:backtrace][:line].is_a?(Hash)
-      [@notice[:error][:backtrace][:line]]
+  def project_setting(key)
+    return nil if @project.airbrake_settings.blank?
+    @project.airbrake_settings.send(key) if @project.airbrake_settings.respond_to?(key)
+  end
+
+  def subject
+    if @notice.error[:message].starts_with?("#{@notice.error[:class]}:")
+      "[#{notice_hash[0..7]}] #{@notice.error[:message]}"[0..254]
     else
-      @notice[:error][:backtrace][:line]
+      "[#{notice_hash[0..7]}] #{@notice.error[:class]} #{@notice.error[:message]}"[0..254]
     end
   end
-  helper_method :backtrace
 
   def notice_hash
     h = []
-    h << @notice[:error][:class]
-    h << @notice[:error][:message]
-    h += backtrace.collect{|element| "#{element[:file]}|#{element[:method].gsub(/_\d+_/, '')}|#{element[:number]}"}
+    h << @notice.error[:class]
+    h << @notice.error[:message]
+    h += normalized_backtrace if @notice.error[:backtrace].present?
 
     Digest::MD5.hexdigest(h.compact.join("\n"))
   end
 
+  def normalized_backtrace
+    @notice.error[:backtrace].collect do |e|
+      "#{e[:file]}|#{e[:method].gsub(/_\d+_/, '')}|#{e[:number]}"
+    end
+  end
+
   def notice_hash_field
     custom_field(:hash_field)
   end
@@ -112,71 +134,20 @@ class AirbrakeController < ::ApplicationController
   end
 
   def reopen?
-    return false if project_setting(:reopen_regexp).blank?
-    !!(@notice[:server_environment][:environment_name] =~ /#{project_setting(:reopen_regexp)}/i)
+    return false if @notice.env.blank? || @notice.env[:environment_name].blank? || project_setting(:reopen_regexp).blank?
+    !!(@notice.env[:environment_name] =~ /#{project_setting(:reopen_regexp)}/i)
   end
 
   def setting(key)
     Setting.plugin_redmine_airbrake_backend[key]
   end
 
-  def project_setting(key)
-    return nil if @project.airbrake_settings.blank?
-    @project.airbrake_settings.send(key) if @project.airbrake_settings.respond_to?(key)
-  end
-
-  def parse_notice
-    @notice = params[:notice]
-
-    return @notice if @notice[:request].blank?
-
-    doc = Hpricot::XML(request.body)
-
-    convert_request_vars(:params, :params)
-    convert_request_vars(:cgi_data, :'cgi-data')
-    convert_request_vars(:session, :session)
-
-    unless @notice[:request][:params].blank?
-      @notice[:request][:params].delete(:action) # already known
-      @notice[:request][:params].delete(:controller) # already known
-    end
-  rescue
-    @notice = nil
-    render nothing: true, status: :bad_request
-  end
-
-  def convert_request_vars(type, pathname)
-    unless @notice[:request][type.to_sym].blank?
-      vars = convert_var_elements(doc/"/notice/request/#{pathname}/var")
-      @notice[:request][type.to_sym] = vars
-    end
-  end
-
-  def convert_var_elements(elements)
-    result = {}
-    elements.each do |elem|
-      result[elem.attributes['key']] = elem.inner_text
+  def render_description
+    if template_exists?("issue_description_#{@notice.params[:type]}", 'airbrake', true)
+      render_to_string(partial: "issue_description_#{@notice.params[:type]}")
+    else
+      render_to_string(partial: 'issue_description')
     end
-    result.delete_if{|k,v| k.strip.blank?}
-    result.symbolize_keys
-  end
-
-  def init_vars
-    # Project
-    @project = Project.where(identifier: redmine_params[:project]).first
-    return unless @project
-
-    # Tracker
-    @tracker = @project.trackers.where(id: redmine_params[:tracker]).first || @project.trackers.where(name: redmine_params[:tracker]).first || project_setting(:tracker)
-
-    # Category
-    @category = @project.issue_categories.where(id: redmine_params[:category]).first || @project.issue_categories.where(name: redmine_params[:category]).first || project_setting(:category)
-
-    # Priority
-    @priority = IssuePriority.where(id: redmine_params[:priority]).first || IssuePriority.where(name: redmine_params[:priority]).first || project_setting(:priority) || IssuePriority.default
-
-    # Assignee
-    @assignee = @project.users.where(id: redmine_params[:assignee]).first || @project.users.where(login: redmine_params[:assignee]).first
   end
 
 end

data/app/controllers/airbrake_project_settings_controller.rb

@@ -5,14 +5,11 @@ class AirbrakeProjectSettingsController < ::ApplicationController
 
   def update
     @airbrake_project_setting = @project.airbrake_settings || AirbrakeProjectSetting.new(project: @project)
-
-    @airbrake_project_setting.tracker = @project.trackers.where(id: params[:airbrake_project_setting][:tracker_id]).first
-    @airbrake_project_setting.category = @project.issue_categories.where(id: params[:airbrake_project_setting][:category_id]).first
-    @airbrake_project_setting.priority = IssuePriority.where(id: params[:airbrake_project_setting][:priority_id]).first
-    @airbrake_project_setting.reopen_regexp = params[:airbrake_project_setting][:reopen_regexp]
+    @airbrake_project_setting.safe_attributes = params[:airbrake_project_setting]
 
     @airbrake_project_setting.save
 
+    flash[:notice] = l(:notice_successful_update)
     redirect_to settings_project_path(@project, :tab => 'airbrake')
   end
 

data/app/helpers/airbrake_helper.rb

@@ -13,7 +13,7 @@ module AirbrakeHelper
     "* *#{name}:* #{value}"
   end
 
-  def format_backtrace(element)
+  def format_backtrace_element(element)
     @htmlentities ||= HTMLEntities.new
 
     repository = repository_for_backtrace_element(element)
@@ -34,8 +34,8 @@ module AirbrakeHelper
   def repository_for_backtrace_element(element)
     if element[:file].start_with?('[PROJECT_ROOT]')
       file = element[:file][14..-1]
-      if redmine_params.key?(:repository)
-        r = @project.repositories.where(identifier: (redmine_params[:repository] || '')).first
+      if @notice.params.key?(:repository)
+        r = @project.repositories.where(identifier: (@notice.params[:repository] || '')).first
         return r if r.present? && r.entry(file)
       else
         return @project.repositories.select{|r| r.entry(file)}.first

data/app/models/airbrake_project_setting.rb

@@ -1,4 +1,6 @@
 class AirbrakeProjectSetting < ActiveRecord::Base
+  include Redmine::SafeAttributes
+
   belongs_to :project
   Project.has_one :airbrake_settings, class_name: AirbrakeProjectSetting.name, dependent: :destroy
 
@@ -12,4 +14,6 @@ class AirbrakeProjectSetting < ActiveRecord::Base
   IssuePriority.has_many :airbrake_project_settings, dependent: :nullify
 
   validates_presence_of :project_id
+
+  safe_attributes :tracker_id, :category_id, :priority_id, :reopen_regexp
 end

data/app/views/airbrake/_issue_description.erb

@@ -1,38 +1,40 @@
-h1. <%= @notice[:error][:message] %>
+h1. <%= @notice.error[:message] %>
 
+<% if @notice.error.present? && @notice.error[:backtrace].present? %>
 h2. Stacktrace:
 
-p((. <%=raw backtrace.collect{|e| format_backtrace(e)}.join("\n") %>
+p((. <%=raw @notice.error[:backtrace].collect{|e| format_backtrace_element(e)}.join("\n") %>
+<% end %>
 
-<% if @notice[:request].present? %>
+<% if @notice.request.present? %>
 h2. Request:
 
-<%=format_list_item('URL', @notice[:request][:url]) %>
-<%=format_list_item('Component', @notice[:request][:component]) %>
-<%=format_list_item('Action', @notice[:request][:action]) %>
+<%=format_list_item('URL', @notice.request[:url]) %>
+<%=format_list_item('Component', @notice.request[:component]) %>
+<%=format_list_item('Action', @notice.request[:action]) %>
 
-<% if @notice[:request][:params].present? %>
+<% if @notice.request[:params].present? %>
 h2. Parameters: 
 
-<%=format_table(@notice[:request][:params]) %>
+<%=format_table(@notice.request[:params]) %>
 <% end %>
 
-<% if @notice[:request][:cgi_data].present? %>
+<% if @notice.request[:cgi_data].present? %>
 h2. Headers: 
 
-<%=format_table(@notice[:request][:cgi_data]) %>
+<%=format_table(@notice.request[:cgi_data]) %>
 <% end %>
 
-<% if @notice[:request][:session].present? %>
+<% if @notice.request[:session].present? %>
 h2. Session: 
 
-<%=format_table(@notice[:request][:session]) %>
+<%=format_table(@notice.request[:session]) %>
 <% end %>
 <% end %>
 
-<% if @notice[:server_environment].present? %>
+<% if @notice.env.present? %>
 h2. Environment
 
-<%=format_list_item('Directory', @notice[:server_environment][:project_root]) %>
-<%=format_list_item('Hostname', @notice[:server_environment][:hostname]) %>
+<%=format_list_item('Directory', @notice.env[:project_root]) %>
+<%=format_list_item('Hostname', @notice.env[:hostname]) %>
 <% end %>

data/app/views/projects/settings/_airbrake.html.erb

@@ -1,5 +1,7 @@
 <% @airbrake_project_setting ||= (@project.airbrake_settings || AirbrakeProjectSetting.new(project: @project)) %>
 
+<%= error_messages_for 'airbrake_project_setting' %>
+
 <h2><%= l(:label_airbrake) %></h2>
 
 <%= labelled_form_for :airbrake_project_setting, @airbrake_project_setting, url: airbrake_settings_project_path(@project), html: {method: :post, id: 'airbrake-form'} do |f| %>
@@ -7,19 +9,15 @@
 
   <div class="box tabular">
     <p>
-      <%=f.label :tracker_id %>
       <%=f.select :tracker_id, options_from_collection_for_select(@project.trackers, :id, :name, @airbrake_project_setting.tracker_id), include_blank: true %>
     </p>
     <p>
-      <%=f.label :category_id %>
       <%=f.select :category_id, options_from_collection_for_select(@project.issue_categories, :id, :name, @airbrake_project_setting.category_id), include_blank: true %>
     </p>
     <p>
-      <%=f.label :priority_id %>
       <%=f.select :priority_id, options_from_collection_for_select(IssuePriority.order(:position), :id, :name, @airbrake_project_setting.priority_id), include_blank: true %>
     </p>
     <p>
-      <%=f.label :reopen_regexp %>
       <%=f.text_field :reopen_regexp %>
       <br />
       (<%=l(:text_regexp_info)%>)

data/lib/redmine_airbrake_backend/notice.rb

@@ -0,0 +1,85 @@
+require 'json'
+require 'hpricot'
+require 'htmlentities'
+
+module RedmineAirbrakeBackend
+  class Notice
+    SUPPORTED_API_VERSIONS = %w(2.4)
+
+    class NoticeInvalid < StandardError; end
+    class UnsupportedVersion < StandardError; end
+
+    attr_reader :version, :params, :notifier, :error, :request, :env
+
+    def initialize(version, params, notifier, options={})
+      @version = version
+      @params = params
+      @notifier = notifier
+
+      @error = options.delete(:error)
+      @request = options.delete(:request)
+      @env = options.delete(:env)
+    end
+
+    def self.parse(xml_data)
+      doc = Hpricot::XML(xml_data)
+
+      raise NoticeInvalid if (notice = doc.at('notice')).blank?
+      raise NoticeInvalid if (version = notice.attributes['version']).blank?
+      raise UnsupportedVersion unless SUPPORTED_API_VERSIONS.include?(version)
+
+      params = JSON.parse(notice.at('api-key').inner_text).symbolize_keys rescue nil
+      raise NoticeInvalid if params.blank?
+
+      raise NoticeInvalid if (notifier = convert_element(notice.at('notifier'))).blank?
+
+      raise NoticeInvalid if (error = convert_element(notice.at('error'))).blank?
+      raise NoticeInvalid if error[:class].blank? || error[:message].blank?
+      error[:backtrace] = error[:backtrace][:line].is_a?(Array) ? error[:backtrace][:line] : [error[:backtrace][:line]] unless error[:backtrace].nil?
+
+      request = convert_element(notice.at('request'))
+      env = convert_element(notice.at('server-environment'))
+
+      new(version, params, notifier, error: error, request: request, env: env)
+    end
+
+    private
+
+    def self.convert_element(elem)
+      return nil if elem.nil?
+
+      return elem.children.first.inner_text if !elem.children.nil? && elem.children.count == 1 && elem.children.first.is_a?(Hpricot::Text)
+
+      return elem.attributes.to_hash.symbolize_keys if elem.children.nil?
+
+      return convert_var_elements(elem.children) if elem.children.count == elem.children.select{|c| c.name == 'var'}.count
+
+      h = {}
+      elem.children.each do |e|
+        key = format_hash_key(e.name)
+        if h.key?(key)
+          h[key] = [h[key]] unless h[key].is_a?(Array)
+          h[key] << convert_element(e)
+        else
+          h[key] = convert_element(e)
+        end
+      end
+      h.delete_if{|k,v| k.strip.blank?}
+      h.symbolize_keys
+    end
+
+    def self.convert_var_elements(elements)
+      vars = {}
+      elements.each do |elem|
+        vars[format_hash_key(elem.attributes['key'])] = elem.inner_text
+      end
+      vars.delete_if{|k,v| k.strip.blank?}
+      vars.symbolize_keys
+    end
+
+    def self.format_hash_key(key)
+      key.to_s.gsub(/-/, '_')
+    end
+
+  end
+end

data/lib/redmine_airbrake_backend/version.rb

@@ -1,3 +1,3 @@
 module RedmineAirbrakeBackend
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_airbrake_backend
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Florian Schwab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2013-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -107,6 +107,7 @@ files:
 - db/migrate/20130708102357_create_airbrake_project_settings.rb
 - lib/redmine_airbrake_backend.rb
 - lib/redmine_airbrake_backend/engine.rb
+- lib/redmine_airbrake_backend/notice.rb
 - lib/redmine_airbrake_backend/project_helper_patch.rb
 - lib/redmine_airbrake_backend/version.rb
 - redmine_airbrake_backend.gemspec