mqtt-v3 0.0.1.ci.release

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec59d893849846a0f086529c3acf5cf9a04c1556a172cde7c3d5d7808d36c004
+  data.tar.gz: 6e031482950ee155832e34b0aebf286ef1fcd811da2465bd23c0f134cff35054
+SHA512:
+  metadata.gz: 411041e65bcf34536b7a32d2d4f74a2c1cfa89d7d66900aff56fc279a2f3876ec95495e6a9258d0c5f083b4753398619ed90b9af3a33dd33f8adb2bd1c9c6274
+  data.tar.gz: ab9b41bf396a640c74c04223aa12b534496ef314977c785348ed6511849881c9a725a4c9bd33d5cf6bdc2562ac12c72d48d20d140d374e809017f60aae4a4df8

data/lib/mqtt/v3/async/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'async'
+require_relative '../client'
+
+module MQTT
+  module V3
+    module Async
+      # An Async {MQTT::Core::Client} for MQTT 5.0
+      class Client < MQTT::V3::Client
+        class << self
+          # Create a new {Client}
+          def open(*io_args, **run_args, &)
+            unless block_given? || ::Async::Task.current?
+              raise MQTT::Error, 'async open requires a block or to be running within the async reactor'
+            end
+
+            super
+          end
+
+          def mqtt_monitor
+            async_monitor
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mqtt/v3/client/connection.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'mqtt/core/client'
+module MQTT
+  module V3
+    class Client < MQTT::Core::Client
+      # Client protocol for MQTT 5.0
+      class Connection < MQTT::Core::Client::Connection
+        def_delegators :session, :clean_session
+
+        def handle_publish(packet)
+          raise ProtocolError, 'Received PUBLISH with DUP and QoS 0' if packet.qos.zero? && packet.dup
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/mqtt/v3/client/session.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'mqtt/core/client'
+require_relative '../packet'
+
+module MQTT
+  module V3
+    class Client < MQTT::Core::Client
+      # Client Session specialisation for MQTT 3.1.1
+      #
+      # Session expiry and auto-assigned client ids are simulated since they are not supported by the protocol itself.
+      #  * An empty client_id and non-zero expiry_interval will auto-generate an id at the first connection.
+      #  * Session expiry is only checked on the client side before sending a CONNECT packet.
+      #  * The clean_session property is always set true for anonymous sessions (zero expiry + client_id empty) and
+      #    this combination is not recoverable.
+      class Session < MQTT::Core::Client::Session
+        # If session expiry is non-zero and client_id is empty, then auto generate a client_id if supported by
+        # the session_store.
+
+        def connect_data(**connect)
+          check_session_managed_fields(:connect, connect, :clean_session)
+          assign_client_id if client_id.empty? && session_store.expiry_interval.positive?
+          super.merge!(client_id:, clean_session: clean?)
+        end
+
+        private
+
+        # Anonymous sessions in MQTT3.0 are abandoned at disconnect.
+        # If we have a long-lived session (ie with non-zero expiry) then we need to fake server assigned id by
+        # generating one now.
+        def assign_client_id
+          session_store.client_id = session_store.generate_client_id
+        end
+      end
+    end
+  end
+end

data/lib/mqtt/v3/client.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'mqtt/core/client'
+require_relative 'packets'
+require_relative 'client/connection'
+require_relative 'client/session'
+
+module MQTT
+  module V3
+    # An MQTT 3.1.1 Client
+    class Client < MQTT::Core::Client
+      class << self
+        def packet_module
+          Packet
+        end
+
+        def protocol_version
+          3
+        end
+      end
+    end
+  end
+end

data/lib/mqtt/v3/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module MQTT
+  module V3
+    class ResponseError < MQTT::ResponseError; end
+  end
+end

data/lib/mqtt/v3/packet/ack_success.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 acknowledgement module
+      #
+      # Most V3 ACK packets have no error codes - the packet arrives successfully, or the connection is closed.
+      # This module provides success!, success?, and failed? methods for these packets.
+      module AckSuccess
+        def success?
+          true
+        end
+
+        def success!
+          self
+        end
+
+        def failed?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/connack.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+
+module MQTT
+  module V3
+    class ConnectionRefused < MQTT::V3::ResponseError; end
+
+    module Packet
+      # MQTT 3.1.1 CONNACK packet
+      #
+      # Connection acknowledgement sent by broker in response to a CONNECT packet.
+      #
+      # @see Core::Client#connect
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718033 MQTT 3.1.1 Spec §3.2
+      class Connack
+        include Packet
+
+        fixed(2)
+
+        # @!attribute [r] session_present
+        #   @return [Boolean] whether the broker has a stored session for this client
+
+        # @!attribute [r] return_code
+        #   @return [Integer] connection return code:
+        #
+        #   - `0x00` Connection accepted
+        #   - `0x01` Unacceptable protocol version
+        #   - `0x02` Identifier rejected
+        #   - `0x03` Server unavailable
+        #   - `0x04` Bad user name or password
+        #   - `0x05` Not authorized
+
+        variable(
+          flags: flags([:reserved, 7], [:session_present, 1]),
+          return_code: :int8
+        )
+
+        RETURN_CODES = {
+          0x00 => :success,
+          0x01 => :unacceptable_protocol_version,
+          0x02 => :identifier_rejected,
+          0x03 => :server_unavailable,
+          0x04 => :bad_user_name_or_password,
+          0x05 => :not_authorized
+        }.freeze
+
+        def success!
+          return self if success?
+
+          raise ConnectionRefused, RETURN_CODES.fetch(return_code, :unknown_error)
+        end
+
+        def success?
+          return_code.zero?
+        end
+
+        def failed?
+          !success?
+        end
+
+        alias connect_return_code return_code # align with spec naming
+        alias session_present? session_present
+
+        # @!visibility private
+        def defaults
+          super.merge!(session_present: false, return_code: 0x00)
+        end
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/connect.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+require 'mqtt/core/packet/connect'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 CONNECT packet
+      #
+      # Sent by client to establish connection with the broker.
+      #
+      # @see Core::Client#connect
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718028 MQTT 3.1.1 Spec §3.1
+      class Connect
+        include Packet
+        include Core::Packet::Connect
+
+        fixed(1)
+
+        # @!attribute [r] protocol_name
+        #   @return [String<UTF8>] protocol name (managed automatically)
+        # @!attribute [r] protocol_version
+        #   @return [Integer] protocol version (managed automatically)
+        # @!attribute [r] clean_session
+        #   @return [Boolean] if true server will abandon any stored session (managed automatically from session store)
+        # @!attribute [r] will_qos
+        #   @return [Integer] QoS level for the Will message: 0, 1, or 2 (default 0)
+        # @!attribute [r] will_retain
+        #   @return [Boolean] should the Will message be retained (default false)
+        # @!attribute [r] keep_alive
+        #   @return [Integer] maximum duration in seconds between packets sent by the client (default 60)
+
+        # @!attribute [r] client_id
+        #   @return [String<UTF8>] client identifier string (auto-assigned if empty with non-zero session expiry)
+        # @!attribute [r] will_topic
+        #   @return [String<UTF8>] topic name to send the Will message to
+        # @!attribute [r] will_payload
+        #   @return [String<Binary>] payload of the Will message
+        # @!attribute [r] username
+        #   @return [String<UTF8>] username for authenticating with the server
+        # @!attribute [r] password
+        #   @return [String<Binary>] password for authenticating with the server
+
+        variable(
+          protocol_name: :utf8string,
+          protocol_version: :int8,
+          connect_flags: flags(
+            :username_flag, :password_flag,
+            :will_retain,
+            [:will_qos, 2],
+            :will_flag,
+            :clean_session,
+            :reserved
+          ),
+          keep_alive: :int16
+        )
+
+        payload(
+          client_id: :utf8string,
+          will_topic: { type: :utf8string, if: :will_flag },
+          will_payload: { type: :binary, if:  :will_flag },
+          username: { type: :utf8string, if:  :username },
+          password: { type: :binary, if: :password }
+        )
+
+        alias clean_requested? clean_session
+        alias username? :username_flag
+        alias password? :password_flag
+        alias will_flag? :will_flag
+
+        # @!visibility private
+        def defaults
+          super.merge!(client_id: nil, keep_alive: 60, clean_session: true, will_qos: 0, will_retain: false)
+        end
+
+        # @!visibility private
+        def apply_overrides(data)
+          super
+          data.merge!(
+            protocol_name: 'MQTT',
+            protocol_version: PROTOCOL_VERSION
+          )
+        end
+
+        # @!visibility private
+        def success!(connack)
+          connack.success!
+        end
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/disconnect.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 DISCONNECT packet
+      #
+      # Sent by client to gracefully disconnect from the broker.
+      #
+      # @see Core::Client#disconnect
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718090 MQTT 3.1.1 Spec §3.14
+      class Disconnect
+        include Packet
+
+        fixed(14)
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/ping_req.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 PINGREQ packet
+      #
+      # Sent by client to keep the connection alive.
+      #
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718081 MQTT 3.1.1 Spec §3.12
+      class PingReq
+        include Packet
+
+        fixed(12)
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/ping_resp.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 PINGRESP packet
+      #
+      # Sent by broker in response to a PINGREQ packet.
+      #
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718086 MQTT 3.1.1 Spec §3.13
+      class PingResp
+        include Packet
+
+        fixed(13)
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/pub_ack.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+require_relative 'ack_success'
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 PUBACK packet
+      #
+      # QoS 1 acknowledgement sent by broker in response to a PUBLISH packet.
+      #
+      # @see Core::Client#publish
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718043 MQTT 3.1.1 Spec §3.4
+      class PubAck
+        include Packet
+
+        fixed(4)
+
+        # @!attribute [r] packet_identifier
+        #   @return [Integer] packet identifier matching the PUBLISH packet (receive only)
+
+        variable(packet_identifier: :int16)
+
+        include AckSuccess
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/pub_comp.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+require_relative 'ack_success'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 PUBCOMP packet
+      #
+      # QoS 2 publish complete (part 3) sent by broker in response to a PUBREL packet.
+      #
+      # @see Core::Client#publish
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718058 MQTT 3.1.1 Spec §3.7
+      class PubComp
+        include Packet
+
+        fixed(7)
+
+        # @!attribute [r] packet_identifier
+        #   @return [Integer] packet identifier matching the PUBREL packet (receive only)
+
+        variable(packet_identifier: :int16)
+
+        include AckSuccess
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/pub_rec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+require_relative 'ack_success'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 PUBREC packet
+      #
+      # QoS 2 acknowledgement (part 1) sent by broker in response to a PUBLISH packet.
+      #
+      # @see Core::Client#publish
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718048 MQTT 3.1.1 Spec §3.5
+      class PubRec
+        include Packet
+
+        fixed(5)
+
+        # @!attribute [r] packet_identifier
+        #   @return [Integer] packet identifier matching the PUBLISH packet (receive only)
+
+        variable(packet_identifier: :int16)
+
+        include AckSuccess
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/pub_rel.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+require_relative 'ack_success'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 PUBREL packet
+      #
+      # QoS 2 publish release (part 2) sent by client in response to a PUBREC packet.
+      #
+      # @see Core::Client#publish
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718053 MQTT 3.1.1 Spec §3.6
+      class PubRel
+        include Packet
+
+        fixed(6, [:reserved, 4, 0b0010])
+
+        # @!attribute [r] packet_identifier
+        #   @return [Integer] packet identifier matching the PUBREC packet (receive only)
+
+        variable(packet_identifier: :int16)
+
+        include AckSuccess
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/publish.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+require 'mqtt/core/packet/publish'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 PUBLISH packet
+      #
+      # Sent by client to publish a message to the broker, or received from broker when subscribed to a topic.
+      #
+      # @see Core::Client#publish
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718037 MQTT 3.1.1 Spec §3.3
+      class Publish
+        include Packet
+        include Core::Packet::Publish
+
+        # @!attribute [r] dup
+        #   @return [Boolean] duplicate delivery flag (managed automatically by session)
+        # @!attribute [r] qos
+        #   @return [Integer] QoS level: 0, 1, or 2 (default 0)
+        # @!attribute [r] retain
+        #   @return [Boolean] retain flag (default false)
+
+        fixed(3, :dup, [:qos, 2], :retain)
+
+        # @!attribute [r] topic_name
+        #   @return [String<UTF8>] topic name to publish to
+        # @!attribute [r] packet_identifier
+        #   @return [Integer] packet identifier for QoS 1/2 exchanges (managed automatically by session)
+
+        variable(
+          topic_name: :utf8string,
+          packet_identifier: { type: :int16, if: -> { qos.positive? } }
+        )
+
+        # @!attribute [r] payload
+        #   @return [String<Binary>] message payload
+
+        payload(payload: :remaining)
+
+        alias topic topic_name
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/sub_ack.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+
+module MQTT
+  module V3
+    module Packet
+      class SubscriptionFailed < MQTT::V3::ResponseError; end
+
+      # MQTT 3.1.1 SUBACK packet
+      #
+      # Subscription acknowledgement sent by broker in response to a SUBSCRIBE packet.
+      #
+      # @see Core::Client#subscribe
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718068 MQTT 3.1.1 Spec §3.9
+      class SubAck
+        include Packet
+
+        fixed(9)
+
+        # @!attribute [r] packet_identifier
+        #   @return [Integer] packet identifier matching the SUBSCRIBE packet (receive only)
+
+        # @!attribute [r] return_codes
+        #   @return [Array<Integer>]
+        #   return code for each subscription:
+        #
+        #   - `0x00` Granted QoS 0
+        #   - `0x01` Granted QoS 1
+        #   - `0x02` Granted QoS 2
+        #   - `0x80` Failure
+
+        variable(packet_identifier: :int16)
+        payload(return_codes: list(:int8))
+
+        RETURN_CODES = {
+          0x00 => 'Granted QoS 0',
+          0x01 => 'Granted QoS 1',
+          0x02 => 'Granted QoS 2',
+          0x80 => 'Failure'
+        }.freeze
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/subscribe.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+require 'mqtt/core/packet/subscribe'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 SUBSCRIBE packet
+      #
+      # Sent by client to subscribe to one or more topic filters.
+      #
+      # @see Core::Client#subscribe
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718063 MQTT 3.1.1 Spec §3.8
+      class Subscribe
+        include Packet
+
+        fixed(8, [:reserved, 4, 0b0010])
+
+        # @!attribute [r] packet_identifier
+        #   @return [Integer] packet identifier for matching with SUBACK (managed automatically by session)
+
+        # @!parse
+        #   class TopicFilter
+        #     # @!attribute [r] topic_filter
+        #     #   @return [String<UTF8>] topic filter pattern
+        #     # @!attribute [r] requested_qos
+        #     #   @return [Integer] maximum QoS level accepted by the client: 0, 1, or 2
+        #   end
+
+        # @!attribute [r] topic_filters
+        #   @return [Array<TopicFilter>] list of topic filters to subscribe to
+
+        variable(packet_identifier: :int16)
+        payload(
+          topic_filters: list(
+            :topic_filter,
+            topic_filter: :utf8string,
+            subscription_options: flags(
+              [:reserved, 6],
+              [:requested_qos, 2]
+            )
+          ) do
+            alias_method :max_qos, :requested_qos
+          end
+        )
+
+        MAX_QOS_FIELD = :requested_qos
+        include MQTT::Core::Packet::Subscribe
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/unsub_ack.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+require_relative 'ack_success'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 UNSUBACK packet
+      #
+      # Unsubscribe acknowledgement sent by broker in response to an UNSUBSCRIBE packet.
+      #
+      # @see Core::Client::Subscription#unsubscribe
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718077 MQTT 3.1.1 Spec §3.11
+      class UnsubAck
+        include Packet
+
+        fixed(11)
+
+        # @!attribute [r] packet_identifier
+        #   @return [Integer] packet identifier matching the UNSUBSCRIBE packet (receive only)
+
+        variable(packet_identifier: :int16)
+
+        include AckSuccess
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet/unsubscribe.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../packet'
+require 'mqtt/core/packet/unsubscribe'
+
+module MQTT
+  module V3
+    module Packet
+      # MQTT 3.1.1 UNSUBSCRIBE packet
+      #
+      # Sent by client to unsubscribe from one or more topic filters.
+      #
+      # @see Core::Client::Subscription#unsubscribe
+      # @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718072 MQTT 3.1.1 Spec §3.10
+      class Unsubscribe
+        include Packet
+        include Core::Packet::Unsubscribe
+
+        fixed(10, [:reserved, 4, 0b0010])
+
+        # @!attribute [r] packet_identifier
+        #   @return [Integer] packet identifier for matching with UNSUBACK (managed automatically by session)
+
+        # @!attribute [r] topic_filters
+        #   @return [Array<String<UTF8>>] list of topic filters to unsubscribe from
+
+        variable(packet_identifier: :int16)
+        payload(topic_filters: list(:utf8string))
+
+        alias unsubscribed_topic_filters topic_filters
+
+        # @!visibility private
+        def success!(_unsuback)
+          self
+        end
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packet.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'mqtt/core/packet'
+require_relative 'version'
+require_relative 'errors'
+
+module MQTT
+  module V3
+    # MQTT 5.0 base packet definition
+    #
+    # Inherited constants (referenced via self:: in {MQTT::Core::Packet}
+    module Packet
+      VALUE_TYPES = {
+        utf8string: MQTT::Core::Type::UTF8String,
+        binary: MQTT::Core::Type::Binary,
+        remaining: MQTT::Core::Type::Remaining,
+        int8: MQTT::Core::Type::Int8,
+        int16: MQTT::Core::Type::Int16,
+        int32: MQTT::Core::Type::Int32,
+        intvar: MQTT::Core::Type::VarInt,
+        varint: MQTT::Core::Type::VarInt,
+        boolean: MQTT::Core::Type::BooleanByte
+      }.freeze
+
+      PROPERTY_TYPES = [].freeze
+
+      # rubocop:disable Style/MutableConstant
+      PACKET_TYPES = {}
+      # rubocop:enable Style/MutableConstant
+
+      extend MQTT::Core::Packet::ModuleMethods
+
+      def self.included(mod)
+        mod.include(MQTT::Core::Packet)
+      end
+    end
+  end
+end

data/lib/mqtt/v3/packets.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# MQTT 5.0
+module MQTT
+  # MQTT 3.1.1 protocol implementation
+  module V3
+    require_relative 'packet/connect'
+    require_relative 'packet/connack'
+    require_relative 'packet/disconnect'
+    require_relative 'packet/ping_req'
+    require_relative 'packet/ping_resp'
+    require_relative 'packet/publish'
+    require_relative 'packet/pub_ack'
+    require_relative 'packet/pub_rec'
+    require_relative 'packet/pub_rel'
+    require_relative 'packet/pub_comp'
+    require_relative 'packet/subscribe'
+    require_relative 'packet/sub_ack'
+    require_relative 'packet/unsubscribe'
+    require_relative 'packet/unsub_ack'
+
+    MQTT::V3::Packet::PACKET_TYPES.freeze
+  end
+end

data/lib/mqtt/v3/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'mqtt/version'
+
+module MQTT
+  module V3
+    VERSION = MQTT::VERSION
+    MQTT_VERSION = Gem::Version.new('3.1.1')
+    PROTOCOL_VERSION = 0x04
+  end
+end

data/lib/mqtt/v3.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'v3/version'
+require_relative 'v3/client'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: mqtt-v3
+version: !ruby/object:Gem::Version
+  version: 0.0.1.ci.release
+platform: ruby
+authors:
+- Grant Gardner
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mqtt-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MQTT version 3.1.1 protocol implementation
+email:
+- grant@lastweekend.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mqtt/v3.rb
+- lib/mqtt/v3/async/client.rb
+- lib/mqtt/v3/client.rb
+- lib/mqtt/v3/client/connection.rb
+- lib/mqtt/v3/client/session.rb
+- lib/mqtt/v3/errors.rb
+- lib/mqtt/v3/packet.rb
+- lib/mqtt/v3/packet/ack_success.rb
+- lib/mqtt/v3/packet/connack.rb
+- lib/mqtt/v3/packet/connect.rb
+- lib/mqtt/v3/packet/disconnect.rb
+- lib/mqtt/v3/packet/ping_req.rb
+- lib/mqtt/v3/packet/ping_resp.rb
+- lib/mqtt/v3/packet/pub_ack.rb
+- lib/mqtt/v3/packet/pub_comp.rb
+- lib/mqtt/v3/packet/pub_rec.rb
+- lib/mqtt/v3/packet/pub_rel.rb
+- lib/mqtt/v3/packet/publish.rb
+- lib/mqtt/v3/packet/sub_ack.rb
+- lib/mqtt/v3/packet/subscribe.rb
+- lib/mqtt/v3/packet/unsub_ack.rb
+- lib/mqtt/v3/packet/unsubscribe.rb
+- lib/mqtt/v3/packets.rb
+- lib/mqtt/v3/version.rb
+licenses:
+- MIT
+metadata:
+  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: Ruby MQTT 3.1.1
+test_files: []