File Coverage

blib/lib/Dezi/Response.pm

Criterion	Covered	Total	%
statement	18	36	50.0
branch	0	8	0.0
condition			n/a
subroutine	6	7	85.7
pod	1	1	100.0
total	25	52	48.0

package Dezi::Response;
use Moo;
use Types::Standard qw( Str Num Int ArrayRef HashRef InstanceOf Maybe );
use Carp;
use JSON;
use Dezi::Doc;
use namespace::autoclean;

our $VERSION = '0.003004';

has 'http_response' => ( is => 'ro', isa => InstanceOf ['HTTP::Response'] );
has 'results'       => ( is => 'rw', isa => Maybe      [ArrayRef] );
has 'total'         => ( is => 'rw', isa => Int );
has 'search_time'   => ( is => 'rw', isa => Num );
has 'build_time'    => ( is => 'rw', isa => Num );
has 'query'         => ( is => 'rw', isa => Str );
has 'fields'        => ( is => 'rw', isa => Maybe      [ArrayRef] );
has 'facets'        => ( is => 'rw', isa => Maybe      [HashRef] );
has 'suggestions'   => ( is => 'rw', isa => Maybe      [ArrayRef] );

=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 )

Returns a new response. I should be a HTTP::Response
object from a Dezi JSON response.

=head2 BUILDARGS

Allows for single argument I instead of named pair.

=head2 BUILD

Initializes objects.

=cut

around BUILDARGS => sub {
    my $orig  = shift;
    my $class = shift;

    if ( @_ == 1 ) {
        return $class->$orig( http_response => $_[0] );
    }
    else {
        return $class->$orig(@_);
    }
};

sub BUILD {
    my $self = shift;
    my $json = from_json( $self->http_response->decoded_content );

    # inflate json into self, except results
    for my $attr ( keys %$json ) {
        next if $attr eq 'results';

        # set in hash directly if we have no method (yet)
        if ( $self->can($attr) ) {
            $self->$attr( $json->{$attr} );
        }
        else {
            $self->{$attr} = $json->{$attr};
        }
    }
    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
    $self->{results} = \@res;
}

=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

=head2 suggestions

Returns array ref of query suggestions.

=head2 http_response

Returns raw HTTP:Response object.

=cut

1;

__END__