mosquitto 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92a30539c75dec74a32576327cc88bd883502e89
+  data.tar.gz: 7d44ae4edbd3c241ba38048d1ae46ec1e2948194
+SHA512:
+  metadata.gz: 99410f286d02e75c29f7663522c8b8a9f05bb35ccb7fce3f0e9ed8b6ea95b560ec2bd217dfc4c576db50bc38125a63d686cc4bcc3caf56ee77951dbe1e7a22d1
+  data.tar.gz: 49240900ce920a90cb5d5be4a7a5b9add7d576b1edf236b8623b0d95b4c9fb54879a86f20821ead46ba6d62f11674aa14ec9c1fb3ee307742781a84b120021e7

data/.gitignore

@@ -0,0 +1,21 @@
+.libs/*
+.rbx/*
+*.rbc
+*.lo
+*.la
+*.lai
+*.dylib.dSYM
+*.dylib
+*.o
+*.a
+*.log
+tmp/*
+true/*
+*.bundle
+*.gem
+doc/*
+.DS_Store
+pkg
+scratch
+ext/mosquitto/Makefile
+.yardoc

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install pkg-config cmake openssl
+  - wget http://mosquitto.org/files/source/mosquitto-1.2.3.tar.gz
+install:
+  - tar xzf mosquitto-1.2.3.tar.gz
+  - cd mosquitto-1.2.3
+  - cmake .
+  - sudo make install
+  - bundle install
+bundler_args: --quiet
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.1.1
+env:
+  - GC_STRESS=0
+  - GC_STRESS=1
+script: "bundle exec rake"
+gemfile:
+  - Gemfile
+notifications:
+  recipients:
+    - lourens@methodmissing.com
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rdoc'

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    mosquitto (0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (1.8.1)
+    rake (10.1.1)
+    rake-compiler (0.9.2)
+      rake
+    rdoc (4.1.1)
+      json (~> 1.4)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mosquitto!
+  rake
+  rake-compiler (~> 0.9.2)
+  rdoc
+  yard

data/LICENSE.md

@@ -0,0 +1,13 @@
+###This library is Open Source, under the BSD 3-Clause license.
+
+Copyright © 2003-2014 LogMeIn, Inc.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the names of LogMeIn, Inc., nor Xively Ltd., nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL LOGMEIN, INC. OR XIVELY LTD. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,244 @@
+# mosquitto - a high perf MQTT 3.1 client
+
+[![Build Status](https://travis-ci.org/xively/mosquitto.png)](https://travis-ci.org/xively/mosquitto)
+
+The mosquitto gem is meant to serve as an easy, performant and standards compliant client for interacting with MQTT brokers.
+
+The API consists of two classes:
+
+[Mosquitto::Client](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client) - the client
+
+[Mosquitto::Message](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Message) - returned from the client
+
+## About MQTT and libmosquitto
+
+[MQ Telemetry Transport](http://mqtt.org/) is :
+
+```
+MQTT stands for MQ Telemetry Transport. It is a publish/subscribe, extremely simple and lightweight messaging
+protocol, designed for constrained devices and low-bandwidth, high-latency or unreliable networks. The design
+principles are to minimise network bandwidth and device resource requirements whilst also attempting to ensure
+reliability and some degree of assurance of delivery. These principles also turn out to make the protocol ideal of
+the emerging “machine-to-machine” (M2M) or “Internet of Things” world of connected devices, and for mobile
+applications where bandwidth and battery power are at a premium.
+```
+Please see the [FAQ](http://mqtt.org/faq) and [list of supported software](http://mqtt.org/wiki/software).
+
+### libmosquitto
+
+```
+Mosquitto is an open source (BSD licensed) message broker that implements the MQ Telemetry Transport protocol
+version 3.1. MQTT provides a lightweight method of carrying out messaging using a publish/subscribe model. This
+makes it suitable for "machine to machine" messaging such as with low power sensors or mobile devices such as
+phones, embedded computers or microcontrollers like the Arduino. 
+```
+
+See the [project website](http://mosquitto.org/) for more information.
+
+## Requirements
+
+This gem links against version 1.2.3 of `libmosquitto` . You will need to install additional packages for your system.
+
+### OS X
+
+The preferred installation method for libmosquitto on OS X is with the [Homebrew](https://github.com/Homebrew/homebrew) package manager :
+
+``` sh
+brew install mosquitto
+```
+
+### Linux Ubuntu
+
+``` sh
+sudo apt-get update
+sudo apt-get install pkg-config cmake openssl
+```
+
+The current Ubuntu packages aren't on 1.2.3 yet - it's recommended to build libmosquitto from source (see below) until further notice. OpenSSL is an optional dependency - libmosquitto builds without it, however TLS specific features would not be available.
+
+### Building libmosquitto from source
+
+``` sh
+wget http://mosquitto.org/files/source/mosquitto-1.2.3.tar.gz
+tar xzf mosquitto-1.2.3.tar.gz
+cd mosquitto-1.2.3
+cmake .
+sudo make install
+```
+
+## Compatibility
+
+This gem is regularly tested against the following Ruby versions on Linux and Mac OS X:
+
+ * Ruby MRI 1.9.3
+ * Ruby MRI 2.0.0 (ongoing patch releases).
+ * Ruby MRI 2.1.0 (ongoing patch releases).
+ * Ruby MRI 2.1.1 (ongoing patch releases).
+
+Ruby 1.8, Rubinius and JRuby are not supported.
+
+## Installing
+
+### OSX / Linux
+
+When are requirements or dependencies are met, the following should install mosquitto without any problems :
+
+``` sh
+gem install mosquitto
+```
+
+The extension checks for libmosquitto presence as well as a 1.2.3 version.
+
+## Usage
+
+### Threaded loop
+
+The simplest mode of operation - starts a new thread to process network traffic.
+
+``` ruby
+require 'mosquitto'
+
+publisher = Mosquitto::Client.new("blocking")
+
+# Spawn a network thread with a main loop
+publisher.loop_start
+
+# On publish callback
+publisher.on_publish do |mid|
+  p "Published #{mid}"
+end
+
+# On connect callback
+publisher.on_connect do |rc|
+  p "Connected with return code #{rc}"
+  # publish a test message once connected
+  publisher.publish(nil, "topic", "test message", Mosquitto::AT_MOST_ONCE, true)
+end
+
+# Connect to MQTT broker
+publisher.connect("test.mosquitto.org", 1883, 10)
+
+# Allow some time for processing
+sleep 2
+
+publisher.disconnect
+
+# Optional, stop the threaded loop - the network thread would be reaped on Ruby exit as well
+publisher.loop_stop(true)
+```
+
+### Blocking loop (simple clients)
+
+The client supports a blocking main loop as well which is useful for building simple MQTT clients. Reconnects
+etc. and other misc operations are handled for you.
+
+``` ruby
+require 'mosquitto'
+
+publisher = Mosquitto::Client.new("blocking")
+
+# On publish callback
+publisher.on_publish do |mid|
+  p "Published #{mid}"
+end
+
+# On connect callback
+publisher.on_connect do |rc|
+  p "Connected with return code #{rc}"
+  # publish a test message once connected
+  publisher.publish(nil, "topic", "test message", Mosquitto::AT_MOST_ONCE, true)
+end
+
+# Connect to MQTT broker
+publisher.connect("test.mosquitto.org", 1883, 10)
+
+# Blocking main loop
+publisher.loop_forever
+```
+
+### Custom main loop
+
+EventMachine support is forthcoming.
+
+### Logging
+
+The client supports any of the Ruby Logger libraries with the standard #add method interface
+
+``` ruby
+require 'mosquitto'
+
+publisher = Mosquitto::Client.new("blocking")
+
+# Sets a custom log callback for us that pipes to the given logger instance
+publisher.logger = Logger.new(STDOUT)
+
+# Connect to MQTT broker
+publisher.connect("test.mosquitto.org", 1883, 10)
+```
+
+### Callbacks
+
+The following callbacks are supported (please follow links for further documentation) :
+
+* [connect](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_connect) - called when the broker sends a CONNACK message in response to a connection.
+* [disconnect](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_disconnect) - called when the broker has received the DISCONNECT command and has disconnected the client.
+* [log](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_log) - should be used if you want event logging information from the client library.
+* [subscribe](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_subscribe) - called when the broker responds to a subscription request.
+* [unsubscribe](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_unsubscribe) - called when the broker responds to a unsubscription request.
+* [publish](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_publish) - called when a message initiated with Mosquitto::Client#publish has been sent to the broker successfully.
+* [message](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_message) - called when a message is received from the broker.
+
+### TLS / SSL
+
+libmosquitto builds with TLS support by default, however [pre-shared key (PSK)](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:tls_psk_set) support is not available when linked against older OpenSSL versions.
+
+``` ruby
+tls_client = Mosquitto::Client.new
+
+tls_client.logger = Logger.new(STDOUT)
+
+tls_client.loop_start
+
+tls_client.on_connect do |rc|
+  p :tls_connection
+end
+tls_client.tls_opts_set(Mosquitto::SSL_VERIFY_PEER, "tlsv1.2", nil)
+tls_client.tls_set('/path/to/mosquitto.org.crt'), nil, nil, nil, nil)
+tls_client.connect('test.mosquitto.org', 8883, 10)
+```
+
+See [documentation](http://rubydoc.info/github/bear-metal/mosquitto) for the full API specification.
+
+## Contact, feedback and bugs
+
+This extension is currently maintained by Lourens Naudé (http://github.com/methodmissing) and contributors.
+
+Please file bugs / issues and feature requests on the [issue tracker](https://github.com/bear-metal/mosquitto/issues)
+
+## Development
+
+To run the tests, you can use RVM and Bundler to create a pristine environment for mosquitto development/hacking.
+Use 'bundle install' to install the necessary development and testing gems:
+
+``` sh
+bundle install
+rake
+```
+Tests by default run against the public `test.mosquitto.org` MQTT server, which supports TLS as well. More information is available at http://test.mosquitto.org/. Alternatively, should you wish you run tests against a local MQTT broker, change the following constants in the test helper to `localhost`:
+
+``` ruby
+class MosquittoTestCase < Test::Unit::TestCase
+  TEST_HOST = "localhost"
+  TEST_PORT = 1883
+
+  TLS_TEST_HOST = "localhost"
+  TLS_TEST_PORT = 8883
+```
+
+## Resources
+
+Documentation available at http://rubydoc.info/github/bear-metal/mosquitto
+
+## Special Thanks
+
+* Roger Light - for libmosquitto

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems' unless defined?(Gem)
+require 'rake' unless defined?(Rake)
+
+require 'rake/extensiontask'
+require 'rake/testtask'
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['README.md', 'lib/**/*.rb', "ext/mosquitto/*.c"]
+end
+
+Rake::ExtensionTask.new('mosquitto') do |ext|
+  ext.name = 'mosquitto_ext'
+  ext.ext_dir = 'ext/mosquitto'
+  CLEAN.include 'lib/**/mosquitto_ext.*'
+end
+
+desc 'Run mosquitto tests'
+Rake::TestTask.new(:test) do |t|
+  t.test_files = Dir.glob("test/**/test_*.rb")
+  t.verbose = true
+  t.warning = true
+end
+
+desc 'Run mosquitto integration tests'
+Rake::TestTask.new(:integration) do |t|
+  t.test_files = Dir.glob("test/test_integration.rb")
+  t.verbose = true
+  t.warning = true
+end
+
+namespace :debug do
+  desc "Run the test suite under gdb"
+  task :gdb do
+    system "gdb --args ruby rake"
+  end
+end
+
+task :test => :compile
+task :default => :test

data/TODO.md

@@ -0,0 +1,19 @@
+* Let close_session be an argument to new client + reinit as well
+* https://github.com/jobytaffey/mqtt-http-server
+* Thread support
+  - release GIL when processing callbacks ?
+  - [X] rb_mosquitto_client_loop_write
+  - [X] rb_mosquitto_client_loop_read
+  - [X] rb_mosquitto_client_loop_stop
+  - [X] rb_mosquitto_client_loop_start
+  - [X] rb_mosquitto_client_loop
+  - [X] rb_mosquitto_client_loop_forever
+  - [X] rb_mosquitto_client_subscribe
+  - [X] rb_mosquitto_client_unsubscribe
+  - [X] rb_mosquitto_client_publish
+  - [X] rb_mosquitto_client_connect
+  - [X] rb_mosquitto_client_disconnect
+  - [X] rb_mosquitto_client_reconnect
+  - [X] rb_mosquitto_client_connect_async
+  - [X] rb_mosquitto_client_reinitialise
+* TLS support

data/examples/pub_sub.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+$:.unshift('.')
+$:.unshift(File.expand_path(File.dirname(__FILE__)) + '/../lib')
+
+require 'mosquitto'
+
+publisher = Mosquitto::Client.new
+publisher.loop_start
+publisher.on_log do |level,msg|
+  p "PUB: #{msg}"
+end
+publisher.on_connect do |rc|
+  p "Connect #{rc}"
+  publisher.publish(nil, "topic", "test", Mosquitto::AT_MOST_ONCE, true)
+end
+publisher.connect("localhost", 1883, 10)
+publisher.on_publish do |mid|
+  p "Published #{mid}"
+end
+sleep 1.5
+publisher.loop_stop(true)
+
+subscriber = Mosquitto::Client.new
+subscriber.loop_start
+subscriber.on_log do |level,msg|
+  p "SUB: #{msg}"
+end
+subscriber.on_connect do |rc|
+  p "Connect #{rc}"
+  subscriber.subscribe(nil, "topic", Mosquitto::AT_MOST_ONCE)
+end
+subscriber.on_subscribe do |mid,qos_count,granted_qos|
+  p "Subscribed #{mid}"
+end
+subscriber.connect("localhost", 1883, 10)
+subscriber.on_message do |msg|
+  p "Message #{msg}"
+end
+sleep 1.5
+subscriber.loop_stop(true)