mqtt 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 910045c2af52ae8eaca56e2a86b936d91a4dc1c17f9c93756a9ea54a42f1b005
-  data.tar.gz: 7e5da868a348396b21357df0b735973438f3919cd40bc5b9e7dca79141e181fb
+  metadata.gz: 1cd5b00cfda7ebb05929c0cc4319b7400b5a8e787a7e11bfeba265017cd31cc8
+  data.tar.gz: b08388a375e26c252ebe829ea191f51c85693cb0e2b2b986f36b567a5dd710c0
 SHA512:
-  metadata.gz: 57cde9d9792ca557c90d28349f0d4352aec8c861488ef67de1c9d40ccba7ee7ee984235340c18b68940273fd518177bc91f4b07c4be832934fc9e72c02656cef
-  data.tar.gz: fe71c84c97918687930830606bd1fc9214e05d92914062b7521f52b69e688953ae9230681531354b9837f99850c1d226dc4bb8f20961e0c4970fe1d0d82fb419
+  metadata.gz: 17a6d4df69038d28566c9c4921e82a4eb363aafc0d1f811ca94ad538337a05460ea7ca8bfc5e8769d00e958443ea72c53c56bd483dc4ebbaf5f89b5d7afc918b
+  data.tar.gz: 71a683f038ec5df05ade1f70cf536ab1174700da82eb9ef810b59d8c06af64588bd0166f7e9012f344f4af7f1326afdd9f0f462a744e340ac3f860f89bf9b0b1

data/NEWS.md

@@ -1,6 +1,32 @@
 Ruby MQTT NEWS
 ==============
 
+Ruby MQTT Version 0.7.0 (2025-10-29)
+------------------------------------
+
+* TLS hostname verification (#125)
+* Supporting private keys other than `RSA` (#148)
+* Removed support for ruby 1.8 and 1.9 (#156)
+* Handle instantaneous and unsolicited PUBACKs (#158)
+* Prevent deadlock due to system call error (#159)
+* Added support for timeout when opening a TCPSocket (#163)
+* Switch to URI::DEFAULT_PARSER.unescape() instead of CGI.unescape()
+
+
+Ruby MQTT Version 0.6.0 (2023-02-17)
+------------------------------------
+
+* Add Rubocop and performed code cleanup
+* Updated yard minimum version to 
+* Added support for clearing the queue of waiting incoming messages (#117)
+* Wrap packet id after 0xffff (#118)
+* Use a queue to wait for Puback packets rather than polling (#120)
+* Filter out spec files from the coverage report
+* Improvements `Packet.read_byte` performance (#134)
+* Use monotonic clock instead of realtime for keep_alive (#132)
+* Switch to CGI.unescape instead of the deprecated URI.unescape (#136)
+
+
 Ruby MQTT Version 0.5.0 (2017-04-16)
 ------------------------------------
 

data/README.md

@@ -25,16 +25,16 @@ You may get the latest stable version from [Rubygems]:
 
     $ gem install mqtt
 
-Alternatively, to use a development snapshot from GitHub using [Bundler]:
-
-    gem 'mqtt', :git => 'https://github.com/njh/ruby-mqtt.git'
+Alternatively, to use a development snapshot from GitHub using [Bundler], add this to your `Gemfile`:
 
+~~~ ruby
+    gem 'mqtt', :github => 'njh/ruby-mqtt'
+~~~
 
 Quick Start
 -----------
 
 ~~~ ruby
-require 'rubygems'
 require 'mqtt'
 
 # Publish example
@@ -89,6 +89,15 @@ client.ca_file   = path_to('root-ca.pem')
 client.connect()
 ~~~
 
+The default timeout when opening a TCP Socket is 30 seconds. To specify it explicitly, use 'connect_timeout =>':
+
+~~~ ruby
+client = MQTT::Client.connect(
+  :host => 'myserver.example.com',
+  :connect_timeout => 15
+)
+~~~
+
 The connection can either be made without the use of a block:
 
 ~~~ ruby

data/lib/mqtt/client.rb

@@ -1,6 +1,5 @@
 autoload :OpenSSL, 'openssl'
 autoload :URI, 'uri'
-autoload :CGI, 'cgi'
 
 # Client class for talking to an MQTT server
 module MQTT
@@ -24,6 +23,9 @@ module MQTT
     # @see OpenSSL::SSL::SSLContext::METHODS
     attr_accessor :ssl
 
+    # Set to false to skip tls hostname verification
+    attr_accessor :verify_host
+
     # Time (in seconds) between pings to remote server (default is 15 seconds)
     attr_accessor :keep_alive
 
@@ -36,6 +38,9 @@ module MQTT
     # Number of seconds to wait for acknowledgement packets (default is 5 seconds)
     attr_accessor :ack_timeout
 
+    # Number of seconds to connect to the server (default is 90 seconds)
+    attr_accessor :connect_timeout
+
     # Username to authenticate to the server with
     attr_accessor :username
 
@@ -69,13 +74,15 @@ module MQTT
       :clean_session => true,
       :client_id => nil,
       :ack_timeout => 5,
+      :connect_timeout => 30,
       :username => nil,
       :password => nil,
       :will_topic => nil,
       :will_payload => nil,
       :will_qos => 0,
       :will_retain => false,
-      :ssl => false
+      :ssl => false,
+      :verify_host => true
     }
 
     # Create and connect a new MQTT Client
@@ -193,13 +200,13 @@ module MQTT
     # Set a path to a file containing a PEM-format client private key
     def key_file=(*args)
       path, passphrase = args.flatten
-      ssl_context.key = OpenSSL::PKey::RSA.new(File.open(path), passphrase)
+      ssl_context.key = OpenSSL::PKey.read(File.binread(path), passphrase)
     end
 
     # Set to a PEM-format client private key
     def key=(*args)
       cert, passphrase = args.flatten
-      ssl_context.key = OpenSSL::PKey::RSA.new(cert, passphrase)
+      ssl_context.key = OpenSSL::PKey.read(cert, passphrase)
     end
 
     # Set a path to a file containing a PEM-format CA certificate and enable peer verification
@@ -235,7 +242,7 @@ module MQTT
 
       unless connected?
         # Create network socket
-        tcp_socket = TCPSocket.new(@host, @port)
+        tcp_socket = open_tcp_socket
 
         if @ssl
           # Set the protocol version
@@ -248,6 +255,8 @@ module MQTT
           @socket.hostname = @host if @socket.respond_to?(:hostname=)
 
           @socket.connect
+
+          @socket.post_connection_check(@host) if @verify_host
         else
           @socket = tcp_socket
         end
@@ -326,14 +335,11 @@ module MQTT
         :payload => payload
       )
 
-      # Send the packet
-      res = send_packet(packet)
-
-      return if qos.zero?
+      queue = qos.zero? ? nil : wait_for_puback(packet.id)
 
-      queue = Queue.new
+      res = send_packet(packet)
 
-      wait_for_puback packet.id, queue
+      return unless queue
 
       deadline = current_time + @ack_timeout
 
@@ -473,7 +479,7 @@ module MQTT
       end
       keep_alive!
     # Pass exceptions up to parent thread
-    rescue Exception => exp
+    rescue ::Exception => exp
       unless @socket.nil?
         @socket.close
         @socket = nil
@@ -482,9 +488,9 @@ module MQTT
       Thread.current[:parent].raise(exp)
     end
 
-    def wait_for_puback(id, queue)
+    def wait_for_puback(id)
       @pubacks_semaphore.synchronize do
-        @pubacks[id] = queue
+        @pubacks[id] = Queue.new
       end
     end
 
@@ -496,7 +502,7 @@ module MQTT
         @last_ping_response = current_time
       elsif packet.class == MQTT::Packet::Puback
         @pubacks_semaphore.synchronize do
-          @pubacks[packet.id] << packet
+          @pubacks[packet.id] << packet if @pubacks[packet.id]
         end
       end
       # Ignore all other packets
@@ -585,8 +591,8 @@ module MQTT
       {
         :host => uri.host,
         :port => uri.port || nil,
-        :username => uri.user ? CGI.unescape(uri.user) : nil,
-        :password => uri.password ? CGI.unescape(uri.password) : nil,
+        :username => uri.user ? URI::DEFAULT_PARSER.unescape(uri.user) : nil,
+        :password => uri.password ? URI::DEFAULT_PARSER.unescape(uri.password) : nil,
         :ssl => ssl
       }
     end
@@ -597,6 +603,19 @@ module MQTT
       @last_packet_id
     end
 
+    def open_tcp_socket
+      return TCPSocket.new @host, @port, connect_timeout: @connect_timeout if RUBY_VERSION.to_f >= 3.0
+
+      begin
+        Timeout.timeout(@connect_timeout) do
+          return TCPSocket.new(@host, @port)
+        end
+      rescue Timeout::Error
+        raise IO::TimeoutError, "Connection timed out for \"#{@host}\" port #{@port}" if defined? IO::TimeoutError
+        raise Errno::ETIMEDOUT, "Connection timed out for \"#{@host}\" port #{@port}"
+      end
+    end
+
     # ---- Deprecated attributes and methods  ---- #
     public
 

data/lib/mqtt/packet.rb

@@ -445,7 +445,7 @@ module MQTT
       def initialize(args = {})
         super(ATTR_DEFAULTS.merge(args))
 
-        if version == '3.1.0' || version == '3.1'
+        if ['3.1.0', '3.1'].include?(version)
           self.protocol_name ||= 'MQIsdp'
           self.protocol_level ||= 0x03
         elsif version == '3.1.1'

data/lib/mqtt/version.rb

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

data/lib/mqtt.rb

@@ -7,11 +7,6 @@ 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

data/spec/mqtt_client_spec.rb

@@ -232,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
 
@@ -406,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)
@@ -415,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)
@@ -424,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)
@@ -434,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
@@ -592,11 +641,11 @@ describe MQTT::Client do
         @injected_pubacks[packet.id] = packet
       end
 
-      def wait_for_puback(id, queue)
+      def wait_for_puback(id)
         packet = @injected_pubacks.fetch(id) {
           return super
         }
-        queue << packet
+        Queue.new << packet
       end
     end
 
@@ -606,6 +655,19 @@ describe MQTT::Client 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
@@ -696,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
@@ -923,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
 

data/spec/mqtt_packet_spec.rb

@@ -382,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
 
@@ -391,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.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Nicholas J Humfrey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-17 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
@@ -108,7 +122,6 @@ files:
 - 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
@@ -137,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Implementation of the MQTT protocol

data/lib/mqtt/patches/string_encoding.rb

@@ -1,32 +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 = dup
-    new.force_encoding(encoding)
-  end
-end
-
-class Encoding
-  attr_reader :name
-
-  def initialize(name)
-    @name = name
-  end
-
-  def to_s
-    @name
-  end
-
-  UTF_8 = Encoding.new('UTF-8')
-  ASCII_8BIT = Encoding.new('ASCII-8BIT')
-end