aws_iot_device 0.1.0

data/lib/aws_iot_device/mqtt_shadow_client/shadow_topic_manager.rb

@@ -0,0 +1,50 @@
+require 'aws_iot_device/mqtt_shadow_client/topic_builder'
+
+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
+        @mqtt_manager = mqtt_manager
+        @sub_unsub_mutex = Mutex.new()
+      end
+
+      def client_id
+        @mqtt_manager.client_id
+      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)
+          else
+            @mqtt_manager.subscribe(topic.get_topic_accepted, 0, callback)
+            @mqtt_manager.subscribe(topic.get_topic_rejected, 0, callback)
+          end
+        }
+        sleep 2
+      end
+
+      def shadow_topic_unsubscribe(shadow_name, shadow_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)
+          else
+            @mqtt_manager.unsubscribe(topic.get_topic_accepted)
+            @mqtt_manager.unsubscribe(topic.get_topic_rejected)
+          end
+        }
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_shadow_client/token_creator.rb

@@ -0,0 +1,32 @@
+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)
+        @shadow_name = shadow_name
+        @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,50 @@
+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
+
+        @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
+      end
+
+      def is_delta?(action_name)
+        action_name == ACTION_NAME[3]
+      end
+
+      def get_topic_general
+        @topic_general
+      end
+
+      def get_topic_accepted
+        @topic_accepted
+      end
+
+      def get_topic_rejected
+        @topic_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 = "0.1.0"
+end

data/samples/mqtt_client_samples/mqtt_client_samples.rb

@@ -0,0 +1,90 @@
+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)
+
+client2 = AwsIotDevice::MqttShadowClient::MqttManager.new
+
+client2.config_endpoint(host, port)
+client2.ssl = true
+client2.config_ssl_context(ca_file_path, key_file_path, cert_file_path)
+
+client.connect()
+client2.connect()
+
+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 #"
+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?")
+
+2.times do
+  client.publish("topic_1", "How do you do?")
+  sleep 1
+  client2.publish("topic_2", "How do you do?")
+  sleep 1
+end
+
+client.disconnect
+client2.disconnect

data/samples/shadow_action_samples/sample_shadow_action_update.rb

@@ -0,0 +1,79 @@
+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
+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
+
+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)
+
+client.register_shadow_delta_callback(filter_callback)
+
+n = 1
+
+5.times do
+  json_payload = "{\"state\":{\"desired\":{\"property\":\"RubySDK\",\"count\":#{n}}}}"
+  client.shadow_update(json_payload, filter_callback, timeout)
+  n += 1
+end
+
+sleep timeout
+
+mqtt_client.disconnect

data/samples/shadow_client_samples/samples_shadow_client_delete.rb

@@ -0,0 +1,73 @@
+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]
+
+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)
+
+filter_callback = Proc.new do |message|
+  puts "Executing the specific callback for topic: #{message.topic}\n##########################################\n"
+end
+
+n = 1
+
+3.times do
+  puts "Start shadow_delete\n"
+  my_shadow_client.delete_shadow(filter_callback, 5)
+  json_payload = '{"state":{"desired":{"property":"RubySDK"}}}'
+  my_shadow_client.update_shadow(json_payload, nil, 5)
+  n += 1
+end
+
+sleep 5
+
+my_shadow_client.disconnect

data/samples/shadow_client_samples/samples_shadow_client_get.rb

@@ -0,0 +1,74 @@
+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]
+
+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)
+
+
+filter_callback = Proc.new do |message|
+  puts "Executing the specific callback for topic: #{message.topic}\n##########################################\n"
+end
+
+puts "##### Starting test_shadow_client_get ######"
+my_shadow_client.get_shadow(filter_callback, 4)
+sleep 5
+
+puts "##### Starting test_shadow_client_get ######"
+my_shadow_client.get_shadow(nil, 4)
+sleep 5
+
+puts "##### Starting test_shadow_client_get ######"
+my_shadow_client.get_shadow(filter_callback, 4)
+sleep 5
+
+my_shadow_client.disconnect