ronin-support 0.1.0 → 0.2.0.rc1

data/ChangeLog.md

@@ -1,3 +1,27 @@
+### 0.2.0 / 2011-05-14
+
+* Require data_paths ~> 0.3.
+* Added {Ronin::Mixin}.
+* Added {Ronin::Network::SMTP::Email#headers}.
+* Added {Integer#html_escape}.
+* Added {Integer#js_escape}.
+* Added {Integer#format_js}.
+* Added {String#html_escape}.
+* Added {String#html_unescape}.
+* Added {String#js_escape}.
+* Added {String#js_unescape}.
+* Added {String#format_js}.
+* Added {Net.smtp_send_message}.
+* Added {Net.http_status}.
+* Added YARD `@api` tags to define the public, semi-public and private APIs.
+* Allow `:method` to be used with {Net.http_ok?}.
+* Fixed a bug in {Ronin::Network::HTTP.expand_url} where `:host` and `:port`
+  options were being overridden.
+* Fixed a bug in {String#format_chars}, where it was not using `each_char`
+  for unicode characters.
+* Deprecated {String#common_postfix}, in favor of {String#common_suffix}.
+  {String#common_postfix} will be removed in ronin-support 1.0.0.
+
 ### 0.1.0 / 2011-03-20
 
 * Initial release:

data/Gemfile

@@ -18,5 +18,13 @@ end
 group :test do
   gem 'i18n',           '~> 0.4'
   gem 'tzinfo',         '~> 0.3.0'
-  gem 'activesupport',  '~> 3.0.0'
+
+  INFLECTORS = {
+    'activesupport' => '~> 3.0.0',
+    'dm-core' => '~> 1.0',
+    'extlib' => '~> 0.9.15'
+  }
+
+  inflector = ENV.fetch('INFLECTOR','dm-core')
+  gem(inflector,INFLECTORS[inflector])
 end

data/README.md

@@ -22,6 +22,7 @@ or payloads over many common Source-Code-Management (SCM) systems.
     * Binary
     * Text
     * HTTP
+    * HTML
     * URIs
   * Generating random text.
   * Networking:
@@ -41,23 +42,25 @@ or payloads over many common Source-Code-Management (SCM) systems.
 ## Examples
 
 For examples of the convenience methods provided by ronin-support,
-please see [Everyday Ronin](http://ronin-ruby.github.com/resources/everyday_ronin.html).
+please see [Everyday Ronin](http://ronin-ruby.github.com/guides/everyday_ronin.html).
 
 ## Requirements
 
 * [Ruby](http://www.ruby-lang.org/) >= 1.8.7
 * [chars](http://github.com/postmodern/chars#readme)
   ~> 0.2
+* [hexdump](http://github.com/postmodern/hexdump#readme)
+  ~> 0.1
 * [combinatorics](http://github.com/postmodern/combinatorics#readme)
   ~> 0.3
 * [uri-query_params](http://github.com/postmodern/uri-query_params#readme)
   ~> 0.5, >= 0.5.2
 * [data_paths](http://github.com/postmodern/data_paths#readme)
-  ~> 0.2, >= 0.2.1
+  ~> 0.3
 
 ## Install
 
-    $ sudo gem install ronin-support
+    $ gem install ronin-support
 
 ## License
 

data/gemspec.yml

@@ -14,9 +14,11 @@ required_ruby_version: ">= 1.8.7"
 
 dependencies:
   chars: ~> 0.2
+  hexdump: ~> 0.1
   combinatorics: ~> 0.3
   uri-query_params: ~> 0.5, >= 0.5.2
-  data_paths: ~> 0.2, >= 0.2.1
+  # data_paths: ~> 0.3
+  data_paths: 0.3.0.rc1
 
 development_dependencies:
   bundler: ~> 1.0.10

data/lib/ronin/extensions.rb

@@ -23,4 +23,5 @@ require 'ronin/extensions/file'
 require 'ronin/extensions/ip_addr'
 require 'ronin/extensions/kernel'
 
-require 'uri/query_params'
+require 'hexdump/extensions'
+require 'uri/query_params/extensions'

data/lib/ronin/extensions/file.rb

@@ -30,6 +30,8 @@ class File
   #
   # @return [nil]
   #
+  # @api public
+  #
   def File.write(path,data)
     File.open(path,'w') { |file| file.write(data) }
   end
@@ -43,6 +45,8 @@ class File
   # @return [String]
   #   The escaped path.
   #
+  # @api public
+  #
   def File.escape_path(path)
     path = path.to_s
 

data/lib/ronin/extensions/ip_addr.rb

@@ -53,6 +53,8 @@ class IPAddr
   # @return [Array<String>]
   #   The IP Addresses found in the text.
   #
+  # @api public
+  #
   def IPAddr.extract(text,version=nil,&block)
     regexp = case version
              when :ipv4
@@ -108,6 +110,8 @@ class IPAddr
   #     puts ip
   #   end
   #
+  # @api public
+  #
   def IPAddr.each(cidr_or_glob,&block)
     unless (cidr_or_glob.include?('*') || cidr_or_glob.include?('-'))
       return IPAddr.new(cidr_or_glob).each(&block)
@@ -168,6 +172,8 @@ class IPAddr
   # @return [Array<String>]
   #   The host-names for the IP address.
   #
+  # @api public
+  #
   def lookup
     Resolv.getnames(self.to_s)
   end
@@ -190,6 +196,8 @@ class IPAddr
   #     puts ip
   #   end
   #
+  # @api public
+  #
   def each
     return enum_for(:each) unless block_given?
 

data/lib/ronin/extensions/kernel.rb

@@ -33,6 +33,8 @@ module Kernel
   #     Resolv.getaddress('might.not.exist.com')
   #   end
   #
+  # @api public
+  #
   def attempt
     begin
       yield() if block_given?

data/lib/ronin/extensions/string.rb

@@ -39,6 +39,8 @@ class String
   # @return [String]
   #   The original string
   #
+  # @api public
+  #
   def each_substring(min=0,&block)
     return enum_for(:each_substring,min) unless block
 
@@ -79,6 +81,8 @@ class String
   #
   # @see each_substring
   #
+  # @api public
+  #
   def each_unique_substring(min=0,&block)
     return enum_for(:each_unique_substring,min) unless block
 
@@ -100,9 +104,15 @@ class String
   end
 
   #
-  # Returns the common prefix of the string and the specified other
-  # string. If no common prefix can be found an empty string will be
-  # returned.
+  # The common prefix of the string and the specified other string.
+  #
+  # @param [String] other
+  #   The other String to compare against.
+  #
+  # @return [String]
+  #   The common prefix between the two Strings.
+  #
+  # @api public
   #
   def common_prefix(other)
     min_length = [length, other.length].min
@@ -117,11 +127,19 @@ class String
   end
 
   #
-  # Returns the common postfix of the string and the specified other
-  # string. If no common postfix can be found an empty string will be
-  # returned.
+  # Finds the common suffix of the string and the specified other string.
   #
-  def common_postfix(other)
+  # @param [String] pther
+  #   The other String to compare against.
+  #
+  # @return [String]
+  #   The common suffix of the two Strings.
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def common_suffix(other)
     min_length = [length, other.length].min
 
     (min_length - 1).times do |i|
@@ -137,13 +155,32 @@ class String
   end
 
   #
-  # Returns the uncommon substring within the specified other string,
-  # which does not occur within the string. If no uncommon substring can be
-  # found, an empty string will be returned.
+  # @deprecated
+  #   Deprecates as of 0.2.0, and will be removed in 1.0.0.
+  #   Please use {#common_suffix} instead.
+  #
+  def common_postfix(other)
+    STDERR.puts "DEPRECATED: String#common_postfix was deprecated in 0.2.0."
+    STDERR.puts "DEPRECATED: Please use String#common_suffix instead."
+
+    common_suffix(other)
+  end
+
+  #
+  # Finds the uncommon substring within the specified other string,
+  # which does not occur within the string.
+  #
+  # @param [String] other
+  #   The other String to compare against.
+  #
+  # @return [String]
+  #   The uncommon substring between the two Strings.
+  #
+  # @api public
   #
   def uncommon_substring(other)
     prefix = common_prefix(other)
-    postfix = self[prefix.length..-1].common_postfix(other[prefix.length..-1])
+    postfix = self[prefix.length..-1].common_suffix(other[prefix.length..-1])
 
     return self[prefix.length...(length - postfix.length)]
   end
@@ -158,6 +195,8 @@ class String
   #   "hello\x00\073\x90\r\n".dump
   #   # => "hello\0;\x90\r\n"
   #
+  # @api public
+  #
   def dump
     c_string = ''
 

data/lib/ronin/formatting/extensions/binary.rb

@@ -20,3 +20,5 @@
 require 'ronin/formatting/extensions/binary/integer'
 require 'ronin/formatting/extensions/binary/string'
 require 'ronin/formatting/extensions/binary/file'
+
+require 'hexdump/extensions'

data/lib/ronin/formatting/extensions/binary/file.rb

@@ -22,10 +22,21 @@ require 'ronin/formatting/extensions/binary/string'
 class File
 
   #
-  # Converts the hexdump at the given path back into raw-data.
+  # Converts a hexdump file to it's original binary data.
+  #
+  # @param [Pathname, String] path
+  #   The path of the hexdump file.
+  #
+  # @param [Hash] options
+  #   Hexdump options.
+  #
+  # @return [String]
+  #   The original binary data.
   #
   # @see String#unhexdump.
   #
+  # @api public
+  #
   def File.unhexdump(path,options={})
     File.read(path).unhexdump(options)
   end

data/lib/ronin/formatting/extensions/binary/integer.rb

@@ -44,6 +44,8 @@ class Integer
   #   0xff41.bytes(4, :big)
   #   # => [0, 0, 255, 65]
   #
+  # @api public
+  #
   def bytes(address_length,endian=:little)
     endian = endian.to_sym
     buffer = []
@@ -107,6 +109,8 @@ class Integer
   #
   # @see http://ruby-doc.org/core/classes/Array.html#M002222
   #
+  # @api public
+  #
   def pack(arch,address_length=nil)
     if arch.kind_of?(String)
       return [self].pack(arch)
@@ -136,6 +140,8 @@ class Integer
   #   42.hex_escape
   #   # => "\\x2a"
   #
+  # @api public
+  #
   def hex_escape
     "\\x%.2x" % self
   end

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

@@ -69,6 +69,8 @@ class String
   #
   # @see http://ruby-doc.org/core/classes/String.html#M000760
   #
+  # @api public
+  #
   def depack(arch,address_length=nil)
     if arch.kind_of?(String)
       return self.unpack(arch)
@@ -118,10 +120,14 @@ class String
   #
   # @see String#format_bytes
   #
+  # @api public
+  #
   def hex_escape(options={})
     format_bytes(options) { |b| b.hex_escape }
   end
 
+  #
+  # Unescapes the hex-escaped String.
   #
   # @return [String]
   #   The unescaped version of the hex escaped String.
@@ -130,6 +136,8 @@ class String
   #   "\\x68\\x65\\x6c\\x6c\\x6f".hex_unescape
   #   # => "hello"
   #
+  # @api public
+  #
   def hex_unescape
     buffer = ''
     hex_index = 0
@@ -196,6 +204,8 @@ class String
   #   "hello again".xor([0x55, 0x41, 0xe1])
   #   # => "=$\x8d9.\xc14&\x80</"
   #
+  # @api public
+  #
   def xor(key)
     key = if key.kind_of?(Integer)
             [key]
@@ -219,6 +229,8 @@ class String
   # @return [String]
   #   The base64 encoded form of the string.
   #
+  # @api public
+  #
   def base64_encode
     Base64.encode64(self)
   end
@@ -229,6 +241,8 @@ class String
   # @return [String]
   #   The base64 decoded form of the string.
   #
+  # @api public
+  #
   def base64_decode
     Base64.decode64(self)
   end
@@ -239,6 +253,8 @@ class String
   # @return [String]
   #   The Zlib inflated form of the string.
   #
+  # @api public
+  #
   def zlib_inflate
     Zlib::Inflate.inflate(self)
   end
@@ -249,6 +265,8 @@ class String
   # @return [String]
   #   The Zlib deflated form of the string.
   #
+  # @api public
+  #
   def zlib_deflate
     Zlib::Deflate.deflate(self)
   end
@@ -288,6 +306,8 @@ class String
   #
   # @return [String] The raw-data from the hexdump.
   #
+  # @api public
+  #
   def unhexdump(options={})
     case (format = options[:format])
     when :od

data/lib/ronin/formatting/extensions/digest/file.rb

@@ -36,6 +36,8 @@ class File
   #   File.md5('data.txt')
   #   # => "5d41402abc4b2a76b9719d911017c592"
   #
+  # @api public
+  #
   def File.md5(path)
     Digest::MD5.file(path).hexdigest
   end
@@ -53,6 +55,8 @@ class File
   #   File.sha1('data.txt')
   #   # => "aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d"
   #
+  # @api public
+  #
   def File.sha1(path)
     Digest::SHA1.file(path).hexdigest
   end
@@ -60,6 +64,8 @@ class File
   #
   # @see File.sha1
   #
+  # @api public
+  #
   def File.sha128(path)
     File.sha1(path)
   end
@@ -77,6 +83,8 @@ class File
   #   File.sha256('data.txt')
   #   # => "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
   #
+  # @api public
+  #
   def File.sha256(path)
     Digest::SHA256.file(path).hexdigest
   end
@@ -84,6 +92,8 @@ class File
   #
   # @see File.sha256
   #
+  # @api public
+  #
   def File.sha2(path)
     File.sha256(path)
   end
@@ -101,6 +111,8 @@ class File
   #   File.sha512('data.txt')
   #   # => "9b71d224bd62f3785d96d46ad3ea3d73319bfbc2890caadae2dff72519673ca72323c3d99ba5c11d7c7acc6e14b8c5da0c4663475c2e5c3adef46f73bcdec043"
   #
+  # @api public
+  #
   def File.sha512(path)
     Digest::SHA512.file(path).hexdigest
   end
@@ -108,6 +120,8 @@ class File
   #
   # @see File.sha512
   #
+  # @api public
+  #
   def File.sha5(path)
     File.sha512(path)
   end