dnssd 1.0 → 1.1.0

data/lib/dnssd.rb

@@ -7,10 +7,13 @@ require 'dnssd/dnssd'
 # Service Discovery aware.
 
 module DNSSD
-  VERSION = '1.0'
+  VERSION = '1.1.0'
 end
 
 require 'dnssd/flags'
+require 'dnssd/reply'
+require 'dnssd/service'
+require 'dnssd/text_record'
 
 =begin
 

data/lib/dnssd/flags.rb

@@ -0,0 +1,104 @@
+##
+# Flags used in DNSSD Ruby API.
+
+class DNSSD::Flags
+
+  constants.each do |name|
+    next unless name =~ /[a-z]/
+    attr = name.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+
+    flag = const_get name
+
+    define_method "#{attr}=" do |bool|
+      if bool then
+        set_flag flag
+      else
+        clear_flag flag
+      end
+    end
+
+    define_method "#{attr}?" do
+      self & flag == flag
+    end
+  end
+
+  ALL_FLAGS = FLAGS.values.inject { |flag, all| flag | all }
+
+  ##
+  # Returns a new set of flags
+
+  def initialize(*flags)
+    @flags = flags.inject 0 do |flag, acc| flag | acc end
+
+    verify
+  end
+
+  ##
+  # Returns the intersection of flags in +self+ and +flags+.
+
+  def &(flags)
+    self.class.new(to_i & flags.to_i)
+  end
+
+  ##
+  # +self+ is equal if +other+ has the same flags
+
+  def ==(other)
+    to_i == other.to_i
+  end
+
+  ##
+  # Clears +flag+
+
+  def clear_flag(flag)
+    @flags &= ~flag
+
+    verify
+  end
+
+  def inspect # :nodoc:
+    flags = to_a.sort.join ', '
+    flags[0, 0] = ' ' unless flags.empty?
+    "#<#{self.class}#{flags}>"
+  end
+
+  ##
+  # Sets +flag+
+
+  def set_flag(flag)
+    @flags |= flag
+
+    verify
+  end
+
+  def to_a
+    FLAGS.map do |name, value|
+      (@flags & value == value) ? name : nil
+    end.compact
+  end
+
+  def to_i # :nodoc:
+    @flags
+  end
+
+  def verify
+    @flags &= ALL_FLAGS
+
+    self
+  end
+
+  ##
+  # Returns the union of flags in +self+ and +flags+
+
+  def |(flags)
+    self.class.new(to_i | flags.to_i)
+  end
+
+  ##
+  # Returns the complement of the flags in +self+
+
+  def ~
+    self.class.new ~to_i
+  end
+
+end

data/lib/dnssd/reply.rb

@@ -0,0 +1,87 @@
+##
+# DNSSD::Reply is used to return information
+
+class DNSSD::Reply
+
+  ##
+  # The service domain
+
+  attr_reader :domain
+
+  ##
+  # Flags describing the reply, see DNSSD::Flags
+
+  attr_reader :flags
+
+  ##
+  # The interface on which the service is available
+
+  attr_reader :interface
+
+  ##
+  # The service name
+
+  attr_reader :name
+
+  ##
+  # The port for this service
+
+  attr_reader :port
+
+  ##
+  # The service associated with the reply, see DNSSD::Service
+
+  attr_reader :service
+
+  ##
+  # The hostname of the host provide the service
+
+  attr_reader :target
+
+  ##
+  # The service's primary text record
+
+  attr_reader :text_record
+
+  ##
+  # The service type
+
+  attr_reader :type
+
+  def self.from_service(service, flags)
+    reply = new
+    reply.instance_variable_set :@service, service
+    reply.instance_variable_set :@flags, DNSSD::Flags.new(flags)
+    reply
+  end
+
+  ##
+  # The full service domain name, see DNSS::Service#fullname
+
+  def fullname
+    DNSSD::Service.fullname @name.gsub("\032", ' '), @type, @domain
+  end
+
+  def inspect
+    "#<%s:0x%x %p type: %s domain: %s interface: %s flags: %s>" % [
+      self.class, object_id, @name, @type, @domain, @interface, @flags
+    ]
+  end
+
+  def set_fullname(fullname)
+    fullname = fullname.gsub(/\\([0-9]+)/) do $1.to_i.chr end
+    fullname = fullname.scan(/(?:[^\\.]|\\\.)+/).map do |part|
+      part.gsub "\\.", '.'
+    end
+
+    @name   = fullname[0]
+    @type   = fullname[1,   2].join '.'
+    @domain = fullname.last + '.'
+  end
+
+  def set_names(name, type, domain)
+    set_fullname [name, type, domain].join('.')
+  end
+
+end
+

data/lib/dnssd/service.rb

@@ -0,0 +1,15 @@
+class DNSSD::Service
+
+  ##
+  # Access the services underlying thread.  Returns nil if the service is
+  # synchronous.
+
+  attr_reader :thread
+  
+  def inspect
+    stopped = stopped? ? 'stopped' : 'running'
+    "#<%s:0x%x %s>" % [self.class, object_id, stopped]
+  end
+
+end
+

data/lib/dnssd/text_record.rb

@@ -0,0 +1,69 @@
+##
+# DNSSD::TextRecord is a Hash wrapper that can encode its contents for DNSSD.
+
+class DNSSD::TextRecord
+
+  ##
+  # Creates a new TextRecord, decoding an encoded +text_record+ if given.
+
+  def initialize(text_record = nil)
+    @records = {}
+
+    return unless text_record
+
+    text_record = text_record.dup
+
+    until text_record.empty? do
+      size = text_record.slice! 0
+      next if size.zero?
+
+      raise ArgumentError, 'ran out of data in text record' if
+        text_record.length < size
+
+      entry = text_record.slice! 0, size
+
+      raise ArgumentError, 'key not found' unless entry =~ /^[^=]/
+
+      key, value = entry.split '=', 2
+
+      next unless key
+
+      @records[key] = value
+    end
+  end
+
+  def [](key)
+    @records[key]
+  end
+
+  def []=(key, value)
+    @records[key] = value
+  end
+
+  ##
+  # Encodes this TextRecord.  A key value pair must be less than 255 bytes in
+  # length.  Keys longer than 14 bytes may not be compatible with all
+  # clients.
+
+  def encode
+    @records.sort.map do |key, value|
+      key = key.to_s
+
+      raise DNSSD::Error, "empty key" if key.empty?
+      raise DNSSD::Error, "key '#{key}' contains =" if key =~ /=/
+
+      record = value ? [key, value.to_s].join('=') : key
+
+      raise DNSSD::Error, "key value pair at '#{key}' too large to encode" if
+        record.length > 255
+
+      "#{record.length.chr}#{record}"
+    end.join ''
+  end
+
+  def to_hash
+    @records.dup
+  end
+
+end
+

data/sample/browse.rb

@@ -0,0 +1,11 @@
+require 'dnssd'
+
+browser = DNSSD.browse '_presence._tcp' do |reply|
+  p reply
+end
+
+trap 'INT' do browser.stop; exit end
+trap 'TERM' do browser.stop; exit end
+
+sleep
+

data/sample/growl.rb

@@ -0,0 +1,14 @@
+require 'dnssd'
+
+browser = DNSSD.browse '_growl._tcp' do |b|
+  DNSSD.resolve b.name, b.type, b.domain do |r|
+    puts "#{b.name} of #{b.type} in #{b.domain} => #{r.target}:#{r.port} on #{b.interface} txt #{r.text_record.inspect}"
+    r.service.stop
+  end
+end
+
+trap 'INT' do browser.stop; exit end
+trap 'TERM' do browser.stop; exit end
+
+sleep
+

data/sample/highlevel_api.rb

@@ -0,0 +1,30 @@
+require 'dnssd'
+
+service = DNSSD::Service.advertise_http "Chad's server", 8808 do |service|
+  p service
+  #service.name_changed? {|name| my_widget.update(name) }
+end
+sleep 4
+service.stop
+
+# collects the resolve results and trys each one (overlap)...when one
+# succeeds, it cancels the other checks and returns.
+
+browser = DNSSD::Browser.for_http do |service|
+  host, port = service.resolve #optionally returns [host, port, iface]
+end
+
+sleep 4
+
+browser.stop
+if browser.more_coming?
+  puts "blah"
+end
+browser.service_discovered? {|service|}
+browser.service_lost? {|service|}
+browser.on_changed do
+  # get current values for UI update
+end
+browser.all_current #=> [service1, service2]
+browser.changed? 
+

data/sample/register.rb

@@ -0,0 +1,30 @@
+require 'dnssd'
+
+DNSSD.register "hey ruby", "_http._tcp", nil, 8081
+
+registrar = DNSSD.register "chad ruby", "_http._tcp", nil, 8080 do |reply|
+  p :registered => reply.fullname
+end
+
+sleep 1
+
+puts
+
+found = {}
+
+browser = DNSSD.browse '_http._tcp' do |reply|
+  if reply.flags.more_coming? then
+    found[reply.name] = true
+  else
+    puts "found:\n#{found.keys.join "\n"}"
+    puts
+
+    found.clear
+  end
+end
+
+sleep 0.1
+
+browser.stop
+registrar.stop
+

data/sample/resolve.rb

@@ -0,0 +1,13 @@
+require 'dnssd'
+
+abort "#{$0} \"http service name\"" if ARGV.empty?
+
+resolver = DNSSD.resolve ARGV.shift, "_http._tcp", "local" do |reply|
+	p reply
+end
+
+trap 'INT' do resolver.stop; exit end
+trap 'TERM' do resolver.stop; exit end
+
+sleep
+

data/sample/resolve_ichat.rb

@@ -0,0 +1,36 @@
+require 'dnssd'
+require 'pp'
+
+class ChatNameResolver
+  def self.resolve_add(reply)
+    Thread.new reply do |reply|
+      DNSSD.resolve reply.name, reply.type, reply.domain do |resolve_reply|
+        puts "Adding: #{resolve_reply.inspect}"
+        pp resolve_reply.text_record
+        resolve_reply.service.stop
+      end
+    end
+  end
+  def self.resolve_remove(reply)
+    Thread.new reply do |reply|
+      DNSSD.resolve reply.name, reply.type, reply.domain do |resolve_reply|
+        puts "Removing: #{resolve_reply.inspect}"
+        resolve_reply.service.stop
+      end
+    end
+  end
+end
+
+browser = DNSSD.browse '_presence._tcp' do |reply|
+  if reply.flags.add? then
+    ChatNameResolver.resolve_add reply
+  else
+    ChatNameResolver.resolve_remove reply
+  end
+end
+
+trap 'INT' do browser.stop; exit end
+trap 'TERM' do browser.stop; exit end
+
+sleep
+

data/test/test_dnssd_reply.rb

@@ -0,0 +1,64 @@
+require 'minitest/autorun'
+require 'dnssd'
+
+class TestDNSSDReply < MiniTest::Unit::TestCase
+
+  def setup
+    @reply = DNSSD::Reply.new
+    @fullname = "Eric\\032Hodel._http._tcp.local."
+  end
+
+  def test_class_from_service
+    reply = DNSSD::Reply.from_service :service, 4
+
+    assert_equal :service, reply.service
+    assert_equal DNSSD::Flags::Default, reply.flags
+  end
+
+  def test_fullname
+    @reply.set_fullname @fullname
+
+    assert_equal "Eric\\032Hodel._http._tcp.local.", @reply.fullname
+
+    @reply.instance_variable_set :@name, 'Dr. Pepper'
+
+    assert_equal "Dr\\.\\032Pepper._http._tcp.local.", @reply.fullname
+  end
+
+  def test_inspect
+    flags = DNSSD::Flags.new
+    @reply.instance_variable_set :@fullname,  'blah'
+    @reply.instance_variable_set :@name,      'drbrain@pincer-tip'
+    @reply.instance_variable_set :@interface, 'en2'
+    @reply.instance_variable_set :@domain,    'local'
+    @reply.instance_variable_set :@flags,     flags
+    @reply.instance_variable_set :@type,      '_presence._tcp'
+
+    expected = "#<DNSSD::Reply:0x#{@reply.object_id.to_s 16} \"drbrain@pincer-tip\" type: _presence._tcp domain: local interface: en2 flags: #{flags}>"
+    assert_equal expected, @reply.inspect
+  end
+
+  def test_set_fullname
+    @reply.set_fullname @fullname
+
+    assert_equal 'Eric Hodel', @reply.name
+    assert_equal '_http._tcp', @reply.type
+    assert_equal 'local.', @reply.domain
+
+    @reply.set_fullname "Dr\\.\\032Pepper._http._tcp.local."
+
+    assert_equal 'Dr. Pepper', @reply.name
+    assert_equal '_http._tcp', @reply.type
+    assert_equal 'local.', @reply.domain
+  end
+
+  def test_set_names
+    @reply.set_names "Dr\\.\032Pepper", '_http._tcp', 'local.'
+
+    assert_equal "Dr.\032Pepper", @reply.name
+    assert_equal '_http._tcp', @reply.type
+    assert_equal 'local.', @reply.domain
+  end
+
+end
+