ronin-support 0.4.0 → 0.4.1

data/lib/ronin/network/mixins/dns.rb

@@ -43,7 +43,7 @@ module Ronin
         #
         # The DNS Resolver to use.
         #
-        # @see DNS#dns_resolver
+        # @see Network::DNS#dns_resolver
         #
         def dns_resolver(nameserver=self.nameserver)
           super(nameserver)

data/lib/ronin/network/mixins/esmtp.rb

@@ -93,6 +93,8 @@ module Ronin
         # @return [Net::SMTP]
         #   The ESMTP enabled session.
         #
+        # @see Network::ESMTP#esmtp_connect
+        #
         # @api public
         #
         def esmtp_connect(options={},&block)
@@ -117,7 +119,7 @@ module Ronin
         # @yieldparam [Net::SMTP] session
         #   The ESMTP session.
         #
-        # @see esmtp_connect
+        # @see Network::ESMTP#esmtp_session
         #
         # @api public
         #

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

@@ -113,6 +113,8 @@ module Ronin
         # @return [Net::HTTP]
         #   The HTTP session object.
         #
+        # @see Network::HTTP#http_session
+        #
         # @api public
         #
         def http_session(options={},&block)
@@ -156,7 +158,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_session
+        # @see Network::HTTP#http_request
         #
         # @api public
         #
@@ -179,7 +181,7 @@ module Ronin
         # @return [Integer]
         #   The HTTP Response Status.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_status
         #
         # @since 1.1.0
         #
@@ -207,7 +209,7 @@ module Ronin
         # @return [Boolean]
         #   Specifies whether the response had an HTTP OK status code or not.
         #
-        # @see #http_status
+        # @see Network::HTTP#http_ok?
         #
         # @since 1.1.0
         #
@@ -235,7 +237,7 @@ module Ronin
         # @return [String]
         #   The HTTP `Server` header.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_server
         #
         # @since 1.1.0
         #
@@ -263,7 +265,7 @@ module Ronin
         # @return [String]
         #   The HTTP `X-Powered-By` header.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_powered_by
         #
         # @since 1.1.0
         #
@@ -292,7 +294,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_copy
         #
         # @api public
         #
@@ -316,7 +318,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_delete
         #
         # @api public
         #
@@ -340,7 +342,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_get
         #
         # @api public
         #
@@ -364,7 +366,7 @@ module Ronin
         # @return [String]
         #   The body of the HTTP Get request.
         #
-        # @see #http_get
+        # @see Network::HTTP#http_get_body
         #
         # @api public
         #
@@ -388,7 +390,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_head
         #
         # @api public
         #
@@ -412,7 +414,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_lock
         #
         # @api public
         #
@@ -436,7 +438,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_mkcol
         #
         # @api public
         #
@@ -460,7 +462,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_move
         #
         # @api public
         #
@@ -484,7 +486,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_options
         #
         # @api public
         #
@@ -514,7 +516,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_post
         #
         # @api public
         #
@@ -538,7 +540,7 @@ module Ronin
         # @return [String]
         #   The body of the Post request.
         #
-        # @see #http_post
+        # @see Network::HTTP#http_post_body
         #
         # @api public
         #
@@ -571,7 +573,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_put
         #
         # @since 0.4.0
         #
@@ -597,7 +599,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_prop_find
         #
         # @api public
         #
@@ -621,7 +623,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_prop_patch
         #
         # @api public
         #
@@ -645,7 +647,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_trace
         #
         # @api public
         #
@@ -669,7 +671,7 @@ module Ronin
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see #http_request
+        # @see Network::HTTP#http_unlock
         #
         # @api public
         #

data/lib/ronin/network/mixins/imap.rb

@@ -88,6 +88,8 @@ module Ronin
         #   Indicates wether or not to use SSL when connecting to the
         #   server.
         #
+        # @see Network::IMAP#imap_connect
+        #
         # @api public
         #
         def imap_connect(options={},&block)
@@ -109,7 +111,7 @@ module Ronin
         # @yieldparam [Net::IMAP] session
         #   The newly created IMAP session object.
         #
-        # @see imap_connect
+        # @see Network::IMAP#imap_session
         #
         # @api public
         #

data/lib/ronin/network/mixins/pop3.rb

@@ -83,6 +83,8 @@ module Ronin
         # @return [Net::POP3]
         #   The newly created POP3 session.
         #
+        # @see Network::POP3#pop3_connect
+        #
         # @api public
         #
         def pop3_connect(options={},&block)
@@ -104,7 +106,7 @@ module Ronin
         # @yieldparam [Net::POP3] session
         #   The newly created POP3 session.
         #
-        # @see pop3_connect
+        # @see Network::POP3#pop3_session
         #
         # @api public
         #

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

@@ -92,6 +92,8 @@ module Ronin
         # @return [Net::SMTP]
         #   The SMTP session.
         #
+        # @see Network::SMTP#smtp_connect
+        #
         # @api public
         #
         def smtp_connect(options={},&block)
@@ -112,7 +114,7 @@ module Ronin
         # @yieldparam [Net::SMTP] session
         #   The SMTP session.
         #
-        # @see smtp_connect
+        # @see Network::SMTP#smtp_session
         #
         # @api public
         #

data/lib/ronin/network/mixins/ssl.rb

@@ -86,6 +86,8 @@ module Ronin
         # @example
         #   socket = ssl_connect
         #
+        # @see Network::SSL#ssl_connect
+        #
         # @api public
         #
         def ssl_connect(host,port,options={},&block)
@@ -128,11 +130,13 @@ module Ronin
         #
         # @example
         #   ssl_session do |socket|
-        #     socket.write("GET /\n\n")
+        #     socket.write("GET / HTTP/1.1\n\r\n\r")
         #
         #     socket.each_line { |line| puts line }
         #   end
         #
+        # @see Network::SSL#ssl_session
+        #
         # @api public
         #
         def ssl_session(options={},&block)

data/lib/ronin/network/mixins/tcp.rb

@@ -84,12 +84,14 @@ module Ronin
         #
         # @example
         #   tcp_connect do |socket|
-        #     socket.write("GET /\n\n")
+        #     socket.write("GET / HTTP/1.1\n\r\n\r")
         #
         #     puts socket.readlines
         #     socket.close
         #   end
         #
+        # @see Network::TCP#tcp_connect
+        #
         # @api public
         #
         def tcp_connect(&block)
@@ -114,6 +116,8 @@ module Ronin
         # @return [TCPSocket]
         #   The newly created TCPSocket object.
         #
+        # @see Network::TCP#tcp_connect_and_send
+        #
         # @api public
         #
         def tcp_connect_and_send(data,&block)
@@ -136,6 +140,8 @@ module Ronin
         #
         # @return [nil]
         #
+        # @see Network::TCP#tcp_session
+        #
         # @api public
         #
         def tcp_session(&block)
@@ -164,6 +170,8 @@ module Ronin
         #   tcp_banner
         #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
         #
+        # @see Network::TCP#tcp_banner
+        #
         # @api public
         #
         def tcp_banner(&block)
@@ -184,6 +192,8 @@ module Ronin
         #   Net.tcp_send(buffer)
         #   # => true
         #
+        # @see Network::TCP#tcp_send
+        #
         # @api public
         #
         def tcp_send(data)
@@ -212,6 +222,8 @@ module Ronin
         # @example
         #   tcp_server
         #
+        # @see Network::TCP#tcp_server
+        #
         # @api public
         #
         def tcp_server(&block)
@@ -244,6 +256,8 @@ module Ronin
         #     client2.close
         #   end
         #
+        # @see Network::TCP#tcp_server_session
+        #
         # @api public
         #
         def tcp_server_session(&block)
@@ -277,6 +291,8 @@ module Ronin
         #     client.puts 'lol'
         #   end
         #
+        # @see Network::TCP#tcp_server_single_server
+        #
         # @api public
         #
         def tcp_single_server(&block)

data/lib/ronin/network/mixins/telnet.rb

@@ -132,6 +132,8 @@ module Ronin
         #   telnet_connect
         #   # => Net::Telnet
         #
+        # @see Network::Telnet#telnet_connect
+        #
         # @api public
         #
         def telnet_connect(options={},&block)
@@ -159,7 +161,7 @@ module Ronin
         #     movie.each_line { |line| puts line }
         #   end
         #
-        # @see telnet_connect
+        # @see Network::Telnet#telnet_session
         #
         # @api public
         #

data/lib/ronin/network/mixins/udp.rb

@@ -88,6 +88,8 @@ module Ronin
         #     puts socket.readlines
         #   end
         #
+        # @see Network::UDP#udp_connect
+        #
         # @api public
         #
         def udp_connect(&block)
@@ -114,6 +116,8 @@ module Ronin
         # @return [UDPSocket]
         #   The newly created UDPSocket object.
         #
+        # @see Network::UDP#udp_connect_and_send
+        #
         # @api public
         #
         def udp_connect_and_send(data,&block)
@@ -138,6 +142,8 @@ module Ronin
         #
         # @return [nil]
         #
+        # @see Network::UDP#udp_session
+        #
         # @api public
         #
         def udp_session(&block)
@@ -161,6 +167,8 @@ module Ronin
         #   Net.udp_send(buffer)
         #   # => true
         #
+        # @see Network::UDP#udp_send
+        #
         # @api public
         #
         # @since 0.4.0
@@ -191,6 +199,8 @@ module Ronin
         # @example
         #   udp_server
         #
+        # @see Network::UDP#udp_server
+        #
         # @api public
         #
         def udp_server(&block)
@@ -217,6 +227,8 @@ module Ronin
         #     data, sender = server.recvfrom(1024)
         #   end
         #
+        # @see Network::UDP#udp_server_session
+        #
         # @api public
         #
         def udp_server_session(&block)

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

@@ -169,7 +169,7 @@ module Ronin
       #     # ...
       #   end
       #
-      # @see smtp_connect
+      # @see #smtp_connect
       #
       # @api public
       #
@@ -197,7 +197,7 @@ module Ronin
       # @yieldparam [SMTP::Email] email
       #   The new email to be sent.
       #
-      # @see smtp_session
+      # @see #smtp_session
       #
       # @example
       #   smtp_send_message 'www.example.com', :to => 'joe@example.com',