apiotics-paho-mqtt 1.0.0

data/lib/paho_mqtt/subscriber.rb

@@ -0,0 +1,163 @@
+# Copyright (c) 2016-2017 Pierre Goudet <p-goudet@ruby-dev.jp>
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+#    https://eclipse.org/org/documents/epl-v10.php.
+# and the Eclipse Distribution License is available at
+#   https://eclipse.org/org/documents/edl-v10.php.
+#
+# Contributors:
+#    Pierre Goudet - initial committer
+
+module PahoMqtt
+  class Subscriber
+
+    attr_reader :subscribed_topics
+
+    def initialize(sender)
+      @waiting_suback    = []
+      @waiting_unsuback  = []
+      @subscribed_mutex  = Mutex.new
+      @subscribed_topics = []
+      @suback_mutex      = Mutex.new
+      @unsuback_mutex    = Mutex.new
+      @sender            = sender
+    end
+
+    def sender=(sender)
+      @sender = sender
+    end
+
+    def config_subscription(new_id)
+      unless @subscribed_topics == [] || @subscribed_topics.nil?
+        packet = PahoMqtt::Packet::Subscribe.new(
+          :id     => new_id,
+          :topics => @subscribed_topics
+        )
+        @subscribed_mutex.synchronize do
+          @subscribed_topics = []
+        end
+        @suback_mutex.synchronize do
+          if @waiting_suback.length >= MAX_SUBACK
+            PahoMqtt.logger.error('SUBACK queue is full, could not send subscribe') if PahoMqtt.logger?
+            return MQTT_ERR_FAILURE
+          end
+          @waiting_suback.push(:id => new_id, :packet => packet, :timestamp => Time.now)
+        end
+        @sender.send_packet(packet)
+      end
+      MQTT_ERR_SUCCESS
+    end
+
+    def add_subscription(max_qos, packet_id, adjust_qos)
+      @suback_mutex.synchronize do
+        adjust_qos, @waiting_suback = @waiting_suback.partition { |pck| pck[:id] == packet_id }
+      end
+      if adjust_qos.length == 1
+        adjust_qos = adjust_qos.first[:packet].topics
+        adjust_qos.each do |t|
+          if [0, 1, 2].include?(max_qos[0])
+            t[1] = max_qos.shift
+          elsif max_qos[0] == 128
+            adjust_qos.delete(t)
+          else
+            PahoMqtt.logger.error("The QoS value is invalid in subscribe.") if PahoMqtt.logger?
+            raise PacketException.new('Invalid suback QoS value')
+          end
+        end
+      else
+        PahoMqtt.logger.error("The packet id is invalid, already used.") if PahoMqtt.logger?
+        raise PacketException.new("Invalid suback packet id: #{packet_id}")
+      end
+      @subscribed_mutex.synchronize do
+        @subscribed_topics.concat(adjust_qos)
+      end
+      return adjust_qos
+    end
+
+    def remove_subscription(packet_id, to_unsub)
+      @unsuback_mutex.synchronize do
+        to_unsub, @waiting_unsuback = @waiting_unsuback.partition { |pck| pck[:id] == packet_id }
+      end
+
+      if to_unsub.length == 1
+        to_unsub = to_unsub.first[:packet].topics
+      else
+        PahoMqtt.logger.error("The packet id is invalid, already used.") if PahoMqtt.logger?
+        raise PacketException.new("Invalid unsuback packet id: #{packet_id}")
+      end
+
+      @subscribed_mutex.synchronize do
+        to_unsub.each do |filter|
+          @subscribed_topics.delete_if { |topic| PahoMqtt.match_filter(topic.first, filter) }
+        end
+      end
+      return to_unsub
+    end
+
+    def send_subscribe(topics, new_id)
+      unless valid_topics?(topics) == MQTT_ERR_FAIL
+        packet = PahoMqtt::Packet::Subscribe.new(
+          :id     => new_id,
+          :topics => topics
+        )
+        @sender.append_to_writing(packet)
+        @suback_mutex.synchronize do
+          if @waiting_suback.length >= MAX_SUBACK
+            PahoMqtt.logger.error('SUBACK queue is full, could not send subscribe') if PahoMqtt.logger?
+            return MQTT_ERR_FAILURE
+          end
+          @waiting_suback.push(:id => new_id, :packet => packet, :timestamp => Time.now)
+        end
+        MQTT_ERR_SUCCESS
+      else
+        raise ProtocolViolation
+      end
+    end
+
+    def send_unsubscribe(topics, new_id)
+      unless valid_topics?(topics) == MQTT_ERR_FAIL
+        packet = PahoMqtt::Packet::Unsubscribe.new(
+          :id     => new_id,
+          :topics => topics
+        )
+
+        @sender.append_to_writing(packet)
+        @unsuback_mutex.synchronize do
+          if @waiting_suback.length >= MAX_UNSUBACK
+            PahoMqtt.logger.error('UNSUBACK queue is full, could not send unbsubscribe') if PahoMqtt.logger?
+            return MQTT_ERR_FAIL
+          end
+          @waiting_unsuback.push(:id => new_id, :packet => packet, :timestamp => Time.now)
+        end
+        MQTT_ERR_SUCCESS
+      else
+        raise ProtocolViolation
+      end
+    end
+
+    def check_waiting_subscriber
+      @sender.check_ack_alive(@waiting_suback, @suback_mutex)
+      @sender.check_ack_alive(@waiting_unsuback, @unsuback_mutex)
+    end
+
+    def valid_topics?(topics)
+      unless topics.length == 0
+        topics.map do |topic|
+          case topic
+          when Array
+            return MQTT_ERR_FAIL if topic.first == ""
+          when String
+            return MQTT_ERR_FAIL if topic == ""
+          end
+        end
+      else
+        MQTT_ERR_FAIL
+      end
+      MQTT_ERR_SUCCESS
+    end
+  end
+end

data/lib/paho_mqtt/version.rb

@@ -0,0 +1,3 @@
+module PahoMqtt
+  VERSION = "1.0.0"
+end

data/samples/client_blocking(reading).rb

@@ -0,0 +1,30 @@
+require 'paho-mqtt'
+
+client = PahoMqtt::Client.new()
+PahoMqtt.logger = 'paho.log'
+
+client.on_message do |pck|
+  puts "New Message: #{pck.topic}\n>>> #{pck.payload}"
+end
+
+wait_suback = true
+client.on_suback do |pck|
+  wait_suback = false
+end
+
+client.connect('localhost', 1883, client.keep_alive, true, true)
+
+Thread.new do
+  while wait_suback do
+    client.loop_read
+    sleep 0.001
+  end
+end
+
+client.subscribe(["topic_test", 2])
+client.loop_write
+
+loop do
+  client.loop_read
+  sleep 0.01
+end

data/samples/client_blocking(writing).rb

@@ -0,0 +1,18 @@
+require 'paho-mqtt'
+
+PahoMqtt.logger = ('paho_mqtt.log')
+
+client = PahoMqtt::Client.new()
+
+client.on_message = lambda { |p|  puts ">>>>> This is the callback for a message event <<<<<\nTopic: #{p.topic}\nPayload: #{p.payload}\nQoS: #{p.qos}" }
+
+
+client.connect('localhost', 1883, client.keep_alive, true, true)
+client.subscribe(["topic_test", 2])
+
+loop do
+  client.publish("topic_test", "Hello, Are you there?", false, 1)
+  client.loop_write
+  client.loop_read
+  sleep 1
+end

data/samples/getting_started.rb

@@ -0,0 +1,49 @@
+require 'paho-mqtt'
+
+### Create a simple client with default attributes
+client = PahoMqtt::Client.new
+PahoMqtt.logger = 'paho_mqtt'
+### Register a callback on message event to display messages
+message_counter = 0
+client.on_message do |message|  
+  puts "Message recieved on topic: #{message.topic}\n>>> #{message.payload}"
+  message_counter += 1
+end
+
+### Register a callback on suback to assert the subcription
+waiting_suback = true
+client.on_suback do
+  waiting_suback = false
+  puts "Subscribed"
+end
+
+### Register a callback for puback event when receiving a puback
+waiting_puback = true
+client.on_puback do
+  waiting_puback = false
+  puts "Message Acknowledged"
+end
+
+### Connect to the eclipse test server on port 1883 (Unencrypted mode)
+client.connect('iot.eclipse.org', 1883)
+
+### Subscribe to a topic
+client.subscribe(['/paho/ruby/test', 2])
+
+### Waiting for the suback answer and excute the previously set on_suback callback
+while waiting_suback do
+  sleep 0.001
+end
+
+### Publlish a message on the topic "/paho/ruby/test" with "retain == false" and "qos == 1"
+client.publish("/paho/ruby/test", "Hello there!", false, 1)
+
+while waiting_puback do
+  sleep 0.001
+end
+
+### Waiting to assert that the message is displayed by on_message callback
+sleep 1
+
+### Calling an explicit disconnect
+client.disconnect

data/samples/test_client.rb

@@ -0,0 +1,70 @@
+require "paho-mqtt"
+require "logger"
+
+cli = PahoMqtt::Client.new({persistent: true, keep_alive: 7})
+PahoMqtt.logger = 'paho_log'
+
+cli.connect('localhost', 1883)
+
+#########################################################
+### Callback settings
+waiting = true
+cli.on_suback { waiting = false}
+
+cli.on_message = lambda { |p|  puts ">>>>> This is a LAMBDA callback for message event <<<<<\nTopic: #{p.topic}\nPayload: #{p.payload}\nQoS: #{p.qos}" }
+
+foo_foo = lambda { |p| puts ">>>>> I am LAMBDA callback for the /foo/foo topic <<<<<" }
+foo_bar = proc { puts ">>>>> I am PROC callback for the /foo/bar topic <<<<<" }
+
+
+cli.add_topic_callback('/foo/tutu') do
+  puts ">>>>> I am BLOCK callback for the /foo/tutu topic <<<<<"
+end
+cli.add_topic_callback('/foo/bar', foo_bar)
+cli.add_topic_callback('/foo/foo', foo_foo)
+
+#########################################################
+
+cli.subscribe(['/foo/foo', 0], ['/foo/bar', 1], ['/foo/tutu', 2], ["/foo", 0])
+
+while waiting do
+  sleep 0.0001
+end
+
+cli.publish("/foo/tutu", "It's me!", false, 2)
+cli.publish("/foo/tutu", "It's you!", false, 1)
+cli.publish("/foo/tutu", "It's them!", false, 0)
+
+cli.publish("/foo/bar", "It's me!", false, 2)
+cli.publish("/foo/bar", "It's you!", false, 1)
+cli.publish("/foo/bar", "It's them!", false, 0)
+
+cli.publish("/foo/foo", "It's me!", false, 2)
+cli.publish("/foo/foo", "It's you!", false, 1)
+cli.publish("/foo/foo", "It's them!", false, 0)
+
+sleep cli.ack_timeout
+
+cli.on_message = nil
+foo_tutu = lambda { |p| puts ">>>>> Changing callback type to LAMBDA for the /foo/tutu topic <<<<<" }
+cli.add_topic_callback('/foo/tutu', foo_tutu)
+cli.add_topic_callback('/foo/bar') do
+  puts ">>>>> Changing callback type to BLOCK for the /foo/bar topic <<<<<"
+end
+
+cli.publish("/foo/tutu", "It's me!", false, 2)
+cli.publish("/foo/tutu", "It's you!", false, 1)
+cli.publish("/foo/tutu", "It's them!", false, 0)
+
+cli.publish("/foo/bar", "It's me!", false, 2)
+cli.publish("/foo/bar", "It's you!", false, 1)
+cli.publish("/foo/bar", "It's them!", false, 0)
+
+sleep cli.ack_timeout
+
+cli.unsubscribe("+/tutu", "+/+")
+
+puts "Waiting 10 sec for keeping alive..."
+sleep 10
+
+cli.disconnect

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: apiotics-paho-mqtt
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mac Dougherty
+- Pierre Goudet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple mqtt client gem
+email:
+- mac@apiotics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- apiotics-paho-mqtt.gemspec
+- bin/console
+- bin/setup
+- lib/paho-mqtt.rb
+- lib/paho_mqtt/client.rb
+- lib/paho_mqtt/connection_helper.rb
+- lib/paho_mqtt/exception.rb
+- lib/paho_mqtt/handler.rb
+- lib/paho_mqtt/packet.rb
+- lib/paho_mqtt/packet/base.rb
+- lib/paho_mqtt/packet/connack.rb
+- lib/paho_mqtt/packet/connect.rb
+- lib/paho_mqtt/packet/disconnect.rb
+- lib/paho_mqtt/packet/pingreq.rb
+- lib/paho_mqtt/packet/pingresp.rb
+- lib/paho_mqtt/packet/puback.rb
+- lib/paho_mqtt/packet/pubcomp.rb
+- lib/paho_mqtt/packet/publish.rb
+- lib/paho_mqtt/packet/pubrec.rb
+- lib/paho_mqtt/packet/pubrel.rb
+- lib/paho_mqtt/packet/suback.rb
+- lib/paho_mqtt/packet/subscribe.rb
+- lib/paho_mqtt/packet/unsuback.rb
+- lib/paho_mqtt/packet/unsubscribe.rb
+- lib/paho_mqtt/publisher.rb
+- lib/paho_mqtt/sender.rb
+- lib/paho_mqtt/ssl_helper.rb
+- lib/paho_mqtt/subscriber.rb
+- lib/paho_mqtt/version.rb
+- samples/client_blocking(reading).rb
+- samples/client_blocking(writing).rb
+- samples/getting_started.rb
+- samples/test_client.rb
+homepage: https://portal.apiotics.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple mqtt client gem
+test_files: []