mqtt-ccutrer 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b93bce8e1cc0e50a0161ac2447fbff2c293ad89f64dc98cb848e20026e754e3
-  data.tar.gz: 4b480e5ffb4df550469d112274f6c831b96f4a2118bb29e32940156b9dccce58
+  metadata.gz: c5586204c6a2b82ab49ccd6f6fc201612985566ac2b0a6580fc0144c83a3b06c
+  data.tar.gz: d38d819d114df28b8dbcbbd357e45fc213ba8932f46dbdcc8f368f8e69e627df
 SHA512:
-  metadata.gz: 3227b778e824d891845cab272ffe73f875ffe2de3440a56e1a3f73bffb5d6fa9edb41844665aead5411276c0241ef4f176fc369b98d1398c54bbdf78dc9103d9
-  data.tar.gz: 51254e256507a8c01dd9197266eed692ccad64c3a7b0baa8bbc3ec50350ea712bc2a8bbfd1b575fca4527d5fe4da0a706f33aa998a932aca8a517f5af40b6721
+  metadata.gz: 8025eeb04ed80c513422f7ebf57b45b16298eb4c226373ea179fb9cbea87be474c2befbd48a26ba4c912bddafa6a21e7f35c6ced815a6c634a7b31355b24c15f
+  data.tar.gz: 41c23b03d0911fffee6aad9abf50df5c1ac0203a3ab44cf16354120b5b6b6687ec62b8704951be4c14f41f98db00d450e464133a983604e40f9a885ad904d55f

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,19 +41,25 @@ 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
 
     # How many attempts to re-establish a connection after it drops before
-    # giving up (default 5)
+    # giving up (default 5); nil for unlimited retries
     attr_accessor :reconnect_limit
 
     # How long to wait between re-connection attempts (exponential - i.e.
     # immediately after first drop, then 5s, then 25s, then 125s, etc.
-    # when theis value defaults to 5)
+    # when this value defaults to 5)
     attr_accessor :reconnect_backoff
 
+    # the longest amount of time to wait before attempting a reconnect
+    attr_accessor :reconnect_backoff_max
+
     # Username to authenticate to the server with
     attr_accessor :username
 
@@ -73,21 +82,24 @@ 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: 5,
+      reconnect_backoff: 2,
+      reconnect_backoff_max: 30,
       username: nil,
       password: nil,
       will_topic: nil,
       will_payload: nil,
       will_qos: 0,
       will_retain: false,
-      ssl: false
+      ssl: false,
+      verify_host: true
     }.freeze
 
     # Create and connect a new MQTT Client
@@ -100,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
 
@@ -130,11 +142,14 @@ module MQTT
     #  client = MQTT::Client.new('myserver.example.com', 18830)
     #  client = MQTT::Client.new(host: 'myserver.example.com')
     #  client = MQTT::Client.new(host: 'myserver.example.com', keep_alive: 30)
+    #  client = MQTT::Client.new(uri: 'mqtt://myserver.example.com', keep_alive: 30)
     #
     def initialize(host = nil, port = nil, **attributes)
+      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
@@ -196,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
@@ -232,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
 
@@ -347,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
@@ -366,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
         )
 
@@ -408,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)
@@ -419,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
@@ -448,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
 
@@ -481,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
@@ -497,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
@@ -556,13 +574,14 @@ module MQTT
 
         retries = 0
         begin
-          connect_internal unless @reconnect_limit == 0
+          connect_internal unless @reconnect_limit.zero?
         rescue
           @socket&.close
           @socket = nil
+          retries += 1
 
-          if (retries += 1) < @reconnect_limit
-            sleep @reconnect_backoff ** retries
+          if @reconnect_limit.nil? || retries < @reconnect_limit
+            sleep [@reconnect_backoff**retries, @reconnect_backoff_max].min
             retry
           end
         end
@@ -582,7 +601,7 @@ module MQTT
       end
 
       begin
-        if @on_reconnect&.arity == 0
+        if @on_reconnect&.arity&.zero?
           @on_reconnect.call
         else
           @on_reconnect&.call(@connack)
@@ -624,7 +643,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
@@ -683,7 +702,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)
@@ -711,7 +730,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
@@ -756,20 +775,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
 
@@ -778,5 +797,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