findme 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,43 @@
 findme
 ======
 
-find neighborhood host and services.
+Find neighborhood host and services. fineme uses `avahi-deamon` and `avahi-browse` to discover and register services. Only works with ubuntu linux for now. (12.04 is tested working)
+
+
+Install
+-------
+    sudo apt-get install avahi-utils avahi-daemon libnss-mdns
+    gem install findme
+    
+Example
+-------
+
+    require 'findme'
+    require 'pp'
+
+    puts Findme.discover.count.to_s + " Service discovered."
+    Findme.discover.each{|service| pp service.inspect}
+    
+More advanced Example
+---------------------
+
+on server:
+
+    require 'findme'
+
+    Findme.register "findme", 1337
+
+on client:
+    
+    require 'findme'
+
+    SERVICE = "findme"
+    services = Findme.discover
+    services.select{|s| s.service == "_#{SERVICE}._tcp"}.each{|s| puts "#{s.ip}:#{s.port}"}
+
+results on client.rb:
+
+    ~ > ruby client.rb
+    fe80::a00:27ff:feeb:xxxx:1337
+    192.168.xx.xx:1337
+

data/example/client.rb

@@ -0,0 +1,7 @@
+require 'findme'
+require 'pp'
+
+SERVICE = "findme"
+#services = Findme.discover
+h = Findme.discover_only_earliest
+h.select{|k,s| s.service == "_#{SERVICE}._tcp"}.each{|k,s| puts "#{k}|#{s.ip}:#{s.port}:#{s.txt}"}

data/example/server.rb

@@ -0,0 +1,4 @@
+require 'findme.rb'
+
+Findme.cleanup
+Findme.register "findme", 1337 

data/findme.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/findme/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["c2h2"]
   gem.email         = ["yiling.cao@gmail.com"]
-  gem.description   = "find neighborhood host and services."
-  gem.summary       = "find neighborhood host and services."
+  gem.description   = "find neighborhood host and services with avahi / avahi-daemon."
+  gem.summary       = "find neighborhood host and services with avahi / avahi-daemon."
   gem.homepage      = "https://github.com/c2h2/findme"
 
   gem.files         = `git ls-files`.split($\)

data/lib/findme.rb

@@ -10,7 +10,7 @@ class Findme
     files = files_with_path.map{|fwp| fwp.split("/").last}
   end
 
-  #clean up all the services this gem registered.
+  #clean up all the services this gem registered. should be called by user to clean up unused services.
   def self.cleanup
     findme_services = []
     files_with_path = Dir.glob(AVAHI_SERVICE_DIR + "*.service")
@@ -28,6 +28,47 @@ class Findme
       File.delete fs
     end
   end
+  
+  def self._get_startup_time str
+    begin
+      pairs = str.strip.split(" ")
+      pairs.each do |p|
+        kv=p.strip.split("=")
+        if kv[0] == "\"findme_startup_time"
+          return kv[0].to_i
+        end
+      end
+    rescue Exception => e
+      # do nothing or if you want to debug: puts e
+    end
+    nil
+  end
+
+  def self.discover_only_earliest
+    services = discover
+    h = {}
+    h_out={}
+    
+    #construct the hash, group the services of the same name
+    services.each do |s|
+      if h[s.service].nil?
+        h[s.service]=[]
+      else
+        #existing hash, do nothing
+      end
+      h[s.service] << s
+    end  
+
+    h.each do |k, v|
+      if (_get_startup_time v[0].txt).nil?
+        #cant find the earliest time, just return the first one.
+      else
+        v.sort! {|x,y| _get_startup_time(x.txt) <=> _get_startup_time(y.txt) }
+      end
+      h_out[k]=v[0]
+    end
+    h_out
+  end
 
   def self.discover 
     res = `avahi-browse -arpt`
@@ -52,19 +93,22 @@ class Findme
   end
 
   #register a new service to the folder
-  def self.register service_name,  port, type = '_tcp'
+  def self.register service_name,  port, txt="", type = '_tcp', protocol="ipv4"
+    txt = ("findme_startup_time=#{Time.now.to_i.to_s} " + txt).strip
     xml = '<?xml version="1.0" standalone=\'no\'?><!--*-nxml-*-->
 <!DOCTYPE service-group SYSTEM "avahi-service.dtd">
 
 <!-- findme generated -->
-<!-- This file is part of udisks -->
+<!-- This file is part of '+ service_name + '} -->
 
 <service-group>
   <name replace-wildcards="yes">%h</name>
 
-  <service>
+  <service protocol="' + protocol + '">
+    
     <type>'+ "_#{service_name}.#{type}" +'</type>
-    <port>' + port.to_s + '</port>
+    <port>'+ port.to_s + '</port>
+    <txt-record>' + txt.to_s + '</txt-record>
   </service>
 </service-group>'
 

data/lib/findme/version.rb

@@ -1,3 +1,3 @@
 module Findme
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: findme
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-02 00:00:00.000000000 Z
+date: 2012-08-29 00:00:00.000000000 Z
 dependencies: []
-description: find neighborhood host and services.
+description: find neighborhood host and services with avahi / avahi-daemon.
 email:
 - yiling.cao@gmail.com
 executables: []
@@ -23,6 +23,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- example/client.rb
+- example/server.rb
 - findme.gemspec
 - lib/findme.rb
 - lib/findme/version.rb
@@ -50,6 +52,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: find neighborhood host and services.
+summary: find neighborhood host and services with avahi / avahi-daemon.
 test_files:
 - test/test.rb