mqtt 0.4.0 → 0.6.0

data/lib/mqtt/version.rb

@@ -1,4 +1,4 @@
 module MQTT
   # The version number of the MQTT gem
-  VERSION = "0.4.0"
+  VERSION = '0.6.0'
 end

data/lib/mqtt.rb

@@ -13,7 +13,6 @@ unless String.method_defined?(:force_encoding)
 end
 
 module MQTT
-
   # Default port number for unencrypted connections
   DEFAULT_PORT = 1883
 
@@ -41,7 +40,6 @@ module MQTT
 
   # MQTT-SN
   module SN
-
     # Default port number for unencrypted connections
     DEFAULT_PORT = 1883
 
@@ -50,6 +48,6 @@ module MQTT
     class ProtocolException < MQTT::Exception
     end
 
-    autoload :Packet,   'mqtt/sn/packet'
+    autoload :Packet, 'mqtt/sn/packet'
   end
 end

data/spec/mqtt_client_spec.rb

@@ -23,12 +23,23 @@ describe MQTT::Client do
     end
   end
 
+  if Process.const_defined? :CLOCK_MONOTONIC
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  else
+    # Support older Ruby
+    def now
+      Time.now.to_f
+    end
+  end
+
   describe "initializing a client" do
     it "with no arguments, it should use the defaults" do
       client = MQTT::Client.new
       expect(client.host).to eq(nil)
       expect(client.port).to eq(1883)
-      expect(client.version).to eq('3.1.0')
+      expect(client.version).to eq('3.1.1')
       expect(client.keep_alive).to eq(15)
     end
 
@@ -117,6 +128,22 @@ describe MQTT::Client do
       expect(client.password).to eq('bpass')
     end
 
+    it "with a URI containing an escaped username and password" do
+      client = MQTT::Client.new(URI.parse('mqtt://foo%20bar:%40123%2B%25@mqtt.example.com'))
+      expect(client.host).to eq('mqtt.example.com')
+      expect(client.port).to eq(1883)
+      expect(client.username).to eq('foo bar')
+      expect(client.password).to eq('@123+%')
+    end
+
+    it "with a URI containing a double escaped username and password" do
+      client = MQTT::Client.new(URI.parse('mqtt://foo%2520bar:123%2525@mqtt.example.com'))
+      expect(client.host).to eq('mqtt.example.com')
+      expect(client.port).to eq(1883)
+      expect(client.username).to eq('foo%20bar')
+      expect(client.password).to eq('123%25')
+    end
+
     it "with a URI as a string" do
       client = MQTT::Client.new('mqtt://mqtt.example.com')
       expect(client.host).to eq('mqtt.example.com')
@@ -175,7 +202,7 @@ describe MQTT::Client do
       expect(client.ssl_context.cert).to be_a(OpenSSL::X509::Certificate)
     end
   end
-    
+
   describe "setting a client private key file path" do
     it "should add a certificate to the SSL context" do
       expect(client.ssl_context.key).to be_nil
@@ -323,9 +350,9 @@ describe MQTT::Client do
       client.password = 'password'
       client.connect('myclient')
       expect(socket.string).to eq(
-        "\x10\x2A"+
-        "\x00\x06MQIsdp"+
-        "\x03\xC2\x00\x0f"+
+        "\x10\x28"+
+        "\x00\x04MQTT"+
+        "\x04\xC2\x00\x0f"+
         "\x00\x08myclient"+
         "\x00\x08username"+
         "\x00\x08password"
@@ -403,6 +430,15 @@ describe MQTT::Client do
         allow(client).to receive(:receive_connack)
         client.connect
       end
+
+      it "should use set hostname on the SSL socket for SNI" do
+        expect(OpenSSL::SSL::SSLSocket).to receive(:new).and_return(ssl_socket)
+        expect(ssl_socket).to receive(:hostname=).with('mqtt.example.com')
+
+        client = MQTT::Client.new('mqtts://mqtt.example.com')
+        allow(client).to receive(:receive_connack)
+        client.connect
+      end
     end
 
     context "with a last will and testament set" do
@@ -429,9 +465,9 @@ describe MQTT::Client do
       it "should include the will in the CONNECT message" do
         client.connect('myclient')
         expect(socket.string).to eq(
-          "\x10\x24"+
-          "\x00\x06MQIsdp"+
-          "\x03\x0e\x00\x0f"+
+          "\x10\x22"+
+          "\x00\x04MQTT"+
+          "\x04\x0e\x00\x0f"+
           "\x00\x08myclient"+
           "\x00\x05topic\x00\x05hello"
         )
@@ -473,6 +509,7 @@ describe MQTT::Client do
       socket.write("\x20\x02\x00\x00")
       socket.rewind
       expect { client.send(:receive_connack) }.not_to raise_error
+      expect(socket).not_to be_closed
     end
 
     it "should raise an exception if the packet type isn't CONNACK" do
@@ -504,6 +541,13 @@ describe MQTT::Client do
       socket.rewind
       expect { client.send(:receive_connack) }.to raise_error(MQTT::ProtocolException, /connection refused/i)
     end
+
+    it "should close the socket for an unsuccessful CONNACK packet" do
+      socket.write("\x20\x02\x00\x05")
+      socket.rewind
+      expect { client.send(:receive_connack) }.to raise_error(MQTT::ProtocolException, /not authorised/i)
+      expect(socket).to be_closed
+    end
   end
 
   describe "when calling the 'disconnect' method" do
@@ -538,10 +582,48 @@ describe MQTT::Client do
   end
 
   describe "when calling the 'publish' method" do
+    class ClientWithPubackInjection < MQTT::Client
+      def initialize
+        super(:host => 'localhost')
+        @injected_pubacks = {}
+      end
+
+      def inject_puback(packet)
+        @injected_pubacks[packet.id] = packet
+      end
+
+      def wait_for_puback(id, queue)
+        packet = @injected_pubacks.fetch(id) {
+          return super
+        }
+        queue << packet
+      end
+    end
+
+    let(:client) { ClientWithPubackInjection.new }
+
     before(:each) do
       client.instance_variable_set('@socket', socket)
     end
 
+    it "should respect timeouts" do
+      require "socket"
+      rd, wr = UNIXSocket.pair
+      client = MQTT::Client.new(:host => 'localhost', :ack_timeout => 1.0)
+      client.instance_variable_set('@socket', rd)
+      t = Thread.new {
+        Thread.current[:parent] = Thread.main
+        loop do
+          client.send :receive_packet
+        end
+      }
+      start = now
+      expect(client.publish('topic','payload', false, 1)).to eq(-1)
+      elapsed = now - start
+      t.kill
+      expect(elapsed).to be_within(0.1).of(1.0)
+    end
+
     it "should write a valid PUBLISH packet to the socket without the retain flag" do
       client.publish('topic','payload', false, 0)
       expect(socket.string).to eq("\x30\x0e\x00\x05topicpayload")
@@ -558,6 +640,19 @@ describe MQTT::Client do
       expect(socket.string).to eq("\x32\x10\x00\x05topic\x00\x01payload")
     end
 
+    it "should wrap the packet id after 65535" do
+      0xffff.times do |n|
+        inject_puback(n + 1)
+        client.publish('topic','payload', false, 1)
+      end
+      expect(client.instance_variable_get(:@last_packet_id)).to eq(0xffff)
+
+      socket.string = ""
+      inject_puback(1)
+      client.publish('topic','payload', false, 1)
+      expect(socket.string).to eq("\x32\x10\x00\x05topic\x00\x01payload")
+    end
+
     it "should write a valid PUBLISH packet to the socket with the QoS set to 2" do
       inject_puback(1)
       client.publish('topic','payload', false, 2)
@@ -595,7 +690,7 @@ describe MQTT::Client do
     it "correctly assigns consecutive ids to packets with QoS 1" do
       inject_puback(1)
       inject_puback(2)
-      
+
       expect(client).to receive(:send_packet) { |packet| expect(packet.id).to eq(1) }
       client.publish "topic", "message", false, 1
       expect(client).to receive(:send_packet) { |packet| expect(packet.id).to eq(2) }
@@ -657,6 +752,15 @@ describe MQTT::Client do
     end
   end
 
+  describe "when calling the 'clear_queue' method" do
+    it "should clear the waiting incoming messages" do
+      inject_packet(:topic => 'topic0', :payload => 'payload0', :qos => 0)
+      expect(client.queue_length).to eq(1)
+      client.clear_queue
+      expect(client.queue_length).to eq(0)
+    end
+  end
+
   describe "when calling the 'get' method" do
     before(:each) do
       client.instance_variable_set('@socket', socket)
@@ -677,6 +781,15 @@ describe MQTT::Client do
       expect(client.queue_empty?).to be_truthy
     end
 
+    it "should successfully receive a valid PUBLISH packet, but not return it, if omit_retained is set" do
+      inject_packet(:topic => 'topic1', :payload => 'payload1', :qos => 1, :retain => 1)
+      inject_packet(:topic => 'topic1', :payload => 'payload2', :qos => 1)
+      topic,payload = client.get(nil, :omit_retained => true)
+      expect(topic).to eq('topic1')
+      expect(payload).to eq('payload2')
+      expect(client.queue_empty?).to be_truthy
+    end
+
     it "acks calling #get_packet and qos=1" do
       inject_packet(:topic => 'topic1', :payload => 'payload1', :qos => 1)
       expect(client).to receive(:send_packet).with(an_instance_of(MQTT::Packet::Puback))
@@ -712,6 +825,18 @@ describe MQTT::Client do
           break if payloads.size > 1
         end
       end
+
+      it "should ignore a PUBLISH message when it is marked as retained and omit_retained is set" do
+        inject_packet(:topic => 'topic0', :payload => 'payload0', :retain => 1)
+        inject_packet(:topic => 'topic1', :payload => 'payload1')
+        payloads = []
+        client.get(nil, :omit_retained => true) do |topic,payload|
+          payloads << payload
+          break if payloads.size > 0
+        end
+        expect(payloads.size).to eq(1)
+        expect(payloads).to eq(['payload1'])
+      end
     end
   end
 
@@ -814,7 +939,7 @@ describe MQTT::Client do
       allow(MQTT::Packet).to receive(:read).and_return MQTT::Packet::Pingresp.new
       client.instance_variable_set '@last_ping_response', Time.at(0)
       client.send :receive_packet
-      expect(client.last_ping_response).to be_within(1).of Time.now
+      expect(client.last_ping_response).to be_within(1).of now
     end
   end
 
@@ -824,20 +949,20 @@ describe MQTT::Client do
     end
 
     it "should send a ping packet if one is due" do
-      client.instance_variable_set('@last_ping_request', Time.at(0))
+      client.instance_variable_set('@last_ping_request', 0.0)
       client.send('keep_alive!')
       expect(socket.string).to eq("\xC0\x00")
     end
 
     it "should update the time a ping was last sent" do
-      client.instance_variable_set('@last_ping_request', Time.at(0))
+      client.instance_variable_set('@last_ping_request', 0.0)
       client.send('keep_alive!')
-      expect(client.instance_variable_get('@last_ping_request')).not_to eq(0)
+      expect(client.instance_variable_get('@last_ping_request')).to be_within(0.01).of(now)
     end
 
     it "should raise an exception if no ping response has been received" do
-      client.instance_variable_set('@last_ping_request', Time.now)
-      client.instance_variable_set('@last_ping_response', Time.at(0))
+      client.instance_variable_set('@last_ping_request', now)
+      client.instance_variable_set('@last_ping_response', 0.0)
       expect {
         client.send('keep_alive!')
       }.to raise_error(
@@ -845,6 +970,13 @@ describe MQTT::Client do
         /No Ping Response received for \d+ seconds/
       )
     end
+
+    it "should not raise an exception if no ping response received and client is disconnected" do
+      client.instance_variable_set('@last_ping_request', Time.now)
+      client.instance_variable_set('@last_ping_response', Time.at(0))
+      client.disconnect(false)
+      client.send('keep_alive!')
+    end
   end
 
   describe "generating a client identifier" do
@@ -890,7 +1022,7 @@ describe MQTT::Client do
 
   def inject_puback(packet_id)
     packet = MQTT::Packet::Puback.new(:id => packet_id)
-    client.instance_variable_get('@pubacks')[packet_id] = packet
+    client.inject_puback packet
   end
 
 end

data/spec/mqtt_packet_spec.rb

@@ -49,6 +49,14 @@ describe MQTT::Packet do
       expect(data.encoding.to_s).to eq("ASCII-8BIT")
     end
 
+    it "should raise an error if too big argument for encode_short" do
+      expect {
+        data = packet.send(:encode_short, 0x10000)
+      }.to raise_error(
+        'Value too big for short'
+      )
+    end
+
     it "should provide a add_string method to get a string preceeded by its length" do
       data = packet.send(:encode_string, 'quack')
       expect(data).to eq("\x00\x05quack")

data/spec/zz_client_integration_spec.rb

@@ -24,9 +24,13 @@ describe "a client talking to a server" do
   end
 
   context "connecting and publishing a packet" do
-    def connect_and_publish
+    def connect_and_publish(options = {})
       @client.connect
-      @client.publish('test', 'foobar')
+
+      retain = options.fetch(:retain) { false }
+      qos = options.fetch(:qos) { 0 }
+
+      @client.publish('test', 'foobar', retain, qos)
       @client.disconnect
       @server.thread.join(1)
     end
@@ -50,6 +54,13 @@ describe "a client talking to a server" do
       connect_and_publish
       expect(@error_log.string).to be_empty
     end
+
+    context "with qos > 0" do
+      it "the server should have received a packet without timeout" do
+        connect_and_publish(:qos => 1)
+        expect(@server.last_publish).not_to be_nil
+      end
+    end
   end
 
   context "connecting, subscribing to a topic and getting a message" do

metadata

@@ -1,85 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: mqtt
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nicholas J Humfrey
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.11.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: 10.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: 10.2.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.45'
 description: Pure Ruby gem that implements the MQTT protocol, a lightweight protocol
   for publish/subscribe messaging.
 email: njh@aelius.com
@@ -92,6 +106,7 @@ files:
 - README.md
 - lib/mqtt.rb
 - lib/mqtt/client.rb
+- lib/mqtt/openssl_fix.rb
 - lib/mqtt/packet.rb
 - lib/mqtt/patches/string_encoding.rb
 - lib/mqtt/proxy.rb
@@ -103,28 +118,27 @@ files:
 - spec/mqtt_sn_packet_spec.rb
 - spec/mqtt_version_spec.rb
 - spec/zz_client_integration_spec.rb
-homepage: http://github.com/njh/ruby-mqtt
+homepage: https://github.com/njh/ruby-mqtt
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: mqtt
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Implementation of the MQTT protocol
 test_files:
@@ -134,4 +148,3 @@ test_files:
 - spec/mqtt_sn_packet_spec.rb
 - spec/mqtt_version_spec.rb
 - spec/zz_client_integration_spec.rb
-has_rdoc: