redmine_airbrake_backend 0.6.2 → 1.0.0

data/app/views/airbrake/issue_description/default.erb

@@ -1,50 +1,44 @@
-<% if error.present? %>
 h1. <%= error.message %>
 
-<% if error.application.present? %>
-h2. Application:
-
-<%= format_list_item('Name', error.application[:name]) %>
-<%= format_list_item('Version', error.application[:version]) %>
-<% end %>
 
 <% if error.backtrace.present? %>
 h2. Stacktrace:
 
-p((. <%= raw error.backtrace.collect { |e| format_backtrace_element(e) }.join("\n") %>
-<% end %>
+p((. <%= raw error.backtrace.map { |e| format_backtrace_element(e) }.join("\n") %>
 <% end %>
 
-<% if request.request.present? %>
-h2. Request:
 
-<%= format_list_item('URL', request.request[:url]) %>
-<%= format_list_item('Component', request.request[:component]) %>
-<%= format_list_item('Action', request.request[:action]) %>
+<% if error.application.present? %>
+h2. Application:
+
+<%= format_list_item('Name', error.application[:name]) %>
+<%= format_list_item('Version', error.application[:version]) %>
+<% end %>
+
 
-<% if request.request[:params].present? %>
+<% if params[:params].present? %>
 h2. Parameters:
 
-<%= format_table(request.request[:params]) %>
+<%= format_table(params[:params]) %>
 <% end %>
 
-<% if request.request[:cgi_data].present? %>
-h2. Headers:
 
-<%= format_table(request.request[:cgi_data]) %>
+<% if params[:session].present? %>
+h2. Session
+
+<%= format_table(params[:session]) %>
 <% end %>
 
-<% if request.request[:session].present? %>
-h2. Session:
 
-<%= format_table(request.request[:session]) %>
-<% end %>
+<% if params[:context].present? %>
+h2. Context
+
+<%= format_table(params[:context].reject { |k, v| [:notifier].include?(k) }) %>
 <% end %>
 
-<% if request.env.present? %>
+
+<% if params[:environment].present? %>
 h2. Environment
 
-<%= format_list_item('Name', request.environment_name) %>
-<%= format_list_item('Directory', request.env[:project_root]) %>
-<%= format_list_item('Hostname', request.env[:hostname]) %>
+<%= format_table(params[:environment]) %>
 <% end %>

data/config/locales/de.yml

@@ -4,7 +4,7 @@ de:
   field_reopen_regexp: Regulärer Ausdruck für erneutes Öffnen
   field_reopen_repeat_description: Neue Fehlerbeschreibung bei erneutem Öffnen anfügen
 
-  settings_airbrake_hash_field: "Benutzerdefiniertes Feld für Fehlernummer"
+  settings_airbrake_hash_field: "Benutzerdefiniertes Feld für Fehler-ID"
   settings_airbrake_occurrences_field: "Benutzerdefiniertes Feld für # Auftreten"
 
   project_module_airbrake: Airbrake

data/config/locales/en.yml

@@ -4,7 +4,7 @@ en:
   field_reopen_regexp: Reopen regular expression
   field_reopen_repeat_description: Add new description on reopen
 
-  settings_airbrake_hash_field: Notice Hash Custom Field
+  settings_airbrake_hash_field: Notice ID Custom Field
   settings_airbrake_occurrences_field: Occurrences Custom Field
 
   project_module_airbrake: Airbrake

data/config/routes.rb

@@ -1,8 +1,7 @@
 Rails.application.routes.draw do
-  # notifier api
-  post '/notifier_api/v2/notices'       => 'airbrake_notice#notice_xml'
-  post '/notifier_api/v3/notices'       => 'airbrake_notice#notice_json'
-  post '/notifier_api/v3/reports/:type' => 'airbrake_report#report'
+  # api
+  post '/api/v3/projects/:project_id/notices'     => 'airbrake_notice#notices'
+  post '/api/v3/projects/:project_id/ios-reports' => 'airbrake_report#ios_reports'
 
   # settings
   resources :projects do

data/lib/redmine_airbrake_backend.rb

@@ -4,4 +4,8 @@ module RedmineAirbrakeBackend
   def self.directory
     File.expand_path(File.join(File.dirname(__FILE__), '..'))
   end
+
+  def self.filter_hex_values(value)
+    value.gsub(/0x[0-9a-f]+/, '')
+  end
 end

data/lib/redmine_airbrake_backend/backtrace_element.rb

@@ -0,0 +1,37 @@
+require 'digest/md5'
+
+
+module RedmineAirbrakeBackend
+  # Backtrace element received by airbrake
+  class BacktraceElement
+    attr_reader :file, :line, :function, :column
+
+    def initialize(data)
+      # File
+      @file = data[:file].presence
+
+      # Line
+      @line = data[:line].presence
+
+      # Function
+      @function = data[:function].presence
+
+      # Column
+      @column = data[:column].presence
+    end
+
+    def checksum
+      @_checksum ||= Digest::MD5.hexdigest("#{@file}|#{normalize_function_name(@function)}|#{@line}|#{@column}")
+    end
+
+    private
+
+    def normalize_function_name(function_name)
+      name = @function
+        .downcase
+        .gsub(/_\d+_/, '') # ruby blocks
+
+      RedmineAirbrakeBackend.filter_hex_values(name)
+    end
+  end
+end

data/lib/redmine_airbrake_backend/engine.rb

@@ -36,10 +36,11 @@ module RedmineAirbrakeBackend
         description      'Airbrake Backend for Redmine'
         url              'https://github.com/ydkn/redmine_airbrake_backend'
         version          ::RedmineAirbrakeBackend::VERSION
-        requires_redmine version_or_higher: '3.1.0'
+        requires_redmine version_or_higher: '3.2.0'
         directory        RedmineAirbrakeBackend.directory
 
         project_module :airbrake do
+          permission :airbrake, { airbrake_notice: [:notices], airbrake_report: [:ios_reports] }
           permission :manage_airbrake, { airbrake: [:update] }
         end
 

data/lib/redmine_airbrake_backend/error.rb

@@ -1,45 +1,43 @@
 require 'digest/md5'
+require 'redmine_airbrake_backend/backtrace_element'
+
 
 module RedmineAirbrakeBackend
   # Error received by airbrake
   class Error
-    attr_accessor :request
     attr_reader :type, :message, :backtrace
-    attr_reader :application, :airbrake_hash, :subject, :attachments
-
-    def initialize(error_data)
-      # Data
-      @data = error_data
+    attr_reader :id, :subject, :application, :attachments
 
+    def initialize(data)
       # Type
-      @type = @data[:type]
+      @type = data[:type]
 
       # Message
-      @message = @data[:message]
+      @message = data[:message]
 
       # Backtrace
-      @backtrace = @data[:backtrace]
-
-      # Application
-      @application = @data[:application]
-
-      # Attachments
-      @attachments = @data[:attachments]
+      @backtrace = data[:backtrace].map { |b| BacktraceElement.new(b) }
 
-      # Hash
-      @airbrake_hash = generate_hash
+      # Error ID
+      @id = generate_id
 
       # Subject
       @subject = generate_subject
+
+      # Attachments
+      @attachments = data[:attachments].presence || []
+
+      # Application
+      @application = data[:application].presence
     end
 
     private
 
-    def generate_hash
+    def generate_id
       h = []
-      h << filter_hex_values(@type)
-      h << filter_hex_values(@message)
-      h += normalized_backtrace
+      h << RedmineAirbrakeBackend.filter_hex_values(@type)
+      h << RedmineAirbrakeBackend.filter_hex_values(@message)
+      h += @backtrace.map(&:checksum).compact
 
       Digest::MD5.hexdigest(h.compact.join("\n"))
     end
@@ -48,34 +46,12 @@ module RedmineAirbrakeBackend
       s = ''
 
       if @type.blank? || @message.starts_with?("#{@type}:")
-        s = "[#{@airbrake_hash[0..7]}] #{@message}"
+        s = "[#{@id[0..7]}] #{@message}"
       else
-        s = "[#{@airbrake_hash[0..7]}] #{@type}: #{@message}"
+        s = "[#{@id[0..7]}] #{@type}: #{@message}"
       end
 
       s[0..254].strip
     end
-
-    def normalized_backtrace
-      if @backtrace.present?
-        @backtrace.map do |e|
-          "#{e[:file]}|#{normalize_method_name(e[:method])}|#{e[:number]}" rescue nil
-        end.compact
-      else
-        []
-      end
-    end
-
-    def normalize_method_name(method_name)
-      name = e[:method]
-        .downcase
-        .gsub(/_\d+_/, '') # ruby blocks
-
-      filter_hex_values(name)
-    end
-
-    def filter_hex_values(value)
-      value.gsub(/0x[0-9a-f]+/, '')
-    end
   end
 end

data/lib/redmine_airbrake_backend/ios_report.rb

@@ -0,0 +1,87 @@
+require 'redmine_airbrake_backend/error'
+
+
+module RedmineAirbrakeBackend
+  # iOS Report received by airbrake
+  class IosReport < Error
+    def initialize(data)
+      super(IosReport.parse(data))
+    end
+
+    private
+
+    def self.parse(data)
+      error = {
+        application: {},
+        backtrace:   [],
+        attachments: [],
+      }
+
+      header_finished      = false
+      next_line_is_message = false
+      crashed_thread       = false
+      indicent_identifier  = nil
+
+      data.split("\n").each do |line|
+        header_finished = true if line =~ /^(Application Specific Information|Last Exception Backtrace|Thread \d+( Crashed)?):$/
+
+        unless header_finished
+          key, value = line.split(':', 2).map { |s| s.strip }
+
+          next if key.blank? || value.blank?
+
+          case key
+          when 'Exception Type'
+            error[:type] = value
+          when 'Exception Codes'
+            error[:message] = value
+          when 'Incident Identifier'
+            indicent_identifier = value
+          when 'Identifier'
+            error[:application][:name] = value
+          when 'Version'
+            error[:application][:version] = value
+          end
+        end
+
+        if next_line_is_message
+          next_line_is_message = false
+
+          error[:message] = line
+
+          if line =~ /^\*\*\* Terminating app due to uncaught exception '([^']+)', reason: '\*\*\* (.*)'$/
+            error[:type]    = Regexp.last_match(1)
+            error[:message] = Regexp.last_match(2)
+          else
+            error[:message] = line
+          end
+        end
+
+        crashed_thread = false if line =~ /^Thread \d+:$/
+
+        if crashed_thread
+          if line =~ /^(\d+)\s+([^\s]+)\s+(0x[0-9a-f]+)\s+(.+) \+ (\d+)$/
+            error[:backtrace] << {
+              file:     Regexp.last_match(2),
+              function: Regexp.last_match(4),
+              line:     Regexp.last_match(5)
+            }
+          end
+        end
+
+        crashed_thread = true if error[:backtrace].blank? && line =~ /^(Last Exception Backtrace|Thread \d+ Crashed):$/
+
+        next_line_is_message = true if line =~ /^Application Specific Information:$/
+      end
+
+      return nil if error.blank?
+
+      error[:attachments] << {
+        filename: "#{indicent_identifier}.crash",
+        data:     data
+      } if indicent_identifier.present?
+
+      error
+    end
+  end
+end

data/lib/redmine_airbrake_backend/version.rb

@@ -1,4 +1,4 @@
 module RedmineAirbrakeBackend
   # Version of this gem
-  VERSION = '0.6.2'
+  VERSION = '1.0.0'
 end

data/redmine_airbrake_backend.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rails'
-  spec.add_dependency 'nokogiri'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_airbrake_backend
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Florian Schwab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2016-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,17 +81,15 @@ files:
 - db/migrate/20130708102357_create_airbrake_project_settings.rb
 - db/migrate/20131003151228_add_reopen_repeat_description.rb
 - lib/redmine_airbrake_backend.rb
+- lib/redmine_airbrake_backend/backtrace_element.rb
 - lib/redmine_airbrake_backend/engine.rb
 - lib/redmine_airbrake_backend/error.rb
+- lib/redmine_airbrake_backend/ios_report.rb
 - lib/redmine_airbrake_backend/patches/issue_category.rb
 - lib/redmine_airbrake_backend/patches/issue_priority.rb
 - lib/redmine_airbrake_backend/patches/project.rb
 - lib/redmine_airbrake_backend/patches/projects_helper.rb
 - lib/redmine_airbrake_backend/patches/tracker.rb
-- lib/redmine_airbrake_backend/report/ios.rb
-- lib/redmine_airbrake_backend/request.rb
-- lib/redmine_airbrake_backend/request/json.rb
-- lib/redmine_airbrake_backend/request/xml.rb
 - lib/redmine_airbrake_backend/version.rb
 - lib/tasks/test.rake
 - redmine_airbrake_backend.gemspec
@@ -131,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: This plugin provides the necessary API to use Redmine as a Airbrake backend

data/lib/redmine_airbrake_backend/report/ios.rb

@@ -1,82 +0,0 @@
-module RedmineAirbrakeBackend
-  # Represents a report contained in a request
-  class Report
-    # iOS report
-    class Ios
-      # Parse an iOS crash log
-      def self.parse(data)
-        error = {
-          backtrace:   [],
-          attachments: [],
-          application: {}
-        }
-
-        header_finished      = false
-        next_line_is_message = false
-        crashed_thread       = false
-        indicent_identifier  = nil
-
-        data.split("\n").each do |line|
-          header_finished = true if line =~ /^(Application Specific Information|Last Exception Backtrace|Thread \d+( Crashed)?):$/
-
-          unless header_finished
-            key, value = line.split(':', 2).map { |s| s.strip }
-
-            next if key.blank? || value.blank?
-
-            case key
-            when 'Exception Type'
-              error[:type] = value
-            when 'Exception Codes'
-              error[:message] = value
-            when 'Incident Identifier'
-              indicent_identifier = value
-            when 'Identifier'
-              error[:application][:name] = value
-            when 'Version'
-              error[:application][:version] = value
-            end
-          end
-
-          if next_line_is_message
-            next_line_is_message = false
-
-            error[:message] = line
-
-            if line =~ /^\*\*\* Terminating app due to uncaught exception '([^']+)', reason: '\*\*\* (.*)'$/
-              error[:type]    = Regexp.last_match(1)
-              error[:message] = Regexp.last_match(2)
-            else
-              error[:message] = line
-            end
-          end
-
-          crashed_thread = false if line =~ /^Thread \d+:$/
-
-          if crashed_thread
-            if line =~ /^(\d+)\s+([^\s]+)\s+(0x[0-9a-f]+)\s+(.+) \+ (\d+)$/
-              error[:backtrace] << {
-                file:   Regexp.last_match(2),
-                method: Regexp.last_match(4),
-                number: Regexp.last_match(5),
-              }
-            end
-          end
-
-          crashed_thread = true if error[:backtrace].blank? && line =~ /^(Last Exception Backtrace|Thread \d+ Crashed):$/
-
-          next_line_is_message = true if line =~ /^Application Specific Information:$/
-        end
-
-        return nil if error.blank?
-
-        error[:attachments] << {
-          filename: "#{indicent_identifier}.crash",
-          data:     data
-        } if indicent_identifier.present?
-
-        error
-      end
-    end
-  end
-end