mqtt-sub_handler 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77c5c7ff31447b119bde650cc2bab092e930fb1e
-  data.tar.gz: 73f5d04c7d2acb4da546ab3b9a16995e643a96ab
+  metadata.gz: eea6058ba5750daeebbf41696765e1702b60495a
+  data.tar.gz: 3dbea34eea6371096173df3cccf2468d682e0786
 SHA512:
-  metadata.gz: ecb77d9ee3bdf6d121edf8c19808c973a3a1c9ca1736119793d7b2a6afa0abb2720b7ab4e4613a6165ac473db1ee36ca0d746af6c3add4ac3e5fa58d9ad89e55
-  data.tar.gz: 1cb20f6c9c7a6e40a09b36d868e65698aaa953a5cd48e5a6f55ca18cb73d965d6f5c99ffdbda0f356f0407e175f3f432204bd3e9edbee966a49ae4579f5f2c86
+  metadata.gz: 9cda8aadc97990675ca7d3b443fa69f82dfb253a4c67eddad0f0bc7a769b24012d30947cd8e7d72df417eea919981590a17e3166e7aa31f9a7deb6bde58d9478
+  data.tar.gz: 1cf6cd63dde250ad6da0d09dbea8b0610cbd375db61305df229d31951961902d26d789fe476b77b9d9be932f9ffcf779474d70372b8a2c30bbbee84d8582534b

data/lib/mqtt/persistence.rb

@@ -0,0 +1,175 @@
+
+require 'json'
+require_relative 'persistence_extensions.rb'
+
+module MQTT
+	class Persistence
+		# Provide persistence for tasks that regularly restart, using MQTT retained messages.
+		# As a fun side effect, this also allows for live monitoring and modifying!
+		#
+		# @author Xasin
+
+
+		# Initialize the Persistence instance.
+		#  This will immediately connect and subscribe to the wildcard of `dir + "/#"`
+		# @param mqtt [MQTT::SubHandler] The MQTT instance to use for storing/communication
+		# @param dir [String] A valid MQTT topic string under which to nest the persistence.
+		def initialize(mqtt, dir = "Persistence")
+			raise ArgumentError, "Not a mqtt class!" unless mqtt.is_a? MQTT::SubHandler
+
+			@mqtt = mqtt;
+			@dir  = dir;
+
+			@rawData   = Hash.new();
+			@paramList = Hash.new();
+
+			@mqtt.subscribe_to "#{@dir}/+" do |data, key|
+				_process_data(data, key[0].to_sym);
+			end
+		end
+
+
+		# Prepare a piece of data to be sent to the MQTT topic
+		# It must either respond to `to_mqtt_string` or to `to_json`
+		def _prepare_send(data, key)
+			if(data.respond_to? :to_mqtt_string)
+				return data.to_mqtt_string;
+			else
+				return data.to_json
+			end
+		end
+		private :_prepare_send
+
+		# Parse a raw String received from MQTT.
+		# If the given class type responds to `from_mqtt_string`, that
+		# function is used for processing.
+		# `JSON.parse` will be used otherwise.
+		# @return [key-type, nil] Returns the parsed data, nil if that fails.
+		def _parse_received(data, key)
+			begin
+				dType = @paramList[key][:type];
+				if(dType.respond_to? :from_mqtt_string)
+					return dType.from_mqtt_string(data);
+				else
+					return JSON.parse(data, symbolize_names: true);
+				end
+			rescue JSON::ParserError
+				return nil;
+			end
+		end
+		private :_parse_received
+
+		# This processes new data received from MQTT.
+		# It returns if the raw string hasn't changed, and will trigger the callbacks.
+		def _process_data(data, key)
+			return if @rawData[key] == data;
+			@rawData[key] = data;
+
+			return unless param = @paramList[key];
+
+			oldData = param[:current];
+			param[:current] = _parse_received(data, key);
+			param[:cbList].each do |cb|
+				cb.call(param[:current], oldData);
+			end
+
+			if(param[:first])
+				param.delete :first
+				param[:cbList] = [param[:cbList], param[:change_cb]].flatten;
+			end
+		end
+		private :_process_data
+
+		# Force setting up a key, overwriting what was already configured.
+		# You usually don't need this!
+		# @param key [Symbol] The key that should be set up.
+		# @param type_class [#from_mqtt_string] The class to use to parse the data. A JSON-conversion
+		#  is used if the class doesn't respond to `from_mqtt_string`
+		def setup!(key, type_class = nil)
+			raise ArgumentError, "Key needs to be a symbol!" unless key.is_a? Symbol
+
+			@paramList[key] = {
+				type: 	type_class,
+				current: nil,
+				cbList:	Array.new(),
+
+				first:		true,
+				change_cb:	Array.new(),
+			}
+
+			if(data = @rawData[key])
+				@rawData[key] = nil;
+				_process_data(data, key);
+			end
+		end
+		# Set up a key, unless it has already been configured.
+		# @param (See #setup!)
+		def setup(key, type_class = nil)
+			return if @paramList.key? key;
+			setup!(key, type_class);
+		end
+
+		# Read out a given, set-up key, returning `nil` if nothing has been read yet (or the value is nil right now),
+		# returning the data otherwise.
+		# If a block is given (using the on_set alias), this block will be added as a callback.
+		# @param key [Symbol] The key to fetch. Must have been set up first!
+		# @yieldparam newData The newly parsed data (depending on the key's type.)
+		# @yieldparam oldData The former data that was present.
+		def [](key, &callback)
+			raise ArgumentError, "Key needs to be a symbol!" unless key.is_a? Symbol
+			raise ArgumentError, "Key has not been set up!" unless @paramList.key? key;
+
+			if(callback)
+				@paramList[key][:cbList] << callback
+				yield(@paramList[key][:current], nil) if @paramList[key][:current]
+			end
+
+			return @paramList[key][:current];
+		end
+		alias on_set []
+
+		# Set a given key to a new value, provided the key has been set up.
+		# Will run the `on_change` and `on_set` callbacks immediately, then publish to MQTT.
+		# @param key [Symbol] The key to write. Must have been set up first!
+		# @param data [#to_json, #to_mqtt_string] The data to write.
+		def []=(key, data)
+			raise ArgumentError, "Key needs to be a symbol!" unless key.is_a? Symbol
+			raise ArgumentError, "Key has not been set up!" unless param = @paramList[key];
+
+			newString = _prepare_send(data, key);
+			return if @rawData[key] == newString;
+			@rawData[key] = newString;
+
+			if(param[:first])
+				param.delete :first
+				param[:cbList] = [param[:cbList], param[:change_cb]].flatten;
+			end
+
+			oldData = param[:current];
+			param[:current] = data;
+			param[:cbList].each do |cb|
+				cb.call(param[:current], oldData);
+			end
+
+			@mqtt.publish_to "#{@dir}/#{key}", newString, retain: true;
+		end
+
+		# Add a callback to be triggered whenever the key's value changes.
+		# The slight difference to `on_set` is that this callback is not executed on the very first
+		# value received from MQTT, making it easier to not trigger some code on restart, only on actual changes.
+		# @param (See #[])
+		# @yieldparam (See #[])
+		def on_change(key, &callback)
+			raise ArgumentError, "Key needs to be a symbol!" unless key.is_a? Symbol
+			raise ArgumentError, "Key has not been set up!" unless @paramList.key? key;
+
+			raise ArgumentError, "A callback needs to be given!" unless callback;
+
+			if(@paramList[key][:first])
+				@paramList[key][:change_cb] << callback;
+			else
+				@paramList[key][:cbList] << callback;
+			end
+		end
+	end
+end

data/lib/mqtt/persistence_extensions.rb

@@ -0,0 +1,13 @@
+
+class Time
+	def to_mqtt_string
+		to_f().to_json()
+	end
+
+	def self.from_mqtt_string(string)
+		data = JSON.parse(string);
+		return nil unless data.is_a? Numeric;
+
+		return self.at(data);
+	end
+end

data/lib/mqtt/sub_testing.rb

@@ -26,8 +26,10 @@ module MQTT
 			private :call_interested
 
 			def raw_subscribe_to(topic, qos: nil)
-				if(@retained_topics[topic]) then
-					publish_to(topic, @retained_topics[topic])
+				@retained_topics.each do |retTopic, retData|
+					if SubHandler.getTopicMatch(retTopic, SubHandler.get_topic_split(topic))
+						publish_to(retTopic, retData)
+					end
 				end
 			end
 			private :raw_subscribe_to

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqtt-sub_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Xasin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt
@@ -89,10 +89,12 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/mqtt/Waitpoint.rb
+- lib/mqtt/persistence.rb
+- lib/mqtt/persistence_extensions.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
+homepage: https://github.com/XasWorks/XasCode/tree/master/Ruby/MQTT
 licenses:
 - GPL-3.0
 metadata: {}
@@ -112,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Asynchronous, topic-based MQTT gem