apiotics_aws_client 1.0.1

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

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

@@ -0,0 +1,30 @@
+$:.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
+
+delta_callback = Proc.new do |delta|
+  message = JSON.parse(delta.payload)
+  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:"
+  entry = $stdin.readline()
+  json_payload = "{\"state\":{\"desired\":{\"message\":\"#{entry.delete!("\n")}\"}}}"
+  my_shadow_client.update_shadow(json_payload, 5, filter_callback)
+  puts "#{3 - n} Message(s) left"
+  n += 1
+end
+
+sleep 3
+
+my_shadow_client.disconnect

data/samples/shadow_topic_samples/sample_topic_manager.rb

@@ -0,0 +1,26 @@
+$:.unshift(File.expand_path("../../../samples", __FILE__))
+
+require 'aws_iot_device'
+require 'config_shadow'
+
+mqtt_client = setting_mqtt_client
+
+topic_client = setting_topic_manager(mqtt_client)
+
+filter_callback = Proc.new do |message|
+  puts "Received (through filtered callback) : "
+  puts "------------------- Topic: #{message.topic}" 
+  puts "------------------- Payload: #{message.payload}"
+  puts "###################"
+end
+
+topic_client.shadow_topic_subscribe("get", filter_callback)
+
+4.times do
+  topic_client.shadow_topic_publish("get", "")
+end
+
+sleep 2
+
+mqtt_client.disconnect
+

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: apiotics_aws_client
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Mac Dougherty
+- Pierre Goudet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.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.10.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: 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: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: 2.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: apiotics-paho-mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: timers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+    - - ">="
+      - !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:
+- info@apiotics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- apiotics-aws-iot-client-1.0.0.gem
+- apiotics_aws_client.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/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
+- lib/aws_iot_device/mqtt_shadow_client/mqtt_manager.rb
+- lib/aws_iot_device/mqtt_shadow_client/shadow_action_manager.rb
+- lib/aws_iot_device/mqtt_shadow_client/shadow_client.rb
+- lib/aws_iot_device/mqtt_shadow_client/shadow_topic_manager.rb
+- 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://portal.apiotics.com
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: The ruby version of the AWS IoT Device SDK. It enables to connect to AWS
+  IoT platform and manage Things.
+test_files: []