dradis-plugins 4.18.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbaa602efa4365bbb53bf83b1df8bf5f7c94bb6f94f51eb06cad4aa760277a8b
-  data.tar.gz: 6c293688ca05a8e93cb98577da607ecce2ab5d640520247cff5e0d07082ffdad
+  metadata.gz: 0c0f03b4fe267f990094ae155369fc8d7eb667ad36dffb3cb2359126731f6bf2
+  data.tar.gz: fd98735eab3125c8145b49968dca0de2a80a46f3a8769ca02bdf06b71b0168cc
 SHA512:
-  metadata.gz: 24a773a0dc01c78b3634cb53ccbdc81e0b53cdbbd8e2986dd046777bf140b5be65c98a6e4cf5216d65721c58dcec6bc83eeee46c04d793052daee1eb41cb573c
-  data.tar.gz: 9d6a29c5e175ed04e3faaf53304708651a8c0cd4898486d13b9a0c2d17ca8c3ceb9bc0b594c0c9930630efe52631dedab210d798d9d92adb25ca5b738ebf9a0e
+  metadata.gz: ab7cafa1f6a2c963990e4e8162e6e7232f9ec8e918588ca5767a268fd0e0aabe861da5dbc4d1a2db206f5c720f4054149a898c42b151f8597a6a3d125ae49191
+  data.tar.gz: a6557601dde763a45b2f760e1f0b2315c6d126cce2919909093f89a2b0037b11e874decee2ad281951131f9b509909540b215a00d1ce15b0a35a8b118c6af1a4

data/.rubocop.yml

@@ -0,0 +1,129 @@
+AllCops:
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  SuggestExtensions: false
+  Exclude:
+    - '**/templates/**/*'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# No extra empty lines.
+Layout/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: never
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: normal
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+v5.0.0 (March 2026)
+  - Return false when checking Engine.enabled? if the db is not yet ready
+  - Store encrypted configuration under `config/credentials/`
+
+v4.19.0 (November 2025)
+  - Add state attribute to Result class
+
 v4.18.0 (September 2025)
   - Update File.exists? calls for ruby upgrade
 

data/Rakefile

@@ -1,2 +1 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'

data/dradis-plugins.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop', '1.79.0'
 end

data/lib/dradis/plugins/base.rb

@@ -43,19 +43,26 @@ module Dradis
         end
 
         def enabled?
-          ActiveRecord::Type::Boolean.new.cast(self.settings.enabled)
+          # if db is ready, answer truthfully. If not, return false
+          db_ready? &&  ActiveRecord::Type::Boolean.new.cast(self.settings.enabled)
         end
 
         def enable!
+          return unless db_ready?
           self.settings.update_settings(enabled: true)
           Dradis::Plugins::clear_enabled_list
         end
 
         def disable!
+          return unless db_ready?
           self.settings.update_settings(enabled: false)
           Dradis::Plugins::clear_enabled_list
         end
       end
+
+      def db_ready?
+        (ActiveRecord::Base.connection.verify! rescue false) && ::Configuration.table_exists?
+      end
     end
   end
 end

data/lib/dradis/plugins/content_service/base.rb

@@ -23,6 +23,6 @@ module Dradis::Plugins::ContentService
     include Notes
     include Properties    if defined?(Dradis::Pro)
 
-     ActiveSupport.run_load_hooks(:content_service, self)
+    ActiveSupport.run_load_hooks(:content_service, self)
   end
 end

data/lib/dradis/plugins/content_service/boards.rb

@@ -10,7 +10,7 @@ module Dradis::Plugins::ContentService
       project.methodology_library.boards
     end
 
-    def create_board(args={})
+    def create_board(args = {})
       name    = args.fetch(:name, default_board_name)
       node_id = args.fetch(:node_id, default_node_id)
       Board.create(

data/lib/dradis/plugins/content_service/content_blocks.rb

@@ -13,7 +13,7 @@ module Dradis::Plugins::ContentService
       end
     end
 
-    def create_content_block(args={})
+    def create_content_block(args = {})
       block_group    = args.fetch(:block_group, default_content_block_group)
       content        = args.fetch(:content, default_content_block_content)
       state          = args.fetch(:state, :published)

data/lib/dradis/plugins/content_service/core.rb

@@ -11,7 +11,7 @@ module Dradis::Plugins::ContentService
 
     # @option plugin [Class] the 'wrapper' module of a plugin, e.g.
     #     Dradis::Plugins::Nessus
-    def initialize(args={})
+    def initialize(args = {})
       @logger = args.fetch(:logger, Rails.logger)
       @plugin = args.fetch(:plugin)
       @project = args[:project]
@@ -25,14 +25,14 @@ module Dradis::Plugins::ContentService
       @default_author ||= "#{plugin::Engine.plugin_name.to_s.humanize} upload plugin"
     end
 
-    def try_rescue_from_length_validation(args={})
+    def try_rescue_from_length_validation(args = {})
       model = args[:model]
       field = args[:field]
       text  = args[:text]
       msg   = args[:msg]
-      tail  = "..." + args[:tail].to_s
+      tail  = '...' + args[:tail].to_s
 
-      logger.error{ "Trying to rescue from a :length error" }
+      logger.error { 'Trying to rescue from a :length error' }
 
       if model.errors[field]
         # the plugin tried to store too much information

data/lib/dradis/plugins/content_service/evidence.rb

@@ -2,7 +2,7 @@ module Dradis::Plugins::ContentService
   module Evidence
     extend ActiveSupport::Concern
 
-    def create_evidence(args={})
+    def create_evidence(args = {})
       content = args.fetch(:content, default_evidence_content)
       node    = args.fetch(:node, default_node_parent)
       issue   = args[:issue] || default_evidence_issue

data/lib/dradis/plugins/content_service/issues.rb

@@ -16,7 +16,7 @@ module Dradis::Plugins::ContentService
       issues.where(category_id: default_issue_category.id)
     end
 
-    def create_issue(args={})
+    def create_issue(args = {})
       text = args.fetch(:text, default_issue_text)
       # NOTE that ID is the unique issue identifier assigned by the plugin,
       # and is not to be confused with the Issue#id primary key
@@ -88,7 +88,6 @@ module Dradis::Plugins::ContentService
       end
     end
 
-
     private
 
     def default_issue_category

data/lib/dradis/plugins/content_service/nodes.rb

@@ -17,7 +17,7 @@ module Dradis::Plugins::ContentService
       nodes.sort_by! { |node| node.label.split('.').map(&:to_i) }
     end
 
-    def create_node(args={})
+    def create_node(args = {})
       label  = args[:label]  || default_node_label
       parent = args[:parent] || default_node_parent
 
@@ -59,7 +59,6 @@ module Dradis::Plugins::ContentService
       @default_node_type ||= Node::Types::DEFAULT
     end
 
-
     # Private: this method returns a list of nodes associated with Evidence
     # instances. When a node is affected by multiple issues, or multiple pieces
     # of evidence, we just want a single reference to it.

data/lib/dradis/plugins/content_service/notes.rb

@@ -6,7 +6,7 @@ module Dradis::Plugins::ContentService
       project.notes.where(category: Category.report)
     end
 
-    def create_note(args={})
+    def create_note(args = {})
       cat  = args.fetch(:category, default_note_category)
       node = args.fetch(:node, default_node_parent)
       text = args.fetch(:text, default_note_text)

data/lib/dradis/plugins/engine.rb

@@ -5,7 +5,7 @@ module Dradis
 
       config.dradis = ActiveSupport::OrderedOptions.new
 
-      initializer "dradis-plugins.set_configs" do |app|
+      initializer 'dradis-plugins.set_configs' do |app|
         options = app.config.dradis
         options.base_export_controller_class_name ||= 'AuthenticatedController'
         options.thor_helper_module ||= Dradis::Plugins::ThorHelper

data/lib/dradis/plugins/export/base.rb

@@ -7,7 +7,7 @@ module Dradis
       class Base
         attr_accessor :content_service, :logger, :options, :plugin, :project, :scope
 
-        def initialize(args={})
+        def initialize(args = {})
           # Save everything just in case the implementing class needs any of it.
           @options = args
 
@@ -22,12 +22,12 @@ module Dradis
           post_initialize(args)
         end
 
-        def export(args={})
+        def export(args = {})
           raise "The export() method is not implemented in this plugin [#{self.class.name}]."
         end
 
         # This method can be overwriten by plugins to do initialization tasks.
-        def post_initialize(args={})
+        def post_initialize(args = {})
         end
 
         private
@@ -52,7 +52,6 @@ module Dradis
             raise "You need to pass a :plugin value to your Exporter or define it under your plugin's root namespace."
           end
         end
-
       end # Base
     end # Export
   end # Plugins

data/lib/dradis/plugins/gem_version.rb

@@ -6,8 +6,8 @@ module Dradis
     end
 
     module VERSION
-      MAJOR = 4
-      MINOR = 18
+      MAJOR = 5
+      MINOR = 0
       TINY = 0
       PRE   = nil
 

data/lib/dradis/plugins/import/filters/base.rb

@@ -2,15 +2,13 @@ module Dradis
   module Plugins
     module Import
       module Filters
-
         class Base
-          def self.query(args={})
+          def self.query(args = {})
             instance = self.new
             instance.query(args)
           end
         end
-
       end
     end
   end
-end
+end

data/lib/dradis/plugins/import/filters.rb

@@ -1,7 +1,6 @@
 module Dradis
   module Plugins
     module Import
-
       module Filters
         class << self
           # -- Class Methods --------------------------------------------------------
@@ -45,7 +44,6 @@ module Dradis
           end
         end
       end
-
     end
   end
-end
+end

data/lib/dradis/plugins/import/result.rb

@@ -1,12 +1,13 @@
 module Dradis::Plugins::Import
   class Result
-    attr_accessor :description, :id, :tags, :title
+    attr_accessor :description, :id, :tags, :title, :state
 
-    def initialize(args={})
+    def initialize(args = {})
       @description = args[:description] || "The Import plugin didn't provide a :description for this result."
       @id          = args[:id]          || "The Import plugin didn't provide an :id for this result."
       @tags        = args[:tags]        || []
       @title       = args[:title]       || "The Import plugin didn't provide a :title for this result."
+      @state       = args[:state]       || nil
     end
   end
 end

data/lib/dradis/plugins/mappings/base.rb

@@ -8,7 +8,6 @@ module Dradis::Plugins::Mappings::Base
   end
 
   module ClassMethods
-
     def default_mapping_fields(source)
       default_mapping(source).map do |destination_field, content|
         MappingField.new(destination_field: destination_field, content: content)

data/lib/dradis/plugins/settings/adapters/db.rb

@@ -9,11 +9,11 @@ module Dradis::Plugins::Settings::Adapters
     end
 
     def exists?(key)
-      db_ready? && Configuration.exists?(name: namespaced_key(key))
+      Configuration.exists?(name: namespaced_key(key))
     end
 
     def read(key)
-      db_ready? && Configuration.find_by(name: namespaced_key(key))&.value
+      Configuration.find_by(name: namespaced_key(key))&.value
     end
 
     def write(key, value)
@@ -26,9 +26,5 @@ module Dradis::Plugins::Settings::Adapters
     def namespaced_key(key)
       [@namespace, key.to_s.underscore].join(':')
     end
-
-    def db_ready?
-      (ActiveRecord::Base.connection.verify! rescue false) && Configuration.table_exists?
-    end
   end
 end

data/lib/dradis/plugins/settings/adapters/encrypted_configuration.rb

@@ -32,17 +32,17 @@ module Dradis::Plugins::Settings::Adapters
     end
 
     private
+
     def config_path
-      @config_path ||= Rails.root.join('config', 'shared', 'dradis-plugins.yml.enc')
+      @config_path ||= Rails.root.join('config', 'credentials', 'dradis-plugins.yml.enc')
     end
 
     def configuration
       @configuration ||= begin
           create_key unless key_path.exist?
-
+          # env_key is a no-op since we're always providing a key_path, but it is required by the initializer and we don't want to re-use RAILS_MASTER_KEY
           ActiveSupport::EncryptedConfiguration.new(
-            config_path: config_path, key_path: key_path,
-            env_key: 'RAILS_MASTER_KEY', raise_if_missing_key: true
+            config_path: config_path, key_path: key_path, env_key: 'DRADIS_PLUGINS_KEY', raise_if_missing_key: true
           )
         end
     end
@@ -52,7 +52,7 @@ module Dradis::Plugins::Settings::Adapters
     end
 
     def key_path
-      @key_path ||= Rails.root.join('config', 'shared', 'dradis-plugins.key')
+      @key_path ||= Rails.root.join('config', 'credentials', 'dradis-plugins.key')
     end
   end
 end

data/lib/dradis/plugins/settings.rb

@@ -20,7 +20,7 @@ module Dradis::Plugins
           value: value = dirty_or_stored_or_default(key.to_sym),
           default: is_default?(key, value)
         }
-      end.sort_by{ |o| o[:name] }
+      end.sort_by { |o| o[:name] }
     end
 
     def save
@@ -32,7 +32,7 @@ module Dradis::Plugins
     end
 
     def update_settings(opts = {})
-      opts.select{ |k, v| @default_options.key?(k) }.each do |k, v|
+      opts.select { |k, v| @default_options.key?(k) }.each do |k, v|
         @dirty_options[k.to_sym] = v
       end
       save

data/lib/dradis/plugins/thor.rb

@@ -17,9 +17,9 @@ module Dradis
           end
         end
 
-        def plugin_thorfiles(args={})
+        def plugin_thorfiles(args = {})
           if paths['dradis/thorfiles'].existent.any?
-            Dir["%s/thorfile.rb" % paths['dradis/thorfiles'].existent]
+            Dir['%s/thorfile.rb' % paths['dradis/thorfiles'].existent]
           else
             []
           end
@@ -27,4 +27,4 @@ module Dradis
       end
     end
   end
-end
+end

data/lib/dradis/plugins/thor_helper.rb

@@ -16,7 +16,6 @@ module Dradis
         @logger ||= default_logger
       end
 
-
       private
       def default_logger
         STDOUT.sync   = true

data/lib/dradis/plugins/upload/field_processor.rb

@@ -5,11 +5,10 @@
 module Dradis
   module Plugins
     module Upload
-
       class FieldProcessor
         attr_reader :data
 
-        def initialize(args={})
+        def initialize(args = {})
           @data = args[:data]
           post_initialize(args)
         end
@@ -18,18 +17,17 @@ module Dradis
         # and extract the value of the requested field.
         #
         # Subclasses will overwrite this method.
-        def value(args={})
+        def value(args = {})
           field = args[:field]
           "Sorry, this plugin doesn't define a FieldProcessor (called for [#{field}])"
         end
 
         protected
         # This can be overriden by subclasses
-        def post_initialize(args={})
+        def post_initialize(args = {})
           # nop
         end
       end
-
     end
   end
 end

data/lib/dradis/plugins/upload/importer.rb

@@ -20,7 +20,7 @@ module Dradis
           { evidence: 'evidence', issue: 'issue' }
         end
 
-        def initialize(args={})
+        def initialize(args = {})
           @options = args
 
           @default_user_id = args[:default_user_id] || -1
@@ -35,12 +35,12 @@ module Dradis
           post_initialize(args)
         end
 
-        def import(args={})
+        def import(args = {})
           raise "The import() method is not implemented in this plugin [#{self.class.name}]."
         end
 
         # This method can be overwriten by plugins to do initialization tasks.
-        def post_initialize(args={})
+        def post_initialize(args = {})
         end
 
         private
@@ -81,7 +81,6 @@ module Dradis
           )
         end
       end # Importer
-
     end # Upload
   end # Plugins
 end # Core

data/lib/dradis/plugins/upload.rb

@@ -7,4 +7,4 @@ end
 
 require 'dradis/plugins/upload/base'
 require 'dradis/plugins/upload/importer'
-require 'dradis/plugins/upload/field_processor'
+require 'dradis/plugins/upload/field_processor'

data/lib/dradis/plugins/version.rb

@@ -8,4 +8,4 @@ module Dradis
       gem_version
     end
   end
-end
+end

data/lib/dradis/plugins.rb

@@ -22,8 +22,9 @@ module Dradis
 
       # Filters the list of plugins and only returns those that provide the
       # requested feature and enabled
-      def with_feature(feature)
-        enabled_list.select do |plugin|
+      def with_feature(feature, include_disabled: false)
+        integrations_list = include_disabled ? list : enabled_list
+        integrations_list.select do |plugin|
           # engine = "#{plugin}::Engine".constantize
           plugin.provides?(feature)
         end
@@ -78,7 +79,6 @@ module Dradis
   end
 end
 
-
 require 'dradis/plugins/engine'
 require 'dradis/plugins/version'
 

data/spec/settings_spec.rb

@@ -18,19 +18,19 @@ describe Dradis::Plugins::Settings do
     TestEngine::settings.reset_defaults!
   end
 
-  it "sets and return default values" do
+  it 'sets and return default values' do
     expect(TestEngine::settings.host).to eq('localhost')
     expect(TestEngine::settings.port).to eq(80)
   end
 
-  it "sets and returns user defined values" do
+  it 'sets and returns user defined values' do
     expect(TestEngine::settings.host).to eq('localhost')
     TestEngine::settings.host = '127.0.0.1'
     expect(TestEngine::settings.host).to eq('127.0.0.1')
     expect(TestEngine::settings.port).to eq(80)
   end
 
-  it "sets and returns new value even if it equals default value" do
+  it 'sets and returns new value even if it equals default value' do
     expect(TestEngine::settings.host).to eq('localhost')
     TestEngine::settings.host = '127.0.0.1'
     expect(TestEngine::settings.host).to eq('127.0.0.1')
@@ -38,17 +38,17 @@ describe Dradis::Plugins::Settings do
     expect(TestEngine::settings.host).to eq('localhost')
   end
 
-  it "saves to db and returns persisted values" do
+  it 'saves to db and returns persisted values' do
     expect(TestEngine::settings.host).to eq('localhost')
     TestEngine::settings.host = '127.0.0.1'
-    expect(TestEngine::settings.save).to eq( { host: '127.0.0.1'} )
+    expect(TestEngine::settings.save).to eq({ host: '127.0.0.1' })
     expect(TestEngine::settings.host).to eq('127.0.0.1')
   end
 
-  it "reads from db after saving" do
+  it 'reads from db after saving' do
     expect(TestEngine::settings.host).to eq('localhost')
     TestEngine::settings.host = '127.0.0.1'
-    expect(TestEngine::settings.save).to eq( { host: '127.0.0.1'} )
+    expect(TestEngine::settings.save).to eq({ host: '127.0.0.1' })
   end
 
 end
@@ -83,5 +83,3 @@ describe Dradis::Plugins::Settings, '#all' do
     ])
   end
 end
-
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dradis-plugins
 version: !ruby/object:Gem::Version
-  version: 4.18.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Daniel Martin
@@ -51,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.79.0
 description: Required dependency for Dradis Framework.
 executables: []
 extensions: []
@@ -59,6 +73,7 @@ files:
 - ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CHANGELOG.template
 - CONTRIBUTING.md