redmine_airbrake_backend 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02aaf16472df5dc61443a9bc2ee67c615f8ad9d3
-  data.tar.gz: a90521ed091002dced77aa89e314dc087341d652
+  metadata.gz: fc1393573d1439588f21f8995af1bc85b4d8661e
+  data.tar.gz: eafd09a81fccf63b1b7af678fb59acf66d86401d
 SHA512:
-  metadata.gz: 677eb39c75a8af444887c31f2fa35ae566fd1ff4d14b4116f841ccb017e294905d309fa28731cb7728847071d467b71be7d502d0a32dddd8dcbe6ac8a1ef324f
-  data.tar.gz: b905d8b8722ebc99be7a0539ace444c4d6ce6be46fc84659664fa45d43d6b4c39c22117147f0310d52b3081ca7848135daf16f3fd13946ccc081436c31df5f70
+  metadata.gz: f1e451b7341129c911d65f16fe679980d5d5efd4a3c9d2b70b771ca4e13b3ff0f69b6a873ed8e69bd34d28758e5cb75ec501e292b6ae0405dfcec3b4d9e6da74
+  data.tar.gz: 97012b7e3cc150080116ea79121de9cc84602ab82ea125c345f3530ab69f0a9ba869298defabe076c0b31acd048347359c07bb25c6043c52eb0d1676dbd34917

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    redmine_airbrake_backend (0.5.0)
+      hpricot
+      htmlentities
+      rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activerecord (4.1.6)
+      activemodel (= 4.1.6)
+      activesupport (= 4.1.6)
+      arel (~> 5.0.0)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    erubis (2.7.0)
+    hike (1.2.3)
+    hpricot (0.8.6)
+    htmlentities (4.3.2)
+    i18n (0.6.11)
+    json (1.8.1)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.2)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.6)
+      actionmailer (= 4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      activemodel (= 4.1.6)
+      activerecord (= 4.1.6)
+      activesupport (= 4.1.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.6)
+      sprockets-rails (~> 2.0)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    sprockets (2.12.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  redmine_airbrake_backend!

data/Rakefile

@@ -4,7 +4,10 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
+Bundler::GemHelper.install_tasks
+
 require 'rdoc/task'
+require 'rake/testtask'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -14,14 +17,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-#APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-#load 'rails/tasks/engine.rake'
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'

data/app/controllers/airbrake_controller.rb

@@ -1,171 +1,151 @@
-require 'redmine_airbrake_backend/notice'
+require 'tempfile'
+require 'redmine_airbrake_backend/request/xml'
+require 'redmine_airbrake_backend/request/json'
 
+# Controller with airbrake related stuff
 class AirbrakeController < ::ApplicationController
-  protect_from_forgery except: :notice
-  prepend_before_filter :parse_notice_and_api_auth
-  before_filter :load_records
-
-  accept_api_auth :notice
-
-  def notice
-    return unless authorize(:issues, :create)
-
-    # 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
-    @issue = Issue.new(
-        subject: subject,
-        project: @project,
-        tracker: @tracker,
-        author: User.current,
-        category: @category,
-        priority: @priority,
-        description: render_description,
-        assigned_to: @assignee
-      ) unless @issue
+  skip_before_filter :verify_authenticity_token
 
-    custom_field_values = {}
+  before_filter :authorize_airbrake
+  before_filter :handle_request
 
-    # Error hash
-    custom_field_values[notice_hash_field.id] = notice_hash if @issue.new_record?
+  after_filter :cleanup_tempfiles
 
-    # Update occurrences
-    if occurrences_field.present?
-      occurrences_value = @issue.custom_value_for(occurrences_field.id)
-      custom_field_values[occurrences_field.id] = ((occurrences_value ? occurrences_value.value.to_i : 0) + 1).to_s
-    end
+  rescue_from RedmineAirbrakeBackend::Request::Error, with: :render_bad_request
 
-    @issue.custom_field_values = custom_field_values
+  private
 
-    # Reopen if closed
-    if reopen? && @issue.status.is_closed?
-      desc = "*Issue reopened after occurring again in _#{@notice.env[:environment_name]}_ environment.*"
-      desc << "\n\n#{render_description}" if project_setting(:reopen_repeat_description)
+  def authorize_airbrake
+    @project = @request.project
 
-      @issue.status = IssueStatus.where(is_default: true).order(:position).first
-      @issue.init_journal(User.current, desc)
-    end
+    authorize(:issues, :create)
+  end
 
-    if @issue.save
-      render xml: {
-        notice: {
-          id: notice_hash,
-          url: issue_url(@issue)
-        }
-      }
-    else
-      render nothing: true, status: :internal_server_error
-    end
+  def render_bad_request(error)
+    render text: error.message, status: :bad_request
   end
 
-  private
+  def parse_xml_request
+    @request  = RedmineAirbrakeBackend::Request::XML.parse(request.body)
 
-  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
+    params[:key] = @request.api_key
   end
 
-  def load_records
-    # Project
-    unless @project = Project.where(identifier: @notice.params[:project]).first
-      render text: 'Project not found!', status: :bad_request
-      return
-    end
+  def parse_json_request
+    @request  = RedmineAirbrakeBackend::Request::JSON.parse(params)
 
-    # Check configuration
-    if notice_hash_field.blank?
-      render text: 'Custom field for notice hash is not configured!', status: :internal_server_error
-      return
-    end
+    params[:key] = @request.api_key
+  end
 
-    # Tracker
-    unless (@tracker = record_for(@project.trackers, :tracker)) && @tracker.custom_fields.where(id: notice_hash_field.id).first
-      render text: 'Tracker not found!', status: :bad_request
-      return
-    end
+  def handle_request
+    @tempfiles = []
 
-    # Category
-    @category = record_for(@project.issue_categories, :category)
+    @results = []
 
-    # Priority
-    @priority = record_for(IssuePriority, :priority) || IssuePriority.default
+    @request.errors.each do |error|
+      issue = find_or_initialize_issue(error)
 
-    # Assignee
-    @assignee = record_for(@project.users, :assignee, [:id, :login])
-  end
+      set_custom_field_values(issue, @request, error.airbrake_hash)
 
-  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
+      reopen_issue(issue, error) if @request.reopen? && issue.status.is_closed?
 
-    project_setting(param_key)
+      if issue.save
+        @results << {
+          issue: issue,
+          hash:  error.airbrake_hash
+        }
+      end
+    end
   end
 
-  def project_setting(key)
-    return nil if @project.airbrake_settings.blank?
-    @project.airbrake_settings.send(key) if @project.airbrake_settings.respond_to?(key)
+  # Load or initialize issue by project, tracker and airbrake hash
+  def find_or_initialize_issue(error)
+    issue_ids = CustomValue.where(customized_type: Issue.name, custom_field_id: @request.notice_hash_field.id, value: error.airbrake_hash).pluck(:customized_id)
+
+    issue = Issue.where(id: issue_ids, project_id: @request.project.id, tracker_id: @request.tracker.id).first
+
+    return issue if issue.present?
+
+    issue = Issue.new(
+      subject: error.subject,
+      project: @request.project,
+      tracker: @request.tracker,
+      author: User.current,
+      category: @request.category,
+      priority: @request.priority,
+      description: render_description(error),
+      assigned_to: @request.assignee
+    )
+
+    add_error_attachments_to_issue(issue, error)
+
+    issue
   end
 
-  def subject
-    s = ''
-    if @notice.error[:class].blank? || @notice.error[:message].starts_with?("#{@notice.error[:class]}:")
-      s = "[#{notice_hash[0..7]}] #{@notice.error[:message]}"
-    else
-      s = "[#{notice_hash[0..7]}] #{@notice.error[:class]} #{@notice.error[:message]}"
+  def set_custom_field_values(issue, request, airbrake_hash)
+    custom_field_values = {}
+
+    # Error hash
+    custom_field_values[request.notice_hash_field.id] = airbrake_hash if issue.new_record?
+
+    # Update occurrences
+    if request.occurrences_field.present?
+      occurrences_value = issue.custom_value_for(request.occurrences_field.id)
+      custom_field_values[request.occurrences_field.id] = ((occurrences_value ? occurrences_value.value.to_i : 0) + 1).to_s
     end
-    s[0..254].strip
+
+    issue.custom_field_values = custom_field_values
   end
 
-  def notice_hash
-    h = []
-    h << @notice.error[:class]
-    h << @notice.error[:message]
-    h += normalized_backtrace
+  def add_error_attachments_to_issue(issue, error)
+    return if error.attachments.blank?
 
-    Digest::MD5.hexdigest(h.compact.join("\n"))
-  end
+    error.attachments.each do |attachment_data|
+      filename = attachment_data[:filename].presence || Redmine::Utils.random_hex(16)
 
-  def normalized_backtrace
-    if @notice.error.present? && @notice.error[:backtrace].present?
-      @notice.error[:backtrace].collect do |e|
-        "#{e[:file]}|#{e[:method].gsub(/_\d+_/, '')}|#{e[:number]}" rescue nil
-      end.compact
-    else
-      []
+      file = Tempfile.new(filename)
+      @tempfiles << file
+
+      file.write(attachment_data[:data])
+      file.rewind
+
+      attachment          = Attachment.new(file: file)
+      attachment.author   = User.current
+      attachment.filename = filename
+
+      issue.attachments << attachment
     end
   end
 
-  def notice_hash_field
-    custom_field(:hash_field)
-  end
+  def reopen_issue(issue, error)
+    return if @request.environment_name.blank?
 
-  def occurrences_field
-    custom_field(:occurrences_field)
-  end
+    desc = "*Issue reopened after occurring again in _#{@request.environment_name}_ environment.*"
+    desc << "\n\n#{render_description(error)}" if @request.reopen_repeat_description?
 
-  def custom_field(key)
-    @project.issue_custom_fields.where(id: setting(key)).first || CustomField.where(id: setting(key), is_for_all: true).first
-  end
+    issue.status = IssueStatus.where(is_default: true).order(:position).first
 
-  def reopen?
-    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
+    issue.init_journal(User.current, desc)
 
-  def setting(key)
-    Setting.plugin_redmine_airbrake_backend[key]
+    add_error_attachments_to_issue(issue, error)
   end
 
-  def render_description
-    if template_exists?("issue_description_#{@notice.params[:type]}", 'airbrake', true)
-      render_to_string(partial: "issue_description_#{@notice.params[:type]}")
+  def render_description(error)
+    locals = { request: @request, error: error }
+
+    if template_exists?("airbrake/issue_description/#{@request.type}")
+      render_to_string("airbrake/issue_description/#{@request.type}", layout: false, locals: locals)
     else
-      render_to_string(partial: 'issue_description')
+      render_to_string('airbrake/issue_description/default', layout: false, locals: locals)
     end
   end
 
+  def cleanup_tempfiles
+    return if @tempfiles.blank?
+
+    @tempfiles.each do |tempfile|
+      tempfile.close rescue nil
+      tempfile.unlink rescue nil
+    end
+  end
 end

data/app/controllers/airbrake_notice_controller.rb

@@ -0,0 +1,25 @@
+# Controller for airbrake notices
+class AirbrakeNoticeController < ::AirbrakeController
+  prepend_before_filter :parse_xml_request,  only: [:notice_xml]
+  prepend_before_filter :parse_json_request, only: [:notice_json]
+
+  accept_api_auth :notice_xml, :notice_json
+
+  # Handle airbrake XML notices
+  def notice_xml
+    render xml: {
+      notice: {
+        id: (@results.first[:hash] rescue nil)
+      }
+    }
+  end
+
+  # Handle airbrake JSON notices
+  def notice_json
+    render json: {
+      notice: {
+        id: (@results.first[:hash] rescue nil)
+      }
+    }
+  end
+end

data/app/controllers/airbrake_project_settings_controller.rb

@@ -1,3 +1,4 @@
+# Controller for project-specific airbrake settings
 class AirbrakeProjectSettingsController < ::ApplicationController
   before_filter :find_project
   before_filter :find_airbrake_setting
@@ -7,10 +8,11 @@ class AirbrakeProjectSettingsController < ::ApplicationController
   def update
     @airbrake_project_setting.safe_attributes = params[:airbrake_project_setting]
 
-    @airbrake_project_setting.save
+    if @airbrake_project_setting.save
+      flash[:notice] = l(:notice_successful_update)
+    end
 
-    flash[:notice] = l(:notice_successful_update)
-    redirect_to settings_project_path(@project, :tab => 'airbrake')
+    redirect_to settings_project_path(@project, tab: 'airbrake')
   end
 
   private
@@ -22,5 +24,4 @@ class AirbrakeProjectSettingsController < ::ApplicationController
   def find_airbrake_setting
     @airbrake_project_setting = @project.airbrake_settings || AirbrakeProjectSetting.new(project: @project)
   end
-
 end