mqtt_pipe 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93caadb951ff60325a712d56794e4431adbcf621
+  data.tar.gz: b9a8f6b3b8a31d2925601444bad95bb054e00c5e
+SHA512:
+  metadata.gz: bf62b6c097b52d0770b64b5bf63dc299a399120a525eb4682b03a92f74d74ce3734fe6221c6008c9620774d4c3c28e009b4196d1a0492f822886fbe83b53e645
+  data.tar.gz: 9e8cf7c06b4e8a625bff2944337bbf90bb8b180f16e898d1127417a47fc34641f030baec5fb0f0e860023eed030f268bfde664a318ed4de36695843efc30e292

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mqtt_pipe.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sebastian Lindberg
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# MQTTPipe
+
+This gem wraps the [MQTT gem](https://github.com/njh/ruby-mqtt) and adds a serializer for simple data structures.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mqtt_pipe'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mqtt_pipe
+
+## Usage
+
+```ruby
+pipe = MQTTPipe.create do
+  on 'hello/world/#' do |message, id|
+    p message, id
+  end
+end
+
+pipe.open 'test.mosquitto.org', port: 1883 do
+  100.times do |i|
+    send "hello/world/#{i}", Time.now
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mqtt_pipe/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/examples/receiver.rb

@@ -0,0 +1,9 @@
+require 'mqtt_pipe'
+
+pipe = MQTTPipe.create do
+  on 'hello/world/#' do |message, id|
+    p message, id
+  end
+end
+
+pipe.open 'test.mosquitto.org', port: 1883

data/examples/sender.rb

@@ -0,0 +1,13 @@
+require 'mqtt_pipe'
+
+pipe = MQTTPipe.create
+
+pipe.open 'test.mosquitto.org', port: 1883 do
+  counter = 0
+  loop do
+    send 'hello/world/' + counter.to_s, Time.now
+    puts 'sending...'
+    counter += 1
+    sleep 1
+  end
+end

data/lib/mqtt_pipe.rb

@@ -0,0 +1,16 @@
+require 'mqtt'
+
+require 'mqtt_pipe/version'
+require 'mqtt_pipe/types'
+require 'mqtt_pipe/packer'
+require 'mqtt_pipe/config'
+require 'mqtt_pipe/listener'
+require 'mqtt_pipe/pipe'
+
+module MQTTPipe
+  extend self
+
+  def create &block
+    Pipe.new &block
+  end
+end

data/lib/mqtt_pipe/config.rb

@@ -0,0 +1,31 @@
+module MQTTPipe
+  
+  ##
+  # An instance of Config is used as the context in which
+  # the pipe is configured.
+  
+  class Config
+    attr_reader :listeners
+    
+    def initialize
+      @listeners = []
+    end
+
+    ##
+    # Subscribe to a topic and attatch an action that will
+    # be called once a message with a matching topic is 
+    # received.
+
+    def on topic, &action
+      raise ArgumentError, 'No block given' if action.nil?
+      @listeners << Listener.new(topic, &action)
+    end
+    
+    ##
+    # Subscribe to all topics
+    
+    def on_anything &action
+      on '#', &action
+    end
+  end
+end

data/lib/mqtt_pipe/listener.rb

@@ -0,0 +1,57 @@
+module MQTTPipe
+  
+  ##
+  # Used to store topics along with their actions. 
+  # Contains conveniens methods for matching the topic to a
+  # given string as well as calling the action.
+  
+  class Listener
+    attr_reader :topic, :pattern
+    
+    ##
+    # The listener requires a topic string and a callable 
+    # action to initialize.
+    #
+    # An ArgumentError is raised if no action is given
+    
+    def initialize topic, &action
+      raise ArgumentError, 'No block given' if action.nil?
+      
+      @topic = topic
+      @action = action
+      
+      pattern = topic.gsub('*', '([^/]+)').gsub('/#', '/?(.*)')
+      @pattern = %r{^#{pattern}$}
+    end
+    
+    ##
+    # Check if a given topic string matches the listener 
+    # topic.
+    #
+    # Returns an array containing any matched sections of
+    # topic, if there was a match. False otherwise.
+
+    def match topic
+      m = @pattern.match topic
+      m.nil? ? false : m.captures
+    end
+    
+    ##
+    # Returns true if the topic matches listener topic 
+    # Otherwise false.
+    
+    def === topic
+      @pattern === topic
+    end
+    
+    ##
+    # Call the listener action
+    
+    def call *args
+      #raise ArgumentError, 'No value provided' if args.empty?
+      @action.call *args
+    end
+    
+    alias_method :run, :call
+  end
+end

data/lib/mqtt_pipe/packer.rb

@@ -0,0 +1,83 @@
+module MQTTPipe
+  
+  ##
+  # The packer module is used to pack/unpack classes that
+  # supports it.
+  
+  module Packer
+    extend self
+    
+    ##
+    # Raised when the packet being unpacked is badly 
+    # formatted.
+    
+    class FormatError < StandardError; end
+    
+    ##
+    # Used to signal the end of a packet as it is being 
+    # unpacked.
+    
+    class EndOfPacket < StandardError; end
+    
+    # Use the refinements made to the supported classes
+    
+    using Types
+        
+    ##
+    # Packs the arguments acording to their type.
+    #
+    # An ArgumentError is raised if any given class does
+    # not support packing.
+    
+    def pack *values
+      values.map{|value| value.to_packed }.join
+    rescue NoMethodError
+      raise ArgumentError, 'Unknown input format'
+    end
+     
+    alias_method :[], :pack
+    
+    
+    ##
+    # Unpacks a serialized object and returns an array of
+    # the original values.
+    
+    def unpack raw, limit: nil
+      raw = StringIO.new raw unless raw.respond_to? :read
+      result = []
+      
+      # Either loop infinately or the number of times 
+      # specified by limit
+      
+      (limit.nil? ? loop : limit.times).each do
+        result << unpack_single(raw)
+      end
+      
+      return result
+    rescue EndOfPacket
+      return result
+    end
+    
+    ##
+    # A simple helper method to read a given number of bytes
+    # +from+ IO object and format them +as+ anything 
+    # supported by Array#unpack.
+    
+    def read_packed_bytes n = 1, from:, as: 'C'
+      raw = from.read(n)
+      raise FormatError if raw.nil? or raw.length != n
+      
+      raw.unpack(as).first
+    end
+    
+    private
+    
+    def unpack_single raw
+      code = raw.read 1
+      raise EndOfPacket if code.nil?
+      
+      type = code.unpack(?C).first
+      Types::Type.lookup(type).from_packed type, raw
+    end
+  end
+end

data/lib/mqtt_pipe/pipe.rb

@@ -0,0 +1,88 @@
+module MQTTPipe
+  
+  ##
+  # The actual wrapper class for MQTT
+  
+  class Pipe
+    
+    ##
+    # Raised when the connection unexpectedly lost.
+    
+    class ConnectionError < StandardError; end
+    
+    
+    def initialize &block      
+      @config = Config.new  
+      @config.instance_eval &block unless block.nil?
+    end
+    
+    ##
+    # Open the pipe
+    
+    def open host, port: 1883, &block
+      MQTT::Client.connect host: host, port: port do |client|
+  
+        # Subscribe
+        topics = @config.listeners.map{|listener| listener.topic }
+        listener_thread = nil
+        
+        unless topics.empty?
+          listener_thread = Thread.new do
+            client.get do |topic, data|
+              begin
+                unpacked_data = Packer.unpack data
+                
+                @config.listeners.each do |listener|
+                  if m = listener.match(topic)
+                    listener.call unpacked_data, *m
+                  end
+                end
+                
+              rescue Packer::FormatError
+                # TODO: Handle more gracefully
+                puts 'Could not parse data!'
+                next
+              end
+            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
+        end
+      end
+    end
+    
+    private
+    
+    class Context
+      def initialize client
+        @client = client
+      end
+      
+      def send topic, *data
+        raise ConnectionError unless @client.connected?
+        @client.publish topic, Packer.pack(*data)
+      end
+    end
+  end
+end
+

data/lib/mqtt_pipe/types.rb

@@ -0,0 +1,11 @@
+require_relative 'types/string'
+require_relative 'types/nil'
+require_relative 'types/false'
+require_relative 'types/true'
+require_relative 'types/integer'
+require_relative 'types/float'
+require_relative 'types/time'
+require_relative 'types/color'
+require_relative 'types/array'
+require_relative 'types/class'
+require_relative 'types/type'

data/lib/mqtt_pipe/types/array.rb

@@ -0,0 +1,36 @@
+module MQTTPipe
+  module Types
+    refine Array.singleton_class do
+      def packer_code; 0x80; end
+      
+      def from_packed type, raw
+        length = if type == packer_code 
+          Packer.read_packed_bytes(1, from: raw) + 31
+        else
+          type - packer_code
+        end
+        
+        array = Packer.unpack raw, limit: length
+        raise Packer::FormatError, 'Badly formatted array' unless array.length == length
+        
+        return array
+      end
+    end
+
+    refine Array do
+      def to_packed
+        header = case length
+        when 0 then return nil.to_packed
+        when 1..31
+          [self.class.packer_code + length].pack(?C)
+        when 32..288
+          [self.class.packer_code, length - 31].pack('C2')
+        else
+          raise ArgumentError, 'Array is too long'
+        end
+        
+        header + map{|v| v.to_packed }.join
+      end
+    end
+  end
+end

data/lib/mqtt_pipe/types/class.rb

@@ -0,0 +1,9 @@
+module MQTTPipe
+  module Types    
+    refine Class do
+      def to_packed
+        [Type.packer_code, self.packer_code].pack 'C2'
+      end 
+    end
+  end
+end

data/lib/mqtt_pipe/types/color.rb

@@ -0,0 +1,17 @@
+module MQTTPipe
+  module Types
+    class Color
+      PACKER_CODE = 0xC9
+      
+      attr_reader :r, :g, :b
+      
+      def initialize r, g, b
+        @r, @g, @b = r, g, b
+      end
+      
+      def to_packed
+        [PACKER_CODE, r, g, b].pack 'C4'
+      end
+    end
+  end
+end

data/lib/mqtt_pipe/types/false.rb

@@ -0,0 +1,17 @@
+module MQTTPipe
+  module Types
+    refine FalseClass.singleton_class do
+      def packer_code; 0xC2; end
+      
+      def from_packed type, _
+        type == packer_code ? false : true
+      end
+    end
+
+    refine FalseClass do
+      def to_packed
+        [self.class.packer_code].pack ?C
+      end
+    end
+  end
+end

data/lib/mqtt_pipe/types/float.rb

@@ -0,0 +1,17 @@
+module MQTTPipe
+  module Types
+    refine Float.singleton_class do
+      def packer_code; 0xC7; end
+      
+      def from_packed _, raw
+        Packer.read_packed_bytes 4, from: raw, as: 'e'
+      end
+    end
+
+    refine Float do
+      def to_packed
+        [self.class.packer_code, self].pack 'Ce'
+      end
+    end
+  end
+end

data/lib/mqtt_pipe/types/integer.rb

@@ -0,0 +1,39 @@
+module MQTTPipe
+  module Types
+    refine Integer.singleton_class do
+      def packer_code; 0xC4; end
+      
+      def from_packed type, raw
+        case type
+        when 0xC4
+          Packer.read_packed_bytes 1, from: raw
+        when 0xC5
+          Packer.read_packed_bytes 2, from: raw, as: 's<'
+        when 0xC6
+          Packer.read_packed_bytes 4, from: raw, as: 'l<'  
+        when 0..0x7F, 0xD0..0xFF
+          [type].pack('C').unpack('c').first
+        end
+      end
+    end
+    
+    refine Integer do
+      def to_packed
+        case self
+        when -48..127
+          [self].pack ?C
+        when 0..255
+          [self.class.packer_code, self].pack 'C2'
+        when -32_768..32_767
+          [self.class.packer_code + 1, self].pack 'Cs<'
+        when -2_147_483_648..2_147_483_647
+          [self.class.packer_code + 2, self].pack 'Cl<'
+        else
+          raise ArgumentError, 'Integer is larger than 32 bit signed'
+        end
+      end
+      
+      
+    end
+  end
+end

data/lib/mqtt_pipe/types/nil.rb

@@ -0,0 +1,17 @@
+module MQTTPipe
+  module Types
+    refine NilClass.singleton_class do
+      def packer_code; 0xC1; end
+      
+      def from_packed _, _
+        return nil
+      end
+    end
+    
+    refine NilClass do
+      def to_packed
+        [self.class.packer_code].pack ?C
+      end
+    end
+  end
+end

data/lib/mqtt_pipe/types/string.rb

@@ -0,0 +1,30 @@
+module MQTTPipe
+  module Types
+    refine String.singleton_class do
+      def packer_code; 0xA0; end
+      
+      def from_packed type, raw
+        length = if type == packer_code
+          Packer.read_packed_bytes(1, from: raw) + 31
+        else
+          type - packer_code
+        end
+        Packer.read_packed_bytes length, from: raw, as: 'A*'
+      end
+    end
+    
+    refine String do
+      def to_packed
+        case length
+        when 0 then return nil.to_packed
+        when 1..31
+          [self.class.packer_code + length, self].pack('CA*')
+        when 32..288
+          [self.class.packer_code, length - 31, self].pack('C2A*')
+        else
+          raise ArgumentError, 'String is too long'
+        end
+      end
+    end
+  end
+end

data/lib/mqtt_pipe/types/time.rb

@@ -0,0 +1,17 @@
+module MQTTPipe
+  module Types
+    refine Time.singleton_class do
+      def packer_code; 0xC8; end
+      
+      def from_packed _, raw
+        at(Packer.read_packed_bytes 4, from: raw, as: 'L<')
+      end
+    end
+
+    refine Time do
+      def to_packed
+        [self.class.packer_code, to_i].pack 'CL<'
+      end
+    end
+  end
+end

data/lib/mqtt_pipe/types/true.rb

@@ -0,0 +1,17 @@
+module MQTTPipe
+  module Types
+    refine TrueClass.singleton_class do
+      def packer_code; 0xC2; end
+      
+      def from_packed type, _
+        type == packer_code ? false : true
+      end
+    end
+
+    refine TrueClass do
+      def to_packed
+        [self.class.packer_code + 1].pack ?C
+      end
+    end
+  end
+end

data/lib/mqtt_pipe/types/type.rb

@@ -0,0 +1,36 @@
+module MQTTPipe
+  module Types
+    module Type
+      extend self
+      
+      def packer_code
+        0xC0
+      end
+
+      def to_packed
+        [packer_code, packer_code].pack 'C2'
+      end
+      
+      def lookup type
+        case type
+        when 0x80..0x9F then Array
+        when 0xA0..0xBF then String
+        when 0xC0       then Type          
+        when 0xC1       then NilClass
+        when 0xC2       then FalseClass
+        when 0xC3       then TrueClass
+        when 0xC7       then Float
+        when 0xC8       then Time
+        when 0xC9       then Color
+        when 0x00..0x7F,
+             0xD0..0xFF,
+             0xC4..0xC6 then Integer
+        end
+      end
+      
+      def from_packed _, raw
+        lookup(Packer.read_packed_bytes 1, from: raw)
+      end
+    end
+  end
+end

data/lib/mqtt_pipe/version.rb

@@ -0,0 +1,3 @@
+module MQTTPipe
+  VERSION = "0.0.1"
+end

data/mqtt_pipe.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mqtt_pipe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mqtt_pipe"
+  spec.version       = MQTTPipe::VERSION
+  spec.authors       = ["Sebastian Lindberg"]
+  spec.email         = ["seb.lindberg@gmail.com"]
+  spec.summary       = %q{A gem for sending a small set of objects via MQTT.}
+  spec.description   = %q{This gem wraps the MQTT gem by njh (on Github) and adds a serializer for simple data structures.}
+  spec.homepage      = "https://github.com/seblindberg/ruby-mqtt-pipe"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mqtt", "~> 0.3"
+  
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

data/spec/config_spec.rb

@@ -0,0 +1,27 @@
+require 'mqtt_pipe'
+
+describe MQTTPipe::Config do
+  let(:klass) { MQTTPipe::Config }
+  
+  before :each do 
+    @config = klass.new
+  end
+    
+  describe '#on' do    
+    it 'requires one argument and a block' do
+      expect{@config.on}.to raise_error(ArgumentError)
+      expect{@config.on 'test'}.to raise_error(ArgumentError)
+      expect{@config.on('test') {}}.not_to raise_error
+    end
+    
+    it 'stores the listener' do
+      expect(@config.listeners.length).to eq(0)
+      
+      @config.on('test') {}
+      
+      expect(@config.listeners.length).to eq(1)
+    end
+  end
+
+
+end

data/spec/listener_spec.rb

@@ -0,0 +1,87 @@
+require 'mqtt_pipe'
+
+describe MQTTPipe::Listener do
+  let(:klass) { MQTTPipe::Listener }
+  let(:topic)              { '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' }
+
+  describe '#new' do    
+    it 'expects a topic and an action block' do
+      expect{klass.new}.to raise_error(ArgumentError)
+      expect{klass.new topic}.to raise_error(ArgumentError)
+      expect{klass.new(topic) {}}.not_to raise_error
+    end
+  end
+  
+  context 'Using the listener' do
+    before :each do
+      @listener = klass.new(topic) {|value, captures = 2| value * captures.to_i }
+    end
+    
+    describe '#topic' do    
+      it 'returns the topic' do
+        expect(@listener.topic).to eq topic
+      end
+    end
+  
+    describe '#pattern' do    
+      it 'returns a regular expression mathing the pattern' do
+        pattern = @listener.pattern
+        
+        expect(pattern).to be_a(Regexp)
+        expect(pattern === topic).to be true
+      end
+      
+      it 'leaves lopics without wildcards as is' do
+        listener = klass.new('test/of') {}
+        expect(listener.pattern === 'test/of').to be_truthy
+        expect(listener.pattern).to eq %r{^test/of$}
+      end
+    end
+    
+    describe '#match' do
+      it 'requires one argument' do
+        expect{@listener.match}.to raise_error ArgumentError
+      end
+      
+      it 'returns true for a matching topic' do
+        expect(@listener.match matching_topic_1).to be_truthy
+        expect(@listener.match matching_topic_2).to be_truthy
+      end
+      
+      it 'returns nil for a non matching topic' do
+        expect(@listener.match non_matching_topic).to be false
+      end
+      
+      it 'also responds to #===' do
+        expect(@listener === matching_topic_1).to be true
+        expect(@listener === non_matching_topic).to be false
+      end
+      
+      it 'captures wildcard match groups' do
+        m = @listener.match matching_topic_2
+        
+        expect(m).not_to be false
+        expect(m[0]).to eq 'some'
+        expect(m[1]).to eq 'with/more/5'
+      end
+    end
+    
+    describe '#call' do      
+      it 'runs the given callback' do
+        expect(@listener.call 42).to eq 84
+      end
+      
+      it 'accepts an optional second argument' do
+        expect(@listener.call 12, 3).to eq 12*3
+      end
+      
+      it 'also responds to #run' do
+        expect(@listener.run 42).to eq 84
+      end
+    end
+    
+  end
+end

data/spec/packer_spec.rb

@@ -0,0 +1,264 @@
+require 'mqtt_pipe'
+
+describe MQTTPipe::Packer do
+  let(:klass) { MQTTPipe::Packer }
+  
+  describe '#pack/#[]' do
+    describe 'Array' do
+      it 'serializes empty arrays to nil' do
+        expect(klass[[]]).to eq [0xC1].pack('C')
+      end
+      
+      it 'serializes short arrays' do
+        arr = (0..4).to_a
+        expect(klass[arr]).to eq [0x85, 0, 1, 2, 3, 4].pack('C*')
+      end
+      
+      it 'serializes long arrays' do
+        arr = (1..100).to_a
+        expect(klass[arr].length).to be 102
+      end
+    end
+    
+    describe 'String' do
+      it 'serializes empty strings to nil' do
+        expect(klass['']).to eq [0xC1].pack('C')
+      end
+      
+      it 'serializes short strings' do
+        expect{klass['string']}.not_to raise_error
+        expect(klass['string']).to eq [0xA6, 'string'].pack('CA*')
+      end
+      
+      it 'serializes long strings' do
+        long_string = '*' * 33
+        expect(klass[long_string]).to eq [0xA0, long_string.length - 31, long_string].pack('C2A*')
+      end
+      
+      it 'does not serialize string longer than 288 chars' do
+        too_long_string = '*' * 289
+        expect{klass[too_long_string]}.to raise_error ArgumentError
+      end
+    end
+    
+    describe 'Type' do
+      it 'serializes classes' do
+        expect(klass[MQTTPipe::Types::Type]).to eq [0xC0, 0xC0].pack('C2')
+        
+        expect(klass[NilClass]).to eq [0xC0, 0xC1].pack('C2')
+        
+        expect(klass[FalseClass]).to eq [0xC0, 0xC2].pack('C2')
+        expect(klass[TrueClass]).to eq [0xC0, 0xC2].pack('C2')
+        
+        expect(klass[Array]).to eq [0xC0, 0x80].pack('C2')
+        expect(klass[String]).to eq [0xC0, 0xA0].pack('C2')
+        
+        expect(klass[Fixnum]).to eq [0xC0, 0xC4].pack('C2')
+        expect(klass[Integer]).to eq [0xC0, 0xC4].pack('C2')
+        
+        expect(klass[Float]).to eq [0xC0, 0xC7].pack('C2')
+        expect(klass[Time]).to eq [0xC0, 0xC8].pack('C2')
+      end
+    end
+    
+    describe 'Nil' do
+      it 'serializes nil values' do
+        expect(klass[nil]).to eq [0xC1].pack(?C)
+      end
+    end
+    
+    describe 'Boolean' do
+      it 'serializes false values' do
+        expect(klass[false]).to eq [0xC2].pack(?C)
+      end
+      
+      it 'serializes true values' do
+        expect(klass[true]).to eq [0xC3].pack(?C)
+      end
+    end
+    
+    describe 'Integer' do
+      it 'serializes small integers' do
+        expect(klass[4]).to eq [4].pack(?c)
+        expect(klass[127]).to eq [127].pack(?c)
+        expect(klass[-48]).to eq [-48].pack(?c)
+      end
+      
+      it 'serializes bytes' do
+        expect(klass[128]).to eq [0xC4, 128].pack('C2')
+        expect(klass[255]).to eq [0xC4, 255].pack('C2')
+      end
+      
+      it 'serializes short integers' do
+        expect(klass[32_767]).to eq [0xC5, 32_767].pack('Cs<')
+        expect(klass[-32_768]).to eq [0xC5, -32_768].pack('Cs<')
+      end
+      
+      it 'serializes integers' do
+        expect(klass[2_147_483_647]).to eq [0xC6, 2_147_483_647].pack('Cl<')
+        expect(klass[-2_147_483_648]).to eq [0xC6, -2_147_483_648].pack('Cl<')
+      end
+      
+      it 'does not serialize integers larger than 32 bit' do
+        expect{klass[2_147_483_648]}.to raise_error ArgumentError
+        expect{klass[-2_147_483_649]}.to raise_error ArgumentError
+      end
+    end
+    
+    describe 'Float' do
+      it 'serializes 32 bit floats' do
+        expect(klass[0.2]).to eq [0xC7, 0.2].pack('Ce')
+      end
+    end
+    
+    describe 'Time' do
+      it 'serializes time' do
+        timestamp = Time.now
+        expect(klass[timestamp]).to eq [0xC8, timestamp.to_i].pack('CL<')
+      end
+    end
+  end
+  
+  
+  describe '#unpack' do
+    it 'raises an error on malformated packets' do
+      # Make the list one item longer than what is written
+      raw = [0x87, *(1..6).to_a].pack 'CC*'
+      expect{klass.unpack(raw)}.to raise_error MQTTPipe::Packer::FormatError
+      
+      # Strings
+      raw = [0xA7, 'string'].pack 'CA*'
+      expect{klass.unpack(raw)}.to raise_error MQTTPipe::Packer::FormatError
+      
+      # Integers
+      raw = [0xC4].pack 'C'
+      expect{klass.unpack(raw)}.to raise_error MQTTPipe::Packer::FormatError
+      
+      raw = [0xC5, 1].pack 'C*'
+      expect{klass.unpack(raw)}.to raise_error MQTTPipe::Packer::FormatError
+      
+      raw = [0xC6, 1,2,3].pack 'C*'
+      expect{klass.unpack(raw)}.to raise_error MQTTPipe::Packer::FormatError
+      
+      # Float
+      raw = [0xC7].pack 'C*'
+      expect{klass.unpack(raw)}.to raise_error MQTTPipe::Packer::FormatError
+      
+      # Time
+      raw = [0xC8, 1].pack 'C*'
+      expect{klass.unpack(raw)}.to raise_error MQTTPipe::Packer::FormatError
+    end
+    
+    describe 'Array' do
+      it 'deserializes short arrays' do
+        raw = [0x86, *(1..6).to_a].pack 'CC6'
+        expect(klass.unpack(raw).first).to eq (1..6).to_a
+      end
+    end
+    
+    describe 'String' do      
+      it 'deserializes short strings' do
+        raw = [0xA6, 'string'].pack 'CA*'
+        
+        expect(klass.unpack(raw).first).to eq 'string'
+      end
+      
+      it 'deserializes long strings' do
+        long_string = '*' * 33
+        raw = [0xA0, long_string.length - 31, long_string].pack 'C2A*'
+        
+        expect(klass.unpack(raw).first).to eq long_string
+      end
+    end
+    
+    describe 'Type' do
+      it 'deserializes types' do
+        raw = [0xC0, 0xC0].pack 'C2'
+        expect(klass.unpack(raw).first).to be MQTTPipe::Types::Type
+      end
+    end
+    
+    describe 'Nil' do      
+      it 'deserializes nil' do
+        raw = [0xC1].pack 'C'
+        expect(klass.unpack(raw).first).to be nil
+      end
+    end
+    
+    describe 'Boolean' do      
+      it 'deserializes to false' do
+        raw = [0xC2].pack 'C'
+        expect(klass.unpack(raw).first).to be false
+      end
+      
+      it 'deserializes to true' do
+        raw = [0xC3].pack 'C'
+        expect(klass.unpack(raw).first).to be true
+      end
+    end
+    
+    describe 'Integer' do
+      it 'deserializes tiny integers' do
+        raw = [127].pack ?C
+        expect(klass.unpack(raw).first).to eq 127
+        
+        raw = [-48].pack ?C
+        expect(klass.unpack(raw).first).to eq -48
+      end
+      
+      it 'deserializes bytes' do
+        raw = [0xC4, 128].pack 'C2'
+        expect(klass.unpack(raw).first).to eq 128
+      end
+      
+      it 'deserializes short integers' do
+        raw = [0xC5, 32_767].pack 'Cs<'
+        expect(klass.unpack(raw).first).to eq 32_767
+        
+        raw = [0xC5, -32_768].pack 'Cs<'
+        expect(klass.unpack(raw).first).to eq -32_768
+      end
+      
+      it 'deserializes long integers' do
+        raw = [0xC6, 2_147_483_647].pack 'Cl<'
+        expect(klass.unpack(raw).first).to eq 2_147_483_647
+        
+        raw = [0xC6, -2_147_483_648].pack 'Cl<'
+        expect(klass.unpack(raw).first).to eq -2_147_483_648
+      end
+    end
+    
+    describe 'Float' do      
+      it 'deserializes float' do
+        raw = [0xC7, 0.4].pack 'Ce'
+        expect(klass.unpack(raw).first).to be_within(0.0001).of(0.4)
+      end
+    end
+    
+    describe 'Time' do
+      it 'deserializes time' do
+        t = Time.now
+        raw = [0xC8, t.to_i].pack 'CL<'
+        expect(klass.unpack(raw).first).to be_a Time
+        expect(klass.unpack(raw).first - t).to be_within(1).of(0)
+      end
+    end
+  end
+  
+  describe 'End to end' do
+    it 'can serialize and deserialize an object' do
+      packet = ['Hello there!', 42, 42_531, ['hi', Time], true, []]
+      
+      req = klass.pack *packet
+      res = klass.unpack req
+            
+      expect(res[0]).to eq 'Hello there!'
+      expect(res[1]).to eq 42
+      expect(res[2]).to eq 42_531
+      expect(res[3][0]).to eq 'hi'
+      expect(res[3][1]).to eq Time
+      expect(res[4]).to eq true
+      expect(res[5]).to eq nil
+    end
+  end
+end

data/spec/pipe_spec.rb

@@ -0,0 +1,9 @@
+require 'mqtt_pipe'
+
+describe MQTTPipe do
+  describe '#create' do
+    it 'returns a pipe' do
+      expect(MQTTPipe.create).to be_a MQTTPipe::Pipe
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: mqtt_pipe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sebastian Lindberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: This gem wraps the MQTT gem by njh (on Github) and adds a serializer
+  for simple data structures.
+email:
+- seb.lindberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/receiver.rb
+- examples/sender.rb
+- lib/mqtt_pipe.rb
+- lib/mqtt_pipe/config.rb
+- lib/mqtt_pipe/listener.rb
+- lib/mqtt_pipe/packer.rb
+- lib/mqtt_pipe/pipe.rb
+- lib/mqtt_pipe/types.rb
+- lib/mqtt_pipe/types/array.rb
+- lib/mqtt_pipe/types/class.rb
+- lib/mqtt_pipe/types/color.rb
+- lib/mqtt_pipe/types/false.rb
+- lib/mqtt_pipe/types/float.rb
+- lib/mqtt_pipe/types/integer.rb
+- lib/mqtt_pipe/types/nil.rb
+- lib/mqtt_pipe/types/string.rb
+- lib/mqtt_pipe/types/time.rb
+- lib/mqtt_pipe/types/true.rb
+- lib/mqtt_pipe/types/type.rb
+- lib/mqtt_pipe/version.rb
+- mqtt_pipe.gemspec
+- spec/config_spec.rb
+- spec/listener_spec.rb
+- spec/packer_spec.rb
+- spec/pipe_spec.rb
+homepage: https://github.com/seblindberg/ruby-mqtt-pipe
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A gem for sending a small set of objects via MQTT.
+test_files:
+- spec/config_spec.rb
+- spec/listener_spec.rb
+- spec/packer_spec.rb
+- spec/pipe_spec.rb