hpfeeds 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03b7575438eb4799c7d0b2e9a25795020f24c501
-  data.tar.gz: 931209087d6e02e8b34d73d14485e6277747bd46
+  metadata.gz: 13f8e72d2ed5ec5e41fd2276f0c81fa308222b6d
+  data.tar.gz: e32cf09a6666c6f1f6a9eb4330248d76ac5d2e2b
 SHA512:
-  metadata.gz: 24dd1cea9aa0de6f341ecce8a960c1ce8d857b60eb11606458fbbbc7afbcb72164753c86bdfad6daf2f8bb3877f5658c3dda0dec212c2e74366867e0bfed1530
-  data.tar.gz: a6db74ca3dc4808fbc72208c73a28c729af8d84e27c70e3877c5d306b3368932a0ecaa60adb344e2b8df4c6c2ac3a75a4617c9c660f21704b950c71141beff4c
+  metadata.gz: dbf30ba8497fdc96e278bd44847712d4a7dfcdda6d98f69c9aaaac67c962939a476fccb9d3a18c4837173ad567b0ad3a2f8d4ad82a6c7805cad04b6adceea0ef
+  data.tar.gz: 5e9b6dd82041d487cfae67e3fa53f9779714a7a13167957e35defd5b56d654cdef7370b8427765b1c9b55257632966960f7e579db7b75ee21c0fc18480eea519

data/CHANGELOG.md

@@ -1,2 +1,10 @@
-== 0.1.0
+#### 0.1.1
+- major fixes:
+ - separate handlers for messages from different chanels
+ - better error messages handling
+
+- minor fixes:
+ - documentation, indentation
+
+#### 0.1.0
 First release

data/README.md

@@ -24,25 +24,25 @@ Here is a basic example:
 require "hpfeeds"
 
 def on_data(name, chan, payload)
-	puts "[%s] %s: %s" % [ chan, name, payload ]
-	# just an example here...
-	@hp.publish('channel', 'message')
+  puts "[%s] %s: %s" % [ chan, name, payload ]
+  # just an example here...
+  @hp.publish('channel', 'message')
 end
 
 def on_error(data)
-	STDERR.puts "ERROR: " + data.inspect
+  STDERR.puts "ERROR: " + data.inspect
 end
 
 begin
   @hp = HPFeeds::Client.new ({
-    host: hpfeeds_server_name_here,
-    port:   10000,
-    ident:  'XXXX',
+    host:   hpfeeds_server_name_here,
+    port:   hpfeeds_port_number_here,  # default is 10000
+    ident:  'XXXXXX',
     secret: '123456'
   })
   channels = %w[ chan1 chan2 chanN ]
-  @hp.subscribe(*channels)
-  @hp.run(method(:on_data), method(:on_error))
+  @hp.subscribe(*channels) { |name, chan, payload| on_data(name, chan, payload) }
+  @hp.run(method(:on_error))
 
 rescue => e
   puts "Exception: #{e}"
@@ -50,6 +50,26 @@ ensure
   @hp.close if @hp
 end
 ```
+### HPFeeds messages handler
+It's also possibile to set separate handlers for messages from different channels, as follows:
+```ruby
+@hp.subscribe(chan1, chan2) do
+  puts "Received something"
+end
+
+@hp.subscribe(chan3, chan4, chan5) do |name, chan|
+  puts "Received something on #{chan}, from #{name}"
+end
+
+@hp.subscribe(chan6, chan7) { |name, chan, payload| custom_method(name, chan, payload) }
+```
+### HPFeeds errors handler
+The argument in
+```ruby
+@hp.run(method(:on_error))
+```
+is an handler for HPFeeds error messages (i.e. `'accessfail'` or `'authfail'`).
+It's optional: if you don't provide any handler, an exception will be raised (`HPFeeds::ErrorMessage`) in case of error messages.
 
 ## Contributing
 

data/lib/hpfeeds.rb

@@ -2,6 +2,8 @@ require 'hpfeeds/version'
 
 module HPFeeds
   autoload :Client, 'hpfeeds/client'
-  autoload :Exception, 'hpfeeds/exception'
   autoload :Decoder, 'hpfeeds/decoder'
+  # exceptions
+  autoload :Exception, 'hpfeeds/exception'
+  autoload :ErrorMessage, 'hpfeeds/exception'
 end

data/lib/hpfeeds/client.rb

@@ -3,16 +3,16 @@ require 'socket'
 
 module HPFeeds
   OP_ERROR     = 0
-  OP_INFO	     = 1
-  OP_AUTH	     = 2
+  OP_INFO      = 1
+  OP_AUTH      = 2
   OP_PUBLISH   = 3
   OP_SUBSCRIBE = 4
 
-  BUFSIZE    = 16384
   HEADERSIZE = 5
+  BUFSIZE    = 16384
 
   class Client
-	  def initialize(options)
+    def initialize(options)
       @host   = options[:host]
       @port   = options[:port] || 10000
       @ident  = options[:ident]
@@ -23,25 +23,27 @@ module HPFeeds
       @sleepwait = options[:sleepwait] || 20
 
       @connected = false
-		  @stopped   = false
+      @stopped   = false
 
-	  	@decoder      = Decoder.new
+      @decoder      = Decoder.new
       @logger       = Logger.new($stdout)
       @logger.level = Logger::INFO
 
+      @handlers = {}
+
       tryconnect
-	  end
-
-	  def tryconnect
-	    loop do
-		    begin
-		      connect()
-		      break
-	      rescue => e
-			    @logger.warn("#{e.class} caugthed while connecting: #{e}. Reconnecting in #{@sleepwait} seconds...")
-			    sleep(@sleepwait)
-	      end
-		  end
+    end
+
+    def tryconnect
+      loop do
+        begin
+          connect()
+          break
+        rescue => e
+          @logger.warn("#{e.class} caugthed while connecting: #{e}. Reconnecting in #{@sleepwait} seconds...")
+          sleep(@sleepwait)
+        end
+      end
     end
 
     def connect
@@ -66,8 +68,8 @@ module HPFeeds
         @brokername = name
         auth = @decoder.msg_auth(rand, @ident, @secret)
         @socket.send(auth, 0)
-			else
-				raise Exception('Expected info message at this point.')
+      else
+        raise Exception.new('Expected info message at this point.')
       end
       @logger.info("connected to #{@host}, port #{@port}")
       @connected = true
@@ -75,11 +77,17 @@ module HPFeeds
       @socket.setsockopt(Socket::Option.bool(:INET, :SOCKET, :KEEPALIVE, true))
     end
 
-    def subscribe(*channels)
+    def subscribe(*channels, &block)
+      if block_given?
+        handler = block
+      else
+        raise ArgumentError.new('When subscribing to a channel, you have to provide a block as a callback for message handling')
+      end
       for c in channels
         @logger.info("subscribing to #{c}")
         message = @decoder.msg_subscribe(@ident, c)
         @socket.send(message, 0)
+        @handlers[c] = handler unless handler.nil?
       end
     end
 
@@ -104,7 +112,7 @@ module HPFeeds
       end
     end
 
-    def run(message_callback, error_callback)
+    def run(error_callback = nil)
       begin
         while !@stopped
           while @connected
@@ -118,22 +126,32 @@ module HPFeeds
             data = @socket.recv(len)
             @logger.debug("received #{data.length} bytes of data")
             if opcode == OP_ERROR
-              error_callback.call(data)
+              unless error_callback.nil?
+                error_callback.call(data)
+              else
+                raise ErrorMessage.new(data)
+              end
             elsif opcode == OP_PUBLISH
               name, chan, payload = @decoder.parse_publish(data)
               @logger.info("received #{payload.length} bytes of data from #{name} on channel #{chan}")
-              message_callback.call(name, chan, payload)
-		        end
+              handler = @handlers[chan]
+              unless handler.nil?
+                # ignore unhandled messages
+                handler.call(name, chan, payload)
+              end
+            end
           end
           @logger.debug("Lost connection, trying to connect again...")
           tryconnect
         end
-
+      rescue ErrorMessage => e
+        @logger.warn("#{e.class} caugthed in main loop: #{e}")
+        raise e
       rescue => e
         message = "#{e.class} caugthed in main loop: #{e}\n"
         message += e.backtrace.join("\n")
-		    @logger.error(message)
-		  end
+        @logger.error(message)
+      end
     end
 
   private

data/lib/hpfeeds/decoder.rb

@@ -5,45 +5,45 @@ module HPFeeds
 
     def parse_header(header)
       raise Exception.new("Malformed header") if header.length < 5
-  	  len = header[0,4].unpack("l>")[0]
-		  op = header[4,1].unpack("C")[0]
+      len = header[0,4].unpack("l>")[0]
+      op = header[4,1].unpack("C")[0]
       return op, len
     end
 
     def parse_info(data)
       len = data[0,1].unpack("C")[0]
       raise Exception.new("Malformed data") if data.length <= len
-			name = data[1,len]
-			rand = data[(1+len)..-1]
+      name = data[1,len]
+      rand = data[(1+len)..-1]
       return name, rand
     end
 
     def parse_publish(data)
-			len = data[0,1].unpack("C")[0]
-			name = data[1,len]
-			len2 = data[(1+len),1].ord
-			chan = data[(1+len+1),len2]
-			payload = data[(1+len+1+len2)..-1]
+      len = data[0,1].unpack("C")[0]
+      name = data[1,len]
+      len2 = data[(1+len),1].ord
+      chan = data[(1+len+1),len2]
+      payload = data[(1+len+1+len2)..-1]
       return name, chan, payload
     end
 
     def msg_auth(rand, ident, secret)
-  		mac = Digest::SHA1.digest(rand + secret)
-	  	msg_hdr(OP_AUTH, [ident.length].pack("C") + ident + mac)
+      mac = Digest::SHA1.digest(rand + secret)
+      msg_hdr(OP_AUTH, [ident.length].pack("C") + ident + mac)
     end
 
     def msg_subscribe(ident, chan)
-		  msg_hdr(OP_SUBSCRIBE, [ident.length].pack("C") + ident + chan)
-	  end
+      msg_hdr(OP_SUBSCRIBE, [ident.length].pack("C") + ident + chan)
+    end
 
     def msg_publish(ident, chan, msg)
-		  msg_hdr(OP_PUBLISH, [ident.length].pack("C") + ident + [chan.length].pack("C") + chan + msg)
-	  end
+      msg_hdr(OP_PUBLISH, [ident.length].pack("C") + ident + [chan.length].pack("C") + chan + msg)
+    end
 
   private
 
-	  def msg_hdr(op, data)
-		  [5+data.length].pack("l>") + [op].pack("C") + data
-	  end
+    def msg_hdr(op, data)
+      [5+data.length].pack("l>") + [op].pack("C") + data
+    end
   end
 end

data/lib/hpfeeds/exception.rb

@@ -1,3 +1,4 @@
 module HPFeeds
   class Exception < RuntimeError; end
+  class ErrorMessage < RuntimeError; end
 end

data/lib/hpfeeds/version.rb

@@ -1,3 +1,3 @@
 module HPFeeds
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/hpfeeds/version.rb~

@@ -0,0 +1,3 @@
+module HPFeeds
+  VERSION = "0.1.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hpfeeds
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Francesco Coda Zabetta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/hpfeeds/exception.rb
+- lib/hpfeeds/version.rb~
 - lib/hpfeeds/decoder.rb
 - lib/hpfeeds/client.rb
 - lib/hpfeeds/version.rb