Doc cleanup

Author: jhart-r7

lib/rex/proto/kademlia/bootstrap_response.rb

@@ -11,12 +11,21 @@ module Kademlia
 
   # A Kademlia bootstrap response message
   class BootstrapResponse < Message
+    # @return [String] the ID of the peer that send the bootstrap response
     attr_reader :peer_id
+    # @return [Integer] the TCP port that the responding peer is listening on
     attr_reader :tcp_port
+    # @return [Integer] the version of this peer
     attr_reader :version
-    # An array of hashes containing the peer ID, IP address, UDP and TCP ports as well as the type/version
+    # @return [Array<Hash<String, Object>>] the peer ID, IP address, UDP/TCP ports and version of each peer
     attr_reader :peers
 
+    # Constructs a new bootstrap response
+    #
+    # @param peer_id [String] the ID of this peer
+    # @param tcp_port [Integer] the TCP port that this peer is listening on
+    # @param version [Integer] the version of this peer
+    # @param peers [Array<Hash<String, Object>>] the peer ID, IP address, UDP/TCP ports and version of each peer
     def initialize(peer_id, tcp_port, version, peers)
       @peer_id = peer_id
       @tcp_port = tcp_port

lib/rex/proto/kademlia/message.rb

@@ -17,21 +17,31 @@ module Proto
 #
 ##
 module Kademlia
+  # A simple Kademlia message
   class Message
     # The header that non-compressed Kad messages use
     STANDARD_PACKET = 0xE4
     # The header that compressed Kad messages use, which is currently unsupported
     COMPRESSED_PACKET = 0xE5
 
-    attr_accessor :type, :body
+    # @return [Integer] the message type
+    attr_reader :type
+    # @return [String] the message body
+    attr_reader :body
 
+    # Construct a new Message from the provided type and body
+    #
     # @param type [String] the message type
     # @param body [String] the message body
     def initialize(type, body = '')
       @type = type
       @body = body
     end
 
+    # Construct a new Message from the provided data
+    #
+    # @param data [String] the data to interpret as a Kademlia message
+    # @return [Message] the message if valid, nil otherwise
     def self.from_data(data)
       return if data.length < 2
       header, type = data.unpack('CC')

lib/rex/proto/kademlia/pong.rb

@@ -10,14 +10,18 @@ module Kademlia
 
   # A Kademlia pong message.
   class Pong < Message
-    # the source port from which the PING was received
+    # @return [Integer] the source port from which the PING was received
     attr_reader :port
 
     def initialize(port = nil)
       super(PONG)
       @port = port
     end
 
+    # Builds a pong from given data
+    #
+    # @param data [String] the data to decode
+    # @return [Pong] the pong if the data is valid, nil otherwise
     def self.from_data(data)
       message = super(data)
       return if message.type != PONG

spec/lib/rex/proto/kademlia/bootstrap_response_spec.rb

@@ -18,13 +18,13 @@
       expect(peer[:ip]).to eq('149.91.116.59')
       expect(peer[:tcp_port]).to eq(4882)
       expect(peer[:udp_port]).to eq(4992)
-      expect(peer[:type]).to eq(8)
+      expect(peer[:version]).to eq(8)
       peer = response.peers.last
       expect(peer[:id]).to eq('9B896000AEBE0B0A0ECB35457177A107')
       expect(peer[:ip]).to eq('83.46.192.208')
       expect(peer[:tcp_port]).to eq(3662)
       expect(peer[:udp_port]).to eq(3672)
-      expect(peer[:type]).to eq(8)
+      expect(peer[:version]).to eq(8)
     end
 
     it 'does not decode overly small bootstrap responses' do