--- trunk/Estraier.pm	2006/01/07 23:48:16	65
+++ trunk/Estraier.pm	2006/01/28 16:43:45	93
@@ -4,7 +4,7 @@
 use strict;
 use warnings;
 
-our $VERSION = '0.02';
+our $VERSION = '0.04_1';
 
 =head1 NAME
 
@@ -12,8 +12,57 @@
 
 =head1 SYNOPSIS
 
-  use Search::Estraier;
-  my $est = new Search::Estraier();
+=head2 Simple indexer
+
+	use Search::Estraier;
+
+	# create and configure node
+	my $node = new Search::Estraier::Node;
+	$node->set_url("http://localhost:1978/node/test");
+	$node->set_auth("admin","admin");
+
+	# create document
+	my $doc = new Search::Estraier::Document;
+
+	# add attributes
+	$doc->add_attr('@uri', "http://estraier.gov/example.txt");
+	$doc->add_attr('@title', "Over the Rainbow");
+
+	# add body text to document
+	$doc->add_text("Somewhere over the rainbow.  Way up high.");
+	$doc->add_text("There's a land that I heard of once in a lullaby.");
+
+	die "error: ", $node->status,"\n" unless ($node->put_doc($doc));
+
+=head2 Simple searcher
+
+	use Search::Estraier;
+
+	# create and configure node
+	my $node = new Search::Estraier::Node;
+	$node->set_url("http://localhost:1978/node/test");
+	$node->set_auth("admin","admin");
+
+	# create condition
+	my $cond = new Search::Estraier::Condition;
+
+	# set search phrase
+	$cond->set_phrase("rainbow AND lullaby");
+
+	my $nres = $node->search($cond, 0);
+	if (defined($nres)) {
+		# for each document in results
+		for my $i ( 0 ... $nres->doc_num - 1 ) {
+			# get result document
+			my $rdoc = $nres->get_doc($i);
+			# display attribte
+			print "URI: ", $rdoc->attr('@uri'),"\n";
+			print "Title: ", $rdoc->attr('@title'),"\n";
+			print $rdoc->snippet,"\n";
+		}
+	} else {
+		die "error: ", $node->status,"\n";
+	}
 
 =head1 DESCRIPTION
 
@@ -25,6 +74,8 @@
 It is implemented as multiple packages which closly resamble Ruby
 implementation. It also includes methods to manage nodes.
 
+There are few examples in C<scripts> directory of this distribution.
+
 =cut
 
 =head1 Inheritable common methods
@@ -106,12 +157,12 @@
 			} elsif ($line =~ m/^$/) {
 				$in_text = 1;
 				next;
-			} elsif ($line =~ m/^(.+)=(.+)$/) {
+			} elsif ($line =~ m/^(.+)=(.*)$/) {
 				$self->{attrs}->{ $1 } = $2;
 				next;
 			}
 
-			warn "draft ignored: $line\n";
+			warn "draft ignored: '$line'\n";
 		}
 	}
 
@@ -269,7 +320,8 @@
 	my $draft;
 
 	foreach my $attr_name (sort keys %{ $self->{attrs} }) {
-		$draft .= $attr_name . '=' . $self->{attrs}->{$attr_name} . "\n";
+		next unless(my $v = $self->{attrs}->{$attr_name});
+		$draft .= $attr_name . '=' . $v . "\n";
 	}
 
 	if ($self->{kwords}) {
@@ -684,6 +736,18 @@
 	return $self->{hints}->{$key};
 }
 
+=head2 hints
+
+More perlish version of C<hint>. This one returns hash.
+
+  my %hints = $rec->hints;
+
+=cut
+
+sub hints {
+	my $self = shift;
+	return $self->{hints};
+}
 
 package Search::Estraier::Node;
 
@@ -703,6 +767,34 @@
 
   my $node = new Search::HyperEstraier::Node( 'http://localhost:1978/node/test' );
 
+or in more verbose form
+
+  my $node = new Search::HyperEstraier::Node(
+  	url => 'http://localhost:1978/node/test',
+	debug => 1,
+	croak_on_error => 1
+  );
+
+with following arguments:
+
+=over 4
+
+=item url
+
+URL to node
+
+=item debug
+
+dumps a B<lot> of debugging output
+
+=item croak_on_error
+
+very helpful during development. It will croak on all errors instead of
+silently returning C<-1> (which is convention of Hyper Estraier API in other
+languages).
+
+=back
+
 =cut
 
 sub new {
@@ -725,7 +817,8 @@
 	} else {
 		my $args = {@_};
 
-		$self->{debug} = $args->{debug};
+		%$self = ( %$self, @_ );
+
 		warn "## Node debug on\n" if ($self->{debug});
 	}
 
@@ -1325,7 +1418,7 @@
 
 =head2 shuttle_url
 
-This is method which uses C<IO::Socket::INET> to communicate with Hyper Estraier node
+This is method which uses C<LWP::UserAgent> to communicate with Hyper Estraier node
 master.
 
   my $rv = shuttle_url( $url, $content_type, $req_body, \$resbody );
@@ -1367,7 +1460,7 @@
 
 	$req->headers->header( 'Host' => $url->host . ":" . $url->port );
 	$req->headers->header( 'Connection', 'close' );
-	$req->headers->header( 'Authorization', 'Basic ' . $self->{auth} );
+	$req->headers->header( 'Authorization', 'Basic ' . $self->{auth} ) if ($self->{auth});
 	$req->content_type( $content_type );
 
 	warn $req->headers->as_string,"\n" if ($self->{debug});
@@ -1381,10 +1474,16 @@
 
 	warn "## response status: ",$res->status_line,"\n" if ($self->{debug});
 
-	return -1 if (! $res->is_success);
-
 	($self->{status}, $self->{status_message}) = split(/\s+/, $res->status_line, 2);
 
+	if (! $res->is_success) {
+		if ($self->{croak_on_error}) {
+			croak("can't get $url: ",$res->status_line);
+		} else {
+			return -1;
+		}
+	}
+
 	$$resbody .= $res->content;
 
 	warn "## response body:\n$$resbody\n" if ($resbody && $self->{debug});
@@ -1484,7 +1583,7 @@
 	$reqbody .= '&credit=' . $credit if ($credit > 0);
 
 	$self->shuttle_url( $self->{url} . '/_set_link',
-		'text/plain',
+		'application/x-www-form-urlencoded',
 		$reqbody,
 		undef
 	) == 200;