-
Notifications
You must be signed in to change notification settings - Fork 0
/
Bing.pm
306 lines (213 loc) · 7.89 KB
/
Bing.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
package Geo::Coder::Bing;
use strict;
use warnings;
use Carp qw(carp croak);
use Encode ();
use JSON;
use LWP::UserAgent;
use URI;
our $VERSION = '0.12';
$VERSION = eval $VERSION;
sub new {
my ($class, @params) = @_;
my %params = (@params % 2) ? (key => @params) : @params;
carp 'Provide a Bing Maps key to use the new REST API'
unless $params{key};
my $self = bless \ %params, $class;
$self->ua(
$params{ua} || LWP::UserAgent->new(agent => "$class/$VERSION")
);
if ($self->{debug}) {
my $dump_sub = sub { $_[0]->dump(maxlength => 0); return };
$self->ua->set_my_handler(request_send => $dump_sub);
$self->ua->set_my_handler(response_done => $dump_sub);
$self->{compress} ||= 0;
}
if (exists $self->{compress} ? $self->{compress} : 1) {
$self->ua->default_header(accept_encoding => 'gzip,deflate');
}
croak q('https' requires LWP::Protocol::https)
if $self->{https} and not $self->ua->is_protocol_supported('https');
return $self;
}
sub response { $_[0]->{response} }
sub ua {
my ($self, $ua) = @_;
if ($ua) {
croak q('ua' must be (or derived from) an LWP::UserAgent')
unless ref $ua and $ua->isa(q(LWP::UserAgent));
$self->{ua} = $ua;
}
return $self->{ua};
}
sub geocode {
return $_[0]->{key} ? &_geocode_rest : &_geocode_ajax;
}
sub _geocode_rest {
my ($self, @params) = @_;
my %params = (@params % 2) ? (location => @params) : @params;
$params{query} = delete $params{location} or return;
$_ = Encode::encode('utf-8', $_) for values %params;
my $uri = URI->new('http://dev.virtualearth.net/REST/v1/Locations');
$uri->scheme('https') if $self->{https};
$uri->query_form(
key => $self->{key},
%params,
);
my $res = $self->{response} = $self->ua->get($uri);
return unless $res->is_success;
# Change the content type of the response from 'application/json' so
# HTTP::Message will decode the character encoding.
$res->content_type('text/plain');
my $content = $res->decoded_content;
return unless $content;
my $data = eval { from_json($content) };
return unless $data;
my @results = @{ $data->{resourceSets}[0]{resources} || [] };
return wantarray ? @results : $results[0];
}
# Support AJAX API for backwards compatibility.
sub _geocode_ajax {
my ($self, @params) = @_;
my %params = (@params % 2) ? (location => @params) : @params;
my $location = $params{location} or return;
$location = Encode::encode('utf-8', $location);
my $uri = URI->new('http://dev.virtualearth.net/');
$uri->scheme('https') if $self->{https};
$uri->path_segments(qw(
services v1 geocodeservice geocodeservice.asmx Geocode
));
$uri->query_form(
format => 'json',
# Note: the quotes around the location parameter are required.
query => qq("$location"),
# These are all required, even if empty.
map { $_ => '' } qw(
addressLine adminDistrict count countryRegion culture
curLocAccuracy currentLocation district entityTypes landmark
locality mapBounds postalCode postalTown rankBy
),
);
my $res = $self->{response} = $self->ua->get($uri);
return unless $res->is_success;
# Change the content type of the response from 'application/json' so
# HTTP::Message will decode the character encoding.
$res->content_type('text/plain');
my $content = $res->decoded_content;
return unless $content;
# Workaround invalid data.
$content =~ s[ \}\.d $ ][}]x;
my $data = eval { from_json($content) };
return unless $data;
my @results = @{ $data->{d}{Results} || [] };
return wantarray ? @results : $results[0];
}
1;
__END__
=head1 NAME
Geo::Coder::Bing - Geocode addresses with the Bing Maps API
=head1 SYNOPSIS
use Geo::Coder::Bing;
my $geocoder = Geo::Coder::Bing->new(key => 'Your Bing Maps key');
my $location = $geocoder->geocode(
location => 'Hollywood and Highland, Los Angeles, CA'
);
=head1 DESCRIPTION
The C<Geo::Coder::Bing> module provides an interface to the Bing Maps
geocoding service.
=head1 METHODS
=head2 new
$geocoder = Geo::Coder::Bing->new('Your Bing Maps key')
$geocoder = Geo::Coder::Bing->new(
key => 'Your Bing Maps key',
# https => 1,
# debug => 1,
)
Creates a new geocoding object.
A Bing Maps key can be obtained here:
L<http://msdn.microsoft.com/en-us/library/ff428642.aspx>.
Accepts an optional B<https> parameter for securing network traffic.
Accepts an optional B<ua> parameter for passing in a custom LWP::UserAgent
object.
=head2 geocode
$location = $geocoder->geocode(location => $location)
@locations = $geocoder->geocode(location => $location)
In scalar context, this method returns the first location result; and in
list context it returns all location results.
Any additional arguments will added to the request parameters. See the Bing
Maps documention for the list of available parameters. An example:
@locations = $geocoder->geocode(
location => $location,
includeNeighborhood => 1,
maxResults => 20,
)
Each location result is a hashref; a typical example looks like:
{
__type =>
"Location:http://schemas.microsoft.com/search/local/ws/rest/v1",
address => {
addressLine => "Hollywood Blvd & N Highland Ave",
adminDistrict => "CA",
countryRegion => "United States",
formattedAddress =>
"Hollywood Blvd & N Highland Ave, Los Angeles, CA 90028",
locality => "Los Angeles",
postalCode => 90028,
},
bbox => [
"34.0977008647939", "-118.344888641665",
"34.1054262999352", "-118.332449571785",
],
confidence => "High",
entityType => "RoadIntersection",
name => "Hollywood Blvd & N Highland Ave, Los Angeles, CA 90028",
point => {
coordinates => [ "34.1015635823646", "-118.338669106725" ],
type => "Point",
},
}
=head2 response
$response = $geocoder->response()
Returns an L<HTTP::Response> object for the last submitted request. Can be
used to determine the details of an error.
=head2 ua
$ua = $geocoder->ua()
$ua = $geocoder->ua($ua)
Accessor for the UserAgent object.
=head1 NOTES
Starting with version 0.08, this module uses the REST API instead of the
AJAX API. Backwards compatibility has been maintained, but its usage by this
module is now deprecated, hence a warning is issued when a key is not
provided to the constructor. Also note that the structure of the data
returned from both APIs differs slightly.
=head1 SEE ALSO
L<http://msdn.microsoft.com/en-us/library/ff701711.aspx>
L<Geo::Coder::Bing::Bulk>
=head1 REQUESTS AND BUGS
Please report any bugs or feature requests to
L<http://rt.cpan.org/Public/Bug/Report.html?Queue=Geo-Coder-Bing>. 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::Coder::Bing
You can also look for information at:
=over
=item * GitHub Source Repository
L<http://github.com/gray/geo-coder-bing>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Geo-Coder-Bing>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Geo-Coder-Bing>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/Public/Dist/Display.html?Name=Geo-Coder-Bing>
=item * Search CPAN
L<http://search.cpan.org/dist/Geo-Coder-Bing/>
=back
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2009-2014 gray <gray at cpan.org>, all rights reserved.
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=head1 AUTHOR
gray, <gray at cpan.org>
=cut