aws_iot_device 0.1.5 → 1.0.0

data/lib/aws_iot_device/mqtt_shadow_client/shadow_topic_manager.rb

@@ -4,47 +4,72 @@ module AwsIotDevice
   module MqttShadowClient
     class ShadowTopicManager
 
-      def initialize(mqtt_manager)
-        if mqtt_manager.nil?
-          raise "TopicAction_error: TopicAction should be initialized with a mqtt_manager but was undefined"
-        end
+      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 client_id
-        @mqtt_manager.client_id
+      def shadow_topic_publish(action, payload)
+        @mqtt_manager.publish(@topic.get_topic_general(action), payload, false, 0)
       end
 
-      def shadow_topic_publish(shadow_name, shadow_action, payload)
-        topic = TopicBuilder.new(shadow_name, shadow_action)
-        @mqtt_manager.publish(topic.get_topic_general, payload, false, 0)
-      end
-
-      def shadow_topic_subscribe(shadow_name, shadow_action, callback=nil)
-        @sub_unsub_mutex.synchronize(){
-          topic = TopicBuilder.new(shadow_name, shadow_action)
-          if topic.is_delta?(shadow_action)
-            @mqtt_manager.subscribe(topic.get_topic_delta, 0, callback)
+      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(topic.get_topic_accepted, 0, callback)
-            @mqtt_manager.subscribe(topic.get_topic_rejected, 0, callback)
+            @mqtt_manager.subscribe_bunch([@topic.get_topic_accepted(action), 1, callback], [@topic.get_topic_rejected(action), 1, callback])
           end
         }
-        sleep 2
       end
-
-      def shadow_topic_unsubscribe(shadow_name, shadow_action)
+          
+      def shadow_topic_unsubscribe(action)
         @sub_unsub_mutex.synchronize(){
-          topic = TopicBuilder.new(shadow_name, shadow_action)
-          if topic.is_delta?(shadow_name)
-            @mqtt_manager.unsubscribe(topic.get_topic_delta)
+          @unsubacked = false
+          if @topic.is_delta?(action)
+            @mqtt_manager.unsubscribe(@topic.get_topic_delta)
           else
-            @mqtt_manager.unsubscribe(topic.get_topic_accepted)
-            @mqtt_manager.unsubscribe(topic.get_topic_rejected)
+            @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/topic_builder.rb

@@ -1,45 +1,30 @@
 module AwsIotDevice
   module MqttShadowClient
     class TopicBuilder
-      ACTION_NAME = %w(get update delete delta).freeze
-
-      def initialize(shadow_name, action_name)
-        unless ACTION_NAME.include?(action_name)
-          raise "action_name_error: unreconized action_name \"#{action_name}\""
-        end
-
-        if shadow_name.nil?
-          raise "shadow_name_error: shadow_name is required but undefined"
-
-        end
-
+      def initialize(shadow_name)
+        raise ArgumentError, "topic_builder initialization, shadow_name is required but undefined" if shadow_name.nil?
+        
         @shadow_name = shadow_name
-        @action_name = action_name
-
-        ### The case of delta's action
-        if is_delta?(action_name)
-          @topic_delta = "$aws/things/#{shadow_name}/shadow/update/delta"
-        else
-          @topic_general = "$aws/things/#{shadow_name}/shadow/#{action_name}"
-          @topic_accepted = "$aws/things/#{shadow_name}/shadow/#{action_name}/accepted"
-          @topic_rejected = "$aws/things/#{shadow_name}/shadow/#{action_name}/rejected"
-        end
+        
+        @topic_delta = "$aws/things/#{shadow_name}/shadow/update/delta"
+        @topic_general = "$aws/things/#{shadow_name}/shadow/"
       end
 
-      def is_delta?(action_name)
-        action_name == ACTION_NAME[3]
+      def is_delta?(action)
+        action == ACTION_NAME[3]
       end
 
-      def get_topic_general
-        @topic_general
+      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
-        @topic_accepted
+      def get_topic_accepted(action)
+        get_topic_general(action) + "/accepted"
       end
 
-      def get_topic_rejected
-        @topic_rejected
+      def get_topic_rejected(action)
+        get_topic_general(action) + "/rejected"
       end
 
       def get_topic_delta

data/lib/aws_iot_device/version.rb

@@ -1,3 +1,3 @@
 module AwsIotDevice
-  VERSION = "0.1.5"
+  VERSION = "1.0.0"
 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

@@ -1,61 +1,11 @@
-require 'aws_iot_device'
-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\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
-end.parse!(ARGV)
-
-
-host = options[:host]
-port = options[:port] || 8883
-cert_file_path = options[:cert]
-key_file_path = options[:key]
-ca_file_path = options[:root_ca] 
-
-client = AwsIotDevice::MqttShadowClient::MqttManager.new(host: host,
-                             port: port,
-                             ssl: true,
-                             cert_file: cert_file_path,
-                             key_file: key_file_path,
-                             ca_file: ca_file_path)
+$:.unshift(File.expand_path("../../../samples", __FILE__))
 
-client2 = AwsIotDevice::MqttShadowClient::MqttManager.new
+require 'aws_iot_device'
+require 'config_shadow'
 
-client2.config_endpoint(host, port)
-client2.ssl = true
-client2.config_ssl_context(ca_file_path, key_file_path, cert_file_path)
+client = setting_mqtt_client
 
-client.connect()
-client2.connect()
+client2 =  setting_mqtt_client
 
 callback = Proc.new do |message|
   p " Client1 catch message event"
@@ -72,12 +22,10 @@ end
 client.subscribe("topic_2", 0, callback)
 client2.subscribe("topic_1", 0,callback2)
 
-
 puts "# STARTING EXAMPLE #"
-sleep 2
 client.publish("topic_1", "Hello Sir. My name is client 1. How do you do? ")
-sleep 2
 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?")
@@ -85,6 +33,6 @@ client2.publish("topic_2", "Hello Mister Client 1. My name is client 2. How do y
   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

@@ -1,76 +1,22 @@
-require 'aws_iot_device'
-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\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)
+$:.unshift(File.expand_path("../../../samples", __FILE__))
 
-
-host = options[:host]
-port = options[:port] || 8883
-cert_file_path = options[:cert]
-key_file_path = options[:key]
-ca_file_path = options[:root_ca]
-thing = options[:things]
-
-mqtt_client = AwsIotDevice::MqttShadowClient::MqttManager.new(host: host,
-                             port: port,
-                             ssl: true,
-                             cert_file: cert_file_path,
-                             key_file: key_file_path,
-                             ca_file: ca_file_path)
-
-mqtt_client.connect
+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
 
-timeout = 5
-
-topic_manager = AwsIotDevice::MqttShadowClient::ShadowTopicManager.new(mqtt_client)
-
-client = AwsIotDevice::MqttShadowClient::ShadowActionManager.new(thing, topic_manager, false)
+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, filter_callback, timeout)
+  client.shadow_update(json_payload, timeout, filter_callback)
   n += 1
 end
 

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

@@ -1,73 +1,24 @@
-require 'aws_iot_device'
-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\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]
+$:.unshift(File.expand_path("../../../samples", __FILE__))
 
-my_shadow_client = AwsIotDevice::MqttShadowClient::ShadowClient.new
-my_shadow_client.configure_endpoint(host, port)
-my_shadow_client.configure_credentials(root_ca_path, private_key_path, certificate_path)
-
-my_shadow_client.connect
-
-my_shadow_client.create_shadow_handler_with_name(thing ,false)
+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
 
-n = 1
+my_shadow_client = setting_shadow
 
+n = 1
 3.times do
   puts "Start shadow_delete\n"
-  my_shadow_client.delete_shadow(filter_callback, 5)
+  my_shadow_client.delete_shadow(5, filter_callback)
+  sleep 0.01
   json_payload = '{"state":{"desired":{"property":"RubySDK"}}}'
-  my_shadow_client.update_shadow(json_payload, nil, 5)
+  my_shadow_client.update_shadow(json_payload, 5)
   n += 1
 end
 
-sleep 5
+sleep 2
 
 my_shadow_client.disconnect