mqtt-sub_handler 0.0.4 → 0.1.0.dev

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8bedfaba639af0313ac3e07e014ea2b481b870c
-  data.tar.gz: 5b1347d9c8111108728f0a2a2b83c8e35d7db7de
+  metadata.gz: 826fa334ef34a9c8b441343ea1ef8b80652ad4df
+  data.tar.gz: 07cfe57e8b9b7e0d355616f60042991104efff4f
 SHA512:
-  metadata.gz: 1a319b293a833d5821f26705c666ca113308a3de252284ff22a44346e621bd84bbbb4f5dc7fb8ca7d948188a9302487c64388dbcda0fa4087ab2e7bd2d0ae943
-  data.tar.gz: e022767bde84d460fff1fc3375335c43084944ff1f8bf4349e5a9ce80c73b8d405b39ea298d2226b27e8245e366dce014b88c5594f08d8288d73e79eaf51184a
+  metadata.gz: 3c9f4e85523610a599c764980fbbe1258e6641f8074c2f607d99256d7e9984c19be091c92bdd3b3b71c3d51da78e5db423c23167cb41d5d4d7b7c80cc3677507
+  data.tar.gz: fe6f9db5d8bf6b6166898f2f468935f0d555c6a31fddc7beffa56ce89b31c722964c54c41ab8f45daa5422195d54a6d9807978b5553ee5e7787cca27e66b8671

data/README.md

@@ -1,11 +1,7 @@
 
-**Important note:**
-*Right now, I (Xasin) am still in the process of figuring out how to properly set up gems.
-This is my first one, and it has only recently (11.02.18) been published.*
-
-*I'm working on documenting the code, so if you can't figure out how to get it running, come back in a few days or make an issue explaining your problem!*
-
----
+### Where're the tests?
+They're not here yet! But if you know how to set them up, I'd absolutely love to have you contribute.
+Open an issue about that and we can figure things out!
 
 # A topic-based, asynchronous MQTT handler
 That's right, finally there's a *mostly* stable, connection-loss resistant MQTT handler out there that runs fully asynchronously.

data/lib/mqtt/sub_handler.rb

@@ -40,10 +40,10 @@ class SubHandler
 		return nil unless receivedTopicList.length >= topicPattern.length;
 
 		topicPattern.each_index do |i|
-			if(topicPattern[i] == "+") then
+			if(topicPattern[i] == "+")
 				outputTopicList << receivedTopicList[i];
 
-			elsif(topicPattern[i] == "#") then
+			elsif(topicPattern[i] == "#")
 				outputTopicList.concat receivedTopicList[i..-1];
 				return outputTopicList;
 
@@ -76,7 +76,7 @@ class SubHandler
 	def raw_subscribe_to(topic, qos: 1)
 		begin
 			@conChangeMutex.lock
-			if not @connected then
+			if not @connected
 				@subscribeQueue << [topic, qos];
 				@conChangeMutex.unlock
 			else
@@ -128,7 +128,7 @@ class SubHandler
 	# @yieldparam topicList [Array<String>] The wildcard topic branches matched.
 	# @yieldreturn [Boolean] Whether or not the data was sufficient, and capture should be stopped.
 	def wait_for(topic, qos: 1, timeout: nil)
-		unless block_given? then
+		unless block_given?
 			raise ArgumentError, "A block for data-processing needs to be passed!"
 		end
 
@@ -136,10 +136,10 @@ class SubHandler
 		register_subscription(subObject);
 
 		begin
-		Timeout::timeout(timeout) do
+		Timeout.timeout(timeout) do
 			loop do
 				return_data = subObject.waitpoint.wait()[1];
-				if yield(return_data[0], return_data[1]) then
+				if yield(return_data[0], return_data[1])
 					return true;
 				end
 			end
@@ -208,7 +208,7 @@ class SubHandler
 
 		begin
 			@conChangeMutex.lock
-			if not @connected then
+			if not @connected
 				@publishQueue << {topic: topic, data: data, qos: qos, retain: retain} unless qos == 0
 				@conChangeMutex.unlock
 			else
@@ -222,10 +222,51 @@ class SubHandler
 	end
 	alias publishTo publish_to
 
+	def ensure_clean_start()
+		@mqttWasStartedClean = @mqtt.clean_session
+		if @mqttWasStartedClean
+			begin
+				@mqtt.connect();
+				@mqtt.disconnect();
+			rescue MQTT::Exception
+				sleep 1;
+				retry
+			rescue SocketError, SystemCallError
+				sleep 5
+				retry
+			end
+			@mqtt.clean_session=false;
+		end
+	end
+	private :ensure_clean_start
+
+	def ensure_clean_exit()
+		if(@mqttWasStartedClean)
+			print "Logging out of mqtt server... "
+			begin
+			Timeout.timeout(10) {
+				begin
+					@mqtt.clean_session = true;
+					@mqtt.disconnect();
+					@mqtt.connect();
+				rescue MQTT::Exception, SocketError, SystemCallError
+					sleep 1
+					retry;
+				end
+			}
+			rescue  Timeout::Error
+				puts "Timed out, aborting!";
+			else
+				puts "Done."
+			end
+		end
+	end
+	private :ensure_clean_exit
+
 	def mqtt_resub_thread
 		while(true)
 			begin
-				Timeout::timeout(10) {
+				Timeout.timeout(10) {
 					@mqtt.connect()
 				}
 				@conChangeMutex.synchronize {
@@ -270,12 +311,12 @@ class SubHandler
 	end
 	def flush_pubqueue()
 		puts "\n";
-		if @publishQueue.empty? then
+		if @publishQueue.empty?
 			puts "MQTT buffer empty, continuing."
 		else
 			print "Finishing sending of MQTT messages ... "
 			begin
-				Timeout::timeout(10) {
+				Timeout.timeout(10) {
 					until @publishQueue.empty? do
 						sleep 0.05;
 					end
@@ -299,7 +340,7 @@ class SubHandler
 	#  mqtt = MQTT::SubHandler.new(MQTT::Client.new("Your.Client.Opts"))
 	def initialize(mqttClient)
 		@callbackList = Array.new();
-		if mqttClient.is_a? String then
+		if mqttClient.is_a? String
 			@mqtt = MQTT::Client.new(mqttClient);
 		else
 			@mqtt = mqttClient;
@@ -317,52 +358,19 @@ class SubHandler
 		@trackerHash = Hash.new();
 
 		@listenerThread = Thread.new do
-			if @mqtt.clean_session
-				@mqttWasStartedClean = true;
-				begin
-					@mqtt.connect();
-					@mqtt.disconnect();
-				rescue MQTT::Exception
-					sleep 1;
-					retry
-				rescue SocketError, SystemCallError
-					sleep 5
-					retry
-				end
-				@mqtt.clean_session=false;
-			end
-
-			mqtt_resub_thread
+			ensure_clean_start();
+			mqtt_resub_thread();
 		end
 		@listenerThread.abort_on_exception = true;
 
 		at_exit {
-			flush_pubqueue
+			flush_pubqueue();
 			@listenerThread.kill();
-
-			if(@mqttWasStartedClean) then
-				print "Logging out of mqtt server... "
-				begin
-				Timeout::timeout(10) {
-					begin
-						@mqtt.clean_session = true;
-						@mqtt.disconnect();
-						@mqtt.connect();
-					rescue MQTT::Exception, SocketError, SystemCallError
-						sleep 1
-						retry;
-					end
-				}
-				rescue  Timeout::Error
-					puts "Timed out, aborting!";
-				else
-					puts "Done."
-				end
-			end
+			ensure_clean_exit();
 		}
 
 		begin
-		Timeout::timeout(10) {
+		Timeout.timeout(10) {
 			until(@connected) do sleep 0.1; end
 		}
 		rescue Timeout::Error

data/lib/mqtt/sub_testing.rb

@@ -0,0 +1,105 @@
+
+require "mqtt/sub_handler"
+
+module MQTT
+	module Testing
+		# This class is meant purely for testing.
+		#  It completely removes the need for a external MQTT broker, and captures errors.
+		#  Message processing can be done step-by-step, for better analysis of errors.
+		#  Its interface is identical to the main class, making it indistinguishable.
+		class SubHandler < MQTT::SubHandler
+			attr_reader		:message_log
+			attr_reader		:publish_queue
+			attr_accessor 	:retained_topics
+
+			def call_interested(topic, data)
+				@callbackList.each do |h|
+					tMatch = SubHandler.getTopicMatch(topic, h.topic_split);
+					if tMatch then
+						begin
+							h.offer(tMatch, data)
+						rescue StandardError => e
+							if(@error_handler)
+								@error_handler.call(e);
+							else
+								raise
+							end
+							return
+						end
+					end
+				end
+			end
+			private :call_interested
+
+			def raw_subscribe_to(topic, qos: nil)
+				if(@retained_topics[topic]) then
+					publish_to(topic, @retained_topics[topic])
+				end
+			end
+			private :raw_subscribe_to
+
+			# Publish a message to topic.
+			# @param topic [String] The topic to push to.
+			# @param data [String] The data to be transmitted.
+			# @note The published data is not immediately processed.
+			#  Use process_message or process_all
+			def publish_to(topic, data, qos: nil, retain: false)
+				@publish_queue 		<< [topic, data];
+				@message_log[topic] 	<< data;
+				@retained_topics[topic] = data if retain;
+			end
+
+			# Process a single MQTT message in queue, recording errors etc.
+			def process_message
+				return if @publish_queue.empty?
+				packet = @publish_queue.pop
+				call_interested(packet[0], packet[1]);
+			end
+
+			# Process all messages until the queue is empty.
+			#  Do remember that the callbacks can publish new data, which then gets processed again!
+			# @param max_loops [Integer] Amount of loops to do before aborting
+			# @param error_on_loop [Boolean] Raise an error if too many loops happened?
+			def process_all(max_loops: 500, error_on_loop: true)
+				until @publish_queue.empty?
+					process_message
+					max_loops -= 1;
+					if(max_loops == 0)
+						if(error_on_loop)
+							raise RuntimeError, "MQTT Loop recursion detected!"
+						end
+						return
+					end
+				end
+			end
+
+			# Prepare the code for the next test by cleaning out all queues.
+			#  The list of callbacks is not affected
+			# @param retained [Boolean, Hash<String, String>] Either a bool whether or not to clear retained messages,
+			#  or a Hash with Topic-Keys containing String-Data to use.
+			def prepare(retained: true)
+				@publish_queue.clear();
+				if(retained.is_a? Hash)
+					@retained_topics = retained.clone
+					@retained_topics.each do |topic, data|
+						publish_to(topic, data);
+					end
+				elsif(retained)
+					@retained_topics = Hash.new();
+				end
+				@message_log.clear()
+			end
+
+			def initialize()
+				@callbackList    = Array.new();
+				@retained_topics = Hash.new();
+				@publish_queue   = Queue.new();
+				@message_log	  = Hash.new() do |h, key| h = Array.new() end;
+			end
+
+			def on_error(&handler)
+				@error_handler = handler;
+			end
+		end
+	end
+end

data/lib/mqtt/subscription_classes.rb

@@ -9,7 +9,7 @@ module MQTT
 			attr_reader :qos
 			attr_reader :topic_split
 
-			def initialize(topic, qos)
+			def initialize(topic, _qos)
 				@topic 		 = topic;
 				@topic_split = SubHandler.getTopicSplit(topic);
 
@@ -56,7 +56,7 @@ module MQTT
 				@callbackList = Array.new();
 			end
 
-			def offer(topicList, data)
+			def offer(_topicList, data)
 				return if data == @value;
 				oldValue = @value;
 				@value = data;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqtt-sub_handler
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0.dev
 platform: ruby
 authors:
 - Xasin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt
@@ -34,6 +34,7 @@ files:
 - README.md
 - lib/mqtt/Waitpoint.rb
 - lib/mqtt/sub_handler.rb
+- lib/mqtt/sub_testing.rb
 - lib/mqtt/subscription_classes.rb
 homepage: https://github.com/XasWorks/XasCode/tree/MQTT_GEM/Ruby/MQTT
 licenses:
@@ -50,9 +51,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14.1