mqtt 0.4.0 → 0.5.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Y2MwODVmNmViNWEyM2ViM2NkMDk1ODIzNzg3ZGJiM2EyYTdlZTJlMw==
-  data.tar.gz: !binary |-
-    OWI1ZGM5Yzk4OWZiZDBkMDY5ZDM5NTllMWQ3YzRhYTk3NThmNDY3Ng==
+SHA1:
+  metadata.gz: b740779b0a3780a38d3c673f47e512201329ccf7
+  data.tar.gz: 514676334d05c2affb8371b24d25c635efd829fb
 SHA512:
-  metadata.gz: !binary |-
-    NDg1ZTMxZTdkNjM2ZDk2ZmU0ZGRiYzcyNWI0ZDk1MWI1MGU3OTRmMmI3Yzkx
-    NmRiYzQ0NmE3NDlhNDQ1MDExNmY2OGM2NzNjYWNlMTAwODc0NDRiNzM3MDU1
-    YWYxYTYyNDdmZTUxNjI2YjM2ODU2ZTgxMGVhNjM1NjAwOWViY2I=
-  data.tar.gz: !binary |-
-    YzkwNjYyYzYxODgyYzZjZWU2MGZhMzQ0YWZhNWM3MTVhNzdjNTFjMjEzYWFj
-    OGMzN2NlYjNmYTdjYzVmODNhZDZmZGIzMDg4ZjBjYmY5MzljNzRlODljMjI0
-    NTI3OGRmZDhhODA0NDA2NDI5ZTBlYzhjZWE3MWJhNGQwYzE4OWQ=
+  metadata.gz: 162771d3087a48968de71863b569ed455bbc6a7f92a1370175db4237bec9b5625ce6b3b7d0997e98eb625bdd900e14cf564152bf35f48f04ea76f857dd3066e3
+  data.tar.gz: 2fa7f6b485082a7f830a063e5a829147ad419566b3ffe0d90a82e8024906b9d37861e97fe779f59fb3230d8309312f0fd17a4e3dd817dd4593dfdab697c03a67

data/NEWS.md

@@ -1,6 +1,21 @@
 Ruby MQTT NEWS
 ==============
 
+Ruby MQTT Version 0.5.0 (2016-04-16)
+------------------------------------
+
+* Switched default protocol version to 3.1.1
+* Added support for Server Name Identification (SNI)
+* Fix for unescaping user/password in URI
+* Fix for bug in MQTT::Proxy class
+* Add the ability to ignore retained packets when subscribed.
+* Fix problem of wrong Puback packet ID
+* Don't keepalive ping if disconnected
+* Immediately close socket after failed Connack
+* FakeServer improvements
+* Fix for working with mathn library.
+
+
 Ruby MQTT Version 0.4.0 (2016-06-27)
 ------------------------------------
 

data/lib/mqtt/client.rb

@@ -10,7 +10,7 @@ class MQTT::Client
   # Port number of the remote server
   attr_accessor :port
 
-  # The version number of the MQTT protocol to use (default 3.1.0)
+  # The version number of the MQTT protocol to use (default 3.1.1)
   attr_accessor :version
 
   # Set to true to enable SSL/TLS encrypted communication
@@ -64,7 +64,7 @@ class MQTT::Client
   ATTR_DEFAULTS = {
     :host => nil,
     :port => nil,
-    :version => '3.1.0',
+    :version => '3.1.1',
     :keep_alive => 15,
     :clean_session => true,
     :client_id => nil,
@@ -264,6 +264,12 @@ class MQTT::Client
 
         @socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, ssl_context)
         @socket.sync_close = true
+
+        # Set hostname on secure socket for Server Name Indication (SNI)
+        if @socket.respond_to?(:hostname=)
+          @socket.hostname = @host
+        end
+
         @socket.connect
       else
         @socket = tcp_socket
@@ -393,15 +399,17 @@ class MQTT::Client
   #     # Do stuff here
   #   end
   #
-  def get(topic=nil)
+  def get(topic=nil, options={})
     if block_given?
       get_packet(topic) do |packet|
-        yield(packet.topic, packet.payload)
+        yield(packet.topic, packet.payload) unless packet.retain && options[:omit_retained]
       end
     else
-      # Wait for one packet to be available
-      packet = get_packet(topic)
-      return packet.topic, packet.payload
+      loop do
+        # Wait for one packet to be available
+        packet = get_packet(topic)
+        return packet.topic, packet.payload unless packet.retain && options[:omit_retained]
+      end
     end
   end
 
@@ -500,7 +508,7 @@ private
   end
 
   def keep_alive!
-    if @keep_alive > 0
+    if @keep_alive > 0 && connected?
       response_timeout = (@keep_alive * 1.5).ceil
       if Time.now >= @last_ping_request + @keep_alive
         packet = MQTT::Packet::Pingreq.new
@@ -530,6 +538,9 @@ private
 
       # Check the return code
       if packet.return_code != 0x00
+        # 3.2.2.3 If a server sends a CONNACK packet containing a non-zero
+        # return code it MUST then close the Network Connection
+        @socket.close
         raise MQTT::ProtocolException.new(packet.return_msg)
       end
     end
@@ -560,8 +571,8 @@ private
     {
       :host => uri.host,
       :port => uri.port || nil,
-      :username => uri.user,
-      :password => uri.password,
+      :username => uri.user ? URI.unescape(uri.user) : nil,
+      :password => uri.password ? URI.unescape(uri.password) : nil,
       :ssl => ssl
     }
   end

data/lib/mqtt/packet.rb

@@ -194,7 +194,7 @@ module MQTT
       # Build up the body length field bytes
       begin
         digit = (body_length % 128)
-        body_length = (body_length / 128)
+        body_length = body_length.div(128)
         # if there are more digits to encode, set the top bit of this digit
         digit |= 0x80 if (body_length > 0)
         header.push(digit)

data/lib/mqtt/proxy.rb

@@ -95,19 +95,19 @@ class MQTT::Proxy
         # Iterate through each of the sockets with data to read
         if selected[0].include?(client_socket)
           packet = MQTT::Packet.read(client_socket)
-          logger.debug "client -> <#{packet.type}>"
+          logger.debug "client -> <#{packet.type_name}>"
           packet = @client_filter.call(packet) unless @client_filter.nil?
           unless packet.nil?
             server_socket.write(packet)
-            logger.debug "<#{packet.type}> -> server"
+            logger.debug "<#{packet.type_name}> -> server"
           end
         elsif selected[0].include?(server_socket)
           packet = MQTT::Packet.read(server_socket)
-          logger.debug "server -> <#{packet.type}>"
+          logger.debug "server -> <#{packet.type_name}>"
           packet = @server_filter.call(packet) unless @server_filter.nil?
           unless packet.nil?
             client_socket.write(packet)
-            logger.debug "<#{packet.type}> -> client"
+            logger.debug "<#{packet.type_name}> -> client"
           end
         else
           logger.error "Problem with select: socket is neither server or client"

data/lib/mqtt/version.rb

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

data/spec/mqtt_client_spec.rb

@@ -28,7 +28,7 @@ describe MQTT::Client 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 +117,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 +191,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 +339,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 +419,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 +454,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 +498,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 +530,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
@@ -595,7 +628,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) }
@@ -677,6 +710,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 +754,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
 
@@ -845,6 +899,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

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,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: mqtt
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Nicholas J Humfrey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2017-04-16 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.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.7
 - !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
 description: Pure Ruby gem that implements the MQTT protocol, a lightweight protocol
@@ -113,17 +113,17 @@ 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
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Implementation of the MQTT protocol
@@ -134,4 +134,3 @@ test_files:
 - spec/mqtt_sn_packet_spec.rb
 - spec/mqtt_version_spec.rb
 - spec/zz_client_integration_spec.rb
-has_rdoc: