The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Search-OpenSearch-Server-0.10
River stage one • 2 direct dependents • 5 total dependents
++
/ Search::OpenSearch::Server::Plack

NAME

Search::OpenSearch::Server::Plack - serve OpenSearch results with Plack

SYNOPSIS

 # write a PSGI application in yourapp.psgi
 use strict;
 use warnings;
 use Plack::Builder;
 use Search::OpenSearch::Server::Plack;
 
 my $engine_config = {
    type   => 'Lucy',
    index  => ['path/to/your/index'],
    facets => {
        names       => [qw( topics people places orgs author )],
        sample_size => 10_000,
    },
    fields => [qw( topics people places orgs author )],
 };

 my $app = Search::OpenSearch::Server::Plack->new( 
    engine_config => $engine_config
 );

 builder {
    mount '/' => $app;
 };

 
 # run the app
 % plackup yourapp.psgi

DESCRIPTION

Search::OpenSearch::Server::Plack is a Plack::Middleware application. This module implements a HTTP-ready Search::OpenSearch server using Plack.

METHODS

call

Implements the required Middleware method. The default behavior is to instantiate a Plack::Request and pass it into do_search().

prepare_app

Calls setup_engine().

setup_engine

Instantiates the Search::OpenSearch::Engine, if necessary, using the values set in engine_config().

do_search( request )

The meat of the application. This method checks params in request, mapping them to the Search::OpenSearch::Engine API.

Returns a Plack::Reponse, finalize()d.

do_rest_api( request )

If the Engine used supports has_rest_api(), this method calls the appropriate HTTP method on the Engine object.

The following HTTP headers are supported for explicitly setting the indexer behavior:

X-SOS-Content-Location
X-SOS-Last-Modified
X-SOS-Parser-Type
X-SOS-Content-Type
X-SOS-Encoding

handle_no_query( response )

If no 'q' param is present in the Plack::Request, this method is called. The default behavior is to set a 400 (bad request) with error message. You can override it to behave more kindly.

AUTHOR

Peter Karman, <karman at cpan.org>

BUGS

Please report any bugs or feature requests to bug-search-opensearch-server at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Search-OpenSearch-Server. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Search::OpenSearch::Server

You can also look for information at:

COPYRIGHT & LICENSE

Copyright 2010 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.