package Dezi::Response;
use strict;
use warnings;
our $VERSION = '0.002001';
use Carp;
use JSON;
# TODO expose all attributes?
use Class::XSAccessor {
accessors => [
qw( results total search_time build_time query fields facets suggestions )
],
};
use Dezi::Doc;
=pod
=head1 NAME
Dezi::Response - Dezi search server response
=head1 SYNOPSIS
use Dezi::Client;
my $client = Dezi::Client->new('http://localhost:5000');
my $response = $client->search( q => 'foo' );
# $response isa Dezi::Response
# iterate over results
for my $result (@{ $response->results }) {
printf("--\n uri: %s\n title: %s\n score: %s\n",
$result->uri, $result->title, $result->score);
}
# print stats
printf(" hits: %d\n", $response->total);
printf("search time: %s\n", $response->search_time);
printf(" build time: %s\n", $response->build_time);
printf(" query: %s\n", $response->query);
=head1 DESCRIPTION
Dezi::Response represents a Dezi server response.
This class is used internally by Dezi::Client.
=head1 METHODS
=head2 new( I<http_response> )
Returns a new response. I<http_response> should be a HTTP::Response
object from a Dezi JSON response.
=cut
sub new {
my $class = shift;
my $http_resp = shift or croak "HTTP::Response required";
my $json = from_json( $http_resp->decoded_content );
my @res;
my @fields;
for my $r ( @{ $json->{results} } ) {
if ( !@fields ) {
for my $k ( keys %$r ) {
if ( !Dezi::Doc->can($k) ) {
push @fields, $k;
}
}
}
my %fields = map { $_ => $r->{$_} } @fields;
push @res, Dezi::Doc->new( %$r, _fields => \%fields );
}
# overwrite with objects
$json->{results} = \@res;
return bless $json, $class;
}
=head2 results
Returns array ref of Dezi::Doc objects.
=head2 total
Returns integer of hit count.
=head2 search_time
Returns string of floating point time Dezi server took to search.
=head2 build_time
Returns string of floating point time Dezi server took to build
response.
=head2 query
Returns the query string.
=head2 fields
Returns array ref of field names.
=head2 facets
Returns array ref of facet objects.
B<Facet objects are currently hashrefs. This may change in future.>
=head2 suggestions
Returns array ref of query suggestions.
=cut
1;
__END__
=head1 AUTHOR
Peter Karman, C<< <karman at cpan.org> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-dezi-client at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dezi-Client>. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Dezi::Client
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dezi-Client>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Dezi-Client>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Dezi-Client>
=item * Search CPAN
L<http://search.cpan.org/dist/Dezi-Client/>
=back
=head1 ACKNOWLEDGEMENTS
=head1 COPYRIGHT & LICENSE
Copyright 2011 Peter Karman.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut