ronin-support 0.1.0 → 0.2.0.rc1

data/lib/ronin/network/http/proxy.rb

@@ -48,6 +48,8 @@ module Ronin
         # @option options [String] :password
         #   The password to authenticate with.
         #
+        # @api public
+        #
         def initialize(options={})
           super(
             options[:host],
@@ -75,6 +77,8 @@ module Ronin
         # @example
         #   Proxy.parse('http://201.26.192.61:8080')
         #
+        # @api public
+        #
         def self.parse(proxy)
           proxy = proxy.to_s.gsub(/^http(s)?:\/*/,'')
 
@@ -110,6 +114,8 @@ module Ronin
         #   The given proxy information was not a {Proxy}, `URI::HTTP`,
         #   `Hash` or {String}.
         #
+        # @api public
+        #
         def self.create(proxy)
           case proxy
           when Proxy
@@ -138,6 +144,8 @@ module Ronin
         # @return [Boolean]
         #   Specifies if the proxy can proxy requests.
         #
+        # @api public
+        #
         def valid?
           begin
             Net.http_get_body(
@@ -156,6 +164,8 @@ module Ronin
         #   The extra number of seconds it takes the proxy to process the
         #   request, compared to sending the request directly.
         #
+        # @api public
+        #
         def latency
           time = lambda { |proxy|
             t1 = Time.now
@@ -183,6 +193,8 @@ module Ronin
         # @return [String]
         #   The IP address the proxy uses for our requests.
         #
+        # @api public
+        #
         def proxied_ip
           IPAddr.extract(Net.http_get_body(
             :url => Network::IP_URL,
@@ -196,6 +208,8 @@ module Ronin
         # @return [Boolean]
         #   Specifies whether the proxy will forward our IP address.
         #
+        # @api public
+        #
         def transparent?
           Network.ip == proxied_ip
         end
@@ -206,6 +220,8 @@ module Ronin
         # @return [Boolean]
         #   Specifies whether the proxy will hide our IP address.
         #
+        # @api public
+        #
         def anonymous?
           !(transparent?)
         end
@@ -213,6 +229,8 @@ module Ronin
         #
         # Disables the Proxy object.
         #
+        # @api public
+        #
         def disable!
           self.host = nil
           self.port = nil
@@ -229,6 +247,8 @@ module Ronin
         #   Specifies whether the proxy object is usable by
         #   Net::HTTP::Proxy.
         #
+        # @api public
+        #
         def enabled?
           !(self.host.nil?)
         end
@@ -240,6 +260,8 @@ module Ronin
         #   The HTTP URI representing the proxy. If the proxy is disabled,
         #   then `nil` will be returned.
         #
+        # @api public
+        #
         def url
           return nil unless enabled?
 
@@ -264,6 +286,8 @@ module Ronin
         # @return [String]
         #   The host-name of the proxy.
         #
+        # @api public
+        #
         def to_s
           self.host.to_s
         end
@@ -274,6 +298,8 @@ module Ronin
         # @return [String]
         #   The inspection of the proxy object.
         #
+        # @api public
+        #
         def inspect
           unless self.host
             str = 'disabled'

data/lib/ronin/network/imap.rb

@@ -32,6 +32,8 @@ module Ronin
       # @return [Integer]
       #   The default Ronin IMAP port.
       #
+      # @api public
+      #
       def IMAP.default_port
         @default_port ||= DEFAULT_PORT
       end
@@ -42,6 +44,8 @@ module Ronin
       # @param [Integer] port
       #   The new default Ronin IMAP port.
       #
+      # @api public
+      #
       def IMAP.default_port=(port)
         @default_port = port
       end

data/lib/ronin/network/network.rb

@@ -35,6 +35,8 @@ module Ronin
     # @return [String]
     #   The external IP Address according to {http://checkip.dyndns.org}.
     #
+    # @api public
+    #
     def Network.ip
       IPAddr.extract(Net::HTTP.get(IP_URL)).first
     end

data/lib/ronin/network/pop3.rb

@@ -32,6 +32,8 @@ module Ronin
       # @return [Integer]
       #   The default Ronin POP3 port.
       #
+      # @api public
+      #
       def POP3.default_port
         @default_port ||= DEFAULT_PORT
       end
@@ -42,6 +44,8 @@ module Ronin
       # @param [Integer] port
       #   The new default Ronin POP3 port.
       #
+      # @api public
+      #
       def POP3.default_port=(port)
         @default_port = port
       end

data/lib/ronin/network/smtp/email.rb

@@ -25,6 +25,8 @@ module Ronin
       #
       class Email
 
+        CRLF = "\n\r"
+
         # Sender of the email
         attr_accessor :from
 
@@ -40,6 +42,9 @@ module Ronin
         # Unique message-id string
         attr_accessor :message_id
 
+        # Additional headers
+        attr_reader :headers
+
         # Body of the email
         attr_accessor :body
 
@@ -52,7 +57,7 @@ module Ronin
         # @option options [String] :from
         #   The address the email is from.
         #
-        # @option options [String] :to
+        # @option options [Array, String] :to
         #   The address that the email should be sent to.
         #
         # @option options [String] :subject
@@ -64,6 +69,9 @@ module Ronin
         # @option options [String, Time] :date (Time.now)
         #   The date the email was sent on.
         #
+        # @option options [Hash<String => String}] :headers
+        #   Additional headers.
+        #
         # @option options [String, Array<String>] :body
         #   The body of the email.
         #
@@ -74,18 +82,29 @@ module Ronin
         # @yieldparam [Email] email
         #   The newly created email object.
         #
+        # @api public
+        #
         def initialize(options={})
           @from = options[:from]
           @to = options[:to]
           @subject = options[:subject]
-          @date = options[:date] || Time.now
+          @date = options.fetch(:date,Time.now)
           @message_id = options[:message_id]
+          @headers = {}
+
+          if options[:headers]
+            @headers.merge!(options[:headers])
+          end
+
           @body = []
 
-          if options[:body].kind_of?(Array)
-            @body += options[:body]
-          else
-            @body << options[:body]
+          if options[:body]
+            case options[:body]
+            when Array
+              @body += options[:body]
+            else
+              @body << options[:body]
+            end
           end
 
           yield self if block_given?
@@ -99,25 +118,31 @@ module Ronin
         #
         # @see http://www.ruby-doc.org/stdlib/libdoc/net/smtp/rdoc/classes/Net/SMTP.html
         #
+        # @api public
+        #
         def to_s
           address = lambda { |info|
-            if info.kind_of?(Array)
-              return "#{info[0]} <#{info[1]}>"
-            elsif info.kind_of?(Hash)
-              return "#{info[:name]} <#{info[:email]}>"
+            case info
+            when Array
+              "#{info[0]} <#{info[1]}>"
             else
-              return info
+              info
             end
           }
 
           message = []
 
           if @from
-            message << "From: #{address.call(@from)}"
+            message << "From: #{@from}"
           end
 
           if @to
-            message << "To: #{address.call(@to)}"
+            message << case @to
+                       when Array
+                         "To: #{@to.join(', ')}"
+                       else
+                         "To: #{@to}"
+                       end
           end
 
           if @subject
@@ -132,10 +157,14 @@ module Ronin
             message << "Message-Id: <#{@message_id}>"
           end
 
+          @headers.each do |name,value|
+            message << "#{name}: #{value}"
+          end
+
           message << ''
           message += @body
 
-          return message.join("\n")
+          return message.join(CRLF)
         end
 
       end

data/lib/ronin/network/smtp/smtp.rb

@@ -32,6 +32,8 @@ module Ronin
       # @return [Integer]
       #   The default Ronin SMTP port.
       #
+      # @api public
+      #
       def SMTP.default_port
         @default_port ||= DEFAULT_PORT
       end
@@ -42,6 +44,8 @@ module Ronin
       # @param [Integer] port
       #   The new default Ronin SMTP port.
       #
+      # @api public
+      #
       def SMTP.default_port=(port)
         @default_port = port
       end
@@ -61,6 +65,8 @@ module Ronin
       #
       # @see Ronin::Network::SMTP::Email
       #
+      # @api public
+      #
       def SMTP.message(options={},&block)
         Email.new(options,&block).to_s
       end

data/lib/ronin/network/ssl.rb

@@ -34,6 +34,8 @@ module Ronin
       # @return [Integer]
       #   The verify mode number used by OpenSSL.
       #
+      # @api private
+      #
       def SSL.verify(mode=nil)
         verify_mode = 'VERIFY_' + (mode || :none).to_s.upcase
 

data/lib/ronin/network/telnet.rb

@@ -38,6 +38,8 @@ module Ronin
       # @return [Integer]
       #   The default Ronin Telnet port.
       #
+      # @api public
+      #
       def Telnet.default_port
         @default_port ||= DEFAULT_PORT
       end
@@ -48,6 +50,8 @@ module Ronin
       # @param [Integer] port
       #   The new default Ronin Telnet port.
       #
+      # @api public
+      #
       def Telnet.default_port=(port)
         @default_port = port
       end
@@ -56,6 +60,8 @@ module Ronin
       # @return [Regexp]
       #   The default Ronin Telnet prompt pattern.
       #
+      # @api public
+      #
       def Telnet.default_prompt
         @default_prompt ||= DEFAULT_PROMPT
       end
@@ -66,6 +72,8 @@ module Ronin
       # @param [Regexp] prompt
       #   The new default Ronin Telnet prompt pattern.
       #
+      # @api public
+      #
       def Telnet.default_prompt=(prompt)
         @default_prompt = prompt
       end
@@ -74,6 +82,8 @@ module Ronin
       # @return [Integer]
       #   The default Ronin Telnet timeout.
       #
+      # @api public
+      #
       def Telnet.default_timeout
         @default_timeout ||= DEFAULT_TIMEOUT
       end
@@ -84,6 +94,8 @@ module Ronin
       # @param [Integer] timeout
       #   The new default Ronin Telnet timeout.
       #
+      # @api public
+      #
       def Telnet.default_timeout=(timeout)
         @default_timeout = timeout
       end
@@ -92,6 +104,8 @@ module Ronin
       # @return [Telnet, IO, nil]
       #   The Ronin Telnet proxy.
       #
+      # @api public
+      #
       def Telnet.proxy
         @proxy ||= nil
       end
@@ -102,6 +116,8 @@ module Ronin
       # @param [Telnet, IO, nil] new_proxy
       #   The new Ronin Telnet proxy.
       #
+      # @api public
+      #
       def Telnet.proxy=(new_proxy)
         @proxy = new_proxy
       end

data/lib/ronin/path.rb

@@ -41,6 +41,8 @@ module Ronin
     # @return [Path]
     #   The root path.
     #
+    # @api public
+    #
     def Path.root
       Path.new('/')
     end
@@ -69,6 +71,8 @@ module Ronin
     #   # => [#<Ronin::Path:..>, #<Ronin::Path:../..>,
     #   #<Ronin::Path:../../..>]
     #
+    # @api public
+    #
     def self.up(n,separator=File::SEPARATOR)
       case n
       when Integer
@@ -105,6 +109,8 @@ module Ronin
     #   Path.up(7).join('etc/passwd')
     #   # => #<Ronin::Path:../../../../../../../etc/passwd>
     #
+    # @api public
+    #
     def join(*names)
       names.map! { |name| name.to_s }
 

data/lib/ronin/support/inflector.rb

@@ -22,7 +22,7 @@ module Ronin
     # The Inflectors supported by ronin-support
     INFLECTORS = {
       :datamapper => {
-        :path => 'dm-core/support/inflector',
+        :path => 'dm-core',
         :const => 'DataMapper::Inflector'
       },
       :active_support => {
@@ -55,6 +55,8 @@ module Ronin
     # @raise [NameError]
     #   The constant could not be found.
     #
+    # @api private
+    #
     def Support.load_inflector!(name)
       name = name.to_sym
 

data/lib/ronin/support/version.rb

@@ -20,6 +20,6 @@
 module Ronin
   module Support
     # ronin-support version
-    VERSION = '0.1.0'
+    VERSION = '0.2.0.rc1'
   end
 end

data/lib/ronin/templates/erb.rb

@@ -47,6 +47,8 @@ module Ronin
       #   }
       #   # => "\nUSER: lolcats\nPASSWORD: staclol\n"
       #
+      # @api public
+      #
       def erb(template)
         ERB.new(template).result(binding)
       end
@@ -63,6 +65,8 @@ module Ronin
       # @example
       #   erb_file 'path/to/template.erb'
       #
+      # @api public
+      #
       def erb_file(template_path)
         read_template(template_path) do |template|
           erb(template)