dnssd 1.0 → 1.1.0

data/test/test_dnssd_text_record.rb

@@ -0,0 +1,83 @@
+require 'minitest/autorun'
+require 'dnssd'
+
+class TestDNSSDTextRecord < MiniTest::Unit::TestCase
+
+  def setup
+    @TR = DNSSD::TextRecord
+  end
+
+  def test_encode
+    tr = @TR.new
+
+    tr['key1'] = nil
+    tr['key2'] = ''
+    tr['key3'] = 'value'
+
+    assert_equal "\004key1\005key2=\012key3=value", tr.encode
+  end
+
+  def test_encode_long
+    tr = @TR.new
+
+    tr['key'] = 'X' * 252
+
+    e = assert_raises DNSSD::Error do
+      tr.encode
+    end
+
+    assert_equal 'key value pair at \'key\' too large to encode', e.message
+  end
+
+  def test_decode
+    text_record = "\fstatus=avail\006email=\004jid=\005node=\tversion=1\ttxtvers=1\016port.p2pj=5298\0161st=Eric Hodel\005nick=\004AIM=\005last=-phsh=59272d0c3ed947b4660fabc0dad9d67647507299\004ext="
+
+    expected = {
+      'status'    => 'avail',
+      'ext'       => '',
+      'node'      => '',
+      'nick'      => '',
+      'last'      => '',
+      'txtvers'   => '1',
+      'AIM'       => '',
+      'jid'       => '',
+      'phsh'      => '59272d0c3ed947b4660fabc0dad9d67647507299',
+      'version'   => '1',
+      '1st'       => 'Eric Hodel',
+      'port.p2pj' => '5298',
+      'email'     => ''
+    }
+
+    assert_equal expected, @TR.new(text_record).to_hash
+  end
+
+  def test_decode_bad
+    assert_raises ArgumentError do
+      @TR.new("\x01") # length past end-of-record
+    end
+
+    assert_raises ArgumentError do
+      # no key
+      @TR.new("\x01=")
+    end
+
+    assert_raises ArgumentError do
+      # 0-length key
+      @TR.new("\x02=v")
+    end
+  end
+
+  def test_decode_empty
+    assert_equal({}, @TR.new("").to_hash)
+    assert_equal({}, @TR.new("\x00").to_hash)
+    assert_equal({}, @TR.new("\x00\x00").to_hash)
+  end
+
+  def test_decode_value
+    assert_equal({ 'k' => nil }, @TR.new("\x01k").to_hash)
+    assert_equal({ 'k' => ''  }, @TR.new("\x02k=").to_hash)
+    assert_equal({ 'k' => 'v' }, @TR.new("\x03k=v").to_hash)
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dnssd
 version: !ruby/object:Gem::Version 
-  version: "1.0"
+  version: 1.1.0
 platform: ruby
 authors: 
 - Chad Fowler
@@ -12,30 +12,9 @@ authors:
 - Eric Hodel
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
-  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
-  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
-  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
-  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
-  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
-  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
-  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
-  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
-  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
-  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
-  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
-  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
-  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
-  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
-  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
-  x52qPcexcYZR7w==
-  -----END CERTIFICATE-----
+cert_chain: []
 
-date: 2009-08-05 00:00:00 -07:00
+date: 2009-08-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,6 +76,7 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 files: 
+- .autotest
 - History.txt
 - Manifest.txt
 - README.txt
@@ -104,11 +84,24 @@ files:
 - ext/dnssd/dns_sd.h
 - ext/dnssd/dnssd.c
 - ext/dnssd/dnssd.h
-- ext/dnssd/dnssd_service.c
-- ext/dnssd/dnssd_structs.c
-- ext/dnssd/dnssd_tr.c
+- ext/dnssd/errors.c
 - ext/dnssd/extconf.rb
+- ext/dnssd/flags.c
+- ext/dnssd/service.c
 - lib/dnssd.rb
+- lib/dnssd/flags.rb
+- lib/dnssd/reply.rb
+- lib/dnssd/service.rb
+- lib/dnssd/text_record.rb
+- sample/browse.rb
+- sample/growl.rb
+- sample/highlevel_api.rb
+- sample/register.rb
+- sample/resolve.rb
+- sample/resolve_ichat.rb
+- test/test_dnssd_flags.rb
+- test/test_dnssd_reply.rb
+- test/test_dnssd_text_record.rb
 has_rdoc: true
 homepage: http://rubyforge.org/projects/dnssd
 licenses: []
@@ -135,9 +128,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dnssd
-rubygems_version: 1.3.5
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: DNS Service Discovery (aka Bonjour, MDNS) API for Ruby
 test_files: 
 - test/test_dnssd_flags.rb
+- test/test_dnssd_reply.rb
+- test/test_dnssd_text_record.rb

data/ext/dnssd/dnssd_structs.c

@@ -1,397 +0,0 @@
-/*
- * Copyright (c) 2004 Chad Fowler, Charles Mills, Rich Kilmer
- * Licensed under the same terms as Ruby.
- * This software has absolutely no warranty.
- */
-#include "dnssd.h"
-
-static VALUE cDNSSDFlags;
-static VALUE cDNSSDReply;
-
-static ID dnssd_iv_flags;
-static ID dnssd_iv_interface;
-static ID dnssd_iv_fullname;
-static ID dnssd_iv_target;
-static ID dnssd_iv_port;
-static ID dnssd_iv_text_record;
-static ID dnssd_iv_name;
-static ID dnssd_iv_type;
-static ID dnssd_iv_domain;
-static ID dnssd_iv_service;
-
-/* dns sd flags, flag ID's, flag names */
-#define DNSSD_MAX_FLAGS 9
-
-static const DNSServiceFlags dnssd_flag[DNSSD_MAX_FLAGS] = {
-  kDNSServiceFlagsMoreComing,
-
-  kDNSServiceFlagsAdd,
-  kDNSServiceFlagsDefault,
-
-  kDNSServiceFlagsNoAutoRename,
-
-  kDNSServiceFlagsShared,
-  kDNSServiceFlagsUnique,
-
-  kDNSServiceFlagsBrowseDomains,
-  kDNSServiceFlagsRegistrationDomains,
-
-  kDNSServiceFlagsLongLivedQuery
-};
-
-static const char *dnssd_flag_name[DNSSD_MAX_FLAGS] = {
-  "more_coming",
-  "add",
-  "default",
-  "no_auto_rename",
-  "shared",
-  "unique",
-  "browse_domains",
-  "registration_domains",
-  "long_lived_query"
-};
-
-static VALUE
-dnssd_struct_inspect(VALUE self, VALUE data) {
-  VALUE buf = rb_str_buf_new(20 + RSTRING_LEN(data));
-  rb_str_buf_cat2(buf, "#<");
-  rb_str_buf_cat2(buf, rb_obj_classname(self));
-  if (RSTRING_LEN(data) > 0) {
-    rb_str_buf_cat2(buf, " ");
-    rb_str_buf_append(buf, data);
-  }
-  rb_str_buf_cat2(buf, ">");
-  return buf;
-}
-
-VALUE
-dnssd_create_fullname(const char *name, const char *regtype, const char *domain, int err_flag) {
-  char buffer[kDNSServiceMaxDomainName];
-  if ( DNSServiceConstructFullName(buffer, name, regtype, domain) ) {
-    static const char msg[] = "could not construct full service name";
-    if (err_flag) {
-      rb_raise(rb_eArgError, msg);
-    } else {
-      VALUE buf;
-      rb_warn(msg);
-      /* just join them all */
-      buf = rb_str_buf_new2(name);
-      rb_str_buf_cat2(buf, regtype);
-      rb_str_buf_cat2(buf, domain);
-      return buf;
-    }
-  }
-  buffer[kDNSServiceMaxDomainName - 1] = '\000'; /* just in case */
-  return rb_str_new2(buffer);
-}
-
-VALUE
-dnssd_split_fullname(VALUE fullname) {
-  static const char re[] = "(?:\\\\.|[^\\.])+\\.";
-  VALUE regexp = rb_reg_new(re, sizeof(re)-1, 0);
-  return rb_funcall2(fullname, rb_intern("scan"), 1, &regexp);
-}
-
-#if 0
-  static void
-quote_and_append(VALUE buf, VALUE str)
-{
-  const char *ptr;
-  long i, last_mark, len;
-
-  ptr = RSTRING_PTR(str);
-  len = RSTRING_LEN(str);
-  last_mark = 0;
-  /* last character should be '.' */
-  for (i=0; i<len-1; i++) {
-    if (ptr[i] == '.') {
-      /* write 1 extra character and replace it with '\\' */
-      rb_str_buf_cat(buf, ptr + last_mark, i + 1 - last_mark);
-      RSTRING_PTR(buf)[i] = '\\';
-      last_mark = i;
-    }
-  }
-  rb_str_buf_cat(buf, ptr + last_mark, len - last_mark);
-}
-#endif
-
-static VALUE
-dnssd_join_names(int argc, VALUE *argv) {
-  int i;
-  VALUE buf;
-  long len = 0;
-
-  for (i=0; i<argc; i++) {
-    argv[i] = StringValue(argv[i]);
-    len += RSTRING_LEN(argv[i]);
-  }
-  buf = rb_str_buf_new(len);
-  for (i=0; i<argc; i++) {
-    rb_str_buf_append(buf, argv[i]);
-  }
-  return buf;
-}
-
-static void
-reply_add_names(VALUE self, const char *name,
-    const char *regtype, const char *domain) {
-  rb_ivar_set(self, dnssd_iv_name, rb_str_new2(name));
-  rb_ivar_set(self, dnssd_iv_type, rb_str_new2(regtype));
-  rb_ivar_set(self, dnssd_iv_domain, rb_str_new2(domain));
-  rb_ivar_set(self, dnssd_iv_fullname, dnssd_create_fullname(name, regtype, domain, 0));
-}
-
-static void
-reply_add_names2(VALUE self, const char *fullname) {
-  VALUE fn = rb_str_new2(fullname);
-  VALUE ary = dnssd_split_fullname(fn);
-  VALUE type[2] =  { rb_ary_entry(ary, 1), rb_ary_entry(ary, 2) };
-
-  rb_ivar_set(self, dnssd_iv_name, rb_ary_entry(ary, 0));
-  rb_ivar_set(self, dnssd_iv_type, dnssd_join_names(2, type));
-  rb_ivar_set(self, dnssd_iv_domain, rb_ary_entry(ary, -1));
-  rb_ivar_set(self, dnssd_iv_fullname, fn);
-}
-
-static void
-reply_set_interface(VALUE self, uint32_t interface) {
-  VALUE if_value;
-  char buffer[IF_NAMESIZE];
-  if (if_indextoname(interface, buffer)) {
-    if_value = rb_str_new2(buffer);
-  } else {
-    if_value = ULONG2NUM(interface);
-  }
-  rb_ivar_set(self, dnssd_iv_interface, if_value);
-}
-
-static void
-reply_set_tr(VALUE self, uint16_t txt_len, const char *txt_rec) {
-  rb_ivar_set(self, dnssd_iv_text_record, dnssd_tr_new((long)txt_len, txt_rec));
-}
-
-static VALUE
-reply_new(VALUE service, DNSServiceFlags flags) {
-  VALUE self = rb_obj_alloc(cDNSSDReply);
-  rb_ivar_set(self, dnssd_iv_service, service);
-  rb_ivar_set(self, dnssd_iv_flags,
-              rb_funcall(cDNSSDFlags, rb_intern("new"), 1, flags));
-  return self;
-}
-
-VALUE
-dnssd_domain_enum_new(VALUE service, DNSServiceFlags flags,
-    uint32_t interface, const char *domain) {
-  VALUE d, self = reply_new(service, flags);
-  reply_set_interface(self, interface);
-  d = rb_str_new2(domain);
-  rb_ivar_set(self, dnssd_iv_domain, d);
-  rb_ivar_set(self, dnssd_iv_fullname, d);
-  return self;
-}
-
-VALUE
-dnssd_browse_new(VALUE service, DNSServiceFlags flags, uint32_t interface,
-    const char *name, const char *regtype, const char *domain) {
-  VALUE self = reply_new(service, flags);
-  reply_set_interface(self, interface);
-  reply_add_names(self, name, regtype, domain);
-  return self;
-}
-
-#if 0
-  static VALUE
-dnssd_gethostname(void)
-{
-#if HAVE_GETHOSTNAME
-#ifndef MAXHOSTNAMELEN
-#define MAXHOSTNAMELEN 256
-#endif
-  char buffer[MAXHOSTNAMELEN + 1];
-  if (gethostname(buffer, MAXHOSTNAMELEN))
-    return Qnil;
-  buffer[MAXHOSTNAMELEN] = '\000';
-  return rb_str_new2(buffer);
-#else
-  return Qnil;
-#endif
-}
-#endif
-
-VALUE
-dnssd_register_new(VALUE service, DNSServiceFlags flags, const char *name,
-    const char *regtype, const char *domain) {
-  VALUE self = reply_new(service, flags);
-  reply_add_names(self, name, regtype, domain);
-  /* HACK */
-  /* See HACK in dnssd_service.c */
-  rb_ivar_set(self, dnssd_iv_interface, rb_ivar_get(service, dnssd_iv_interface));
-  rb_ivar_set(self, dnssd_iv_port, rb_ivar_get(service, dnssd_iv_port));
-  rb_ivar_set(self, dnssd_iv_text_record, rb_ivar_get(service, dnssd_iv_text_record));
-  /********/
-  return self;
-}
-
-VALUE
-dnssd_resolve_new(VALUE service, DNSServiceFlags flags, uint32_t interface,
-    const char *fullname, const char *host_target,
-    uint16_t opaqueport, uint16_t txt_len, const char *txt_rec) {
-  uint16_t port = ntohs(opaqueport);
-  VALUE self = reply_new(service, flags);
-  reply_set_interface(self, interface);
-  reply_add_names2(self, fullname);
-  rb_ivar_set(self, dnssd_iv_target, rb_str_new2(host_target));
-  rb_ivar_set(self, dnssd_iv_port, UINT2NUM(port));
-  reply_set_tr(self, txt_len, txt_rec);
-  return self;
-}
-
-/*
- * call-seq:
- *    reply.inspect   => string
- *
- */
-static VALUE
-reply_inspect(VALUE self) {
-  VALUE fullname = rb_ivar_get(self, dnssd_iv_fullname);
-  return dnssd_struct_inspect(self, StringValue(fullname));
-}
-
-/*
- * call-seq:
- *    DNSSD::Reply.new() => raises a RuntimeError
- *
- */
-static VALUE
-reply_initialize(int argc, VALUE *argv, VALUE reply) {
-  dnssd_instantiation_error(rb_obj_classname(reply));
-  return Qnil;
-}
-
-void
-Init_DNSSD_Replies(void) {
-  int i;
-  VALUE flags_hash;
-  /* hack so rdoc documents the project correctly */
-#ifdef mDNSSD_RDOC_HACK
-  mDNSSD = rb_define_module("DNSSD");
-#endif
-
-  dnssd_iv_flags = rb_intern("@flags");
-  dnssd_iv_interface = rb_intern("@interface");
-  dnssd_iv_fullname = rb_intern("@fullname");
-  dnssd_iv_target = rb_intern("@target");
-  dnssd_iv_port = rb_intern("@port");
-  dnssd_iv_text_record = rb_intern("@text_record");
-  dnssd_iv_name = rb_intern("@name");
-  dnssd_iv_type = rb_intern("@type");
-  dnssd_iv_domain = rb_intern("@domain");
-  dnssd_iv_service = rb_intern("@service");
-
-  cDNSSDFlags = rb_define_class_under(mDNSSD, "Flags", rb_cObject);
-
-  cDNSSDReply = rb_define_class_under(mDNSSD, "Reply", rb_cObject);
-  /* DNSSD::Reply objects can only be instantiated by
-   * DNSSD.browse(), DNSSD.register(), DNSSD.resolve(), DNSSD.enumerate_domains(). */
-  rb_define_method(cDNSSDReply, "initialize", reply_initialize, -1);
-  /* The service associated with the reply.  See DNSSD::Service for more information. */
-  rb_define_attr(cDNSSDReply, "service", 1, 0);
-  /* Flags describing the reply.  See DNSSD::Flags for more information. */
-  rb_define_attr(cDNSSDReply, "flags", 1, 0);
-  /* The service name. (Not used by DNSSD.enumerate_domains().) */
-  rb_define_attr(cDNSSDReply, "name", 1, 0);
-  /* The service type. (Not used by DNSSD.enumerate_domains().) */
-  rb_define_attr(cDNSSDReply, "type", 1, 0);
-  /* The service domain. */
-  rb_define_attr(cDNSSDReply, "domain", 1, 0);
-  /* The interface on which the service is available. (Used only by DNSSSD.resolve().) */
-  rb_define_attr(cDNSSDReply, "interface", 1, 0);
-  /* The full service domain name, in the form "<servicename>.<protocol>.<domain>.".
-   * (Any literal dots (".") are escaped with a backslash ("\."), and literal
-   * backslashes are escaped with a second backslash ("\\"), e.g. a web server
-   * named "Dr. Pepper" would have the fullname  "Dr\.\032Pepper._http._tcp.local.".)
-   * See DNSSD::Service.fullname() for more information. */
-  rb_define_attr(cDNSSDReply, "fullname", 1, 0);
-  /* The service's primary text record, see DNSSD::TextRecord for more information. */
-  rb_define_attr(cDNSSDReply, "text_record", 1, 0);
-  /* The target hostname of the machine providing the service.
-   * This name can be passed to functions like Socket.gethostbyname()
-   * to identify the host's IP address. */
-  rb_define_attr(cDNSSDReply, "target", 1, 0);
-  /* The port on which connections are accepted for this service. */
-  rb_define_attr(cDNSSDReply, "port", 1, 0);
-
-  rb_define_method(cDNSSDReply, "inspect", reply_inspect, 0);
-
-  /* flag constants */
-#if DNSSD_MAX_FLAGS != 9
-#error The code below needs to be updated.
-#endif
-  /* MoreComing indicates that at least one more result is queued and will be delivered following immediately after this one.
-   * Applications should not update their UI to display browse
-   * results when the MoreComing flag is set, because this would
-   * result in a great deal of ugly flickering on the screen.
-   * Applications should instead wait until until MoreComing is not set,
-   * and then update their UI.
-   * When MoreComing is not set, that doesn't mean there will be no more
-   * answers EVER, just that there are no more answers immediately
-   * available right now at this instant. If more answers become available
-   * in the future they will be delivered as usual.
-   */
-  rb_define_const(cDNSSDFlags, "MoreComing", ULONG2NUM(kDNSServiceFlagsMoreComing));
-
-
-  /* Flags for domain enumeration and DNSSD.browse() reply callbacks.
-   * DNSSD::Flags::Default applies only to enumeration and is only valid in
-   * conjuction with DNSSD::Flags::Add.  An enumeration callback with the DNSSD::Flags::Add
-   * flag NOT set indicates a DNSSD::Flags::Remove, i.e. the domain is no longer valid.
-   */
-  rb_define_const(cDNSSDFlags, "Add", ULONG2NUM(kDNSServiceFlagsAdd));
-  rb_define_const(cDNSSDFlags, "Default", ULONG2NUM(kDNSServiceFlagsDefault));
-
-  /* Flag for specifying renaming behavior on name conflict when registering non-shared records.
-   * By default, name conflicts are automatically handled by renaming the service.
-   * DNSSD::Flags::NoAutoRename overrides this behavior - with this
-   * flag set, name conflicts will result in a callback.  The NoAutoRename flag
-   * is only valid if a name is explicitly specified when registering a service
-   * (ie the default name is not used.)
-   */
-  rb_define_const(cDNSSDFlags, "NoAutoRename", ULONG2NUM(kDNSServiceFlagsNoAutoRename));
-
-  /* Flag for registering individual records on a connected DNSServiceRef.
-   * DNSSD::Flags::Shared indicates that there may be multiple records
-   * with this name on the network (e.g. PTR records).  DNSSD::Flags::Unique indicates that the
-   * record's name is to be unique on the network (e.g. SRV records).
-   * (DNSSD::Flags::Shared and DNSSD::Flags::Unique are currently not used by the Ruby API.)
-   */
-  rb_define_const(cDNSSDFlags, "Shared", ULONG2NUM(kDNSServiceFlagsShared));
-  rb_define_const(cDNSSDFlags, "Unique", ULONG2NUM(kDNSServiceFlagsUnique));
-
-  /* Flags for specifying domain enumeration type in DNSSD.enumerate_domains()
-   * (currently not part of the Ruby API).
-   * DNSSD::Flags::BrowseDomains enumerates domains recommended for browsing,
-   * DNSSD::Flags::RegistrationDomains enumerates domains recommended for registration.
-   */
-  rb_define_const(cDNSSDFlags, "BrowseDomains", ULONG2NUM(kDNSServiceFlagsBrowseDomains));
-  rb_define_const(cDNSSDFlags, "RegistrationDomains", ULONG2NUM(kDNSServiceFlagsRegistrationDomains));
-
-  /* Flag for creating a long-lived unicast query for the DNSDS.query_record()
-   * (currently not part of the Ruby API). */
-  rb_define_const(cDNSSDFlags, "LongLivedQuery", ULONG2NUM(kDNSServiceFlagsLongLivedQuery));
-
-  flags_hash = rb_hash_new();
-
-  for (i = 0; i < DNSSD_MAX_FLAGS; i++) {
-    rb_hash_aset(flags_hash, rb_str_new2(dnssd_flag_name[i]),
-		 ULONG2NUM(dnssd_flag[i]));
-  }
-
-  rb_define_const(cDNSSDFlags, "FLAGS", flags_hash);
-}
-
-/* Document-class: DNSSD::Reply
- *
- * DNSSD::Reply is used to return information
- *
- */
-