dradis-projects 3.0.0

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

@@ -0,0 +1,13 @@
+require_relative 'gem_version'
+
+module Dradis
+  module Plugins
+    module Projects
+      # Returns the version of the currently loaded Projects as a
+      # <tt>Gem::Version</tt>.
+      def self.version
+        gem_version
+      end
+    end
+  end
+end

data/lib/tasks/thorfile.rb

@@ -0,0 +1,139 @@
+require 'logger'
+
+class ExportTasks < Thor
+  include Dradis::Plugins::thor_helper_module.to_s.constantize
+
+  namespace   "dradis:plugins:projects:export"
+
+  desc "template", "export the current repository structure as a dradis template"
+  method_option   :file, type: :string, desc: "the template file to create, or directory to create it in"
+  def template
+    require 'config/environment'
+
+    logger        = Logger.new(STDOUT)
+    logger.level  = Logger::DEBUG
+    template_path = options.file || Rails.root.join('backup').to_s
+
+    unless template_path =~ /\.xml\z/
+      date          = DateTime.now.strftime("%Y-%m-%d")
+      sequence      = Dir.glob(File.join(template_path, "dradis-template_#{date}_*.xml")).collect do |a|
+                        a.match(/_([0-9]+)\.xml\z/)[1].to_i
+                      end.max || 0
+
+      template_path = File.join(template_path, "dradis-template_#{date}_#{sequence + 1}.xml")
+    end
+
+    detect_and_set_project_scope
+
+    exporter = Dradis::Plugins::Projects::Export::Template.new(
+      content_service: content_service_for(Dradis::Plugins::Projects::Export::Template),
+      logger: logger
+    )
+
+    File.open(template_path, 'w') { |f| f.write exporter.export() }
+
+    logger.info { "Template file created at:\n\t#{ File.expand_path( template_path ) }" }
+    logger.close
+  end
+
+
+  desc      "package", "creates a copy of your current repository"
+  long_desc "Creates a copy of the current repository, including all nodes, notes and " +
+            "attachments as a zipped archive. The backup can be imported into another " +
+            "dradis instance using the 'Project Package Upload' option."
+  method_option   :file, type: :string, desc: "the package file to create, or directory to create it in"
+  def package
+    require 'config/environment'
+
+    logger        = Logger.new(STDOUT)
+    logger.level  = Logger::DEBUG
+    package_path  = options.file || Rails.root.join('backup')
+
+    unless package_path =~ /\.zip\z/
+      date      = DateTime.now.strftime("%Y-%m-%d")
+      sequence  = Dir.glob(File.join(package_path, "dradis-export_#{date}_*.zip")).collect { |a| a.match(/_([0-9]+)\.zip\z/)[1].to_i }.max || 0
+      package_path = File.join(package_path, "dradis-export_#{date}_#{sequence + 1}.zip")
+    end
+
+    detect_and_set_project_scope
+
+    Dradis::Plugins::Projects::Export::Package.new(
+      content_service: content_service_for(Dradis::Plugins::Projects::Export::Package),
+      logger: logger
+    ).export(filename: package_path)
+
+    logger.info{ "Project package created at:\n\t#{ File.expand_path( package_path ) }" }
+    logger.close
+  end
+
+end
+
+class UploadTasks < Thor
+  include Dradis::Plugins::thor_helper_module.to_s.constantize
+
+  namespace   "dradis:plugins:projects:upload"
+
+  # This task will load into the current database the contents of the template
+  # file passed as the first argument
+  desc "template FILE", "create a new repository structure from an XML file"
+  def template(file_path)
+    require 'config/environment'
+
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::DEBUG
+
+    unless File.exists?(file_path)
+      $stderr.puts "** the file [#{file_path}] does not exist"
+      exit -1
+    end
+
+    detect_and_set_project_scope
+
+    content_service  = content_service_for(Dradis::Plugins::Projects::Upload::Template)
+    template_service = Dradis::Plugins::TemplateService.new(plugin: Dradis::Plugins::Projects::Upload::Template)
+
+    importer = Dradis::Plugins::Projects::Upload::Template::Importer.new(
+      logger:           logger,
+      content_service:  content_service,
+      template_service: template_service
+    )
+
+    importer.import(file: file_path)
+
+    logger.close
+  end
+
+
+  # The reverse operation to the dradis:export:project:package task. From a
+  # zipped project package extract the contents of the archive and populate
+  # the dradis DB and attachments with them.
+  desc "package FILE", "import an entire repository package"
+  def package(file_path)
+    require 'config/environment'
+
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::DEBUG
+
+    unless File.exists?(file_path)
+      $stderr.puts "** the file [#{file_path}] does not exist"
+      exit -1
+    end
+
+
+    detect_and_set_project_scope
+
+    content_service  = content_service_for(Dradis::Plugins::Projects::Upload::Package)
+    template_service = Dradis::Plugins::TemplateService.new(plugin: Dradis::Plugins::Projects::Upload::Package)
+
+    importer = Dradis::Plugins::Projects::Upload::Package::Importer.new(
+                logger: logger,
+       content_service: content_service,
+      template_service: template_service
+    )
+
+    importer.import(file: file_path)
+
+    logger.close
+  end
+
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: dradis-projects
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Daniel Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dradis-plugins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: This plugin allows you to dump the contents of the repo into a zip archive
+  and restore the state from one of them.
+email:
+- etd@nomejortu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/dradis/plugins/projects/packages_controller.rb
+- app/controllers/dradis/plugins/projects/templates_controller.rb
+- config/routes.rb
+- dradis-projects.gemspec
+- lib/dradis-projects.rb
+- lib/dradis/plugins/projects.rb
+- lib/dradis/plugins/projects/engine.rb
+- lib/dradis/plugins/projects/export/package.rb
+- lib/dradis/plugins/projects/export/template.rb
+- lib/dradis/plugins/projects/gem_version.rb
+- lib/dradis/plugins/projects/upload/package.rb
+- lib/dradis/plugins/projects/upload/template.rb
+- lib/dradis/plugins/projects/version.rb
+- lib/tasks/thorfile.rb
+homepage: http://dradisframework.org
+licenses:
+- GPL-2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Project export/upload for the Dradis Framework.
+test_files: []