lex-mqtt 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bada2aeb4e0d02eb1325b234c0c861eeabc48e014a861f3478c9f6cfa4e6c56
+  data.tar.gz: c9aaf17ca95f9c1949c53f4c3480c81674a5a2e866f047ce33c35c2427ec473a
+SHA512:
+  metadata.gz: f432eed99b6b02868cff3f6ee36fc2a516f5e0da79a5f2c473f1a06de4b516219e9f7810095ea7c7da1f6904ceb82ed7a9c7a6343f9d1e84de91b835f3a0669b
+  data.tar.gz: a8a4a1b693a75f9ac6c7456b40c5c35474bc37506336ca715fab7dfb1cf74fe66de2da03ed4a00162a5672256e51c14341d059f801e88cda2ae83b0f55ef3c46

data/.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: CI
+on:
+  push:
+    branches: [origin]
+  pull_request:
+
+jobs:
+  ci:
+    uses: LegionIO/.github/.github/workflows/ci.yml@main
+
+  release:
+    needs: ci
+    if: github.event_name == 'push' && github.ref == 'refs/heads/origin'
+    uses: LegionIO/.github/.github/workflows/release.yml@main
+    secrets:
+      rubygems-api-key: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+.rspec_status
+coverage/
+pkg/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+require:
+  - rubocop-rspec
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.4
+  SuggestExtensions: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+Naming/PredicateMethod:
+  Enabled: false
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [0.1.0] - 2026-03-21
+
+### Added
+- `Helpers::Client` module with `.connection` factory method wrapping `MQTT::Client`
+- `Runners::Publish` with `publish` (topic, payload, retain, qos)
+- `Runners::Subscribe` with `subscribe` (topic, timeout, max_messages) and `get` (single message)
+- Standalone `Client` class including all runner modules
+- Framework `lex_settings` declaring default host, port, and ssl settings

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'
+gem 'simplecov'

data/README.md

@@ -0,0 +1,46 @@
+# lex-mqtt
+
+LegionIO extension for MQTT broker integration. Publish and subscribe to MQTT topics via the `mqtt` gem.
+
+## Usage
+
+### Standalone Client
+
+```ruby
+require 'lex-mqtt'
+
+client = Legion::Extensions::Mqtt::Client.new(
+  host:     'broker.example.com',
+  port:     1883,
+  username: 'user',
+  password: 'secret',
+  ssl:      false
+)
+
+# Publish a message
+client.publish(topic: 'sensors/temperature', payload: '22.5')
+client.publish(topic: 'sensors/temperature', payload: '22.5', retain: true, qos: 1)
+
+# Get a single message
+result = client.get(topic: 'sensors/temperature')
+# => { topic: 'sensors/temperature', payload: '22.5' }
+
+# Subscribe and collect messages
+result = client.subscribe(topic: 'sensors/#', timeout: 5, max_messages: 10)
+# => { messages: [...], count: 3, topic: 'sensors/#' }
+```
+
+## Configuration
+
+Default `lex_settings`:
+
+| Key | Default |
+|-----|---------|
+| `mqtt.host` | `'localhost'` |
+| `mqtt.port` | `1883` |
+| `mqtt.ssl` | `false` |
+
+## Dependencies
+
+- `mqtt` (~> 0.6)
+- Ruby >= 3.4

data/lex-mqtt.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/legion/extensions/mqtt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lex-mqtt'
+  spec.version       = Legion::Extensions::Mqtt::VERSION
+  spec.authors       = ['Esity']
+  spec.email         = ['matthewdiverson@gmail.com']
+
+  spec.summary       = 'LEX::Mqtt'
+  spec.description   = 'Connects Legion to MQTT brokers'
+  spec.homepage      = 'https://github.com/LegionIO/lex-mqtt'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.4'
+
+  spec.metadata['homepage_uri']          = spec.homepage
+  spec.metadata['source_code_uri']       = 'https://github.com/LegionIO/lex-mqtt'
+  spec.metadata['documentation_uri']     = 'https://github.com/LegionIO/lex-mqtt'
+  spec.metadata['changelog_uri']         = 'https://github.com/LegionIO/lex-mqtt'
+  spec.metadata['bug_tracker_uri']       = 'https://github.com/LegionIO/lex-mqtt/issues'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mqtt', '~> 0.6'
+end

data/lib/legion/extensions/mqtt/client.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'helpers/client'
+require_relative 'runners/publish'
+require_relative 'runners/subscribe'
+
+module Legion
+  module Extensions
+    module Mqtt
+      class Client
+        include Runners::Publish
+        include Runners::Subscribe
+
+        attr_reader :opts
+
+        def initialize(host: 'localhost', port: 1883, username: nil, password: nil, ssl: false)
+          @opts = { host: host, port: port, username: username, password: password, ssl: ssl }
+        end
+
+        def settings
+          { options: @opts }
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/mqtt/helpers/client.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'mqtt'
+
+module Legion
+  module Extensions
+    module Mqtt
+      module Helpers
+        module Client
+          def self.connection(**opts)
+            MQTT::Client.new(
+              host: opts[:host]     || 'localhost',
+              port: opts[:port]     || 1883,
+              username: opts[:username],
+              password: opts[:password],
+              ssl: opts[:ssl] || false
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/mqtt/runners/publish.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Mqtt
+      module Runners
+        module Publish
+          def publish(topic:, payload:, retain: false, qos: 0, **)
+            client = Helpers::Client.connection(**@opts)
+            client.connect
+            client.publish(topic, payload, retain, qos)
+            { published: true, topic: topic, retain: retain, qos: qos }
+          ensure
+            client&.disconnect
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/mqtt/runners/subscribe.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Mqtt
+      module Runners
+        module Subscribe
+          def subscribe(topic:, timeout: 5, max_messages: 10, **)
+            messages = with_client(topic) { |c| collect_messages(c, timeout, max_messages) }
+            { messages: messages, count: messages.size, topic: topic }
+          end
+
+          def get(topic:, **)
+            topic_name, payload = with_client(topic, &:get)
+            { topic: topic_name, payload: payload }
+          end
+
+          private
+
+          def with_client(topic)
+            client = Helpers::Client.connection(**@opts)
+            client.connect
+            client.subscribe(topic)
+            yield(client)
+          ensure
+            client&.disconnect
+          end
+
+          def collect_messages(client, timeout, max_messages)
+            messages = []
+            deadline = Time.now + timeout
+            loop do
+              break if messages.size >= max_messages || Time.now > deadline
+
+              topic_name, msg = client.get_packet&.then { |pkt| [pkt.topic, pkt.payload] }
+              messages << { topic: topic_name, payload: msg } if topic_name
+            rescue MQTT::Exception
+              break
+            end
+            messages
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/mqtt/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Mqtt
+      VERSION = '0.1.1'
+    end
+  end
+end

data/lib/legion/extensions/mqtt.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'legion/extensions/mqtt/version'
+require 'legion/extensions/mqtt/helpers/client'
+require 'legion/extensions/mqtt/runners/publish'
+require 'legion/extensions/mqtt/runners/subscribe'
+require 'legion/extensions/mqtt/client'
+
+module Legion
+  module Extensions
+    module Mqtt
+      extend Legion::Extensions::Core if Legion::Extensions.const_defined? :Core
+
+      def self.lex_settings
+        { mqtt: { host: 'localhost', port: 1883, ssl: false } }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: lex-mqtt
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Esity
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Connects Legion to MQTT brokers
+email:
+- matthewdiverson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- lex-mqtt.gemspec
+- lib/legion/extensions/mqtt.rb
+- lib/legion/extensions/mqtt/client.rb
+- lib/legion/extensions/mqtt/helpers/client.rb
+- lib/legion/extensions/mqtt/runners/publish.rb
+- lib/legion/extensions/mqtt/runners/subscribe.rb
+- lib/legion/extensions/mqtt/version.rb
+homepage: https://github.com/LegionIO/lex-mqtt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LegionIO/lex-mqtt
+  source_code_uri: https://github.com/LegionIO/lex-mqtt
+  documentation_uri: https://github.com/LegionIO/lex-mqtt
+  changelog_uri: https://github.com/LegionIO/lex-mqtt
+  bug_tracker_uri: https://github.com/LegionIO/lex-mqtt/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: LEX::Mqtt
+test_files: []