ronin 1.4.1 → 1.5.0.rc1

data/lib/ronin/installation.rb

@@ -77,8 +77,8 @@ module Ronin
     # Enumerates over all files within a given directory found in any
     # of the installed Ronin libraries.
     #
-    # @param [String] directory
-    #   The directory path to search within.
+    # @param [String] pattern
+    #   The glob pattern to search for.
     #
     # @yield [file]
     #   The given block will be passed each file found within the directory.

data/lib/ronin/model/model.rb

@@ -18,7 +18,6 @@
 #
 
 require 'ronin/model/types'
-require 'ronin/support/inflector'
 
 require 'dm-core'
 require 'dm-types'
@@ -75,9 +74,9 @@ module Ronin
       # @api semipublic
       #
       def relationship_name
-        name = Support::Inflector.underscore(self.name.split('::').last)
-
-        return Support::Inflector.pluralize(name).to_sym
+        DataMapper::Inflector.pluralize(
+          DataMapper::Inflector.underscore(self.name.split('::').last)
+        ).to_sym
       end
 
       #
@@ -133,7 +132,7 @@ module Ronin
           if value.kind_of?(Array)
             value.map(&formatter).join(', ')
           elsif value.kind_of?(Symbol)
-            Support::Inflector.humanize(value)
+            DataMapper::Inflector.humanize(value)
           else
             value.to_s
           end
@@ -148,7 +147,7 @@ module Ronin
             name = name.to_s
 
             unless name[-3..-1] == '_id'
-              name = Support::Inflector.humanize(name)
+              name = DataMapper::Inflector.humanize(name)
               value = formatter.call(value)
 
               if block_given?

data/lib/ronin/model/types/description.rb

@@ -35,9 +35,6 @@ module Ronin
         # @param [Object] value
         #   The text of the description.
         #
-        # @param [DataMapper::Property] property
-        #   The description property.
-        #
         # @return [String, nil]
         #   The type-casted description.
         #

data/lib/ronin/os.rb

@@ -96,8 +96,8 @@ module Ronin
     # @param [Symbol, String] name
     #   The method name to define for the predefined OS.
     #
-    # @param [String] os_name
-    #   The name of the OS.
+    # @param [Hash{Symbol => Object}] attributes
+    #   Additional attributes for the OS.
     #
     # @return [nil]
     #

data/lib/ronin/password.rb

@@ -63,7 +63,7 @@ module Ronin
     #
     # Hashes the password.
     #
-    # @param [Symbol, String] digest
+    # @param [Symbol, String] algorithm
     #   The digest algorithm to use.
     #
     # @param [Hash] options

data/lib/ronin/repository.rb

@@ -126,10 +126,10 @@ module Ronin
     # @param [Hash] attributes
     #   The attributes of the repository.
     #
-    # @param [String] path
+    # @option attributes [String] :path
     #   The path to the repository.
     #
-    # @param [Symbol] scm
+    # @option attributes [Symbol] :scm
     #   The SCM used by the repository. Can be either:
     #
     #   * `:git`
@@ -137,7 +137,7 @@ module Ronin
     #   * `:sub_version` / `:svn`
     #   * `:rsync`
     #
-    # @param [String, URI::HTTP, URI::HTTPS] uri
+    # @option attributes [String, URI] :uri
     #   The URI the repository resides at.
     #
     # @yield [repo]
@@ -393,10 +393,10 @@ module Ronin
     end
 
     #
-    # De-activates all installed or added repositories.
+    # Deactivates all installed or added repositories.
     #
     # @return [Array<Repository>]
-    #   The de-activated repositories.
+    #   The deactivated repositories.
     #
     # @see #deactivate!
     #
@@ -520,7 +520,7 @@ module Ronin
     end
 
     #
-    # De-activates the repository by removing the {#lib_dir} from the
+    # Deactivates the repository by removing the {#lib_dir} from the
     # `$LOAD_PATH` global variable.
     #
     # @api private

data/lib/ronin/script/path.rb

@@ -19,7 +19,6 @@
 
 require 'ronin/model'
 require 'ronin/script/script'
-require 'ronin/support/inflector'
 
 require 'object_loader'
 
@@ -66,7 +65,7 @@ module Ronin
       #
       def class_path
         if self.class_name
-          Support::Inflector.underscore(self.class_name)
+          DataMapper::Inflector.underscore(self.class_name)
         end
       end
 

data/lib/ronin/spec/database.rb

@@ -24,13 +24,25 @@ require 'tempfile'
 
 RSpec.configure do |spec|
   spec.before(:suite) do
-    database_file = Tempfile.new('ronin_database').path
-    database_uri  = {:adapter => 'sqlite3', :database => database_file}
+    defaults = {
+      :user     => 'ronin_test',
+      :password => 'ronin_test',
+      :database => 'ronin_test'
+    }
+    adapter  = ENV.fetch('ADAPTER','sqlite3')
 
-    Ronin::Database.repositories[:default] = database_uri
+    uri = case adapter
+          when 'sqlite3', 'sqlite'
+            {
+              :adapter  => 'sqlite3',
+              :database => Tempfile.new('ronin_database').path
+            }
+          else
+            defaults.merge(:adapter => adapter)
+          end
 
     # setup the database
-    Ronin::Database.setup
+    Ronin::Database.setup(uri)
 
     # auto-migrate any models defined in the specs
     DataMapper.finalize.auto_migrate!

data/lib/ronin/ui/cli/cli.rb

@@ -51,7 +51,7 @@ module Ronin
         if @commands.empty?
           commands_dir = File.join('lib',Commands.namespace_root)
 
-          Installation.each_file_in(commands_dir,:rb) do |path|
+          Installation.each_file_in(commands_dir,'rb') do |path|
             # remove the .rb file extension
             name = path.chomp('.rb')
 

data/lib/ronin/ui/cli/command.rb

@@ -185,9 +185,7 @@ module Ronin
         # @api public
         #
         def self.run(options={})
-          command = new()
-          
-          return command.run(options)
+          new().run(options)
         end
 
         #
@@ -263,7 +261,10 @@ module Ronin
 
           setup
           execute
+
           return true
+        ensure
+          cleanup
         end
 
         #
@@ -293,6 +294,16 @@ module Ronin
         def execute
         end
 
+        #
+        # Default method to call after the command has finished.
+        #
+        # @since 1.5.0
+        #
+        # @api semipublic
+        #
+        def cleanup
+        end
+
         protected
 
         #
@@ -343,6 +354,31 @@ module Ronin
           end
         end
 
+        #
+        # Example usages for the command.
+        #
+        # @param [Array<String>] new_examples
+        #   The new examples for the command.
+        #
+        # @return [Array]
+        #   Example commands.
+        #
+        # @since 1.5.0
+        #
+        # @api semipublic
+        #
+        def self.examples(new_examples=nil)
+          if new_examples
+            @examples = new_examples
+          else
+            @examples ||= if superclass < Command
+                            superclass.examples.dup
+                          else
+                            []
+                          end
+          end
+        end
+
         #
         # The options for the parameters.
         #
@@ -366,7 +402,7 @@ module Ronin
         # @param [Hash] options
         #   Additional options for the option.
         #
-        # @option options [Hash{Class => Class}, Set<Class>, Array<Class>, Class, true] :type (String)
+        # @option options [Hash{Class => Class}, Set<Class>, Array<Class>, Class, true] :type
         #   The type of the options.
         #
         # @option options [Object, Proc] :default
@@ -395,8 +431,6 @@ module Ronin
         # @api semipublic
         #
         def self.option(name,options={})
-          options = {:type => String}.merge(options)
-
           self.options[name] = {
             :flag  => options[:flag],
             :usage => options[:usage],
@@ -417,7 +451,7 @@ module Ronin
                         :description  => 'Silence all output'
 
         option :color, :type        => true,
-                       :default     => proc { !$stdout.tty? },
+                       :default     => proc { $stdout.tty? },
                        :description => 'Enables color output'
 
         #
@@ -598,6 +632,15 @@ module Ronin
               end
             end
 
+            unless self.class.examples.empty?
+              opts.separator ''
+              opts.separator 'Examples:'
+
+              self.class.examples.each do |example|
+                opts.separator "  #{example}"
+              end
+            end
+
             if self.class.summary
               opts.separator ''
               opts.separator self.class.summary

data/lib/ronin/ui/cli/commands/console.rb

@@ -68,13 +68,12 @@ module Ronin
                            :description => 'Print the Ronin version'
 
           #
-          # Starts the Ronin Console.
+          # Sets up the Ronin Console.
           #
-          def execute
-            if version?
-              puts "ronin #{Ronin::VERSION}"
-              return
-            end
+          # @since 1.5.0
+          #
+          def setup
+            super
 
             UI::Console.color = color?
             UI::Console.short_errors = !backtrace?
@@ -86,6 +85,16 @@ module Ronin
             if database?
               Database.repositories[:default] = @database
             end
+          end
+
+          #
+          # Starts the Ronin Console.
+          #
+          def execute
+            if version?
+              puts "ronin #{Ronin::VERSION}"
+              return
+            end
 
             UI::Console.start
           end

data/lib/ronin/ui/cli/commands/creds.rb

@@ -69,7 +69,7 @@ module Ronin
           option :list, :type        => true,
                         :default     => true,
                         :flag        => '-l',
-                        :description => 'List all Credentials'
+                        :description => 'List the Credentials'
 
           #
           # Queries the {Credential} model.

data/lib/ronin/ui/cli/commands/database.rb

@@ -56,44 +56,56 @@ module Ronin
 
           summary 'Manages the Ronin Database'
 
-          option :add, :type  => Symbol,
-                       :flag  => '-a',
-                       :usage => 'NAME'
-
-          option :set, :type  => Symbol,
-                       :flag  => '-s',
-                       :usage => 'NAME'
-
-          option :remove, :type  => Symbol,
-                          :flag  => '-r',
-                          :usage => 'NAME'
-
-          option :clear, :type  => Symbol,
-                         :flag  => '-C',
-                         :usage => 'NAME'
+          option :add, :type        => Symbol,
+                       :flag        => '-a',
+                       :usage       => 'NAME',
+                       :description => 'Adds a Database Repository'
+
+          option :set, :type        => Symbol,
+                       :flag        => '-s',
+                       :usage       => 'NAME',
+                       :description => 'Sets the information for a Database Repository'
+
+          option :remove, :type        => Symbol,
+                          :flag        => '-r',
+                          :usage       => 'NAME',
+                          :description => 'Removes a Database Repository'
+
+          option :clear, :type        => Symbol,
+                         :flag        => '-C',
+                         :usage       => 'NAME',
+                         :description => 'WARNING: Clears a Database Repository'
           
           # repository options
-          option :uri, :type  => String,
-                       :usage => 'sqlite3:///path'
+          option :uri, :type        => String,
+                       :usage       => 'sqlite3:///path',
+                       :description => 'The URI for the Database Repository'
 
-          option :adapter, :type  => String,
-                           :usage => 'DB'
+          option :adapter, :type        => String,
+                           :usage       => 'sqlite3|mysql|postgres',
+                           :description => 'The Database Adapter'
 
-          option :host, :type  => String,
-                        :usage => 'HOST'
+          option :host, :type        => String,
+                        :usage       => 'HOST',
+                        :description => 'The host running the Database'
 
-          option :port, :type  => Integer,
-                        :usage => 'PORT'
+          option :port, :type        => Integer,
+                        :usage       => 'PORT',
+                        :description => 'The port the Database is listening on'
 
-          option :user, :type => String
+          option :user, :type        => String,
+                        :description => 'User to authenticate with'
 
-          option :password, :type => String
+          option :password, :type        => String,
+                            :description => 'Password to authenticate with'
 
-          option :database, :type  => String,
-                            :usage => 'NAME'
+          option :database, :type        => String,
+                            :usage       => 'NAME',
+                            :description => 'Database name'
 
-          option :path, :type  => String,
-                        :usage => 'PATH'
+          option :path, :type        => String,
+                        :usage       => 'PATH',
+                        :description => 'Path to the Database file.'
 
           #
           # Displays or modifies the Ronin Database configuration.

data/lib/ronin/ui/cli/commands/emails.rb

@@ -54,25 +54,30 @@ module Ronin
 
           summary 'Manages EmailAddresses'
 
-          query_option :with_hosts, :type  => Array,
-                                    :flag  => '-H',
-                                    :usage => 'HOST [...]'
+          query_option :with_hosts, :type        => Array,
+                                    :flag        => '-H',
+                                    :usage       => 'HOST [...]',
+                                    :description => 'Searches for the associated HOST(s)'
 
-          query_option :with_ips, :type  => Array,
-                                  :flag  => '-I',
-                                  :usage => 'IP [...]'
+          query_option :with_ips, :type        => Array,
+                                  :flag        => '-I',
+                                  :usage       => 'IP [...]',
+                                  :description => 'Searches for the associated IP(s)'
 
-          query_option :with_users, :type  => Array,
-                                    :flag  => '-u',
-                                    :usage => 'NAME [...]'
+          query_option :with_users, :type        => Array,
+                                    :flag        => '-u',
+                                    :usage       => 'NAME [...]',
+                                    :description => 'Searches for the associated UserName(s)'
 
-          option :list, :type    => true,
-                        :default => true,
-                        :flag    => '-l'
+          option :list, :type        => true,
+                        :default     => true,
+                        :flag        => '-l',
+                        :description => 'Lists the EmailAddresses'
 
-          option :import, :type  => String,
-                          :flag  => '-i',
-                          :usage => 'FILE'
+          option :import, :type        => String,
+                          :flag        => '-i',
+                          :usage       => 'FILE',
+                          :description => 'Imports EmailAddresses from the FILE'
 
         end
       end