Module: Net::DND

Defined in:

lib/net/dnd.rb,
lib/net/dnd/field.rb,
lib/net/dnd/errors.rb,
lib/net/dnd/expires.rb,
lib/net/dnd/profile.rb,
lib/net/dnd/session.rb,
lib/net/dnd/version.rb,
lib/net/dnd/response.rb,
lib/net/dnd/user_spec.rb,
lib/net/dnd/connection.rb

Overview

Inspired by the outstanding work done by Jamis Buck on the Net::SSH family of gems/libraries, this new version of Net::DND aims to be a much better interface for working with the Dartmouth Name Directory (DND) protocol.

In the first (1.0.0) release, the focus is still on providing primarily user finding facilites, however, the architecture has been re-worked to allow for fairly easy support of the rest of the DND protocol, should the need ever arise.

Contained here, in the module/librtary wrapper file, is the primary ‘start’ method, which allows for straightforward session/connection management. The intent is to call this method with a block construct, like this:

Net::DND.start("your.dnd.server", fields) do |dnd|
  profile = dnd.find("some user")
end

But you don’t need to use the block version. You can simply call the start method and it will return a DND session object. You can then send find commands to that object. Used in this way, you have to remember to explicitly close the DND session, as below:

dnd = Net::DND.start('dnd.dartmouth.edu', %w(name nickname uid))
profile = dnd.find('Throckmorton Scribblemonger', :one)
dnd.close
puts profile.nickname
 > throckie

All calls to the find command, whether it’s restricted to a single match or not, will return Net::DND::Profile objects. The profile object(s) will contain getter methods for the field names specified in the start call. If no fields are supplied, the DND session, and therefore all returned profile objects will contain the full set of publicly viewable fields from the partiuclar DND server to which you’ve connected.

Defined Under Namespace

Modules: Expires Classes: Connection, ConnectionClosed, ConnectionError, Error, Field, FieldAccessDenied, FieldLineInvalid, FieldNotFound, InvalidResponse, Profile, Response, Session, UserSpec

Constant Summary

MAJOR =

1

MINOR =

1

PATCH =

2

VERSION =

[MAJOR, MINOR, PATCH].join(".")

Class Method Summary

• .start(host, fields = [], &block) ⇒ Object

Class Method Details

.start(host, fields = [], &block) ⇒ Object

# File 'lib/net/dnd.rb', line 40

def self.start(host, fields=[], &block)
  session = Session.start(host, fields)
  if block_given?
    yield session
    session.close
  else
    return session
  end
end