maxmind-geoip2 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +17 -0
- data/Gemfile +11 -0
- data/Gemfile.lock +70 -0
- data/LICENSE-APACHE +202 -0
- data/LICENSE-MIT +17 -0
- data/README.dev.md +4 -0
- data/README.md +326 -0
- data/Rakefile +14 -0
- data/lib/maxmind/geoip2.rb +4 -0
- data/lib/maxmind/geoip2/client.rb +313 -0
- data/lib/maxmind/geoip2/errors.rb +48 -0
- data/lib/maxmind/geoip2/model/abstract.rb +27 -0
- data/lib/maxmind/geoip2/model/anonymous_ip.rb +63 -0
- data/lib/maxmind/geoip2/model/asn.rb +39 -0
- data/lib/maxmind/geoip2/model/city.rb +75 -0
- data/lib/maxmind/geoip2/model/connection_type.rb +32 -0
- data/lib/maxmind/geoip2/model/country.rb +70 -0
- data/lib/maxmind/geoip2/model/domain.rb +32 -0
- data/lib/maxmind/geoip2/model/enterprise.rb +15 -0
- data/lib/maxmind/geoip2/model/insights.rb +14 -0
- data/lib/maxmind/geoip2/model/isp.rb +53 -0
- data/lib/maxmind/geoip2/reader.rb +277 -0
- data/lib/maxmind/geoip2/record/abstract.rb +22 -0
- data/lib/maxmind/geoip2/record/city.rb +38 -0
- data/lib/maxmind/geoip2/record/continent.rb +37 -0
- data/lib/maxmind/geoip2/record/country.rb +54 -0
- data/lib/maxmind/geoip2/record/location.rb +73 -0
- data/lib/maxmind/geoip2/record/maxmind.rb +17 -0
- data/lib/maxmind/geoip2/record/place.rb +28 -0
- data/lib/maxmind/geoip2/record/postal.rb +30 -0
- data/lib/maxmind/geoip2/record/represented_country.rb +23 -0
- data/lib/maxmind/geoip2/record/subdivision.rb +48 -0
- data/lib/maxmind/geoip2/record/traits.rb +200 -0
- data/maxmind-geoip2.gemspec +25 -0
- data/test/test_client.rb +424 -0
- data/test/test_model_country.rb +80 -0
- data/test/test_model_names.rb +47 -0
- data/test/test_reader.rb +459 -0
- metadata +116 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 107c7822a5a2de18a3339637547ca8fd8eef5163
|
4
|
+
data.tar.gz: 8d730256e5f036178cf13cbd69ed5be2b86afc10
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1c9dc8f9b3a115494fa9f20c603f772721568a3759b9e2619fde20751ba71a50109d911effeb7d702d286a2011e56d71049ff6a2b854b177f012bbf6bd904291
|
7
|
+
data.tar.gz: a895b54353186ad7fdffec41d9fcf0efa03f093f2dd44a7bbe31e417e13e726a971bb4b88a8a7357c424b16d864061aa563aa150b87160a087d025e852be9a60
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
## 0.2.0 (2020-02-26)
|
4
|
+
|
5
|
+
* Added support for the GeoIP2 Precision web services: Country, City, and
|
6
|
+
Insights.
|
7
|
+
|
8
|
+
## 0.1.0 (2020-02-20)
|
9
|
+
|
10
|
+
* Added support for the Anonymous IP, ASN, Connection Type, Domain, and ISP
|
11
|
+
databases.
|
12
|
+
* Added missing dependency on maxmind-db to the gemspec. Reported by Sean
|
13
|
+
Dilda. GitHub #4.
|
14
|
+
|
15
|
+
## 0.0.1 (2020-01-09)
|
16
|
+
|
17
|
+
* Initial implementation with support for location databases.
|
data/Gemfile
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
source 'https://rubygems.org'
|
4
|
+
|
5
|
+
gem 'http'
|
6
|
+
gem 'maxmind-db'
|
7
|
+
gem 'minitest', group: :development
|
8
|
+
gem 'rake', group: :development
|
9
|
+
gem 'rubocop', group: :development
|
10
|
+
gem 'rubocop-performance', group: :development
|
11
|
+
gem 'webmock', group: :development
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,70 @@
|
|
1
|
+
GEM
|
2
|
+
remote: https://rubygems.org/
|
3
|
+
specs:
|
4
|
+
addressable (2.7.0)
|
5
|
+
public_suffix (>= 2.0.2, < 5.0)
|
6
|
+
ast (2.4.0)
|
7
|
+
crack (0.4.3)
|
8
|
+
safe_yaml (~> 1.0.0)
|
9
|
+
domain_name (0.5.20190701)
|
10
|
+
unf (>= 0.0.5, < 1.0.0)
|
11
|
+
ffi (1.12.2)
|
12
|
+
ffi-compiler (1.0.1)
|
13
|
+
ffi (>= 1.0.0)
|
14
|
+
rake
|
15
|
+
hashdiff (1.0.0)
|
16
|
+
http (4.3.0)
|
17
|
+
addressable (~> 2.3)
|
18
|
+
http-cookie (~> 1.0)
|
19
|
+
http-form_data (~> 2.2)
|
20
|
+
http-parser (~> 1.2.0)
|
21
|
+
http-cookie (1.0.3)
|
22
|
+
domain_name (~> 0.5)
|
23
|
+
http-form_data (2.2.0)
|
24
|
+
http-parser (1.2.1)
|
25
|
+
ffi-compiler (>= 1.0, < 2.0)
|
26
|
+
jaro_winkler (1.5.4)
|
27
|
+
maxmind-db (1.1.0)
|
28
|
+
minitest (5.14.0)
|
29
|
+
parallel (1.19.1)
|
30
|
+
parser (2.7.0.2)
|
31
|
+
ast (~> 2.4.0)
|
32
|
+
public_suffix (4.0.3)
|
33
|
+
rainbow (3.0.0)
|
34
|
+
rake (13.0.1)
|
35
|
+
rexml (3.2.4)
|
36
|
+
rubocop (0.80.0)
|
37
|
+
jaro_winkler (~> 1.5.1)
|
38
|
+
parallel (~> 1.10)
|
39
|
+
parser (>= 2.7.0.1)
|
40
|
+
rainbow (>= 2.2.2, < 4.0)
|
41
|
+
rexml
|
42
|
+
ruby-progressbar (~> 1.7)
|
43
|
+
unicode-display_width (>= 1.4.0, < 1.7)
|
44
|
+
rubocop-performance (1.5.2)
|
45
|
+
rubocop (>= 0.71.0)
|
46
|
+
ruby-progressbar (1.10.1)
|
47
|
+
safe_yaml (1.0.5)
|
48
|
+
unf (0.1.4)
|
49
|
+
unf_ext
|
50
|
+
unf_ext (0.0.7.6)
|
51
|
+
unicode-display_width (1.6.1)
|
52
|
+
webmock (3.8.2)
|
53
|
+
addressable (>= 2.3.6)
|
54
|
+
crack (>= 0.3.2)
|
55
|
+
hashdiff (>= 0.4.0, < 2.0.0)
|
56
|
+
|
57
|
+
PLATFORMS
|
58
|
+
ruby
|
59
|
+
|
60
|
+
DEPENDENCIES
|
61
|
+
http
|
62
|
+
maxmind-db
|
63
|
+
minitest
|
64
|
+
rake
|
65
|
+
rubocop
|
66
|
+
rubocop-performance
|
67
|
+
webmock
|
68
|
+
|
69
|
+
BUNDLED WITH
|
70
|
+
2.1.4
|
data/LICENSE-APACHE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/LICENSE-MIT
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
2
|
+
this software and associated documentation files (the "Software"), to deal in
|
3
|
+
the Software without restriction, including without limitation the rights to
|
4
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
5
|
+
of the Software, and to permit persons to whom the Software is furnished to do
|
6
|
+
so, subject to the following conditions:
|
7
|
+
|
8
|
+
The above copyright notice and this permission notice shall be included in all
|
9
|
+
copies or substantial portions of the Software.
|
10
|
+
|
11
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
12
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
13
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
14
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
15
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
16
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
17
|
+
SOFTWARE.
|
data/README.dev.md
ADDED
data/README.md
ADDED
@@ -0,0 +1,326 @@
|
|
1
|
+
# GeoIP2 Ruby API
|
2
|
+
|
3
|
+
## Description
|
4
|
+
|
5
|
+
This is the Ruby API for the GeoIP2
|
6
|
+
[webservices](https://dev.maxmind.com/geoip/geoip2/web-services) and
|
7
|
+
[databases](https://dev.maxmind.com/geoip/geoip2/geolite2/). This API also
|
8
|
+
works with the free [GeoLite2
|
9
|
+
databases](https://dev.maxmind.com/geoip/geoip2/geolite2/).
|
10
|
+
|
11
|
+
## Installation
|
12
|
+
|
13
|
+
```
|
14
|
+
gem install maxmind-geoip2
|
15
|
+
```
|
16
|
+
|
17
|
+
## IP Geolocation Usage
|
18
|
+
|
19
|
+
IP geolocation is inherently imprecise. Locations are often near the center
|
20
|
+
of the population. Any location provided by a GeoIP2 database or web
|
21
|
+
service should not be used to identify a particular address or household.
|
22
|
+
|
23
|
+
## Database Reader
|
24
|
+
|
25
|
+
### Usage
|
26
|
+
|
27
|
+
To use this API, you must create a new `MaxMind::GeoIP2::Reader` object
|
28
|
+
with the path to the database file as the first argument to the
|
29
|
+
constructor. You may then call the method corresponding to the database you
|
30
|
+
are using.
|
31
|
+
|
32
|
+
If the lookup succeeds, the method call will return a model class for the
|
33
|
+
record in the database. This model in turn contains multiple container
|
34
|
+
objects for the different parts of the data such as the city in which the
|
35
|
+
IP address is located.
|
36
|
+
|
37
|
+
If the record is not found, a `MaxMind::GeoIP2::AddressNotFoundError`
|
38
|
+
exception is thrown. If the database is invalid or corrupt, a
|
39
|
+
`MaxMind::DB::InvalidDatabaseError` exception will be thrown.
|
40
|
+
|
41
|
+
See the [API documentation](https://www.rubydoc.info/gems/maxmind-geoip2)
|
42
|
+
for more details.
|
43
|
+
|
44
|
+
### City Example
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
require 'maxmind/geoip2'
|
48
|
+
|
49
|
+
# This creates the Reader object which should be reused across lookups.
|
50
|
+
reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-City.mmdb')
|
51
|
+
|
52
|
+
record = reader.city('128.101.101.101')
|
53
|
+
|
54
|
+
puts record.country.iso_code # US
|
55
|
+
puts record.country.name # United States
|
56
|
+
puts record.country.names['zh-CN'] # '美国'
|
57
|
+
|
58
|
+
puts record.most_specific_subdivision.name # Minnesota
|
59
|
+
puts record.most_specific_subdivision.iso_code # MN
|
60
|
+
|
61
|
+
puts record.city.name # Minneapolis
|
62
|
+
|
63
|
+
puts record.postal.code # 55455
|
64
|
+
|
65
|
+
puts record.location.latitude # 44.9733
|
66
|
+
puts record.location.longitude # -93.2323
|
67
|
+
|
68
|
+
puts record.traits.network # 128.101.101.101/32
|
69
|
+
```
|
70
|
+
|
71
|
+
### Country Example
|
72
|
+
|
73
|
+
```ruby
|
74
|
+
require 'maxmind/geoip2'
|
75
|
+
|
76
|
+
# This creates the Reader object which should be reused across lookups.
|
77
|
+
reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Country.mmdb')
|
78
|
+
|
79
|
+
record = reader.country('128.101.101.101')
|
80
|
+
|
81
|
+
puts record.country.iso_code # US
|
82
|
+
puts record.country.name # United States
|
83
|
+
puts record.country.names['zh-CN'] # '美国'
|
84
|
+
```
|
85
|
+
|
86
|
+
### Enterprise Example
|
87
|
+
|
88
|
+
```ruby
|
89
|
+
require 'maxmind/geoip2'
|
90
|
+
|
91
|
+
# This creates the Reader object which should be reused across lookups.
|
92
|
+
reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Enterprise.mmdb')
|
93
|
+
|
94
|
+
record = reader.enterprise('128.101.101.101')
|
95
|
+
|
96
|
+
puts record.country.confidence # 99
|
97
|
+
puts record.country.iso_code # US
|
98
|
+
puts record.country.name # United States
|
99
|
+
puts record.country.names['zh-CN'] # '美国'
|
100
|
+
|
101
|
+
puts record.most_specific_subdivision.confidence # 77
|
102
|
+
puts record.most_specific_subdivision.name # Minnesota
|
103
|
+
puts record.most_specific_subdivision.iso_code # MN
|
104
|
+
|
105
|
+
puts record.city.confidence # 60
|
106
|
+
puts record.city.name # Minneapolis
|
107
|
+
|
108
|
+
puts record.postal.code # 55455
|
109
|
+
|
110
|
+
puts record.location.accuracy_radius # 50
|
111
|
+
puts record.location.latitude # 44.9733
|
112
|
+
puts record.location.longitude # -93.2323
|
113
|
+
|
114
|
+
puts record.traits.network # 128.101.101.101/32
|
115
|
+
```
|
116
|
+
|
117
|
+
### Anonymous IP Example
|
118
|
+
|
119
|
+
```ruby
|
120
|
+
require 'maxmind/geoip2'
|
121
|
+
|
122
|
+
# This creates the Reader object which should be reused across lookups.
|
123
|
+
reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Anonymous-IP.mmdb')
|
124
|
+
|
125
|
+
record = reader.anonymous_ip('128.101.101.101')
|
126
|
+
|
127
|
+
puts "Anonymous" if record.is_anonymous
|
128
|
+
```
|
129
|
+
|
130
|
+
### ASN Example
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
require 'maxmind/geoip2'
|
134
|
+
|
135
|
+
# This creates the Reader object which should be reused across lookups.
|
136
|
+
reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoLite2-ASN.mmdb')
|
137
|
+
|
138
|
+
record = reader.asn('128.101.101.101')
|
139
|
+
|
140
|
+
puts record.autonomous_system_number # 1234
|
141
|
+
puts record.autonomous_system_organization # Example Ltd
|
142
|
+
```
|
143
|
+
|
144
|
+
### Connection Type Example
|
145
|
+
|
146
|
+
```ruby
|
147
|
+
require 'maxmind/geoip2'
|
148
|
+
|
149
|
+
# This creates the Reader object which should be reused across lookups.
|
150
|
+
reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Connection-Type.mmdb')
|
151
|
+
|
152
|
+
record = reader.connection_type('128.101.101.101')
|
153
|
+
|
154
|
+
puts record.connection_type # Cable/DSL
|
155
|
+
```
|
156
|
+
|
157
|
+
### Domain Example
|
158
|
+
|
159
|
+
```ruby
|
160
|
+
require 'maxmind/geoip2'
|
161
|
+
|
162
|
+
# This creates the Reader object which should be reused across lookups.
|
163
|
+
reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Domain.mmdb')
|
164
|
+
|
165
|
+
record = reader.domain('128.101.101.101')
|
166
|
+
|
167
|
+
puts record.domain # example.com
|
168
|
+
```
|
169
|
+
|
170
|
+
### ISP Example
|
171
|
+
|
172
|
+
```ruby
|
173
|
+
require 'maxmind/geoip2'
|
174
|
+
|
175
|
+
# This creates the Reader object which should be reused across lookups.
|
176
|
+
reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-ISP.mmdb')
|
177
|
+
|
178
|
+
record = reader.isp('128.101.101.101')
|
179
|
+
|
180
|
+
puts record.autonomous_system_number # 217
|
181
|
+
puts record.autonomous_system_organization # University of Minnesota
|
182
|
+
puts record.isp # University of Minnesota
|
183
|
+
puts record.organization # University of Minnesota
|
184
|
+
```
|
185
|
+
|
186
|
+
## Web Service Client
|
187
|
+
|
188
|
+
### Usage
|
189
|
+
|
190
|
+
To use this API, you must create a new `MaxMind::GeoIP2::Client` object
|
191
|
+
with your account ID and license key, then you call the method
|
192
|
+
corresponding to a specific end point, passing it the IP address you want
|
193
|
+
to look up.
|
194
|
+
|
195
|
+
If the request succeeds, the method call will return a model class for the end
|
196
|
+
point you called. This model in turn contains multiple record classes, each of
|
197
|
+
which represents part of the data returned by the web service.
|
198
|
+
|
199
|
+
If there is an error, a structured exception is thrown.
|
200
|
+
|
201
|
+
See the [API documentation](https://www.rubydoc.info/gems/maxmind-geoip2)
|
202
|
+
for more details.
|
203
|
+
|
204
|
+
### Example
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
require 'maxmind/geoip2'
|
208
|
+
|
209
|
+
# This creates a Client object that can be reused across requests.
|
210
|
+
# Replace "42" with your account ID and "license_key" with your license
|
211
|
+
# key.
|
212
|
+
client = MaxMind::GeoIP2::Client.new(
|
213
|
+
account_id: 42,
|
214
|
+
license_key: 'license_key',
|
215
|
+
)
|
216
|
+
|
217
|
+
# Replace "city" with the method corresponding to the web service that
|
218
|
+
# you are using, e.g., "country", "insights".
|
219
|
+
record = client.city('128.101.101.101')
|
220
|
+
|
221
|
+
puts record.country.isoCode # US
|
222
|
+
puts record.country.name # United States
|
223
|
+
puts record.country.names['zh-CN'] # 美国
|
224
|
+
|
225
|
+
puts record.most_specific_subdivision.name # Minnesota
|
226
|
+
puts record.most_specific_subdivision.iso_code # MN
|
227
|
+
|
228
|
+
puts record.city.name # Minneapolis
|
229
|
+
|
230
|
+
puts record.postal.code # 55455
|
231
|
+
|
232
|
+
puts record.location.latitude # 44.9733
|
233
|
+
puts record.location.longitude # -93.2323
|
234
|
+
|
235
|
+
puts record.traits.network # 128.101.101.101/32
|
236
|
+
```
|
237
|
+
|
238
|
+
## Values to use for Database or Array Keys
|
239
|
+
|
240
|
+
**We strongly discourage you from using a value from any `names` property
|
241
|
+
as a key in a database or array.**
|
242
|
+
|
243
|
+
These names may change between releases. Instead we recommend using one of
|
244
|
+
the following:
|
245
|
+
|
246
|
+
* `MaxMind::GeoIP2::Record::City` - `city.geoname_id`
|
247
|
+
* `MaxMind::GeoIP2::Record::Continent` - `continent.code` or
|
248
|
+
`continent.geoname_id`
|
249
|
+
* `MaxMind::GeoIP2::Record::Country` and
|
250
|
+
`MaxMind::GeoIP2::Record::RepresentedCountry` - `country.iso_code` or
|
251
|
+
`country.geoname_id`
|
252
|
+
* `MaxMind::GeoIP2::Record::Subdivision` - `subdivision.iso_code` or
|
253
|
+
`subdivision.geoname_id`
|
254
|
+
|
255
|
+
### What data is returned?
|
256
|
+
|
257
|
+
While many of the end points return the same basic records, the attributes
|
258
|
+
which can be populated vary between end points. In addition, while an end
|
259
|
+
point may offer a particular piece of data, MaxMind does not always have
|
260
|
+
every piece of data for any given IP address.
|
261
|
+
|
262
|
+
See the [GeoIP2 Precision web service
|
263
|
+
docs](https://dev.maxmind.com/geoip/geoip2/web-services) for details on
|
264
|
+
what data each end point may return.
|
265
|
+
|
266
|
+
The only piece of data which is always returned is the `ip_address`
|
267
|
+
attribute in the `MaxMind::GeoIP2::Record::Traits` record.
|
268
|
+
|
269
|
+
## Integration with GeoNames
|
270
|
+
|
271
|
+
[GeoNames](https://www.geonames.org/) offers web services and downloadable
|
272
|
+
databases with data on geographical features around the world, including
|
273
|
+
populated places. They offer both free and paid premium data. Each feature
|
274
|
+
is unique identified by a `geoname_id`, which is an integer.
|
275
|
+
|
276
|
+
Many of the records returned by the GeoIP2 web services and databases
|
277
|
+
include a `geoname_id` property. This is the ID of a geographical feature
|
278
|
+
(city, region, country, etc.) in the GeoNames database.
|
279
|
+
|
280
|
+
Some of the data that MaxMind provides is also sourced from GeoNames. We
|
281
|
+
source things like place names, ISO codes, and other similar data from the
|
282
|
+
GeoNames premium data set.
|
283
|
+
|
284
|
+
## Reporting data problems
|
285
|
+
|
286
|
+
If the problem you find is that an IP address is incorrectly mapped, please
|
287
|
+
[submit your correction to MaxMind](https://www.maxmind.com/en/correction).
|
288
|
+
|
289
|
+
If you find some other sort of mistake, like an incorrect spelling, please
|
290
|
+
check the [GeoNames site](https://www.geonames.org/) first. Once you've
|
291
|
+
searched for a place and found it on the GeoNames map view, there are a
|
292
|
+
number of links you can use to correct data ("move", "edit", "alternate
|
293
|
+
names", etc.). Once the correction is part of the GeoNames data set, it
|
294
|
+
will be automatically incorporated into future MaxMind releases.
|
295
|
+
|
296
|
+
If you are a paying MaxMind customer and you're not sure where to submit a
|
297
|
+
correction, please [contact MaxMind
|
298
|
+
support](https://www.maxmind.com/en/support) for help.
|
299
|
+
|
300
|
+
## Support
|
301
|
+
|
302
|
+
Please report all issues with this code using the [GitHub issue
|
303
|
+
tracker](https://github.com/maxmind/GeoIP2-ruby/issues).
|
304
|
+
|
305
|
+
If you are having an issue with a MaxMind service that is not specific to the
|
306
|
+
client API, please see [our support page](https://www.maxmind.com/en/support).
|
307
|
+
|
308
|
+
## Requirements
|
309
|
+
|
310
|
+
This code requires Ruby version 2.4 or higher.
|
311
|
+
|
312
|
+
## Contributing
|
313
|
+
|
314
|
+
Patches and pull requests are encouraged. Please include unit tests
|
315
|
+
whenever possible.
|
316
|
+
|
317
|
+
## Versioning
|
318
|
+
|
319
|
+
This library uses [Semantic Versioning](https://semver.org/).
|
320
|
+
|
321
|
+
## Copyright and License
|
322
|
+
|
323
|
+
This software is Copyright (c) 2020 by MaxMind, Inc.
|
324
|
+
|
325
|
+
This is free software, licensed under the [Apache License, Version
|
326
|
+
2.0](LICENSE-APACHE) or the [MIT License](LICENSE-MIT), at your option.
|