mqtt_api_client 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b088d9d3aeb35ebe2ccd4859de7b6ec9a662862ff4a3967f3b4024c6a1c19d7
-  data.tar.gz: f0715c7f69236b628be8ea7b80ffd82e91810dedca081cbb13f1cc49b0a92c47
+  metadata.gz: a240564b318c55966a38d19bf82e3889f42913e95d6d0b55ca4029ef3e29a38e
+  data.tar.gz: a1882e0fb51e34be57b2cf9ae4daa6c2d80a09eb8a6a198cf3e384442132f043
 SHA512:
-  metadata.gz: db1bde54e70d4dd57593f0c66b0a51be1a31bebc86d2fb3771898dd97302428d7c3a7a356bafb0e0767c331990c90f61c475f9a61ded3993dc474ed79c4b8c55
-  data.tar.gz: fade692f1b10693adf0efd4e45a2e64c4684fae77496b089eeadefa6a5b00a4f1a75ef7d900823bc4b644d1b7163359e74befbb6f89eca5a5e3f5e50995297c0
+  metadata.gz: 828d9958263be605c6c1ad5f4a10b7aeeac4508e5131ef6bb6399113786e8f8fcf6ed0bb1bda7ecf4f3cffe9757cdc5880d602f10a46b35efec610115c774e2a
+  data.tar.gz: 2ae4cd4206a80f4740b562bb80535584c97dbece54c064da133a5b0660a8f07605a576e62a13e5ada794b5d31a053193616c1b5c3fc7422b828f9eab1d245bd9

data/.env.local.example

@@ -0,0 +1,8 @@
+DEVICE_IDENTIFIER=
+MQTT_HOST=
+MQTT_PORT=8883
+
+DOTENV_LINEBREAK_MODE=legacy
+
+MQTT_CERT="-----BEGIN CERTIFICATE-----\nxxxx\n-----END CERTIFICATE-----\n"
+MQTT_KEY="-----BEGIN RSA PRIVATE KEY-----\nxxxx\n-----END RSA PRIVATE KEY-----\n"

data/.rubocop.yml

@@ -0,0 +1,71 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/CommentIndentation:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyElse:
+  Exclude:
+    - lib/mqtt_api_client/command.rb
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/YodaCondition:
+  Enabled: false

data/README.md

@@ -17,10 +17,33 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 ```ruby
-command = MqttApiClient::Command.new(certificate, private_key, "localhost")
+#
+# connect to your MQTT broker (AWS IoT, Mosquitto, and so on..)
+# @param [String], crt
+# @param [String], key
+# @param [String], host
+mqtt_client = MQTT::Client.new.tap do |client|
+  # connection info
+  client.host = "my.host"
+  client.port = 8883
+  client.ssl = true
+
+  # certificates
+  client.cert = my_cert
+  client.key = my_private_key
+
+  client.connect
+end
+
+#
+# @param [MQTT::Client], mqtt_client
+# @param [String], device_identifier
+command = MqttApiClient::Command.new(mqtt_client, "D0045F")
 
 command.health_status
 command.file_list
+
+command.disconnect
 ```
 
 ## Development

data/lib/mqtt_api_client/device.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "logger"
+require "fileutils"
+module MqttApiClient
+  class Device
+    TIMEOUT_SECONDS = 2
+
+    attr_reader :mqtt_client, :device_identifier, :logger
+
+    #
+    # @param mqtt_client [MQTT::Client]
+    # @param device_identifier [String]
+    def initialize(mqtt_client:, device_identifier:, logger: default_logger(device_identifier))
+      @mqtt_client = mqtt_client
+      @device_identifier = device_identifier
+      @logger = logger
+
+      logger&.info "Command logger initialized at #{Time.now}"
+
+      subscribe_to_all(
+        "device/#{device_identifier}/file_list",
+        "device/#{device_identifier}/health_status"
+      )
+    end
+
+    def file_list
+      mqtt_client.publish("device/#{device_identifier}/command", "file_list")
+
+      begin
+        process_get(
+          "device/#{device_identifier}/file_list",
+          "file_list"
+        )
+      rescue Timeout::Error => e
+        logger&.error "file_list timeout: #{e}"
+
+        Timeout::Error.new(e)
+      end
+    end
+
+    def health_status
+      mqtt_client.publish("device/#{device_identifier}/command", "health_status")
+
+      begin
+        process_get(
+          "device/#{device_identifier}/health_status",
+          "health_status"
+        )
+      rescue Timeout::Error => e
+        logger&.error "health_status timeout: #{e}"
+
+        Timeout::Error.new(e)
+      end
+    end
+
+    def disconnect
+      mqtt_client.disconnect
+    end
+
+    private
+
+    def process_get(subscribed_topic, logger_key)
+      @_process_get ||= Timeout.timeout(TIMEOUT_SECONDS) do
+        mqtt_client.get do |topic, message|
+          if topic == subscribed_topic
+            logger&.info "#{logger_key}: #{message}"
+
+            # do any logic with a message there, if you need to
+
+            return message
+          end
+        end
+      end
+    end
+
+    def default_logger(device_identifier)
+      FileUtils.mkdir_p("log")
+
+      Logger.new("log/device_#{device_identifier}.log", "daily")
+    end
+
+    #
+    # @param topics [Array<String]
+    def subscribe_to_all(*topics)
+      topics.each { |topic| mqtt_client.subscribe(topic) }
+    end
+  end
+end

data/lib/mqtt_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MqttApiClient
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/mqtt_api_client.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require "amazing_print"
-require "dotenv/load"
 require "mqtt"
-require_relative "mqtt_api_client/command"
+require_relative "mqtt_api_client/device"
 require_relative "mqtt_api_client/version"
 
 module MqttApiClient

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqtt_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Vladyslav Sumskyi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-22 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt
@@ -31,8 +31,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env.example"
+- ".env.local.example"
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -40,7 +41,7 @@ files:
 - Rakefile
 - bitbucket-pipelines.yml
 - lib/mqtt_api_client.rb
-- lib/mqtt_api_client/command.rb
+- lib/mqtt_api_client/device.rb
 - lib/mqtt_api_client/version.rb
 homepage: https://bitbucket.org/macklabsinc/mqtt_api_client/src/master/
 licenses:
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: MQTT API Client

data/.env.example

@@ -1,4 +0,0 @@
-AWS_CERTIFICATE=
-AWS_PRIVATE_KEY=
-LOCAL_CERTIFICATE=
-LOCAL_PRIVATE_KEY=

data/lib/mqtt_api_client/command.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-require "logger"
-
-module MqttApiClient
-  # commands implemented
-  class Command
-    attr_reader :mqtt_client, :crt, :key, :host, :logger
-
-    #
-    # @param [File|String], crt
-    # @param [File|String], key
-    def initialize(crt, key, host)
-      @crt = if File.file? crt
-               File.read crt
-             else
-               crt
-             end
-      @key = if File.file? key
-               File.read key
-             else
-               key
-             end
-
-      @host = host
-
-      @logger = Logger.new("log/command.log", "daily")
-      @logger.info "Command logger initialized at #{Time.now}"
-
-      connect
-    end
-
-    # rubocop:disable Style/EmptyElse
-    def file_list(device_identifier)
-      subscribed_topic = "device/#{device_identifier}/file_list"
-
-      mqtt_client.subscribe(subscribed_topic)
-      mqtt_client.publish("device/#{device_identifier}/command", "file_list")
-
-      mqtt_client.get do |topic, message|
-        mqtt_client.unsubscribe(subscribed_topic) if topic == subscribed_topic
-
-        if topic == subscribed_topic
-          logger.info "New file_list: #{message}"
-
-          # do some logic with a message, probably update device file_list in the DB ?
-
-          return message
-        else
-          # I don't want to raise exception here because we are
-          # getting messages from the whole mqtt queue, one by one,
-          # and the next message could be that what we need
-        end
-      end
-    end
-
-    def health_status(device_identifier)
-      subscribed_topic = "device/#{device_identifier}/health_status"
-      mqtt_client.subscribe(subscribed_topic)
-
-      mqtt_client.publish("device/#{device_identifier}/command", "health_status")
-
-      mqtt_client.get do |topic, message|
-        mqtt_client.unsubscribe(subscribed_topic) if topic == subscribed_topic
-
-        if topic == subscribed_topic
-          logger.info "New health_status: #{message}"
-
-          # do some logic with a message, probably update device health_status in the DB ?
-
-          return message
-        else
-          # I don't want to raise exception here because we are
-          # getting messages from the whole mqtt queue, one by one,
-          # and the next message could be that what we need
-        end
-        # rubocop:enable Style/EmptyElse
-      end
-    end
-
-    private
-
-    def connect
-      @mqtt_client = MQTT::Client.new
-      @mqtt_client.host = host
-      @mqtt_client.port = 8883
-      @mqtt_client.ssl = true
-
-      @mqtt_client.cert = crt
-      @mqtt_client.key = key
-
-      @mqtt_client.connect
-    end
-  end
-end