paho-mqtt 1.0.7 → 1.0.9

data/lib/paho_mqtt/exception.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2016-2018 Pierre Goudet <p-goudet@ruby-dev.jp>
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+#    https://eclipse.org/org/documents/epl-v10.php.
+# and the Eclipse Distribution License is available at
+#   https://eclipse.org/org/documents/edl-v10.php.
+#
+# Contributors:
+#    Pierre Goudet - initial committer
+
+
+module PahoMqtt
+  class Exception < ::StandardError
+    def initialize(msg="")
+      super
+    end
+  end
+  
+  class ProtocolViolation < Exception
+  end
+  
+  class WritingException < Exception
+  end
+  
+  class ReadingException < Exception
+  end
+
+  class PacketException < Exception
+  end
+
+  class PacketFormatException < Exception
+  end
+
+  class ProtocolVersionException < Exception
+  end
+
+  class LowVersionException < Exception
+  end
+end

data/lib/paho_mqtt/handler.rb

@@ -21,9 +21,9 @@ module PahoMqtt
 
     def initialize
       @registered_callback = []
-      @last_ping_resp = -1
-      @publisher = nil
-      @subscriber = nil
+      @last_ping_resp      = -1
+      @publisher           = nil
+      @subscriber          = nil
     end
 
     def config_pubsub(publisher, subscriber)
@@ -52,7 +52,7 @@ module PahoMqtt
     end
 
     def handle_packet(packet)
-      PahoMqtt.logger.info("New packet #{packet.class} recieved.") if PahoMqtt.logger?
+      PahoMqtt.logger.info("New packet #{packet.class} received.") if PahoMqtt.logger?
       type = packet_type(packet)
       self.send("handle_#{type}", packet)
     end
@@ -76,16 +76,17 @@ module PahoMqtt
         PahoMqtt.logger.error("The topics where the callback is trying to be unregistered have been found nil.") if PahoMqtt.logger?
         raise ArgumentError
       end
-      @registered_callback.delete_if {|pair| pair.first == topic}
+      @registered_callback.delete_if { |pair| pair.first == topic }
       MQTT_ERR_SUCCESS
     end
 
     def handle_connack(packet)
       if packet.return_code == 0x00
-        PahoMqtt.logger.debug("Connack receive and connection accepted.") if PahoMqtt.logger?
+        PahoMqtt.logger.debug(packet.return_msg) if PahoMqtt.logger?
         handle_connack_accepted(packet.session_present)
       else
-        handle_connack_error(packet.return_code)
+        PahoMqtt.logger.warm(packet.return_msg) if PahoMqtt.logger?
+        MQTT_CS_DISCONNECTED
       end
       @on_connack.call(packet) unless @on_connack.nil?
       MQTT_CS_CONNECTED
@@ -99,7 +100,7 @@ module PahoMqtt
 
     def new_session?(session_flag)
       if !@clean_session && !session_flag
-        PahoMqtt.logger.debug("New session created for the client") if PahoMqtt.logger?
+        PahoMqtt.logger.debug("New session created for the client.") if PahoMqtt.logger?
       end
     end
 
@@ -121,9 +122,9 @@ module PahoMqtt
 
     def handle_suback(packet)
       max_qos = packet.return_codes
-      id = packet.id
-      topics = []
-      topics = @subscriber.add_subscription(max_qos, id, topics)
+      id      = packet.id
+      topics  = []
+      topics  = @subscriber.add_subscription(max_qos, id, topics)
       unless topics.empty?
         @on_suback.call(topics) unless @on_suback.nil?
       end
@@ -139,12 +140,12 @@ module PahoMqtt
     end
 
     def handle_publish(packet)
-      id = packet.id
-      qos = packet.qos
-      if @publisher.do_publish(qos, id) == MQTT_ERR_SUCCESS
-        @on_message.call(packet) unless @on_message.nil?
-        check_callback(packet)
-      end
+        id = packet.id
+        qos = packet.qos
+        if @publisher.do_publish(qos, id) == MQTT_ERR_SUCCESS
+          @on_message.call(packet) unless @on_message.nil?
+          check_callback(packet)
+        end
     end
 
     def handle_puback(packet)
@@ -175,18 +176,6 @@ module PahoMqtt
       end
     end
 
-    def handle_connack_error(return_code)
-      if return_code == 0x01
-        raise LowVersionException
-      elsif CONNACK_ERROR_MESSAGE.has_key(return_code.to_sym)
-        PahoMqtt.logger.warm(CONNACK_ERRO_MESSAGE[return_code])
-        MQTT_CS_DISCONNECTED
-      else
-        PahoMqtt.logger("Unknown return code for CONNACK packet: #{return_code}")
-        raise PacketException
-      end
-    end
-
     def on_connack(&block)
       @on_connack = block if block_given?
       @on_connack
@@ -264,9 +253,8 @@ module PahoMqtt
       if PahoMqtt::PACKET_TYPES[3..13].include?(type)
         type.to_s.split('::').last.downcase
       else
-        puts "Packet: #{packet.inspect}"
-        PahoMqtt.logger.error("Received an unexpeceted packet: #{packet}") if PahoMqtt.logger?
-         raise PacketException
+        PahoMqtt.logger.error("Received an unexpeceted packet: #{packet}.") if PahoMqtt.logger?
+         raise PacketException.new('Invalid packet type id')
       end
     end
 
@@ -277,7 +265,7 @@ module PahoMqtt
       end
       unless callbacks.empty?
         callbacks.each do |callback|
-            callback.call(packet)
+          callback.call(packet)
         end
       end
     end

data/lib/paho_mqtt/packet/base.rb

@@ -36,8 +36,8 @@ module PahoMqtt
 
       # Default attribute values
       ATTR_DEFAULTS = {
-        :version => '3.1.0',
-        :id => 0,
+        :version     => '3.1.0',
+        :id          => 0,
         :body_length => nil
       }
 
@@ -47,6 +47,7 @@ module PahoMqtt
         packet = create_from_header(
           read_byte(socket)
         )
+
         unless packet.nil?
           packet.validate_flags
 
@@ -59,22 +60,22 @@ module PahoMqtt
             body_length += ((digit & 0x7F) * multiplier)
             multiplier *= 0x80
             pos += 1
-          end while ((digit & 0x80) != 0x00) and pos <= 4
+          end while ((digit & 0x80) != 0x00) && pos <= 4
 
           # Store the expected body length in the packet
           packet.instance_variable_set('@body_length', body_length)
 
           # Read in the packet body
-          packet.parse_body( socket.read(body_length) )
+          packet.parse_body(socket.read(body_length))
         end
-        return packet
+        packet
       end
 
       # Parse buffer into new packet object
       def self.parse(buffer)
         packet = parse_header(buffer)
         packet.parse_body(buffer)
-        return packet
+        packet
       end
 
       # Parse the header and create a new packet object of the correct type
@@ -82,7 +83,8 @@ module PahoMqtt
       def self.parse_header(buffer)
         # Check that the packet is a long as the minimum packet size
         if buffer.bytesize < 2
-          raise "Invalid packet: less than 2 bytes long"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid packet: less than 2 bytes long")
         end
 
         # Create a new packet object
@@ -96,13 +98,14 @@ module PahoMqtt
         pos = 1
         begin
           if buffer.bytesize <= pos
-            raise "The packet length header is incomplete"
+            raise PahoMqtt::PacketFormatException.new(
+                    "The packet length header is incomplete")
           end
           digit = bytes[pos]
           body_length += ((digit & 0x7F) * multiplier)
           multiplier *= 0x80
           pos += 1
-        end while ((digit & 0x80) != 0x00) and pos <= 4
+        end while ((digit & 0x80) != 0x00) && pos <= 4
 
         # Store the expected body length in the packet
         packet.instance_variable_set('@body_length', body_length)
@@ -110,7 +113,7 @@ module PahoMqtt
         # Delete the fixed header from the raw packet passed in
         buffer.slice!(0...pos)
 
-        return packet
+        packet
       end
 
       # Create a new packet object from the first byte of a MQTT packet
@@ -120,7 +123,8 @@ module PahoMqtt
           type_id = ((byte & 0xF0) >> 4)
           packet_class = PahoMqtt::PACKET_TYPES[type_id]
           if packet_class.nil?
-            raise "Invalid packet type identifier: #{type_id}"
+            raise PahoMqtt::PacketFormatException.new(
+                    "Invalid packet type identifier: #{type_id}")
           end
 
           # Convert the last 4 bits of byte into array of true/false
@@ -141,7 +145,7 @@ module PahoMqtt
       # Set packet attributes from a hash of attribute names and values
       def update_attributes(attr={})
         attr.each_pair do |k,v|
-          if v.is_a?(Array) or v.is_a?(Hash)
+          if v.is_a?(Array) || v.is_a?(Hash)
             send("#{k}=", v.dup)
           else
             send("#{k}=", v)
@@ -153,9 +157,10 @@ module PahoMqtt
       def type_id
         index = PahoMqtt::PACKET_TYPES.index(self.class)
         if index.nil?
-          raise "Invalid packet type: #{self.class}"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid packet type: #{self.class}")
         end
-        return index
+        index
       end
 
       # Get the name of the packet type as a string in capitals
@@ -179,7 +184,8 @@ module PahoMqtt
       # Parse the body (variable header and payload) of a packet
       def parse_body(buffer)
         if buffer.bytesize != body_length
-          raise "Failed to parse packet - input buffer (#{buffer.bytesize}) is not the same as the body length header (#{body_length})"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Failed to parse packet - input buffer (#{buffer.bytesize}) is not the same as the body length header (#{body_length})")
         end
       end
 
@@ -205,7 +211,8 @@ module PahoMqtt
         # Check that that packet isn't too big
         body_length = body.bytesize
         if body_length > 268435455
-          raise "Error serialising packet: body is more than 256MB"
+          raise PahoMqtt::PacketFormatException.new(
+          "Error serialising packet: body is more than 256MB")
         end
 
         # Build up the body length field bytes
@@ -225,7 +232,8 @@ module PahoMqtt
       # @private
       def validate_flags
         if flags != [false, false, false, false]
-          raise "Invalid flags in #{type_name} packet header"
+          raise PahoMqtt::PacketFormatException.new(
+          "Invalid flags in #{type_name} packet header")
         end
       end
 
@@ -243,7 +251,7 @@ module PahoMqtt
 
       # Encode an array of bits and return them
       def encode_bits(bits)
-        [bits.map{|b| b ? '1' : '0'}.join].pack('b*')
+        [bits.map { |b| b ? '1' : '0' }.join].pack('b*')
       end
 
       # Encode a 16-bit unsigned integer and return it
@@ -274,7 +282,7 @@ module PahoMqtt
 
       # Remove 8 bits from the front of buffer
       def shift_bits(buffer)
-        buffer.slice!(0...1).unpack('b8').first.split('').map {|b| b == '1'}
+        buffer.slice!(0...1).unpack('b8').first.split('').map { |b| b == '1' }
       end
 
       # Remove n bytes from the front of buffer

data/lib/paho_mqtt/packet/connack.rb

@@ -27,7 +27,7 @@ module PahoMqtt
       attr_accessor :return_code
 
       # Default attribute values
-      ATTR_DEFAULTS = {:return_code => 0x00}
+      ATTR_DEFAULTS = { :return_code => 0x00 }
 
       # Create a new Client Connect packet
       def initialize(args={})
@@ -54,9 +54,9 @@ module PahoMqtt
       def return_msg
         case return_code
         when 0x00
-          "Connection Accepted"
+          "Connection accepted"
         when 0x01
-          "Connection refused: unacceptable protocol version"
+          raise LowVersionException
         when 0x02
           "Connection refused: client identifier rejected"
         when 0x03
@@ -75,19 +75,21 @@ module PahoMqtt
         body = ''
         body += encode_bits(@connack_flags)
         body += encode_bytes(@return_code.to_i)
-        return body
+        body
       end
 
       # Parse the body (variable header and payload) of a Connect Acknowledgment packet
       def parse_body(buffer)
         super(buffer)
         @connack_flags = shift_bits(buffer)
-        unless @connack_flags[1,7] == [false, false, false, false, false, false, false]
-          raise "Invalid flags in Connack variable header"
+        unless @connack_flags[1, 7] == [false, false, false, false, false, false, false]
+          raise PacketFormatException.new(
+                  "Invalid flags in Connack variable header")
         end
         @return_code = shift_byte(buffer)
         unless buffer.empty?
-          raise "Extra bytes at end of Connect Acknowledgment packet"
+          raise PacketFormatException.new(
+                  "Extra bytes at end of Connect Acknowledgment packet")
         end
       end
 

data/lib/paho_mqtt/packet/connect.rb

@@ -55,29 +55,30 @@ module PahoMqtt
 
       # Default attribute values
       ATTR_DEFAULTS = {
-        :client_id => nil,
+        :client_id     => nil,
         :clean_session => true,
-        :keep_alive => 15,
-        :will_topic => nil,
-        :will_qos => 0,
-        :will_retain => false,
-        :will_payload => '',
-        :username => nil,
-        :password => nil,
+        :keep_alive    => 15,
+        :will_topic    => nil,
+        :will_qos      => 0,
+        :will_retain   => false,
+        :will_payload  => '',
+        :username      => nil,
+        :password      => nil,
       }
 
       # Create a new Client Connect packet
       def initialize(args={})
         super(ATTR_DEFAULTS.merge(args))
 
-        if version == '3.1.0' or version == '3.1'
+        if version == '3.1.0' || version == '3.1'
           self.protocol_name ||= 'MQIsdp'
           self.protocol_level ||= 0x03
         elsif version == '3.1.1'
           self.protocol_name ||= 'MQTT'
           self.protocol_level ||= 0x04
         else
-          raise ArgumentError.new("Unsupported protocol version: #{version}")
+          raise PahoMqtt::PacketFormatException.new(
+                  "Unsupported protocol version: #{version}")
         end
       end
 
@@ -88,7 +89,8 @@ module PahoMqtt
         body += encode_string(@protocol_name)
         body += encode_bytes(@protocol_level.to_i)
         if @keep_alive < 0
-          raise "Invalid keep-alive value: cannot be less than 0"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Invalid keep-alive value: cannot be less than 0")
         end
 
         body += encode_flags(@connect_flags)
@@ -106,10 +108,12 @@ module PahoMqtt
 
       def check_version
         if @version == '3.1.0'
-          if @client_id.nil? or @client_id.bytesize < 1
-            raise "Client identifier too short while serialising packet"
+          if @client_id.nil? || @client_id.bytesize < 1
+            raise PahoMqtt::PacketFormatException.new(
+                    "Client identifier too short while serialising packet")
           elsif @client_id.bytesize > 23
-            raise "Client identifier too long when serialising packet"
+            raise PahoMqtt::PacketFormatException.new(
+                    "Client identifier too long when serialising packet")
           end
         end
       end
@@ -131,12 +135,13 @@ module PahoMqtt
         super(buffer)
         @protocol_name = shift_string(buffer)
         @protocol_level = shift_byte(buffer).to_i
-        if @protocol_name == 'MQIsdp' and @protocol_level == 3
+        if @protocol_name == 'MQIsdp' && @protocol_level == 3
           @version = '3.1.0'
-        elsif @protocol_name == 'MQTT' and @protocol_level == 4
+        elsif @protocol_name == 'MQTT' && @protocol_level == 4
           @version = '3.1.1'
         else
-          raise "Unsupported protocol: #{@protocol_name}/#{@protocol_level}"
+          raise PahoMqtt::PacketFormatException.new(
+                  "Unsupported protocol: #{@protocol_name}/#{@protocol_level}")
         end
 
         @connect_flags = shift_byte(buffer)
@@ -155,10 +160,10 @@ module PahoMqtt
           # The MQTT v3.1 specification says that the payload is a UTF-8 string
           @will_payload = shift_string(buffer)
         end
-        if ((@connect_flags & 0x80) >> 7) == 0x01 and buffer.bytesize > 0
+        if ((@connect_flags & 0x80) >> 7) == 0x01 && buffer.bytesize > 0
           @username = shift_string(buffer)
         end
-        if ((@connect_flags & 0x40) >> 6) == 0x01 and buffer.bytesize > 0
+        if ((@connect_flags & 0x40) >> 6) == 0x01 && buffer.bytesize > 0
           @password = shift_string(buffer)
         end
       end