mqtt-ccutrer 1.0.0

data/lib/mqtt/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MQTT
+  # The version number of the MQTT gem
+  VERSION = '1.0.0'
+end

data/spec/zz_client_integration_spec.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'mqtt'
+require 'fake_server'
+
+describe 'a client talking to a server' do
+  before do
+    @error_log = StringIO.new
+    @server = MQTT::FakeServer.new
+    @server.just_one_connection = true
+    @server.respond_to_pings = true
+    @server.logger = Logger.new(@error_log)
+    @server.logger.level = Logger::WARN
+    @server.start
+
+    @client = MQTT::Client.new(@server.address, @server.port)
+  end
+
+  after do
+    @client.disconnect
+    @server.stop
+  end
+
+  context 'connecting and publishing a packet' do
+    def connect_and_publish(**kwargs)
+      @client.connect
+
+      @client.publish('test', 'foobar', **kwargs)
+      @client.flush
+      @client.disconnect
+      @server.thread.join(1)
+    end
+
+    it 'the server should have received a packet' do
+      connect_and_publish
+      expect(@server.last_publish).not_to be_nil
+    end
+
+    it 'the server should have received the correct topic' do
+      connect_and_publish
+      expect(@server.last_publish.topic).to eq('test')
+    end
+
+    it 'the server should have received the correct payload' do
+      connect_and_publish
+      expect(@server.last_publish.payload).to eq('foobar')
+    end
+
+    it 'the server should not report any errors' do
+      connect_and_publish
+      expect(@error_log.string).to be_empty
+    end
+
+    context 'with qos > 0' do
+      it 'the server should have received a packet without timeout' do
+        connect_and_publish(qos: 1)
+        expect(@server.last_publish).not_to be_nil
+      end
+    end
+  end
+
+  context 'connecting, subscribing to a topic and getting a packet' do
+    def connect_and_subscribe
+      @client.connect
+      @client.subscribe('test', 'foobar')
+      @packet = @client.get
+      @client.disconnect
+    end
+
+    it 'the client should have received the correct data' do
+      connect_and_subscribe
+      expect(@packet).not_to be_nil
+      expect(@packet.topic).to eq('test')
+      expect(@packet.payload).to eq('hello test')
+    end
+
+    it 'the server should not report any errors' do
+      connect_and_subscribe
+      expect(@error_log.string).to be_empty
+    end
+  end
+
+  context 'sends pings when idle' do
+    def connect_and_ping(keep_alive)
+      @client.keep_alive = keep_alive
+      @client.connect
+      @server.thread.join(2)
+      @client.disconnect
+    end
+
+    context 'when keep-alive=1' do
+      it 'the server should have received at least one ping' do
+        connect_and_ping(1)
+        expect(@server.pings_received).to be >= 1
+      end
+
+      it 'the server should not report any errors' do
+        connect_and_ping(1)
+        expect(@error_log.string).to be_empty
+      end
+    end
+
+    context 'when keep-alive=0' do
+      it 'the server should not receive any pings' do
+        connect_and_ping(0)
+        expect(@server.pings_received).to eq(0)
+      end
+
+      it 'the server should not report any errors' do
+        connect_and_ping(0)
+        expect(@error_log.string).to be_empty
+      end
+    end
+  end
+
+  context 'detects server not sending ping responses' do
+    before do
+      @server.respond_to_pings = false
+      @client.keep_alive = 1
+      @client.ack_timeout = 0.5
+    end
+
+    it 'the server should have received at least one ping' do
+      @client.reconnect_limit = 0
+      @client.connect
+      expect { @client.get }.to raise_error(MQTT::KeepAliveTimeout)
+      expect(@server.pings_received).to eq 1
+    end
+
+    it 'reconnects on idle timeout' do
+      @server.just_one_connection = false
+
+      reconnect_count = 0
+      @client.on_reconnect do
+        reconnect_count += 1
+      end
+      @client.connect
+      # it should reconnect after 1.5s
+      sleep 2
+      @client.disconnect
+      expect(reconnect_count).to eq 1
+    ensure
+      @server.stop
+    end
+
+    it "backs off if can't immediately reconnect" do
+      @client.reconnect_limit = 3
+
+      @client.connect
+
+      expect(TCPSocket).to receive(:new).exactly(3).times.and_raise('fail')
+
+      expect(@client).to receive(:sleep).with(5)
+      expect(@client).to receive(:sleep).with(25)
+
+      # the original error is returned
+      expect { @client.get }.to raise_error(MQTT::KeepAliveTimeout)
+    ensure
+      @server.stop
+    end
+
+    it 'includes the connack packet in on_reconnect callback' do
+      @server.just_one_connection = false
+
+      reconnect_count = 0
+      @client.on_reconnect do |connack|
+        expect(connack).to be_a(MQTT::Packet::Connack)
+        reconnect_count += 1
+      end
+      @client.connect
+      # it should reconnect after 1.5s
+      sleep 2
+      @client.disconnect
+      expect(reconnect_count).to eq 1
+    ensure
+      @server.stop
+    end
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: mqtt-ccutrer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: |2
+    Pure Ruby gem that implements the MQTT protocol, a lightweight protocol for
+    publish/subscribe messaging.
+email: cody@cutrer.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- NEWS.md
+- README.md
+- lib/mqtt-ccutrer.rb
+- lib/mqtt.rb
+- lib/mqtt/client.rb
+- lib/mqtt/packet.rb
+- lib/mqtt/proxy.rb
+- lib/mqtt/sn/packet.rb
+- lib/mqtt/version.rb
+- spec/zz_client_integration_spec.rb
+homepage: http://github.com/ccutrer/ruby-mqtt
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Implementation of the MQTT protocol
+test_files:
+- spec/zz_client_integration_spec.rb