aws_iot_device 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aws_iot_device.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aws_iot_device/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aws_iot_device"
+  spec.version       = AwsIotDevice::VERSION
+  spec.authors       = ["Pierre Goudet"]
+  spec.email         = ["p-goudet@ruby-dev.jp"]
+
+  spec.summary       = %q{A gem use to communicates with the Aws Iot platform through the MQTT protocol}
+  spec.description   = %q{A gem use to communicates with the Aws Iot platform through the MQTT protocol}
+  spec.homepage      = "https://github.com/RubyDevInc/aws-iot-device-sdk-ruby"
+  spec.license       = "Apache 2.0"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "facets", "~> 3.1.0"
+  spec.add_runtime_dependency "json", "~> 1.8.3"
+  spec.add_runtime_dependency "mqtt", "~> 0.4.0"
+  spec.add_runtime_dependency "timers", "~> 4.1.1"
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aws_iot"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aws_iot_device.rb

@@ -0,0 +1,7 @@
+require "aws_iot_device/version"
+require "aws_iot_device/mqtt_adapter"
+require "aws_iot_device/mqtt_shadow_client"
+
+module AwsIotDevice
+  # Your code goes here...
+end

data/lib/aws_iot_device/mqtt_adapter.rb

@@ -0,0 +1,32 @@
+require 'facets'
+require 'aws_iot_device/mqtt_adapter/client'
+
+module AwsIotDevice
+  module MqttAdapter
+    extend self
+
+    ### Return the adapter selected for the module with either a pre-setted value or a default value
+    def adapter
+      return @adapter if @adapter
+      ### Calling the setter method with the default symbol 'RubyMqttAdapter' and return it.
+      self.adapter = :ruby_mqtt_adapter
+      @adapter
+    end
+
+    ### The setter of the module's adapter attributes
+    def adapter=(adapter_lib)
+      case adapter_lib
+      when Symbol, String
+        begin
+          require "aws_iot_device/mqtt_adapter/#{adapter_lib}"
+        rescue LoadError
+          raise "LoadError: Could find adapters for the lib #{adapter_lib}"
+          exit
+        end
+        @adapter = MqttAdapter.const_get("#{adapter_lib.to_s.camelcase(:upper)}")
+      else
+        raise "TypeError: Library name should be a String or Symbol"
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_adapter/client.rb

@@ -0,0 +1,139 @@
+module AwsIotDevice
+  module MqttAdapter
+    class Client
+
+      attr_reader :client_id
+
+      ### @adapter contains the name of the adapter that should be module as a third party librairy
+      ### The method call by the shared client are implemented by the third party or the adapter module itself.
+      ### @adapter default value is MqttShareLib::Adapters::RubyMqttAdapter
+      attr_accessor :adapter
+
+      ### @on_'event' contains the callback's [block, Proc, lambda] that should be called when 'event' is catched
+      ### Callbacks should be customized in the higher level class (ex. MqttManger or upper)
+      ### Callback should be called by some (private) handlers define in the third party librairy
+
+      ### On a MqttAdapter's create, the client adapter is set as the previously define module adapter
+      ### The client is then initialize with the client type of the third librairy of the adapter.
+      ### @client default type is MQTT::Client
+      def initialize(*args)
+        @adapter = MqttAdapter.adapter.new(*args)
+      end
+
+      def client_id
+        @adapter.client_id
+      end
+
+      ### The following method represent the basics common MQTT actions.
+      ### As possible, they should be implemented in the third party librairy
+      ### If not, the adpater should implement them or throw and excpetion
+      def connect(*args, &block)
+        @adapter.connect(*args, &block)
+      end
+
+      def publish(topic, payload='', retain=false, qos=0)
+        @adapter.publish(topic, payload, retain, qos)
+      end
+
+      def loop_start
+        @thread = @adapter.loop_start
+      end
+
+      def loop_stop
+        @adapter.loop_stop(@thread)
+      end
+
+      def loop_forever
+        @adapter.loop_forever
+      end
+
+      def mqtt_loop
+        @adapter.loop
+      end
+
+      def loop_read
+        @adapter.loop_read
+      end
+
+      def loop_write
+        @adapter.loop_write
+      end
+
+      def loop_misc
+        @adapter.loop_misc
+      end
+
+      def get(topic=nil, &block)
+        @adapter.get(topic, &block)
+      end
+
+      def get_packet(topic=nil, &block)
+        @adapter.get_packet(topic, &block)
+      end
+
+      def generate_client_id
+        @adapter.generate_client_id
+      end
+
+      def disconnect(send_msg=true)
+        @adapter.disconnect(send_msg)
+      end
+
+      def connected?
+        @adapter.connected?
+      end
+
+      def subscribe(topic)
+        @adapter.subscribe(topic)
+      end
+
+      def unsubscribe(topic)
+        @adapter.unsubscribe(topic)
+      end
+
+      def set_tls_ssl_context(ca_cert, cert=nil, key=nil)
+        @adapter.set_tls_ssl_context(ca_cert, cert, key)
+      end
+
+      def add_callback_filter_topic(topic, callback)
+        @adapter.add_callback_filter_topic(topic, callback)
+      end
+
+      def remove_callback_filter_topic(topic)
+        @adapter.remove_callback_filter_topic(topic)
+      end
+
+      def on_message=(callback)
+        @adapter.on_message = callback
+      end
+
+      ### The following attributes should exists in every MQTT third party librairy.
+      ### They are necessary (or really usefull and common) for the establishement of the connection and/or the basic Mqtt actions.
+      ### The setter directely change the third party client value when the getter remote the actual SharedClient instance's attribute value
+      def host
+        @adapter.host
+      end
+
+      def host=(host)
+        @adapter.host = host
+      end
+
+      def port
+        @adapter.port
+      end
+
+      def port=(port)
+        @adapter.port = port
+      end
+
+      # Boolean for the encrypted mode (true = ssl/tls | false = no encryption)
+      def ssl
+        @adapter.ssl
+      end
+
+      def ssl=(ssl)
+        @adapter.ssl = ssl
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_adapter/mqtt_adapter.rb

@@ -0,0 +1,139 @@
+module AwsIotDevice
+  module MqttAdapter
+    class MqttAdapter
+
+      attr_reader :client_id
+
+      ### @adapter contains the name of the adapter that should be module as a third party librairy
+      ### The method call by the shared client are implemented by the third party or the adapter module itself.
+      ### @adapter default value is MqttShareLib::Adapters::RubyMqttAdapter
+      attr_accessor :adapter
+
+      ### @on_'event' contains the callback's [block, Proc, lambda] that should be called when 'event' is catched
+      ### Callbacks should be customized in the higher level class (ex. MqttManger or upper)
+      ### Callback should be called by some (private) handlers define in the third party librairy
+
+      ### On a MqttAdapter's create, the client adapter is set as the previously define module adapter
+      ### The client is then initialize with the client type of the third librairy of the adapter.
+      ### @client default type is MQTT::Client
+      def initialize(*args)
+        @adapter = ::MqttAdapterLib.adapter.new(*args)
+      end
+
+      def client_id
+        @adapter.client_id
+      end
+
+      ### The following method represent the basics common MQTT actions.
+      ### As possible, they should be implemented in the third party librairy
+      ### If not, the adpater should implement them or throw and excpetion
+      def connect(*args, &block)
+        @adapter.connect(*args, &block)
+      end
+
+      def publish(topic, payload='', retain=false, qos=0)
+        @adapter.publish(topic, payload, retain, qos)
+      end
+
+      def loop_start
+        @thread = @adapter.loop_start
+      end
+
+      def loop_stop
+        @adapter.loop_stop(@thread)
+      end
+
+      def loop_forever
+        @adapter.loop_forever
+      end
+
+      def mqtt_loop
+        @adapter.loop
+      end
+
+      def loop_read
+        @adapter.loop_read
+      end
+
+      def loop_write
+        @adapter.loop_write
+      end
+
+      def loop_misc
+        @adapter.loop_misc
+      end
+
+      def get(topic=nil, &block)
+        @adapter.get(topic, &block)
+      end
+
+      def get_packet(topic=nil, &block)
+        @adapter.get_packet(topic, &block)
+      end
+
+      def generate_client_id
+        @adapter.generate_client_id
+      end
+
+      def disconnect(send_msg=true)
+        @adapter.disconnect(send_msg)
+      end
+
+      def connected?
+        @adapter.connected?
+      end
+
+      def subscribe(topic)
+        @adapter.subscribe(topic)
+      end
+
+      def unsubscribe(topic)
+        @adapter.unsubscribe(topic)
+      end
+
+      def set_tls_ssl_context(ca_cert, cert=nil, key=nil)
+        @adapter.set_tls_ssl_context(ca_cert, cert, key)
+      end
+
+      def add_callback_filter_topic(topic, callback)
+        @adapter.add_callback_filter_topic(topic, callback)
+      end
+
+      def remove_callback_filter_topic(topic)
+        @adapter.remove_callback_filter_topic(topic)
+      end
+
+      def on_message=(callback)
+        @adapter.on_message = callback
+      end
+
+      ### The following attributes should exists in every MQTT third party librairy.
+      ### They are necessary (or really usefull and common) for the establishement of the connection and/or the basic Mqtt actions.
+      ### The setter directely change the third party client value when the getter remote the actual SharedClient instance's attribute value
+      def host
+        @adapter.host
+      end
+
+      def host=(host)
+        @adapter.host = host
+      end
+
+      def port
+        @adapter.port
+      end
+
+      def port=(port)
+        @adapter.port = port
+      end
+
+      # Boolean for the encrypted mode (true = ssl/tls | false = no encryption)
+      def ssl
+        @adapter.ssl
+      end
+
+      def ssl=(ssl)
+        @adapter.ssl = ssl
+      end
+    end
+  end
+end

data/lib/aws_iot_device/mqtt_adapter/ruby_mqtt_adapter.rb

@@ -0,0 +1,176 @@
+require 'mqtt'
+require 'thread'
+
+module AwsIotDevice
+  module MqttAdapter
+    class RubyMqttAdapter
+
+      attr_reader :client_id
+
+      attr_accessor :filtered_topics
+
+      def initialize(*args)
+        @client = MQTT::Client.new(*args)
+        @filtered_topics = {}
+        @client_id = ""
+        @client_id = generate_client_id
+      end
+
+      def client_id
+        @client_id
+      end
+
+      def publish(topic, payload='', retain=false, qos=0)
+        @client.publish(topic, payload, retain, qos)
+      end
+
+      def create_client(*args)
+        @client = MQTT::Client.new(*args)
+      end
+
+      def connect(*args, &block)
+        client = create_client(*args) if @client.nil?
+        @client.connect(&block)
+        loop_start
+      end
+
+      def generate_client_id(prefix='ruby', lenght=16)
+        charset = Array('A'..'Z') + Array('a'..'z') + Array('0'..'9')
+        @client_id << prefix << Array.new(lenght) { charset.sample }.join
+      end
+
+      def ssl_context
+        @client.ssl_context
+      end
+
+      def disconnect(send_msg=true)
+        @client.disconnect(send_msg)
+      end
+
+      def connected?
+        @client.connected?
+      end
+
+      def subscribe(topics, qos=0)
+        @client.subscribe(topics, qos)
+      end
+
+      def get(topic=nil, &block)
+        @client.get(topic, &block)
+      end
+
+      def get_packet(topic=nil, &block)
+        @client.get_packet(topic, &block)
+      end
+
+      def queue_empty?
+        @client.queue_empty?
+      end
+
+      def queue_length
+        @client.queue_length
+      end
+
+      def unsubscribe(*topics)
+        @client.unsubscribe(*topics)
+      end
+
+      def host
+        @client.host
+      end
+
+      def host=(host)
+        @client.host = host
+      end
+
+      def port
+        @client.port
+      end
+
+
+      def port=(port)
+        @client.port = port
+      end
+
+      def ssl=(ssl)
+        @client.ssl = ssl
+      end
+
+      def set_tls_ssl_context(ca_cert, cert=nil, key=nil)
+        @client.ssl ||= true
+        @client.ssl_context
+        @client.cert_file = cert
+        @client.key_file = key
+        @client.ca_file = ca_cert
+      end
+
+      ############### Custom Features #################
+
+      def loop_start
+        Thread.new{loop_forever}
+      end
+
+      def loop_stop(thread)
+        thread.join
+      end
+
+      def loop_forever
+        loop do
+          mqtt_loop
+        end
+      end
+
+      def mqtt_loop
+        loop_read
+        loop_write
+        loop_misc
+      end
+
+      def loop_read(max_message=10)
+        counter_message = 0
+        while !@client.queue_empty? && counter_message <= max_message
+          message = get_packet
+          ### Fitlering message if matching to filtered topic
+          topic = message.topic
+          if @filtered_topics.key?(topic)
+            callback = @filtered_topics[topic] 
+            callback.call(message)
+          else
+            on_message_callback(message)
+          end
+          counter_message += 1
+        end
+      end
+
+      def loop_write
+      end
+
+      def loop_misc
+      end
+
+      def on_message=(callback)
+        @on_message = callback
+      end
+
+      def on_message_callback(message)
+        if @on_message.is_a? Proc
+          @on_message.call(message)
+        end
+      end
+
+      def add_callback_filter_topic(topic, callback)
+        unless callback.nil?
+          @filtered_topics[topic] = callback
+        else
+          @filtered_topic.delete(topic)
+        end
+      end
+
+      def remove_callback_filter_topic(topic)
+        if @filtered_topics.key(topic)
+          @filtered_topics.delete(topic)
+        end
+      end
+    end
+  end
+end