redmine_airbrake_backend 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd9ed3cb0664c977824beee01de24dabd2883bba7bbaa0df8dbe1bfdbfd6ca47
-  data.tar.gz: 4d52088e65e445ab788d459ef88d88395716fd544e85ea97a15082198f586c11
+  metadata.gz: 78d324b14146a054ed7f62573df24493843ebccc846a1a8936348fff51228098
+  data.tar.gz: 6225ac96f31412e899d0ab2f06e869f22761d4af19583dda20cdfefc1e00d416
 SHA512:
-  metadata.gz: 2a17ebe81cdb4aac103031e7ee8920f33a0a23ed9075a1deb0f48b288ebb0c3fd24b91580b83c62c36d805c096a240d467ac6d488b6a75e38ebc4e9db7bdf398
-  data.tar.gz: dec97c57aab26ddd559c0680eae89ed05b810866755866b0ae8e326a6438a314423c5d31adb32e96f91d4ecd116b20473cfcd5450184819a3eac061c8b1604b0
+  metadata.gz: 366e346434ea2a82047ff0d1a7c6314ff2782e5e4056cdf3f2563e2ebfe0f958265d727a1e87dd47eddb001c61b3d832dd3fa20ee4e6f8eb9973e2aba3a59801
+  data.tar.gz: abb59d8c978611fa973c20a3de001904a1bfade5c30d910739ad2285cccc7a024a0e0951e57f4fb1da429d9fae0d2b61ebcb16c6fab24f94a97cd40fd763e18a

data/.gitlab-ci.yml

@@ -0,0 +1,42 @@
+stages:
+  - build
+  - codequality
+  - security
+
+build:
+  stage: build
+  image: ruby:2.5
+  script:
+    - gem install bundler --no-ri --no-rdoc
+    - bundle update
+  artifacts:
+    paths:
+      - Gemfile.lock
+
+rubocop:
+  stage: codequality
+  image: ruby:2.5
+  script:
+    - gem install rubocop --no-ri --no-rdoc
+    - rubocop
+
+dependency_scanning:
+  stage: security
+  dependencies:
+    - build
+  image: docker:stable
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env DEP_SCAN_DISABLE_REMOTE_CHECKS="${DEP_SCAN_DISABLE_REMOTE_CHECKS:-false}"
+        --volume "$PWD:/code"
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/dependency-scanning:$SP_VERSION" /code
+  artifacts:
+    paths:
+      - gl-dependency-scanning-report.json

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'test/**/*.rb'
+    - '**/*.rake'
+
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 15

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.2.2 (2018-11-03)
+### Fixes
+  - Fix finding repository if no filename is for backtrace element
+### Changes
+  - Internal restructuring for better code style
+  - Requires Ruby >= 2.4.0
+  - Requires Redmine >= 3.4.0
+
 ## 1.2.1 (2018-01-29)
 ### Features
   - All responses are formatted as JSON

data/Gemfile

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in redmine_airbrake_backend.gemspec
-gemspec path: File.dirname(__FILE__)
+gemspec path: __dir__

data/README.md

@@ -1,7 +1,3 @@
-[![Gem Version](https://img.shields.io/gem/v/redmine_airbrake_backend.svg)](https://rubygems.org/gems/redmine_airbrake_backend)
-[![Dependencies](https://img.shields.io/gemnasium/ydkn/redmine_airbrake_backend.svg)](https://gemnasium.com/ydkn/redmine_airbrake_backend)
-[![Code Climate](https://img.shields.io/codeclimate/github/ydkn/redmine_airbrake_backend.svg)](https://codeclimate.com/github/ydkn/redmine_airbrake_backend)
-
 # Redmine Airbrake Backend
 
 This plugin provides the necessary API to use Redmine as an Airbrake backend.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -24,5 +26,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/app/controllers/airbrake_controller.rb

@@ -1,13 +1,18 @@
-require 'tempfile'
+# frozen_string_literal: true
+
 require 'redmine_airbrake_backend/notice'
 
 # Controller with airbrake related stuff
 class AirbrakeController < ::ApplicationController
+  include AirbrakeIssueHandling
+  include AirbrakeRendering
+
   skip_before_action :verify_authenticity_token
-  skip_before_action :session_expiration, :user_setup, :check_if_login_required, :set_localization, :check_password_change
+  skip_before_action :session_expiration, :user_setup, :check_if_login_required, :set_localization,
+                     :check_password_change
 
   prepend_before_action :find_project
-  prepend_before_action :parse_key
+  prepend_before_action :check_key, :parse_key
 
   before_action :authorize
   before_action :find_tracker
@@ -16,8 +21,6 @@ class AirbrakeController < ::ApplicationController
   before_action :find_assignee
   before_action :find_repository
 
-  after_action :cleanup_tempfiles
-
   private
 
   def find_project
@@ -25,16 +28,18 @@ class AirbrakeController < ::ApplicationController
   end
 
   def parse_key
+    raw_key = if (request.headers['HTTP_AUTHORIZATION'] || '') =~ /^Bearer\s+(.*)\s*$/i # New auth method
+                Regexp.last_match[1]
+              elsif params[:key].present? # Old auth method
+                params[:key]
+              end
+
+    @key = JSON.parse(raw_key).with_indifferent_access
+  rescue StandardError
     @key = nil
+  end
 
-    if (request.headers['HTTP_AUTHORIZATION'] || '') =~ /^Bearer\s+(.*)\s*$/i
-      # New auth method
-      @key = JSON.parse(Regexp.last_match[1]).with_indifferent_access rescue nil
-    elsif params[:key].present?
-      # Old auth method
-      @key = JSON.parse(params[:key]).with_indifferent_access rescue nil
-    end
-
+  def check_key
     render_error('No or invalid API key format', :unauthorized) if @key.blank? || @key[:key].blank?
   end
 
@@ -58,7 +63,9 @@ class AirbrakeController < ::ApplicationController
     render_error('No or invalid tracker', :failed_dependency) if @tracker.blank?
 
     # Check notice ID field
-    render_error('Custom field for notice hash not available on selected tracker', :failed_dependency) if @tracker.custom_fields.find_by(id: notice_hash_field.id).blank?
+    return unless @tracker.custom_fields.find_by(id: notice_hash_field.id).blank?
+
+    render_error('Custom field for notice hash not available on selected tracker', :failed_dependency)
   end
 
   def find_category
@@ -70,7 +77,7 @@ class AirbrakeController < ::ApplicationController
   end
 
   def find_assignee
-    @assignee = record_for(@project.users, :assignee, [:id, :login])
+    @assignee = record_for(@project.users, :assignee, %i[id login])
   end
 
   def find_repository
@@ -85,8 +92,14 @@ class AirbrakeController < ::ApplicationController
 
   def render_airbrake_response
     if @issue.present?
+      airbrake_id_value = CustomValue.find_by(
+        customized_type: Issue.name,
+        customized_id:   @issue.id,
+        custom_field_id: notice_hash_field.id
+      )
+
       render json: {
-        id:  (CustomValue.find_by(customized_type: Issue.name, customized_id: @issue.id, custom_field_id: notice_hash_field.id).value rescue nil),
+        id:  airbrake_id_value&.value,
         url: issue_url(@issue)
       }, status: :created
     else
@@ -94,7 +107,7 @@ class AirbrakeController < ::ApplicationController
     end
   end
 
-  def record_for(on, key, fields = [:id, :name])
+  def record_for(on, key, fields = %i[id name])
     fields.each do |field|
       val = on.find_by(field => @key[key])
       return val if val.present?
@@ -114,7 +127,8 @@ class AirbrakeController < ::ApplicationController
   end
 
   def custom_field(key)
-    @project.issue_custom_fields.find_by(id: global_setting(key)) || CustomField.find_by(id: global_setting(key), is_for_all: true)
+    @project.issue_custom_fields.find_by(id: global_setting(key)) ||
+      CustomField.find_by(id: global_setting(key), is_for_all: true)
   end
 
   def notice_hash_field
@@ -124,123 +138,4 @@ class AirbrakeController < ::ApplicationController
   def occurrences_field
     custom_field(:occurrences_field)
   end
-
-  def create_issue!
-    return if @notice.blank?
-    return if @notice.errors.blank?
-
-    @issue = find_or_initialize_issue(@notice)
-
-    set_issue_custom_field_values(@issue, @notice)
-
-    reopen_issue(@issue, @notice) if @issue.persisted? && @issue.status.is_closed? && reopen_issue?(@notice)
-
-    @issue = nil unless @issue.save
-  end
-
-  # Load or initialize issue by project, tracker and airbrake hash
-  def find_or_initialize_issue(notice)
-    issue_ids = CustomValue.where(customized_type: Issue.name, custom_field_id: notice_hash_field.id, value: notice.id).pluck(:customized_id)
-
-    issue = Issue.find_by(id: issue_ids, project_id: @project.id, tracker_id: @tracker.id)
-
-    return issue if issue.present?
-
-    initialize_issue(notice)
-  end
-
-  def initialize_issue(notice)
-    issue = Issue.new(
-        subject: notice.subject,
-        project: @project,
-        tracker: @tracker,
-        author: User.current,
-        category: @category,
-        priority: @priority,
-        description: render_description(notice),
-        assigned_to: @assignee
-      )
-
-    add_attachments_to_issue(issue, notice)
-
-    issue
-  end
-
-  def set_issue_custom_field_values(issue, notice)
-    custom_field_values = {}
-
-    # Error ID
-    custom_field_values[notice_hash_field.id] = notice.id if issue.new_record?
-
-    # 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
-
-    issue.custom_field_values = custom_field_values
-  end
-
-  def add_attachments_to_issue(issue, notice)
-    return if notice.attachments.blank?
-
-    @tempfiles ||= []
-
-    notice.attachments.each do |data|
-      filename = data[:filename].presence || Redmine::Utils.random_hex(16)
-
-      file = Tempfile.new(filename)
-      @tempfiles << file
-
-      file.write(data[:data])
-      file.rewind
-
-      issue.attachments << Attachment.new(file: file, author: User.current, filename: filename)
-    end
-  end
-
-  def reopen_issue?(notice)
-    reopen_regexp = project_setting(:reopen_regexp)
-
-    return false if reopen_regexp.blank?
-    return false if notice.environment_name.blank?
-
-    !!(notice.environment_name =~ /#{reopen_regexp}/i)
-  end
-
-  def issue_reopen_repeat_description?
-    !!project_setting(:reopen_repeat_description)
-  end
-
-  def reopen_issue(issue, notice)
-    return if notice.environment_name.blank?
-
-    desc = "*Issue reopened after occurring again in _#{notice.environment_name}_ environment.*"
-    desc << "\n\n#{render_description(notice)}" if issue_reopen_repeat_description?
-
-    issue.status = issue.tracker.default_status
-
-    issue.init_journal(User.current, desc)
-
-    add_attachments_to_issue(issue, notice)
-  end
-
-  def render_description(notice)
-    locals = { notice: notice }
-
-    if template_exists?("airbrake/issue_description/#{notice.type}")
-      render_to_string("airbrake/issue_description/#{notice.type}", layout: false, locals: locals)
-    else
-      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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Controller for airbrake notices
 class AirbrakeNoticeController < ::AirbrakeController
   accept_api_auth :notices
@@ -15,11 +17,11 @@ class AirbrakeNoticeController < ::AirbrakeController
 
   def parse_notice
     @notice = RedmineAirbrakeBackend::Notice.new(
-        errors:      params[:errors].map { |e| RedmineAirbrakeBackend::Error.new(e) },
-        params:      params[:params],
-        session:     params[:session],
-        context:     params[:context],
-        environment: params[:environment]
-      )
+      errors:      params[:errors].map { |e| RedmineAirbrakeBackend::Error.new(e) },
+      params:      params[:params],
+      session:     params[:session],
+      context:     params[:context],
+      environment: params[:environment]
+    )
   end
 end

data/app/controllers/airbrake_project_settings_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Controller for project-specific airbrake settings
 class AirbrakeProjectSettingsController < ::ApplicationController
   before_filter :find_project
@@ -6,9 +8,7 @@ class AirbrakeProjectSettingsController < ::ApplicationController
   menu_item :settings
 
   def update
-    if @airbrake_project_setting.update(airbrake_project_setting_params)
-      flash[:notice] = l(:notice_successful_update)
-    end
+    flash[:notice] = l(:notice_successful_update) if @airbrake_project_setting.update(airbrake_project_setting_params)
 
     redirect_to settings_project_path(@project, tab: 'airbrake')
   end
@@ -25,6 +25,8 @@ class AirbrakeProjectSettingsController < ::ApplicationController
   end
 
   def airbrake_project_setting_params
-    params.require(:airbrake_project_setting).permit(:tracker_id, :category_id, :priority_id, :reopen_regexp, :reopen_repeat_description)
+    params
+      .require(:airbrake_project_setting)
+      .permit(:tracker_id, :category_id, :priority_id, :reopen_regexp, :reopen_repeat_description)
   end
 end

data/app/controllers/airbrake_report_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'redmine_airbrake_backend/ios_report'
 
 # Controller for airbrake reports

data/app/controllers/concerns/airbrake_attachments.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+# Handling for creating / updating issues
+module AirbrakeAttachments
+  extend ActiveSupport::Concern
+
+  included do
+    after_action :cleanup_tempfiles
+  end
+
+  private
+
+  def add_attachment_to_issue(issue, data)
+    filename = data[:filename].presence || Redmine::Utils.random_hex(16)
+
+    file = Tempfile.new(filename)
+
+    @tempfiles << file
+
+    file.write(data[:data])
+    file.rewind
+
+    issue.attachments << Attachment.new(file: file, author: User.current, filename: filename)
+  end
+
+  def add_attachments_to_issue(issue, notice)
+    return if notice.attachments.blank?
+
+    @tempfiles ||= []
+
+    notice.attachments.each do |data|
+      add_attachment_to_issue(issue, data)
+    end
+  end
+
+  def close_tempfile(tempfile)
+    tempfile.close
+  rescue StandardError
+    nil
+  end
+
+  def unlink_tempfile(tempfile)
+    tempfile.unlink
+  rescue StandardError
+    nil
+  end
+
+  def cleanup_tempfiles
+    Array(@tempfiles).compact.each do |tempfile|
+      close_tempfile(tempfile)
+      unlink_tempfile(tempfile)
+    end
+  end
+end