mqtt-ccutrer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbcc93715636fd1a6f3491005dccf8c9805c519145145154a9895d5fb3df0670
+  data.tar.gz: f978d8185287327b475f69881546dde182fbbd3c9d665253d9625bc48df1f9a9
+SHA512:
+  metadata.gz: 53cb56f81cd0eed1d41d6a0c5a7b7fcb88e53f5fcea755cdf544715d38fd698b931c7b5d23bbf161709a0f46fe72ce14a0f0107f2bfe5f59e92225c72d8d0556
+  data.tar.gz: 845ec674c88c7be5b7835adeb1d6b52397661f3e02ae775240cb2621058eba72956327ca961c0ce82172a13485faee720d9b0c9c37e99f03643f1918d5d0d203

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2009-2013 Nicholas J Humfrey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/NEWS.md

@@ -0,0 +1,173 @@
+Ruby MQTT NEWS
+==============
+
+Ruby MQTT Version 1.0.0 (2021-02-19) (CCutrer fork)
+---------------------------------------------------
+* Increase minimum Ruby version to 2.5
+* Change several methods to take kwargs
+* Remove `get` vs. `get_packet`; just always return packets from get
+* `get` no longer takes an optional topic to subscribe to; just call
+  `subscribe`
+* Remove `last_ping_response` since it's not recorded anymore
+* Remove deprecated `remote_host` and `remote_port`
+* `connect` no longer takes an optional client id; just set it beforehand
+* Add `batch_publish` method for improving performance of QoS 1 publishes
+* Add `flush` method to ensure writes have finished, since writes are
+  now done in a background thread
+* Add `wait_for_ack` param to `subscribe` and `unsubscribe`
+* Automatic reconnects
+* Re-send Pub, Sub, and Unsub packets that don't get acked, even across
+  server disconnects
+* Only send keepalive pings if we haven't received any other packets,
+  and measure from the last packet received, instead of the last ping
+  sent
+* Improve CPU usage by only checking for timeouts at the time of the
+  timeout, instead of polling
+
+Ruby MQTT Version 0.5.0 (2017-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)
+------------------------------------
+
+* Added puback handling for QoS level 1
+* Low-level MQTT-SN packet parsing support
+* Allow certs to be set directly instead of just by file
+* Allow keyphrase for certs to be passed through
+* Put 'disconnect' inside an 'ensure' block
+* Fix for error on publish with frozen payload
+* Fix for packets always getting id 1
+* Improvements to tests
+
+
+Ruby MQTT Version 0.3.1 (2014-10-10)
+------------------------------------
+
+* Added ```last_ping_response``` to attribute to ```MQTT::Client```
+
+
+Ruby MQTT Version 0.3.0 (2014-08-26)
+------------------------------------
+
+* Added support for MQTT protocol version 3.1.1
+* Renamed a number of methods/attributes:
+  - Renamed ```:granted_qos``` to ```:return_codes```
+  - Renamed ```:remote_port``` to ```:port```
+  - Renamed ```:remote_host``` to ```:host```
+  - Renamed ```:message_id``` to ```:id```
+  - Renamed ```:protocol_version``` to ```:protocol_level```
+  - Renamed ```MQTT_BROKER``` environment variable to ```MQTT_SERVER```
+* Added more checks to ensure that the 3.1.1 protocol specs are adhered to
+* Added a Library Overview section to the README
+* Added links to the protocol specification to README
+* Improvements to the YARD API documentation
+* Don't display payload in inspect if it contains non-visible ASCII characters
+* Upgraded to rspec 3
+* Various minor bug fixes and corrections
+
+
+Ruby MQTT Version 0.2.0 (2014-04-02)
+------------------------------------
+
+* Added SSL/TLS support
+* Added support for passing connection details using a URI
+* Added support for using the ```MQTT_BROKER``` environment variable
+* Allow passing array of topics to Client#unsubscribe
+* Allow more combinations of arguments to be passed to a new Client
+* No longer defaults to ‘localhost’ if there is no server configured
+* Fixed more 'unused variable' warnings
+* Documentation improvements
+* Ruby 1.8 fixes
+* Ruby 2 fixes
+
+
+Ruby MQTT Version 0.1.0 (2013-09-07)
+------------------------------------
+
+* Changed license to MIT, to simplify licensing concerns
+* Improvements for UTF-8 handling under Ruby 1.9
+* Added ```get_packet``` method
+* Added support for a keep-alive value of 0
+* Added a #inspect method to the Packet classes
+* Added checks for the protocol name and version
+* Added check to ensure that packet body isn't too big
+* Added validation of QoS value
+* Added example of using authentication
+* Fixed 'unused variable' warnings
+* Reduced duplicated code in packet parsing
+* Improved testing
+  - Created fake server and integration tests
+  - Better test coverage
+  - Added more tests for error states
+
+
+Ruby MQTT Version 0.0.9 (2012-12-21)
+------------------------------------
+
+* Fixes for Ruby 1.9.3 by Mike English
+* Fix for ```client_id``` typo by Anubisss
+* Added methods to inspect the incoming message queue: ```queue_empty?``` and ```queue_length```
+* Fixed incorrect implementation of the parsing and serialising of Subscription Acknowledgement packets
+* Changed test mocking from Mocha to rspec-mocks
+
+
+Ruby MQTT Version 0.0.8 (2011-02-04)
+------------------------------------
+
+* Implemented Last Will and Testament feature
+* Renamed dup attribute to duplicate to avoid method name clash
+* Made the random ```client_id``` generator a public class method
+
+
+Ruby MQTT Version 0.0.7 (2011-01-19)
+------------------------------------
+
+* You can now pass a topic and block to client.get
+* Added MQTT::Client.connect class method
+
+
+Ruby MQTT Version 0.0.5 (2011-01-18)
+------------------------------------
+
+* Implemented setting username and password (MQTT 3.1)
+* Renamed ```clean_start``` to ``clean_session```
+* Started using autoload to load classes
+* Modernised Gem building mechanisms
+
+
+Ruby MQTT Version 0.0.4 (2009-02-22)
+------------------------------------
+
+* Re-factored packet encoding/decoding into one class per packet type
+* Added MQTT::Proxy class for implementing an MQTT proxy
+
+
+Ruby MQTT Version 0.0.3 (2009-02-08)
+------------------------------------
+
+* Added checking of Connection Acknowledgement
+* Automatic client identifier generation
+
+
+Ruby MQTT Version 0.0.2 (2009-02-03)
+------------------------------------
+
+* Added support for packets longer than 127 bytes
+
+
+Ruby MQTT Version 0.0.1 (2009-02-01)
+------------------------------------
+
+* Initial Release

data/README.md

@@ -0,0 +1,218 @@
+[![Build Status](https://travis-ci.org/njh/ruby-mqtt.svg)](https://travis-ci.org/ccutrer/ruby-mqtt)
+
+ruby-mqtt
+=========
+
+Pure Ruby gem that implements the [MQTT] protocol, a lightweight protocol for publish/subscribe messaging.
+
+Also includes a class for parsing and generating [MQTT-SN] packets.
+
+
+Table of Contents
+-----------------
+* [Installation](#installation)
+* [Quick Start](#quick-start)
+* [Library Overview](#library-overview)
+* [Resources](#resources)
+* [License](#license)
+* [Contact](#contact)
+
+
+Installation
+------------
+
+You may get the latest stable version from [Rubygems]:
+
+    $ gem install mqtt-ccutrer
+
+Quick Start
+-----------
+
+~~~ ruby
+require 'mqtt'
+
+# Publish example
+MQTT::Client.connect('test.mosquitto.org') do |c|
+  c.publish('test', 'message')
+end
+
+# Subscribe example
+MQTT::Client.connect('test.mosquitto.org') do |c|
+  # If you pass a block to the get method, then it will loop
+  c.subscribe('test')
+  c.get do |packet|
+    puts "#{packet.topic}: #{packet.payload}"
+  end
+end
+~~~
+
+
+Library Overview
+----------------
+
+### Connecting ###
+
+A new client connection can be created by passing either a [MQTT URI], a host and port or by passing a hash of attributes.
+
+~~~ ruby
+client = MQTT::Client.connect('mqtt://myserver.example.com')
+client = MQTT::Client.connect('mqtts://user:pass@myserver.example.com')
+client = MQTT::Client.connect('myserver.example.com')
+client = MQTT::Client.connect('myserver.example.com', 18830)
+client = MQTT::Client.connect(host: 'myserver.example.com', port: 1883 ... )
+~~~
+
+TLS/SSL is not enabled by default, to enabled it, pass `ssl: true`:
+
+~~~ ruby
+client = MQTT::Client.connect(
+  host: 'test.mosquitto.org',
+  port: 8883,
+  ssl: true
+)
+~~~
+
+Alternatively you can create a new Client object and then configure it by setting attributes. This example shows setting up client certificate based authentication:
+
+~~~ ruby
+client = MQTT::Client.new
+client.host = 'myserver.example.com'
+client.ssl = true
+client.cert_file = path_to('client.pem')
+client.key_file  = path_to('client.key')
+client.ca_file   = path_to('root-ca.pem')
+client.connect
+~~~
+
+The connection can either be made without the use of a block:
+
+~~~ ruby
+client = MQTT::Client.connect('test.mosquitto.org')
+# perform operations
+client.disconnect
+~~~
+
+Or, if using a block, with an implicit disconnection at the end of the block.
+
+~~~ ruby
+MQTT::Client.connect('test.mosquitto.org') do |client|
+  # perform operations
+end
+~~~
+
+For more information, see the list of attributes for the [MQTT::Client] class and the [MQTT::Client.connect] method.
+
+
+### Publishing ###
+
+To send a message to a topic, use the ```publish``` method:
+
+~~~ ruby
+client.publish(topic, payload, retain: false, qos: 0)
+~~~
+
+The method will return once the message has been sent to the MQTT server for QoS 0,
+or once an Ack has been received from the server for QoS 1.
+
+For more information see the [MQTT::Client#publish] method.
+
+
+### Subscribing ###
+
+You can send a subscription request to the MQTT server using the subscribe method. One or more [Topic Filters] may be passed in:
+
+~~~ ruby
+client.subscribe( 'topic1' )
+client.subscribe( 'topic1', 'topic2' )
+client.subscribe( 'foo/#' )
+~~~
+
+For more information see the [MQTT::Client#subscribe] method.
+
+
+### Receiving Messages ###
+
+To receive a message, use the get method. This method will block until a message is available. You can access details
+about the packet such as if it was retained, the topic it was sent to, and the payload.
+
+~~~ ruby
+packet = client.get
+packet.retained?
+packet.topic
+packet.payload
+~~~
+
+Alternatively, you can give the get method a block, which will be called for every message received and loop forever:
+
+~~~ ruby
+client.get do |packet|
+  # Block is executed for every message received
+end
+~~~
+
+For more information see the [MQTT::Client#get] method.
+
+
+### Parsing and serialising of packets ###
+
+The parsing and serialising of MQTT and MQTT-SN packets is a separate lower-level API.
+You can use it to build your own clients and servers, without using any of the rest of the
+code in this gem.
+
+~~~ ruby
+# Parse a string containing a binary packet into an object
+packet_obj = MQTT::Packet.parse(binary_packet)
+    
+# Write a PUBACK packet to an IO handle
+ios << MQTT::Packet::Puback(id: 20)
+    
+# Write an MQTT-SN Publish packet with QoS -1 to a UDP socket
+socket = UDPSocket.new
+socket.connect('localhost', MQTT::SN::DEFAULT_PORT)
+socket << MQTT::SN::Packet::Publish.new(
+  topic_id: 'TT',
+  topic_id_type: :short,
+  data: "The time is: #{Time.now}",
+  qos: -1
+)
+socket.close
+~~~
+
+Limitations
+-----------
+
+ * QoS 2 is not currently supported by client
+ * Pending publishes are only persisted as long as a reconnect occurs within
+   the configured timeout
+
+Resources
+---------
+
+* API Documentation: http://rubydoc.info/gems/mqtt
+* Protocol Specification v3.1.1: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html
+* Protocol Specification v3.1: http://public.dhe.ibm.com/software/dw/webservices/ws-mqtt/mqtt-v3r1.html
+* MQTT-SN Protocol Specification v1.2: http://mqtt.org/new/wp-content/uploads/2009/06/MQTT-SN_spec_v1.2.pdf
+* MQTT Homepage: http://www.mqtt.org/
+* GitHub Project: http://github.com/njh/ruby-mqtt
+
+
+License
+-------
+
+The mqtt ruby gem is licensed under the terms of the MIT license.
+See the file LICENSE for details.
+
+
+[MQTT]:           http://www.mqtt.org/
+[MQTT-SN]:        http://mqtt.org/2013/12/mqtt-for-sensor-networks-mqtt-sn
+[Rubygems]:       http://rubygems.org/
+[Bundler]:        http://bundler.io/
+[MQTT URI]:       https://github.com/mqtt/mqtt.github.io/wiki/URI-Scheme
+[Topic Filters]:  http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html#_Toc388534397
+
+[MQTT::Client]:           http://rubydoc.info/gems/mqtt-ccutrer/MQTT/Client#instance_attr_details
+[MQTT::Client.connect]:   http://rubydoc.info/gems/mqtt-ccutrer/MQTT/Client.connect
+[MQTT::Client#publish]:   http://rubydoc.info/gems/mqtt-ccutrer/MQTT/Client:publish
+[MQTT::Client#subscribe]: http://rubydoc.info/gems/mqtt-ccutrer/MQTT/Client:subscribe
+[MQTT::Client#get]:       http://rubydoc.info/gems/mqtt-ccutrer/MQTT/Client:get
+

data/lib/mqtt-ccutrer.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'mqtt'

data/lib/mqtt.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'socket'
+require 'timeout'
+
+require 'mqtt/version'
+
+module MQTT
+  # Default port number for unencrypted connections
+  DEFAULT_PORT = 1883
+
+  # Default port number for TLS/SSL encrypted connections
+  DEFAULT_SSL_PORT = 8883
+
+  # Super-class for other MQTT related exceptions
+  class Exception < RuntimeError
+  end
+
+  # A ProtocolException will be raised if there is a
+  # problem with data received from a remote host
+  class ProtocolException < Exception
+  end
+
+  class KeepAliveTimeout < ProtocolException
+  end
+
+  # A NotConnectedException will be raised when trying to
+  # perform a function but no connection has been
+  # established
+  class NotConnectedException < Exception
+  end
+
+  # A ConnectionClosedException will be raised when the
+  # connection has been closed while waiting for an operation
+  # to complete
+  class ConnectionClosedException < Exception
+  end
+
+  # A ResendLimitExceededException will be raised when a packet
+  # has timed out without an ack too many times
+  class ResendLimitExceededException < Exception
+  end
+
+  autoload :Client,   'mqtt/client'
+  autoload :Packet,   'mqtt/packet'
+  autoload :Proxy,    'mqtt/proxy'
+
+  # MQTT-SN
+  module SN
+    # Default port number for unencrypted connections
+    DEFAULT_PORT = 1883
+
+    # A ProtocolException will be raised if there is a
+    # problem with data received from a remote host
+    class ProtocolException < MQTT::Exception
+    end
+
+    autoload :Packet, 'mqtt/sn/packet'
+  end
+end