dradis-projects 3.0.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49c15588026961bde0a45b0134a90d201652140b
-  data.tar.gz: 1f293e40090e59155f8d62a144c214674c592093
+  metadata.gz: 1cab66cd7298c8c99104ed76957913173bde0225
+  data.tar.gz: 7a230d20b6e4e54abba7962c2bee781d40753e91
 SHA512:
-  metadata.gz: 4f1f43f87498ba38e625448bf03f16e2ad4d585efe41c168ee24a51b87ee36348499082bbeb300d7628ab94281295e97b63bb9ca02f28b13b9d5819416315588
-  data.tar.gz: 80501324eb22fbda873638fc93790509c0c28f32369527dc79cbe7b3d90279ab72ea17b25f56b15c4afd62551a7b6ebac327fe8a3e43f00d6fa4383a39575b4c
+  metadata.gz: 5c13c91fc60a01f1309dfb0e8071589e3fc8cac377542697c52e38eccb99e3aa314e4e4ef72a8bc35a4e7376900fecacc50c2de6c3689a0974ecf08e9d9bea40
+  data.tar.gz: 5da07252c8179dbfc343bf7134afe927a01b8e095a14a8ef85fcad4551ccff7c7bc6301a0321a293155a5c05550ccf1cf0b601becd8bc3d7e7fe27958baf9a20

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## Dradis Framework 3.6 (March XX, 2017) ##
+
+*   Include file version in project template export.
+
+*   Stop using homegrown configuration and use `Rails.application.config`.
+
+*   Make the project template exporter / uploader configurable.
+
+*   Break down the #export and #parse methods into smaller tasks.
+

data/app/controllers/dradis/plugins/projects/packages_controller.rb

@@ -1,17 +1,13 @@
 module Dradis::Plugins::Projects
   class PackagesController < Dradis::Plugins::Export::BaseController
     def show
-      # these come from Export#create
-      export_manager_hash   = session[:export_manager].with_indifferent_access
-      content_service_class = export_manager_hash[:content_service].constantize
+      filename = Rails.root.join('tmp', 'dradis-export.zip')
 
-      exporter = Dradis::Plugins::Projects::Export::Package.new(
-        content_service: content_service_class.new(plugin: Dradis::Plugins::Projects)
-      )
+      options  = export_options.merge(plugin: Dradis::Plugins::Projects)
+      exporter = Dradis::Plugins::Projects::Export::Package.new(options)
+      template = exporter.export(filename: filename)
 
-      package_file = Rails.root.join('tmp', 'dradis-export.zip')
-      template     = exporter.export(export_manager_hash.merge(filename: package_file))
-      send_file(package_file)
+      send_file(filename)
     end
   end
 end

data/app/controllers/dradis/plugins/projects/templates_controller.rb

@@ -1,15 +1,13 @@
 module Dradis::Plugins::Projects
   class TemplatesController < Dradis::Plugins::Export::BaseController
     def show
-      # these come from Export#create
-      export_manager_hash   = session[:export_manager].with_indifferent_access
-      content_service_class = export_manager_hash[:content_service].constantize
+      # this allows us to have different exporters in different editions
+      exporter_class = Rails.application.config.dradis.projects.template_exporter
 
-      exporter = Dradis::Plugins::Projects::Export::Template.new(
-        content_service: content_service_class.new(plugin: Dradis::Plugins::Projects)
-      )
+      options  = export_options.merge(plugin: Dradis::Plugins::Projects)
+      exporter = exporter_class.new(options)
+      template = exporter.export
 
-      template = exporter.export(export_manager_hash)
       send_data(template, filename: 'dradis-template.xml', type: :xml)
     end
   end

data/dradis-projects.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
 
-  spec.add_dependency 'dradis-plugins', '~> 3.5'
+  spec.add_dependency 'dradis-plugins', '~> 3.6'
   spec.add_dependency 'rubyzip', '~> 1.2.1'
 end

data/lib/dradis/plugins/projects.rb

@@ -13,3 +13,7 @@ require 'dradis/plugins/projects/export/template'
 require 'dradis/plugins/projects/upload/package'
 require 'dradis/plugins/projects/upload/template'
 require 'dradis/plugins/projects/version'
+
+module Dradis::Plugins::Projects
+  ActiveSupport.run_load_hooks(:dradis_projects, self)
+end

data/lib/dradis/plugins/projects/engine.rb

@@ -4,6 +4,8 @@ module Dradis
       class Engine < ::Rails::Engine
         isolate_namespace Dradis::Plugins::Projects
 
+        config.dradis.projects = ActiveSupport::OrderedOptions.new
+
         include ::Dradis::Plugins::Base
         description 'Save and restore project information'
         provides :export, :upload
@@ -14,6 +16,13 @@ module Dradis
           end
         end
 
+        initializer "dradis-projects.set_configs" do |app|
+          options = app.config.dradis.projects
+          options.template_exporter ||= Dradis::Plugins::Projects::Export::V1::Template
+          options.template_uploader ||= Dradis::Plugins::Projects::Upload::V1::Template::Importer
+        end
+
+
         # Because this plugin provides two export modules, we have to overwrite
         # the default .uploaders() method.
         #
@@ -28,4 +37,4 @@ module Dradis
       end
     end
   end
-end
+end

data/lib/dradis/plugins/projects/export/package.rb

@@ -4,15 +4,16 @@ module Dradis::Plugins::Projects::Export
     # Create a new project export bundle. It will include an XML file with the
     # contents of the repository (see db_only) and all the attachments that
     # have been uploaded into the system.
-    def export(params={})
-      raise ":filename not provided" unless params.key?(:filename)
+    def export(args={})
+      raise ":filename not provided" unless args.key?(:filename)
 
-      filename = params[:filename]
-      logger   = params.fetch(:logger, Rails.logger)
+      filename = args[:filename]
+      logger   = options.fetch(:logger, Rails.logger)
 
       File.delete(filename) if File.exists?(filename)
 
       logger.debug{ "Creating a new Zip file in #{filename}..." }
+
       Zip::File.open(filename, Zip::File::CREATE) do |zipfile|
         Node.all.each do |node|
           node_path = Attachment.pwd.join(node.id.to_s)
@@ -24,12 +25,16 @@ module Dradis::Plugins::Projects::Export
         end
 
         logger.debug{ "\tAdding XML repository dump" }
-        template_exporter = Template.new(content_service: content_service)
-        template = template_exporter.export(params)
+
+        exporter_class    = Rails.application.config.dradis.projects.template_exporter
+        template_exporter = exporter_class.new(options)
+        template          = template_exporter.export
+
         zipfile.get_output_stream('dradis-repository.xml') { |out|
           out << template
         }
       end
+
       logger.debug{ 'Done.' }
     end
 

data/lib/dradis/plugins/projects/export/template.rb

@@ -2,10 +2,10 @@ module Dradis::Plugins::Projects::Export
   class Template < Dradis::Plugins::Export::Base
     # This method returns an XML representation of current repository which
     # includes Categories, Nodes and Notes
-    def export(params={})
+    def export(args={})
       builder = Builder::XmlMarkup.new
       builder.instruct!
-      result = builder.tag!('dradis-template') do |template_builder|
+      result = builder.tag!('dradis-template', version: version) do |template_builder|
         build_nodes(template_builder)
         build_issues(template_builder)
         build_methodologies(template_builder)
@@ -16,158 +16,13 @@ module Dradis::Plugins::Projects::Export
     end
 
     private
-
-    def build_activities_for(builder, trackable)
-      builder.activities do |activities_builder|
-        trackable.activities.each do |activity|
-          activities_builder.activity do |activity_builder|
-            activity_builder.action(activity.action)
-            activity_builder.user_email(user_email_for_activity(activity))
-            activity_builder.created_at(activity.created_at.to_i)
-          end
-        end
-      end
-    end
-
-    def build_categories(builder)
-      categories = []
-      categories << Category.issue if @issues.any?
-      categories += @nodes.map do |node|
-        node.notes.map { |note| note.category }.uniq
-      end.flatten.uniq
-
-      builder.categories do |categories_builder|
-        categories.each do |category|
-          categories_builder.category do |category_builder|
-            category_builder.id(category.id)
-            category_builder.name(category.name)
-          end
-        end
-      end
-    end
-
-    def build_evidence_for_node(builder, node)
-      builder.evidence do |evidences_builder|
-        node.evidence.each do |evidence|
-          evidences_builder.evidence do |evidence_builder|
-            evidence_builder.id(evidence.id)
-            evidence_builder.author(evidence.author)
-            evidence_builder.tag!('issue-id', evidence.issue_id)
-            evidence_builder.content do
-              evidence_builder.cdata!(evidence.content)
-            end
-            build_activities_for(evidence_builder, evidence)
-          end
-        end
-      end
-    end
-
-    def build_issues(builder)
-      @issues = Issue.where(node_id: Node.issue_library).includes(:activities)
-
-      builder.issues do |issues_builder|
-        @issues.each do |issue|
-          issues_builder.issue do |issue_builder|
-            issue_builder.id(issue.id)
-            issue_builder.author(issue.author)
-            issue_builder.text do
-              issue_builder.cdata!(issue.text)
-            end
-            build_activities_for(issue_builder, issue)
-          end
-        end
-      end
-    end
-
-    def build_methodologies(builder)
-      methodologies = Node.methodology_library.notes
-      builder.methodologies do |methodologies_builder|
-        methodologies.each do |methodology|
-          methodologies_builder.methodology do |methodology_builder|
-            methodology_builder.text do
-              methodology_builder.cdata!(methodology.text)
-            end
-          end
-        end
-      end
-    end
-
-    def build_nodes(builder)
-      @nodes = Node.includes(:activities, :evidence, :notes, evidence: [:activities], notes: [:activities, :category]).all.reject do |node|
-        [Node::Types::METHODOLOGY,
-          Node::Types::ISSUELIB].include?(node.type_id)
-      end
-
-      builder.nodes do |nodes_builder|
-        @nodes.each do |node|
-          nodes_builder.node do |node_builder|
-            node_builder.id(node.id)
-            node_builder.label(node.label)
-            node_builder.tag!('parent-id', node.parent_id)
-            node_builder.position(node.position)
-            node_builder.properties do
-              node_builder.cdata!(node.raw_properties)
-            end
-            node_builder.tag!('type-id', node.type_id)
-            # Notes
-            build_notes_for_node(node_builder, node)
-            # Evidence
-            build_evidence_for_node(node_builder, node)
-            build_activities_for(node_builder, node)
-          end
-        end
-      end
-    end
-
-    def build_notes_for_node(builder, node)
-      builder.notes do |notes_builder|
-        node.notes.each do |note|
-          notes_builder.note do |note_builder|
-            note_builder.id(note.id)
-            note_builder.author(note.author)
-            note_builder.tag!('category-id', note.category_id)
-            note_builder.text do
-              note_builder.cdata!(note.text)
-            end
-            build_activities_for(note_builder, note)
-          end
-        end
-      end
-    end
-
-    def build_tags(builder)
-      tags = Tag.all
-      builder.tags do |tags_builder|
-        tags.each do |tag|
-          tags_builder.tag do |tag_builder|
-            tag_builder.id(tag.id)
-            tag_builder.name(tag.name)
-            tag_builder.taggings do |taggings_builder|
-              tag.taggings.each do |tagging|
-                taggings_builder.tagging do |tagging_builder|
-                  tagging_builder.tag!('taggable-id', tagging.taggable_id)
-                  tagging_builder.tag!('taggable-type', tagging.taggable_type)
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-
-
-    # Cache user emails so we don't have to make an extra SQL request
-    # for every activity
-    def user_email_for_activity(activity)
-      return activity.user if activity.user.is_a?(String)
-
-      @user_emails ||= begin
-        User.select([:id, :email]).all.each_with_object({}) do |user, hash|
-          hash[user.id] = user.email
-        end
-      end
-      @user_emails[activity.user_id]
-    end
-
+    def build_categories(builder);    raise NotImplementedError; end
+    def build_issues(builder);        raise NotImplementedError; end
+    def build_methodologies(builder); raise NotImplementedError; end
+    def build_nodes(builder);         raise NotImplementedError; end
+    def build_tags(builder);          raise NotImplementedError; end
+    def version;                      raise NotImplementedError; end
   end
 end
+
+require_relative 'v1/template'

data/lib/dradis/plugins/projects/export/v1/template.rb

@@ -0,0 +1,167 @@
+module Dradis::Plugins::Projects::Export::V1
+  class Template < Dradis::Plugins::Projects::Export::Template
+    VERSION = 1
+
+    protected
+
+    def build_activities_for(builder, trackable)
+      builder.activities do |activities_builder|
+        trackable.activities.each do |activity|
+          activities_builder.activity do |activity_builder|
+            activity_builder.action(activity.action)
+            activity_builder.user_email(user_email_for_activity(activity))
+            activity_builder.created_at(activity.created_at.to_i)
+          end
+        end
+      end
+    end
+
+    def build_categories(builder)
+      categories = []
+      categories << Category.issue if @issues.any?
+      categories += @nodes.map do |node|
+        node.notes.map { |note| note.category }.uniq
+      end.flatten.uniq
+
+      builder.categories do |categories_builder|
+        categories.each do |category|
+          categories_builder.category do |category_builder|
+            category_builder.id(category.id)
+            category_builder.name(category.name)
+          end
+        end
+      end
+    end
+
+    def build_evidence_for_node(builder, node)
+      builder.evidence do |evidences_builder|
+        node.evidence.each do |evidence|
+          evidences_builder.evidence do |evidence_builder|
+            evidence_builder.id(evidence.id)
+            evidence_builder.author(evidence.author)
+            evidence_builder.tag!('issue-id', evidence.issue_id)
+            evidence_builder.content do
+              evidence_builder.cdata!(evidence.content)
+            end
+            build_activities_for(evidence_builder, evidence)
+          end
+        end
+      end
+    end
+
+    def build_issues(builder)
+      @issues = Issue.where(node_id: Node.issue_library).includes(:activities)
+
+      builder.issues do |issues_builder|
+        @issues.each do |issue|
+          issues_builder.issue do |issue_builder|
+            issue_builder.id(issue.id)
+            issue_builder.author(issue.author)
+            issue_builder.text do
+              issue_builder.cdata!(issue.text)
+            end
+            build_activities_for(issue_builder, issue)
+          end
+        end
+      end
+    end
+
+    def build_methodologies(builder)
+      methodologies = Node.methodology_library.notes
+      builder.methodologies do |methodologies_builder|
+        methodologies.each do |methodology|
+          methodologies_builder.methodology do |methodology_builder|
+            methodology_builder.text do
+              methodology_builder.cdata!(methodology.text)
+            end
+          end
+        end
+      end
+    end
+
+    def build_nodes(builder)
+      @nodes = Node.includes(:activities, :evidence, :notes, evidence: [:activities], notes: [:activities, :category]).all.reject do |node|
+        [Node::Types::METHODOLOGY,
+          Node::Types::ISSUELIB].include?(node.type_id)
+      end
+
+      builder.nodes do |nodes_builder|
+        @nodes.each do |node|
+          nodes_builder.node do |node_builder|
+            node_builder.id(node.id)
+            node_builder.label(node.label)
+            node_builder.tag!('parent-id', node.parent_id)
+            node_builder.position(node.position)
+            node_builder.properties do
+              node_builder.cdata!(node.raw_properties)
+            end
+            node_builder.tag!('type-id', node.type_id)
+            # Notes
+            build_notes_for_node(node_builder, node)
+            # Evidence
+            build_evidence_for_node(node_builder, node)
+            build_activities_for(node_builder, node)
+          end
+        end
+      end
+    end
+
+    def build_notes_for_node(builder, node)
+      builder.notes do |notes_builder|
+        node.notes.each do |note|
+          notes_builder.note do |note_builder|
+            note_builder.id(note.id)
+            note_builder.author(note.author)
+            note_builder.tag!('category-id', note.category_id)
+            note_builder.text do
+              note_builder.cdata!(note.text)
+            end
+            build_activities_for(note_builder, note)
+          end
+        end
+      end
+    end
+
+    def build_tags(builder)
+      tags = Tag.all
+      builder.tags do |tags_builder|
+        tags.each do |tag|
+          tags_builder.tag do |tag_builder|
+            tag_builder.id(tag.id)
+            tag_builder.name(tag.name)
+            tag_builder.taggings do |taggings_builder|
+              tag.taggings.each do |tagging|
+                taggings_builder.tagging do |tagging_builder|
+                  tagging_builder.tag!('taggable-id', tagging.taggable_id)
+                  tagging_builder.tag!('taggable-type', tagging.taggable_type)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+
+    # Cache user emails so we don't have to make an extra SQL request
+    # for every activity
+    def user_email_for_activity(activity)
+      return activity.user if activity.user.is_a?(String)
+
+      @user_emails ||= begin
+        User.select([:id, :email]).all.each_with_object({}) do |user, hash|
+          hash[user.id] = user.email
+        end
+      end
+      @user_emails[activity.user_id]
+    end
+
+    # Use the class VERSION constant, but allow for subclasses to overwrite it.
+    #
+    # See:
+    #   http://stackoverflow.com/questions/3174563/how-to-use-an-overridden-constant-in-an-inheritanced-class
+    def version
+      self.class::VERSION
+    end
+  end
+end