lora-rb 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e741ccd715377f07a8ffbbb22fe91f833ccec4a
-  data.tar.gz: 4d02bcf8d4b566e6c182ed2f63cb6a99080a8cc2
+  metadata.gz: 213844df0c3f518068ec280585bcd4c3a8d6b5df
+  data.tar.gz: 6ab538fa6d2dfdccc730908be73c580793900894
 SHA512:
-  metadata.gz: c37b0380a04d8bc486e5269d4910c416564ab2c35b8838f35ff4d649cbf90661980a40c22ae16c4b8c0c7932ac92abee486058853e606a569e37e68bfe296423
-  data.tar.gz: 7d2d70038ada006a99eeefd2322905c756c4adb9f0b6e48160c104724263fdb0eea5a479127b9c2e758c6d1c8e00fcad2b1ae0011d894b85fb8f67bd406984c7
+  metadata.gz: f726dc55bed3ee0c18a15e62132216161aa55506a2eddaec0a0025c15c899016724d1fc8d000573f1090ac8f91ff5b28700f32f04d796287a0e3f561b104280c
+  data.tar.gz: b87fca2f73d4e4d5a5092bf197f4fcbaa83c2ee8f12c65537a9d472a97cb3ff8c91de8b8e000d270e840929ffa7373efde4290bec4718f1a44904b6f8bab6dad

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+v0.9.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.8.0..v0.9.0) August 7th, 2017
+------------------------------
+* Mqtt protocol renamed to Rabbitmq and new generic mqtt protocol added
+* Mqtt protocol now support tls
+* Now support the italian lora network A2a Smart City
+* Configuration params updated to meet the mqtt requirements
+* Updated readme
+
 v0.8.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.7.0..v0.8.0) July 11th, 2017
 ------------------------------
 * Send_cmd now accept param confirmed true/false

data/README.md

@@ -23,7 +23,94 @@ To use it in a bundle, add to gem file `gem 'lora-rb'` and run `bundle install`
 
 Establish a secure connection to your `Lora Application` on the cloud.
 
-This version only support the TLS protocol.
+This version supports:
+    1. TLS protocol with [Loriot](http://loriot.io)
+    1. Http push with [Resiot](http://resiot.io)
+    1. MQTT with [A2aSmartCity](http://www.a2asmartcity.io/)
+
+## Configuration
+
+Insert private information in the yaml:
+
+    lib/config/private.yml
+
+and the configuration's parameter in the config file.
+
+    lib/config/config.rb
+
+If you are using rails you can use the generator:
+
+    bundle exec rails generate lora_rb:install
+
+Every provider assign you a token and an appkey or an appid. Insert your secret data in the yaml:
+
+```yaml
+defaults:
+  appid:
+  token:
+  # Some provider may use it
+  username:
+  password:
+  connector_id:
+```
+
+If you are using Rails 5.1 you can do something like this:
+
+```yaml
+defaults: &defaults
+  appid: <%= Rails.application.secrets.lora_appid %>
+  token: <%= Rails.application.secrets.lora_token %>
+  # etc ...
+```
+
+### TLS (with Loriot)
+
+```ruby
+LoraRb.configure do |config|
+  # These informations are shared for all environments
+  config.protocol = :tls
+  config.host = 'eu1.loriot.io'
+  config.port = 737
+end
+```
+
+### HTTP (with Resiot)
+
+```ruby
+LoraRb.configure do |config|
+  # These informations are shared for all environments
+  config.protocol = :http
+  config.host = 'eu72.resiot.io'
+  config.port = 80
+end
+```
+
+### RABBITMQ
+
+```ruby
+LoraRb.configure do |config|
+  # These informations are shared for all environments
+  config.protocol = :rabbitmq
+  config.host = 'localhost'
+end
+```
+
+### MQTT (with A2a)
+
+```ruby
+LoraRb.configure do |config|
+  # These informations are shared for all environments
+  config.protocol = :mqtt
+  config.host = 'ptnetsuite.a2asmartcity.io'
+  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.ssl = true
+  config.ssl_file = 'ssl_certificates/mqtt_ca.crt'
+end
+```
+
+## Usage
 
 From irb require the library:
 
@@ -37,10 +124,10 @@ then create an instance
 lora = LoraClient.new
 ```
 
-if you are in debug mode you should also receive a json:
+you should receive the instance with variables depending on protocol:
 
-```json
-{ "hello":"LORIOT.io TLS Server", "version":"1.0.4" }
+```
+#<LoraClient:0x0056318ad8e048 ...
 ```
 
 ### Send data to a device
@@ -102,6 +189,9 @@ To use it in a bundle, add to gem file `gem 'lora-rb'` and run `bundle install`
 - [x] Organization in modules to support new protocols  `v0.2.0`
 - [x] Add a configuration `v0.3.0`
 - [x] Add a rails generator `v0.3.0`
+- [x] Add http push support `v0.5.0`
+- [x] Add RabbitMq support `v0.6.0`
+- [x] Add Mqtt support `v0.9.0`
 - [ ] Test with many devices
 
 ## Contributing

data/lib/config/config.rb

@@ -3,8 +3,15 @@ LoraRb.configure do |config|
   # config.protocol = :tls
   # config.host = 'eu1.loriot.io'
   # config.port = 737
-  # config.protocol = :mqtt
+  # config.protocol = :rabbitmq
   # config.host = 'localhost'
-  config.protocol = :http
-  config.host = 'eu72.resiot.io'
+  # config.protocol = :http
+  # config.host = 'eu72.resiot.io'
+  config.protocol = :mqtt
+  config.host = 'ptnetsuite.a2asmartcity.io'
+  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.ssl = true
+  config.ssl_file = 'ssl_certificates/mqtt_ca.crt'
 end

data/lib/config/private.yml

@@ -1,11 +1,19 @@
 defaults: &defaults
+  # Loriot
   #appid: "BE7A02C1"
-  appid: "a1b2c3d4e5f60001"
   #token: "zHcD-1ouz3ytyOLE6SMhwA"
-  token: "17e3ce759c444b3977f4adbf9dd0e010"
-  # Some provider may use it
-  connector_id: "69643d32"
-  test_eui: "BE7A00000000123C"
+  # Resiot
+  #appid: "a1b2c3d4e5f60001"
+  #token: "17e3ce759c444b3977f4adbf9dd0e010"
+  #connector_id: "69643d32"
+  # A2a
+  #appid: "a1b2c3d4e5f60001"
+  appid: "9955"
+  token: "2B7E151628AED2A6ABF7158809CF4F3C"
+  username: "fractalgarden"
+  password: "fr4ctalg4rden"
+
+  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/config/private_EXAMPLE.yml

@@ -3,6 +3,8 @@ defaults: &defaults
   appid:
   token:
   # Some provider may use it
+  username:
+  password:
   connector_id:
   # Insert your device for test purpose
   test_eui:

data/lib/core/base.rb

@@ -1,8 +1,6 @@
 require 'json'
 require 'socket'
 require 'openssl'
-require 'http'
-require 'bunny'
 
 require_relative 'configuration'
 require_relative 'configuration_dynamic'

data/lib/core/configuration.rb

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

data/lib/core/protocol.rb

@@ -5,7 +5,7 @@ module LoraRb
 
     # Show tips on usage
     def self.supported_protocols
-      %w(tls http mqtt)
+      %w(tls http rabbitmq mqtt)
     end
   end
 end

data/lib/generators/install_generator.rb

@@ -16,7 +16,7 @@ module LoraRb
           <<-FILE.gsub(/^            /, '')
             connection_protocol = LoraRb.configuration.protocol
             raise 'Define your protocol in the configuration file!' unless connection_protocol
-            raise "Connection protocol #{connection_protocol} not recognized!" unless %w(tls).include?(connection_protocol.to_s)
+            raise "Connection protocol #{connection_protocol} not recognized!" unless LoraRb::Protocol.supported_protocols.include?(connection_protocol.to_s)
             require "lora-rb/#{connection_protocol}/call"
             LoraClient.include LoraRb::Call
           

data/lib/lora-rb/base.rb

@@ -1,4 +1,5 @@
 require_relative 'help'
+require_relative 'utility'
 
 ###################################
 # An interface to Lora Service from Ruby
@@ -8,11 +9,16 @@ class LoraClient
 
   # Establish a secure connection to your account on the cloud
   def initialize(options = {})
-    options = { debug: false,
-                token: LoraRb::Settings.token,
-                appid: LoraRb::Settings.appid,
-                host: LoraRb.configuration.host,
-                port: LoraRb.configuration.port }.merge(options)
+    options = {debug: false,
+               token: LoraRb::Settings.token,
+               appid: LoraRb::Settings.appid,
+               host: LoraRb.configuration.host,
+               port: LoraRb.configuration.port,
+               uplink_url: LoraRb.configuration.uplink_url,
+               downlink_url: LoraRb.configuration.downlink_url,
+               ssl: LoraRb.configuration.ssl,
+               ssl_file: LoraRb.configuration.ssl_file
+                }.merge(options)
     @debug = options[:debug]
     @token = options[:token]
     @appid = options[:appid]
@@ -54,7 +60,7 @@ class LoraClient
   def listen(options = {}, &block)
     options = { debug: @debug }.merge(options)
 
-    puts "#{Time.now} Starting Listen #{@appid}. To exit press CTRL+C" if options[:debug]
+    puts "#{Time.now} Starting Listen app #{@appid}. To exit press CTRL+C" if options[:debug]
     sub_listen(options)
   end
 

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

@@ -6,6 +6,7 @@ module LoraRb
     private
 
     def sub_initialize(options={})
+      require 'http'
       @host = options[:host]
       {'hello' => 'Lora-Rb: Ready to start!'}
     end

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

@@ -8,48 +8,117 @@ module LoraRb
     private
 
     def sub_initialize(options={})
-      @connection = Bunny.new(hostname: options[:host])
-      @connection.start
-      @channel = @connection.create_channel
-      @queue = @channel.queue(options[:queue])
+      require 'mqtt'
+
+      raise 'Specify aaa to continue!' unless options[:uplink_url]
+      raise 'Specify aaa to continue!' unless options[:downlink_url]
+      raise 'Specify aaa to continue!' unless options[:host]
+      raise 'Specify aaa to continue!' unless options[:port]
+      raise 'Specify ssl_file to continue!' if options[:ssl] && !options[:ssl_file]
+
+      @username = LoraRb::Settings.username
+      password = LoraRb::Settings.password
+      @client_id = "#{@username}::ssg#{generate_request_id}"
+
+      @client = MQTT::Client.connect(
+          host: options[:host],
+          port: options[:port],
+          ssl:  options[:ssl],
+          cert_file: options[:ssl_file],
+          username: @username,
+          password: password,
+          client_id: @client_id
+      )
+
+      @topic = merge_tags_to_url(options[:uplink_url],
+                                 { username: @username,
+                                   appid: @appid },
+                                 { debug: options[:debug] })
+
+      @downlink_url = merge_tags_to_url(options[:downlink_url])
       {'hello' => 'Lora-Rb: Ready to start!'}
     end
 
     # Send the request to device
     def sub_send_cmd(options={})
-      str_request = "{\"cmd\":\"#{options[:cmd]}\",\"EUI\":\"#{options[:eui]}\",\"port\":#{options[:port]},\"confirmed\":#{options[:confirmed]},\"data\":\"#{options[:data]}\"} 	"
-      puts "#{Time.now} Cmq request: #{str_request}" if options[:debug]
-      response = @channel.default_exchange.publish(str_request, routing_key: @queue.name)
-      puts " [x] Sent '#{str_request}'" if options[:debug]
+      h_request = {
+        "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
+        "qos": options[:qos] || 1             # (Optional) Quality Of Service:
+                                              #     0 - Best effort. The message will be transmitted to the devices
+                                              #         of the group that satisfy the multicast profile requirements
+                                              #         (they should have been activated and have sent at least one
+                                              #         uplink, they should be class C devices, etc..).
+                                              #     1 - Transmission guaranteed. No message will be transmitted if
+                                              #         some devices do not satisfy the multicast profile requirements.
+                                              #         Default: 1 */
+      }
+      request_id = generate_request_id
+      publish_url = merge_tags_to_url(@downlink_url,
+                                       username: @username,
+                                       appid: @appid,
+                                       deveui: options[:eui],
+                                       clientid: @client_id,
+                                       requestid: request_id)
+
+      puts "#{Time.now} publish #{h_request.to_json} to #{publish_url}" if options[:debug]
+
+      response = @client.publish(publish_url, h_request.to_json, false)
+      puts " [x] publish response: #{response}" if options[:debug]
+
+      if options[:confirmed]
+        response_topic = "reply/#{@client_id}/id/#{request_id}"
+        puts " [x] Waiting response on #{response_topic} ..." if options[:debug]
+        response_topic, response = sub_read_data(topic: response_topic)
+        puts " [x] Topic response: #{response}" if options[:debug]
+      end
       response
     end
 
     # Receive the payload from the network
     def sub_read_data(options={})
-      delivery_info, metadata, payload = @queue.pop
-      puts " [x] Received #{delivery_info} #{metadata} #{payload}" if options[:debug]
+      topic = options[:topic] || @topic
+      puts " [x] Reading topic #{topic}..." if options[:debug]
+      topic, message = @client.get(topic)
+      message = JSON.parse(message)
+      message['EUI'] ||= get_eui_from_topic(topic) if message.respond_to? '[]'
+      puts " [x] #{topic}: #{message}" if options[:debug]
+      return topic, message
     end
 
     # Waiting for message in the queue
     def sub_listen(options={}, &block)
-      puts " [*] Waiting for messages in #{@queue.name}. To exit press CTRL+C" if options[:debug]
-      @queue.subscribe(block: true) do |delivery_info, properties, body|
-        puts " [x] Received #{body}" if options[:debug]
-        block.call(delivery_info, properties, body) if block
-        # cancel the consumer to exit
-        delivery_info.consumer.cancel
+      topic = options[:topic] || @topic
+      puts " [*] Waiting for messages in #{topic}. To exit press CTRL+C" if options[:debug]
+
+      @client.get(topic) do |topic, message|
+        # Block is executed for every message received
+        puts " [x] #{topic}: #{message}" if options[:debug]
+        message = JSON.parse(message)
+        message['EUI'] ||= get_eui_from_topic(topic) if message.respond_to? '[]'
+        puts " [x] after rework: #{message}" if options[:debug]
+        block.call(topic, message) if block
+        break if options[:test]
       end
     end
 
     # Close the connection
     def sub_quit
-      @connection.close
+      @client.disconnect
     end
 
-  end
-end
+    private
+
+    def get_eui_from_topic(topic)
+      topic&.match(/(?!devices\/)\w{16}/)&.to_s
+    end
+
+    def generate_request_id
+      Time.now.strftime('%y%m%d%H%M%S')
+    end
 
-# Monkey patch since Bunny use the rails method .empty?
-class NilClass
-  def empty?; true end
+  end
 end

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

@@ -0,0 +1,57 @@
+# LoraRb calling methods
+module LoraRb
+  # It contains all the methods for selecting the items
+  module Call
+
+    attr_reader :client
+
+    private
+
+    def sub_initialize(options={})
+      require 'bunny'
+      @connection = Bunny.new(hostname: options[:host])
+      @connection.start
+      @channel = @connection.create_channel
+      @queue = @channel.queue(options[:queue])
+      {'hello' => 'Lora-Rb: Ready to start!'}
+    end
+
+    # Send the request to device
+    def sub_send_cmd(options={})
+      str_request = "{\"cmd\":\"#{options[:cmd]}\",\"EUI\":\"#{options[:eui]}\",\"port\":#{options[:port]},\"confirmed\":#{options[:confirmed]},\"data\":\"#{options[:data]}\"} 	"
+      puts "#{Time.now} Cmq request: #{str_request}" if options[:debug]
+      response = @channel.default_exchange.publish(str_request, routing_key: @queue.name)
+      puts " [x] Sent '#{str_request}'" if options[:debug]
+      response
+    end
+
+    # Receive the payload from the network
+    def sub_read_data(options={})
+      delivery_info, metadata, payload = @queue.pop
+      puts " [x] Received #{delivery_info} #{metadata} #{payload}" if options[:debug]
+      return delivery_info, metadata, payload
+    end
+
+    # Waiting for message in the queue
+    def sub_listen(options={}, &block)
+      puts " [*] Waiting for messages in #{@queue.name}. To exit press CTRL+C" if options[:debug]
+      @queue.subscribe(block: true) do |delivery_info, properties, body|
+        puts " [x] Received #{body}" if options[:debug]
+        block.call(delivery_info, properties, body) if block
+        # cancel the consumer to exit
+        delivery_info.consumer.cancel
+      end
+    end
+
+    # Close the connection
+    def sub_quit
+      @connection.close
+    end
+
+  end
+end
+
+# Monkey patch since Bunny use the rails method .empty?
+class NilClass
+  def empty?; true end
+end

data/lib/lora-rb/utility.rb

@@ -0,0 +1,18 @@
+# LoraRb methods
+module LoraRb
+  # It contains generic methods
+  module Base
+    private
+
+    # Show tips on usage
+    def merge_tags_to_url(url, tags={}, options={})
+      puts "merge_tags_to_url: #{url}" if options[:debug]
+      tags.each do |tag, value|
+        puts " replace {#{tag}} with #{value}" if options[:debug]
+        url.gsub!("{#{tag}}", value.to_s)
+      end
+      puts "merge_tags_to_url: completed #{url}" if options[:debug]
+      url
+    end
+  end
+end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module LoraRb
   def self.version
-    "0.8.0"
+    "0.9.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lora-rb
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Marco Mastrodonato
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -26,48 +26,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: openssl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: bunny
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +66,9 @@ files:
 - 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/utility.rb
 - lib/vendor/deep_symbolize.rb
 - lib/version.rb
 homepage: https://github.com/marcomd/lora-rb