mini_mqtt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 998e32192be7c070e3c79ffc234c874ecf3962e7
-  data.tar.gz: 426b36b3850393562047e1a09f9c1cf9067fdfb9
+  metadata.gz: 122329e41615462566527851764e5f1120bde96e
+  data.tar.gz: 22a3417ee3be5c3911fff0233a766e01f4fdb7e9
 SHA512:
-  metadata.gz: 5e86d0852c429b21a11d035bbd0da3b1d8fc1c193ee7d106fe27787f75b931167a2ed7af46cec696b471c9e3bff09714c3a75f1d8d0617cc0f2717032a05093d
-  data.tar.gz: dbce45001fa0d8f7ef8b8a63c6a041c630722416f9cc67bd56add6641fbf54c34e24886000bea9e66f3ae852489540a8129b6c8987414d760390604522d0d0c0
+  metadata.gz: 149e5b17a38167dab79812ad5f9a652cccb21f52f69c78cc69fd740d375469fba1d8e5652ddcaa3b4eacc83aebe7a5799adb336824259bddae51bb69c18f1ad1
+  data.tar.gz: f49d83a7b2f26be8951afa6981f9bcea1e68e8d94523d4808d5e2d02db7f7ebcf8c0f315af985b0f382ab32951533d49a453785444dc2fc8e5a5dbaec9208504

data/README.md

@@ -1,33 +1,31 @@
+[![Code Climate](https://codeclimate.com/github/antico5/mini_mqtt/badges/gpa.svg)](https://codeclimate.com/github/antico5/mini_mqtt)
+[![Test Coverage](https://codeclimate.com/github/antico5/mini_mqtt/badges/coverage.svg)](https://codeclimate.com/github/antico5/mini_mqtt/coverage)
+[![Issue Count](https://codeclimate.com/github/antico5/mini_mqtt/badges/issue_count.svg)](https://codeclimate.com/github/antico5/mini_mqtt)
+[![Build Status](https://travis-ci.org/antico5/mini_mqtt.svg?branch=master)](https://travis-ci.org/antico5/mini_mqtt)
+
 # MiniMqtt
 
 A full ruby implementation of the client side of MQTT protocol. 
 
 The philosophy behind this gem is to keep the code as minimal and tidy as possible, and to completely avoid dependencies.
 
-    cloc lib
-    
-    ---------------------------------------------------------------------
-    Language         files          blank        comment           code
-    ---------------------------------------------------------------------
-    Ruby                 6            103             14            449
-    ---------------------------------------------------------------------
 
 ## Features
 
 * Supports all MQTT features up to QoS 1.
-* Doesn't support websockets.
-* Doesn't store messages once the connection has been closed.
+* 450 lines of code
+* 98% test coverage
+* Doesn't store messages once the connection has been closed/lost.
 
 ## Installation
 
-Clone this repo and include it to your load path. This project isn't published at rubygems yet.
+`gem 'mini_mqtt'`
+
 
 ## How to test
-You need mosquitto server installed in order to run integration tests.
+Integration tests will hit mosquitto's test broker test.mosquitto.org.
 
-    sudo apt-get install mosquitto
-    
-    rake test
+`rake test`
 
 ## Usage
 
@@ -85,7 +83,7 @@ client.subscribe '/topic', '/qos_topic' => 1
 ```
 
 ### Get messages
-The caller of these methods are blocked until a message arrives, or the connection is lost.
+The caller of these methods is blocked until a message arrives, or the connection is lost.
 
 ```ruby
 # Get a single message
@@ -99,5 +97,6 @@ end
 ```
 
 ### Gracefully disconnect
+```ruby
 client.disconnect
 ```

data/lib/mini_mqtt.rb

@@ -1,6 +1,19 @@
 require 'mini_mqtt/bin_helper'
 require 'mini_mqtt/packet'
 require 'mini_mqtt/connect_packet'
+require 'mini_mqtt/connack_packet'
+require 'mini_mqtt/publish_packet'
+require 'mini_mqtt/puback_packet'
+require 'mini_mqtt/pubrec_packet'
+require 'mini_mqtt/pubrel_packet'
+require 'mini_mqtt/pubcomp_packet'
+require 'mini_mqtt/subscribe_packet'
+require 'mini_mqtt/suback_packet'
+require 'mini_mqtt/unsubscribe_packet'
+require 'mini_mqtt/unsuback_packet'
+require 'mini_mqtt/pingreq_packet'
+require 'mini_mqtt/pingresp_packet'
+require 'mini_mqtt/disconnect_packet'
 require 'mini_mqtt/packet_handler'
 require 'mini_mqtt/client'
 

data/lib/mini_mqtt/client.rb

@@ -17,16 +17,16 @@ module MiniMqtt
     def connect options = {}
       # Create socket and packet handler
       @socket = TCPSocket.new @host, @port
-      @packet_handler = PacketHandler.new @socket
+      @handler = PacketHandler.new @socket
 
       # Send ConnectPacket
-      send_packet ConnectPacket.new user: @user,
+      @handler.write_packet ConnectPacket.new user: @user,
         password: @password, keep_alive: @keep_alive, client_id: @client_id,
         clean_session: @clean_session, will_topic: options[:will_topic],
         will_message: options[:will_message], will_retain: options[:will_retain]
 
       # Receive connack packet
-      connack = receive_packet
+      connack = @handler.get_packet
 
       if connack.accepted?
         @received_messages = Queue.new
@@ -46,22 +46,22 @@ module MiniMqtt
       end
       topics = topics.inject :merge
       packet = SubscribePacket.new topics: topics
-      send_packet packet
+      @handler.write_packet packet
     end
 
     def unsubscribe *topics
-      send_packet UnsubscribePacket.new topics: topics
+      @handler.write_packet UnsubscribePacket.new topics: topics
     end
 
     def publish topic, message, options = {}
       packet = PublishPacket.new topic: topic, message: message.to_s,
         retain: options[:retain], qos: options[:qos]
-      send_packet packet
+      @handler.write_packet packet
     end
 
     def disconnect
       # Send DisconnectPacket, then kill threads and close socket
-      send_packet DisconnectPacket.new
+      @handler.write_packet DisconnectPacket.new
       @read_thread.kill
       @keepalive_thread.kill
       @socket.close
@@ -83,53 +83,43 @@ module MiniMqtt
 
     private
 
-      def send_packet packet
-        @packet_handler.write_packet packet
-      end
-
-      def receive_packet
-        @packet_handler.get_packet
-      end
-
-      def handle_received_packet packet
-        case packet
-        when PingrespPacket
-          @last_ping_response = Time.now
-
-        when PublishPacket
-          @received_messages << packet
-          if packet.qos > 0
-            send_packet PubackPacket.new packet_id: packet.packet_id
-          end
-
-        when PubackPacket
+    def handle_received_packet packet
+      case packet
+      when PingrespPacket
+        @last_ping_response = Time.now
+      when PublishPacket
+        @received_messages << packet
+        if packet.qos > 0
+          @handler.write_packet PubackPacket.new packet_id: packet.packet_id
         end
+      when PubackPacket
       end
+    end
 
-      def generate_client_id
-        "client_#{ rand(10000000) }"
-      end
+    def generate_client_id
+      "client_#{ rand(10000000) }"
+    end
 
-      def spawn_read_thread!
-        @read_thread = Thread.new do
-          while connected? do
-            handle_received_packet receive_packet
-          end
-          @received_messages << nil
+    def spawn_read_thread!
+      @read_thread = Thread.new do
+        while connected? do
+          handle_received_packet @handler.get_packet
         end
+        @received_messages << nil
       end
+    end
 
-      def spawn_keepalive_thread!
-        @keepalive_thread = Thread.new do
-          while connected? do
-            send_packet PingreqPacket.new
-            sleep @keep_alive
-            if Time.now - @last_ping_response > 2 * @keep_alive
-              puts "Error: MQTT Server not responding to ping. Disconnecting."
-              @socket.close
-            end
+    def spawn_keepalive_thread!
+      @keepalive_thread = Thread.new do
+        while connected? do
+          @handler.write_packet PingreqPacket.new
+          sleep @keep_alive
+          if Time.now - @last_ping_response > 2 * @keep_alive
+            puts "Error: MQTT Server not responding to ping. Disconnecting."
+            @socket.close
           end
         end
       end
+    end
   end
 end

data/lib/mini_mqtt/connack_packet.rb

@@ -0,0 +1,30 @@
+module MiniMqtt
+  class ConnackPacket < Packet
+    attr_reader :return_code
+    register_packet_type 2
+
+    ERRORS = { 1 => "unacceptable protocol version",
+               2 => "identifier rejected",
+               3 => "server unavailable",
+               4 => "bad username or password",
+               5 => "not authorized" }
+
+
+    def read_variable_header
+      @session_present = @stream.readbyte & 0x01
+      @return_code = @stream.readbyte
+    end
+
+    def session_present?
+      @session_present == 1
+    end
+
+    def accepted?
+      @return_code == 0
+    end
+
+    def error_message
+      ERRORS[@return_code]
+    end
+  end
+end

data/lib/mini_mqtt/connect_packet.rb

@@ -1,5 +1,7 @@
 module MiniMqtt
   class ConnectPacket < Packet
+    register_packet_type 1
+
     def initialize options = {}
       @user = options[:user]
       @password = options[:password]
@@ -29,8 +31,7 @@ module MiniMqtt
     end
 
     def build_payload
-      payload = ""
-      payload << mqtt_utf8_encode(@client_id)
+      payload = mqtt_utf8_encode(@client_id)
       if @will_message
         payload << mqtt_utf8_encode(@will_topic)
         payload << mqtt_utf8_encode(@will_message)

data/lib/mini_mqtt/disconnect_packet.rb

@@ -0,0 +1,5 @@
+module MiniMqtt
+  class DisconnectPacket < Packet
+    register_packet_type 14
+  end
+end

data/lib/mini_mqtt/packet.rb

@@ -1,10 +1,9 @@
-class InvalidFlagsError < StandardError ; end
-
 module MiniMqtt
   class Packet
     include BinHelper
 
     @@last_packet_id = 0
+    @@packet_classes = {}
 
     def decode stream, flags = 0
       @stream = stream
@@ -22,218 +21,58 @@ module MiniMqtt
       0b000
     end
 
-    private
-
-      def new_packet_id
-        @@last_packet_id += 1
-        @@last_packet_id %= 65535
-        1 + @@last_packet_id
-      end
-
-      def read_variable_header
-      end
-
-      def read_payload
-      end
-
-      def handle_flags flags
-      end
-
-      def build_variable_header
-        ""
-      end
-
-      def build_payload
-        ""
-      end
-
-  end
-
-  module AckPacket
-    attr_accessor :packet_id
-
-    def initialize params = {}
-      @packet_id = params[:packet_id]
-    end
-
-    def read_variable_header
-      @packet_id = read_ushort @stream
-    end
-
-    def build_variable_header
-      ushort @packet_id
-    end
-  end
-
-  class ConnackPacket < Packet
-    attr_reader :return_code
-
-    ERRORS = { 1 => "unacceptable protocol version",
-               2 => "identifier rejected",
-               3 => "server unavailable",
-               4 => "bad username or password",
-               5 => "not authorized" }
-
-
-    def read_variable_header
-      @session_present = @stream.readbyte & 0x01
-      @return_code = @stream.readbyte
+    def self.packet_type_id
+      @packet_type_id
     end
 
-    def session_present?
-      @session_present == 1
+    def self.get_packet_class packet_type_id
+      @@packet_classes[packet_type_id]
     end
 
-    def accepted?
-      @return_code == 0
-    end
+    private
 
-    def error_message
-      ERRORS[@return_code]
+    def self.register_packet_type packet_type_id
+      @packet_type_id = packet_type_id
+      @@packet_classes[packet_type_id] = self
     end
 
-  end
-
-  class PublishPacket < Packet
-    attr_accessor :dup, :qos, :retain, :packet_id, :topic, :message
-
-    def handle_flags flags
-      @dup = flags & 0b1000 != 0
-      @qos = (flags & 0b0110) >> 1
-      @retain = flags & 0b0001 != 0
+    def new_packet_id
+      @@last_packet_id += 1
+      @@last_packet_id %= 65535
+      1 + @@last_packet_id
     end
 
     def read_variable_header
-      @topic = read_mqtt_encoded_string @stream
-      if @qos > 0
-        @packet_id = read_ushort @stream
-      end
     end
 
     def read_payload
-      @message = @stream.read
-    end
-
-    def initialize params = {}
-      @topic = params[:topic] || ""
-      @message = params[:message] || ""
-      @qos = params[:qos] || 0
-      @dup = params[:dup] || false
-      @retain = params[:retain] || false
-      @packet_id = params[:packet_id]
     end
 
-    def flags
-      flags = 0
-      flags |= 0b0001 if @retain
-      flags |= qos << 1
-      flags |= 0b1000 if @dup
-      flags
+    def handle_flags flags
     end
 
     def build_variable_header
-      header = mqtt_utf8_encode @topic
-      if @qos > 0
-        @packet_id ||= new_packet_id
-        header << ushort(@packet_id)
-      end
-      header
+      ""
     end
 
     def build_payload
-      @message
-    end
-
-  end
-
-  class PubackPacket < Packet
-    include AckPacket
-  end
-
-  class PubrecPacket < Packet
-    include AckPacket
-  end
-
-  class PubrelPacket < Packet
-    include AckPacket
-
-    def flags
-      0b0010
+      ""
     end
   end
 
-  class PubcompPacket < Packet
-    include AckPacket
-  end
-
-  class SubscribePacket < Packet
-    attr_accessor :packet_id, :topics
+  module AckPacket
+    attr_accessor :packet_id
 
     def initialize params = {}
-      @topics = params[:topics]
-    end
-
-    def flags
-      0b0010
-    end
-
-    def build_variable_header
-      @packet_id ||= new_packet_id
-      ushort @packet_id
-    end
-
-    def build_payload
-      @topics.map do |topic, qos|
-        mqtt_utf8_encode(topic) + uchar(qos)
-      end.join
+      @packet_id = params[:packet_id]
     end
-  end
-
-  class SubackPacket < Packet
-    attr_accessor :packet_id, :max_qos_accepted
 
     def read_variable_header
       @packet_id = read_ushort @stream
     end
 
-    def read_payload
-      @max_qos_accepted = @stream.read.unpack 'C*'
-    end
-  end
-
-  class UnsubscribePacket < Packet
-    attr_accessor :packet_id, :topics
-
-    def flags
-      0b0010
-    end
-
-    def initialize params = {}
-      @topics = params[:topics]
-    end
-
     def build_variable_header
-      @packet_id ||= new_packet_id
       ushort @packet_id
     end
-
-    def build_payload
-      @topics.map do |topic|
-        mqtt_utf8_encode(topic)
-      end.join
-    end
-  end
-
-  class UnsubackPacket < Packet
-    include AckPacket
-  end
-
-  class PingreqPacket < Packet
-  end
-
-  class PingrespPacket < Packet
-  end
-
-  class DisconnectPacket < Packet
   end
 end

data/lib/mini_mqtt/packet_handler.rb

@@ -1,22 +1,6 @@
 require 'stringio'
 
 module MiniMqtt
-  PACKET_CLASSES = { 1 => ConnectPacket,
-                     2 => ConnackPacket,
-                     3 => PublishPacket,
-                     4 => PubackPacket,
-                     5 => PubrecPacket,
-                     6 => PubrelPacket,
-                     7 => PubcompPacket,
-                     8 => SubscribePacket,
-                     9 => SubackPacket,
-                     10 => UnsubscribePacket,
-                     11 => UnsubackPacket,
-                     12 => PingreqPacket,
-                     13 => PingrespPacket,
-                     14 => DisconnectPacket }
-  PACKET_CODES = PACKET_CLASSES.invert
-
   class PacketHandler
     include BinHelper
 
@@ -36,7 +20,7 @@ module MiniMqtt
     def get_packet
       # First byte contains packet type and flags. 4 bits each.
       first_byte = @stream.readbyte
-      packet_class = PACKET_CLASSES[ first_byte >> 4 ]
+      packet_class = Packet.get_packet_class(first_byte >> 4)
       flags = first_byte & 0xf
 
       #Decode length using algorithm, and read packet body.
@@ -55,7 +39,7 @@ module MiniMqtt
     def write_packet packet
       # Write type and flags, then encoded packet length, then packet
       @mutex.synchronize do
-        type_and_flags = PACKET_CODES[packet.class] << 4
+        type_and_flags = packet.class.packet_type_id << 4
         type_and_flags += packet.flags
         @stream.write uchar(type_and_flags)
         encoded_packet = packet.encode

data/lib/mini_mqtt/pingreq_packet.rb

@@ -0,0 +1,5 @@
+module MiniMqtt
+  class PingreqPacket < Packet
+    register_packet_type 12
+  end
+end

data/lib/mini_mqtt/pingresp_packet.rb

@@ -0,0 +1,5 @@
+module MiniMqtt
+  class PingrespPacket < Packet
+    register_packet_type 13
+  end
+end

data/lib/mini_mqtt/puback_packet.rb

@@ -0,0 +1,6 @@
+module MiniMqtt
+  class PubackPacket < Packet
+    include AckPacket
+    register_packet_type 4
+  end
+end

data/lib/mini_mqtt/pubcomp_packet.rb

@@ -0,0 +1,6 @@
+module MiniMqtt
+  class PubcompPacket < Packet
+    include AckPacket
+    register_packet_type 7
+  end
+end

data/lib/mini_mqtt/publish_packet.rb

@@ -0,0 +1,53 @@
+module MiniMqtt
+  class PublishPacket < Packet
+    attr_accessor :dup, :qos, :retain, :packet_id, :topic, :message
+    register_packet_type 3
+
+    def handle_flags flags
+      @dup = flags & 0b1000 != 0
+      @qos = (flags & 0b0110) >> 1
+      @retain = flags & 0b0001 != 0
+    end
+
+    def read_variable_header
+      @topic = read_mqtt_encoded_string @stream
+      if @qos > 0
+        @packet_id = read_ushort @stream
+      end
+    end
+
+    def read_payload
+      @message = @stream.read
+    end
+
+    def initialize params = {}
+      @topic = params[:topic] || ""
+      @message = params[:message] || ""
+      @qos = params[:qos] || 0
+      @dup = params[:dup] || false
+      @retain = params[:retain] || false
+      @packet_id = params[:packet_id]
+    end
+
+    def flags
+      flags = 0
+      flags |= 0b0001 if @retain
+      flags |= qos << 1
+      flags |= 0b1000 if @dup
+      flags
+    end
+
+    def build_variable_header
+      header = mqtt_utf8_encode @topic
+      if @qos > 0
+        @packet_id ||= new_packet_id
+        header << ushort(@packet_id)
+      end
+      header
+    end
+
+    def build_payload
+      @message
+    end
+  end
+end

data/lib/mini_mqtt/pubrec_packet.rb

@@ -0,0 +1,6 @@
+module MiniMqtt
+  class PubrecPacket < Packet
+    include AckPacket
+    register_packet_type 5
+  end
+end

data/lib/mini_mqtt/pubrel_packet.rb

@@ -0,0 +1,10 @@
+module MiniMqtt
+  class PubrelPacket < Packet
+    include AckPacket
+    register_packet_type 6
+
+    def flags
+      0b0010
+    end
+  end
+end

data/lib/mini_mqtt/suback_packet.rb

@@ -0,0 +1,14 @@
+module MiniMqtt
+  class SubackPacket < Packet
+    attr_accessor :packet_id, :max_qos_accepted
+    register_packet_type 9
+
+    def read_variable_header
+      @packet_id = read_ushort @stream
+    end
+
+    def read_payload
+      @max_qos_accepted = @stream.read.unpack 'C*'
+    end
+  end
+end

data/lib/mini_mqtt/subscribe_packet.rb

@@ -0,0 +1,25 @@
+module MiniMqtt
+  class SubscribePacket < Packet
+    attr_accessor :packet_id, :topics
+    register_packet_type 8
+
+    def initialize params = {}
+      @topics = params[:topics]
+    end
+
+    def flags
+      0b0010
+    end
+
+    def build_variable_header
+      @packet_id ||= new_packet_id
+      ushort @packet_id
+    end
+
+    def build_payload
+      @topics.map do |topic, qos|
+        mqtt_utf8_encode(topic) + uchar(qos)
+      end.join
+    end
+  end
+end

data/lib/mini_mqtt/unsuback_packet.rb

@@ -0,0 +1,6 @@
+module MiniMqtt
+  class UnsubackPacket < Packet
+    include AckPacket
+    register_packet_type 11
+  end
+end

data/lib/mini_mqtt/unsubscribe_packet.rb

@@ -0,0 +1,25 @@
+module MiniMqtt
+  class UnsubscribePacket < Packet
+    attr_accessor :packet_id, :topics
+    register_packet_type 10
+
+    def flags
+      0b0010
+    end
+
+    def initialize params = {}
+      @topics = params[:topics]
+    end
+
+    def build_variable_header
+      @packet_id ||= new_packet_id
+      ushort @packet_id
+    end
+
+    def build_payload
+      @topics.map do |topic|
+        mqtt_utf8_encode(topic)
+      end.join
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_mqtt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Armando Andini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,9 +90,22 @@ files:
 - lib/mini_mqtt.rb
 - lib/mini_mqtt/bin_helper.rb
 - lib/mini_mqtt/client.rb
+- lib/mini_mqtt/connack_packet.rb
 - lib/mini_mqtt/connect_packet.rb
+- lib/mini_mqtt/disconnect_packet.rb
 - lib/mini_mqtt/packet.rb
 - lib/mini_mqtt/packet_handler.rb
+- lib/mini_mqtt/pingreq_packet.rb
+- lib/mini_mqtt/pingresp_packet.rb
+- lib/mini_mqtt/puback_packet.rb
+- lib/mini_mqtt/pubcomp_packet.rb
+- lib/mini_mqtt/publish_packet.rb
+- lib/mini_mqtt/pubrec_packet.rb
+- lib/mini_mqtt/pubrel_packet.rb
+- lib/mini_mqtt/suback_packet.rb
+- lib/mini_mqtt/subscribe_packet.rb
+- lib/mini_mqtt/unsuback_packet.rb
+- lib/mini_mqtt/unsubscribe_packet.rb
 - test/client_test.rb
 - test/connack_packet_test.rb
 - test/connect_packet_test.rb
@@ -134,19 +147,19 @@ signing_key:
 specification_version: 4
 summary: MQTT Client for Ruby.
 test_files:
-- test/pubcomp_packet_test.rb
-- test/disconnect_packet_test.rb
-- test/publish_packet_test.rb
+- test/pubrel_packet_test.rb
 - test/ping_packets_test.rb
-- test/connack_packet_test.rb
+- test/disconnect_packet_test.rb
+- test/unsuback_packet_test.rb
+- test/puback_packet_test.rb
 - test/unsubscribe_packet_test.rb
-- test/connect_packet_test.rb
 - test/test_helper.rb
-- test/subscribe_packet_test.rb
-- test/unsuback_packet_test.rb
+- test/connect_packet_test.rb
+- test/publish_packet_test.rb
 - test/suback_packet_test.rb
-- test/puback_packet_test.rb
+- test/pubcomp_packet_test.rb
+- test/subscribe_packet_test.rb
+- test/connack_packet_test.rb
+- test/packet_handler_test.rb
 - test/client_test.rb
-- test/pubrel_packet_test.rb
 - test/pubrec_packet_test.rb
-- test/packet_handler_test.rb