geocoder 1.6.6 → 1.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -2
- data/README.md +318 -206
- data/lib/generators/geocoder/config/templates/initializer.rb +7 -1
- data/lib/geocoder/cache.rb +12 -33
- data/lib/geocoder/cache_stores/base.rb +40 -0
- data/lib/geocoder/cache_stores/generic.rb +35 -0
- data/lib/geocoder/cache_stores/redis.rb +34 -0
- data/lib/geocoder/configuration.rb +7 -2
- data/lib/geocoder/ip_address.rb +6 -0
- data/lib/geocoder/lookup.rb +16 -2
- data/lib/geocoder/lookups/abstract_api.rb +46 -0
- data/lib/geocoder/lookups/amazon_location_service.rb +54 -0
- data/lib/geocoder/lookups/base.rb +8 -2
- data/lib/geocoder/lookups/bing.rb +1 -1
- data/lib/geocoder/lookups/geoapify.rb +72 -0
- data/lib/geocoder/lookups/geoip2.rb +4 -0
- data/lib/geocoder/lookups/ip2location.rb +10 -6
- data/lib/geocoder/lookups/ipdata_co.rb +1 -1
- data/lib/geocoder/lookups/ipqualityscore.rb +50 -0
- data/lib/geocoder/lookups/melissa_street.rb +41 -0
- data/lib/geocoder/lookups/photon.rb +89 -0
- data/lib/geocoder/lookups/uk_ordnance_survey_names.rb +1 -1
- data/lib/geocoder/results/abstract_api.rb +146 -0
- data/lib/geocoder/results/amazon_location_service.rb +57 -0
- data/lib/geocoder/results/esri.rb +5 -2
- data/lib/geocoder/results/geoapify.rb +179 -0
- data/lib/geocoder/results/ipqualityscore.rb +54 -0
- data/lib/geocoder/results/mapbox.rb +10 -4
- data/lib/geocoder/results/melissa_street.rb +46 -0
- data/lib/geocoder/results/photon.rb +119 -0
- data/lib/geocoder/version.rb +1 -1
- metadata +17 -2
@@ -0,0 +1,89 @@
|
|
1
|
+
require 'geocoder/lookups/base'
|
2
|
+
require 'geocoder/results/photon'
|
3
|
+
|
4
|
+
module Geocoder::Lookup
|
5
|
+
class Photon < Base
|
6
|
+
def name
|
7
|
+
'Photon'
|
8
|
+
end
|
9
|
+
|
10
|
+
private # ---------------------------------------------------------------
|
11
|
+
|
12
|
+
def supported_protocols
|
13
|
+
[:https]
|
14
|
+
end
|
15
|
+
|
16
|
+
def base_query_url(query)
|
17
|
+
host = configuration[:host] || 'photon.komoot.io'
|
18
|
+
method = query.reverse_geocode? ? 'reverse' : 'api'
|
19
|
+
"#{protocol}://#{host}/#{method}?"
|
20
|
+
end
|
21
|
+
|
22
|
+
def results(query)
|
23
|
+
return [] unless (doc = fetch_data(query))
|
24
|
+
return [] unless doc['type'] == 'FeatureCollection'
|
25
|
+
return [] unless doc['features'] || doc['features'].present?
|
26
|
+
|
27
|
+
doc['features']
|
28
|
+
end
|
29
|
+
|
30
|
+
def query_url_params(query)
|
31
|
+
lang = query.language || configuration.language
|
32
|
+
params = { lang: lang, limit: query.options[:limit] }
|
33
|
+
|
34
|
+
if query.reverse_geocode?
|
35
|
+
params.merge!(query_url_params_reverse(query))
|
36
|
+
else
|
37
|
+
params.merge!(query_url_params_coordinates(query))
|
38
|
+
end
|
39
|
+
|
40
|
+
params.merge!(super)
|
41
|
+
end
|
42
|
+
|
43
|
+
def query_url_params_coordinates(query)
|
44
|
+
params = { q: query.sanitized_text }
|
45
|
+
|
46
|
+
if (bias = query.options[:bias])
|
47
|
+
params.merge!(lat: bias[:latitude], lon: bias[:longitude], location_bias_scale: bias[:scale])
|
48
|
+
end
|
49
|
+
|
50
|
+
if (filter = query_url_params_coordinates_filter(query))
|
51
|
+
params.merge!(filter)
|
52
|
+
end
|
53
|
+
|
54
|
+
params
|
55
|
+
end
|
56
|
+
|
57
|
+
def query_url_params_coordinates_filter(query)
|
58
|
+
filter = query.options[:filter]
|
59
|
+
return unless filter
|
60
|
+
|
61
|
+
bbox = filter[:bbox]
|
62
|
+
{
|
63
|
+
bbox: bbox.is_a?(Array) ? bbox.join(',') : bbox,
|
64
|
+
osm_tag: filter[:osm_tag]
|
65
|
+
}
|
66
|
+
end
|
67
|
+
|
68
|
+
def query_url_params_reverse(query)
|
69
|
+
params = { lat: query.coordinates[0], lon: query.coordinates[1], radius: query.options[:radius] }
|
70
|
+
|
71
|
+
if (dsort = query.options[:distance_sort])
|
72
|
+
params[:distance_sort] = dsort ? 'true' : 'false'
|
73
|
+
end
|
74
|
+
|
75
|
+
if (filter = query_url_params_reverse_filter(query))
|
76
|
+
params.merge!(filter)
|
77
|
+
end
|
78
|
+
|
79
|
+
params
|
80
|
+
end
|
81
|
+
|
82
|
+
def query_url_params_reverse_filter(query)
|
83
|
+
filter = query.options[:filter]
|
84
|
+
return unless filter
|
85
|
+
|
86
|
+
{ query_string_filter: filter[:string] }
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
@@ -0,0 +1,146 @@
|
|
1
|
+
require 'geocoder/results/base'
|
2
|
+
|
3
|
+
module Geocoder
|
4
|
+
module Result
|
5
|
+
class AbstractApi < Base
|
6
|
+
|
7
|
+
##
|
8
|
+
# Geolocation
|
9
|
+
|
10
|
+
def state
|
11
|
+
@data['region']
|
12
|
+
end
|
13
|
+
|
14
|
+
def state_code
|
15
|
+
@data['region_iso_code']
|
16
|
+
end
|
17
|
+
|
18
|
+
def city
|
19
|
+
@data["city"]
|
20
|
+
end
|
21
|
+
|
22
|
+
def city_geoname_id
|
23
|
+
@data["city_geoname_id"]
|
24
|
+
end
|
25
|
+
|
26
|
+
def region_geoname_id
|
27
|
+
@data["region_geoname_id"]
|
28
|
+
end
|
29
|
+
|
30
|
+
def postal_code
|
31
|
+
@data["postal_code"]
|
32
|
+
end
|
33
|
+
|
34
|
+
def country
|
35
|
+
@data["country"]
|
36
|
+
end
|
37
|
+
|
38
|
+
def country_code
|
39
|
+
@data["country_code"]
|
40
|
+
end
|
41
|
+
|
42
|
+
def country_geoname_id
|
43
|
+
@data["country_geoname_id"]
|
44
|
+
end
|
45
|
+
|
46
|
+
def country_is_eu
|
47
|
+
@data["country_is_eu"]
|
48
|
+
end
|
49
|
+
|
50
|
+
def continent
|
51
|
+
@data["continent"]
|
52
|
+
end
|
53
|
+
|
54
|
+
def continent_code
|
55
|
+
@data["continent_code"]
|
56
|
+
end
|
57
|
+
|
58
|
+
def continent_geoname_id
|
59
|
+
@data["continent_geoname_id"]
|
60
|
+
end
|
61
|
+
|
62
|
+
##
|
63
|
+
# Security
|
64
|
+
|
65
|
+
def is_vpn?
|
66
|
+
@data.dig "security", "is_vpn"
|
67
|
+
end
|
68
|
+
|
69
|
+
##
|
70
|
+
# Timezone
|
71
|
+
|
72
|
+
def timezone_name
|
73
|
+
@data.dig "timezone", "name"
|
74
|
+
end
|
75
|
+
|
76
|
+
def timezone_abbreviation
|
77
|
+
@data.dig "timezone", "abbreviation"
|
78
|
+
end
|
79
|
+
|
80
|
+
def timezone_gmt_offset
|
81
|
+
@data.dig "timezone", "gmt_offset"
|
82
|
+
end
|
83
|
+
|
84
|
+
def timezone_current_time
|
85
|
+
@data.dig "timezone", "current_time"
|
86
|
+
end
|
87
|
+
|
88
|
+
def timezone_is_dst
|
89
|
+
@data.dig "timezone", "is_dst"
|
90
|
+
end
|
91
|
+
|
92
|
+
##
|
93
|
+
# Flag
|
94
|
+
|
95
|
+
def flag_emoji
|
96
|
+
@data.dig "flag", "emoji"
|
97
|
+
end
|
98
|
+
|
99
|
+
def flag_unicode
|
100
|
+
@data.dig "flag", "unicode"
|
101
|
+
end
|
102
|
+
|
103
|
+
def flag_png
|
104
|
+
@data.dig "flag", "png"
|
105
|
+
end
|
106
|
+
|
107
|
+
def flag_svg
|
108
|
+
@data.dig "flag", "svg"
|
109
|
+
end
|
110
|
+
|
111
|
+
##
|
112
|
+
# Currency
|
113
|
+
|
114
|
+
def currency_currency_name
|
115
|
+
@data.dig "currency", "currency_name"
|
116
|
+
end
|
117
|
+
|
118
|
+
def currency_currency_code
|
119
|
+
@data.dig "currency", "currency_code"
|
120
|
+
end
|
121
|
+
|
122
|
+
##
|
123
|
+
# Connection
|
124
|
+
|
125
|
+
def connection_autonomous_system_number
|
126
|
+
@data.dig "connection", "autonomous_system_number"
|
127
|
+
end
|
128
|
+
|
129
|
+
def connection_autonomous_system_organization
|
130
|
+
@data.dig "connection", "autonomous_system_organization"
|
131
|
+
end
|
132
|
+
|
133
|
+
def connection_connection_type
|
134
|
+
@data.dig "connection", "connection_type"
|
135
|
+
end
|
136
|
+
|
137
|
+
def connection_isp_name
|
138
|
+
@data.dig "connection", "isp_name"
|
139
|
+
end
|
140
|
+
|
141
|
+
def connection_organization_name
|
142
|
+
@data.dig "connection", "organization_name"
|
143
|
+
end
|
144
|
+
end
|
145
|
+
end
|
146
|
+
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
require 'geocoder/results/base'
|
2
|
+
|
3
|
+
module Geocoder::Result
|
4
|
+
class AmazonLocationService < Base
|
5
|
+
def initialize(result)
|
6
|
+
@place = result
|
7
|
+
end
|
8
|
+
|
9
|
+
def coordinates
|
10
|
+
[@place.geometry.point[1], @place.geometry.point[0]]
|
11
|
+
end
|
12
|
+
|
13
|
+
def address
|
14
|
+
@place.label
|
15
|
+
end
|
16
|
+
|
17
|
+
def neighborhood
|
18
|
+
@place.neighborhood
|
19
|
+
end
|
20
|
+
|
21
|
+
def route
|
22
|
+
@place.street
|
23
|
+
end
|
24
|
+
|
25
|
+
def city
|
26
|
+
@place.municipality || @place.sub_region
|
27
|
+
end
|
28
|
+
|
29
|
+
def state
|
30
|
+
@place.region
|
31
|
+
end
|
32
|
+
|
33
|
+
def state_code
|
34
|
+
@place.region
|
35
|
+
end
|
36
|
+
|
37
|
+
def province
|
38
|
+
@place.region
|
39
|
+
end
|
40
|
+
|
41
|
+
def province_code
|
42
|
+
@place.region
|
43
|
+
end
|
44
|
+
|
45
|
+
def postal_code
|
46
|
+
@place.postal_code
|
47
|
+
end
|
48
|
+
|
49
|
+
def country
|
50
|
+
@place.country
|
51
|
+
end
|
52
|
+
|
53
|
+
def country_code
|
54
|
+
@place.country
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
@@ -16,11 +16,14 @@ module Geocoder::Result
|
|
16
16
|
end
|
17
17
|
end
|
18
18
|
|
19
|
-
def
|
19
|
+
def state
|
20
20
|
attributes['Region']
|
21
21
|
end
|
22
22
|
|
23
|
-
|
23
|
+
def state_code
|
24
|
+
abbr = attributes['RegionAbbr']
|
25
|
+
abbr.to_s == "" ? state : abbr
|
26
|
+
end
|
24
27
|
|
25
28
|
def country
|
26
29
|
country_key = reverse_geocode? ? "CountryCode" : "Country"
|
@@ -0,0 +1,179 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'geocoder/results/base'
|
4
|
+
|
5
|
+
module Geocoder
|
6
|
+
module Result
|
7
|
+
# https://apidocs.geoapify.com/docs/geocoding/api
|
8
|
+
class Geoapify < Base
|
9
|
+
def address(_format = :full)
|
10
|
+
properties['formatted']
|
11
|
+
end
|
12
|
+
|
13
|
+
def address_line1
|
14
|
+
properties['address_line1']
|
15
|
+
end
|
16
|
+
|
17
|
+
def address_line2
|
18
|
+
properties['address_line2']
|
19
|
+
end
|
20
|
+
|
21
|
+
def house_number
|
22
|
+
properties['housenumber']
|
23
|
+
end
|
24
|
+
|
25
|
+
def street
|
26
|
+
properties['street']
|
27
|
+
end
|
28
|
+
|
29
|
+
def postal_code
|
30
|
+
properties['postcode']
|
31
|
+
end
|
32
|
+
|
33
|
+
def district
|
34
|
+
properties['district']
|
35
|
+
end
|
36
|
+
|
37
|
+
def suburb
|
38
|
+
properties['suburb']
|
39
|
+
end
|
40
|
+
|
41
|
+
def city
|
42
|
+
properties['city']
|
43
|
+
end
|
44
|
+
|
45
|
+
def county
|
46
|
+
properties['county']
|
47
|
+
end
|
48
|
+
|
49
|
+
def state
|
50
|
+
properties['state']
|
51
|
+
end
|
52
|
+
|
53
|
+
# Not currently available in the API
|
54
|
+
def state_code
|
55
|
+
''
|
56
|
+
end
|
57
|
+
|
58
|
+
def country
|
59
|
+
properties['country']
|
60
|
+
end
|
61
|
+
|
62
|
+
def country_code
|
63
|
+
return unless properties['country_code']
|
64
|
+
|
65
|
+
properties['country_code'].upcase
|
66
|
+
end
|
67
|
+
|
68
|
+
def coordinates
|
69
|
+
return unless properties['lat']
|
70
|
+
return unless properties['lon']
|
71
|
+
|
72
|
+
[properties['lat'], properties['lon']]
|
73
|
+
end
|
74
|
+
|
75
|
+
# See: https://tools.ietf.org/html/rfc7946#section-3.1
|
76
|
+
#
|
77
|
+
# Each feature has a "Point" type in the Geoapify API.
|
78
|
+
def geometry
|
79
|
+
return unless data['geometry']
|
80
|
+
|
81
|
+
symbol_hash data['geometry']
|
82
|
+
end
|
83
|
+
|
84
|
+
# See: https://tools.ietf.org/html/rfc7946#section-5
|
85
|
+
def bounds
|
86
|
+
data['bbox']
|
87
|
+
end
|
88
|
+
|
89
|
+
# Type of the result, one of:
|
90
|
+
#
|
91
|
+
# * :unknown
|
92
|
+
# * :amenity
|
93
|
+
# * :building
|
94
|
+
# * :street
|
95
|
+
# * :suburb
|
96
|
+
# * :district
|
97
|
+
# * :postcode
|
98
|
+
# * :city
|
99
|
+
# * :county
|
100
|
+
# * :state
|
101
|
+
# * :country
|
102
|
+
#
|
103
|
+
def type
|
104
|
+
return :unknown unless properties['result_type']
|
105
|
+
|
106
|
+
properties['result_type'].to_sym
|
107
|
+
end
|
108
|
+
|
109
|
+
# Distance in meters to given bias:proximity or to given coordinates for
|
110
|
+
# reverse geocoding
|
111
|
+
def distance
|
112
|
+
properties['distance']
|
113
|
+
end
|
114
|
+
|
115
|
+
# Calculated rank for the result, containing the following keys:
|
116
|
+
#
|
117
|
+
# * `popularity` - The popularity score of the result
|
118
|
+
# * `confidence` - The confidence value of the result (0-1)
|
119
|
+
# * `match_type` - The result's match type, one of following:
|
120
|
+
# * full_match
|
121
|
+
# * inner_part
|
122
|
+
# * match_by_building
|
123
|
+
# * match_by_street
|
124
|
+
# * match_by_postcode
|
125
|
+
# * match_by_city_or_disrict
|
126
|
+
# * match_by_country_or_state
|
127
|
+
#
|
128
|
+
# Example:
|
129
|
+
# {
|
130
|
+
# popularity: 8.615793062435909,
|
131
|
+
# confidence: 0.88,
|
132
|
+
# match_type: :full_match
|
133
|
+
# }
|
134
|
+
def rank
|
135
|
+
return unless properties['rank']
|
136
|
+
|
137
|
+
r = symbol_hash(properties['rank'])
|
138
|
+
r[:match_type] = r[:match_type].to_sym if r[:match_type]
|
139
|
+
r
|
140
|
+
end
|
141
|
+
|
142
|
+
# Examples:
|
143
|
+
#
|
144
|
+
# Open
|
145
|
+
# {
|
146
|
+
# sourcename: 'openstreetmap',
|
147
|
+
# wheelchair: 'limited',
|
148
|
+
# wikidata: 'Q186125',
|
149
|
+
# wikipedia: 'en:Madison Square Garden',
|
150
|
+
# website: 'http://www.thegarden.com/',
|
151
|
+
# phone: '12124656741',
|
152
|
+
# osm_type: 'W',
|
153
|
+
# osm_id: 138141251,
|
154
|
+
# continent: 'North America',
|
155
|
+
# }
|
156
|
+
def datasource
|
157
|
+
return unless properties['datasource']
|
158
|
+
|
159
|
+
symbol_hash properties['datasource']
|
160
|
+
end
|
161
|
+
|
162
|
+
private
|
163
|
+
|
164
|
+
def properties
|
165
|
+
@properties ||= data['properties'] || {}
|
166
|
+
end
|
167
|
+
|
168
|
+
def symbol_hash(orig_hash)
|
169
|
+
{}.tap do |result|
|
170
|
+
orig_hash.each_key do |key|
|
171
|
+
next unless orig_hash[key]
|
172
|
+
|
173
|
+
result[key.to_sym] = orig_hash[key]
|
174
|
+
end
|
175
|
+
end
|
176
|
+
end
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
@@ -0,0 +1,54 @@
|
|
1
|
+
require 'geocoder/results/base'
|
2
|
+
|
3
|
+
module Geocoder
|
4
|
+
module Result
|
5
|
+
class Ipqualityscore < Base
|
6
|
+
|
7
|
+
def self.key_method_mappings
|
8
|
+
{
|
9
|
+
'request_id' => :request_id,
|
10
|
+
'success' => :success?,
|
11
|
+
'message' => :message,
|
12
|
+
'city' => :city,
|
13
|
+
'region' => :state,
|
14
|
+
'country_code' => :country_code,
|
15
|
+
'mobile' => :mobile?,
|
16
|
+
'fraud_score' => :fraud_score,
|
17
|
+
'ISP' => :isp,
|
18
|
+
'ASN' => :asn,
|
19
|
+
'organization' => :organization,
|
20
|
+
'is_crawler' => :crawler?,
|
21
|
+
'host' => :host,
|
22
|
+
'proxy' => :proxy?,
|
23
|
+
'vpn' => :vpn?,
|
24
|
+
'tor' => :tor?,
|
25
|
+
'active_vpn' => :active_vpn?,
|
26
|
+
'active_tor' => :active_tor?,
|
27
|
+
'recent_abuse' => :recent_abuse?,
|
28
|
+
'bot_status' => :bot?,
|
29
|
+
'connection_type' => :connection_type,
|
30
|
+
'abuse_velocity' => :abuse_velocity,
|
31
|
+
'timezone' => :timezone,
|
32
|
+
}
|
33
|
+
end
|
34
|
+
|
35
|
+
key_method_mappings.each_pair do |key, meth|
|
36
|
+
define_method meth do
|
37
|
+
@data[key]
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
alias_method :state_code, :state
|
42
|
+
alias_method :country, :country_code
|
43
|
+
|
44
|
+
def postal_code
|
45
|
+
'' # No suitable fallback
|
46
|
+
end
|
47
|
+
|
48
|
+
def address
|
49
|
+
[city, state, country_code].compact.reject(&:empty?).join(', ')
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
@@ -23,7 +23,10 @@ module Geocoder::Result
|
|
23
23
|
context_part('region')
|
24
24
|
end
|
25
25
|
|
26
|
-
|
26
|
+
def state_code
|
27
|
+
value = context_part('region', 'short_code')
|
28
|
+
value.split('-').last unless value.nil?
|
29
|
+
end
|
27
30
|
|
28
31
|
def postal_code
|
29
32
|
context_part('postcode')
|
@@ -33,7 +36,10 @@ module Geocoder::Result
|
|
33
36
|
context_part('country')
|
34
37
|
end
|
35
38
|
|
36
|
-
|
39
|
+
def country_code
|
40
|
+
value = context_part('country', 'short_code')
|
41
|
+
value.upcase unless value.nil?
|
42
|
+
end
|
37
43
|
|
38
44
|
def neighborhood
|
39
45
|
context_part('neighborhood')
|
@@ -45,8 +51,8 @@ module Geocoder::Result
|
|
45
51
|
|
46
52
|
private
|
47
53
|
|
48
|
-
def context_part(name)
|
49
|
-
context.
|
54
|
+
def context_part(name, key = 'text')
|
55
|
+
(context.detect { |c| c['id'] =~ Regexp.new(name) } || {})[key]
|
50
56
|
end
|
51
57
|
|
52
58
|
def context
|
@@ -0,0 +1,46 @@
|
|
1
|
+
require 'geocoder/results/base'
|
2
|
+
|
3
|
+
module Geocoder::Result
|
4
|
+
class MelissaStreet < Base
|
5
|
+
def address(format = :full)
|
6
|
+
@data['FormattedAddress']
|
7
|
+
end
|
8
|
+
|
9
|
+
def street_address
|
10
|
+
@data['AddressLine1']
|
11
|
+
end
|
12
|
+
|
13
|
+
def suffix
|
14
|
+
@data['ThoroughfareTrailingType']
|
15
|
+
end
|
16
|
+
|
17
|
+
def number
|
18
|
+
@data['PremisesNumber']
|
19
|
+
end
|
20
|
+
|
21
|
+
def city
|
22
|
+
@data['Locality']
|
23
|
+
end
|
24
|
+
|
25
|
+
def state_code
|
26
|
+
@data['AdministrativeArea']
|
27
|
+
end
|
28
|
+
alias_method :state, :state_code
|
29
|
+
|
30
|
+
def country
|
31
|
+
@data['CountryName']
|
32
|
+
end
|
33
|
+
|
34
|
+
def country_code
|
35
|
+
@data['CountryISO3166_1_Alpha2']
|
36
|
+
end
|
37
|
+
|
38
|
+
def postal_code
|
39
|
+
@data['PostalCode']
|
40
|
+
end
|
41
|
+
|
42
|
+
def coordinates
|
43
|
+
[@data['Latitude'].to_f, @data['Longitude'].to_f]
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|