Class: Arachni::Plugin::Base Abstract

Inherits:
Object
  • Object
show all
Includes:
Module::Output
Defined in:
lib/plugin/base.rb

Overview

This class is abstract.

Arachni::Plugin::Base class

An abstract class for the plugins.<br/> All plugins must extend this.

@author: Tasos “Zapotek” Laskos

<[email protected]>
<[email protected]>

@version: 0.1

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Module::Output

#o_print_debug, #o_print_error, #o_print_info, #o_print_line, #o_print_ok, #o_print_status, #o_print_verbose, #print_debug, #print_error, #print_info, #print_line, #print_ok, #print_status, #print_verbose

Methods included from UI::Output

#buffer, #debug!, #debug?, #flush_buffer, #mute!, #muted?, #only_positives!, #only_positives?, #print_debug, #print_debug_backtrace, #print_debug_pp, #print_error, #print_error_backtrace, #print_info, #print_line, #print_ok, #print_status, #print_verbose, #reroute_to_file, #reroute_to_file?, #unmute!, #verbose!, #verbose?

Constructor Details

#initialize(framework, options) ⇒ Base

Returns a new instance of Base.

Parameters:



57
58
59
60
 
# File 'lib/plugin/base.rb', line 57

def initialize( framework, options )
    @framework = framework
    @options   = options
end

Class Method Details

.info ⇒ Object

REQUIRED

Do not ommit any of the info.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/plugin/base.rb', line 93

def self.info
    {
        :name           => 'Abstract plugin class',
        :description    => %q{Abstract plugin class.},
        :author         => 'Tasos "Zapotek" Laskos <[email protected]>',
        :version        => '0.1',
        :options        => [
            #                        option name       required?       description                     default
            # Arachni::OptBool.new( 'print_framework', [ false, 'Do you want to print the framework?', false ] ),
            # Arachni::OptString.new( 'my_name_is',    [ false, 'What\'s you name?', 'Tasos' ] ),
        ]
    }
end

Instance Method Details

#clean_up ⇒ Object

OPTIONAL



80
81
82
 
# File 'lib/plugin/base.rb', line 80

def clean_up( )

end

#prepare ⇒ Object

OPTIONAL



66
67
68
 
# File 'lib/plugin/base.rb', line 66

def prepare( )

end

#register_results(results) ⇒ Object 



84
85
86
 
# File 'lib/plugin/base.rb', line 84

def register_results( results )
    @framework.plugin_store( self, results )
end

#run ⇒ Object

REQUIRED



73
74
75
 
# File 'lib/plugin/base.rb', line 73

def run( )

end