mqtt-ccutrer 1.0.3 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c95449b66faaba1f857dbb64e535b2f4a8565a91a8611aa3b53d1b1a3c802f7d
-  data.tar.gz: 053ce243061cf20b3326d53e7fda9afaa82972d4029631e6e0857efc465e7bcf
+  metadata.gz: c0a41d0227405118d24d483405143974e08a6606f41990eb74e3061aeac0b8c6
+  data.tar.gz: bc82c7c0fed1835e290639c38d948fea328ef744df28536e9cd828777013594a
 SHA512:
-  metadata.gz: e465141738a3352c562474041f199a260496d9d499d81899613381de8521a9fb215bdde351b608ac9630a463b3fa2e2dd4cfe22046ab179926d0c657ffebaa08
-  data.tar.gz: 0b87b975e3c9a792f17dcc663c9aa0c0be764a6866eeeedb1a88ba9d38511f661995c412920d6798e580929317d4e633fdd744f33177fb7609c30542b4394e5d
+  metadata.gz: 7c630b2d5554bb36770598a0b3ae6ff470482ed43d1f6accf92eea9fc733efcd5d37dc595fe8b9dc982418612cd0a2a4ae7abc1ab22a6e8af137ee3c46b20c0a
+  data.tar.gz: 0b2167ca3b631389b650dab69acd1c272a935766bc4d5eb8b8d6848c5316f2a6ad930833b409c2dbbc3d2c82abca929ca4d9bb7128231bfb84daaa7322957006

data/README.md

@@ -1,5 +1,3 @@
-[![Build Status](https://travis-ci.org/njh/ruby-mqtt.svg)](https://travis-ci.org/ccutrer/ruby-mqtt)
-
 ruby-mqtt
 =========
 
@@ -84,6 +82,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,8 +1,8 @@
 # frozen_string_literal: true
 
-autoload :OpenSSL, 'openssl'
-autoload :SecureRandom, 'securerandom'
-autoload :URI, 'uri'
+autoload :OpenSSL, "openssl"
+autoload :SecureRandom, "securerandom"
+autoload :URI, "uri"
 
 # Client class for talking to an MQTT server
 module MQTT
@@ -26,6 +26,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
 
@@ -38,6 +41,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
+
     # How many times to attempt re-sending packets that weren't acknowledged
     # (default is 5) before giving up
     attr_accessor :resend_limit
@@ -76,11 +82,12 @@ module MQTT
     ATTR_DEFAULTS = {
       host: nil,
       port: nil,
-      version: '3.1.1',
+      version: "3.1.1",
       keep_alive: 15,
       clean_session: true,
       client_id: nil,
       ack_timeout: 5,
+      connect_timeout: 30,
       resend_limit: 5,
       reconnect_limit: 5,
       reconnect_backoff: 2,
@@ -91,7 +98,8 @@ module MQTT
       will_payload: nil,
       will_qos: 0,
       will_retain: false,
-      ssl: false
+      ssl: false,
+      verify_host: true
     }.freeze
 
     # Create and connect a new MQTT Client
@@ -104,15 +112,15 @@ module MQTT
     #    # do stuff here
     #  end
     #
-    def self.connect(*args, &block)
+    def self.connect(*args, &)
       client = MQTT::Client.new(*args)
-      client.connect(&block)
+      client.connect(&)
       client
     end
 
     # Generate a random client identifier
     # (using the characters 0-9 and a-z)
-    def self.generate_client_id(prefix = 'ruby', length = 16)
+    def self.generate_client_id(prefix = "ruby", length = 16)
       "#{prefix}#{SecureRandom.alphanumeric(length).downcase}"
     end
 
@@ -140,8 +148,8 @@ module MQTT
       host = attributes.delete(:uri) if attributes.key?(:uri)
 
       # Set server URI from environment if present
-      if host.nil? && port.nil? && attributes.empty? && ENV['MQTT_SERVER']
-        attributes.merge!(parse_uri(ENV['MQTT_SERVER']))
+      if host.nil? && port.nil? && attributes.empty? && ENV["MQTT_SERVER"]
+        attributes.merge!(parse_uri(ENV["MQTT_SERVER"]))
       end
 
       if host
@@ -203,13 +211,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
@@ -239,13 +247,13 @@ module MQTT
       end
 
       if @client_id.nil? || @client_id.empty?
-        raise 'Must provide a client_id if clean_session is set to false' unless @clean_session
+        raise "Must provide a client_id if clean_session is set to false" unless @clean_session
 
         # Empty client id is not allowed for version 3.1.0
-        @client_id = MQTT::Client.generate_client_id if @version == '3.1.0'
+        @client_id = MQTT::Client.generate_client_id if @version == "3.1.0"
       end
 
-      raise ArgumentError, 'No MQTT server host set when attempting to connect' if @host.nil?
+      raise ArgumentError, "No MQTT server host set when attempting to connect" if @host.nil?
 
       connect_internal
 
@@ -354,12 +362,12 @@ module MQTT
     # Publish a message on a particular topic to the MQTT server.
     def publish(topics, payload = nil, retain: false, qos: 0)
       if topics.is_a?(Hash) && !payload.nil?
-        raise ArgumentError, 'Payload cannot be passed if passing a hash for topics and payloads'
+        raise ArgumentError, "Payload cannot be passed if passing a hash for topics and payloads"
       end
       raise NotConnectedException unless connected?
 
       if @batch_publish && qos != 0
-        values = @batch_publish[{ retain: retain, qos: qos }] ||= {}
+        values = @batch_publish[{ retain:, qos: }] ||= {}
         if topics.is_a?(Hash)
           values.merge!(topics)
         else
@@ -373,14 +381,14 @@ module MQTT
       topics = { topics => payload } unless topics.is_a?(Hash)
 
       topics.each do |(topic, topic_payload)|
-        raise ArgumentError, 'Topic name cannot be nil' if topic.nil?
-        raise ArgumentError, 'Topic name cannot be empty' if topic.empty?
+        raise ArgumentError, "Topic name cannot be nil" if topic.nil?
+        raise ArgumentError, "Topic name cannot be empty" if topic.empty?
 
         packet = MQTT::Packet::Publish.new(
           id: next_packet_id,
-          qos: qos,
-          retain: retain,
-          topic: topic,
+          qos:,
+          retain:,
+          topic:,
           payload: topic_payload
         )
 
@@ -415,7 +423,7 @@ module MQTT
 
       packet = MQTT::Packet::Subscribe.new(
         id: next_packet_id,
-        topics: topics
+        topics:
       )
       token = register_for_ack(packet) if wait_for_ack
       send_packet(packet)
@@ -426,10 +434,10 @@ module MQTT
     def unsubscribe(*topics, wait_for_ack: false)
       raise NotConnectedException unless connected?
 
-      topics = topics.first if topics.is_a?(Enumerable) && topics.count == 1
+      topics = topics.first if topics.is_a?(Enumerable) && topics.one?
 
       packet = MQTT::Packet::Unsubscribe.new(
-        topics: topics,
+        topics:,
         id: next_packet_id
       )
       token = register_for_ack(packet) if wait_for_ack
@@ -455,18 +463,18 @@ module MQTT
         packet = @read_queue.pop
         if packet.is_a?(Array) && packet.last >= loop_start
           e = packet.first
-          e.set_backtrace((e.backtrace || []) + ['<from MQTT worker thread>'] + caller)
+          e.set_backtrace((e.backtrace || []) + ["<from MQTT worker thread>"] + caller)
           raise e
         end
         next unless packet.is_a?(Packet)
 
         unless block_given?
-          puback_packet(packet) if packet.qos > 0
+          puback_packet(packet) if packet.qos.positive?
           return packet
         end
 
         yield packet
-        puback_packet(packet) if packet.qos > 0
+        puback_packet(packet) if packet.qos.positive?
       end
     end
 
@@ -488,10 +496,11 @@ module MQTT
     private
 
     PendingAck = Struct.new(:packet, :queue, :timeout_at, :send_count)
+    private_constant :PendingAck
 
     def connect_internal
       # Create network socket
-      tcp_socket = TCPSocket.new(@host, @port)
+      tcp_socket = open_tcp_socket
 
       if @ssl
         # Set the protocol version
@@ -504,6 +513,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
@@ -561,28 +572,32 @@ module MQTT
         should_exit = Thread.current == @read_thread
         @read_thread = @write_thread = nil
 
+        # Clear pending acks from the old connection. Their packets were
+        # sent (or queued) on a now-dead socket, so the broker will never
+        # acknowledge them. Unblock any threads waiting in wait_for_ack.
+        @acks_mutex.synchronize do
+          @acks.each_value do |pending_ack|
+            pending_ack.queue << :close
+          end
+          @acks.clear
+        end
+
         retries = 0
         begin
-          connect_internal unless @reconnect_limit == 0
+          connect_internal unless @reconnect_limit&.zero?
         rescue
           @socket&.close
           @socket = nil
           retries += 1
 
           if @reconnect_limit.nil? || retries < @reconnect_limit
-            sleep [@reconnect_backoff ** retries, @reconnect_backoff_max].min
+            sleep [@reconnect_backoff**retries, @reconnect_backoff_max].min
             retry
           end
         end
 
         unless @socket
           # couldn't reconnect
-          @acks_mutex.synchronize do
-            @acks.each_value do |pending_ack|
-              pending_ack.queue << :close
-            end
-            @acks.clear
-          end
           @connected = false
           @read_queue << [exception, current_time]
           return
@@ -590,7 +605,7 @@ module MQTT
       end
 
       begin
-        if @on_reconnect&.arity == 0
+        if @on_reconnect&.arity&.zero?
           @on_reconnect.call
         else
           @on_reconnect&.call(@connack)
@@ -611,7 +626,7 @@ module MQTT
 
       # we just needed to break out of our select to set up a new timeout;
       # we can discard the actual contents
-      @wake_up_pipe[0].readpartial(4096) if read_ready&.include?(@wake_up_pipe[0])
+      @wake_up_pipe[0].read_nonblock(4096, exception: false) if read_ready&.include?(@wake_up_pipe[0])
 
       handle_timeouts
 
@@ -632,7 +647,7 @@ module MQTT
       @acks_mutex.synchronize do
         if @acks.empty?
           # just need to wake up the read thread to set up the timeout for this packet
-          @wake_up_pipe[1].write('z')
+          @wake_up_pipe[1].write("z")
         end
         @acks[packet.id] = PendingAck.new(packet, queue, timeout_at, 1)
       end
@@ -691,7 +706,7 @@ module MQTT
         return
       end
       # timed out, or simple re-send
-      @wake_up_pipe[1].write('z') if @acks.first.first == packet.id
+      @wake_up_pipe[1].write("z") if @acks.first.first == packet.id
       pending_ack.timeout_at = current_time + @ack_timeout
       packet.duplicate = true
       send_packet(packet)
@@ -719,7 +734,7 @@ module MQTT
     end
 
     def handle_keep_alives
-      return unless @keep_alive && @keep_alive > 0
+      return unless @keep_alive&.positive?
 
       current_time_local = current_time
       if current_time_local >= @last_packet_sent_at + @keep_alive && !@keep_alive_sent
@@ -764,20 +779,20 @@ module MQTT
     def parse_uri(uri)
       uri = URI.parse(uri) unless uri.is_a?(URI)
       ssl = case uri.scheme
-            when 'mqtt'
+            when "mqtt"
               false
-            when 'mqtts'
+            when "mqtts"
               true
             else
-              raise 'Only the mqtt:// and mqtts:// schemes are supported'
+              raise "Only the mqtt:// and mqtts:// schemes are supported"
             end
 
       {
         host: uri.host,
         port: uri.port || nil,
-        username: uri.user ? URI::Parser.new.unescape(uri.user) : nil,
-        password: uri.password ? URI::Parser.new.unescape(uri.password) : nil,
-        ssl: ssl
+        username: uri.user ? URI::RFC2396_PARSER.unescape(uri.user) : nil,
+        password: uri.password ? URI::RFC2396_PARSER.unescape(uri.password) : nil,
+        ssl:
       }
     end
 
@@ -786,5 +801,18 @@ module MQTT
       @last_packet_id = 1 if @last_packet_id > 0xffff
       @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 (defined?(IO::TimeoutError) ? IO::TimeoutError : Errno::ETIMEDOUT),
+              "Connection timed out for \"#{@host}\" port #{@port}"
+      end
+    end
   end
 end