ronin-support 0.1.0 → 0.2.0.rc1

data/lib/ronin/formatting/extensions/text/array.rb

@@ -34,6 +34,8 @@ class Array
   #   ['A', 'BB', 0x90].bytes
   #   # => [0x41, 0x42, 0x42, 0x90]
   #
+  # @api public
+  #
   def bytes
     self.inject([]) do |accum,elem|
       if elem.kind_of?(Integer)
@@ -57,6 +59,8 @@ class Array
   #   [0x41, 0x41, 0x20].chars
   #   # => ["A", "A", " "]
   #
+  # @api public
+  #
   def chars
     array_bytes = self.bytes
 
@@ -72,6 +76,8 @@ class Array
   #   [0x41, 0x41, 0x20].char_string
   #   # => "AA "
   #
+  # @api public
+  #
   def char_string
     chars.join
   end
@@ -91,6 +97,8 @@ class Array
   #   ['A', 'BB', 0x90].bytes
   #   # => ['\x41', '\x42', '\x42', '\x90']
   #
+  # @api public
+  #
   def hex_chars
     array_bytes = self.bytes
     
@@ -113,6 +121,8 @@ class Array
   #   ['A', 'BB', 0x90].bytes
   #   # => ['0x41', '0x42', '0x42', '0x90']
   #
+  # @api public
+  #
   def hex_integers
     array_bytes = self.bytes
     

data/lib/ronin/formatting/extensions/text/string.rb

@@ -17,7 +17,7 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'chars'
+require 'set'
 
 class String
 
@@ -27,10 +27,10 @@ class String
   # @param [Hash] options
   #   Additional options.
   #
-  # @option options [Array, Range] :include (0x00..0xff)
+  # @option options [#include?] :include (0x00..0xff)
   #   The bytes to format.
   #
-  # @option options [Array, Range] :exclude
+  # @option options [#include?] :exclude
   #   The bytes not to format.
   #
   # @yield [byte]
@@ -43,17 +43,16 @@ class String
   # @return [String]
   #   The formatted version of the String.
   #
+  # @api public
+  #
   def format_bytes(options={})
-    included = (options[:include] || (0x00..0xff))
-    excluded = (options[:exclude] || [])
+    included = options.fetch(:include,(0x00..0xff))
+    excluded = options.fetch(:exclude,Set[])
 
     formatted = ''
 
     self.each_byte do |b|
-      c = b.chr
-
-      if ((included.include?(b) || included.include?(c)) \
-          && !(excluded.include?(b) || excluded.include?(c)))
+      if (included.include?(b) && !excluded.include?(b))
         formatted << yield(b)
       else
         formatted << b
@@ -69,10 +68,10 @@ class String
   # @param [Hash] options
   #   Additional options.
   #
-  # @option options [Array, Range] :include (0x00..0xff)
+  # @option options [#include?, Regexp] :include (/./m)
   #   The bytes to format.
   #
-  # @option options [Array, Range] :exclude
+  # @option options [#include?, Regexp] :exclude
   #   The bytes not to format.
   #
   # @yield [char]
@@ -85,8 +84,33 @@ class String
   # @return [String]
   #   The formatted version of the String.
   #
+  # @api public
+  #
   def format_chars(options={})
-    format_bytes(options) { |b| yield b.chr }
+    included = options.fetch(:include,/./m)
+    excluded = options.fetch(:exclude,Set[])
+
+    formatted = ''
+
+    matches = lambda { |filter,c|
+      if filter.respond_to?(:include?)
+        filter.include?(c)
+      elsif filter.kind_of?(Regexp)
+        c =~ filter
+      else
+        false
+      end
+    }
+
+    self.each_char do |c|
+      if (matches[included,c] && !matches[excluded,c])
+        formatted << yield(c)
+      else
+        formatted << c
+      end
+    end
+
+    return formatted
   end
 
   #
@@ -109,6 +133,8 @@ class String
   #   "get out your checkbook".random_case
   #   # => "gEt Out YOur CHEckbook"
   #
+  # @api public
+  #
   def random_case(options={})
     prob = (options[:probability] || 0.5)
 
@@ -133,6 +159,8 @@ class String
   # @return [String]
   #   The new modified String.
   #
+  # @api public
+  #
   def insert_before(pattern,data)
     string = self.dup
     index = string.index(pattern)
@@ -153,6 +181,8 @@ class String
   # @return [String]
   #   The new modified String.
   #
+  # @api public
+  #
   def insert_after(pattern,data)
     string = self.dup
     match = string.match(pattern)
@@ -183,6 +213,8 @@ class String
   #   "hello".pad('A',50)
   #   # => "helloAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
   #
+  # @api public
+  #
   def pad(padding,max_length=self.length)
     padding = padding.to_s
 

data/lib/ronin/formatting/html.rb

@@ -0,0 +1,20 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# Ronin Support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin Support 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/formatting/extensions/html'

data/lib/ronin/mixin.rb

@@ -0,0 +1,89 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  #
+  # A base Module for all other Mixin modules. Adds a `mixin` method
+  # which includes/extends other Modules and evaluates a block of
+  # code, within any Classes/Objects it is included/extended into.
+  #
+  #     module MyMixin
+  #       include Mixin
+  #
+  #       mixin Paremters
+  #
+  #       mixin do
+  #         parameter :user, :default => 'admin'
+  #       end
+  #     end
+  #
+  # @since 0.2.0
+  #
+  module Mixin
+    #
+    # Defines the `mixin` method when included.
+    #
+    # @since 0.2.0
+    #
+    def self.included(base)
+      base.module_eval do
+        protected
+
+        #
+        # Mixins in the modules or code block into other modules that the
+        # module might be included or extended into.
+        #
+        # @param [Array<Module>] modules
+        #   Other modules to mixin.
+        #
+        # @yield []
+        #   The given code block will be evaluated into the modules
+        #   the module is included or extended into.
+        #
+        # @since 0.2.0
+        #
+        # @api semipublic
+        #
+        def self.mixin(*modules,&block)
+          unless modules.empty?
+            @mixin_modules = modules
+          end
+
+          @mixin_block = block if block
+
+          def self.included(base)
+            if @mixin_modules
+              base.send(:include,*@mixin_modules)
+            end
+
+            base.module_eval(&@mixin_block) if @mixin_block
+          end
+
+          def self.extended(base)
+            if @mixin_modules
+              base.send(:extend,*@mixin_modules)
+            end
+
+            base.instance_eval(&@mixin_block) if @mixin_block
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/network/extensions/esmtp/net.rb

@@ -23,6 +23,8 @@ module Net
   #
   # @see Ronin::Network::SMTP.message
   #
+  # @api public
+  #
   def Net.esmtp_message(options={},&block)
     Net.smtp_message(options,&block)
   end
@@ -62,6 +64,8 @@ module Net
   # @return [Net::SMTP]
   #   The ESMTP enabled session.
   #
+  # @api public
+  #
   def Net.esmtp_connect(host,options={})
     session = Net.smtp_connect(host,options)
     session.esmtp = true
@@ -88,6 +92,8 @@ module Net
   #
   # @see Net.esmtp_connect
   #
+  # @api public
+  #
   def Net.esmtp_session(host,options={})
     Net.smtp_session(host,options) do |session|
       session.esmtp = true

data/lib/ronin/network/extensions/http/net.rb

@@ -69,6 +69,8 @@ module Net
   # @return [Net::HTTP]
   #   The HTTP session object.
   #
+  # @api public
+  #
   def Net.http_connect(options={},&block)
     options = Ronin::Network::HTTP.expand_options(options)
 
@@ -145,6 +147,8 @@ module Net
   #
   # @see Net.http_connect
   #
+  # @api public
+  #
   def Net.http_session(options={},&block)
     Net.http_connect(options) do |sess,expanded_options|
       if block
@@ -193,6 +197,8 @@ module Net
   #
   # @see http_session
   #
+  # @api public
+  #
   def Net.http_request(options={},&block)
     resp = nil
 
@@ -213,6 +219,94 @@ module Net
     return resp
   end
 
+  #
+  # Returns the Status Code of the Response.
+  #
+  # @param [Hash] options
+  #   Additional options.
+  #
+  # @option options [Symbol, String] :method (:head)
+  #   The method to use for the request.
+  #
+  # @return [Integer]
+  #   The HTTP Response Status.
+  #
+  # @see http_request
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def Net.http_status(options={})
+    options = {:method => :head}.merge(options)
+
+    return Net.http_request(options).code.to_i
+  end
+
+  #
+  # Checks if the response has an HTTP OK status code.
+  #
+  # @param [Hash] options
+  #   Additional options.
+  #
+  # @option options [Symbol, String] :method (:head)
+  #   The method to use for the request.
+  #
+  # @return [Boolean]
+  #   Specifies wether the response had an HTTP OK status code or not.
+  #
+  # @see http_status
+  #
+  # @api public
+  #
+  def Net.http_ok?(options={})
+    Net.http_status(options) == 200
+  end
+
+  #
+  # Sends a HTTP Head request and returns the HTTP Server header.
+  #
+  # @param [Hash] options
+  #   Additional options.
+  #
+  # @option options [Symbol, String] :method (:head)
+  #   The method to use for the request.
+  #
+  # @return [String]
+  #   The HTTP `Server` header.
+  #
+  # @see http_request
+  #
+  # @api public
+  #
+  def Net.http_server(options={})
+    options = {:method => :head}.merge(options)
+
+    return Net.http_request(options)['server']
+  end
+
+  #
+  # Sends an HTTP Head request and returns the HTTP X-Powered-By header.
+  #
+  # @param [Hash] options
+  #   Additional options.
+  #
+  # @option options [Symbol, String] :method (:get)
+  #   The method to use for the request.
+  #
+  # @return [String]
+  #   The HTTP `X-Powered-By` header.
+  #
+  # @see http_request
+  #
+  # @api public
+  #
+  def Net.http_powered_by(options={})
+    options = {:method => :get}.merge(options)
+    
+    return Net.http_request(options)['x-powered-by']
+  end
+
   #
   # Performs an HTTP Copy request.
   #
@@ -231,6 +325,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_copy(options={})
     resp = Net.http_request(options.merge(:method => :copy))
 
@@ -256,6 +352,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_delete(options={},&block)
     original_headers = options[:headers]
 
@@ -290,6 +388,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_get(options={},&block)
     resp = Net.http_request(options.merge(:method => :get))
 
@@ -315,6 +415,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_get_body(options={},&block)
     Net.http_get(options,&block).body
   end
@@ -337,6 +439,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_head(options={},&block)
     resp = Net.http_request(options.merge(:method => :head))
 
@@ -344,57 +448,6 @@ module Net
     return resp
   end
 
-  #
-  # Checks if the response has an HTTP OK status code.
-  #
-  # @param [Hash] options
-  #   Additional options.
-  #
-  # @return [Boolean]
-  #   Specifies wether the response had an HTTP OK status code or not.
-  #
-  # @see http_request
-  #
-  def Net.http_ok?(options={})
-    Net.http_head(options).code == 200
-  end
-
-  #
-  # Sends a HTTP Head request and returns the HTTP Server header.
-  #
-  # @param [Hash] options
-  #   Additional options.
-  #
-  # @return [String]
-  #   The HTTP `Server` header.
-  #
-  # @see http_request
-  #
-  def Net.http_server(options={})
-    Net.http_head(options)['server']
-  end
-
-  #
-  # Sends an HTTP Head request and returns the HTTP X-Powered-By header.
-  #
-  # @param [Hash] options
-  #   Additional options.
-  #
-  # @return [String]
-  #   The HTTP `X-Powered-By` header.
-  #
-  # @see http_request
-  #
-  def Net.http_powered_by(options={})
-    resp = Net.http_head(options)
-
-    if resp.code != 200
-      resp = Net.http_get(options)
-    end
-
-    return resp['x-powered-by']
-  end
-
   #
   # Performs an HTTP Lock request.
   #
@@ -413,6 +466,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_lock(options={},&block)
     resp = Net.http_request(options.merge(:method => :lock))
 
@@ -438,6 +493,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_mkcol(options={},&block)
     resp = Net.http_request(options.merge(:method => :mkcol))
 
@@ -463,6 +520,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_move(options={},&block)
     resp = Net.http_request(options.merge(:method => :move))
 
@@ -488,6 +547,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_options(options={},&block)
     resp = Net.http_request(options.merge(:method => :options))
 
@@ -516,6 +577,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_post(options={},&block)
     resp = Net.http_request(options.merge(:method => :post))
 
@@ -544,6 +607,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_post_body(options={},&block)
     Net.http_post(options,&block).body
   end
@@ -566,6 +631,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_prop_find(options={},&block)
     original_headers = options[:headers]
 
@@ -600,6 +667,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_prop_patch(options={},&block)
     resp = Net.http_request(options.merge(:method => :proppatch))
 
@@ -625,6 +694,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_trace(options={},&block)
     resp = Net.http_request(options.merge(:method => :trace))
 
@@ -650,6 +721,8 @@ module Net
   #
   # @see http_request
   #
+  # @api public
+  #
   def Net.http_unlock(options={},&block)
     resp = Net.http_request(options.merge(:method => :unlock))