losant_mqtt 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c87e33d018c821a2029fba40648c908dfe95fd49
-  data.tar.gz: 04366bd1c0d8b4ae7589752b36964835ca726cc8
+SHA256:
+  metadata.gz: 95e1102a26f7a342a937e14265699b57143aeb4d3e0596e133662acd0aad3bf3
+  data.tar.gz: 538c22dc7d4e8c95c54d007239dd274ed520017552c1bcb54a2eb9479673c157
 SHA512:
-  metadata.gz: ad56b84c3baabbc3f26b3087f95147e3f0e593cc8118179237361a368816ae8211412622bcbeded2fe549164cc1a35acbb2a8818b1667d171125db9e15e5bd4d
-  data.tar.gz: 8aa800f635ad40098281e50198798c2392f1ef80e0a0bda9b0adffdca8debb0a942253b5de8d9ddcc9ebac35bf3febe882c6ee1d67397b1c7210a2c53694df7a
+  metadata.gz: 150f8fbb01168707d750f965093e78a774fc0f9c5f4a052a25f03e46b3e16a02555afde857c449bcf5c1047d6417e4d13cfd93fefdca2a9227eecefeac59b2cf
+  data.tar.gz: addfbc387818cdbb17b10cce44b1a795c924a57e1205553f75c999352bfb83055ead97ead5e1bb728cc434732c069899abdbe2b808a74a303b400b3a1077f468

data/.markdownlint.json

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD009": { "br_spaces": 2 },
+  "MD013": false,
+  "MD033": false,
+  "MD041": false,
+  "MD014": false,
+  "MD034": false,
+  "MD026": false
+}

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.6.0

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
- - 2.4.0
- - 2.3.3
- - 2.2.6
- - 2.1.10
+ - '2.6.0'
+ - '2.5.3'
+ - '2.4.5'
+ - '2.3.8'
+ - '2.2.10'
+ - '2.1.10'

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Losant IoT, Inc.
+Copyright (c) 2019 Losant IoT, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/Losant/losant-mqtt-ruby.svg?branch=master)](https://travis-ci.org/Losant/losant-mqtt-ruby) [![Gem Version](https://badge.fury.io/rb/losant_mqtt.svg)](https://badge.fury.io/rb/losant_mqtt)
 
 The [Losant](https://www.losant.com) MQTT client provides a simple way for
-custom things to communicate with the Losant platform over MQTT.  You can
+custom things to communicate with the Losant platform over MQTT. You can
 authenticate as a device, publish device state, and listen for device commands.
 
 This client works with Ruby 2.1 and higher, and it depends on [Event Machine](https://github.com/eventmachine/eventmachine) to provide
@@ -75,15 +75,15 @@ end
 
 ## API Documentation
 
-*   [Device](#device)
-    *   [initializer](#initializer)
-    *   [connect](#connect)
-    *   [connected?](#connected)
-    *   [close](#close)
-    *   [send_state](#send_state)
-    *   [on](#on)
-    *   [add_listener](#add_listener)
-    *   [remove_listener](#remove_listener)
+* [Device](#device)
+  * [initializer](#initializer)
+  * [connect](#connect)
+  * [connected?](#connected)
+  * [close](#close)
+  * [send_state](#send_state)
+  * [on](#on)
+  * [add_listener](#add_listener)
+  * [remove_listener](#remove_listener)
 
 ### Device
 
@@ -111,28 +111,22 @@ LosantMqtt::Device.new(device_id:, key:, secret:, secure: true, retry_lost_conne
 
 The ``Client()`` initializer takes the following arguments:
 
-*   device_id  
-The device's ID. Obtained by first registering a device using
-the Losant platform.
+* device_id  
+  The device's ID. Obtained by first registering a device using the Losant platform.
 
-*   key  
-The Losant access key.
+* key  
+  The Losant access key.
 
-*   secret  
-The Losant access secret.
+* secret  
+  The Losant access secret.
 
-*   secure  
-If the client should connect to Losant over SSL - default is true.
+* secure  
+  If the client should connect to Losant over SSL - default is true.
 
-*   retry_lost_connection  
-If the client should retry lost connections - default is true.  Errors on
-initial connect will still be raised, but if a good connection is
-subsequently lost and this flag is true, the client will try to automatically
-reconnect and will not raise errors (except in the case of authentication
-errors, which will still be raised). When this flag is true, disconnection
-and reconnection can be monitored using the `:close` and `:reconnect` events.
+* retry_lost_connection  
+  If the client should retry lost connections - default is true. Errors on initial connect will still be raised, but if a good connection is subsequently lost and this flag is true, the client will try to automatically reconnect and will not raise errors (except in the case of authentication errors, which will still be raised). When this flag is true, disconnection and reconnection can be monitored using the `:close` and `:reconnect` events.
 
-###### Example
+##### Initializer Example
 
 ```ruby
 device = LosantMqtt::Device.new(device_id: "my-device-id",
@@ -178,13 +172,13 @@ coordinates once a second or more. Because of this, sendState is typically
 the most invoked function. Any state data sent to Losant is stored and made
 available in data visualization tools and workflow triggers.
 
-*   state  
-The state to send as a hash.
+* state  
+  The state to send as a hash.
 
-*   time  
-When the state occured - if nil or not set, will default to now.
+* time  
+  When the state occurred - if nil or not set, will default to now.
 
-###### Example
+##### Send State Example
 
 ```ruby
 device.send_state({ voltage: read_analog_in() })
@@ -198,20 +192,14 @@ on(event, proc=nil, &block)
 
 Adds an observer to listen for an event on this device.
 
-*   event  
-The event name to listen for.  Possible events are: `:connect` (the device
-has connected), `:reconnect` (the device lost its connection and reconnected),
-`:close` (the device's connection was closed), and
-`:command` (the device has received a command from Losant).
-
-*   proc / &block  
-The proc or block to call with the given event fires.  The first
-argument for all callbacks will be the device instance.  For `:close` callbacks,
-there can be a second argument which is the reason for the closing of the
-connection, and for `:command` callbacks the second argument is the command
+* event  
+  The event name to listen for. Possible events are: `:connect` (the device has connected), `:reconnect` (the device lost its connection and reconnected), `:close` (the device's connection was closed), and `:command` (the device has received a command from Losant).
+
+* proc / &block  
+  The proc or block to call with the given event fires. The first argument for all callbacks will be the device instance. For `:close` callbacks, there can be a second argument which is the reason for the closing of the connection, and for `:command` callbacks the second argument is the command
 received.
 
-###### Example
+##### On Command Example
 
 ```ruby
 device.on(:command) do |device, command|
@@ -233,16 +221,16 @@ remove_listener(event, proc)
 
 Removes an observer from listening for an event on this device.
 
-*   event  
-The event name to stop listening for.  Same events as [on](#on).
+* event  
+  The event name to stop listening for. Same events as [on](#on).
 
-*   proc  
-The proc that should be removed.
+* proc  
+  The proc that should be removed.
 
 <br/>
 
 *****
 
-Copyright (c) 2017 Losant IoT, Inc
+Copyright (c) 2019 Losant IoT, Inc
 
 <https://www.losant.com>

data/lib/losant_mqtt.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2017 Losant IoT, Inc.
+# Copyright (c) 2019 Losant IoT, Inc.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/losant_mqtt/device.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2017 Losant IoT, Inc.
+# Copyright (c) 2019 Losant IoT, Inc.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/losant_mqtt/device_connection.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2017 Losant IoT, Inc.
+# Copyright (c) 2019 Losant IoT, Inc.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/losant_mqtt/utils.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2017 Losant IoT, Inc.
+# Copyright (c) 2019 Losant IoT, Inc.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/losant_mqtt/version.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2017 Losant IoT, Inc.
+# Copyright (c) 2019 Losant IoT, Inc.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantMqtt
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/losant_mqtt.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = ">= 2.1"
 
   gem.add_runtime_dependency "eventmachine", "~> 1.2"
-  gem.add_runtime_dependency "mqtt", "~> 0.4"
+  gem.add_runtime_dependency "mqtt", "~> 0.5"
   gem.add_runtime_dependency "events", "~> 0.9"
 
-  gem.add_development_dependency "rspec", "~> 3.5"
+  gem.add_development_dependency "rspec", "~> 3.8"
   gem.add_development_dependency "rake", "~> 12"
 end

data/spec/device_spec.rb

@@ -18,7 +18,7 @@ describe LosantMqtt::Device do
 
   it "should correctly connect, send state, and receive a command" do
     EventMachine.run do
-      EventMachine.add_timer(5) { raise RuntimeError.new("Test Timed Out") }
+      EventMachine.add_timer(15) { raise RuntimeError.new("Test Timed Out") }
 
       # associated with app id 57615eebc035bd0100cb964a
       # workflow that takes state reported and sends a command back
@@ -35,7 +35,9 @@ describe LosantMqtt::Device do
         callbacks_called.push(:command)
         expect(cmd["name"]).to eq("triggeredCommand")
         expect(cmd["payload"]).to eq({ "result" => "one-1-false" })
-        d.close
+        EventMachine.add_timer(0.1) do
+          d.close
+        end
       end
 
       device.on(:connect) do |d|
@@ -51,7 +53,9 @@ describe LosantMqtt::Device do
         expect(d.connected?).to eq(false)
         expect(reason).to eq(nil)
         expect(callbacks_called).to eq([:connect, :command])
-        EventMachine.stop_event_loop
+        EventMachine.add_timer(0.1) do
+          EventMachine.stop_event_loop
+        end
       end
 
       device.send_state({ str_attr: "one", num_attr: 1, bool_attr: false })
@@ -60,7 +64,7 @@ describe LosantMqtt::Device do
 
   it "should reconnect when connection is abnormally lost and flag is true" do
     EventMachine.run do
-      EventMachine.add_timer(10) { raise RuntimeError.new("Test Timed Out") }
+      EventMachine.add_timer(15) { raise RuntimeError.new("Test Timed Out") }
 
       # associated with app id 57615eebc035bd0100cb964a
       # workflow that takes state reported and sends a command back
@@ -77,7 +81,9 @@ describe LosantMqtt::Device do
         callbacks_called.push(:command)
         expect(cmd["name"]).to eq("triggeredCommand")
         expect(cmd["payload"]).to eq({ "result" => "two-2-true" })
-        d.close
+        EventMachine.add_timer(0.1) do
+          d.close
+        end
       end
 
       device.on(:connect) do |d|
@@ -106,7 +112,9 @@ describe LosantMqtt::Device do
         else
           expect(reason).to eq(nil)
           expect(callbacks_called).to eq([:connect, :close, :reconnect, :command, :close])
-          EventMachine.stop_event_loop
+          EventMachine.add_timer(0.1) do
+            EventMachine.stop_event_loop
+          end
         end
       end
 
@@ -117,7 +125,7 @@ describe LosantMqtt::Device do
   it "should not reconnect when connection is abnormally lost and flag is false" do
     expect do
       EventMachine.run do
-        EventMachine.add_timer(10) { raise RuntimeError.new("Test Timed Out") }
+        EventMachine.add_timer(15) { raise RuntimeError.new("Test Timed Out") }
 
         # associated with app id 57615eebc035bd0100cb964a
         # workflow that takes state reported and sends a command back
@@ -162,7 +170,7 @@ describe LosantMqtt::Device do
   it "should raise errors on initial bad connect" do
     expect do
       EventMachine.run do
-        EventMachine.add_timer(10) { raise RuntimeError.new("Test Timed Out") }
+        EventMachine.add_timer(15) { raise RuntimeError.new("Test Timed Out") }
         device = LosantMqtt::Device.new(
           device_id: "not a device id",
           key: "not a key",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: losant_mqtt
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Michael Kuehl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: events
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".markdownlint.json"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -121,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: An MQTT client for the Losant MQTT Broker