Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lexrus/mmdb-swift
A tiny wrapper for libmaxminddb which allows you to lookup Geo data by IP address.
https://github.com/lexrus/mmdb-swift
carthage geolite2 geolocation maxmind swift
Last synced: 1 day ago
JSON representation
A tiny wrapper for libmaxminddb which allows you to lookup Geo data by IP address.
- Host: GitHub
- URL: https://github.com/lexrus/mmdb-swift
- Owner: lexrus
- License: apache-2.0
- Created: 2015-12-18T04:20:40.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-12-10T16:09:12.000Z (almost 4 years ago)
- Last Synced: 2024-11-07T20:15:40.763Z (8 days ago)
- Topics: carthage, geolite2, geolocation, maxmind, swift
- Language: C
- Size: 20.1 MB
- Stars: 123
- Watchers: 8
- Forks: 59
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MMDB-Swift
[](http://cocoapods.org/pods/MMDB-Swift)
[](https://github.com/Carthage/Carthage)
[](https://github.com/Carthage/Carthage)
A tiny wrapper for [libmaxminddb](https://github.com/maxmind/libmaxminddb) which allows you to lookup Geo data by IP address.
---
**NOTE** From `v0.5.0`, MMDB-Swift no longer bundles [GeoLite2 database](http://dev.maxmind.com/geoip/geoip2/geolite2/) due to the license change. Developers should download the binary version from the [Maxmind website](http://dev.maxmind.com/geoip/geoip2/geolite2/).
## CocoaPods
MMDB-Swift is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile:
``` ruby
platform :ios, '8.0'
use_frameworks!
pod "MMDB-Swift"
```
Then, run the following command:
``` bash
pod install
```
## Carthage
To integrate MMDB-Swift into your Xcode project using Carthage, add the following line to your `Cartfile`:
```
github "lexrus/MMDB-Swift"
```
Run `carthage update` to build the frameworks and drag the built `MMDB.framework` into your Xcode project.
## Swift Package Manager
Package.swift
``` swift
import PackageDescription
let package = Package(
name: "YOUR_AWESOME_PROJECT",
targets: [],
dependencies: [
.Package(
url: "https://github.com/lexrus/MMDB-Swift",
versions: "0.0.1" ..< Version.max
)
]
)
```
## Usage
``` swift
guard let db = MMDB("PATH_TO_THE_DATABASE") else {
print("Failed to open DB.")
return
}
if let country = db.lookup("8.8.4.4") {
print(country)
}
```
This outputs:
``` json
{
"continent": {
"code": "NA",
"names": {
"ja": "北アメリカ",
"en": "North America",
"ru": "Северная Америка",
"es": "Norteamérica",
"de": "Nordamerika",
"zh-CN": "北美洲",
"fr": "Amérique du Nord",
"pt-BR": "América do Norte"
}
},
"isoCode": "US",
"names": {
"ja": "アメリカ合衆国",
"en": "United States",
"ru": "США",
"es": "Estados Unidos",
"de": "USA",
"zh-CN": "美国",
"fr": "États-Unis",
"pt-BR": "Estados Unidos"
}
}
```
Notice that country is a struct defined as:
``` swift
public struct MMDBContinent {
var code: String?
var names: [String: String]?
}
public struct MMDBCountry: CustomStringConvertible {
var continent = MMDBContinent()
var isoCode = ""
var names = [String: String]()
...
}
```
## Author
[Lex Tang](https://github.com/lexrus) (Twitter: [@lexrus](https://twitter.com/lexrus))
## License
MMDB-Swift is available under the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). See the [LICENSE](https://github.com/lexrus/MMDB-Swift/blob/master/LICENSE) file for more info.
The GeoLite2 databases are distributed under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/).