dradis-plugins 4.16.0 → 4.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 040de0ca94888eed6a46b3369d4cbf43d47ef8ebda7c222b5cda993b137edc3c
-  data.tar.gz: e680cb65ff3828c4a4aa48a8b296137ad77a82f6245b458966ff4769a46720e7
+  metadata.gz: ab80c138e39b3703d4f65fe3406c9aa876f2588b3bdbaa2f44a1f0fd7cae0e4b
+  data.tar.gz: 4a4ce3dc4c10a0ec9fb7d7206bbea7fe68c0775a34242657f578e15804922a77
 SHA512:
-  metadata.gz: ab57dd203b9269ec378d8b8e401c7d282f448668b0552a173355b614b096e666c9373e2e2069ab2c183a6533bad75b174d8725fd60ac16c7280786c347b51f1f
-  data.tar.gz: 452eda00c7a560beac5c5b5e73de684c1ac140ffa6a81ce488f8716ea0c6f23e971dfd892c939704fe13a8cab2e6bdaabf48dc438666a2eaa2f08784625c2114
+  metadata.gz: c9555248bb5697d70bcda15e6d7bc5e80281c611efe18a29b4dc3d75cf1f1afb09f369014a3eebce0afea2fc7246c02bad48e58bfd2cb01d3527bc508ebebaf5
+  data.tar.gz: 69d1ccd744a4af22b92e98eba0bff5b9a9d0b2bb304aa0b2ab0cdbea077a29354ad63c584cc706eae079fa12ea6e8480078ddaf2db0233779412e39556cdb42b

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+v4.17.0 (July 2025)
+  - Add Exportable concern to house shared report export logic from Export::BaseController
+  - Only track report export when report is created
+
 v4.16.0 (May 2025)
   - Enable audit tracking for persistent permissions changes
   - Default to draft state on tool upload

data/app/controllers/concerns/dradis/plugins/exportable.rb

@@ -0,0 +1,50 @@
+module Dradis
+  module Plugins
+    module Exportable
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :set_exporter, only: [:create]
+        before_action :validate_scope, only: [:create]
+        before_action :validate_template, only: [:create]
+      end
+
+      private
+
+      def is_api?
+        controller_path.include?('api')
+      end
+
+      def set_exporter
+        raise NotImplementedError
+      end
+
+      def templates_dir
+        @templates_dir ||= File.join(::Configuration::paths_templates_reports, @exporter)
+      end
+
+      def validate_scope
+        unless Dradis::Plugins::ContentService::Base::VALID_SCOPES.include?(export_params[:scope])
+          if is_api?
+            render_json_error(Exception.new('Something fishy is going on...'), 422)
+          else
+            raise 'Something fishy is going on...'
+          end
+        end
+      end
+
+      def validate_template
+        @template_file =
+          File.expand_path(File.join(templates_dir, export_params[:template]))
+
+        unless @template_file.starts_with?(templates_dir) && File.exists?(@template_file)
+          if is_api?
+            render_json_error(Exception.new('Something fishy is going on...'), 422)
+          else
+            raise 'Something fishy is going on...'
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/dradis/plugins/persistent_permissions.rb

@@ -3,7 +3,7 @@ module Dradis
     module PersistentPermissions
       extend ActiveSupport::Concern
 
-      include UsageTracking
+      include UsageTracking if defined?(Dradis::Pro)
 
       def update
         @user = User.authors.find(params[:id])

data/app/controllers/dradis/plugins/export/base_controller.rb

@@ -2,12 +2,11 @@ module Dradis
   module Plugins
     module Export
       class BaseController < Rails.application.config.dradis.base_export_controller_class_name.to_s.constantize
+        include Exportable
         include ProjectScoped
         include UsageTracking if defined?(Dradis::Pro)
 
-        before_action :validate_scope
-        before_action :validate_template
-        after_action :track_export, if: -> { defined?(Dradis::Pro) }
+        after_action :track_export, only: [:create], if: -> { defined?(Dradis::Pro) }
 
         protected
 
@@ -15,35 +14,16 @@ module Dradis
           params.permit(:project_id, :scope, :template)
         end
 
-        def validate_template
-          @template_file =
-            File.expand_path(File.join(templates_dir, export_params[:template]))
-
-          unless @template_file.starts_with?(templates_dir) && File.exists?(@template_file)
-            raise 'Something fishy is going on...'
-          end
-        end
-
-        def validate_scope
-          unless Dradis::Plugins::ContentService::Base::VALID_SCOPES.include?(export_params[:scope])
-            raise 'Something fishy is going on...'
-          end
-        end
-
         private
 
-        def engine_name
-          "#{self.class.to_s.deconstantize}::Engine".constantize.plugin_name.to_s
-        end
-
-        def templates_dir
-          @templates_dir ||= File.join(::Configuration::paths_templates_reports, engine_name)
+        def set_exporter
+          @exporter = "#{self.class.to_s.deconstantize}::Engine".constantize.plugin_name.to_s
         end
 
         def track_export
           project = Project.includes(:evidence, :nodes).find(current_project.id)
           track_usage('report.exported', {
-            exporter: engine_name,
+            exporter: @exporter,
             issue_count: project.issues.size,
             evidence_count: project.evidence.size,
             node_count: project.nodes.in_tree.size

data/lib/dradis/plugins/gem_version.rb

@@ -7,7 +7,7 @@ module Dradis
 
     module VERSION
       MAJOR = 4
-      MINOR = 16
+      MINOR = 17
       TINY = 0
       PRE   = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-plugins
 version: !ruby/object:Gem::Version
-  version: 4.16.0
+  version: 4.17.0
 platform: ruby
 authors:
 - Daniel Martin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-16 00:00:00.000000000 Z
+date: 2025-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/controllers/concerns/dradis/plugins/exportable.rb
 - app/controllers/concerns/dradis/plugins/persistent_permissions.rb
 - app/controllers/dradis/plugins/export/base_controller.rb
 - dradis-plugins.gemspec