lora-rb 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d9ae8b46b9a42db2037a2fa8982464bb9752af1
-  data.tar.gz: 9035bc787caaeb5d2ed80c2fca7bc4d59bcfebce
+  metadata.gz: e64d803226daebe33886346c591fe64547de3222
+  data.tar.gz: f8bbfa9765e0b8e59e1a5d31cd393bd162ca599f
 SHA512:
-  metadata.gz: fb96d0297ecdde1cdd73c92ba9af09184cec57a558b50e7ab625abc32942c3dec8f0a5280eedbac23e12fbeb55f2ae813ea5096bf3e4c0abab0c37fe33133f4d
-  data.tar.gz: 8eb4548eee426a26c629cb3a9a19214c2efff3daab9d20f5976200bf959ba67cc8125da44e570e19d7be7ea6c184f2604d21583289de91a235248dd1920692a8
+  metadata.gz: '02503788daa2ca41e53219162fbba9062060d491058cc9f72f5ba639ffd23341b4ce7573c4b0769c0a7bcdd97fbe261601280b7de7c0248ea0c8f55daabee7b1'
+  data.tar.gz: 38a51544561b73924783012f69118e0916950dacb3fc3ad8a7500a10e3b47d8f1cc47fb7937a01d8c68fc483168202e8b0fdc233e09158ec821e3a8999a0aefd

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+v0.15.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.14.0..v0.15.0) November 1th, 2017
+------------------------------
+* Added new parameter "provider" to connection's configuration 
+* Added provider fractalgarden as new provider which support mqtt protocol. It offers free service, try it!
+* LoraClient class is now extended by the provider's methods on the initialization. In the future, this will make it easier 
+  to connect to multiple network servers.
+* Several improvements
+
 v0.14.1 October 20th, 2017
 ------------------------------
 * Mqtt: method all_enqueued_downlink_id raise the custom exception EuiNotFound 

data/lib/config/config.rb

@@ -7,6 +7,8 @@ LoraRb.configure do |config|
   # config.host = 'localhost'
   # config.protocol = :http
   # config.host = 'eu72.resiot.io'
+  # A2a
+  config.provider = :a2a
   config.protocol = :mqtt
   config.host = 'ptnetsuite.a2asmartcity.io'
   config.port = 8883
@@ -23,4 +25,18 @@ LoraRb.configure do |config|
   ]
   config.ssl = true
   config.ssl_file = 'ssl_certificates/mqtt_ca.crt'
+  # Fractalgarden Free Network Server
+  # config.provider = :fractalgarden
+  # config.protocol = :mqtt
+  # config.host = '192.168.1.106'
+  # config.port = 1883
+  # config.uplink_url = 'application/{appid}/node/+/rx'
+  # config.downlink_url = 'application/{appid}/node/{deveui}/tx'
+  # config.timeout = 30.0
+  # # If you expect more than one response in a topic, ad a item with url=nil to not subscribe it newly
+  # config.downlink_response_urls = [
+  #     { name: :queued, url: 'reply/{clientid}/id/{requestid}'},
+  # ]
+  # config.ssl = false
+  # # config.ssl_file = "#{Rails.root}/vendor/ssl_certificates/a2a_mqtt_ca.crt"
 end

data/lib/config/private.yml

@@ -8,12 +8,16 @@ defaults: &defaults
   #connector_id: "69643d32"
   # A2a
   #appid: "a1b2c3d4e5f60001"
-  appid: "9956" # SSG dev
   token: "2B7E151628AED2A6ABF7158809CF4F3C"
+  appid: "9957"
   username: "fractalgarden"
   password: "fr4ctalg4rden"
+  # Fractalgarden
+#  appid: "1"
+#  username: "loraserver_gw"
+#  password: "loraserver_gw"
 
-  test_eui: "be7a0000000010cf"
+  test_eui: "be7a00000000123c"
   #foo: add every variable you need and use it with => LoraRb::Settings.foo
   #  bar: sub variable are accessible with hash => LoraRb::Settings.foo[:bar]
 

data/lib/core/configuration.rb

@@ -2,11 +2,12 @@ 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,
-                  :timeout, :enqueued_downlinks_url, :delete_enqueued_downlink_url
+    attr_accessor :provider, :protocol, :host, :port, :uplink_url, :downlink_url, :downlink_response_urls,
+                  :ssl, :ssl_file, :env, :timeout, :enqueued_downlinks_url, :delete_enqueued_downlink_url
 
     def initialize
-      @protocol = nil
+      @provider = nil #PROVIDERS.keys.first
+      @protocol = nil #PROVIDERS[@provider].first
       @host = nil
       @port = nil
       @uplink_url = nil
@@ -19,7 +20,6 @@ module LoraRb
       @env = 'development'
       @timeout = 10.0
     end
-
   end
 
   def self.configuration

data/lib/core/protocol.rb

@@ -3,9 +3,19 @@ module LoraRb
   # It contains protocols methods
   class Protocol
 
-    # Show tips on usage
-    def self.supported_protocols
-      %w(tls http rabbitmq mqtt)
+    PROVIDERS = { fractalgarden: [:mqtt],
+                  a2a: [:mqtt],
+                  loriot: [:tls],
+                  resiot: [:http]
+    }
+
+    def self.provider_is_valid?(provider: LoraRb.configuration.provider)
+      PROVIDERS.has_key? provider
+    end
+    def self.supported?(provider: LoraRb.configuration.provider,
+                                 protocol: LoraRb.configuration.protocol)
+      return unless provider && protocol
+      PROVIDERS[provider] && PROVIDERS[provider].include?(protocol.to_sym)
     end
   end
 end

data/lib/lora-rb.rb

@@ -26,16 +26,10 @@ require_relative 'lora-rb/base'
 unless defined?(Rails)
   require_relative 'config/config'
 
-  connection_protocol = LoraRb.configuration.protocol
-  raise "Define your protocol in the configuration file!" unless connection_protocol
-  raise "Connection protocol #{connection_protocol} not recognized!" unless LoraRb::Protocol.supported_protocols.include?(connection_protocol.to_s)
-  require_relative "lora-rb/#{connection_protocol}/call"
-  LoraClient.include LoraRb::Call
-
   %w(private.yml).each  do |file|
     filepath = File.join(LoraRb.root, 'lib', 'config', file)
     LoraRb::Settings.load!(filepath, env: LoraRb.configuration.env) if File.exist? filepath
   end
-  raise "Insert your secret data to login on the lora cloud!" if LoraRb::Settings.appid.nil? || LoraRb::Settings.token.nil?
+  raise "Insert your secret data to login on the lora network server!" if LoraRb::Settings.appid.nil? || LoraRb::Settings.token.nil?
 end
 

data/lib/lora-rb/{mqtt → a2a/mqtt}/call.rb

@@ -10,27 +10,29 @@ module LoraRb
     def sub_initialize(options={})
       require 'mqtt'
 
-      raise 'Specify uplink_url to continue!' unless options[:uplink_url]
-      raise 'Specify downlink_url to continue!' unless options[:downlink_url]
+      raise 'Specify uplink_url to continue!'             unless options[:uplink_url]
+      raise 'Specify downlink_url to continue!'           unless options[:downlink_url]
       raise 'Specify downlink_response_urls to continue!' unless options[:downlink_response_urls]
-      raise 'Specify host to continue!' unless options[:host]
-      raise 'Specify port to continue!' unless options[:port]
-      raise 'Specify username to continue!' unless options[:username]
-      raise 'Specify password to continue!' unless options[:password]
-      raise 'Specify ssl_file to continue!' if options[:ssl] && !options[:ssl_file]
+      raise 'Specify host to continue!'                   unless options[:host]
+      raise 'Specify port to continue!'                   unless options[:port]
+      raise 'Specify username to continue!'               unless options[:username]
+      raise 'Specify password to continue!'               unless options[:password]
+      raise 'Specify ssl_file to continue!'               if options[:ssl] && !options[:ssl_file]
 
       @username = options[:username]
       @client_id = "#{@username}::ssg#{generate_request_id}"
 
-      @client = MQTT::Client.connect(
+      connection_attributes = {
           host: options[:host],
           port: options[:port],
           ssl:  options[:ssl],
-          cert_file: options[:ssl_file],
           username: @username,
           password: options[:password],
           client_id: @client_id
-      )
+      }
+      connection_attributes[:cert_file] = options[:ssl_file] if connection_attributes[:ssl]
+      # The class variable @@mock is set by the stubbed class. The other methods (send_cmd etc.) are entirely stubbed.
+      @client = MQTT::Client.connect(connection_attributes) unless defined?(@@mock) && @@mock
 
       @topic = merge_tags_to_url(options[:uplink_url],
                                  { username: @username,
@@ -56,9 +58,12 @@ module LoraRb
         "port": options[:port],               # Port where the message should be sent
         "payload": options[:data],            # Message payload
         "confirmed": options[:confirmed],     # (Optional) Tells whether a confirmed downlink is requested. Default: false
-        "window": options[:window] || "BOTH", # (Optional) Specifies which rx window should be used: RX1, RX2 or any(BOTH). Default: BOTH
-        "priority": options[:priority] || 0,  # (Optional) Message priority, used to sort messages in the queue. Default: 0
       }
+      # (Optional) Specifies which rx window should be used: RX1, RX2 or any(BOTH). Default: BOTH
+      h_request['window'] = options[:window] if options[:window]
+      # (Optional) Message priority, used to sort messages in the queue. Default: 0
+      h_request['priority'] = options[:priority] if options[:priority]
+
       request_id = generate_request_id
       publish_url = merge_tags_to_url(@downlink_url,
                                        username: @username,

data/lib/lora-rb/base.rb

@@ -30,6 +30,14 @@ class LoraClient
 
     require 'philter'
     require 'securerandom'
+
+    raise "Specify your provider in the configuration file!" unless LoraRb.configuration.provider
+    raise "Specify the protocol in the configuration file!" unless LoraRb.configuration.protocol
+    raise "Provider #{LoraRb.configuration.provider} not defined!" unless LoraRb::Protocol.provider_is_valid?
+    raise "Connection protocol #{LoraRb.configuration.protocol} not supported by the provider #{LoraRb.configuration.provider}!" unless LoraRb::Protocol.supported?
+    require_relative "#{LoraRb.configuration.provider}/#{LoraRb.configuration.protocol}/call"
+    self.extend LoraRb::Call
+
     welcome_response = sub_initialize(options)
 
     raise("Lora-rb: Cannot connect to host #{options[:host]}:#{options[:port]}") unless welcome_response.key?('hello')

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

@@ -0,0 +1,187 @@
+# LoraRb calling methods
+module LoraRb
+  class EuiNotFound < StandardError; end
+  # It contains all the methods for selecting the items
+  module Call
+    attr_reader :client
+
+    private
+
+    def sub_initialize(options={})
+      require 'mqtt'
+
+      raise 'Specify uplink_url to continue!'             unless options[:uplink_url]
+      raise 'Specify downlink_url to continue!'           unless options[:downlink_url]
+      raise 'Specify downlink_response_urls to continue!' unless options[:downlink_response_urls]
+      raise 'Specify host to continue!'                   unless options[:host]
+      raise 'Specify port to continue!'                   unless options[:port]
+      raise 'Specify username to continue!'               unless options[:username]
+      raise 'Specify password to continue!'               unless options[:password]
+      raise 'Specify ssl_file to continue!'               if options[:ssl] && !options[:ssl_file]
+
+      @username = options[:username]
+      @client_id = "#{@username}::ssg#{generate_request_id}"
+
+      connection_attributes = {
+          host: options[:host],
+          port: options[:port],
+          ssl:  options[:ssl],
+          username: @username,
+          password: options[:password],
+          client_id: @client_id
+      }
+      connection_attributes[:cert_file] = options[:ssl_file] if connection_attributes[:ssl]
+      # The class variable @@mock is set by the stubbed class. The other methods (send_cmd etc.) are entirely stubbed.
+      @client = MQTT::Client.connect(connection_attributes) unless defined?(@@mock) && @@mock
+
+      @topic = merge_tags_to_url(options[:uplink_url],
+                                 { username: @username,
+                                   appid: @appid },
+                                 { debug: options[:debug] })
+
+      @downlink_url = options[:downlink_url]
+      @downlink_response_urls = options[:downlink_response_urls]
+      @enqueued_downlinks_url = options[:enqueued_downlinks_url]
+      @delete_enqueued_downlink_url = options[:delete_enqueued_downlink_url]
+      @timeout = options[:timeout]
+      @wait_response = options.has_key?(:wait_response) ? options[:wait_response] : true
+      {'hello' => 'Lora-Rb: Ready to start!'}
+    end
+
+    # Send the request to device
+    def sub_send_cmd(options={})
+      options = { wait_response: @wait_response }.merge(options)
+
+      request_id = generate_request_id
+      h_request = {
+          "fport": options[:port],              # Port where the message should be sent
+          "data": options[:data],               # Message payload
+          "confirmed": options[:confirmed],     # (Optional) Tells whether a confirmed downlink is requested. Default: false
+          "devEUI": options[:eui],
+          "reference": request_id
+      }
+
+      publish_url = merge_tags_to_url(@downlink_url,
+                                       username: @username,
+                                       appid: @appid,
+                                       deveui: options[:eui],
+                                       clientid: @client_id,
+                                       requestid: request_id)
+
+      puts "  publish #{h_request.to_json} to #{publish_url}" if options[:debug]
+      responses = []
+      response_topics = []
+      # thr_response = nil
+      if options[:wait_response]
+        @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,
+                                             appid: @appid,
+                                             deveui: options[:eui],
+                                             clientid: @client_id,
+                                             requestid: request_id)
+          puts "  Subscribing response #{response_topic}" if options[:debug] == :full
+          response_topics << response_topic
+        end
+
+        raise "cannot subscribe without topic, response_topics is empty!" if response_topics.empty?
+        @client.subscribe(*response_topics)
+      end
+
+      @client.publish(publish_url, h_request.to_json, false)
+
+      if options[:wait_response]
+        # Waiting for all the responses
+        # 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, debug: options[:debug])
+          response = { topic: response_topic, json: response_message }
+          puts "  Found response #{response} " if options[:debug] == :full
+          responses << response
+        end
+
+        @client.unsubscribe(*response_topics)
+      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.
+    # If topic is nil it uses subscribed topics
+    def sub_read_data(options={})
+      topic = options.has_key?(:topic) ? options[:topic] : @topic
+      if topic
+        topic = topic.dup
+        puts "  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? '[]'
+        eui = get_eui_from_topic(topic)
+        message['eui'] ||= eui if eui
+        port = get_port_from_topic(topic)
+        message['port'] ||= port if port
+      end
+      return topic, message
+    end
+
+    # Waiting for message in the queue
+    def sub_listen(options={}, &block)
+      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) do |topic, message|
+        # Block is executed for every message received
+        puts "  original json: #{topic}: #{message}" if options[:debug] == :full
+        message = JSON.parse(message)
+        if message.respond_to? '[]'
+          eui = get_eui_from_topic(topic)
+          message['eui'] ||= eui if eui
+          port = get_port_from_topic(topic)
+          message['port'] ||= port if port
+        end
+        puts "  #{message}" if options[:debug] #After reworking
+        block.call(topic, message) if block_given?
+        break if options[:test]
+      end
+    end
+
+    # Close the connection
+    def sub_quit
+      @client.disconnect
+    end
+
+    def get_eui_from_topic(topic)
+      res = topic&.match(/devices\/(\w{16})/)
+      res[1] if res
+    end
+
+    def get_port_from_topic(topic)
+      res = topic&.match(/uplink\/(\d+)(\/|\Z)/)
+      res[1] if res
+    end
+
+    def generate_request_id
+      "#{Time.now.strftime('%y%m%d%H%M%S')}#{SecureRandom.hex(1)}"
+    end
+
+  end
+end

data/lib/lora-rb/utility.rb

@@ -2,7 +2,6 @@
 module LoraRb
   # It contains generic methods
   module Base
-    private
 
     # Show tips on usage
     def merge_tags_to_url(url, tags={}, options={})
@@ -17,6 +16,8 @@ module LoraRb
     end
   end
 
+  private
+
   def puts(message)
     Kernel.puts "[#{self.class.name}##{__method__}] #{Time.now} #{message}"
   end

data/lib/version.rb

@@ -1,8 +1,8 @@
 module LoraRb
   def self.version
-    "0.14.1"
+    "0.15.0"
   end
   def self.updated_at
-    "2017-10-20"
+    "2017-11-01"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lora-rb
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Marco Mastrodonato
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2017-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -32,6 +32,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
@@ -39,6 +42,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
@@ -46,6 +52,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
@@ -53,6 +62,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
@@ -91,12 +103,13 @@ files:
 - lib/core/protocol.rb
 - lib/generators/install_generator.rb
 - lib/lora-rb.rb
+- lib/lora-rb/a2a/mqtt/call.rb
 - lib/lora-rb/base.rb
+- lib/lora-rb/fractalgarden/mqtt/call.rb
+- lib/lora-rb/fractalgarden/rabbitmq/call.rb
 - lib/lora-rb/help.rb
-- lib/lora-rb/http/call.rb
-- lib/lora-rb/mqtt/call.rb
-- lib/lora-rb/rabbitmq/call.rb
-- lib/lora-rb/tls/call.rb
+- lib/lora-rb/loriot/tls/call.rb
+- lib/lora-rb/resiot/http/call.rb
 - lib/lora-rb/utility.rb
 - lib/vendor/deep_symbolize.rb
 - lib/version.rb