aws_iot_device 0.1.5 → 1.0.0

data/samples/shadow_client_samples/samples_shadow_client_description.rb

@@ -0,0 +1,64 @@
+require "aws_iot_device"
+
+host = "AWS IoT endpoint"
+port = 8883
+thing = "Thing Name"
+root_ca_path = "Path to your CA certificate"
+private_key_path = "Path to your private key"
+certificate_path = "Path to your certificate"
+
+# Create a new client with empty arguments 
+shadow_client = AwsIotDevice::MqttShadowClient::ShadowClient.new
+
+# Configure the endpoint and the port the client would connect
+shadow_client.configure_endpoint(host, port)
+
+# Configure the credentials to enable a connection over TLS/SSL encryption
+shadow_client.configure_credentials(root_ca_path, private_key_path, certificate_path)
+
+# Create an event handler to bind the client with the remote thing in a persistent mode
+shadow_client.create_shadow_handler_with_name(thing, true)
+
+# Local timeout used for operation
+timeout = 4
+
+# Send a connect request to the AWS IoT platform
+shadow_client.connect
+
+# Register a callback for the get action as a block
+shadow_client.register_get_callback do
+  puts "generic callback for get action"
+end
+
+# Register a callback for the delete action as a proc
+shadow_client.register_delete_callback(proc { puts "generic callback for delete action"})
+
+# Register a callback for the update action as a lambda
+shadow_client.register_update_callback(lambda {|_message| puts "generic callback for update action"})
+
+# Register a callback for the delta events
+shadow_client.register_delta_callback do
+  puts "delta have been catch in a callback"
+end
+
+# Send a get request with an associated callback in a block
+shadow_client.get_shadow do
+  puts "get thing"
+end
+
+# Send a delete request with an associated callback in a proc
+shadow_client.delete_shadow(timeout, proc {puts "delete thing"})
+
+# Send a udpate request with an associated callback in a lambda
+shadow_client.update_shadow("{\"state\":{\"desired\":{\"message\":\"Hello\"}}}", timeout, lambda {|_message| puts "update thing"})
+
+# Sleep to assert all opereation have been processed
+sleep timeout
+
+# Clear out the previously registered callback for each action
+shadow_client.remove_get_callback
+shadow_client.remove_update_callback
+shadow_client.remove_delete_callback
+
+# Explicit disconnect from the AWS IoT platform
+shadow_client.disconnect

data/samples/shadow_client_samples/samples_shadow_client_get.rb

@@ -1,74 +1,23 @@
-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)
+$:.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
+
 puts "##### Starting test_shadow_client_get ######"
-my_shadow_client.get_shadow(filter_callback, 4)
-sleep 5
+my_shadow_client.get_shadow(2, filter_callback)
 
 puts "##### Starting test_shadow_client_get ######"
-my_shadow_client.get_shadow(nil, 4)
-sleep 5
+my_shadow_client.get_shadow do
+  puts "Block callback for a token"
+end
 
 puts "##### Starting test_shadow_client_get ######"
-my_shadow_client.get_shadow(filter_callback, 4)
-sleep 5
+my_shadow_client.get_shadow(2, filter_callback)
 
-my_shadow_client.disconnect
+sleep 3

data/samples/shadow_client_samples/samples_shadow_client_getting_started.rb

@@ -0,0 +1,22 @@
+require "aws_iot_device"
+
+host = "AWS IoT endpoint"
+port = 8883
+thing = "Thing Name"
+root_ca_path = "Path to your CA certificate"
+private_key_path = "Path to your private key"
+certificate_path = "Path to your certificate"
+
+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.get_shadow do |_message|
+  # Do what you want with the get_shadow's answer
+  p ":)"
+end
+sleep 2 #Timer to ensure that the answer is received
+
+shadow_client.disconnect

data/samples/shadow_client_samples/samples_shadow_client_update.rb

@@ -1,59 +1,7 @@
-require 'aws_iot_device'
-require 'optparse'
-require 'json'
-
-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
-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, true)
+require 'aws_iot_device'
+require 'config_shadow'
 
 filter_callback = Proc.new do |message|
   puts "Executing the specific callback for topic: #{message.topic}\n##########################################\n"
@@ -64,18 +12,19 @@ delta_callback = Proc.new do |delta|
   puts "Catching a new message : #{message["state"]["message"]}\n##########################################\n"
 end
 
+my_shadow_client = setting_shadow
 my_shadow_client.register_delta_callback(delta_callback)
 
 n = 1
 3.times do
-  puts "Type the message that you want to register in the thing [#{thing}]:"
+  puts "Type the message that you want to register in the thing:"
   entry = $stdin.readline()
   json_payload = "{\"state\":{\"desired\":{\"message\":\"#{entry.delete!("\n")}\"}}}"
-  my_shadow_client.update_shadow(json_payload, filter_callback, 5)
+  my_shadow_client.update_shadow(json_payload, 5, filter_callback)
   puts "#{3 - n} Message(s) left"
-  sleep 2
   n += 1
 end
 
+sleep 3
 
 my_shadow_client.disconnect

data/samples/shadow_topic_samples/sample_topic_manager.rb

@@ -1,61 +1,11 @@
-require "aws_iot_device"
-require 'optparse'
+$:.unshift(File.expand_path("../../../samples", __FILE__))
 
-options = {}
+require 'aws_iot_device'
+require 'config_shadow'
 
-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
+mqtt_client = setting_mqtt_client
 
-  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]
-
-manager = AwsIotDevice::MqttShadowClient::MqttManager.new(host: host,
-                             port: port,
-                             ssl: true,
-                             cert_file: certificate_path,
-                             key_file: private_key_path,
-                             ca_file: root_ca_path)
-
-manager.connect
-
-cli = AwsIotDevice::MqttShadowClient::ShadowTopicManager.new(manager)
+topic_client = setting_topic_manager(mqtt_client)
 
 filter_callback = Proc.new do |message|
   puts "Received (through filtered callback) : "
@@ -64,14 +14,13 @@ filter_callback = Proc.new do |message|
   puts "###################"
 end
 
-cli.shadow_topic_subscribe(thing, "get", filter_callback)
-
-sleep 1
+topic_client.shadow_topic_subscribe("get", filter_callback)
 
 4.times do
-  cli.shadow_topic_publish(thing, "get", "")
-  sleep 1
+  topic_client.shadow_topic_publish("get", "")
 end
 
-manager.disconnect
+sleep 2
+
+mqtt_client.disconnect
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws_iot_device
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Pierre Goudet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2017-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,20 +27,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +57,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,20 +67,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: facets
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +97,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -80,34 +107,49 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
-  name: mqtt
+  name: paho-mqtt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: timers
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +157,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,8 +167,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.1
-description: A gem use to communicates with the Aws Iot platform through the MQTT
-  protocol
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+description: The gem is using the MQTT protocol to execute the command defined by
+  the AWS IoT platform. A default MQTT client is included in the gem, however an adapter
+  system enables to plug another MQTT client.
 email:
 - p-goudet@ruby-dev.jp
 executables: []
@@ -139,10 +188,11 @@ files:
 - aws_iot_device.gemspec
 - bin/console
 - bin/setup
+- codeclimate.yml
 - lib/aws_iot_device.rb
 - lib/aws_iot_device/mqtt_adapter.rb
 - lib/aws_iot_device/mqtt_adapter/client.rb
-- lib/aws_iot_device/mqtt_adapter/mqtt_adapter.rb
+- lib/aws_iot_device/mqtt_adapter/paho_mqtt_adapter.rb
 - lib/aws_iot_device/mqtt_adapter/ruby_mqtt_adapter.rb
 - lib/aws_iot_device/mqtt_shadow_client.rb
 - lib/aws_iot_device/mqtt_shadow_client/json_payload_parser.rb
@@ -153,15 +203,19 @@ files:
 - lib/aws_iot_device/mqtt_shadow_client/token_creator.rb
 - lib/aws_iot_device/mqtt_shadow_client/topic_builder.rb
 - lib/aws_iot_device/version.rb
+- samples/config_shadow.rb
 - samples/mqtt_client_samples/mqtt_client_samples.rb
 - samples/shadow_action_samples/sample_shadow_action_update.rb
+- samples/shadow_client_samples/samples_shadow_client_block.rb
 - samples/shadow_client_samples/samples_shadow_client_delete.rb
+- samples/shadow_client_samples/samples_shadow_client_description.rb
 - samples/shadow_client_samples/samples_shadow_client_get.rb
+- samples/shadow_client_samples/samples_shadow_client_getting_started.rb
 - samples/shadow_client_samples/samples_shadow_client_update.rb
 - samples/shadow_topic_samples/sample_topic_manager.rb
 homepage: https://github.com/RubyDevInc/aws-iot-device-sdk-ruby
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -182,5 +236,6 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: A gem use to communicates with the Aws Iot platform through the MQTT protocol
+summary: The ruby version of the AWS IoT Device SDK. It enables to connect to AWS
+  IoT platform and manage Things.
 test_files: []