mqtt_pipe 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f579008e0f69a4f8dd375038f2b611d39e82ec07
-  data.tar.gz: 4b54e9845ad534d37b6f954028f5c6d9e3bcd83b
+  metadata.gz: 9eb995dda9d228f1276dd94091d8e4e243eeae66
+  data.tar.gz: 54dbf42a2f536c7865cd3c529489ea34fccf7f1a
 SHA512:
-  metadata.gz: 1ded3c38efb21c73ecb8ac1cb2455cb1dc206e7e6273101fd26672e1c914143748e37862f39e311a79aed4a2fe3b7a2879f48586029d9ac2c96b271f8bd31e68
-  data.tar.gz: 249ded44ccac0db4e6f66372f242b99ea9d4c205fc245fe62c4b0233328ceebcfa9536450542dbf72a8af750754fdbf6a38bb648431b792ca24c4c18cf9df50b
+  metadata.gz: 8f23a64abaf8a1db9a9288b8a93367b8b5552e46c0b30645eb0bb4fdb5d9aa5a27f4f10dde32ce2ff5a2a7ee4483a69387e6b0293ff38a0548e82048283752e6
+  data.tar.gz: 31e0b5d28c07cc7d3b44b701dec0160559b88a7ea7a80ef6cc79127838ab5fcf26b609494f62f026e4e16b4beeed0d5c4031f2b09d266b2e818d795500181b6e

data/README.md

@@ -41,7 +41,7 @@ MQTTPipe.create do
 end
 ```
 
-Everything does not need to be contained in a block:
+Or without the block:
 
 ```ruby
 pipe = MQTTPipe.create
@@ -57,6 +57,7 @@ pipe.open 'test.mosquitto.org', port: 1883 do
 end
 ```
 
+
 ## Protocol
 
 Taking inspiration from the excellent [MessagePack](http://msgpack.org) project each data type is represented by a byte value, or in same cases a range of values. The currently supported data types along with their byte values are:
@@ -88,15 +89,17 @@ Note that the integers are split over several codes to accommodate for the vario
 
 Array and string are also special cases in that their sizes are not known. They require a length value to be passed along with them, but instead of always including an extra byte for that purpose, length smaller than 32 can be encoded directly in the type byte value. An example is shown below:
 
-#### Strings with length 1..31:
+Strings with length 1..31:
 
     'test' -> [0xA0 + 4, 0x74, 0x65, 0x73, 0x74]
 
-#### Strings with length 32..288
+Strings with length 32..288
     
     'testing how really long strings are encoded'
            -> [0xA0, 43 - 32, 0x74, 0x65, 0x73, ...]
 
+**Note that both strings and arrays with length 0 are converted to and sent as `nil`.**
+
 Some data types that may be supported in the future are:
 
   - IP Addresses

data/examples/receiver.rb

@@ -5,5 +5,5 @@ pipe = MQTTPipe.create do
     p message, id
   end
   
-  open 'test.mosquitto.org', port: 1883
+  open 'localhost', port: 1883
 end

data/examples/sender.rb

@@ -6,7 +6,7 @@ pipe.on 'hello/world/5' do
   puts 'received 5'
 end
 
-pipe.open 'test.mosquitto.org', port: 1883 do
+pipe.open 'localhost', port: 1883 do
   counter = 0
   loop do
     send 'hello/world/' + counter.to_s, Time.now

data/lib/mqtt_pipe/listener.rb

@@ -6,7 +6,7 @@ module MQTTPipe
   # given string as well as calling the action.
   
   class Listener
-    attr_reader :topic, :pattern
+    attr_reader :topic, :pattern, :action
     
     ##
     # The listener requires a topic string and a callable 
@@ -20,7 +20,7 @@ module MQTTPipe
       @topic = topic
       @action = action
       
-      pattern = topic.gsub('*', '([^/]+)').gsub('/#', '/?(.*)')
+      pattern = topic.gsub('*', '([^/]+)').gsub('/#', '/?(.*)').gsub('#', '(.*)')
       @pattern = %r{^#{pattern}$}
     end
     

data/lib/mqtt_pipe/packer.rb

@@ -64,7 +64,7 @@ module MQTTPipe
     # the original values.
     
     def unpack raw, limit: nil
-      raw = StringIO.new raw unless raw.respond_to? :read
+      raw = ::StringIO.new raw unless raw.respond_to? :read
       result = []
       
       # Either loop infinately or the number of times 

data/lib/mqtt_pipe/pipe.rb

@@ -6,7 +6,7 @@ module MQTTPipe
   class Pipe
     
     ##
-    # Raised when the connection unexpectedly lost.
+    # Raised when the connection is broken
     
     class ConnectionError < StandardError; end
     
@@ -14,7 +14,9 @@ module MQTTPipe
     # Create a new pipe and optionally yield to a block
     
     def initialize &block
-      @listeners = []      
+      @listeners = []
+      @error_handler = nil
+      
       instance_eval &block unless block.nil?
     end
     
@@ -35,6 +37,10 @@ module MQTTPipe
       on '#', &action
     end
     
+    def on_error &action
+      @error_handler = action
+    end
+    
     alias_method :on_everything, :on_anything
     
     def topics
@@ -45,54 +51,57 @@ module MQTTPipe
     # Open the pipe
     
     def open host, port: 1883, &block
-      MQTT::Client.connect host: host, port: port do |client|
+      listener_thread = nil
+      client = MQTT::Client.connect host: host, port: port
+      context = Context.new client
   
-        # Subscribe
-        listener_thread = nil
-        
-        unless @listeners.empty?
-          listener_thread = Thread.new do
-            client.get do |topic, data|
-              begin
-                unpacked_data = Packer.unpack data
-                
-                @listeners.each do |listener|
-                  if m = listener.match(topic)
-                    listener.call unpacked_data, *m
-                  end
+      unless @listeners.empty?
+        listener_thread = Thread.new(Thread.current) do |parent|          
+          client.get do |topic, data|
+            begin
+              unpacked_data = Packer.unpack data
+              
+              @listeners.each do |listener|
+                if m = listener.match(topic)
+                  #listener.call unpacked_data, *m
+                  context.instance_exec unpacked_data, *m, &listener.action
                 end
-                
-              rescue Packer::FormatError
-                # TODO: Handle more gracefully
-                puts 'Could not parse data!'
-                next
               end
+              
+            rescue Packer::FormatError
+              @error_handler.call topic, data unless @error_handler.nil?
+              next
+              
+            # Raise the exception in the parent thread
+            rescue Exception => e
+              parent.raise e
             end
           end
-          
-          client.subscribe *topics
         end
-                  
-        unless block.nil?
-          context = Context.new client
-          
-          begin
-            context.instance_eval &block
-          rescue ConnectionError
-            
-            puts 'Need to reconnect'
-          rescue Interrupt
-          ensure
-            listener_thread.exit unless topics.empty?
-          end
         
-        else
-          begin
-            listener_thread.join unless topics.empty?
-          rescue Interrupt
-          end
+        client.subscribe *topics
+      end
+      
+      # Call user block
+      unless block.nil?
+        begin
+          context.instance_eval &block
+        rescue ConnectionError
+          puts 'TODO: Handle reconnect'
+        rescue Interrupt
+          exit
         end
       end
+      
+      # Join with listener thread
+      begin
+        listener_thread.join unless listener_thread.nil?
+      rescue Interrupt
+      end
+      
+    ensure
+      client.disconnect
+      listener_thread.exit unless listener_thread.nil?
     end
     
     private

data/lib/mqtt_pipe/types/color.rb

@@ -13,5 +13,14 @@ module MQTTPipe
         [PACKER_CODE, r, g, b].pack 'C4'
       end
     end
+    
+    class << Color
+      def from_packed _, raw
+        color = 3.times.map do
+          Packer.read_packed_bytes(1, from: raw, as: 'C')
+        end
+        new *color
+      end
+    end
   end
 end

data/lib/mqtt_pipe/version.rb

@@ -1,3 +1,3 @@
 module MQTTPipe
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end 

data/spec/listener_spec.rb

@@ -3,6 +3,7 @@ require 'mqtt_pipe'
 describe MQTTPipe::Listener do
   let(:klass) { MQTTPipe::Listener }
   let(:topic)              { 'test/*/topic/#' }
+  let(:topic_pattern)       { %r{^test/([^/]+)/topic/?(.*)$} }
   let(:matching_topic_1)   { 'test/some/topic' }
   let(:matching_topic_2)   { 'test/some/topic/with/more/5' }
   let(:non_matching_topic) { 'test/topic/with/8' }
@@ -31,6 +32,7 @@ describe MQTTPipe::Listener do
         pattern = @listener.pattern
         
         expect(pattern).to be_a(Regexp)
+        expect(pattern).to eq topic_pattern
         expect(pattern === topic).to be true
       end
       
@@ -82,6 +84,5 @@ describe MQTTPipe::Listener do
         expect(@listener.run 42).to eq 84
       end
     end
-    
   end
 end

data/spec/pipe_spec.rb

@@ -35,6 +35,9 @@ describe MQTTPipe::Pipe do
       end
     end
     
+    describe '#on_error' do
+    end
+    
     describe '#topics' do
       it 'stores the topics that have beed subscribed to' do
         expect(@pipe.topics.empty?).to be true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqtt_pipe
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sebastian Lindberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt