mqtt 0.5.0 → 0.7.0

data/lib/mqtt/version.rb

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

data/lib/mqtt.rb

@@ -7,13 +7,7 @@ require 'timeout'
 
 require 'mqtt/version'
 
-# String encoding monkey patch for Ruby 1.8
-unless String.method_defined?(:force_encoding)
-  require 'mqtt/patches/string_encoding.rb'
-end
-
 module MQTT
-
   # Default port number for unencrypted connections
   DEFAULT_PORT = 1883
 
@@ -41,7 +35,6 @@ module MQTT
 
   # MQTT-SN
   module SN
-
     # Default port number for unencrypted connections
     DEFAULT_PORT = 1883
 
@@ -50,6 +43,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,6 +23,17 @@ 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
@@ -221,10 +232,46 @@ describe MQTT::Client do
   describe "setting an encrypted client private key, w/an incorrect passphrase" do
     let(:key_pass) { 'ttqm' }
 
-    it "should raise an OpenSSL::PKey::RSAError exception" do
+    it "should raise an exception" do
       expect(client.ssl_context.key).to be_nil
       expect { client.key_file = [fixture_path('client.pass.key'), key_pass] }.to(
-        raise_error(OpenSSL::PKey::RSAError, /Neither PUB key nor PRIV key/))
+        raise_error(/Could not parse PKey/))
+    end
+  end
+
+  describe "setting a client private EC key file path" do
+    it "should add a certificate to the SSL context" do
+      expect(client.ssl_context.key).to be_nil
+      client.key_file = fixture_path('ec.key')
+      expect(client.ssl_context.key).to be_a(OpenSSL::PKey::EC)
+    end
+  end
+
+  describe "setting a client private EC key directly" do
+    it "should add a certificate to the SSL context" do
+      expect(client.ssl_context.key).to be_nil
+      client.key = File.read(fixture_path('ec.key'))
+      expect(client.ssl_context.key).to be_a(OpenSSL::PKey::EC)
+    end
+  end
+
+  describe "setting an encrypted client private EC key, w/the correct passphrase" do
+    let(:key_pass) { 'mqtt' }
+
+    it "should add the decrypted certificate to the SSL context" do
+      expect(client.ssl_context.key).to be_nil
+      client.key_file = [fixture_path('ec.pass.key'), key_pass]
+      expect(client.ssl_context.key).to be_a(OpenSSL::PKey::EC)
+    end
+  end
+
+  describe "setting an encrypted client private EC key, w/an incorrect passphrase" do
+    let(:key_pass) { 'ttqm' }
+
+    it "should raise an exception" do
+      expect(client.ssl_context.key).to be_nil
+      expect { client.key_file = [fixture_path('ec.pass.key'), key_pass] }.to(
+        raise_error(/Could not parse PKey/))
     end
   end
 
@@ -395,6 +442,7 @@ describe MQTT::Client do
       it "should use ssl if it enabled using the :ssl => true parameter" do
         expect(OpenSSL::SSL::SSLSocket).to receive(:new).and_return(ssl_socket)
         expect(ssl_socket).to receive(:connect)
+        expect(ssl_socket).to receive(:post_connection_check).with('mqtt.example.com')
 
         client = MQTT::Client.new('mqtt.example.com', :ssl => true)
         allow(client).to receive(:receive_connack)
@@ -404,6 +452,7 @@ describe MQTT::Client do
       it "should use ssl if it enabled using the mqtts:// scheme" do
         expect(OpenSSL::SSL::SSLSocket).to receive(:new).and_return(ssl_socket)
         expect(ssl_socket).to receive(:connect)
+        expect(ssl_socket).to receive(:post_connection_check).with('mqtt.example.com')
 
         client = MQTT::Client.new('mqtts://mqtt.example.com')
         allow(client).to receive(:receive_connack)
@@ -413,6 +462,7 @@ describe MQTT::Client do
       it "should use set the SSL version, if the :ssl parameter is a symbol" do
         expect(OpenSSL::SSL::SSLSocket).to receive(:new).and_return(ssl_socket)
         expect(ssl_socket).to receive(:connect)
+        expect(ssl_socket).to receive(:post_connection_check).with('mqtt.example.com')
 
         client = MQTT::Client.new('mqtt.example.com', :ssl => :TLSv1)
         expect(client.ssl_context).to receive('ssl_version=').with(:TLSv1)
@@ -423,11 +473,21 @@ describe MQTT::Client do
       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')
+        expect(ssl_socket).to receive(:post_connection_check).with('mqtt.example.com')
 
         client = MQTT::Client.new('mqtts://mqtt.example.com')
         allow(client).to receive(:receive_connack)
         client.connect
       end
+
+      it "should skip host verification" do
+        expect(OpenSSL::SSL::SSLSocket).to receive(:new).and_return(ssl_socket)
+        expect(ssl_socket).to receive(:connect)
+
+        client = MQTT::Client.new('mqtt.example.com', :ssl => true, :verify_host => false)
+        allow(client).to receive(:receive_connack)
+        client.connect
+      end
     end
 
     context "with a last will and testament set" do
@@ -571,10 +631,61 @@ 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)
+        packet = @injected_pubacks.fetch(id) {
+          return super
+        }
+        Queue.new << packet
+      end
+    end
+
+    let(:client) { ClientWithPubackInjection.new }
+
     before(:each) do
       client.instance_variable_set('@socket', socket)
     end
 
+    it "should respect connect_timeout" do
+      client = MQTT::Client.new(:host => '198.51.100.1', :connect_timeout => 0.1)
+      expect {
+        client.connect
+      }.to raise_error( 
+        if defined? IO::TimeoutError
+          IO::TimeoutError
+        else
+          Errno::ETIMEDOUT
+        end
+      )
+    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")
@@ -591,6 +702,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)
@@ -634,6 +758,20 @@ describe MQTT::Client do
       expect(client).to receive(:send_packet) { |packet| expect(packet.id).to eq(2) }
       client.publish "topic", "message", false, 1
     end
+
+    it "does not crash when receiving a PUBACK for a packet it never sent" do
+      expect { client.send(:handle_packet, MQTT::Packet::Puback.new(:id => 666)) }.to_not raise_error
+    end
+
+    it "does not crash with QoS 1 when the broker sends the PUBACK instantly" do
+      allow(client).to receive(:send_packet).and_wrap_original do |send_packet, packet, *args, &block|
+        send_packet.call(packet, *args, &block).tap do
+          client.send(:handle_packet, MQTT::Packet::Puback.new(:id => packet.id))
+        end
+      end
+
+      expect { client.publish("topic", "message", false, 1) }.to_not raise_error
+    end
   end
 
   describe "when calling the 'subscribe' method" do
@@ -690,6 +828,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)
@@ -852,15 +999,29 @@ describe MQTT::Client do
       expect(@read_queue.size).to eq(0)
     end
 
-    it "should close the socket if there is an exception" do
+    it "should close the socket if there is an MQTT exception" do
       expect(socket).to receive(:close).once
       allow(MQTT::Packet).to receive(:read).and_raise(MQTT::Exception)
       client.send(:receive_packet)
     end
 
+    it "should close the socket if there is a system call error" do
+      expect(socket).to receive(:close).once
+      allow(MQTT::Packet).to receive(:read).and_raise(Errno::ECONNRESET)
+      client.send(:receive_packet)
+    end
+
     it "should pass exceptions up to parent thread" do
-      expect(@parent_thread).to receive(:raise).once
-      allow(MQTT::Packet).to receive(:read).and_raise(MQTT::Exception)
+      e = MQTT::Exception.new
+      expect(@parent_thread).to receive(:raise).with(e).once
+      allow(MQTT::Packet).to receive(:read).and_raise(e)
+      client.send(:receive_packet)
+    end
+
+    it "should pass a system call error up to parent thread" do
+      e = Errno::ECONNRESET.new
+      expect(@parent_thread).to receive(:raise).with(e).once
+      allow(MQTT::Packet).to receive(:read).and_raise(e)
       client.send(:receive_packet)
     end
 
@@ -868,7 +1029,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
 
@@ -878,20 +1039,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(
@@ -951,7 +1112,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")
@@ -374,8 +382,7 @@ describe MQTT::Packet::Publish do
       expect(packet.topic.bytesize).to eq(8)
     end
 
-    it "should have the correct topic string length", :unless => RUBY_VERSION =~ /^1\.8/ do
-      # Ruby 1.8 doesn't support UTF-8 properly
+    it "should have the correct topic string length" do
       expect(packet.topic.length).to eq(6)
     end
 
@@ -383,8 +390,7 @@ describe MQTT::Packet::Publish do
       expect(packet.payload.bytesize).to eq(12)
     end
 
-    it "should have the correct payload string length", :unless => RUBY_VERSION =~ /^1\.8/ do
-      # Ruby 1.8 doesn't support UTF-8 properly
+    it "should have the correct payload string length" do
       expect(packet.payload.length).to eq(10)
     end
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mqtt
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Nicholas J Humfrey
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-16 00:00:00.000000000 Z
+date: 2025-10-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !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,8 +120,8 @@ 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
 - lib/mqtt/sn/packet.rb
 - lib/mqtt/version.rb
@@ -103,11 +131,11 @@ 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
@@ -122,9 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: mqtt
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Implementation of the MQTT protocol
 test_files:

data/lib/mqtt/patches/string_encoding.rb

@@ -1,34 +0,0 @@
-# Monkey patch to add stubbed string encoding functions to Ruby 1.8
-
-class String
-  def force_encoding(encoding)
-    @encoding = encoding
-    self
-  end
-
-  def encoding
-    @encoding ||= Encoding::ASCII_8BIT
-  end
-
-  def encode(encoding)
-    new = self.dup
-    new.force_encoding(encoding)
-  end
-end
-
-class Encoding
-  def initialize(name)
-    @name = name
-  end
-
-  def to_s
-    @name
-  end
-  
-  def name
-    @name
-  end
-
-  UTF_8 = Encoding.new("UTF-8")
-  ASCII_8BIT = Encoding.new("ASCII-8BIT")
-end