dradis-plugins 3.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b231853a8ff2f2abe085576c558a48258331c03
+  data.tar.gz: 47ca422c98df77c01578b824a222e851a58bb198
+SHA512:
+  metadata.gz: ee50b07b08ea47999650868d2b056e1a259fd32a9ba3960f79b0062e224516140517ed84f65cf7a707d9019c654eeacb145e0b0466209d06440beee2596487c5
+  data.tar.gz: 0ba086c181e376c710c0bf814369e230f2d9462b452957b5de99e1c389b98d56f5ae74d2728984b3eaa5699f5e9e0be15b5bd33daf9b7bb32b952de7efdca89d

data/.gitignore

@@ -0,0 +1,11 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+/Gemfile.lock
+/pkg/
+/vendor/bundle/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Plugin contribution guidelines
+
+See the Dradis Framework's [CONTRIBUTING.md](https://github.com/dradis/dradisframework/blob/master/CONTRIBUTING.md)

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+#gem 'dradis_core', path: '/Users/etd/dradis/git/dradis/core'
+#gem 'dradis', :github => 'dradis/dradisframework' # temporarily here until 3.0.0.beta is released
+# git "https://github.com/dradis/dradisframework.git", :branch => 'dradis3.x' do
+#   gem 'dradis_core'
+# end
+
+# Specify your gem's dependencies in dradis-html_export.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README.md

@@ -0,0 +1,25 @@
+# Plugin manager for the Dradis Framework
+
+[![Build Status](https://secure.travis-ci.org/dradis/dradis-plugins.png?branch=master)](http://travis-ci.org/dradis/dradis-plugins)
+
+This gem contains the base classes needed to manage the plugins in Dradis.
+
+The Dradis 3 gemified plugin Engines need to include Dradis::Plugins::Base which is defined in this class.
+
+Warning, we me end up merging this gem with Dradis::Core!!
+
+The plugin requires Dradis 3.0 or higher.
+
+## More information
+
+See the Dradis Framework's [README.md](https://github.com/dradis/dradisframework/blob/master/README.md)
+
+
+## Contributing
+
+See the Dradis Framework's [CONTRIBUTING.md](https://github.com/dradis/dradisframework/blob/master/CONTRIBUTING.md)
+
+
+## License
+
+Dradis Framework and all its components are released under [GNU General Public License version 2.0](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file.

data/Rakefile

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

data/dradis-plugins.gemspec

@@ -0,0 +1,30 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'dradis/plugins/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.platform      = Gem::Platform::RUBY
+  spec.name = 'dradis-plugins'
+  spec.version = Dradis::Plugins::VERSION::STRING
+  spec.summary = 'Plugin manager for the Dradis Framework project.'
+  spec.description = 'Required dependency for Dradis Framework.'
+
+  spec.license = 'GPL-2'
+
+  spec.authors = ['Daniel Martin']
+  spec.email = ['etd@nomejortu.com']
+  spec.homepage = 'http://dradisframework.org'
+
+  spec.files = `git ls-files`.split($\)
+  spec.executables = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # By not including Rails as a dependency, we can use the gem with different
+  # versions of Rails (a sure recipe for disaster, I'm sure), which is needed
+  # until we bump Dradis Pro to 4.1.
+  # s.add_dependency 'rails', '~> 4.1.1'
+end

data/lib/dradis-plugins.rb

@@ -0,0 +1 @@
+require 'dradis/plugins'

data/lib/dradis/plugins.rb

@@ -0,0 +1,115 @@
+require 'dradis/plugins/engine'
+require 'dradis/plugins/version'
+
+require 'dradis/plugins/content_service'
+require 'dradis/plugins/template_service'
+
+require 'dradis/plugins/import'
+require 'dradis/plugins/upload'
+
+module Dradis
+  module Plugins
+    module Base
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          # mattr_accessor :plugin_name
+
+          @features = []
+          @name = 'Use plugin_info(args) with :name to provide a name for this plugin.'
+          Plugins::register(self)
+        end
+      end
+
+      module ClassMethods
+        # def options(key)
+        #   @options[key]
+        # end
+        #
+        # def plugin_info(args={})
+        #   features = args.delete(:provides)
+        #   provides(features)
+        #   @options = args
+        # end
+
+        def description(new_description)
+          @description = new_description
+        end
+
+        def plugin_description
+          @description ||= "This plugin doesn't provide a :description"
+        end
+
+        def plugin_name
+          self.name.split('::')[2].underscore.to_sym
+        end
+
+        def provides(*list)
+          @features = list
+        end
+
+        def provides?(feature)
+          @features.include?(feature)
+        end
+      end
+    end
+
+    class << self
+      @@extensions = []
+
+      # Returns an array of modules representing currently registered Dradis Plugins / engines
+      #
+      # Example:
+      #   Dradis::Core::Plugins.list  =>  [Dradis::Core, Dradis::Frontend]
+      def list
+        @@extensions
+      end
+
+      # Filters the list of plugins and only returns those that provide the
+      # requested feature.
+      def with_feature(feature)
+        @@extensions.select do |plugin|
+          # engine = "#{plugin}::Engine".constantize
+          plugin.provides?(feature)
+        end
+      end
+
+      # Register a plugin with the framework
+      #
+      # Example:
+      #   Dradis::Core::Plugins.register(Dradis::Core)
+      def register(const)
+        return if registered?(const)
+
+        validate_plugin!(const)
+
+        @@extensions << const
+      end
+
+      # Unregister a plugin from the framework
+      #
+      # Example:
+      #   Dradis::Core::Plugins.unregister(Dradis::Core)
+      def unregister(const)
+        @@extensions.delete(const)
+      end
+
+      # Returns true if a plugin is currently registered with the framework
+      #
+      # Example:
+      #   Dradis::Core::Plugins.registered?(Dradis::Core)
+      def registered?(const)
+        @@extensions.include?(const)
+      end
+
+      private
+
+      # Use this to ensure the Extension conforms with some expected interface
+      def validate_plugin!(const)
+        # unless const.respond_to?(:root) && const.root.is_a?(Pathname)
+        #   raise InvalidEngineError, "Engine must define a root accessor that returns a pathname to its root"
+        # end
+      end
+    end
+  end
+end

data/lib/dradis/plugins/content_service.rb

@@ -0,0 +1,93 @@
+module Dradis
+  module Plugins
+    class ContentService
+      attr_accessor :logger, :plugin
+
+      def initialize(args={})
+        @plugin = args[:plugin]
+      end
+
+      # Create a hash with all issues where the keys correspond to the field passed
+      # as an argument.
+      #
+      # This is use by the plugins to check whether a given issue is already in
+      # the project.
+      def all_issues_by_field(field)
+        # we don't memoize it because we want it to reflect recently added Issues
+        klass = class_for(:issue)
+
+        issues_map = klass.where(category_id: default_issue_category.id).map do |issue|
+          [issue.fields[field], issue]
+        end
+        Hash[issues_map]
+      end
+
+
+      def create_node(args={})
+        label   = args[:label] || "create_node() invoked by #{plugin} without a :label parameter"
+        type_id = args[:type_id] || default_node_type
+        parent  = args[:parent] || default_parent_node
+
+        parent.children.find_or_create_by_label_and_type_id(label, type_id)
+      end
+
+      def create_note(args={})
+        node = args[:node] || default_parent_node
+        text = args[:text] || "create_note() invoked by #{plugin} without a :text parameter"
+
+        node.notes.create text: text, category: default_note_category, author: default_author
+      end
+
+      def create_issue(args={})
+        text = args[:text] || "create_issue() invoked by #{plugin} without a :text parameter"
+
+        # we inject the source Plugin into the issue's text
+        text << "\n\n#[plugin]#\n#{plugin::Engine::plugin_name}\n"
+
+        class_for(:issue).create(text: text) do |i|
+          i.author   = default_author
+          i.node     = issuelib
+          i.category = default_issue_category
+        end
+      end
+
+      def create_evidence(args={})
+        content = args[:content] || "create_evidence() invoked by #{plugin} without a :content parameter"
+        node    = args[:node] || default_parent_node
+        issue   = args[:issue] || create_issue(text: "#[Title]#\nAuto-generated issue.\n\n#[Description]#\ncreate_evidence() invoked by #{plugin} without an :issue parameter")
+
+        node.evidence.create(issue_id: issue.id, content: content)
+      end
+
+      private
+      def class_for(model)
+        "Dradis::Core::#{model.to_s.capitalize}".constantize
+      end
+
+
+      def default_author
+        @default_author ||= "#{plugin::Engine.plugin_name.to_s.humanize} upload plugin"
+      end
+
+      def default_issue_category
+        @default_issue_category ||= class_for(:category).issue
+      end
+
+      def default_node_type
+        @default_node_type ||= class_for(:node)::Types::DEFAULT
+      end
+
+      def default_note_category
+        @default_note_category ||= class_for(:category).default
+      end
+
+      def default_parent_node
+        @default_parent_node ||= class_for(:node).create(label: 'plugin.output')
+      end
+
+      def issuelib
+        @issuelib ||= class_for(:node).issue_library
+      end
+    end
+  end
+end

data/lib/dradis/plugins/engine.rb

@@ -0,0 +1,19 @@
+module Dradis
+  module Plugins
+    class Engine < ::Rails::Engine
+      isolate_namespace Dradis::Plugins
+
+      # initializer 'frontend.append_migrations' do |app|
+      #   unless app.root.to_s == root.to_s
+      #     config.paths["db/migrate"].expanded.each do |path|
+      #       app.config.paths["db/migrate"].push(path)
+      #     end
+      #   end
+      # end
+
+      # initializer 'frontend.asset_precompile_paths' do |app|
+      #   app.config.assets.precompile += ["dradis/frontend/manifests/*"]
+      # end
+    end
+  end
+end

data/lib/dradis/plugins/gem_version.rb

@@ -0,0 +1,17 @@
+module Dradis
+  module Plugins
+    # Returns the version of the currently loaded Frontend as a <tt>Gem::Version</tt>
+    def self.gem_version
+      Gem::Version.new VERSION::STRING
+    end
+
+    module VERSION
+      MAJOR = 3
+      MINOR = 0
+      TINY = 0
+      PRE = 'pre'
+
+      STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+    end
+  end
+end

data/lib/dradis/plugins/import.rb

@@ -0,0 +1,3 @@
+require 'dradis/plugins/import/filters'
+require 'dradis/plugins/import/filters/base'
+require 'dradis/plugins/import/result'

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

@@ -0,0 +1,50 @@
+module Dradis
+  module Plugins
+    module Import
+
+      module Filters
+        class << self
+          # -- Class Methods --------------------------------------------------------
+          # One Import plugin can define several filters (e.g. to query different
+          # endpoints of a remote API).
+          #
+          # Use this method in your Importer to register different filters, pass a
+          # block or a class.
+          #
+          # Examples:
+          #
+          # register_filter :by_osvdb_id do
+          #   def c
+          # end
+          def add(label, filter, &block)
+            filter ||= Class.new(Dradis::Plugins::Import::Filters::Base)
+            filter.class_eval(&block) if block_given?
+
+            unless filter.method_defined?(:query)
+              raise NoMethodError, "query() is not declared in the #{label.inspect} strategy"
+            end
+
+            base = Dradis::Plugins::Import::Filters::Base
+            unless filter.ancestors.include?(base)
+              raise "#{label.inspect} is not a #{base}"
+            end
+
+            _filters[label] = filter
+          end
+
+          # Provides access to strategies by label
+          # :api: public
+          def [](label)
+            _filters[label]
+          end
+
+          # :api: private
+          def _filters
+            @filters ||= {}
+          end
+        end
+      end
+
+    end
+  end
+end

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

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

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

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

data/lib/dradis/plugins/template_service.rb

@@ -0,0 +1,102 @@
+module Dradis
+  module Plugins
+    class TemplateService
+      attr_accessor :logger, :template, :templates_dir
+
+      def initialize(args={})
+        @plugin = args[:plugin]
+        @templates_dir = args[:templates_dir] || default_templates_dir
+      end
+
+
+      # For a given entry, return a text blob resulting from applying the
+      # chosen template to the supplied entry.
+      def process_template(args={})
+        self.template = args[:template]
+        data          = args[:data]
+
+        processor = @plugin::FieldProcessor.new(data: data)
+
+        template_source.gsub( /%(.*?)%/ ) do |field|
+          name = field[1..-2]
+          if fields.include?(name)
+            processor.value(field: name)
+          else
+            "Field [#{field}] not recognized by the plugin"
+          end
+        end
+      end
+
+
+      # ---------------------------------------------- Plugin Manager interface
+
+      # This lists the fields defined by this plugin that can be used in the
+      # template
+      def fields
+        @fields ||= {}
+        @fields[template] ||= begin
+          fields_file = File.join(templates_dir, "#{template}.fields")
+          File.readlines(fields_file).map(&:chomp)
+        end
+      end
+
+      # This returns a sample of valid entry for the Plugin Manager
+      def sample
+        @sample ||= {}
+        @sample[template] ||= begin
+          sample_file = File.join(templates_dir, "#{template}.sample")
+          File.read(sample_file)
+        end
+      end
+
+      # Set the plugin's item template. This is used by the Plugins Manager
+      # to force the plugin to use the new_template (provided by the user)
+      def set_template(args={})
+        template = args[:template]
+        content  = args[:content]
+
+        @sources ||= {}
+        @sources[template] ||= {
+          content: nil,
+          mtime: DateTime.now
+        }
+        @sources[template][:content] = content
+      end
+
+      # This method returns the current template's source. It caches the
+      # template based on the file's last-modified time and refereshes the
+      # cached copy when it detects changes.
+      def template_source
+        @sources ||= {}
+
+        # The template can change from one time to the next (via the Plugin Manager)
+        template_file  = File.join(templates_dir, "#{template}.template")
+        template_mtime = File.mtime(template_file)
+
+        if @sources.key?(template)
+          # refresh cached version if modified since last read
+          if template_mtime > @sources[template][:mtime]
+            @template[template][:mtime] = template_mtime
+            @template[template][:content] = File.read( template_file )
+          end
+        else
+          @sources[template] = {
+            mtime: template_mtime,
+            content: File.read(template_file)
+          }
+        end
+
+        @sources[template][:content]
+      end
+      # --------------------------------------------- /Plugin Manager interface
+
+      private
+
+      # This method returns the default location in which plugins should look
+      # for their templates.
+      def default_templates_dir
+        @default_templates_dir ||= Rails.root.join('templates', 'plugins', @plugin::Engine::plugin_name.to_s)
+      end
+    end
+  end
+end

data/lib/dradis/plugins/upload.rb

@@ -0,0 +1,2 @@
+require 'dradis/plugins/upload/base'
+require 'dradis/plugins/upload/field_processor'

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

@@ -0,0 +1,42 @@
+# This module contains basic Upload plugin functions to control template
+# sample and field management for the Plugin Manager.
+#
+module Dradis
+  module Plugins
+    module Upload
+      class Base
+        attr_accessor :content_service, :logger, :template_service
+
+        def initialize(args={})
+          @logger = args.fetch(:logger, Rails.logger)
+
+          @content_service = args[:content_service] || default_content_service
+          @template_service = args[:template_service] || default_template_service
+
+          content_service.logger = logger
+          template_service.logger = logger
+
+          post_initialize(args)
+        end
+
+        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={})
+        end
+
+        private
+        def default_content_service
+          @content ||= Dradis::Plugins::ContentService.new
+        end
+
+        def default_template_service
+          @template ||= Dradis::Plugins::TemplateService.new
+        end
+      end # Base
+
+    end # Upload
+  end # Plugins
+end # Core

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

@@ -0,0 +1,29 @@
+# The plugin's FieldProcessor is in charge of understanding the incoming data
+# from the uploaded file and extracting the fields to populate the template.
+# Plugins are expected to overwrite the value() method.
+#
+module Dradis
+  module Plugins
+    module Upload
+
+      class FieldProcessor
+        attr_reader :data
+
+        def initialize(args={})
+          @data = args[:data]
+          post_initialize(args)
+        end
+
+        # Inspect the data object currently stored in this processor instance
+        # and extract the value of the requested field.
+        #
+        # Subclasses will overwrite this method.
+        def value(args={})
+          field = args[:field]
+          "Sorry, this plugin doesn't define a FieldProcessor (called for [#{field}])"
+        end
+      end
+
+    end
+  end
+end

data/lib/dradis/plugins/version.rb

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

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: dradis-plugins
+version: !ruby/object:Gem::Version
+  version: 3.0.0.pre
+platform: ruby
+authors:
+- Daniel Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-31 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: 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'
+description: Required dependency for Dradis Framework.
+email:
+- etd@nomejortu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dradis-plugins.gemspec
+- lib/dradis-plugins.rb
+- lib/dradis/plugins.rb
+- lib/dradis/plugins/content_service.rb
+- lib/dradis/plugins/engine.rb
+- lib/dradis/plugins/gem_version.rb
+- lib/dradis/plugins/import.rb
+- lib/dradis/plugins/import/filters.rb
+- lib/dradis/plugins/import/filters/base.rb
+- lib/dradis/plugins/import/result.rb
+- lib/dradis/plugins/template_service.rb
+- lib/dradis/plugins/upload.rb
+- lib/dradis/plugins/upload/base.rb
+- lib/dradis/plugins/upload/field_processor.rb
+- lib/dradis/plugins/version.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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: Plugin manager for the Dradis Framework project.
+test_files: []