File Coverage

blib/lib/Geo/Parser/Text.pm

Criterion	Covered	Total	%
statement	35	75	46.6
branch	0	4	0.0
condition			n/a
subroutine	12	16	75.0
pod	2	4	50.0
total	49	99	49.4

package Geo::Parser::Text;

use 5.006;
use strict;
use warnings;
use utf8::all;
use open ':utf8';

use XML::Simple;
use LWP::UserAgent;
use HTTP::Request;
use URI;
use Data::Dumper;


use constant DEBUG    => 0;
use constant GEO_HOST => q{https://geocode.xyz};

sub new {
    my $class = shift;
    my $self = {
        geo_host        => shift
    };

    bless ($self, $class);
    return $self;
}

sub geodata {
  my $self = shift;
  $self->{geodata} = $_[0] if $_[0];
  return $self->{geodata};
}

sub geocode {
  my $self    = shift;
	my %params = @_;

  my %form_values;
  foreach my $param (keys %params) {
    $form_values{$param} = $params{$param};
  }
  $form_values{geoit} = 'XML'; #default

warn Data::Dumper->Dump([\%form_values],['Form Values']) if DEBUG;

  $self->process_request(%form_values);

    my $geodata    = $self->geodata;
	my @a = split(//,$geodata);
	my $geod = pop @a;
	$geod = '' . $geod;
	my %t;
	my $ref = \%t;

	eval {
	$ref = XMLin($geod);
	};
  warn Data::Dumper->Dump([$ref],['Response']) if DEBUG;

  $self->geodata($ref);

  return $self->geodata;

}

sub process_request {
  my $self        = shift;
  my %form_values = @_;
  $self->{geo_host} = GEO_HOST unless $self->{geo_host};

  my $uri = URI->new;
  $uri->query_form(%form_values);
  my $ua  = LWP::UserAgent->new;
  my $req = HTTP::Request->new(POST => $self->{geo_host});
  $req->content_type('application/x-www-form-urlencoded');
  $req->content($uri->query);

  my $res    = $ua->request($req);
  my $result = $res->as_string;

warn $result if DEBUG;

  my $geodata = $result;


  return $self->geodata($geodata);
}



=head1 NAME

Geo::Parser::Text - Perl extension for geoparsing, geocoding and standardizing locations from free form text. Worldwide Coverage. Geocode places to latitude, longitude, elevation.
And vice-versa.

=head1 VERSION

Version 0.051

=cut

our $VERSION = '0.051';


=head1 SYNOPSIS

	use Geo::Parser::Text;

	# initialize with your host
	my $g = Geo::Parser::Text->new([geo_host]);

	# Scan text in $str for locations...
 	my $hashref = $g->geocode(scantext=>$str);

        # Geocode a single location from $str...
        my $hashref = $g->geocode(locate=>$str);
        #

	# Example...

	#!/usr/bin/perl
	use strict;
	use Geo::Parser::Text;
	use Data::Dumper;
	my $g = Geo::Parser::Text->new('https://geocode.xyz');
	my $str = "The most important museums of Amsterdam are located on the Museumplein, located at the southwestern side of the Rijksmuseum.";
	my $ref = $g->geocode(scantext=>$str,region=>'NL');
	print Dumper $ref;

	#expected response
	$Response = {
          'match' => [
                     {
                       'longt' => '4.88355',
                       'location' => 'RIJKSMUSEUM, AMSTERDAM, NL',
                       'matchtype' => 'street',
                       'confidence' => '1.0',
                       'MentionIndices' => '112',
                       'latt' => '52.35976'
                     },
                     {
                       'longt' => '4.87986',
                       'location' => 'MUSEUMPLEIN, AMSTERDAM, NL',
                       'matchtype' => 'street',
                       'confidence' => '1.0',
                       'MentionIndices' => '59',
                       'latt' => '52.35791'
                     },
                     {
                       'longt' => '4.89574',
                       'location' => 'Amsterdam,NL',
                       'matchtype' => 'locality',
                       'confidence' => '0.4',
                       'MentionIndices' => '30',
                       'latt' => '52.36014'
                     }
                   ]
        };


    	#or

	#forward geocode and cleanup/standardize input address

	my $ref = $g->geocode(locate=>'10 Downing St, Londino UK');
  	print Dumper $ref;

	#expected response
	$Response  = {
          'standard' => {
                        'stnumber' => '10',
                        'addresst' => 'DOWNING STREET',
                        'city' => 'Londino',
                        'prov' => 'UK',
                        'countryname' => 'United Kingdom',
                        'postal' => {},
                        'confidence' => '0.60'
                      },
          'longt' => '-0.12768',
          'elevation' => {},
          'latt' => '51.50354'
        };



	#reverse geocode
	my $ref = $g->geocode(locate=>'51.5034066,-0.1275923');
        print Dumper $ref;

	#expected response
	$Response = {
              'confidence' => '0.9',
              'distance' => '0',
              'city' => 'London',
              'inlatt' => '51.50341',
              'stnumber' => '9',
              'latt' => '51.50328',
              'postal' => 'SW1A 2AG',
              'staddress' => 'Downing Street',
              'longt' => '-0.12751',
              'inlongt' => '-0.12759',
              'prov' => 'UK'
            };


=head1 DESCRIPTION

This module provides a Perl front end for the geocode.xyz, geocoder.ca API.

It allows the programmer to extract locations containing street addresses, street intersections and city names along with their geocoded latitude,longitude from bodies of text such as microblogs or wikipedia entries. (It should work with any type of text, but dumping html text or paragraphs containing over 200 words, will slow down the response.

If you need faster parsing grab the geocode.xyz server image on the AWS, and run it on a faster server.

If you run your own instance, make sure to pass the instance ip address or domain name at invocation eg, Geo::Parser::Text->new($server). For North American locations use geocoder.ca

The api also geocodes single locations (returning the location matched with the highest probability from a string of text. If you pass a latitude,longitude pair, it will reverse geocode that point)

Geocoding requests also return the elevation value of the point in meters.

For explanation on the API responses see https://geocode.xyz/api

=head2 METHODS

=head2 new

my $geo = new ( host => 'https://geocode.xyz');

Initialize with the default server. https://geocode.xyz for Worldwide coverage, https://geocoder.ca for North America.

=head2 geocode

my $ref = $geo->geocode(locate=>'Paris France');
or
my $ref = $geo->geocode(scantext=>'Paris France');

Set the text to be scanned or string to be geocoded and return a hash reference with the response.

Takes a hash of parameter names and values.
You are required to pass a hash to geocode with either the scantext or locate key set to the text you want to geocode/geoparse.

You may also pass other optional arguments as described in the API at https://geocode.xyz/api.

Foe eg:
my $ref = $geo->geocode(locate=>'Paris France', auth=>'your auth code for unthrottled access', region=>'FR');



=over 1

=back
=head1 EXPORT

None by default.


=head1 REQUIREMENTS

XML::Simple,
LWP::UserAgent,
HTTP::Request,
URI
Data::Dumper

=head1 SEE ALSO

This module was featured in the 2016 Perl Advent Calendar. L.

=head1 AUTHOR

Ervin Ruci, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  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 Geo::Parser::Text


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2018 Ervin Ruci.

This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:

L

Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


=head1 SEE ALSO

Geo::Coder::CA
Geo::Coder::List
HTML::GoogleMaps::V3
Geo::Coder::OpenCage
Geo::Parse::OSM
Text::NLP
=cut

1; # End of Geo::Parser::Text