mqttopia 0.1.9 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dcdb52227984d43667ef297e1740a96329a28931140f2c2760a6446cf5ee31a
-  data.tar.gz: 8d1ba1e116657ae18027c2686599476b859600de42fec69c1e938f23a6c89f05
+  metadata.gz: 22fd456b89816f0c1a408aa91ce87314f871501013eab946a19a48d7c3ddbffd
+  data.tar.gz: 1880d0c512433ddb69fa7fced3f1c191355346a2e66a5dd4c2e23be4d91d7497
 SHA512:
-  metadata.gz: b8ae4365a041299e9e4e4e2e43c75cdb4ca5cf8406fc451e0e95a47ccc834ccf21998c76f909c8bb924922588b0eaecedaaa7689ba9ad8881b3d8d3fa0ff6823
-  data.tar.gz: 2bd8bef90f21419e6fdf594eb4c81ad920bb11eac3bbfd74c081280b9d0e866bb32802cda0b90f0b71804521127195af9e6b0e0ca36035093c917e6fd6b7fef6
+  metadata.gz: 9f575cbc7790b82d2e675a9fd9358dc6fe80cdbb7152375e04f742b4f9a1703f710ecb40fb79040a38684fb161e5f4d437473a25b326e77342caf21cccfe8fa1
+  data.tar.gz: ee39f5c542c8c399295d4802ab4c17334d3ea513d010c844bc7014061de550c58dc542f6e2c0ce9bef9a95aa94d93313cec2a88f7b14834dcc7c491dae91dd79

data/.rubocop.yml

@@ -37,3 +37,5 @@ Lint/MissingSuper:
   Enabled: false
 Lint/RescueException:
   Enabled: false
+Style/RedundantFetchBlock:
+  Enabled: false

data/MQTT_SUBSCRIPTIONS.md

@@ -11,24 +11,25 @@ This subscription handles trip metrics and serializes the data related to trips,
 ### **Payload Structure:**
 ```json
 {
-  "trip_id": 123,
-  "metrics": {
-    "locPerms": 0,
-    "connt": "wf",
-    "batt": { "l": 100, "cs": "charging" },
-    "battPwOp": 0,
-    "pws": 0,
-    "notf": 1,
-    "gps": 1,
-    "nlog": 500,
-    "loc": {
-      "lat": 29.9585182,
-      "lon": 31.0423193,
-      "acc": 20,
-      "alt": 150.5,
-      "ts": 1729074275127 // unix timestamp
-    },
-    "ts": 1729074279737 // unix timestamp
+  "tid": "101",
+  "ts": 1729504252695,
+  "batt": {
+    "l": 100,
+    "cs": "2"
+  },
+  "connt": "wf",
+  "pws": -1,
+  "gps": -1,
+  "nlog": 585,
+  "battPwOp": -1,
+  "locPerms": 0,
+  "notf": -1,
+  "loc": {
+    "lat": 29.97577349165706,
+    "lon": 31.097835359438037,
+    "acc": 3.6214938163757324,
+    "alt": 0,
+    "ts": 1729504252310
   }
 }
 ```
@@ -42,12 +43,12 @@ This subscription handles trip metrics and serializes the data related to trips,
     connection_type: "wf",
     battery: {
       battery_level: 100,
-      charging_statuc: "charging",
-      opmization_status: 0,
-      power_saving_mode: 0
+      charging_status: "UNKNOWN",
+      optimization_status: false,
+      power_saving_mode: false
     },
-    notification_permission: 1,
-    gps: 1,
+    notification_permission: false,
+    gps: false,
     location: {
       latitude: 29.9585182,
       longitude: 31.0423193,
@@ -63,10 +64,45 @@ This subscription handles trip metrics and serializes the data related to trips,
 
 ---
 
-### **Date Types:**
+### **Date Types and mapping:**
 
 - To decode a unix timestamp use the following link [epoch_converter](https://www.epochconverter.com/)
-
+- **optimization_status**, **power_saving_mode**, **notification_permission**
+  ```json
+    {
+      "0": true,
+      "-1": false
+    }
+  ```
+- **location_permission**
+  ```json
+  {
+    "0": "BACKGROUND_FINE",
+    "-1": "BACKGROUND_COARSE",
+    "-2": "FOREGROUND_FINE",
+    "-3": "FOREGROUND_COARSE",
+    "-4": "DISABLED"
+  }
+  ```
+- **connection_type**
+  ```json
+  {
+    "wf": "WIFI",
+    "cel": "CELLULAR",
+    "et": "ETHERNET",
+    "nc": "NO_CONNECTION",
+    "uk": "UNKNOWN"
+  }
+  ```
+- **charging_status**
+  ```json
+    {
+      "0": "UNKNOWN",
+      "1": "DISCHARGING",
+      "2": "CHARGING",
+      "3": "FULL"
+    }
+  ```
 ---
 
 ### **Usage Example:**
@@ -76,24 +112,25 @@ $client.subscribe('illa/trips/20/trip_metric/send/user/20') do |response|
 end
 
 payload = {
-  "trip_id": 123,
-  "metrics": {
-    "locPerms": 0,
-    "connt": "wf",
-    "batt": { "l": 100, "cs": "charging" },
-    "battPwOp": 0,
-    "pws": 0,
-    "notf": 1,
-    "gps": 1,
-    "nlog": 500,
-    "loc": {
-      "lat": 29.9585182,
-      "lon": 31.0423193,
-      "acc": 20,
-      "alt": 150.5,
-      "ts": 1729074275127
-    },
-    "ts": 1729074279737
+  "tid": "101",
+  "ts": 1729504252695,
+  "batt": {
+    "l": 100,
+    "cs": "2"
+  },
+  "connt": "wf",
+  "pws": -1,
+  "gps": -1,
+  "nlog": 585,
+  "battPwOp": -1,
+  "locPerms": 0,
+  "notf": -1,
+  "loc": {
+    "lat": 29.97577349165706,
+    "lon": 31.097835359438037,
+    "acc": 3.6214938163757324,
+    "alt": 0,
+    "ts": 1729504252310
   }
 }
 $client.publish('illa/trips/20/trip_metric/send/user/20', payload)

data/lib/mqttopia/client.rb

@@ -8,7 +8,7 @@ require_relative "subscriptions/redirect"
 module Mqttopia
   class Client
     @instance = nil
-    attr_reader :mqtt_client, :debugging
+    attr_reader :mqtt_client, :debugging, :debugging_topic
 
     def self.instance
       @instance ||= new
@@ -31,6 +31,7 @@ module Mqttopia
         ack_timeout: 5
       )
       @debugging = Mqttopia.debugging
+      @debugging_topic = "mqttopia/test/debugging"
     rescue Exception => e
       log_error("initialize", e)
     end
@@ -45,18 +46,24 @@ module Mqttopia
       disconnect_and_log("connect", e)
     end
 
-    def publish(topic, message = nil, qos = 0)
-      return unless ensure_connection
+    def self.publish(topic, message = nil, qos = 0)
+      client = new
+      client.connect
 
       # publish(topic, payload = '', retain = false, qos = 0)
-      mqtt_client.publish(topic, message, false, qos)
-      log_debug("Sent message on topic #{topic}: #{message} with QOS #{qos}")
+      client.mqtt_client.publish(topic, message, false, qos)
+      client.disconnect
+
+      Mqttopia::Logger.debug("\n#{message}\n") if client.debugging
+      true
     rescue Exception => e
-      disconnect_and_log("publish", e)
+      Mqttopia::Logger.error("\nMqttopia::Client -> publish: #{e}\n")
+      false
     end
 
     def subscribe(topic, qos = 0, &block)
       return unless ensure_connection
+      raise StandardError, "Blocked Topic" if [debugging_topic].include?(topic)
 
       mqtt_client.subscribe(topic => qos)
       create_subscription_thread(qos, &block)
@@ -68,6 +75,10 @@ module Mqttopia
       mqtt_client.disconnect if connected?
     end
 
+    def ready_to_connect?
+      !active_host.nil?
+    end
+
     private
 
     def active_host(hosts = Mqttopia.hosts, port = Mqttopia.port, timeout = 10)
@@ -82,13 +93,20 @@ module Mqttopia
       nil # Return nil if no reachable host is found
     end
 
-    def create_subscription_thread(qos, &block)
+    def create_subscription_thread(qos)
       Thread.new do
         mqtt_client.get do |topic, message|
           log_debug("Received RAW message on topic #{topic}: #{message} with QOS #{qos}")
 
           response = safe_mqtt_response(topic, message)
-          block.call(response) if response
+
+          if debugging && topic.exclude?(debugging_topic)
+            publish(debugging_topic,
+                    { 'topic_name': topic,
+                      'mqttopia_response': response }, 2)
+          end
+
+          yield response if response
         end
       end
     end
@@ -99,7 +117,7 @@ module Mqttopia
         payload: parse_json(raw_payload)
       ).call
     rescue Exception => e
-      log_error("safe_mqtt_response", e)
+      log_error("safe_mqtt_response", e) if debugging
       nil
     end
 

data/lib/mqttopia/serializers/test_debug.rb

@@ -9,9 +9,13 @@ module Mqttopia
         {
           topic_name: body[:topic_name],
           payload: body[:payload],
-          received_at: DateTime.now.strftime("%Q")&.to_s
+          received_at: current_timestamp
         }
       end
+
+      def current_timestamp
+        DateTime.now.strftime("%Q")
+      end
     end
   end
 end

data/lib/mqttopia/serializers/trip_metric.rb

@@ -5,53 +5,89 @@ module Mqttopia
     module TripMetric
       module_function
 
+      KEYS = %i[ts locPerms connt batt battPwOp pws notf gps nlog loc].freeze
+
       def serialize(body)
+        return unless valid_metric?(body[:metrics])
+
         {
           trip_id: body[:trip_id],
-          metrics: body[:metrics] && metric_serialize(body[:metrics]),
-          logged_at: body[:metrics] && body[:metrics][:ts]&.to_s,
-          received_at: DateTime.now.strftime("%Q")&.to_s
+          metrics: serialize_metrics(body[:metrics]),
+          logged_at: body.dig(:metrics, :ts)&.to_s,
+          received_at: current_timestamp
+        }
+      end
+
+      def serialize_metrics(metrics)
+        {
+          location_permission: location_permission_mapper(metrics[:locPerms]),
+          connection_type: connection_type_mapper(metrics[:connt]),
+          battery: serialize_battery(metrics[:batt], metrics[:battPwOp], metrics[:pws]),
+          notification_permission: metrics[:notf]&.zero?,
+          gps: metrics[:gps]&.zero?,
+          number_of_trip_logs: metrics[:nlog],
+          location: serialize_location(metrics[:loc])
         }
       end
 
-      def metric_serialize(metric)
+      def serialize_battery(battery, optimization_status, power_saving_mode)
+        return unless battery
+
+        {
+          battery_level: battery[:l],
+          charging_status: charging_status_mapper(battery[:cs]),
+          optimization_status: optimization_status&.zero?,
+          power_saving_mode: power_saving_mode&.zero?
+        }
+      end
+
+      def serialize_location(location)
+        return unless location
+
         {
-          location_permission: location_permission_mapper(metric[:locPerms]),
-          connection_type: metric[:connt],
-          battery: {
-            battery_level: metric[:batt] && metric[:batt][:l],
-            charging_statuc: metric[:batt] && metric[:batt][:cs],
-            opmization_status: metric[:battPwOp],
-            power_saving_mode: metric[:pws]
-          },
-          notification_permission: metric[:notf],
-          gps: metric[:gps],
-          number_of_trip_logs: metric[:nlog],
-          location: metric[:loc] && {
-            latitude: metric[:loc][:lat],
-            longitude: metric[:loc][:lon],
-            accuracy: metric[:loc][:acc],
-            altitude: metric[:loc][:alt],
-            logged_at: metric[:loc][:ts]&.to_s
-          }
+          latitude: location[:lat],
+          longitude: location[:lon],
+          accuracy: location[:acc],
+          altitude: location[:alt],
+          logged_at: location[:ts]&.to_s
         }
       end
 
-      def location_permission_mapper(location_permission)
-        case location_permission
-        when 0
-          "BACKGROUND_FINE"
-        when -1
-          "BACKGROUND_COARSE"
-        when -2
-          "FOREGROUND_FINE"
-        when -3
-          "FOREGROUND_COARSE"
-        when -4
-          "DISABLED"
-        else
-          "UNKNOWN"
-        end
+      def location_permission_mapper(permission)
+        {
+          "0" => "BACKGROUND_FINE",
+          "-1" => "BACKGROUND_COARSE",
+          "-2" => "FOREGROUND_FINE",
+          "-3" => "FOREGROUND_COARSE",
+          "-4" => "DISABLED"
+        }.fetch(permission&.to_s) { "UNKNOWN" }
+      end
+
+      def connection_type_mapper(connection_type)
+        {
+          "wf" => "WIFI",
+          "cel" => "CELLULAR",
+          "et" => "ETHERNET",
+          "nc" => "NO_CONNECTION",
+          "uk" => "UNKNOWN"
+        }.fetch(connection_type) { "UNKNOWN" }
+      end
+
+      def charging_status_mapper(charging_status)
+        {
+          "0" => "UNKNOWN",
+          "1" => "DISCHARGING",
+          "2" => "CHARGING",
+          "3" => "FULL"
+        }.fetch(charging_status&.to_s) { "UNKNOWN" }
+      end
+
+      def valid_metric?(metrics)
+        metrics.is_a?(Hash) && KEYS.all? { |key| metrics.key?(key) }
+      end
+
+      def current_timestamp
+        DateTime.now.strftime("%Q")
       end
     end
   end

data/lib/mqttopia/subscriptions/services/trip_metrics.rb

@@ -16,6 +16,7 @@ module Mqttopia
 
         validates :trip_id, presence: true, numericality: { only_integer: true, greater_than: 0 }
         validates :metrics, presence: true
+        # validate :metric_json_format
 
         def initialize(trip_id:, metrics:, options: {})
           @trip_id = trip_id

data/lib/mqttopia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mqttopia
-  VERSION = "0.1.9"
+  VERSION = "0.1.18"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqttopia
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.18
 platform: ruby
 authors:
 - Illa Tech
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-24 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel