apiotics_aws_client 1.0.1

data/lib/aws_iot_device/mqtt_shadow_client/shadow_client.rb

@@ -0,0 +1,118 @@
+require 'aws_iot_device/mqtt_shadow_client/mqtt_manager'
+require 'aws_iot_device/mqtt_shadow_client/shadow_topic_manager'
+require 'aws_iot_device/mqtt_shadow_client/shadow_action_manager'
+
+module AwsIotDevice
+  module MqttShadowClient
+    class ShadowClient
+
+      def initialize(*args)
+        unless args.last.nil?
+          config_attr(args.last)
+        else
+          @mqtt_client = MqttManager.new
+        end
+      end
+
+      def connect(*args, &block)
+        @mqtt_client.connect(*args)
+        self.logger.info("Connected to the AWS IoT platform") if logger?
+        if block_given?
+          begin
+            yield(self)
+          ensure
+            @mqtt_client.disconnect
+          end
+        end
+      end
+
+      def create_shadow_handler_with_name(shadow_name, persistent_subscribe=false)
+        @action_manager = ShadowActionManager.new(shadow_name, @mqtt_client, persistent_subscribe)
+      end
+
+      def logger=(logger_path)
+        file = File.open(logger_path, "a+")
+        log_file = Logger.new(file)
+        log_file.level = Logger::DEBUG
+        @action_manager.logger = log_file
+      end
+
+      def logger
+        @action_manager.logger
+      end
+
+      def logger?
+        @action_manager.logger?
+      end
+
+      def get_shadow(timeout=5, callback=nil, &block)
+        @action_manager.shadow_get(timeout, callback, &block)
+      end
+
+      def update_shadow(payload, timeout=5, callback=nil, &block)
+        @action_manager.shadow_update(payload, timeout, callback, &block)
+      end
+
+      def delete_shadow(timeout=5, callback=nil, &block)
+        @action_manager.shadow_delete(timeout, callback, &block)
+      end
+
+      def register_get_callback(callback=nil, &block)
+        @action_manager.register_get_callback(callback, &block)
+      end
+
+      def register_update_callback(callback=nil, &block)
+        @action_manager.register_update_callback(callback, &block)
+      end
+
+      def register_delete_callback(callback=nil, &block)
+        @action_manager.register_delete_callback(callback, &block)
+      end
+
+      def register_delta_callback(callback=nil, &block)
+        @action_manager.register_shadow_delta_callback(callback, &block)
+      end
+
+      def remove_delta_callback
+        @action_manager.remove_shadow_delta_callback
+      end
+
+      def remove_get_callback
+        @action_manager.remove_get_callback
+      end
+
+      def remove_update_callback
+        @action_manager.remove_update_callback
+      end
+
+      def remove_delete_callback
+        @action_manager.remove_delete_callback
+      end
+
+      def disconnect
+        @mqtt_client.disconnect
+      end
+
+      def configure_endpoint(host, port)
+        @mqtt_client.config_endpoint(host,port)
+      end
+
+      def configure_credentials(ca_file, key, cert)
+        @mqtt_client.config_ssl_context(ca_file, key, cert)
+      end
+
+
+      private
+
+      def config_attr(args)
+        shadow_attr = args.dup
+        shadow_attr.keep_if {|key| key == :shadow_name || key == :persistent_subscribe || key == :logger }
+        mqtt_attr = args        
+        mqtt_attr.delete_if {|key| key == :shadow_name || key == :persistent_subscribe || key == :logger }
+        @mqtt_client = MqttManager.new(mqtt_attr)
+        shadow_attr[:persistent_subscribe] ||= false
+        @action_manager = create_shadow_handler_with_name(shadow_attr[:shadow_name], shadow_attr[:persistent_subsrcibe]) if shadow_attr.has_key?(:shadow_name)
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_shadow_client/shadow_topic_manager.rb

@@ -0,0 +1,75 @@
+require 'aws_iot_device/mqtt_shadow_client/topic_builder'
+
+module AwsIotDevice
+  module MqttShadowClient
+    class ShadowTopicManager
+
+      def initialize(mqtt_manager, shadow_name)
+        raise ArgumentError, "topic manager should be initialized with a mqtt_manager but was undefined" if mqtt_manager.nil?
+        raise ArgumentError, "topic manager should be initialize with a mqtt mmanager but was undefined" if shadow_name.nil?
+
+        @mqtt_manager = mqtt_manager
+        @sub_unsub_mutex = Mutex.new()
+        @topic = TopicBuilder.new(shadow_name)
+        @timeout = mqtt_manager.mqtt_operation_timeout_s
+      end
+
+      def shadow_topic_publish(action, payload)
+        @mqtt_manager.publish(@topic.get_topic_general(action), payload, false, 0)
+      end
+
+      def shadow_topic_subscribe(action, callback=nil)
+        @sub_unsub_mutex.synchronize() {
+          @subacked = false
+          if @topic.is_delta?(action)
+            @mqtt_manager.subscribe(@topic.get_topic_delta, 0, callback)
+          else
+            @mqtt_manager.subscribe_bunch([@topic.get_topic_accepted(action), 1, callback], [@topic.get_topic_rejected(action), 1, callback])
+          end
+        }
+      end
+          
+      def shadow_topic_unsubscribe(action)
+        @sub_unsub_mutex.synchronize(){
+          @unsubacked = false
+          if @topic.is_delta?(action)
+            @mqtt_manager.unsubscribe(@topic.get_topic_delta)
+          else
+            @mqtt_manager.unsubscribe_bunch(@topic.get_topic_accepted(action), @topic.get_topic_rejected(action))
+          end
+        }
+      end
+
+      def retrieve_action(topic)
+        res = nil
+        ACTION_NAME.each do |action|
+          if topic[0] == @topic.get_topic_accepted(action)
+            res = action.to_sym
+            break
+          end
+        end
+        res
+      end
+
+      def paho_client?
+        @mqtt_manager.paho_client?
+      end
+
+      def on_suback=(callback)
+        @mqtt_manager.on_suback = callback
+      end
+
+      def on_suback(&block)
+        @mqtt_manager.on_suback(&block)
+      end
+
+      def on_unsuback=(callback)
+        @mqtt_manager.on_unsuback = callback 
+      end
+
+      def on_unsuback(&block)
+        @mqtt_manager.on_unsuback(&block)
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_shadow_client/token_creator.rb

@@ -0,0 +1,36 @@
+require 'securerandom'
+require 'timers'
+require 'thread'
+require 'json'
+
+module AwsIotDevice
+  module MqttShadowClient
+    class TokenCreator
+      ### This class manage the clients token.
+      ### Every actions receive a token for a certian interval, meaning that action is waiting to be proceed.
+      ### When token time run out or the actions have been treated token should deleted.
+
+      def initialize(shadow_name, client_id)
+        if shadow_name.length > 16
+          @shadow_name = shadow_name[0..15]
+        else
+          @shadow_name = shadow_name
+        end
+        @client_id = client_id
+        @sequence_number = 0
+      end
+
+      def create_next_token
+        token = ""
+        token << "#{@client_id}" << "_" << "#{@shadow_name}" << "_" << "#{@sequence_number}" << "_" << "#{random_token_string(5)}"
+      end
+
+      private
+
+      def random_token_string(lenght)
+        charset = Array('A'..'Z') + Array('a'..'z') + Array('0'..'9')
+        Array.new(lenght) { charset.sample }.join
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_shadow_client/topic_builder.rb

@@ -0,0 +1,35 @@
+module AwsIotDevice
+  module MqttShadowClient
+    class TopicBuilder
+      def initialize(shadow_name)
+        raise ArgumentError, "topic_builder initialization, shadow_name is required but undefined" if shadow_name.nil?
+        
+        @shadow_name = shadow_name
+        
+        @topic_delta = "$aws/things/#{shadow_name}/shadow/update/delta"
+        @topic_general = "$aws/things/#{shadow_name}/shadow/"
+      end
+
+      def is_delta?(action)
+        action == ACTION_NAME[3]
+      end
+
+      def get_topic_general(action)
+        raise ArgumentError, "topic_builder, get topic, unreconized action_name \"#{action}\"" unless ACTION_NAME.include?(action)
+        @topic_general + action
+      end
+
+      def get_topic_accepted(action)
+        get_topic_general(action) + "/accepted"
+      end
+
+      def get_topic_rejected(action)
+        get_topic_general(action) + "/rejected"
+      end
+
+      def get_topic_delta
+        @topic_delta
+      end
+    end
+  end
+end

data/lib/aws_iot_device/version.rb

@@ -0,0 +1,3 @@
+module AwsIotDevice
+  VERSION = "1.0.1"
+end

data/samples/config_shadow.rb

@@ -0,0 +1,72 @@
+require 'optparse'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Basic usage basic_greeting.rb -c \"YOUR_CERTIFICATE_PATH\" -k \"YOUR_KEY_FILE_PATH\" -ca \"YOUR_ROOT_CA_PATH -H \"YOUR_ENDPOINT\" -p 8883 -t \"YOUR THING NAME\"\n"
+  
+  opts.separator ""
+  opts.separator "Common options"
+  opts.on_tail("-h", "--help", "--usage", "Show this message") do
+    puts opts
+    exit
+  end
+  
+  opts.on("-H", "--host [END_POINT]", "The endpoint where you want to connect") do |host|
+    options[:host] = host
+  end
+  
+  opts.on("-p", "--port [MQTT_PORT]", "The port used for the connection Default is 8883") do |port|
+    options[:port] = port
+  end
+  
+  opts.on("-c", "--cert [CERT_FILE_PATH]", "The path to the certificate file of the private key.") do |cert|
+    options[:cert] = cert
+  end
+  
+  opts.on("-k", "--key [KEY_FILE_PATH]", "The path to private key file that would be used for encryption") do |key|
+    options[:key] = key
+  end
+  
+  opts.on("-a", "--root_ca [ROOT_CA_PATH]", "The path to the authority certification file") do |root_ca|
+    options[:root_ca] = root_ca
+  end
+
+  opts.on("-t", "--thing [THING_NAME]", "The Thing name on which the action would be done") do |thing|
+    options[:things] = thing
+  end
+end.parse!(ARGV)
+
+@host = options[:host]
+@port = options[:port] || 8883
+@certificate_path = options[:cert]
+@private_key_path = options[:key]
+@root_ca_path = options[:root_ca]
+@thing = options[:things]
+
+def setting_mqtt_client
+  mqtt_client = AwsIotDevice::MqttShadowClient::MqttManager.new(host: @host,
+                                                                port: @port,
+                                                                ssl: true)
+  mqtt_client.config_ssl_context(@root_ca_path, @private_key_path, @certificate_path)
+  mqtt_client.connect
+  mqtt_client
+end
+
+def setting_topic_manager(mqtt_client)
+  topic_manager = AwsIotDevice::MqttShadowClient::ShadowTopicManager.new(mqtt_client, @thing)
+end
+
+def setting_action_manager(mqtt_client)
+  action_manager = AwsIotDevice::MqttShadowClient::ShadowActionManager.new(@thing, mqtt_client, false)
+  action_manager
+end
+
+def setting_shadow
+  shadow_client = AwsIotDevice::MqttShadowClient::ShadowClient.new
+  shadow_client.configure_endpoint(@host, @port)
+  shadow_client.configure_credentials(@root_ca_path, @private_key_path, @certificate_path)
+  shadow_client.create_shadow_handler_with_name(@thing, true)
+  shadow_client.connect
+  shadow_client
+end

data/samples/mqtt_client_samples/mqtt_client_samples.rb

@@ -0,0 +1,38 @@
+$:.unshift(File.expand_path("../../../samples", __FILE__))
+
+require 'aws_iot_device'
+require 'config_shadow'
+
+client = setting_mqtt_client
+
+client2 =  setting_mqtt_client
+
+callback = Proc.new do |message|
+  p " Client1 catch message event"
+  p "--- Topic: #{message.topic}"
+  p "--- Payload: #{message.payload}"
+end
+
+callback2 = Proc.new do |message|
+  p " Client2 catch message event"
+  p "--- Topic: #{message.topic}"
+  p "--- Payload: #{message.payload}"
+end
+
+client.subscribe("topic_2", 0, callback)
+client2.subscribe("topic_1", 0,callback2)
+
+puts "# STARTING EXAMPLE #"
+client.publish("topic_1", "Hello Sir. My name is client 1. How do you do? ")
+client2.publish("topic_2", "Hello Mister Client 1. My name is client 2. How do you do?")
+sleep 1
+
+2.times do
+  client.publish("topic_1", "How do you do?")
+  sleep 1
+  client2.publish("topic_2", "How do you do?")
+  sleep 1
+end
+sleep 2
+client.disconnect
+client2.disconnect

data/samples/shadow_action_samples/sample_shadow_action_update.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.expand_path("../../../samples", __FILE__))
+
+require 'aws_iot_device'
+require 'config_shadow'
+
+filter_callback = Proc.new do |message|
+  puts "Executing the specific callback for topic: #{message.topic}\n##########################################\n"
+end
+
+mqtt_client = setting_mqtt_client
+client = setting_action_manager(mqtt_client)
+
+client.register_shadow_delta_callback(filter_callback)
+timeout = 5
+
+n = 1
+5.times do
+  json_payload = "{\"state\":{\"desired\":{\"property\":\"RubySDK\",\"count\":#{n}}}}"
+  client.shadow_update(json_payload, timeout, filter_callback)
+  n += 1
+end
+
+sleep timeout
+
+mqtt_client.disconnect

data/samples/shadow_client_samples/samples_shadow_client_block.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.expand_path("../../../samples", __FILE__))
+
+require 'aws_iot_device'
+require 'config_shadow'
+
+filter_callback = Proc.new do |message|
+  puts "Executing the specific callback for topic: #{message.topic}\n##########################################\n"
+end
+
+my_shadow_client = setting_shadow
+
+my_shadow_client.connect do |client|
+
+  puts "##### Starting test_shadow_client_get ######"
+  client.get_shadow(4, filter_callback)
+  
+  puts "##### Starting test_shadow_client_get ######"
+  client.get_shadow(4) do
+    puts "CALLED FROM BLOCK"
+  end
+  
+  puts "##### Starting test_shadow_client_get ######"
+  client.get_shadow(4, filter_callback)
+  sleep 5
+end

data/samples/shadow_client_samples/samples_shadow_client_delete.rb

@@ -0,0 +1,24 @@
+$:.unshift(File.expand_path("../../../samples", __FILE__))
+
+require 'aws_iot_device'
+require 'config_shadow'
+
+filter_callback = Proc.new do |message|
+  puts "Executing the specific callback for topic: #{message.topic}\n##########################################\n"
+end
+
+my_shadow_client = setting_shadow
+
+n = 1
+3.times do
+  puts "Start shadow_delete\n"
+  my_shadow_client.delete_shadow(5, filter_callback)
+  sleep 0.01
+  json_payload = '{"state":{"desired":{"property":"RubySDK"}}}'
+  my_shadow_client.update_shadow(json_payload, 5)
+  n += 1
+end
+
+sleep 2
+
+my_shadow_client.disconnect