m2x-mqtt 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6473976f9a8f12fcb6c6e8e08884a31b6e7865e0
-  data.tar.gz: 3e4b2ad0d14a5e5a5324da70bc54f22c145a80d5
+  metadata.gz: 4e5c6b14401ae444dfd7369aa051367c84e99469
+  data.tar.gz: 349ab423f5899f54af40b9c4dae57b40de04f1d5
 SHA512:
-  metadata.gz: bdef4c3d3d59b5b1b2a7efd4aa0aeb8d4e229528327cf92280dc978426709ecc2abe0275ee948ed6cfd6ee21a7be1626a0979197132174e655db9ffbb7ad9eba
-  data.tar.gz: 462e780b49e185af8109e646712ebebb497ffdb8148f06d45b934efe55d4c631bb583405e1a38bbe71b81c0b5027fc233b05b9a2e9ffd2b08788d5357101c608
+  metadata.gz: 3b844080a95c6a2b88d41270225ece40aa5c1cfbda94fc7832a2bf3bbe66c24d5dff27c27ecaa50836e9077056c2a6fde0407f83722d914a7f788ce8afc31e25
+  data.tar.gz: 5d1dc996ff2e34369fde6cd4ac1413a98bd36acecbd8e5d6c7cf1ec5b625b2d9d8d17ac4f8ca4d12288ef04bfd11bd7a5f233d942910d2f9d06b9e1d8a196348

data/lib/m2x/mqtt.rb

@@ -2,10 +2,12 @@ module M2X
   class MQTT
     require_relative "mqtt/version"
     require_relative "mqtt/client"
+    require_relative "mqtt/client/packet_router"
     require_relative "mqtt/resource"
     require_relative "mqtt/device"
     require_relative "mqtt/distribution"
     require_relative "mqtt/stream"
+    require_relative "mqtt/command"
 
     attr_accessor :client
 

data/lib/m2x/mqtt/client.rb

@@ -16,15 +16,18 @@ class M2X::MQTT::Client
   def initialize(api_key, options={})
     @api_key = api_key
     @options = DEFAULTS.merge(options)
+
+    @packet_router = PacketRouter.new
   end
 
   # Public: Subscribe the client to the responses topic.
   #
-  # This is required in order to receive responses from the
-  # M2X API server. Note that #get_response already subscribes
-  # the client.
+  # This is required in order to receive responses or commands
+  # from the M2X API server. Note that #get_response already
+  # subscribes the client.
   def subscribe
     mqtt_client.subscribe(response_topic)
+    mqtt_client.subscribe(command_topic)
   end
 
   # Public: Send a payload to the M2X API server.
@@ -45,10 +48,27 @@ class M2X::MQTT::Client
   # Optionally receives a block which will iterate through responses
   # and yield each one.
   def get_response
-    return JSON.parse(mqtt_client.get_packet(response_topic).payload) unless block_given?
+    mqtt_client.subscribe(response_topic)
 
-    mqtt_client.get_packet(response_topic) do |packet|
-      yield JSON.parse(packet.payload)
+    return packet_router.json_fetch(mqtt_client, response_topic) unless block_given?
+
+    loop do
+      yield packet_router.json_fetch(mqtt_client, response_topic)
+    end
+  end
+
+  # Public: Retrieve a command from the M2X Server.
+  #
+  # Returns a Hash with the command from the MQTT Server in M2X.
+  # Optionally receives a block which will iterate through commands
+  # and yield each one.
+  def get_command
+    mqtt_client.subscribe(command_topic)
+
+    return M2X::MQTT::Command.new(self, packet_router.json_fetch(mqtt_client, command_topic)) unless block_given?
+
+    loop do
+      yield M2X::MQTT::Command.new(self, packet_router.json_fetch(mqtt_client, command_topic))
     end
   end
 
@@ -60,6 +80,8 @@ class M2X::MQTT::Client
 
   private
 
+  attr_reader :packet_router
+
   def request(verb, path, params=nil)
     path  = versioned(path)
     body  = params || {}
@@ -85,6 +107,10 @@ class M2X::MQTT::Client
     @response_topic ||= "m2x/#{@api_key}/responses".freeze
   end
 
+  def command_topic
+    @command_topic ||= "m2x/#{@api_key}/commands".freeze
+  end
+
   def mqtt_client
     @mqtt_client ||= ::MQTT::Client.new.tap do |client|
                        client.host     = @options[:api_url]

data/lib/m2x/mqtt/client/packet_router.rb

@@ -0,0 +1,27 @@
+require "json"
+require "thread"
+
+class M2X::MQTT::Client::PacketRouter
+  def initialize
+    @lock   = Mutex.new
+    @queues = Hash.new { |hash, key| hash[key] = [] }
+  end
+
+  def fetch(mqtt_client, topic)
+    @lock.synchronize do
+      packet = @queues[topic].shift
+      return packet if packet
+
+      loop do
+        packet = mqtt_client.get_packet
+        return packet if topic == packet.topic
+
+        @queues[packet.topic] << packet
+      end
+    end
+  end
+
+  def json_fetch(mqtt_client, topic)
+    JSON.parse(fetch(mqtt_client, topic).payload)
+  end
+end

data/lib/m2x/mqtt/command.rb

@@ -0,0 +1,31 @@
+require "uri"
+
+# Wrapper for AT&T M2X Commands API
+# https://m2x.att.com/developer/documentation/v2/device
+class M2X::MQTT::Command < M2X::MQTT::Resource
+
+  def initialize(client, attributes)
+    @client     = client
+    @attributes = attributes
+  end
+
+  def path
+    @path ||= URI.parse(@attributes.fetch("url")).path
+  end
+
+  # Mark the command as processed, with optional response data.
+  # Check the API response after calling to verify success (no status conflict).
+  #
+  # https://m2x.att.com/developer/documentation/v2/commands#Device-Marks-a-Command-as-Processed
+  def process!(response_data={})
+    @client.post("#{path}/process", response_data)
+  end
+
+  # Mark the command as rejected, with optional response data.
+  # Check the API response after calling to verify success (no status conflict).
+  #
+  # https://m2x.att.com/developer/documentation/v2/commands#Device-Marks-a-Command-as-Rejected
+  def reject!(response_data={})
+    @client.post("#{path}/reject", response_data)
+  end
+end

data/lib/m2x/mqtt/device.rb

@@ -23,6 +23,27 @@ class M2X::MQTT::Device < M2X::MQTT::Resource
     M2X::MQTT::Stream.new(@client, self, "name" => name)
   end
 
+  # Return a list of recently received commands.
+  #
+  # Most commonly, this method can be used to fetch unacknowledged
+  # commands by filtering by delivery status, using the parameters:
+  #
+  # { status: "sent" }
+  #
+  # MQTT clients that are subscribed to command delivery notifications
+  # should still use this method periodically to check for unacknowledged
+  # commands that were missed while offline or during a network partition.
+  #
+  # https://m2x.att.com/developer/documentation/v2/commands#Device-List-of-Received-Commands
+  def commands(params={})
+    @client.get("#{path}/commands", params)
+
+    res      = @client.get_response
+    commands = res["body"]["commands"] if res["status"] < 300
+
+    commands.map { |data| M2X::MQTT::Command.new(@client, data) } if commands
+  end
+
   # Update the current location of the specified device.
   #
   # https://m2x.att.com/developer/documentation/v2/device#Update-Device-Location

data/lib/m2x/mqtt/resource.rb

@@ -21,4 +21,19 @@ class M2X::MQTT::Resource
   def path
     raise NotImplementedError
   end
+
+  # Return the resource details
+  def view
+    @client.get(path)
+
+    res = @client.get_response
+
+    @attributes = res["body"] if res["status"] < 300 && res["body"]
+  end
+
+  # Refresh the resource details and return self
+  def refresh
+    view
+    self
+  end
 end

data/lib/m2x/mqtt/version.rb

@@ -1,5 +1,5 @@
 module M2X
   class MQTT
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: m2x-mqtt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Leandro López
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt
@@ -42,6 +42,8 @@ files:
 - README.md
 - lib/m2x/mqtt.rb
 - lib/m2x/mqtt/client.rb
+- lib/m2x/mqtt/client/packet_router.rb
+- lib/m2x/mqtt/command.rb
 - lib/m2x/mqtt/device.rb
 - lib/m2x/mqtt/distribution.rb
 - lib/m2x/mqtt/resource.rb
@@ -68,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby client for AT&T M2X (MQTT)