mqtt_api_client 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c75dac8a27f93fc8756bb64868aba970a57a5e99267e749820acda6009745f
-  data.tar.gz: 0ef832f1ca9e28be3226788205339ac92d228ee1ec013d2679d09096df63bfa7
+  metadata.gz: 9168c78afc2d36166c65fb36af8a62ab5f6b3b0494bc208a34666b3be3d81af9
+  data.tar.gz: 10f08ca4e45df407c3474299f9c5fec65b0e7415f5068d2b342fce56102a21dd
 SHA512:
-  metadata.gz: e00b819611be0ddc22ed5d93e378b1ed4f7546d5b531ab0a57b5cca49b83ecd5832055017d27c214865e1513ef3939960558b964915c182357299d2400656044
-  data.tar.gz: 57d53b71b510c4455c0064fce28ac11386fe724f5c2f9435d0725d6a5f43fb186bb26e4912aeab7dd2d4b42638325892140f260c97446a3fb746c61c718b80e0
+  metadata.gz: '080407873f5678539f5cb400afaa980eea469e22bbd827760717437e3f4bf40da45da36327a00f95dbf9dacaf1a94f5d1ca83414ecb9c287ff8af20a43255d26'
+  data.tar.gz: cd5588a020ca71a9b29c31f843f8eab66a2be4ebcb39cb887b0f70e2069d2619faaa35f5c5a4e942205f19d25901ae468fb676c14cd8890dd56a7f55cf3da7a9

data/.rubocop.yml

@@ -1,3 +1,14 @@
+# 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
@@ -6,25 +17,55 @@ AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable
 
-Layout/LineLength:
+Gemspec/RequireMFA:
   Enabled: false
 
-Metrics/BlockLength:
+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/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Style/YodaCondition:
+  Enabled: false

data/README.md

@@ -8,15 +8,43 @@ TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_O
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add macklabsinc/mqtt_api_client
+    $ bundle add mqtt_api_client
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install macklabsinc/mqtt_api_client
+    $ gem install mqtt_api_client
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+#
+# 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
 
@@ -26,7 +54,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mqtt_api_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://bitbucket.com/macklabsinc/mqtt_api_client/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/macklabsinc/mqtt_api_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://bitbucket.com/macklabsinc/mqtt_api_client/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/mqtt_api_client/command.rb

@@ -3,93 +3,84 @@
 require "logger"
 
 module MqttApiClient
-  # commands implemented
   class Command
-    attr_reader :mqtt_client, :crt, :key, :host, :logger
+    TIMEOUT_SECONDS = 2
+
+    attr_reader :mqtt_client, :device_identifier
 
     #
-    # @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
+    # @param mqtt_client [MQTT::Client]
+    # @param device_identifier [String]
+    def initialize(mqtt_client, device_identifier)
+      @mqtt_client = mqtt_client
+      @device_identifier = device_identifier
+
+      logger.info "Command logger initialized at #{Time.now}"
+
+      subscribe_to_all(
+        "device/#{device_identifier}/file_list",
+        "device/#{device_identifier}/health_status"
+      )
     end
 
-    # rubocop:disable Style/EmptyElse
-    def file_list(device_identifier)
-      subscribed_topic = "device/#{device_identifier}/file_list"
-
-      mqtt_client.subscribe(subscribed_topic)
+    def file_list
       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 ?
+      begin
+        process_get(
+          "device/#{device_identifier}/file_list",
+          "New file_list"
+        )
+      rescue Timeout::Error => e
+        logger.error "file_list timeout: #{e}"
 
-          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
+        Timeout::Error.new(e)
       end
     end
 
-    def health_status(device_identifier)
-      subscribed_topic = "device/#{device_identifier}/health_status"
-      mqtt_client.subscribe(subscribed_topic)
-
+    def health_status
       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 ?
+      begin
+        process_get(
+          "device/#{device_identifier}/health_status",
+          "New health_status"
+        )
+      rescue Timeout::Error => e
+        logger.error "health_status timeout: #{e}"
 
-          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
+        Timeout::Error.new(e)
       end
     end
 
     private
 
-    def connect
-      @mqtt_client = MQTT::Client.new
-      @mqtt_client.host = host
-      @mqtt_client.port = 8883
-      @mqtt_client.ssl = true
+    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
+          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
+    end
 
-      @mqtt_client.cert = crt
-      @mqtt_client.key = key
+    def logger
+      @_logger ||= Logger.new("log/command.log", "daily")
+    end
 
-      @mqtt_client.connect
+    #
+    # @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.0"
+  VERSION = "0.1.2"
 end

data/lib/mqtt_api_client.rb

@@ -2,8 +2,8 @@
 
 require "amazing_print"
 require "mqtt"
-require_relative "mqtt_api_client/version"
 require_relative "mqtt_api_client/command"
+require_relative "mqtt_api_client/version"
 
 module MqttApiClient
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqtt_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Vladyslav Sumskyi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt
@@ -42,7 +42,7 @@ files:
 - lib/mqtt_api_client.rb
 - lib/mqtt_api_client/command.rb
 - lib/mqtt_api_client/version.rb
-- sig/mqtt_api_client.rbs
+- log/.keep
 homepage: https://bitbucket.org/macklabsinc/mqtt_api_client/src/master/
 licenses:
 - MIT
@@ -67,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.6
 signing_key: 
 specification_version: 4
 summary: MQTT API Client

data/sig/mqtt_api_client.rbs

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