lora-rb 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa20e294270b6a37671b7d98b8afe2d70f19ea1f
-  data.tar.gz: 5510af9e4a7d1a0ffe716531ae595a4680812905
+  metadata.gz: b03ccb7f68a985497bf5b56243bae9fb9a2fec4c
+  data.tar.gz: 8f28fc05ec5d849056c9820285f687720e960e05
 SHA512:
-  metadata.gz: 76a047649347b811eb85fa7e8f1728208b1c404c318fc75360421dab2011e245a4b4ffd51344ffb237daac85ff8e1eb08999e3769865a3406b2e1a2532ff39d3
-  data.tar.gz: d7400a832dabe4cb4d2bc69917048be49d12406886e36fd55ad90136efc0d38cac7bb75d019bce2fe5c4408d245bbab0b0505058f8cfbb7d984b6c91b58f86b4
+  metadata.gz: 5c60b0f7b8460c1d215b00be34815a58028036f4499bdd6d999cd1db7eef4a54043fc2fcd143b26aea274ab933dcbd1447a9739f008ca73a85777d5057702ec3
+  data.tar.gz: 061beb001e41389bb4eb0ad7149382b495b743a7d4414ec1f56e6235b561639d11ccc158d36aee48619d8b98ffdcc17c46d8b820ae2364ac39c58473803eba1d

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+v0.12.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.11.0..v0.12.0) August 25th, 2017
+------------------------------
+* Mqtt:
+    * send_cmd doesn't use thread anymore. Now it subscribes each topics then read data, 
+      ones for each downlink_response_urls
+    * added timeout to the configuration params
+    * read_data now has a timeout after which it raises a Timeout::Error. Listen, on the other hand, doesn't have it. 
+    * read_data and listen now can use subscribed topics. To do that, set topic argument to nil
+    * downlink_response_urls now is an array, before it was an hash
+
 v0.11.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.10.0..v0.11.0) August 10th, 2017
 ------------------------------
 * Mqtt:

data/README.md

@@ -198,11 +198,24 @@ This is an example provided using mqtt protocol and the provider A2a:
 
 Using MQTT, by default the param wait_response is true. This means after publishing a message it waits the response 
 on dedicated topic.
+
+```ruby
+config.downlink_response_urls = [
+  { name: :queued, url: 'reply/{clientid}/id/{requestid}'},
+  # { name: :transmitted, url: '/sub/v1/users/{username}/apps/{appid}/devices/{deveui}/events/downlink' }
+  # { name: :confirmed, url: nil },
+]
+```
+
+For each downlink urls, a subscription is performed. Then, after the publication, a reading is made for each one.
+If you expect more than one response in the same topic, add it with url=nil to not subscribe it newly
+
 If you dont want to wait the response you just set that param to false.
 
 ```ruby
 lora.send_cmd(eui: 'Insert here your device eui',
               data: 'f0a1b3ff',
+              confirmed: false,
               wait_response: false)
 ```
 

data/lib/config/config.rb

@@ -12,10 +12,13 @@ LoraRb.configure do |config|
   config.port = 8883
   config.uplink_url = '/sub/v1/users/{username}/apps/{appid}/devices/+/uplink/+'
   config.downlink_url = '/api/v1/users/{username}/apps/{appid}/devices/{deveui}/downlink/post/reply/{clientid}/id/{requestid}'
-  config.downlink_response_urls = {
-      queued: 'reply/{clientid}/id/{requestid}',
-      transmitted: '/sub/v1/users/{username}/apps/{appid}/devices/{deveui}/events/downlink'
-  }
+  config.timeout = 10.0
+  # If you expect more than one response in a topic, add an item with url=nil to not subscribe it newly
+  config.downlink_response_urls = [
+      { name: :queued, url: 'reply/{clientid}/id/{requestid}'},
+      # { name: :transmitted, url: '/sub/v1/users/{username}/apps/{appid}/devices/{deveui}/events/downlink' }
+      # { name: :confirmed, url: nil },
+  ]
   config.ssl = true
   config.ssl_file = 'ssl_certificates/mqtt_ca.crt'
 end

data/lib/core/configuration.rb

@@ -2,7 +2,8 @@ module LoraRb
   class Configuration
     # attr_writer :allow_sign_up
 
-    attr_accessor :protocol, :host, :port, :uplink_url, :downlink_url, :downlink_response_urls, :ssl, :ssl_file, :env
+    attr_accessor :protocol, :host, :port, :uplink_url, :downlink_url, :downlink_response_urls, :ssl, :ssl_file, :env,
+                  :timeout
 
     def initialize
       @protocol = nil
@@ -14,6 +15,7 @@ module LoraRb
       @ssl = nil # True if uses tls
       @ssl_file = nil # The certificate's path
       @env = 'development'
+      @timeout = 10.0
     end
 
   end

data/lib/lora-rb/base.rb

@@ -20,8 +20,8 @@ class LoraClient
                username: LoraRb::Settings.username,
                password: LoraRb::Settings.password,
                ssl: LoraRb.configuration.ssl,
-               ssl_file: LoraRb.configuration.ssl_file
-                }.merge(options)
+               ssl_file: LoraRb.configuration.ssl_file,
+               timeout: LoraRb.configuration.timeout }.merge(options)
     @debug = options[:debug]
     @token = options[:token]
     @appid = options[:appid]

data/lib/lora-rb/mqtt/call.rb

@@ -39,6 +39,7 @@ module LoraRb
                                  { debug: options[:debug] })
 
       @downlink_url = merge_tags_to_url(options[:downlink_url])
+      @timeout = options[:timeout]
       @wait_response = options.has_key?(:wait_response) ? options[:wait_response] : true
       {'hello' => 'Lora-Rb: Ready to start!'}
     end
@@ -71,11 +72,13 @@ module LoraRb
 
       puts "#{Time.now} publish #{h_request.to_json} to #{publish_url}" if options[:debug]
 
-
       responses = []
-      thr_responses = []
+      # thr_response = nil
       if options[:wait_response]
-        @downlink_response_urls.each do |name, response_url|
+        @downlink_response_urls.each do |dru_hash|
+          name, response_url = dru_hash[:name], dru_hash[:url]
+          next unless response_url
+
           # response_topic = "reply/#{@client_id}/id/#{request_id}"
           response_topic = merge_tags_to_url(response_url,
                                              username: @username,
@@ -83,13 +86,8 @@ module LoraRb
                                              deveui: options[:eui],
                                              clientid: @client_id,
                                              requestid: request_id)
-          puts " [x] Starting thread #{name} to wait response on topic #{response_topic} ..." if options[:debug] == :full
-          thr_responses << Thread.new do
-            response_topic, response_message = sub_read_data(topic: response_topic)
-            response = { name: name, topic: response_topic, json: response_message }
-            puts " [x] End thread with response #{response} " if options[:debug] == :full
-            responses << response
-          end
+          puts " [x] Subscribing response #{response_topic}" if options[:debug] == :full
+          @client.subscribe(response_topic)
         end
       end
 
@@ -97,31 +95,54 @@ module LoraRb
 
       if options[:wait_response]
         # Waiting for all the responses
-        thr_responses.each { |thr_response| thr_response.join }
+        # thr_responses.each { |thr_response| thr_response.join }
+        # thr_response.join
+        @downlink_response_urls.each do |dru_hash|
+          response_topic, response_message = sub_read_data(topic: nil)
+          response = { topic: response_topic, json: response_message }
+          puts " [x] Found response #{response} " if options[:debug] == :full
+          responses << response
+        end
       end
       responses
     end
 
     # Receive the payload from the network
+    # There is a timeout. Use this method only to retrieve data from the queue. If you have to waiting data
+    # please use listen.
     def sub_read_data(options={})
-      topic = options[:topic] || @topic
-      puts " [x] Reading topic #{topic}..." if options[:debug]
-      topic, message = @client.get(topic.dup)
+      topic = options.has_key?(:topic) ? options[:topic] : @topic
+      if topic
+        topic = topic.dup
+        puts " [x] Reading topic #{topic}..." if options[:debug]
+      end
+
+      message = nil
+      begin
+        Timeout.timeout(options[:timeout] || @timeout) do
+          topic, message = @client.get(topic)
+        end
+      rescue Timeout::Error
+        message = {error: 'Timeout'}.to_json
+      end
+
       message = JSON.parse(message)
       if message.respond_to? '[]'
         message['eui'] ||= get_eui_from_topic(topic)
         message['port'] ||= get_port_from_topic(topic)
       end
-      puts " [x] #{topic}: #{message}" if options[:debug]
       return topic, message
     end
 
     # Waiting for message in the queue
     def sub_listen(options={}, &block)
-      topic = options[:topic] || @topic
-      puts " [*] Waiting for messages in #{topic}. To exit press CTRL+C" if options[:debug]
+      topic = options.has_key?(:topic) ? options[:topic] : @topic
+      if topic
+        topic = topic.dup
+        puts " [*] Waiting for messages in #{topic}. To exit press CTRL+C" if options[:debug]
+      end
 
-      @client.get(topic.dup) do |topic, message|
+      @client.get(topic) do |topic, message|
         # Block is executed for every message received
         puts " [x] #{topic}: #{message}" if options[:debug]
         message = JSON.parse(message)

data/lib/lora-rb/utility.rb

@@ -7,12 +7,12 @@ module LoraRb
     # Show tips on usage
     def merge_tags_to_url(url, tags={}, options={})
       url = url.dup
-      puts "merge_tags_to_url: #{url}" if options[:debug]
+      puts "merge_tags_to_url: #{url}" if options[:debug] == :full
       tags.each do |tag, value|
-        puts " replace {#{tag}} with #{value}" if options[:debug]
+        puts " replace {#{tag}} with #{value}" if options[:debug] == :full
         url.gsub!("{#{tag}}", value.to_s)
       end
-      puts "merge_tags_to_url: completed #{url}" if options[:debug]
+      puts "merge_tags_to_url: completed #{url}" if options[:debug] == :full
       url
     end
   end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module LoraRb
   def self.version
-    "0.11.0"
+    "0.12.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lora-rb
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Marco Mastrodonato