qubitro-mqtt 0.0.1

data/spec/mqtt_version_spec.rb

@@ -0,0 +1,23 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'spec_helper'
+require 'qubitro-mqtt'
+
+describe MQTT do
+
+  describe "version number" do
+    it "should be defined as a constant" do
+      expect(defined?(MQTT::VERSION)).to eq('constant')
+    end
+
+    it "should be a string" do
+      expect(MQTT::VERSION).to be_a(String)
+    end
+
+    it "should be in the format x.y.z" do
+      expect(MQTT::VERSION).to match(/^\d{1,2}\.\d{1,2}\.\d{1,2}$/)
+    end
+
+  end
+
+end

data/spec/zz_client_integration_spec.rb

@@ -0,0 +1,177 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'spec_helper'
+require 'qubitro-mqtt'
+require 'fake_server'
+
+describe "a client talking to a server" do
+
+  before(:each) 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(:each) do
+    @client.disconnect
+    @server.stop
+  end
+
+  context "connecting and publishing a packet" do
+    def connect_and_publish(options = {})
+      @client.connect
+
+      retain = options.fetch(:retain) { false }
+      qos = options.fetch(:qos) { 0 }
+
+      @client.publish('test', 'foobar', retain, qos)
+      @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 message" do
+    def connect_and_subscribe
+      @client.connect
+      @client.subscribe('test')
+      @topic, @message = @client.get
+      @client.disconnect
+    end
+
+    it "the client should have received the right topic name" do
+      connect_and_subscribe
+      expect(@topic).to eq('test')
+    end
+
+    it "the client should have received the right message" do
+      connect_and_subscribe
+      expect(@message).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 "connecting, subscribing to a topic and getting a packet" do
+    def connect_and_subscribe
+      @client.connect
+      @client.subscribe('test', 'foobar')
+      @packet = @client.get_packet
+      @client.disconnect
+    end
+
+    it "the client should have received a packet" do
+      connect_and_subscribe
+      expect(@packet).not_to be_nil
+    end
+
+    it "the client should have received the correct topic" do
+      connect_and_subscribe
+      expect(@packet.topic).to eq('test')
+    end
+
+    it "the client should have received the correct payload" do
+      connect_and_subscribe
+      expect(@packet.payload).to eq('hello test')
+    end
+
+    it "the client should have received a retained packet" do
+      connect_and_subscribe
+      expect(@packet.retain).to be_truthy
+    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
+    def connect_and_timeout(keep_alive)
+      @server.respond_to_pings = false
+      @client.keep_alive = keep_alive
+      @client.connect
+      sleep(keep_alive * 3)
+    end
+
+    context "when keep-alive=1" do
+      it "the server should have received at least one ping" do
+        expect {
+          connect_and_timeout(1)
+        }.to raise_error(
+          MQTT::ProtocolException,
+          'No Ping Response received for 2 seconds'
+        )
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: qubitro-mqtt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Qubitro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-24 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: 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: 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
+- !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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.0
+description: Pure Ruby gem that implements the MQTT protocol, a lightweight protocol
+  for publish/subscribe messaging.
+email: social@qubitro.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- NEWS.md
+- README.md
+- lib/qubitro-mqtt.rb
+- lib/qubitro-mqtt/client.rb
+- lib/qubitro-mqtt/packet.rb
+- lib/qubitro-mqtt/patches/string_encoding.rb
+- lib/qubitro-mqtt/proxy.rb
+- lib/qubitro-mqtt/sn/packet.rb
+- lib/qubitro-mqtt/version.rb
+- spec/mqtt_client_spec.rb
+- spec/mqtt_packet_spec.rb
+- spec/mqtt_proxy_spec.rb
+- spec/mqtt_sn_packet_spec.rb
+- spec/mqtt_version_spec.rb
+- spec/zz_client_integration_spec.rb
+homepage: https://github.com/qubitro/mqtt-client-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Implementation of the MQTT protocol
+test_files:
+- spec/mqtt_client_spec.rb
+- spec/mqtt_packet_spec.rb
+- spec/mqtt_proxy_spec.rb
+- spec/mqtt_version_spec.rb
+- spec/mqtt_sn_packet_spec.rb
+- spec/zz_client_integration_spec.rb