Class: Geomash::Parser

Inherits:
Object
  • Object
show all
Defined in:
lib/geomash/parser.rb

Class Method Summary collapse

Class Method Details

.bing_keyObject


13
14
15
# File 'lib/geomash/parser.rb', line 13

def self.bing_key
  Geomash.config[:bing_key] || '<bing_key>'
end

.cache_enabledObject


4
5
6
7
# File 'lib/geomash/parser.rb', line 4

def self.cache_enabled
  return Geomash.config[:parser_cache_enabled] unless Geomash.config[:parser_cache_enabled].nil?
  return false
end

.google_keyObject


17
18
19
# File 'lib/geomash/parser.rb', line 17

def self.google_key
  Geomash.config[:google_key] || '<google_key>'
end

.google_premierObject


21
22
23
# File 'lib/geomash/parser.rb', line 21

def self.google_premier
  Geomash.config[:google_premier] || ['key', 'client', 'channel']
end

.mapquest_keyObject


9
10
11
# File 'lib/geomash/parser.rb', line 9

def self.mapquest_key
  Geomash.config[:mapquest_key] || '<mapquest_key>'
end

.parse_bing_api(term, parse_term_flag = false) ⇒ Object

Note: Limited to only looking at United States places…


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
# File 'lib/geomash/parser.rb', line 30

def self.parse_bing_api(term, parse_term_flag=false)
  return_hash = {}
  retry_count = 3

  #Skip if no bing_key... possibly move this elsewhere?
  return return_hash if self.bing_key == '<bing_key>'

  return_hash[:original_term] = term

  term = Geomash::Standardizer.parse_for_geographic_term(term) if parse_term_flag
  term = Geomash::Standardizer.standardize_geographic_term(term)

  if term.blank?
    return {}
  end

  return_hash[:standardized_term] = term

  #Bing API does badly with parentheses...
  if term.match(/[\(\)]+/)
    return {}
  end

  #Sometimes with building, city, state, bing is dumb and will only return state. Example: Boston Harbor, Boston, Mass.
  #So if not a street address, pass to have google handle it for better results...
  #Example of another bad record: South Street bridge, West Bridgewater, Mass. would give a place in Holyoke
  if term.split(',').length >= 3 && term.match(/\d/).blank? && term.downcase.match(/ave\.*,/).blank? && term.downcase.match(/avenue\.*,/).blank? && term.downcase.match(/street\.*,/).blank? && term.downcase.match(/st\.*,/).blank? && term.downcase.match(/road\.*,/).blank? && term.downcase.match(/rd\.*,/).blank?
    return {}
  end

  ::Geocoder.configure(:lookup => :bing,:api_key => self.bing_key,:timeout => self.timeout, :always_raise => :all)

  begin
    bing_api_result = Geocoder.search(term)
  rescue SocketError => e
    Geocoder::Lookup.get(:bing).cache.expire(Geocoder::Query.new(term).url) if self.cache_enabled #Expire this url
    retry unless (retry_count -= 1).zero?
  rescue Geocoder::OverQueryLimitError => e
    Geocoder::Lookup.get(:bing).cache.expire(Geocoder::Query.new(term).url) if self.cache_enabled #Expire this url
    raise e
  rescue Exception => e
    Geocoder::Lookup.get(:bing).cache.expire(Geocoder::Query.new(term).url) if self.cache_enabled #Expire this url
    raise e
  end


  #Use only for United States results... international results are inaccurate.
  if bing_api_result.present? && bing_api_result.first.data["address"]["countryRegion"] == 'United States'

    if bing_api_result.first.data["entityType"] == 'Neighborhood'
      return {} #Doesn't return a city... Google handles this better.
    end

    if bing_api_result.first.data["address"]["addressLine"].present?
      return_hash[:term_differs_from_tgn] = true
      return_hash[:street_part] = bing_api_result.first.data["address"]["addressLine"]
      return_hash[:coords] = {:latitude=>bing_api_result.first.data["geocodePoints"].first["coordinates"].first.to_s,
                                   :longitude=>bing_api_result.first.data["geocodePoints"].first["coordinates"].last.to_s,
                                   :combined=>bing_api_result.first.data["geocodePoints"].first["coordinates"].first.to_s + ',' + bing_api_result.first.data["geocodePoints"].first["coordinates"].last.to_s}
    end

    return_hash[:country_part] = bing_api_result.first.data["address"]["countryRegion"]

    if return_hash[:country_part] == 'United States'
      return_hash[:state_part] = Geomash::Constants::STATE_ABBR[bing_api_result.first.data["address"]["adminDistrict"]]
    else
      return_hash[:state_part] = bing_api_result.first.data["address"]["adminDistrict"]
    end

    return_hash[:city_part] = bing_api_result.first.data["address"]["locality"]
  else
    return {}
  end

  #Only return if USA for now. International results often awful.
  return return_hash[:country_part] == 'United States' ? return_hash : {}
end

.parse_google_api(term, parse_term_flag = false) ⇒ Object

Final fallback is google API. The best but we are limited to 2500 requests per day unless we pay the $10k a year premium account… Note: If google cannot find street, it will return just city/state, like for “Salem Street and Paradise Road, Swampscott, MA, 01907” Seems like it sets a partial_match=>true in the data section…


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
# File 'lib/geomash/parser.rb', line 188

def self.parse_google_api(term, parse_term_flag=false)
  return_hash = {}
  retry_count = 3

  return_hash[:original_term] = term

  term = Geomash::Standardizer.parse_for_geographic_term(term) if parse_term_flag
  term = Geomash::Standardizer.standardize_geographic_term(term)

  #Soviet Union returns back a place in Kazakhstan
  if term.blank? || term == 'Soviet Union'
    return {}
  end

  #FIXME: Handle just a plain 'Korea' better...
  if term.match(/Korea/) and !term.match(/South/) and !term.match(/North/)
    term.gsub!('Korea', 'South Korea')
  end

  return_hash[:standardized_term] = term

  if self.google_premier != ['key', 'client', 'channel']
    ::Geocoder.configure(:lookup => :google_premier,:api_key => self.google_premier,:timeout => self.timeout, :use_https => true, :always_raise => :all)
  elsif self.google_key != '<google_key>'
    ::Geocoder.configure(:lookup => :google,:api_key => self.google_key,:timeout => self.timeout, :use_https => true, :always_raise => :all)
  else
    ::Geocoder.configure(:lookup => :google,:api_key => nil,:timeout => self.timeout, :always_raise => :all)
  end

  begin
    google_api_result = ::Geocoder.search(term)
  rescue SocketError => e
    Geocoder::Lookup.get(:google).cache.expire(Geocoder::Query.new(term).url) if self.cache_enabled #Expire this url
    retry unless (retry_count -= 1).zero?
  rescue Geocoder::OverQueryLimitError => e
    Geocoder::Lookup.get(:google).cache.expire(Geocoder::Query.new(term).url) if self.cache_enabled #Expire this url
    raise e
  rescue Exception => e
    Geocoder::Lookup.get(:google).cache.expire(Geocoder::Query.new(term).url) if self.cache_enabled #Expire this url
    raise e
  end


  #Check if only a partial match. To avoid errors, strip out the first part and try again...
  #Need better way to check for street endings. See: http://pe.usps.gov/text/pub28/28apc_002.htm
  #Fixme: This breaks Washington DC (Airport)
  if google_api_result.present?
    if google_api_result.first.data['partial_match'] && term.split(',').length > 1 && !term.downcase.include?('street') && !term.downcase.include?('st.') && !term.downcase.include?('avenue') && !term.downcase.include?('ave.') && !term.downcase.include?('court') && !term.downcase.include?('dr.') && !term.downcase.include?('airport')  && !term.downcase.include?('building')
      term = term.split(',')[1..term.split(',').length-1].join(',').strip
      google_api_result = Geocoder.search(term)
    end
  end


  if google_api_result.present?
    #Find the best match index... case of Ho Chi Minh City (Vietnam) resolving to an airport...
    best_match_index = 0
    best_city_match = -1
    best_state_match = -1

    google_api_result.each_with_index do |single_google_api_result, index|
      single_google_api_result.data["address_components"].each do |result|
        if (result['types'] & ['locality']).present?
          if return_hash[:standardized_term].to_ascii.include?(result['long_name'].to_ascii)
            best_city_match = index if best_city_match == -1
          end
        elsif (result['types'] & ['administrative_area_level_1']).present?
          if return_hash[:standardized_term].to_ascii.include?(result['long_name'].to_ascii.gsub('-city', ''))
            best_state_match = index if best_state_match == -1
          end
        end
      end
    end

    if best_city_match != -1
      best_match_index = best_city_match
    elsif best_state_match != -1
      best_match_index = best_state_match
    end


    #Types: street number, route, neighborhood, establishment, transit_station, bus_station
    google_api_result[best_match_index].data["address_components"].each do |result|
      if (result['types'] & ['street number', 'route', 'establishment', 'transit_station', 'bus_station']).present? || (result['types'].include?('neighborhood') && !result['types'].include?('political'))
        #return_hash[:term_differs_from_tgn] = true
        #TODO: Not implemented for Google results right now.
        #return_hash[:street_part] = 'TODO: Not Implemented for Google Results'
        return_hash[:coords] = {:latitude=>google_api_result[best_match_index].data['geometry']['location']['lat'].to_s,
                                     :longitude=>google_api_result[best_match_index].data['geometry']['location']['lng'].to_s,
                                     :combined=>google_api_result[best_match_index].data['geometry']['location']['lat'].to_s + ',' + google_api_result[best_match_index].data['geometry']['location']['lng'].to_s}
      elsif (result['types'] & ['country']).present?
        #gsub to fix a case of "Macedonia" returning "Macedonia (FYROM)"
        return_hash[:country_part] = result['long_name'].gsub(/ \(.+\)$/, '')
      elsif (result['types'] & ['administrative_area_level_1']).present?
        return_hash[:state_part] = result['long_name'].to_ascii.gsub('-city', '')
      elsif (result['types'] & ['locality']).present?
        return_hash[:city_part] = result['long_name']
      elsif (result['types'] & ['sublocality', 'political']).length == 2
          return_hash[:neighborhood_part] ||= result['long_name'] #See term 'Roxbury (Boston, Mass.)' for why neighborhood should take precedence
      elsif result['types'].include?('neighborhood')
        return_hash[:neighborhood_part] = result['long_name']
      end
    end

    return_hash[:term_differs_from_tgn] ||= google_api_result[best_match_index].data['partial_match'] unless google_api_result[best_match_index].data['partial_match'].blank?
  end

  #This changed in Google... twice now actually... need a better way to handle this
  if return_hash[:state_part] == 'Nord-Pas-de-Calais Picardie' || return_hash[:state_part] == 'Nord-Pas-de-Calais-Picardie'
    return_hash[:state_part] = 'Picardy'
  end

  #FIXME: Google free API rate limit is 5 requests / 1 second now (used to be 10). Need a better way to handle this.
  sleep(0.1)

  return return_hash
end

.parse_mapquest_api(term, parse_term_flag = false) ⇒ Object

Mapquest allows unlimited requests - start here?


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
# File 'lib/geomash/parser.rb', line 109

def self.parse_mapquest_api(term, parse_term_flag=false)
  return_hash = {}
  retry_count = 3

  #Skip if no bing_key... possibly move this elsewhere?
  return return_hash if self.mapquest_key == '<mapquest_key>'

  return_hash[:original_term] = term

  term = Geomash::Standardizer.parse_for_geographic_term(term) if parse_term_flag
  term = Geomash::Standardizer.standardize_geographic_term(term)

  if term.blank?
    return {}
  end

  return_hash[:standardized_term] = term

  #Mapquest returns bad data for: Manchester, Mass.
  if term.include?('Manchester') || term.include?('Atlanta, MI')
    return {}
  end

  #Messed up with just neighborhoods. Example: Hyde Park (Boston, Mass.) or Hyde Park (Boston, Mass.)
  #So if not a street address, pass to have google handle it for better results...
  if term.split(',').length >= 3 && term.match(/\d/).blank? && term.downcase.match(/ave\.*,/).blank? && term.downcase.match(/avenue\.*,/).blank? && term.downcase.match(/street\.*,/).blank? && term.downcase.match(/st\.*,/).blank? && term.downcase.match(/road\.*,/).blank? && term.downcase.match(/rd\.*,/).blank?
    return {}
  end

  ::Geocoder.configure(:lookup => :mapquest,:api_key => self.mapquest_key,:timeout => self.timeout, :always_raise => :all)

  begin
    mapquest_api_result = Geocoder.search(term)
  rescue SocketError => e
    Geocoder::Lookup.get(:mapquest).cache.expire(Geocoder::Query.new(term).url) if self.cache_enabled #Expire this url
    retry unless (retry_count -= 1).zero?
  rescue Geocoder::OverQueryLimitError => e
    Geocoder::Lookup.get(:mapquest).cache.expire(Geocoder::Query.new(term).url) if self.cache_enabled #Expire this url
    raise e
  rescue Exception => e
    Geocoder::Lookup.get(:mapquest).cache.expire(Geocoder::Query.new(term).url) if self.cache_enabled #Expire this url
    raise e
  end

  #If this call returned a result...
  if mapquest_api_result.present?

    if mapquest_api_result.first.data["street"].present?
      #return_hash[:term_differs_from_tgn] = true
      return_hash[:street_part] = mapquest_api_result.first.data["street"]
      return_hash[:coords] = {:latitude=>mapquest_api_result.first.data['latLng']['lat'].to_s,
                                   :longitude=>mapquest_api_result.first.data['latLng']['lng'].to_s,
                                   :combined=>mapquest_api_result.first.data['latLng']['lat'].to_s + ',' + mapquest_api_result.first.data['latLng']['lng'].to_s}
    end

    return_hash[:country_part] = ISO3166::Country.new(mapquest_api_result.first.data["adminArea1"]).name

    if return_hash[:country_part] == 'United States'
      return_hash[:state_part] = Geomash::Constants::STATE_ABBR[mapquest_api_result.first.data["adminArea3"]] || mapquest_api_result.first.data["adminArea4"]
    else
      return_hash[:state_part] = mapquest_api_result.first.data["adminArea3"].gsub(' province', '')
    end

    return_hash[:city_part] = mapquest_api_result.first.data["adminArea5"]

    return_hash[:city_part] = return_hash[:city_part].gsub(' City', '') #Return New York as New York City...
  end

  #Only return if USA for now. Google is better with stuff like: 'Long Binh, Vietnam'
  #Also only return if there is a city if there were more than two terms passed in. Fixes: Roxbury, MA
  return {} unless return_hash[:country_part] == 'United States'
  return {} if term.split(',').length >= 2 && return_hash[:city_part].blank?

  return return_hash
end

.timeoutObject


25
26
27
# File 'lib/geomash/parser.rb', line 25

def self.timeout
  Geomash.config[:timeout]
end