mqttopia 0.1.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6dcdb52227984d43667ef297e1740a96329a28931140f2c2760a6446cf5ee31a
+  data.tar.gz: 8d1ba1e116657ae18027c2686599476b859600de42fec69c1e938f23a6c89f05
+SHA512:
+  metadata.gz: b8ae4365a041299e9e4e4e2e43c75cdb4ca5cf8406fc451e0e95a47ccc834ccf21998c76f909c8bb924922588b0eaecedaaa7689ba9ad8881b3d8d3fa0ff6823
+  data.tar.gz: 2bd8bef90f21419e6fdf594eb4c81ad920bb11eac3bbfd74c081280b9d0e866bb32802cda0b90f0b71804521127195af9e6b0e0ca36035093c917e6fd6b7fef6

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+    TargetRubyVersion: 2.7
+    Include:
+        - 'app/**/*.rb'
+        - 'lib/**/*.rb'
+    Exclude:
+        - 'bin/**/*'
+        - 'test/**/*'
+
+Bundler:
+  Severity: error
+Gemspec:
+  Severity: error
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+Metrics/ClassLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 30
+Metrics/AbcSize:
+  Enabled: false
+Lint/MissingSuper:
+  Enabled: false
+Lint/RescueException:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-22
+
+- Initial release

data/MQTT_SUBSCRIPTIONS.md

@@ -0,0 +1,135 @@
+
+# MQTT Subscriptions
+
+## 1. **`trip_metrics` Subscription**
+
+This subscription handles trip metrics and serializes the data related to trips, such as GPS location, battery status, and connection types.
+
+### **Purpose:**
+- To monitor the metrics of a trip in real-time, including the trip's ID, GPS data, battery level, location permissions, and notification permissions.
+
+### **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
+  }
+}
+```
+
+### **Serialized Output:**
+```ruby
+{
+  trip_id: 123,
+  metrics: {
+    location_permission: "BACKGROUND_FINE",
+    connection_type: "wf",
+    battery: {
+      battery_level: 100,
+      charging_statuc: "charging",
+      opmization_status: 0,
+      power_saving_mode: 0
+    },
+    notification_permission: 1,
+    gps: 1,
+    location: {
+      latitude: 29.9585182,
+      longitude: 31.0423193,
+      accuracy: 20,
+      altitude: 150.5,
+      logged_at: 1729074275127 # unix timestamp
+    }
+  },
+  logged_at: 1729074275127, # unix timestamp
+  received_at: 1729074275127 # unix timestamp
+}
+```
+
+---
+
+### **Date Types:**
+
+- To decode a unix timestamp use the following link [epoch_converter](https://www.epochconverter.com/)
+
+---
+
+### **Usage Example:**
+```ruby
+$client.subscribe('illa/trips/20/trip_metric/send/user/20') do |response|
+  puts "Received trip metrics: #{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
+  }
+}
+$client.publish('illa/trips/20/trip_metric/send/user/20', payload)
+```
+
+---
+
+## 2. **`test_debug` Subscription**
+
+The `test_debug` subscription is used for testing and debugging purposes, capturing payloads sent on specific MQTT topics.
+
+### **Purpose:**
+- To log and serialize MQTT messages for debugging purposes, capturing both the topic name and payload.
+
+### **Payload Structure:**
+```json
+{
+  "topic_name": "test/topic",
+  "payload": { "message": "Hello, MQTT" }
+}
+```
+
+### **Serialized Output:**
+```ruby
+{
+  topic_name: "test/topic",
+  payload: { message: "Hello, MQTT" },
+  received_at: 1729074275127 # unix timestamp
+}
+```
+
+### **Usage Example:**
+```ruby
+$client.subscribe('test/#') do |response|
+  puts "Received debug message: #{response}"
+end
+
+$client.publish('test/topic', 'Hello, MQTT')
+```

data/README.md

@@ -0,0 +1,142 @@
+
+# Mqttopia
+
+Mqttopia is a Ruby-based project designed to facilitate interactions with MQTT protocols. It provides a modular architecture for handling MQTT clients, subscriptions, and data serialization, making it easier to integrate MQTT into your applications.
+
+---
+
+## **Features**
+
+- Configurable MQTT client with options for hosts, port, SSL, and authentication.
+- Subscription handling for dynamic topics.
+- Data serialization modules to standardize payloads.
+- Custom Rake tasks for initializing configuration files.
+
+---
+
+## **Installation**
+
+### Bundler
+
+```ruby
+gem 'mqttopia', '~> 0.1.0'
+```
+
+### Manual
+
+```sh
+gem install mqttopia
+```
+
+---
+
+## **Usage**
+
+### Configuring Mqttopia
+
+You can create or update the `mqttopia.rb` file using the included Rake task:
+
+```bash
+bundle exec rails generate mqttopia:install
+```
+
+The generated `mqttopia.rb` will contain:
+
+```ruby
+Mqttopia.configure do |config|
+  config.hosts = ["localhost"]
+  config.port = 1883
+  config.username = "user"
+  config.password = "xxxx"
+  config.ssl = true
+end
+```
+
+### Example: Subscribing and Publishing Messages
+
+```ruby
+client = Mqttopia::Client.instance
+
+# Subscribe to a topic
+client.subscribe('test/#') do |response|
+  puts "Received: #{response}"
+end
+
+# Publish a message to a topic
+client.publish('test/topic', 'Hello, MQTT')
+```
+
+### MQTT subscriptions
+
+- [MQTT subscriptions](https://github.com/go-illa/mqttopia/blob/master/MQTT_SUBSCRIPTIONS.md)
+
+---
+
+## **Topic Name Structure**
+
+- **send data** : `illa/{entity}/{entity_id}/{operation}/send/user/{user_id}`
+- **ask data** : `illa/{entity}/{entity_id}/{operation}/ask/user/{user_id}`
+- **operation** : `trip_metrics`, `test_debug`, ..etc.
+- **entity**: `trips`
+- `user/{user_id}` is optional
+
+---
+
+## **Rake Tasks**
+
+### Available Tasks
+
+- **Initialize Configuration File:**
+
+  Creates `mqttopia_initialize.rb` with default configurations.
+
+  ```bash
+  bundle exec rake mqttopia:initialize
+  ```
+
+---
+
+## **Project Structure**
+
+```
+mqttopia/
+├── lib/
+│   ├── mqttopia/               # Modules for mqttopia gem
+│   |   ├── helpers/            # Helper Modules
+│   |   ├── serializers/        # Modules for payload serialization
+│   |   ├── subscriptions/      # MQTT Topics's events and services
+│   |   └── topics/             # MQTT Topic constants [name, regex, service, serializer]
+│   |── tasks/                  # Rake tasks
+│   ├── mqttopia.rb             # Main entry point for the gem
+│   ├── client.rb               # MQTT client implementation
+│   └── logger.rb               # Logging setup
+└── test/                       # Minitest-based test suite
+```
+
+---
+
+## **Contributing**
+
+1. Fork the repository.
+2. Create a feature branch: `git checkout -b feature-branch-name`
+3. Commit your changes: `git commit -m "Add new feature"`
+4. Push the branch: `git push origin feature-branch-name`
+5. Open a Pull Request.
+
+---
+
+## **License**
+
+This project is licensed under the MIT License. See the `LICENSE` file for more information.
+
+---
+
+## **Contact**
+
+If you have any questions or need further assistance, feel free to open an issue or contact the maintainer.
+
+---
+
+## **Acknowledgements**
+
+Special thanks to all contributors and users who have made this project possible.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']  # Make sure all test files are loaded
+  # t.verbose = true  # This will give more output during the test run
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/TEST_README.md

@@ -0,0 +1,57 @@
+# TEST
+
+## Installation
+
+```sh
+gem install mqttopia
+```
+
+## Testing `test_mqttopia.rb`
+
+1. create a new `test_mqttopia.rb` file
+```sh
+	touch test_mqttopia.rb
+```
+
+2. file structure and testing scenarios
+```ruby
+# test_mqttopia.rb
+
+# Require the gem's main file
+require 'mqttopia'
+
+# Initialize Mqttopia, using your mqtt server credentials
+Mqttopia.configure do |config|
+  config.hosts = ["localhost"]
+  config.port = 1883
+  config.username = 'user'
+  config.password = 'xxxx'
+  config.ssl = true
+  config.debugging = true
+end
+
+begin
+  # Create a client instance (connect to mqtt server)
+  client = Mqttopia::Client.instance
+
+  # Subscribe to a topic and print received messages
+  client.subscribe('test/#') do |response|
+    puts "Received PROCESSED message: #{response}"
+  end
+rescue StandardError => e
+  puts "MQTT CLIENT #{e}"
+end
+
+# Publish a message to the topic
+client.publish('test/topic', 'Hello, MQTT')
+
+puts 'Listening for new MQTT messages. Press Ctrl+C to exit.'
+
+# Keep the script alive to listen indefinitely
+sleep
+```
+
+3. Run the file
+```sh
+	ruby test_mqttopia.rb
+```

data/lib/generators/mqttopia/install_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Mqttopia
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Creates a Mqttopia initializer file for configuration."
+
+      # Method to generate the initializer
+      def copy_initializer
+        template "mqttopia_initializer.rb", "config/initializers/mqttopia.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/mqttopia_initializer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# config/initializers/mqttopia.rb
+
+Mqttopia.configure do |config|
+  # Set the MQTT hosts
+  config.hosts = ["localhost"]
+
+  # Set the MQTT port
+  config.port = 1883
+
+  # Set the MQTT username
+  config.username = "user"
+
+  # Set the MQTT password
+  config.password = "xxxx"
+
+  # Set the MQTT ssl
+  config.ssl = true
+
+  # Set the MQTT debugging mode
+  # config.debugging = true
+
+  # Set the logger (defaults to STDOUT)
+  # config.logger = Logger.new(STDOUT)
+end

data/lib/mqttopia/client.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "mqtt"
+require "json"
+require "socket"
+require_relative "subscriptions/redirect"
+
+module Mqttopia
+  class Client
+    @instance = nil
+    attr_reader :mqtt_client, :debugging
+
+    def self.instance
+      @instance ||= new
+    end
+
+    private_class_method :new
+
+    def initialize(
+      username: Mqttopia.username,
+      password: Mqttopia.password,
+      port: Mqttopia.port,
+      ssl: Mqttopia.ssl
+    )
+      @mqtt_client = MQTT::Client.new(
+        port: port,
+        username: username,
+        password: password,
+        ssl: ssl,
+        keep_alive: 15,
+        ack_timeout: 5
+      )
+      @debugging = Mqttopia.debugging
+    rescue Exception => e
+      log_error("initialize", e)
+    end
+
+    def connect
+      host = active_host(Mqttopia.hosts)
+      raise ArgumentError, "No hosts available" if host.nil?
+
+      mqtt_client.host = host
+      mqtt_client.connect
+    rescue Exception => e
+      disconnect_and_log("connect", e)
+    end
+
+    def publish(topic, message = nil, qos = 0)
+      return unless ensure_connection
+
+      # 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}")
+    rescue Exception => e
+      disconnect_and_log("publish", e)
+    end
+
+    def subscribe(topic, qos = 0, &block)
+      return unless ensure_connection
+
+      mqtt_client.subscribe(topic => qos)
+      create_subscription_thread(qos, &block)
+    rescue Exception => e
+      disconnect_and_log("subscribe", e)
+    end
+
+    def disconnect
+      mqtt_client.disconnect if connected?
+    end
+
+    private
+
+    def active_host(hosts = Mqttopia.hosts, port = Mqttopia.port, timeout = 10)
+      hosts.each do |host|
+        Socket.tcp(host, port, connect_timeout: timeout) do |sock|
+          sock.close
+          return host # Return the first reachable host
+        end
+      rescue SocketError, Errno::ECONNREFUSED, Errno::ETIMEDOUT, IOError
+        next # Ignore unreachable hosts and continue checking
+      end
+      nil # Return nil if no reachable host is found
+    end
+
+    def create_subscription_thread(qos, &block)
+      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
+        end
+      end
+    end
+
+    def safe_mqtt_response(topic_name, raw_payload)
+      Mqttopia::Subscriptions::Redirect.new(
+        topic_name: topic_name,
+        payload: parse_json(raw_payload)
+      ).call
+    rescue Exception => e
+      log_error("safe_mqtt_response", e)
+      nil
+    end
+
+    def parse_json(payload)
+      JSON.parse(payload, symbolize_names: true)
+    rescue JSON::ParserError
+      payload
+    end
+
+    def ensure_connection
+      connected? || connect || connected?
+    end
+
+    def connected?
+      mqtt_client.connected?
+    end
+
+    def log_error(method, error)
+      Mqttopia::Logger.error("\nMqttopia::Client -> #{method}: #{error_details(error)}\n")
+    end
+
+    def log_debug(message)
+      Mqttopia::Logger.debug("\n#{message}\n") if debugging
+    end
+
+    def disconnect_and_log(method, error)
+      disconnect
+      log_error(method, error)
+    end
+
+    def error_details(error)
+      {
+        type: error.class.name&.gsub("Mqttopia::Subscriptions::Services::", ""),
+        message: error.message
+      }
+    end
+  end
+end

data/lib/mqttopia/helpers/data_extractor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Mqttopia
+  module Helpers
+    module DataExtractor
+      def extract_trip_id(topic_name)
+        return unless topic_name.include?("trips/")
+
+        match_data = topic_name.match(%r{trips/([^/]*)})
+
+        match_data && !match_data[1].empty? ? match_data[1] : nil
+      end
+
+      def extract_user_id(topic_name)
+        return unless topic_name.include?("user/")
+
+        match_data = topic_name.match(%r{user/([^/]*)})
+
+        match_data && !match_data[1].empty? ? match_data[1] : nil
+      end
+    end
+  end
+end

data/lib/mqttopia/logger.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/delegation" # Require ActiveSupport's delegation
+
+module Mqttopia
+  class Logger
+    class << self
+      # Initialize the logger
+      def logger
+        @logger ||= Mqttopia.logger # Default to logging to STDOUT
+      end
+
+      # Allow users to set a custom logger (e.g., logging to a file)
+      attr_writer :logger
+
+      # Simple wrapper for logging debug messages
+      delegate :debug, to: :logger
+
+      # Wrapper for logging info messages
+      delegate :info, to: :logger
+
+      # Wrapper for logging warn messages
+      delegate :warn, to: :logger
+
+      # Wrapper for logging error messages
+      delegate :error, to: :logger
+    end
+  end
+end

data/lib/mqttopia/serializers/test_debug.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mqttopia
+  module Serializers
+    module TestDebug
+      module_function
+
+      def serialize(body)
+        {
+          topic_name: body[:topic_name],
+          payload: body[:payload],
+          received_at: DateTime.now.strftime("%Q")&.to_s
+        }
+      end
+    end
+  end
+end

data/lib/mqttopia/serializers/trip_metric.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Mqttopia
+  module Serializers
+    module TripMetric
+      module_function
+
+      def serialize(body)
+        {
+          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
+        }
+      end
+
+      def metric_serialize(metric)
+        {
+          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
+          }
+        }
+      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
+      end
+    end
+  end
+end

data/lib/mqttopia/subscriptions/redirect.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "services/trip_metrics"
+require_relative "services/test_debug"
+require_relative "../topics/services"
+
+module Mqttopia
+  module Subscriptions
+    class Redirect
+      attr_reader :topic_name, :payload, :debugging
+
+      def initialize(topic_name:, payload:)
+        @topic_name = topic_name
+        @payload = payload
+        @debugging = Mqttopia.debugging
+      end
+
+      def call
+        Mqttopia::Topics::Services::KEYS.each_value do |value|
+          next unless topic_name.match(value[:regex])
+
+          return value[:service].safe_constantize.call(
+            topic_name,
+            payload,
+            { serializer: value[:serializer] }
+          )
+        end
+
+        Mqttopia::Logger.warn "No matching topic found for #{topic_name}" if debugging
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mqttopia
+  module Subscriptions
+    module Services
+      class Base
+        include ActiveModel::Validations
+        extend Mqttopia::Helpers::DataExtractor
+
+        def self.call(topic, payload, _options = {})
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "active_model"
+require_relative "../../serializers/test_debug"
+require_relative "./base"
+
+module Mqttopia
+  module Subscriptions
+    module Services
+      class TestDebug < Mqttopia::Subscriptions::Services::Base
+        class TestDebugInvalidError < ArgumentError
+        end
+
+        attr_reader :topic_name, :payload, :options
+
+        validates :topic_name, presence: true
+        validates :payload, presence: true
+
+        def initialize(topic_name:, payload:, options: {})
+          @topic_name = topic_name
+          @payload = payload
+          @options = options
+        end
+
+        def self.call(topic, payload, options = {})
+          new(topic_name: topic, payload: payload, options: options).process
+        end
+
+        def process
+          raise TestDebugInvalidError, errors.full_messages.to_sentence unless valid?
+
+          Mqttopia::Serializers::TestDebug.serialize({
+                                                       topic_name: topic_name,
+                                                       payload: payload
+                                                     })
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "active_model"
+require_relative "../../serializers/trip_metric"
+require_relative "../../helpers/data_extractor"
+require_relative "./base"
+
+module Mqttopia
+  module Subscriptions
+    module Services
+      class TripMetrics < Mqttopia::Subscriptions::Services::Base
+        class TripMetricsInvalidError < ArgumentError
+        end
+
+        attr_reader :trip_id, :metrics, :options, :user_id
+
+        validates :trip_id, presence: true, numericality: { only_integer: true, greater_than: 0 }
+        validates :metrics, presence: true
+
+        def initialize(trip_id:, metrics:, options: {})
+          @trip_id = trip_id
+          @metrics = metrics
+          @options = options
+          @user_id = options[:user_id]
+        end
+
+        def self.call(topic, payload, options = {})
+          trip_id = topic.include?("trips/") && topic.match(%r{trips/[^/]+}) && extract_trip_id(topic)
+          options[:user_id] = topic.include?("user/") && topic.match(%r{user/[^/]+}) && extract_user_id(topic)
+
+          new(trip_id: trip_id, metrics: payload, options: options).process
+        end
+
+        def process
+          raise TripMetricsInvalidError, errors.full_messages.to_sentence unless valid?
+
+          Mqttopia::Serializers::TripMetric.serialize({
+                                                        trip_id: trip_id,
+                                                        metrics: metrics
+                                                      })
+        end
+      end
+    end
+  end
+end

data/lib/mqttopia/topics/services.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mqttopia
+  module Topics
+    class Services
+      KEYS = {
+        trip_metric: {
+          topic_name: "illa/trips/:trip_id/trip_metric/send/user/:user_id",
+          service: "Mqttopia::Subscriptions::Services::TripMetrics",
+          serializer: "Mqttopia::Serializers::TripMetric",
+          regex: %r{\Ailla/trips/(?<trip_id>\d+)/trip_metric/send(?:/user/(?<user_id>\d+))?\z}
+        },
+        test_debug: {
+          topic_name: "test",
+          service: "Mqttopia::Subscriptions::Services::TestDebug",
+          serializer: "Mqttopia::Serializers::TripMetric",
+          regex: %r{test/}
+        }
+      }.freeze
+    end
+  end
+end

data/lib/mqttopia/version.rb

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

data/lib/mqttopia.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "logger"
+
+require_relative "mqttopia/version"
+require_relative "mqttopia/client"
+require_relative "mqttopia/logger"
+
+# Load rake tasks
+Dir[File.expand_path("tasks/**/*.rake", __dir__)].each { |task| load task }
+
+# Base module for Mqttopia Gem
+module Mqttopia
+  class Error < StandardError; end
+
+  mattr_accessor :hosts, :port, :username, :password, :ssl, :logger, :debugging
+
+  @@port = 1883
+  @@ssl = true
+  @@logger = ::Logger.new($stdout)
+  @@debugging = false
+
+  def self.configure
+    yield self
+  end
+end

data/lib/tasks/initialize.rake

@@ -0,0 +1,44 @@
+# lib/tasks/initialize.rake
+require 'rake'
+
+namespace :mqttopia do
+  desc "Create mqttopia_initialize.rb with default configuration"
+  task :initialize do
+    file_name = 'mqttopia_initialize.rb'
+    content = <<~RUBY
+      Mqttopia.configure do |config|
+        # Set the MQTT host
+        config.hosts = ["localhost"]
+
+        # Set the MQTT port
+        config.port = 1883
+
+        # Set the MQTT username
+        config.username = "user"
+
+        # Set the MQTT password
+        config.password = "xxxx"
+
+        # Set the MQTT ssl
+        config.ssl = true
+
+        # Set the MQTT debugging mode
+        # config.debugging = true
+
+        # Set the logger (defaults to STDOUT)
+        # config.logger = Logger.new(STDOUT)
+      end
+
+      # $client = Mqttopia::Client.instance
+      # $client.subscribe('test/#') { |res| puts res }
+      # $client.publish('test/topic', 'Hello, MQTT')
+    RUBY
+
+    if File.exist?(file_name)
+      puts "Skipping: #{file_name} already exists"
+    else
+      File.write(file_name, content)
+      puts "Created: #{file_name}"
+    end
+  end
+end

data/mqttopia.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "lib/mqttopia/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mqttopia"
+  spec.version = Mqttopia::VERSION
+  spec.authors = ["Illa Tech"]
+  spec.email = ["tech@illa.com.eg"]
+
+  spec.summary = "Mqttopia"
+  spec.description = "Mqttopia description"
+  spec.homepage = "https://github.com/go-illa"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/go-illa/mqttopia"
+  spec.metadata["changelog_uri"] = "https://github.com/go-illa/mqttopia"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activemodel", ">= 4.1"
+  spec.add_dependency "json", ">= 1.6"
+  spec.add_dependency "logger", ">= 1.4"
+  spec.add_dependency "mqtt", ">= 0.6"
+  spec.add_dependency "railties", ">= 4.2"
+  spec.add_dependency "rake", ">= 11.0"
+
+  spec.add_development_dependency "brakeman", "~> 6.0"
+  spec.add_development_dependency "fasterer", "~> 0.10"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 2.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+
+  spec.post_install_message = '
+      [MQTTOPIA] Please make sure to run `rails generate mqttopia:install`
+      '
+end

data/sig/mqttopia.rbs

@@ -0,0 +1,4 @@
+module Mqttopia
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: mqttopia
+version: !ruby/object:Gem::Version
+  version: 0.1.9
+platform: ruby
+authors:
+- Illa Tech
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Mqttopia description
+email:
+- tech@illa.com.eg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- MQTT_SUBSCRIPTIONS.md
+- README.md
+- Rakefile
+- TEST_README.md
+- lib/generators/mqttopia/install_generator.rb
+- lib/generators/templates/mqttopia_initializer.rb
+- lib/mqttopia.rb
+- lib/mqttopia/client.rb
+- lib/mqttopia/helpers/data_extractor.rb
+- lib/mqttopia/logger.rb
+- lib/mqttopia/serializers/test_debug.rb
+- lib/mqttopia/serializers/trip_metric.rb
+- lib/mqttopia/subscriptions/redirect.rb
+- lib/mqttopia/subscriptions/services/base.rb
+- lib/mqttopia/subscriptions/services/test_debug.rb
+- lib/mqttopia/subscriptions/services/trip_metrics.rb
+- lib/mqttopia/topics/services.rb
+- lib/mqttopia/version.rb
+- lib/tasks/initialize.rake
+- mqttopia.gemspec
+- sig/mqttopia.rbs
+homepage: https://github.com/go-illa
+licenses: []
+metadata:
+  homepage_uri: https://github.com/go-illa
+  source_code_uri: https://github.com/go-illa/mqttopia
+  changelog_uri: https://github.com/go-illa/mqttopia
+post_install_message: "\n      [MQTTOPIA] Please make sure to run `rails generate
+  mqttopia:install`\n      "
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.19
+signing_key:
+specification_version: 4
+summary: Mqttopia
+test_files: []