qubitro-mqtt 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e45bcfabd6e2367a012443f034589db3f5b2c77c3c094194b9c5f40fbde2ffd
-  data.tar.gz: 033462023ec38750bef3e354254ac9695a6fa4498aca320792e8669a8ece2dd3
+  metadata.gz: f2e4b91db5fac6376f66460d1795edf045786007175bc20b8287969c7dceee3c
+  data.tar.gz: 5a0abdbea64055edc89b1ee60aa9ddbba72b9edeea4a88984a78aae6a4a6dc9d
 SHA512:
-  metadata.gz: b214109e69f71238e59479e284b09bf49cffaca0ec9b47555f5d37c0d69455395782a758518783119ca7063f53c79afa38d134db8da12507a46b5088d46db5f8
-  data.tar.gz: 66fade5d90ac5c4fc5575da1957778a0589364aa3d57af3ed051cc7f60b903d702c6d5c88cd2fa39ab0c48c85c3660dd01c3f846f0e6d2254da828118b3b0e98
+  metadata.gz: e48dc2860e57e06bac949dd445cad1ff3246fcf52fdbb3cf7a55535dffedcfae5f8d8ce4b6e4aedee3a5ac94a32e782028f18803579f7ba40f8562cf402aab8a
+  data.tar.gz: 4eda7f542d58438ec6cd799a7ea20b1f523f2515bbbefff65783cf8875d6ece23ba521ba22fdb7dc446d656ebf89d4f947205220265527ebd93e9ed94184944f

data/README.md

@@ -15,8 +15,8 @@ MQTT::Client.connect(
   :host => host,
   :port => 1883,
   :client_id => deviceID,
-  :username => deviceID,
-  :password => deviceToken,
+  :device_id => deviceID,
+  :device_token => device_token,
   :ack_timeout => 15,
   :will_topic => deviceID,
   :will_payload => payload,

data/lib/qubitro-mqtt/client.rb

@@ -36,10 +36,10 @@ module MQTT
     attr_accessor :ack_timeout
 
     # Device ID to authenticate to the server with
-    attr_accessor :deviceId
+    attr_accessor :device_id
 
     # Device Token to authenticate to the server with
-    attr_accessor :deviceToken
+    attr_accessor :device_token
 
     # 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,
-      :deviceId => nil,
-      :deviceToken => nil,
+      :device_id => nil,
+      :device_token => 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,
-          :deviceId => @deviceId,
-          :deviceToken => @deviceToken,
+          :device_id => @device_id,
+          :device_token => @device_token,
           :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,
-        :deviceId => uri.user ? URI.unescape(uri.user) : nil,
-        :deviceToken => uri.password ? URI.unescape(uri.password) : nil,
+        :device_id => uri.device_id ? URI.unescape(uri.device_id) : nil,
+        :device_token => uri.device_token ? URI.unescape(uri.device_token) : 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 deviceId for authenticating with the server
-        attr_accessor :deviceId
+        # The device_id for authenticating with the server
+        attr_accessor :device_id
   
-        # The deviceToken for authenticating with the server
-        attr_accessor :deviceToken
+        # The device_token for authenticating with the server
+        attr_accessor :device_token
   
         # Default attribute values
         ATTR_DEFAULTS = {
@@ -438,8 +438,8 @@ module MQTT
           :ack_timeout => 15,
           :will_retain => false,
           :will_payload => '',
-          :deviceId => nil,
-          :deviceToken => nil
+          :device_id => nil,
+          :device_token => 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 @deviceToken.nil?
-          @connect_flags |= 0x80 unless @deviceId.nil?
+          @connect_flags |= 0x40 unless @device_token.nil?
+          @connect_flags |= 0x80 unless @device_id.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(@deviceId) unless @deviceId.nil?
-          body += encode_string(@deviceToken) unless @deviceToken.nil?
+          body += encode_string(@device_id) unless @device_id.nil?
+          body += encode_string(@device_token) unless @device_token.nil?
           body
         end
   
@@ -521,10 +521,10 @@ module MQTT
             @will_payload = shift_string(buffer)
           end
           if ((@connect_flags & 0x80) >> 7) == 0x01 && buffer.bytesize > 0
-            @deviceId = shift_string(buffer)
+            @device_id = shift_string(buffer)
           end
           if ((@connect_flags & 0x40) >> 6) == 0x01 && buffer.bytesize > 0 # rubocop: disable Style/GuardClause
-            @deviceToken = shift_string(buffer)
+            @device_token = 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 += ", deviceId='#{deviceId}'" unless deviceId.nil?
-          str += ', deviceToken=...' unless deviceToken.nil?
+          str += ", device_id='#{device_id}'" unless device_id.nil?
+          str += ', device_token=...' unless device_token.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.7'
+    VERSION = '0.0.8'
   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 deviceId and deviceToken" do
+    it "with a URI containing a device_id and device_token" 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.deviceId).to eq('auser')
-      expect(client.deviceToken).to eq('bpass')
+      expect(client.device_id).to eq('auser')
+      expect(client.device_token).to eq('bpass')
     end
 
-    it "with a URI containing an escaped deviceId and deviceToken" do
+    it "with a URI containing an escaped device_id and device_token" 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.deviceId).to eq('foo bar')
-      expect(client.deviceToken).to eq('@123+%')
+      expect(client.device_id).to eq('foo bar')
+      expect(client.device_token).to eq('@123+%')
     end
 
-    it "with a URI containing a double escaped deviceId and deviceToken" do
+    it "with a URI containing a double escaped device_id and device_token" 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.deviceId).to eq('foo%20bar')
-      expect(client.deviceToken).to eq('123%25')
+      expect(client.device_id).to eq('foo%20bar')
+      expect(client.device_token).to eq('123%25')
     end
 
     it "with a URI as a string" do
@@ -334,9 +334,9 @@ describe MQTT::Client do
       client.connect('myclient')
     end
 
-    it "should include the deviceId and deviceToken for an authenticated connection" do
-      client.deviceId = 'deviceId'
-      client.deviceToken = 'deviceToken'
+    it "should include the device_id and device_token for an authenticated connection" do
+      client.device_id = 'device_id'
+      client.device_token = 'device_token'
       client.connect('myclient')
       expect(socket.string).to eq(
         "\x10\x28"+

data/spec/mqtt_packet_spec.rb

@@ -541,11 +541,11 @@ describe MQTT::Packet::Connect do
       )
     end
 
-    it "should output the correct bytes for a packet with a deviceId and deviceToken" do
+    it "should output the correct bytes for a packet with a device_id and device_token" do
       packet = MQTT::Packet::Connect.new(
         :client_id => 'myclient',
-        :deviceId => 'deviceId',
-        :deviceToken => 'deviceToken'
+        :device_id => 'device_id',
+        :device_token => 'device_token'
       )
       expect(packet.to_s).to eq(
         "\x10\x2A"+
@@ -566,8 +566,8 @@ describe MQTT::Packet::Connect do
         :will_retain => true,
         :will_topic => 'will_topic',
         :will_payload => 'will_message',
-        :deviceId => 'user0123456789',
-        :deviceToken => 'pass0123456789'
+        :device_id => 'user0123456789',
+        :device_token => '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"+ # deviceId (16)
+        "\x00\x0Euser0123456789"+ # device_id (16)
         "\x00\x0Epass0123456789"
-      )  # deviceToken (16)
+      )  # device_token (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 deviceId field of the packet to nil" do
-      expect(packet.deviceId).to be_nil
+    it "should set the the device_id field of the packet to nil" do
+      expect(packet.device_id).to be_nil
     end
 
-    it "should set the the deviceToken field of the packet to nil" do
-      expect(packet.deviceToken).to be_nil
+    it "should set the the device_token field of the packet to nil" do
+      expect(packet.device_token).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 deviceId field of the packet to nil" do
-      expect(packet.deviceId).to be_nil
+    it "should set the the device_id field of the packet to nil" do
+      expect(packet.device_id).to be_nil
     end
 
-    it "should set the the deviceToken field of the packet to nil" do
-      expect(packet.deviceToken).to be_nil
+    it "should set the the device_token field of the packet to nil" do
+      expect(packet.device_token).to be_nil
     end
   end
 
@@ -770,7 +770,7 @@ describe MQTT::Packet::Connect do
     end
   end
 
-  describe "when parsing a Connect packet with a deviceId and deviceToken" do
+  describe "when parsing a Connect packet with a device_id and device_token" do
     let(:packet) do
       MQTT::Packet.parse(
         "\x10\x2A"+
@@ -813,17 +813,17 @@ describe MQTT::Packet::Connect do
     end
 
     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')
+      expect(packet.device_id).to eq('device_id')
+      expect(packet.device_id.encoding.to_s).to eq('UTF-8')
     end
 
     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')
+      expect(packet.device_token).to eq('device_token')
+      expect(packet.device_token.encoding.to_s).to eq('UTF-8')
     end
   end
 
-  describe "when parsing a Connect that has a deviceId but no deviceToken" do
+  describe "when parsing a Connect that has a device_id but no device_token" do
     let(:packet) do
       MQTT::Packet.parse(
         "\x10\x20\x00\x06MQIsdp\x03\x80\x00\x0a\x00\x08myclient\x00\x08deviceId"
@@ -831,16 +831,16 @@ describe MQTT::Packet::Connect do
     end
 
     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')
+      expect(packet.device_id).to eq('device_id')
+      expect(packet.device_id.encoding.to_s).to eq('UTF-8')
     end
 
     it "should set the Device ID of the packet correctly" do
-      expect(packet.deviceToken).to be_nil
+      expect(packet.device_token).to be_nil
     end
   end
 
-  describe "when parsing a Connect that has a deviceToken but no deviceId" do
+  describe "when parsing a Connect that has a device_token but no device_id" do
     let(:packet) do
       MQTT::Packet.parse(
         "\x10\x20\x00\x06MQIsdp\x03\x40\x00\x0a\x00\x08myclient\x00\x08deviceToken"
@@ -848,16 +848,16 @@ describe MQTT::Packet::Connect do
     end
 
     it "should set the Device ID of the packet correctly" do
-      expect(packet.deviceId).to be_nil
+      expect(packet.device_id).to be_nil
     end
 
     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')
+      expect(packet.device_token).to eq('device_token')
+      expect(packet.device_token.encoding.to_s).to eq('UTF-8')
     end
   end
 
-  describe "when parsing a Connect packet has the deviceId and deviceToken flags set but doesn't have the fields" do
+  describe "when parsing a Connect packet has the device_id and device_token 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"
@@ -865,11 +865,11 @@ describe MQTT::Packet::Connect do
     end
 
     it "should set the Device ID of the packet correctly" do
-      expect(packet.deviceId).to be_nil
+      expect(packet.device_id).to be_nil
     end
 
     it "should set the Device ID of the packet correctly" do
-      expect(packet.deviceToken).to be_nil
+      expect(packet.device_token).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"+ # deviceId (16)
-        "\x00\x0Epass0123456789"  # deviceToken (16)
+        "\x00\x0Euser0123456789"+ # device_id (16)
+        "\x00\x0Epass0123456789"  # device_token (16)
       )
     end
 
@@ -937,13 +937,13 @@ describe MQTT::Packet::Connect do
     end
 
     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')
+      expect(packet.device_id).to eq('user0123456789')
+      expect(packet.device_id.encoding.to_s).to eq('UTF-8')
     end
 
     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')
+      expect(packet.device_token).to eq('pass0123456789')
+      expect(packet.device_token.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,
-        :deviceId => 'foo'
+        :device_id => 'foo'
       )
-      expect(packet.inspect).to eq("#<MQTT::Packet::Connect: keep_alive=10, client_id='c123', deviceId='foo'>")
+      expect(packet.inspect).to eq("#<MQTT::Packet::Connect: keep_alive=10, client_id='c123', device_id='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 deviceToken/i)
+      expect(packet.return_msg).to match(/bad user name or device_token/i)
     end
   end
 

metadata

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