go-mqtt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8698ec3fcf903c009cffb7a8c9f4fefc17704577c05b629e7cf2192c2402de94
+  data.tar.gz: 84deb7a3a57332f01b3d24b86b0dbb1bec8425c5586f851e2fb66aeb4b506b63
+SHA512:
+  metadata.gz: cbcd90f72f086b3ee8e42daf3aaf4138f556932b5240a625dda5229f25e61eb05a3ec5536a8966acb2408ed52240465ef9ec654e93e07a50b41328cccb6aae6a
+  data.tar.gz: a8cae3bc9bdf70ce094332991eb1468acb07b44eb8b0e82c72d3dbadf7bf0ecc8bd490e74a129b74ba497c5ad8c37c76b91fdef24dd76d38c5e8491266854b40

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,150 @@
+Ruby MQTT NEWS
+==============
+
+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,237 @@
+[![Build Status](https://github.com/njh/ruby-mqtt/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/njh/ruby-mqtt/actions/workflows/build.yml?query=branch%3Amain)
+
+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
+
+Alternatively, to use a development snapshot from GitHub using [Bundler], add this to your `Gemfile`:
+
+~~~ ruby
+    gem 'mqtt', :github => 'njh/ruby-mqtt'
+~~~
+
+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.get('test') do |topic,message|
+    puts "#{topic}: #{message}"
+  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 default timeout when opening a TCP Socket is 90 seconds. To specify it explicitly, use 'connect_timeout =>':
+
+~~~ ruby
+client = MQTT::Client.connect(
+  :host => 'myserver.example.com',
+  :connect_timeout => 15
+)
+~~~
+
+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 and 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)
+~~~
+
+The method will return once the message has been sent to the MQTT server.
+
+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. The topic is the name of the topic the message was sent to. The message is a string:
+
+~~~ ruby
+topic,message = client.get
+~~~
+
+Alternatively, you can give the get method a block, which will be called for every message received and loop forever:
+
+~~~ ruby
+client.get do |topic,message|
+  # 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
+ * Automatic re-connects to the server are not supported
+ * No local persistence for packets
+
+
+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.
+
+
+Contact
+-------
+
+* Author:    Nicholas J Humfrey
+* Email:     njh@aelius.com
+* Twitter:   [@njh]
+* Home Page: http://www.aelius.com/njh/
+
+
+
+[@njh]:           http://twitter.com/njh
+[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/MQTT/Client#instance_attr_details
+[MQTT::Client.connect]:   http://rubydoc.info/gems/mqtt/MQTT/Client.connect
+[MQTT::Client#publish]:   http://rubydoc.info/gems/mqtt/MQTT/Client:publish
+[MQTT::Client#subscribe]: http://rubydoc.info/gems/mqtt/MQTT/Client:subscribe
+[MQTT::Client#get]:       http://rubydoc.info/gems/mqtt/MQTT/Client:get