mqtt 0.1.0 → 0.2.0

data/{NEWS → NEWS.md}

@@ -1,6 +1,21 @@
 Ruby MQTT NEWS
 ==============
 
+Ruby MQTT Version 0.2.0 (2014-04-02)
+------------------------------------
+
+* Added SSL/TLS support
+* Added support for passing connection details using a URI
+* Added support for using the MQTT_BROKER environment variable
+* Allow passing array of topics to Client#unsubscribe
+* Allow more combinations of arguments to be passed to a new Client
+* No longer defaults to ‘localhost’ if there is no broker configured
+* Fixed more 'unused variable' warnings
+* Documentation improvements
+* Ruby 1.8 fixes
+* Ruby 2 fixes
+
+
 Ruby MQTT Version 0.1.0 (2013-09-07)
 ------------------------------------
 

data/{README → README.md}

@@ -1,8 +1,7 @@
 ruby-mqtt
 =========
 
-Pure Ruby gem that implements the MQTT (Message Queue Telemetry Transport) protocol,
-a lightweight protocol for publish/subscribe messaging.
+Pure Ruby gem that implements the MQTT protocol, a lightweight protocol for publish/subscribe messaging.
 
 
 Installing
@@ -46,12 +45,14 @@ Resources
 * GitHub Project: http://github.com/njh/ruby-mqtt
 * API Documentation: http://rubydoc.info/gems/mqtt/frames
 
+
 License
 -------
 
 The ruby-mqtt gem is licensed under the terms of the MIT license.
 See the file LICENSE for details.
 
+
 Contact
 -------
 

data/lib/mqtt.rb

@@ -14,15 +14,24 @@ end
 
 module MQTT
 
-  DEFAULT_HOST = 'localhost'
+  # Default port number for unencrypted connections 
   DEFAULT_PORT = 1883
+  
+  # Default port number for TLS/SSL encrypted connections 
+  DEFAULT_SSL_PORT = 8883
 
+  # Super-class for other MQTT related exceptions
   class Exception < Exception
   end
 
+  # A ProtocolException will be raised if there is a 
+  # problem with data received from a remote host
   class ProtocolException < MQTT::Exception
   end
 
+  # A NotConnectedException will be raised when trying to 
+  # perform a function but no connection has been
+  # established
   class NotConnectedException < MQTT::Exception
   end
 

data/lib/mqtt/client.rb

@@ -1,29 +1,63 @@
+autoload :OpenSSL, 'openssl'
+autoload :URI, 'uri'
+
+
 # Client class for talking to an MQTT broker
 class MQTT::Client
-  attr_reader :remote_host     # Hostname of the remote broker
-  attr_reader :remote_port     # Port number of the remote broker
-  attr_accessor :keep_alive    # Time (in seconds) between pings to remote broker
-  attr_accessor :clean_session # Set the 'Clean Session' flag when connecting?
-  attr_accessor :client_id     # Client Identifier
-  attr_accessor :ack_timeout   # Number of seconds to wait for acknowledgement packets
-  attr_accessor :username      # Username to authenticate to the broker with
-  attr_accessor :password      # Password to authenticate to the broker with
-  attr_accessor :will_topic    # The topic that the Will message is published to
-  attr_accessor :will_payload  # Contents of message that is sent by broker when client disconnect
-  attr_accessor :will_qos      # The QoS level of the will message sent by the broker
-  attr_accessor :will_retain   # If the Will message should be retain by the broker after it is sent
-
-  # OLD deprecated clean_start
-  alias :clean_start :clean_session
-  alias :clean_start= :clean_session=
+  # Hostname of the remote broker
+  attr_accessor :remote_host
+
+  # Port number of the remote broker
+  attr_accessor :remote_port
+
+  # Set to true to enable SSL/TLS encrypted communication
+  #
+  # Set to a symbol to use a specific variant of SSL/TLS.
+  # Allowed values include: 
+  # 
+  # @example Using TLS 1.0
+  #    client = Client.new('mqtt.example.com', :ssl => :TLSv1)
+  # @see OpenSSL::SSL::SSLContext::METHODS
+  attr_accessor :ssl
+
+  # Time (in seconds) between pings to remote broker
+  attr_accessor :keep_alive
+
+  # Set the 'Clean Session' flag when connecting?
+  attr_accessor :clean_session
+
+  # Client Identifier
+  attr_accessor :client_id
+
+  # Number of seconds to wait for acknowledgement packets
+  attr_accessor :ack_timeout
+
+  # Username to authenticate to the broker with
+  attr_accessor :username
+
+  # Password to authenticate to the broker with
+  attr_accessor :password
+
+  # The topic that the Will message is published to
+  attr_accessor :will_topic
+
+  # Contents of message that is sent by broker when client disconnect
+  attr_accessor :will_payload
+
+  # The QoS level of the will message sent by the broker
+  attr_accessor :will_qos
+
+  # If the Will message should be retain by the broker after it is sent
+  attr_accessor :will_retain
+
 
   # Timeout between select polls (in seconds)
   SELECT_TIMEOUT = 0.5
 
   # Default attribute values
   ATTR_DEFAULTS = {
-    :remote_host => MQTT::DEFAULT_HOST,
-    :remote_port => MQTT::DEFAULT_PORT,
+    :remote_host => nil,
+    :remote_port => nil,
     :keep_alive => 15,
     :clean_session => true,
     :client_id => nil,
@@ -33,10 +67,12 @@ class MQTT::Client
     :will_topic => nil,
     :will_payload => nil,
     :will_qos => 0,
-    :will_retain => false
+    :will_retain => false,
+    :ssl => false
   }
 
   # Create and connect a new MQTT Client
+  #
   # Accepts the same arguments as creating a new client.
   # If a block is given, then it will be executed before disconnecting again.
   #
@@ -71,28 +107,63 @@ class MQTT::Client
 
   # Create a new MQTT Client instance
   #
+  # Accepts one of the following:
+  # - a URI that uses the MQTT scheme
+  # - a hostname and port
+  # - a Hash containing attributes to be set on the new instance
+  #
+  # If no arguments are given then the method will look for a URI
+  # in the MQTT_BROKER environment variable.
+  #
   # Examples:
+  #  client = MQTT::Client.new
+  #  client = MQTT::Client.new('mqtt://myserver.example.com')
+  #  client = MQTT::Client.new('mqtt://user:pass@myserver.example.com')
   #  client = MQTT::Client.new('myserver.example.com')
   #  client = MQTT::Client.new('myserver.example.com', 18830)
   #  client = MQTT::Client.new(:remote_host => 'myserver.example.com')
   #  client = MQTT::Client.new(:remote_host => 'myserver.example.com', :keep_alive => 30)
   #
   def initialize(*args)
-    if args.count == 0
-      args = {}
-    elsif args.count == 1 and args[0].is_a?(Hash)
-      args = args[0]
-    elsif args.count == 1
-      args = {:remote_host => args[0]}
-    elsif args.count == 2
-      args = {:remote_host => args[0], :remote_port => args[1]}
+    if args.last.is_a?(Hash)
+      attr = args.pop
     else
+      attr = {}
+    end
+
+    if args.length == 0
+      if ENV['MQTT_BROKER']
+        attr.merge!(parse_uri(ENV['MQTT_BROKER']))
+      end
+    end
+
+    if args.length >= 1
+      case args[0]
+        when URI
+          attr.merge!(parse_uri(args[0]))
+        when %r|^mqtts?://|
+          attr.merge!(parse_uri(args[0]))
+        else
+          attr.merge!(:remote_host => args[0])
+      end
+    end
+
+    if args.length >= 2
+      attr.merge!(:remote_port => args[1])
+    end
+
+    if args.length >= 3
       raise ArgumentError, "Unsupported number of arguments"
     end
 
     # Merge arguments with default values for attributes
-    ATTR_DEFAULTS.merge(args).each_pair do |k,v|
-      instance_variable_set("@#{k}", v)
+    ATTR_DEFAULTS.merge(attr).each_pair do |k,v|
+      self.send("#{k}=", v)
+    end
+
+    # Set a default port number
+    if @remote_port.nil?
+      @remote_port = @ssl ? MQTT::DEFAULT_SSL_PORT : MQTT::DEFAULT_PORT
     end
 
     # Initialise private instance variables
@@ -105,6 +176,33 @@ class MQTT::Client
     @write_semaphore = Mutex.new
   end
 
+  # Get the OpenSSL context, that is used if SSL/TLS is enabled
+  def ssl_context
+    @ssl_context ||= OpenSSL::SSL::SSLContext.new
+  end
+
+  # Set a path to a file containing a PEM-format client certificate
+  def cert_file=(path)
+    ssl_context.cert = OpenSSL::X509::Certificate.new(File.open(path))
+  end
+
+  # Set a path to a file containing a PEM-format client private key
+  def key_file=(path)
+    ssl_context.key = OpenSSL::PKey::RSA.new(File.open(path))
+  end
+
+  # Set a path to a file containing a PEM-format CA certificate and enable peer verification
+  def ca_file=(path)
+    ssl_context.ca_file = path
+    unless path.nil?
+      ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+  end
+
+  # Set the Will for the client
+  #
+  # The will is a message that will be delivered by the broker when the client dies.
+  # The Will must be set before establishing a connection to the broker
   def set_will(topic, payload, retain=false, qos=0)
     self.will_topic = topic
     self.will_payload = payload
@@ -115,16 +213,38 @@ class MQTT::Client
   # Connect to the MQTT broker
   # If a block is given, then yield to that block and then disconnect again.
   def connect(clientid=nil)
-    if !clientid.nil?
+    unless clientid.nil?
       @client_id = clientid
-    elsif @client_id.nil?
-      @client_id = MQTT::Client.generate_client_id
-      @clean_session = true
+    end
+
+    if @client_id.nil? or @client_id.empty?
+      if @clean_session
+        @client_id = MQTT::Client.generate_client_id
+      else
+        raise 'Must provide a client_id if clean_session is set to false'
+      end
+    end
+
+    if @remote_host.nil?
+      raise 'No MQTT broker host set when attempting to connect'
     end
 
     if not connected?
       # Create network socket
-      @socket = TCPSocket.new(@remote_host,@remote_port)
+      tcp_socket = TCPSocket.new(@remote_host, @remote_port)
+
+      if @ssl
+        # Set the protocol version
+        if @ssl.is_a?(Symbol)
+          ssl_context.ssl_version = @ssl
+        end
+
+        @socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, ssl_context)
+        @socket.sync_close = true
+        @socket.connect
+      else
+        @socket = tcp_socket
+      end
 
       # Protocol name and version
       packet = MQTT::Packet::Connect.new(
@@ -148,7 +268,9 @@ class MQTT::Client
       # Start packet reading thread
       @read_thread = Thread.new(Thread.current) do |parent|
         Thread.current[:parent] = parent
-        loop { receive_packet }
+        while connected? do
+          receive_packet
+        end
       end
     end
 
@@ -162,6 +284,11 @@ class MQTT::Client
   # Disconnect from the MQTT broker.
   # If you don't want to say goodbye to the broker, set send_msg to false.
   def disconnect(send_msg=true)
+    # Stop reading packets from the socket first
+    @read_thread.kill if @read_thread and @read_thread.alive?
+    @read_thread = nil
+
+    # Close the socket if it is open
     if connected?
       if send_msg
         packet = MQTT::Packet::Disconnect.new
@@ -170,16 +297,17 @@ class MQTT::Client
       @socket.close unless @socket.nil?
       @socket = nil
     end
-    @read_thread.kill if @read_thread and @read_thread.alive?
-    @read_thread = nil
   end
 
   # Checks whether the client is connected to the broker.
   def connected?
-    not @socket.nil?
+    (not @socket.nil?) and (not @socket.closed?)
   end
 
   # Send a MQTT ping message to indicate that the MQTT client is alive.
+  #
+  # Note that you will not normally need to call this method
+  # as it is called automatically
   def ping
     packet = MQTT::Packet::Pingreq.new
     send_packet(packet)
@@ -288,6 +416,10 @@ class MQTT::Client
 
   # Send a unsubscribe message for one or more topics on the MQTT broker
   def unsubscribe(*topics)
+    if topics.is_a?(Enumerable) and topics.count == 1
+      topics = topics.first
+    end
+
     packet = MQTT::Packet::Unsubscribe.new(
       :topics => topics,
       :message_id => @message_id.next
@@ -302,7 +434,7 @@ private
   def receive_packet
     begin
       # Poll socket - is there data waiting?
-      result = IO.select([@socket], nil, nil, SELECT_TIMEOUT)
+      result = IO.select([@socket], [], [], SELECT_TIMEOUT)
       unless result.nil?
         # Yes - read in the packet
         packet = MQTT::Packet.read(@socket)
@@ -355,8 +487,28 @@ private
 
     # Only allow one thread to write to socket at a time
     @write_semaphore.synchronize do
-      @socket.write(data)
+      @socket.write(data.to_s)
+    end
+  end
+
+  private
+  def parse_uri(uri)
+    uri = URI.parse(uri) unless uri.is_a?(URI)
+    if uri.scheme == 'mqtt'
+      ssl = false
+    elsif uri.scheme == 'mqtts'
+      ssl = true
+    else
+      raise "Only the mqtt:// and mqtts:// schemes are supported"
     end
+
+    {
+      :remote_host => uri.host,
+      :remote_port => uri.port || nil,
+      :username => uri.user,
+      :password => uri.password,
+      :ssl => ssl
+    }
   end
 
 end

data/lib/mqtt/packet.rb

@@ -5,12 +5,20 @@ module MQTT
   # Class representing a MQTT Packet
   # Performs binary encoding and decoding of headers
   class MQTT::Packet
-    attr_reader :duplicate   # Duplicate delivery flag
-    attr_reader :retain      # Retain flag
-    attr_reader :qos         # Quality of Service level
-    attr_reader :body_length # The length of the parsed packet body
+    # Duplicate delivery flag
+    attr_reader :duplicate
 
-    DEFAULTS = {
+    # Retain flag
+    attr_reader :retain
+
+    # Quality of Service level (0, 1, 2)
+    attr_reader :qos
+
+    # The length of the parsed packet body
+    attr_reader :body_length
+
+    # Default attribute values
+    ATTR_DEFAULTS = {
       :duplicate => false,
       :qos => 0,
       :retain => false,
@@ -105,9 +113,10 @@ module MQTT
 
     # Create a new empty packet
     def initialize(args={})
-      update_attributes(DEFAULTS.merge(args))
+      update_attributes(ATTR_DEFAULTS.merge(args))
     end
 
+    # Set packet attributes from a hash of attribute names and values
     def update_attributes(attr={})
       attr.each_pair do |k,v|
         send("#{k}=", v)
@@ -201,6 +210,7 @@ module MQTT
       header.pack('C*') + body
     end
 
+    # Returns a human readable string
     def inspect
       "\#<#{self.class}>"
     end
@@ -270,11 +280,18 @@ module MQTT
 
     # Class representing an MQTT Publish message
     class Publish < MQTT::Packet
+      # The topic name to publish to
       attr_accessor :topic
+      
+      # Identifier for an individual publishing flow
+      # Only required in PUBLISH Packets where the QoS level is 1 or 2
       attr_accessor :message_id
+      
+      # The data to be published
       attr_accessor :payload
 
-      DEFAULTS = {
+      # Default attribute values
+      ATTR_DEFAULTS = {
           :topic => nil,
           :message_id => 0,
           :payload => ''
@@ -282,7 +299,7 @@ module MQTT
 
       # Create a new Publish packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
       end
 
       # Get serialisation of packet's body
@@ -305,6 +322,7 @@ module MQTT
         @payload = buffer
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
         "\#<#{self.class}: " +
         "d#{duplicate ? '1' : '0'}, " +
@@ -328,23 +346,41 @@ module MQTT
 
     # Class representing an MQTT Connect Packet
     class Connect < MQTT::Packet
+      # The name of the protocol (defaults to MQIsdp)
       attr_accessor :protocol_name
+
+      # The version number of the protocol (defaults to 3)
       attr_accessor :protocol_version
+
+      # The client identifier string
       attr_accessor :client_id
+      
+      # Set to false to keep a persistent session with the broker
       attr_accessor :clean_session
+
+      # Period the broker should keep connection open for between pings
       attr_accessor :keep_alive
+      
+      # The topic name to send the Will message to
       attr_accessor :will_topic
+      
+      # The QoS level to send the Will message as
       attr_accessor :will_qos
+      
+      # Set to true to make the Will message retained
       attr_accessor :will_retain
+      
+      # The payload of the Will message
       attr_accessor :will_payload
+      
+      # The username for authenticating with the broker
       attr_accessor :username
+      
+      # The password for authenticating with the broker
       attr_accessor :password
 
-      # OLD deprecated clean_start
-      alias :clean_start :clean_session
-      alias :clean_start= :clean_session=
-
-      DEFAULTS = {
+      # Default attribute values
+      ATTR_DEFAULTS = {
         :protocol_name => 'MQIsdp',
         :protocol_version => 0x03,
         :client_id => nil,
@@ -360,7 +396,7 @@ module MQTT
 
       # Create a new Client Connect packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
       end
 
       # Get serialisation of packet's body
@@ -436,6 +472,7 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
         str = "\#<#{self.class}: "
         str += "keep_alive=#{keep_alive}"
@@ -449,12 +486,15 @@ module MQTT
 
     # Class representing an MQTT Connect Acknowledgment Packet
     class Connack < MQTT::Packet
+      # The return code (defaults to 0 for connection accepted)
       attr_accessor :return_code
-      DEFAULTS = {:return_code => 0x00}
+
+      # Default attribute values
+      ATTR_DEFAULTS = {:return_code => 0x00}
 
       # Create a new Client Connect packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
       end
 
       # Get a string message corresponding to a return code
@@ -495,6 +535,7 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
         "\#<#{self.class}: 0x%2.2X>" % return_code
       end
@@ -502,12 +543,15 @@ module MQTT
 
     # Class representing an MQTT Publish Acknowledgment packet
     class Puback < MQTT::Packet
+      # Identifier for an individual publishing flow
       attr_accessor :message_id
-      DEFAULTS = {:message_id => 0}
+
+      # Default attribute values
+      ATTR_DEFAULTS = {:message_id => 0}
 
       # Create a new Publish Acknowledgment packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
       end
 
       # Get serialisation of packet's body
@@ -524,6 +568,7 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
         "\#<#{self.class}: 0x%2.2X>" % message_id
       end
@@ -531,12 +576,15 @@ module MQTT
 
     # Class representing an MQTT Publish Received packet
     class Pubrec < MQTT::Packet
+      # Identifier for an individual publishing flow
       attr_accessor :message_id
-      DEFAULTS = {:message_id => 0}
+
+      # Default attribute values
+      ATTR_DEFAULTS = {:message_id => 0}
 
       # Create a new Publish Recieved packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
       end
 
       # Get serialisation of packet's body
@@ -553,6 +601,7 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
         "\#<#{self.class}: 0x%2.2X>" % message_id
       end
@@ -560,12 +609,15 @@ module MQTT
 
     # Class representing an MQTT Publish Release packet
     class Pubrel < MQTT::Packet
+      # Identifier for an individual publishing flow
       attr_accessor :message_id
-      DEFAULTS = {:message_id => 0}
+
+      # Default attribute values
+      ATTR_DEFAULTS = {:message_id => 0}
 
       # Create a new Publish Release packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
       end
 
       # Get serialisation of packet's body
@@ -582,6 +634,7 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
         "\#<#{self.class}: 0x%2.2X>" % message_id
       end
@@ -589,12 +642,15 @@ module MQTT
 
     # Class representing an MQTT Publish Complete packet
     class Pubcomp < MQTT::Packet
+      # Identifier for an individual publishing flow
       attr_accessor :message_id
-      DEFAULTS = {:message_id => 0}
+
+      # Default attribute values
+      ATTR_DEFAULTS = {:message_id => 0}
 
       # Create a new Publish Complete packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
       end
 
       # Get serialisation of packet's body
@@ -611,6 +667,7 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
         "\#<#{self.class}: 0x%2.2X>" % message_id
       end
@@ -618,13 +675,18 @@ module MQTT
 
     # Class representing an MQTT Client Subscribe packet
     class Subscribe < MQTT::Packet
+      # Identifier for an individual publishing flow
       attr_accessor :message_id
+      
+      # One or more topic names to subscribe to
       attr_reader :topics
-      DEFAULTS = {:message_id => 0}
+
+      # Default attribute values
+      ATTR_DEFAULTS = {:message_id => 0}
 
       # Create a new Subscribe packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
         @topics ||= []
         @qos = 1 # Force a QOS of 1
       end
@@ -696,8 +758,9 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
-        str = "\#<#{self.class}: 0x%2.2X, %s>" % [
+        _str = "\#<#{self.class}: 0x%2.2X, %s>" % [
           message_id,
           topics.map {|t| "'#{t[0]}':#{t[1]}"}.join(', ')
         ]
@@ -706,13 +769,18 @@ module MQTT
 
     # Class representing an MQTT Subscribe Acknowledgment packet
     class Suback < MQTT::Packet
+      # Identifier to tie the Subscribe request to the Suback response
       attr_accessor :message_id
+
+      # The QoS level that was granted for the subscribe request
       attr_reader :granted_qos
-      DEFAULTS = {:message_id => 0}
+
+      # Default attribute values
+      ATTR_DEFAULTS = {:message_id => 0}
 
       # Create a new Subscribe Acknowledgment packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
         @granted_qos ||= []
       end
 
@@ -747,6 +815,7 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
         "\#<#{self.class}: 0x%2.2X, qos=%s>" % [message_id, granted_qos.join(',')]
       end
@@ -754,17 +823,23 @@ module MQTT
 
     # Class representing an MQTT Client Unsubscribe packet
     class Unsubscribe < MQTT::Packet
+      # One or more topics to unsubscribe from
       attr_reader :topics
+
+      # Identifier to tie the Unsubscribe request to the Unsuback response
       attr_accessor :message_id
-      DEFAULTS = {:message_id => 0}
+
+      # Default attribute values
+      ATTR_DEFAULTS = {:message_id => 0}
 
       # Create a new Unsubscribe packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
         @topics ||= []
         @qos = 1 # Force a QOS of 1
       end
 
+      # Set one or more topics to unsubscribe from
       def topics=(value)
         if value.is_a?(Array)
           @topics = value
@@ -792,8 +867,9 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
-        str = "\#<#{self.class}: 0x%2.2X, %s>" % [
+        "\#<#{self.class}: 0x%2.2X, %s>" % [
           message_id,
           topics.map {|t| "'#{t}'"}.join(', ')
         ]
@@ -802,12 +878,15 @@ module MQTT
 
     # Class representing an MQTT Unsubscribe Acknowledgment packet
     class Unsuback < MQTT::Packet
+      # Identifier to tie the Unsubscribe request to the Unsuback response
       attr_accessor :message_id
-      DEFAULTS = {:message_id => 0}
+
+      # Default attribute values
+      ATTR_DEFAULTS = {:message_id => 0}
 
       # Create a new Unsubscribe Acknowledgment packet
       def initialize(args={})
-        super(DEFAULTS.merge(args))
+        super(ATTR_DEFAULTS.merge(args))
       end
 
       # Get serialisation of packet's body
@@ -824,6 +903,7 @@ module MQTT
         end
       end
 
+      # Returns a human readable string, summarising the properties of the packet
       def inspect
         "\#<#{self.class}: 0x%2.2X>" % message_id
       end