apiotics_aws_iot_client 1.0.1

data/lib/aws_iot_device/mqtt_adapter/ruby_mqtt_adapter.rb

@@ -0,0 +1,183 @@
+require 'mqtt'
+require 'thread'
+
+module AwsIotDevice
+  module MqttAdapter
+    class RubyMqttAdapter
+
+      attr_reader :client_id
+
+      attr_accessor :filtered_topics
+
+      def initialize(*args)
+        @client = MQTT::Client.new(*args)
+        @filtered_topics = {}
+        @client_id = ""
+        @client_id = generate_client_id
+      end
+
+      def client_id
+        @client_id
+      end
+
+      def publish(topic, payload='', retain=false, qos=0)
+        @client.publish(topic, payload, retain, qos)
+      end
+
+      def create_client(*args)
+        @client = MQTT::Client.new(*args)
+      end
+
+      def connect(*args, &block)
+        @client = create_client(*args) if @client.nil?
+        @client.connect(&block)
+        loop_start
+      end
+
+      def generate_client_id(prefix='ruby', lenght=16)
+        charset = Array('A'..'Z') + Array('a'..'z') + Array('0'..'9')
+        @client_id << prefix << Array.new(lenght) { charset.sample }.join
+      end
+
+      def ssl_context
+        @client.ssl_context
+      end
+
+      def disconnect(send_msg=true)
+        @client.disconnect(send_msg)
+      end
+
+      def connected?
+        @client.connected?
+      end
+
+      def subscribe(topics, qos=0)
+        @client.subscribe(topics, qos)
+      end
+
+      def get(topic=nil, &block)
+        @client.get(topic, &block)
+      end
+
+      def get_packet(topic=nil, &block)
+        @client.get_packet(topic, &block)
+      end
+
+      def queue_empty?
+        @client.queue_empty?
+      end
+
+      def queue_length
+        @client.queue_length
+      end
+
+      def unsubscribe(*topics)
+        @client.unsubscribe(*topics)
+      end
+
+      def host
+        @client.host
+      end
+
+      def host=(host)
+        @client.host = host
+      end
+
+      def port
+        @client.port
+      end
+
+      def port=(port)
+        @client.port = port
+      end
+
+      def ssl=(ssl)
+        @client.ssl = ssl
+      end
+
+      def set_tls_ssl_context(ca_cert, cert=nil, key=nil)
+        @client.ssl ||= true
+        @client.ssl_context
+        @client.cert_file = cert
+        @client.key_file = key
+        @client.ca_file = ca_cert
+      end
+
+      ############### Custom Features #################
+
+      def loop_start
+        Thread.new{ loop_forever }
+      end
+
+      def loop_stop(thread)
+        thread.join
+      end
+
+      def loop_forever
+        loop do
+          mqtt_loop
+          sleep 0.005
+        end
+      end
+
+      def mqtt_loop
+        loop_read
+        loop_write
+        loop_misc
+      end
+
+      def loop_read(max_message=10)
+        counter_message = 0
+        while !@client.queue_empty? && counter_message <= max_message
+          message = get_packet
+          ### Fitlering message if matching to filtered topic
+          topic = message.topic
+          if @filtered_topics.key?(topic)
+            callback = @filtered_topics[topic]
+            callback.call(message)
+          else
+            on_message_callback(message)
+          end
+          counter_message += 1
+        end
+      end
+
+      def loop_write
+        puts "loop_write is unavailable for ruby-mqtt client's"
+      end
+
+      def loop_misc
+        puts "loop_misc is unavailable for ruby-mqtt client's"
+      end
+
+      def on_message=(callback)
+        @on_message = callback
+      end
+
+      def on_message(&block)
+        @on_message = block if block_given?
+        @on_message
+      end
+
+      def on_message_callback(message)
+        if @on_message.is_a?(Proc) || @on_message.lambda?
+          @on_message.call(message)
+        end
+      end
+
+      def add_callback_filter_topic(topic, callback)
+        unless callback.nil?
+          @filtered_topics[topic] = callback
+        else
+          @filtered_topic.delete(topic)
+        end
+      end
+
+      def remove_callback_filter_topic(topic)
+        if @filtered_topics.key(topic)
+          @filtered_topics.delete(topic)
+        end
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_shadow_client.rb

@@ -0,0 +1,7 @@
+require 'aws_iot_device/mqtt_shadow_client/shadow_client'
+
+module AwsIotDevice
+  module MqttShadowClient
+    ACTION_NAME = %w(get update delete delta).freeze
+  end
+end

data/lib/aws_iot_device/mqtt_shadow_client/json_payload_parser.rb

@@ -0,0 +1,34 @@
+require 'securerandom'
+require 'timers'
+require 'thread'
+require 'json'
+
+module AwsIotDevice
+  module MqttShadowClient
+    class JSONPayloadParser
+      ### This class acts as Basic JSON parser.
+      ### The answer from AWS is in a JSON format.
+      ### All different key of the JSON file should be defined as hash key
+
+      def initialize
+        @message = {}
+      end
+
+      def set_message(message)
+        @message = JSON.parse(message)
+      end
+
+      def get_attribute_value(key)
+        @message[key]
+      end
+
+      def set_attribute_value(key, value)
+        @message[key] = value
+      end
+
+      def get_json
+        @message.to_json
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_shadow_client/mqtt_manager.rb

@@ -0,0 +1,201 @@
+require 'thread'
+
+module AwsIotDevice
+  module MqttShadowClient
+    class MqttManager
+
+      attr_reader :client_id
+
+      attr_accessor :connection_timeout_s
+
+      attr_accessor :mqtt_operation_timeout_s
+
+      attr_accessor :ssl
+
+      def initialize(*args)
+        @client = create_mqtt_adapter(*args)
+        @mqtt_operation_timeout_s = 2
+        @mutex_publish = Mutex.new()
+        @mutex_subscribe = Mutex.new()
+        @mutex_unsubscribe = Mutex.new()
+      end
+
+      def host=(host)
+        @client.host = host
+      end
+
+      def host
+        @client.host
+      end
+
+      def port=(port)
+       @client.port = port
+      end
+
+      def port
+        @client.port
+      end
+      
+      def client_id
+        @client.client_id
+      end
+
+      def create_mqtt_adapter(*args)
+        @client = MqttAdapter::Client.new(*args)
+      end
+
+      def config_endpoint(host, port)
+        raise ArgumentError, "configure endpoint either host or port is nil" if host.nil? || port.nil?
+        @client.host = host
+        @client.port = port
+      end
+
+      def config_ssl_context(ca_file, key, cert)
+        self.ca_file = ca_file
+        self.key = key
+        self.cert = cert
+        @client.set_tls_ssl_context(@ca_file, @cert, @key)
+      end
+
+      def connect(*args, &block)
+        ### Execute a mqtt opration loop in background for time period defined by mqtt_connection_timeout
+        @client.connect(*args, &block)
+      end
+
+      def disconnect
+        @client.disconnect
+      end
+
+      def publish(topic, payload="", retain=nil, qos=0)
+        raise ArgumentError, "publish topic cannot be nil" if topic.nil?
+        @mutex_publish.synchronize {
+          @client.publish(topic, payload, retain, qos)
+        }
+      end
+
+      def subscribe(topic, qos=0, callback=nil)
+        raise ArgumentError, "subscribe topic cannot be nil" if topic.nil?
+        @mutex_subscribe.synchronize {
+          @client.add_callback_filter_topic(topic, callback)
+          @client.subscribe(topic, qos)
+        }
+      end
+
+      def subscribe_bunch(*topics)
+        @mutex_subscribe.synchronize {
+          topics.each do |topic|
+            @client.add_callback_filter_topic(topic.first, topic.pop) if !topic[2].nil? && topic[2].is_a?(Proc)
+          end
+          @client.subscribe_bunch(topics)
+        }
+      end
+      
+      def unsubscribe(topic)
+        raise ArgumentError, "unsubscribe topic cannot be nil" if topic.nil?
+        @mutex_unsubscribe.synchronize{
+          @client.remove_callback_filter_topic(topic)
+          @client.unsubscribe(topic)
+        }
+      end
+
+      def unsubscribe_bunch(*topics)
+        @mutex_unsubscribe.synchronize {
+          topics.each do |topic|
+            @client.remove_callback_filter_topic(topic)
+          end
+          @client.unsubscribe_bunch(topics)
+        }
+      end
+
+      def on_connack=(callback)
+        @client.on_connack = callback if paho_client?
+      end
+
+      def on_suback=(callback)
+        @client.on_suback = callback if paho_client?
+      end
+
+      def on_unsuback=(callback)
+        @client.on_unsuback = callback if paho_client?
+      end
+
+      def on_puback=(callback)
+        @client.on_puback = callback if paho_client?
+      end
+
+      def on_pubrec=(callback)
+        @client.on_pubrec = callback if paho_client?
+      end
+
+      def on_pubrel=(callback)
+        @client.on_pubrel = callback if paho_client?
+      end
+
+      def on_pubcomp=(callback)
+        @client.on_pubcomp = callback if paho_client?
+      end
+
+      def on_message=(callback)
+        @client.on_message = callback
+      end
+
+      def on_connack(&block)
+        @client.on_connack(&block) if paho_client?
+      end
+
+      def on_suback(&block)
+        @client.on_suback(&block) if paho_client?
+      end
+
+      def on_unsuback(&block)
+        @client.on_unsuback(&block) if paho_client?
+      end
+
+      def on_puback(&block)
+        @client.on_puback(&block) if paho_client?
+      end
+
+      def on_pubrec(&block)
+        @client.on_pubrec(&block) if paho_client?
+      end
+
+      def on_pubrel(&block)
+        @client.on_pubrel(&block) if paho_client?
+      end
+
+      def on_pubcomp(&block)
+        @client.on_pubcomp(&block) if paho_client?
+      end
+
+      def on_message(&block)
+        @client.on_message(&block)
+      end
+
+      def add_topic_callback(topic, callback, &block)
+        @client.add_callback_filter_topic(topic, callback, &block)
+      end
+
+      def remove_topic_callback(topic)
+        @client.remove_callback_filter_topic(topic)
+      end
+
+      def paho_client?
+        @client.adapter.class == MqttAdapter::PahoMqttAdapter
+      end
+
+      private
+
+      def cert=(path)
+        @cert = path
+      end
+
+      def key=(path)
+        @key = path
+      end
+
+      def ca_file=(path)
+        @ca_file = path
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_shadow_client/shadow_action_manager.rb

@@ -0,0 +1,318 @@
+require 'securerandom'
+require 'timers'
+require 'thread'
+require 'json'
+require 'aws_iot_device/mqtt_shadow_client/token_creator'
+require 'aws_iot_device/mqtt_shadow_client/json_payload_parser'
+
+module AwsIotDevice
+  module MqttShadowClient
+    class ShadowActionManager
+      ### This the main AWS action manager
+      ### It enables the AWS IoT actions (get, update, delete)
+      ### It enables the time control the time out after an action have been start
+      ### Actions requests are send on the general actions topic and answer is retreived from accepted/refused/delta topics
+
+      attr_accessor :logger
+
+      def initialize(shadow_name, mqtt_client, persistent_subscribe=false)
+        @shadow_name = shadow_name
+        @topic_manager = ShadowTopicManager.new(mqtt_client, shadow_name)
+        @payload_parser = JSONPayloadParser.new
+        @is_subscribed = {}
+        @is_subscribed[:get] = false
+        @is_subscribed[:update] = false
+        @is_subscribed[:delete] = false
+        @token_handler = TokenCreator.new(shadow_name, mqtt_client.client_id)
+        @persistent_subscribe = persistent_subscribe
+        @last_stable_version = -1 #Mean no currentely stable
+        @topic_subscribed_callback = {}
+        @topic_subscribed_callback[:get] = nil
+        @topic_subscribed_callback[:update] = nil
+        @topic_subscribed_callback[:delta] = nil
+        @topic_subscribed_task_count = {}
+        @topic_subscribed_task_count[:get] = 0
+        @topic_subscribed_task_count[:update] = 0
+        @topic_subscribed_task_count[:delete] = 0
+        @token_pool = {}
+        @token_callback = {}
+        @task_count_mutex = Mutex.new
+        @token_mutex = Mutex.new
+        @parser_mutex = Mutex.new
+        set_basic_callback
+      end
+
+      ### Send and publish packet with an empty payload contains in a valid JSON format.
+      ### A unique token is generate and send in the packet in order to trace the action.
+      ### Subscribe to the two get/accepted and get/rejected of the coresponding shadow.
+      ### If the request is accpeted, the answer would be send on the get/accepted topic.
+      ### It contains all the details of the shadow state in JSON document.
+      ### A specific callback in Proc could be send parameter.
+      ### Before exit, the function start a timer count down in the separate thread.
+      ### If the time ran out, the timer_handler function is called and the get action is cancelled using the token.
+      ###
+      ### Parameter:
+      ###   > callback: the Proc to execute when the answer to th get request would be received.
+      ###                It should accept three different paramter:
+      ###                  - payload : the answer content
+      ###                  - response_status : among ['accepted', 'refused', 'delta']
+      ###                  - token : the token assoicate to the get request
+      ###
+      ###   > timeout: the period after which the request should be canceled and timer_handler should be call
+      ###
+      ### Returns :
+      ###   > the token associate to the current action (which also store in @token_pool)
+
+      def shadow_get(timeout=5, callback=nil, &block)
+        shadow_action(:get, "", timeout, callback, &block)
+      end
+
+      def shadow_update(payload, timeout=5, callback=nil, &block)
+        shadow_action(:update, payload, timeout, callback, &block)
+      end
+
+      def shadow_delete(timeout=5, callback=nil, &block)
+        shadow_action(:delete, "", timeout, callback, &block)
+      end
+
+      def register_get_callback(callback, &block)
+        register_action_callback(:get, callback, &block)
+      end
+
+      def register_update_callback(callback, &block)
+        register_action_callback(:update, callback, &block)
+      end
+
+      def register_delete_callback(callback, &block)
+        register_action_callback(:delete, callback, &block)
+      end
+
+      def register_shadow_delta_callback(callback, &block)
+        if callback.is_a?(Proc)
+          @topic_subscribed_callback[:delta] = callback
+        elsif block_given?
+          @topic_subscribed_callback[:delta] = block
+        end
+        @topic_manager.shadow_topic_subscribe("delta", @default_callback)
+      end
+
+      def remove_get_callback
+        remove_action_callback(:get)
+      end
+
+      def remove_update_callback
+        remove_action_callback(:update)
+      end
+
+      def remove_delete_callback
+        remove_action_callback(:delete)
+      end
+
+      def remove_shadow_delta_callback
+        @topic_subscribe_callback.delete[:delta]
+        @topic_manager.shadow_topic_unsubscribe("delta")
+      end
+
+      def logger?
+        !@logger.nil? && @logger.is_a?(Logger)
+      end
+
+      private
+
+      def shadow_action(action, payload="", timeout=5, callback=nil, &block)
+        current_token = Symbol
+        timer = Timers::Group.new
+        json_payload = ""
+        @token_mutex.synchronize(){
+          current_token = @token_handler.create_next_token
+        }
+        timer.after(timeout){ timeout_manager(action, current_token) }
+        @parser_mutex.synchronize {
+          @payload_parser.set_message(payload) unless payload == ""
+          @payload_parser.set_attribute_value("clientToken", current_token)
+          json_payload = @payload_parser.get_json
+        }
+        handle_subscription(action, timeout) unless @is_subscribed[action]
+        @topic_manager.shadow_topic_publish(action.to_s, json_payload)
+        @task_count_mutex.synchronize {
+          @topic_subscribed_task_count[action] += 1
+        }
+        @token_pool[current_token] = timer
+        register_token_callback(current_token, callback, &block)
+        Thread.new{ timer.wait }
+        current_token
+      end
+
+      ### Should cancel the token after a preset time interval
+      def timeout_manager(action_name, token)
+        if @token_pool.has_key?(token)
+          action = action_name.to_sym
+          @token_pool.delete(token)
+          @token_callback.delete(token)
+          @logger.warn("The #{action_name} request with the token #{token} has timed out!\n") if logger?
+          @task_count_mutex.synchronize {
+            @topic_subscribed_task_count[action] -= 1
+            unless @topic_subscribed_task_count[action] <= 0
+              @topic_subscribed_task_count[action] = 0
+              unless @persistent_subscribe
+                @topic_manager.shadow_topic_unsubscribe(action)
+                @is_subscribed[action.to_sym] = false
+              end
+            end
+          }
+        end
+      end
+
+      def set_basic_callback
+        @default_callback = proc { |message| do_message_callback(message) }
+
+        @topic_manager.on_suback = lambda do |topics|
+          action = @topic_manager.retrieve_action(topics[0])
+          @is_subscribed[action] ||= true unless action.nil?
+        end
+
+        @topic_manager.on_unsuback = lambda do |topics|
+          action = @topic_manager.retrieve_action(topics[0])
+          @is_subscribed[action] = false if action.nil?
+        end
+      end
+
+      def register_token_callback(token, callback, &block)
+        if callback.is_a?(Proc)
+          @token_callback[token] = callback
+        elsif block_given?
+          @token_callback[token] = block
+        end
+      end
+
+      def remove_token_callback(token)
+        @token_callback.delete(token)
+      end
+
+      def register_action_callback(action, callback, &block)
+        if callback.is_a?(Proc)
+          @topic_subscribed_callback[action] = callback
+        elsif block_given?
+          @topic_subscribed_callback[action] = block
+        end
+      end
+
+      def remove_action_callback(action)
+        @topic_subscribed_callback[action] = nil
+      end
+
+      def decresase_task_count(action)
+        @topic_subscribed_task_count[action] -= 1
+        if @topic_subscribed_task_count[action] <= 0
+          @topic_subscribed_task_count[action] = 0
+          unless @persistent_subscribe
+            @topic_manager.shadow_topic_unsubscribe(action.to_s)
+            @is_subscribed[action] = false
+          end
+        end
+      end
+
+      ### The default callback that is called by every actions
+      ### It acknowledge the accepted status if action success
+      ### Call a specific callback for each actions if it defined have been register previously
+      def do_message_callback(message)
+        topic = message.topic
+        action = parse_action(topic)
+        type = parse_type(topic)
+        payload = message.payload
+        token = nil
+        new_version = -1
+        @parser_mutex.synchronize() {
+          @payload_parser.set_message(payload)
+          new_version = @payload_parser.get_attribute_value("version")
+          token = @payload_parser.get_attribute_value("clientToken")
+        }
+        if %w(get update delete).include?(action)
+          if @token_pool.has_key?(token)
+            @token_pool[token].cancel
+            @token_pool.delete(token)
+            if type.eql?("accepted")
+              do_accepted(message, action.to_sym, token, type, new_version)
+            else
+              do_rejected(token, action, new_version)
+            end
+            @task_count_mutex.synchronize {
+              decresase_task_count(action.to_sym)
+            }
+          end
+        elsif %w(delta).include?(action)
+          do_delta(message, new_version)
+        end
+      end
+
+      def do_accepted(message, action, token, type, new_version)
+        if new_version && new_version >= @last_stable_version
+          @logger.info("The #{action} action with the token #{token} have been accepted.") if logger?
+          type.eql?("delete") ? @last_stable_version = -1 : @last_stable_version = new_version
+          Thread.new do
+            accepted_tasks(message, action, token)
+          end
+        else
+          @logger.warn("CATCH AN ACCEPTED #{action} BUT OUTDATED/INVALID VERSION (= #{new_version})\n") if logger?
+        end
+      end
+
+      def accepted_tasks(message, action, token)
+        @topic_subscribed_callback[action].call(message)  unless @topic_subscribed_callback[action].nil?
+        @token_callback[token].call(message) if @token_callback.has_key?(token)
+        @token_callback.delete(token)
+      end
+
+      def do_rejected(token, action, new_version)
+        if new_version && new_version >= @last_stable_version
+          @logger.info("The #{action} action with the token #{token} have been rejected.") if logger?
+          @token_callback.delete(token)
+        else
+          @logger.warn("CATCH AN REJECTED #{action} BUT OUTDATED/INVALID VERSION (= #{new_version})\n") if logger?
+        end
+      end
+
+      def do_delta(message, new_version)
+        if new_version && new_version >= @last_stable_version
+          @logger.info("A delta action have been accepted.") if logger?
+          @last_stable_version = new_version
+          Thread.new { @topic_subscribed_callback[:delta].call(message) } unless @topic_subscribed_callback[:delta].nil?
+        else
+          @logger.warn("CATCH A DELTA BUT OUTDATED/INVALID VERSION (= #{new_version})\n") if logger?
+        end
+      end
+
+      def handle_subscription(action, timeout)
+        @topic_manager.shadow_topic_subscribe(action.to_s, @default_callback)
+        if @topic_manager.paho_client?
+          ref = Time.now + timeout
+          while !@is_subscribed[action] && handle_timeout(ref) do
+            sleep 0.0001
+          end
+        else
+          sleep 2
+        end
+      end
+
+      def handle_timeout(ref)
+        Time.now <= ref
+      end
+
+      def parse_shadow_name(topic)
+        topic.split('/')[2]
+      end
+
+      def parse_action(topic)
+        if topic.split('/')[5] == "delta"
+          topic.split('/')[5]
+        else
+          topic.split('/')[4]
+        end
+      end
+
+      def parse_type(topic)
+        topic.split('/')[5]
+      end
+    end
+  end
+end