mqtt-sub_handler 0.1.0.dev → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 826fa334ef34a9c8b441343ea1ef8b80652ad4df
-  data.tar.gz: 07cfe57e8b9b7e0d355616f60042991104efff4f
+  metadata.gz: 77c5c7ff31447b119bde650cc2bab092e930fb1e
+  data.tar.gz: 73f5d04c7d2acb4da546ab3b9a16995e643a96ab
 SHA512:
-  metadata.gz: 3c9f4e85523610a599c764980fbbe1258e6641f8074c2f607d99256d7e9984c19be091c92bdd3b3b71c3d51da78e5db423c23167cb41d5d4d7b7c80cc3677507
-  data.tar.gz: fe6f9db5d8bf6b6166898f2f468935f0d555c6a31fddc7beffa56ce89b31c722964c54c41ab8f45daa5422195d54a6d9807978b5553ee5e7787cca27e66b8671
+  metadata.gz: ecb77d9ee3bdf6d121edf8c19808c973a3a1c9ca1736119793d7b2a6afa0abb2720b7ab4e4613a6165ac473db1ee36ca0d746af6c3add4ac3e5fa58d9ad89e55
+  data.tar.gz: 1cb20f6c9c7a6e40a09b36d868e65698aaa953a5cd48e5a6f55ca18cb73d965d6f5c99ffdbda0f356f0407e175f3f432204bd3e9edbee966a49ae4579f5f2c86

data/README.md

@@ -1,8 +1,3 @@
-
-### 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.
 What's even nicer is that you can attach (and detach!) callbacks to *any* topic you want - including wildcards!

data/lib/mqtt/sub_handler.rb

@@ -1,8 +1,9 @@
 
 require 'timeout'
 require 'mqtt'
+require 'json'
 
-require 'mqtt/subscription_classes'
+require_relative 'subscription_classes.rb'
 
 # @author Xasin
 module MQTT
@@ -15,11 +16,14 @@ end
 
 
 class SubHandler
+	# Whether or not hashes and arrays should be converted to JSON when sending
+	attr_accessor :jsonifyHashes
+
 	# Split a Topic into a Topic-Array
 	# @param topicName [String] The string topic which to split
 	# @return [Array<String>] A list of individual topic-branches
 	# @note This function is mainly used for background processing.
-	def self.getTopicSplit(topicName)
+	def self.get_topic_split(topicName)
 		return topicName.scan(/[^\/]+/);
 	end
 
@@ -27,13 +31,13 @@ class SubHandler
 	# @param receivedTopicString [String] The string (as
 	#  returned by MQTT.get) to compare
 	# @param topicPattern [Array<String>] The Topic-Array (as
-	#  returned by .getTopicSplit) to compare against
+	#  returned by .get_topic_split) to compare against
 	# @return [nil, Array<String>] Nil if no match was found.
 	#  An Array of matched wildcard topic branches (can be empty) when
 	#  successfully matched
-	# @note (see .getTopicSplit)
+	# @note (see .get_topic_split)
 	def self.getTopicMatch(receivedTopicString, topicPattern)
-		receivedTopicList = getTopicSplit receivedTopicString;
+		receivedTopicList = get_topic_split receivedTopicString;
 
 		outputTopicList = Array.new();
 
@@ -206,6 +210,10 @@ class SubHandler
 	def publish_to(topic, data, qos: 1, retain: false)
 		raise ArgumentError, "Wrong symbol in topic: #{topic}" if topic =~ /[#\+]/
 
+		if(@jsonifyHashes and (data.is_a? Array or data.is_a? Hash))
+			data = data.to_json
+		end
+
 		begin
 			@conChangeMutex.lock
 			if not @connected
@@ -335,10 +343,12 @@ class SubHandler
 	# @param mqttClient [String, MQTT::Client] Either a URI to connect to, or a MQTT::Client
 	#  The URI can be of the form "mqtts://Password@User:URL:port".
 	#  The MQTT client instance can be fully configured, as specified by the MQTT Gem. It must *not* already be connected!
+	# @param jsonify [Boolean] Should Hashes and Arrays input into publish_to be converted to JSON?
+	#  This can be useful to have one less .to_json call. Default is true.
 	# @example Starting the handler
 	#  mqtt = MQTT::SubHandler.new('iot.eclipse.org');
 	#  mqtt = MQTT::SubHandler.new(MQTT::Client.new("Your.Client.Opts"))
-	def initialize(mqttClient)
+	def initialize(mqttClient, jsonify: true)
 		@callbackList = Array.new();
 		if mqttClient.is_a? String
 			@mqtt = MQTT::Client.new(mqttClient);
@@ -346,6 +356,8 @@ class SubHandler
 			@mqtt = mqttClient;
 		end
 
+		@jsonifyHashes = jsonify;
+
 		@conChangeMutex = Mutex.new();
 		@connected 		= false;
 

data/lib/mqtt/sub_testing.rb

@@ -1,5 +1,6 @@
 
-require "mqtt/sub_handler"
+require_relative "sub_handler.rb"
+require 'securerandom'
 
 module MQTT
 	module Testing
@@ -12,20 +13,13 @@ module MQTT
 			attr_reader		:publish_queue
 			attr_accessor 	:retained_topics
 
+			attr_accessor  :test_handler
+
 			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
+						h.offer(tMatch, data)
 					end
 				end
 			end
@@ -44,6 +38,12 @@ module MQTT
 			# @note The published data is not immediately processed.
 			#  Use process_message or process_all
 			def publish_to(topic, data, qos: nil, retain: false)
+				if(@jsonifyHashes and (data.is_a? Array or data.is_a? Hash))
+					data = data.to_json
+				else
+					data = data.to_s;
+				end
+
 				@publish_queue 		<< [topic, data];
 				@message_log[topic] 	<< data;
 				@retained_topics[topic] = data if retain;
@@ -64,13 +64,33 @@ module MQTT
 				until @publish_queue.empty?
 					process_message
 					max_loops -= 1;
+
 					if(max_loops == 0)
 						if(error_on_loop)
-							raise RuntimeError, "MQTT Loop recursion detected!"
+							if(@test_handler)
+								@test_handler.flunk("MQTT Loop recursion detected")
+							else
+								raise RuntimeError, "MQTT Loop recursion detected"
+							end
 						end
 						return
 					end
 				end
+
+				if(error_on_loop and @test_handler)
+					@test_handler.pass("No MQTT Loop recursion.");
+				end
+			end
+
+			def assert_garbage_resilient()
+				@callbackList.each do |c|
+					t = Array.new() {|a,k| a[k] = SecureRandom.random_bytes(100)}
+					c.offer(t, SecureRandom.random_bytes(100));
+				end
+
+				if(@test_handler)
+					@test_handler.pass("No garbage message problem detected.");
+				end
 			end
 
 			# Prepare the code for the next test by cleaning out all queues.
@@ -90,15 +110,31 @@ module MQTT
 				@message_log.clear()
 			end
 
-			def initialize()
+			# Perform a complete reset of the testing unit, clearing out all
+			#  queues and removing all callbacks. This should mainly be used
+			#  inside the teardown or setup routines, before creating a new
+			#  testing instance, to prevent uncleaned garbage.
+			def full_reset()
+				@callbackList.clear();
+				prepare();
+			end
+
+			# Initialize the test class
+			# @param jsonify [Boolean] Whether or not Hashes and Arrays should be
+			#  converted to JSON before sending.
+			# @param test_handler [nil, MiniTest::Test] The test handler to use to report
+			#  errors or pass sanity checks. Must support flunk and pass!
+			def initialize(jsonify: true, test_handler: nil)
 				@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;
+				@trackerHash = Hash.new();
+
+				@jsonifyHashes = jsonify;
+
+				@test_handler = test_handler;
 			end
 		end
 	end

data/lib/mqtt/subscription_classes.rb

@@ -1,5 +1,5 @@
 
-require 'mqtt/Waitpoint.rb'
+require_relative 'Waitpoint.rb'
 
 module MQTT
 	module Subscriptions
@@ -11,7 +11,7 @@ module MQTT
 
 			def initialize(topic, _qos)
 				@topic 		 = topic;
-				@topic_split = SubHandler.getTopicSplit(topic);
+				@topic_split = SubHandler.get_topic_split(topic);
 
 				@qos 			= 0;
 			end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqtt-sub_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.0.dev
+  version: 0.1.0
 platform: ruby
 authors:
 - Xasin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt
@@ -24,6 +24,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Asynchronous handling of callbacks that can be attached to individual
   topics, based on the mqtt gem.
 email: 
@@ -51,9 +107,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14.1