qubitro-mqtt 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65a25771b798460c0e6bb0139e663b03b25b70e3523571c99d3dfc321c9946d9
-  data.tar.gz: aa84a5c562e2982ed348c0495ade1740a365defdbad831dde547b2e1a28086c2
+  metadata.gz: 7e45bcfabd6e2367a012443f034589db3f5b2c77c3c094194b9c5f40fbde2ffd
+  data.tar.gz: 033462023ec38750bef3e354254ac9695a6fa4498aca320792e8669a8ece2dd3
 SHA512:
-  metadata.gz: ab8f325bcbf975c8bc14c42437dced1b3527434148d7e62c99715a5c3dd69b83c226ba5bd694b22c983e18a63ad927340e28192288ecec5de090c3dba5ed6564
-  data.tar.gz: bf49a922afd337facc796c78fdf6a1aec8f7aebd02a0289e6728d23449684372634abba2e7604af22d31f062708dcc8e1bd0f3c897c6d51220ab6d6741cac722
+  metadata.gz: b214109e69f71238e59479e284b09bf49cffaca0ec9b47555f5d37c0d69455395782a758518783119ca7063f53c79afa38d134db8da12507a46b5088d46db5f8
+  data.tar.gz: 66fade5d90ac5c4fc5575da1957778a0589364aa3d57af3ed051cc7f60b903d702c6d5c88cd2fa39ab0c48c85c3660dd01c3f846f0e6d2254da828118b3b0e98

data/lib/qubitro-mqtt/client.rb

@@ -35,11 +35,11 @@ module MQTT
     # Number of seconds to wait for acknowledgement packets (default is 5 seconds)
     attr_accessor :ack_timeout
 
-    # Username to authenticate to the server with
-    attr_accessor :username
+    # Device ID to authenticate to the server with
+    attr_accessor :deviceId
 
-    # Password to authenticate to the server with
-    attr_accessor :password
+    # Device Token to authenticate to the server with
+    attr_accessor :deviceToken
 
     # The topic that the Will message is published to
     attr_accessor :will_topic
@@ -68,8 +68,8 @@ module MQTT
       :clean_session => true,
       :client_id => nil,
       :ack_timeout => 5,
-      :username => nil,
-      :password => nil,
+      :deviceId => nil,
+      :deviceToken => nil,
       :will_topic => nil,
       :will_payload => nil,
       :will_qos => 0,
@@ -252,8 +252,8 @@ module MQTT
           :clean_session => @clean_session,
           :keep_alive => @keep_alive,
           :client_id => @client_id,
-          :username => @username,
-          :password => @password,
+          :deviceId => @deviceId,
+          :deviceToken => @deviceToken,
           :will_topic => @will_topic,
           :will_payload => @will_payload,
           :will_qos => @will_qos,
@@ -579,8 +579,8 @@ module MQTT
       {
         :host => uri.host,
         :port => uri.port || nil,
-        :username => uri.user ? URI.unescape(uri.user) : nil,
-        :password => uri.password ? URI.unescape(uri.password) : nil,
+        :deviceId => uri.user ? URI.unescape(uri.user) : nil,
+        :deviceToken => uri.password ? URI.unescape(uri.password) : nil,
         :ssl => ssl
       }
     end

data/lib/qubitro-mqtt/packet.rb

@@ -422,11 +422,11 @@ module MQTT
         # The payload of the Will message
         attr_accessor :will_payload
   
-        # The username for authenticating with the server
-        attr_accessor :username
+        # The deviceId for authenticating with the server
+        attr_accessor :deviceId
   
-        # The password for authenticating with the server
-        attr_accessor :password
+        # The deviceToken for authenticating with the server
+        attr_accessor :deviceToken
   
         # Default attribute values
         ATTR_DEFAULTS = {
@@ -438,8 +438,8 @@ module MQTT
           :ack_timeout => 15,
           :will_retain => false,
           :will_payload => '',
-          :username => nil,
-          :password => nil
+          :deviceId => nil,
+          :deviceToken => nil
         }
   
         # Create a new Client Connect packet
@@ -479,8 +479,8 @@ module MQTT
           @connect_flags |= 0x04 unless @will_topic.nil?
           @connect_flags |= ((@will_qos & 0x03) << 3)
           @connect_flags |= 0x20 if @will_retain
-          @connect_flags |= 0x40 unless @password.nil?
-          @connect_flags |= 0x80 unless @username.nil?
+          @connect_flags |= 0x40 unless @deviceToken.nil?
+          @connect_flags |= 0x80 unless @deviceId.nil?
           body += encode_bytes(@connect_flags)
   
           body += encode_short(@keep_alive)
@@ -490,8 +490,8 @@ module MQTT
             # The MQTT v3.1 specification says that the payload is a UTF-8 string
             body += encode_string(@will_payload)
           end
-          body += encode_string(@username) unless @username.nil?
-          body += encode_string(@password) unless @password.nil?
+          body += encode_string(@deviceId) unless @deviceId.nil?
+          body += encode_string(@deviceToken) unless @deviceToken.nil?
           body
         end
   
@@ -521,10 +521,10 @@ module MQTT
             @will_payload = shift_string(buffer)
           end
           if ((@connect_flags & 0x80) >> 7) == 0x01 && buffer.bytesize > 0
-            @username = shift_string(buffer)
+            @deviceId = shift_string(buffer)
           end
           if ((@connect_flags & 0x40) >> 6) == 0x01 && buffer.bytesize > 0 # rubocop: disable Style/GuardClause
-            @password = shift_string(buffer)
+            @deviceToken = shift_string(buffer)
           end
         end
   
@@ -534,8 +534,8 @@ module MQTT
                 "keep_alive=#{keep_alive}"
           str += ', clean' if clean_session
           str += ", client_id='#{client_id}'"
-          str += ", username='#{username}'" unless username.nil?
-          str += ', password=...' unless password.nil?
+          str += ", deviceId='#{deviceId}'" unless deviceId.nil?
+          str += ', deviceToken=...' unless deviceToken.nil?
           str + '>'
         end
   

data/lib/qubitro-mqtt/version.rb

@@ -1,5 +1,5 @@
 module MQTT
     # The version number of the MQTT gem
-    VERSION = '0.0.6'
+    VERSION = '0.0.7'
   end
   

data/spec/mqtt_client_spec.rb

@@ -109,28 +109,28 @@ describe MQTT::Client do
       expect(client.ssl).to be_truthy
     end
 
-    it "with a URI containing a username and password" do
+    it "with a URI containing a deviceId and deviceToken" do
       client = MQTT::Client.new(URI.parse('mqtt://auser:bpass@mqtt.example.com'))
       expect(client.host).to eq('mqtt.example.com')
       expect(client.port).to eq(1883)
-      expect(client.username).to eq('auser')
-      expect(client.password).to eq('bpass')
+      expect(client.deviceId).to eq('auser')
+      expect(client.deviceToken).to eq('bpass')
     end
 
-    it "with a URI containing an escaped username and password" do
+    it "with a URI containing an escaped deviceId and deviceToken" 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+%')
+      expect(client.deviceId).to eq('foo bar')
+      expect(client.deviceToken).to eq('@123+%')
     end
 
-    it "with a URI containing a double escaped username and password" do
+    it "with a URI containing a double escaped deviceId and deviceToken" 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')
+      expect(client.deviceId).to eq('foo%20bar')
+      expect(client.deviceToken).to eq('123%25')
     end
 
     it "with a URI as a string" do
@@ -334,17 +334,17 @@ describe MQTT::Client do
       client.connect('myclient')
     end
 
-    it "should include the username and password for an authenticated connection" do
-      client.username = 'username'
-      client.password = 'password'
+    it "should include the deviceId and deviceToken for an authenticated connection" do
+      client.deviceId = 'deviceId'
+      client.deviceToken = 'deviceToken'
       client.connect('myclient')
       expect(socket.string).to eq(
         "\x10\x28"+
         "\x00\x04MQTT"+
         "\x04\xC2\x00\x0f"+
         "\x00\x08myclient"+
-        "\x00\x08username"+
-        "\x00\x08password"
+        "\x00\x08deviceId"+
+        "\x00\x08deviceToken"
       )
     end
 

data/spec/mqtt_packet_spec.rb

@@ -541,19 +541,19 @@ describe MQTT::Packet::Connect do
       )
     end
 
-    it "should output the correct bytes for a packet with a username and password" do
+    it "should output the correct bytes for a packet with a deviceId and deviceToken" do
       packet = MQTT::Packet::Connect.new(
         :client_id => 'myclient',
-        :username => 'username',
-        :password => 'password'
+        :deviceId => 'deviceId',
+        :deviceToken => 'deviceToken'
       )
       expect(packet.to_s).to eq(
         "\x10\x2A"+
         "\x00\x06MQIsdp"+
         "\x03\xC2\x00\x0f"+
         "\x00\x08myclient"+
-        "\x00\x08username"+
-        "\x00\x08password"
+        "\x00\x08deviceId"+
+        "\x00\x08deviceToken"
       )
     end
 
@@ -566,8 +566,8 @@ describe MQTT::Packet::Connect do
         :will_retain => true,
         :will_topic => 'will_topic',
         :will_payload => 'will_message',
-        :username => 'user0123456789',
-        :password => 'pass0123456789'
+        :deviceId => 'user0123456789',
+        :deviceToken => 'pass0123456789'
       )
       expect(packet.to_s).to eq(
         "\x10\x5F"+ # fixed header (2)
@@ -577,9 +577,9 @@ describe MQTT::Packet::Connect do
         "\x00\x1712345678901234567890123"+ # client identifier (25)
         "\x00\x0Awill_topic"+ # will topic (12)
         "\x00\x0Cwill_message"+ # will message (14)
-        "\x00\x0Euser0123456789"+ # username (16)
+        "\x00\x0Euser0123456789"+ # deviceId (16)
         "\x00\x0Epass0123456789"
-      )  # password (16)
+      )  # deviceToken (16)
     end
 
     context 'protocol version 3.1.1' do
@@ -643,12 +643,12 @@ describe MQTT::Packet::Connect do
       expect(packet.clean_session).to be_falsey
     end
 
-    it "should set the the username field of the packet to nil" do
-      expect(packet.username).to be_nil
+    it "should set the the deviceId field of the packet to nil" do
+      expect(packet.deviceId).to be_nil
     end
 
-    it "should set the the password field of the packet to nil" do
-      expect(packet.password).to be_nil
+    it "should set the the deviceToken field of the packet to nil" do
+      expect(packet.deviceToken).to be_nil
     end
   end
 
@@ -693,12 +693,12 @@ describe MQTT::Packet::Connect do
       expect(packet.clean_session).to be_falsey
     end
 
-    it "should set the the username field of the packet to nil" do
-      expect(packet.username).to be_nil
+    it "should set the the deviceId field of the packet to nil" do
+      expect(packet.deviceId).to be_nil
     end
 
-    it "should set the the password field of the packet to nil" do
-      expect(packet.password).to be_nil
+    it "should set the the deviceToken field of the packet to nil" do
+      expect(packet.deviceToken).to be_nil
     end
   end
 
@@ -770,15 +770,15 @@ describe MQTT::Packet::Connect do
     end
   end
 
-  describe "when parsing a Connect packet with a username and password" do
+  describe "when parsing a Connect packet with a deviceId and deviceToken" do
     let(:packet) do
       MQTT::Packet.parse(
         "\x10\x2A"+
         "\x00\x06MQIsdp"+
         "\x03\xC0\x00\x0a"+
         "\x00\x08myclient"+
-        "\x00\x08username"+
-        "\x00\x08password"
+        "\x00\x08deviceId"+
+        "\x00\x08deviceToken"
       )
     end
 
@@ -812,64 +812,64 @@ describe MQTT::Packet::Connect do
       expect(packet.keep_alive).to eq(10)
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.username).to eq('username')
-      expect(packet.username.encoding.to_s).to eq('UTF-8')
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceId).to eq('deviceId')
+      expect(packet.deviceId.encoding.to_s).to eq('UTF-8')
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.password).to eq('password')
-      expect(packet.password.encoding.to_s).to eq('UTF-8')
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceToken).to eq('deviceToken')
+      expect(packet.deviceToken.encoding.to_s).to eq('UTF-8')
     end
   end
 
-  describe "when parsing a Connect that has a username but no password" do
+  describe "when parsing a Connect that has a deviceId but no deviceToken" do
     let(:packet) do
       MQTT::Packet.parse(
-        "\x10\x20\x00\x06MQIsdp\x03\x80\x00\x0a\x00\x08myclient\x00\x08username"
+        "\x10\x20\x00\x06MQIsdp\x03\x80\x00\x0a\x00\x08myclient\x00\x08deviceId"
       )
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.username).to eq('username')
-      expect(packet.username.encoding.to_s).to eq('UTF-8')
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceId).to eq('deviceId')
+      expect(packet.deviceId.encoding.to_s).to eq('UTF-8')
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.password).to be_nil
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceToken).to be_nil
     end
   end
 
-  describe "when parsing a Connect that has a password but no username" do
+  describe "when parsing a Connect that has a deviceToken but no deviceId" do
     let(:packet) do
       MQTT::Packet.parse(
-        "\x10\x20\x00\x06MQIsdp\x03\x40\x00\x0a\x00\x08myclient\x00\x08password"
+        "\x10\x20\x00\x06MQIsdp\x03\x40\x00\x0a\x00\x08myclient\x00\x08deviceToken"
       )
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.username).to be_nil
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceId).to be_nil
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.password).to eq('password')
-      expect(packet.password.encoding.to_s).to eq('UTF-8')
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceToken).to eq('deviceToken')
+      expect(packet.deviceToken.encoding.to_s).to eq('UTF-8')
     end
   end
 
-  describe "when parsing a Connect packet has the username and password flags set but doesn't have the fields" do
+  describe "when parsing a Connect packet has the deviceId and deviceToken flags set but doesn't have the fields" do
     let(:packet) do
       MQTT::Packet.parse(
         "\x10\x16\x00\x06MQIsdp\x03\xC0\x00\x0a\x00\x08myclient"
       )
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.username).to be_nil
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceId).to be_nil
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.password).to be_nil
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceToken).to be_nil
     end
   end
 
@@ -883,8 +883,8 @@ describe MQTT::Packet::Connect do
         "\x00\x1712345678901234567890123"+ # client identifier (25)
         "\x00\x0Awill_topic"+ # will topic (12)
         "\x00\x0Cwill_message"+ # will message (14)
-        "\x00\x0Euser0123456789"+ # username (16)
-        "\x00\x0Epass0123456789"  # password (16)
+        "\x00\x0Euser0123456789"+ # deviceId (16)
+        "\x00\x0Epass0123456789"  # deviceToken (16)
       )
     end
 
@@ -936,14 +936,14 @@ describe MQTT::Packet::Connect do
       expect(packet.will_payload.encoding.to_s).to eq('UTF-8')
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.username).to eq('user0123456789')
-      expect(packet.username.encoding.to_s).to eq('UTF-8')
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceId).to eq('user0123456789')
+      expect(packet.deviceId.encoding.to_s).to eq('UTF-8')
     end
 
-    it "should set the Username of the packet correctly" do
-      expect(packet.password).to eq('pass0123456789')
-      expect(packet.password.encoding.to_s).to eq('UTF-8')
+    it "should set the Device ID of the packet correctly" do
+      expect(packet.deviceToken).to eq('pass0123456789')
+      expect(packet.deviceToken.encoding.to_s).to eq('UTF-8')
     end
   end
 
@@ -997,9 +997,9 @@ describe MQTT::Packet::Connect do
         :keep_alive => 10,
         :client_id => 'c123',
         :clean_session => false,
-        :username => 'foo'
+        :deviceId => 'foo'
       )
-      expect(packet.inspect).to eq("#<MQTT::Packet::Connect: keep_alive=10, client_id='c123', username='foo'>")
+      expect(packet.inspect).to eq("#<MQTT::Packet::Connect: keep_alive=10, client_id='c123', deviceId='foo'>")
     end
   end
 
@@ -1167,7 +1167,7 @@ describe MQTT::Packet::Connack do
     end
 
     it "should set the return message of the packet correctly" do
-      expect(packet.return_msg).to match(/bad user name or password/i)
+      expect(packet.return_msg).to match(/bad user name or deviceToken/i)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qubitro-mqtt
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Qubitro