paho-mqtt 0.0.2 → 1.0.0

data/lib/paho_mqtt/packet/disconnect.rb

@@ -0,0 +1,20 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Disconnect < PahoMqtt::Packet::Base
+      # Create a new Client Disconnect packet
+      def initialize(args={})
+        super(args)
+      end
+      
+      # Check the body
+      def parse_body(buffer)
+        super(buffer)
+        unless buffer.empty?
+          raise "Extra bytes at end of Disconnect packet"
+        end
+      end
+    end
+  end
+end

data/lib/paho_mqtt/packet/pingreq.rb

@@ -0,0 +1,12 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Pingreq < PahoMqtt::Packet::Base
+      # Create a new Ping Request packet
+      def initialize(args={})
+        super(args)
+      end
+    end
+  end
+end

data/lib/paho_mqtt/packet/pingresp.rb

@@ -0,0 +1,20 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Pingresp < PahoMqtt::Packet::Base
+      # Create a new Ping Response packet
+      def initialize(args={})
+        super(args)
+      end
+
+      # Check the body
+      def parse_body(buffer)
+        super(buffer)
+        unless buffer.empty?
+          raise "Extra bytes at end of Ping Response packet"
+        end
+      end
+    end
+  end
+end

data/lib/paho_mqtt/packet/puback.rb

@@ -0,0 +1,27 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Puback < PahoMqtt::Packet::Base
+      # Get serialisation of packet's body
+      def encode_body
+        encode_short(@id)
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        unless buffer.empty?
+          raise "Extra bytes at end of Publish Acknowledgment packet"
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X>" % id
+      end
+    end
+  end
+end
+

data/lib/paho_mqtt/packet/pubcomp.rb

@@ -0,0 +1,26 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Pubcomp < PahoMqtt::Packet::Base
+      # Get serialisation of packet's body
+      def encode_body
+        encode_short(@id)
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        unless buffer.empty?
+          raise "Extra bytes at end of Publish Complete packet"
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X>" % id
+      end
+    end
+  end
+end

data/lib/paho_mqtt/packet/publish.rb

@@ -0,0 +1,127 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Publish < PahoMqtt::Packet::Base
+      # Duplicate delivery flag
+      attr_accessor :duplicate
+
+      # Retain flag
+      attr_accessor :retain
+
+      # Quality of Service level (0, 1, 2)
+      attr_accessor :qos
+
+      # The topic name to publish to
+      attr_accessor :topic
+
+      # The data to be published
+      attr_accessor :payload
+
+      # Default attribute values
+      ATTR_DEFAULTS = {
+        :topic => nil,
+        :payload => ''
+      }
+
+      # Create a new Publish packet
+      def initialize(args={})
+        super(ATTR_DEFAULTS.merge(args))
+      end
+
+      def duplicate
+        @flags[3]
+      end
+
+      # Set the DUP flag (true/false)
+      def duplicate=(arg)
+        if arg.kind_of?(Integer)
+          @flags[3] = (arg == 0x1)
+        else
+          @flags[3] = arg
+        end
+      end
+
+      def retain
+        @flags[0]
+      end
+
+      # Set the retain flag (true/false)
+      def retain=(arg)
+        if arg.kind_of?(Integer)
+          @flags[0] = (arg == 0x1)
+        else
+          @flags[0] = arg
+        end
+      end
+
+      def qos
+        (@flags[1] ? 0x01 : 0x00) | (@flags[2] ? 0x02 : 0x00)
+      end
+
+      # Set the Quality of Service level (0/1/2)
+      def qos=(arg)
+        @qos = arg.to_i
+        if @qos < 0 or @qos > 2
+          raise "Invalid QoS value: #{@qos}"
+        else
+          @flags[1] = (arg & 0x01 == 0x01)
+          @flags[2] = (arg & 0x02 == 0x02)
+        end
+      end
+
+      # Get serialisation of packet's body
+      def encode_body
+        body = ''
+        if @topic.nil? or @topic.to_s.empty?
+          raise "Invalid topic name when serialising packet"
+        end
+        body += encode_string(@topic)
+        body += encode_short(@id) unless qos == 0
+        body += payload.to_s.dup.force_encoding('ASCII-8BIT')
+        return body
+      end
+
+      # Parse the body (variable header and payload) of a Publish packet
+      def parse_body(buffer)
+        super(buffer)
+        @topic = shift_string(buffer)
+        @id = shift_short(buffer) unless qos == 0
+        @payload = buffer
+      end
+
+      # Check that fixed header flags are valid for this packet type
+      # @private
+      def validate_flags
+        if qos == 3
+          raise "Invalid packet: QoS value of 3 is not allowed"
+        end
+        if qos == 0 and duplicate
+          raise "Invalid packet: DUP cannot be set for QoS 0"
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: " +
+          "d#{duplicate ? '1' : '0'}, " +
+          "q#{qos}, " +
+          "r#{retain ? '1' : '0'}, " +
+          "m#{id}, " +
+          "'#{topic}', " +
+          "#{inspect_payload}>"
+      end
+
+      protected
+
+      def inspect_payload
+        str = payload.to_s
+        if str.bytesize < 16 and str =~ /^[ -~]*$/
+          "'#{str}'"
+        else
+          "... (#{str.bytesize} bytes)"
+        end
+      end
+    end
+  end
+end

data/lib/paho_mqtt/packet/pubrec.rb

@@ -0,0 +1,26 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Pubrec < PahoMqtt::Packet::Base
+      # Get serialisation of packet's body
+      def encode_body
+        encode_short(@id)
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        unless buffer.empty?
+          raise "Extra bytes at end of Publish Received packet"
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X>" % id
+      end
+    end
+  end
+end

data/lib/paho_mqtt/packet/pubrel.rb

@@ -0,0 +1,44 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Pubrel < PahoMqtt::Packet::Base
+      # Default attribute values
+      ATTR_DEFAULTS = {
+        :flags => [false, true, false, false],
+      }
+
+      # Create a new Pubrel packet
+      def initialize(args={})
+        super(ATTR_DEFAULTS.merge(args))
+      end
+
+      # Get serialisation of packet's body
+      def encode_body
+        encode_short(@id)
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        unless buffer.empty?
+          raise "Extra bytes at end of Publish Release packet"
+        end
+      end
+
+      # Check that fixed header flags are valid for this packet type
+      # @private
+      def validate_flags
+        if @flags != [false, true, false, false]
+          raise "Invalid flags in PUBREL packet header"
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X>" % id
+      end
+    end
+  end
+end

data/lib/paho_mqtt/packet/suback.rb

@@ -0,0 +1,56 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Suback < PahoMqtt::Packet::Base
+      # An array of return codes, ordered by the topics that were subscribed to
+      attr_accessor :return_codes
+
+      # Default attribute values
+      ATTR_DEFAULTS = {
+        :return_codes => [],
+      }
+
+      # Create a new Subscribe Acknowledgment packet
+      def initialize(args={})
+        super(ATTR_DEFAULTS.merge(args))
+      end
+
+      # Set the granted QoS value for each of the topics that were subscribed to
+      # Can either be an integer or an array or integers.
+      def return_codes=(value)
+        if value.is_a?(Array)
+          @return_codes = value
+        elsif value.is_a?(Integer)
+          @return_codes = [value]
+        else
+          raise "return_codes should be an integer or an array of return codes"
+        end
+      end
+
+      # Get serialisation of packet's body
+      def encode_body
+        if @return_codes.empty?
+          raise "no granted QoS given when serialising packet"
+        end
+        body = encode_short(@id)
+        return_codes.each { |qos| body += encode_bytes(qos) }
+        return body
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        while(buffer.bytesize>0)
+          @return_codes << shift_byte(buffer)
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        "\#<#{self.class}: 0x%2.2X, rc=%s>" % [id, return_codes.map{|rc| "0x%2.2X" % rc}.join(',')]
+      end
+    end
+  end
+end

data/lib/paho_mqtt/packet/subscribe.rb

@@ -0,0 +1,104 @@
+# encoding: BINARY
+
+module PahoMqtt
+  module Packet
+    class Subscribe < PahoMqtt::Packet::Base
+      # One or more topic filters to subscribe to
+      attr_accessor :topics
+
+      # Default attribute values
+      ATTR_DEFAULTS = {
+        :topics => [],
+        :flags => [false, true, false, false],
+      }
+
+      # Create a new Subscribe packet
+      def initialize(args={})
+        super(ATTR_DEFAULTS.merge(args))
+      end
+
+      # Set one or more topic filters for the Subscribe packet
+      # The topics parameter should be one of the following:
+      # * String: subscribe to one topic with QoS 0
+      # * Array: subscribe to multiple topics with QoS 0
+      # * Hash: subscribe to multiple topics where the key is the topic and the value is the QoS level
+      #
+      # For example:
+      #   packet.topics = 'a/b'
+      #   packet.topics = ['a/b', 'c/d']
+      #   packet.topics = [['a/b',0], ['c/d',1]]
+      #   packet.topics = {'a/b' => 0, 'c/d' => 1}
+      #
+      def topics=(value)
+        # Get input into a consistent state
+        if value.is_a?(Array)
+          input = value.flatten
+        else
+          input = [value]
+        end
+
+        @topics = []
+        while(input.length>0)
+          item = input.shift
+          if item.is_a?(Hash)
+            # Convert hash into an ordered array of arrays
+            @topics += item.sort
+          elsif item.is_a?(String)
+            # Peek at the next item in the array, and remove it if it is an integer
+            if input.first.is_a?(Integer)
+              qos = input.shift
+              @topics << [item,qos]
+            else
+              @topics << [item,0]
+            end
+          else
+            # Meh?
+            raise "Invalid topics input: #{value.inspect}"
+          end
+        end
+        @topics
+      end
+
+      # Get serialisation of packet's body
+      def encode_body
+        if @topics.empty?
+          raise "no topics given when serialising packet"
+        end
+        body = encode_short(@id)
+        topics.each do |item|
+          body += encode_string(item[0])
+          body += encode_bytes(item[1])
+        end
+        return body
+      end
+
+      # Parse the body (variable header and payload) of a packet
+      def parse_body(buffer)
+        super(buffer)
+        @id = shift_short(buffer)
+        @topics = []
+        while(buffer.bytesize>0)
+          topic_name = shift_string(buffer)
+          topic_qos = shift_byte(buffer)
+          @topics << [topic_name,topic_qos]
+        end
+      end
+
+      # Check that fixed header flags are valid for this packet type
+      # @private
+      def validate_flags
+        if @flags != [false, true, false, false]
+          raise "Invalid flags in SUBSCRIBE packet header"
+        end
+      end
+
+      # Returns a human readable string, summarising the properties of the packet
+      def inspect
+        _str = "\#<#{self.class}: 0x%2.2X, %s>" % [
+          id,
+          topics.map {|t| "'#{t[0]}':#{t[1]}"}.join(', ')
+        ]
+      end
+    end
+  end
+end